Adwords Customer Match

View as Markdown

Create and manage data import and export jobs.

AdwordsCustomerMatch: Create job

POSThttps://api.lytics.io/v2/job/adwords-customer-match

Create a AdwordsCustomerMatch job

Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.ad_consentoptionalstring

Select the consent status for sending user data to Google for advertising purposes. Different consent groups should be sent through separate jobs to the same list

config.adwords_account_idrequiredstring

Select which Google Ads account to create the customer match list and audience model. This has to be set to select lists from managed Google Ads accounts

config.adwords_customer_idoptionalstring

Select the managed Google Ads account associated with the account selected above. This will take precedence over the selected Google Ads account. If there is no managed Google Ads Account select the same account as above.

config.adwords_list_idoptionalinteger

Select which Google Ads customer match list to append to. If no list is selected, a new customer match list will be created

config.app_idoptionalstring

If Mobile ID is entered, enter the Mobile App ID for the mobile application from which the data was collected to AdWords API

config.country_code_fieldoptionalstring

Select which field contains the user's two letter country code

config.email_fieldoptionalstring

Select the field containing the user's email — plain or SHA256-hashed; plain values are hashed before sending.

config.first_name_fieldoptionalstring

Select which field contains the user's first name. To match by name, country code and zipcode must be provided

config.ip_address_fieldoptionalstring

Select the field containing the user's IP address. Only used for Google Ads Customer Match — Display & Video 360 doesn't accept IP data

config.ip_observe_end_time_fieldoptionalstring

Select the field containing when the IP address observation window for the user ended. Leave blank to omit

config.ip_observe_start_time_fieldoptionalstring

Select the field containing when the IP address observation window for the user began. Leave blank to omit

config.last_name_fieldoptionalstring

Select which field contains the user's last name

config.mobile_id_fieldoptionalstring

Select to match on mobile ID field instead of email

config.personalization_consentoptionalstring

Select consent status for ad personalization. Different consent groups should be sent through separate jobs to the same list

config.phone_number_fieldoptionalstring

Select the field containing the user's phone number — plain or SHA256-hashed; plain values are hashed before sending.

config.segment_idoptionalstring

Select the Lytics audience to export to Google Ads and create audience model off of

config.user_id_fieldoptionalstring

Select to match on user ID field instead of email

config.zip_code_fieldoptionalstring

Select which field contains the user's zipcode

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean

expires_atoptionalstring (date-time)

monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger

quiet_time_of_dayoptionalstring

quiet_timezoneoptionalstring

Sample Request

{
  "auth_ids": [
    "string"
  ],
  "config": {
    "ad_consent": "string",
    "adwords_account_id": "string",
    "adwords_customer_id": "string",
    "adwords_list_id": 0,
    "app_id": "string",
    "country_code_field": "string",
    "email_field": "string",
    "first_name_field": "string",
    "ip_address_field": "string",
    "ip_observe_end_time_field": "string",
    "ip_observe_start_time_field": "string",
    "last_name_field": "string",
    "mobile_id_field": "string",
    "personalization_consent": "string",
    "phone_number_field": "string",
    "segment_id": "string",
    "user_id_field": "string",
    "zip_code_field": "string"
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}

Sample Response

Status|201 Created

{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "ad_consent": "string",
      "adwords_account_id": "string",
      "adwords_customer_id": "string",
      "adwords_list_id": 0,
      "app_id": "string",
      "country_code_field": "string",
      "email_field": "string",
      "first_name_field": "string",
      "ip_address_field": "string",
      "ip_observe_end_time_field": "string",
      "ip_observe_start_time_field": "string",
      "last_name_field": "string",
      "mobile_id_field": "string",
      "personalization_consent": "string",
      "phone_number_field": "string",
      "segment_id": "string",
      "user_id_field": "string",
      "zip_code_field": "string"
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

AdwordsCustomerMatch: Get job

GEThttps://api.lytics.io/v2/job/adwords-customer-match/{id}

AdwordsCustomerMatch: Update job

PUThttps://api.lytics.io/v2/job/adwords-customer-match/{id}

{ "auth_ids": [ "string" ], "config": { "ad_consent": "string", "adwords_account_id": "string", "adwords_customer_id": "string", "adwords_list_id": 0, "app_id": "string", "country_code_field": "string", "email_field": "string", "first_name_field": "string", "ip_address_field": "string", "ip_observe_end_time_field": "string", "ip_observe_start_time_field": "string", "last_name_field": "string", "mobile_id_field": "string", "personalization_consent": "string", "phone_number_field": "string", "segment_id": "string", "user_id_field": "string", "zip_code_field": "string" }, "description": "string", "drop_events_during_quiet_window": true, "expires_at": "2019-08-24T14:15:22Z", "monitoring": {}, "name": "string", "quiet_period": 0, "quiet_time_of_day": "string", "quiet_timezone": "string" }

{ "_meta": {}, "data": { "account_id": "string", "anomaly_rule": { "aid": 0, "checks": [ { "allowable_violations": 0, "interval": "string", "lookback_count": 0, "max_threshold": 0, "metric_type": "string", "min_threshold": 0, "type": "string", "variance_pct": 0 } ], "created": "string", "id": "string", "subject_id": "string", "subject_type": "string", "updated": "string" }, "api_token_auth_id": "string", "auth_ids": [ "string" ], "config": { "ad_consent": "string", "adwords_account_id": "string", "adwords_customer_id": "string", "adwords_list_id": 0, "app_id": "string", "country_code_field": "string", "email_field": "string", "first_name_field": "string", "ip_address_field": "string", "ip_observe_end_time_field": "string", "ip_observe_start_time_field": "string", "last_name_field": "string", "mobile_id_field": "string", "personalization_consent": "string", "phone_number_field": "string", "segment_id": "string", "user_id_field": "string", "zip_code_field": "string" }, "created": "string", "deleted": true, "description": "string", "drop_events_during_quiet_window": true, "expires_at": "2019-08-24T14:15:22Z", "id": "string", "meta": {}, "monitoring": {}, "name": "string", "quiet_period": 0, "quiet_time_of_day": "string", "quiet_timezone": "string", "sleep_until": "string", "status": "runnable", "updated": "string", "user_id": "string", "workflow": "string", "workflow_id": "string" }, "request_id": "string", "status": 0 }

Adwords Customer Match

AdwordsCustomerMatch: Create job

Query Parameters

Headers

Body Parameters

AdwordsCustomerMatch: Get job

AdwordsCustomerMatch: Update job

Adwords Customer Match

AdwordsCustomerMatch: Create job

Query Parameters

Headers

Body Parameters

AdwordsCustomerMatch: Get job

AdwordsCustomerMatch: Update job

URL Parameters

Query Parameters

Headers

URL Parameters

Query Parameters

Headers

Body Parameters

URL Parameters

Query Parameters

Headers

URL Parameters

Query Parameters

Headers

Body Parameters