Сопоставление полей

Используйте сопоставление полей, чтобы перевести каждый этап рабочего процесса сопоставления клиентов с API Google Ads на API Data Manager:

Сопоставление полей управления аудиторией

Используйте таблицы соответствия, чтобы сопоставить список UserList в Google Ads API с его UserList в Data Manager API.

UserList (Google Ads API) UserList (API менеджера данных) Примечания
resource_name name Подробности см. в разделе «Названия ресурсов» .
id id
read_only read_only
name display_name Необходимый
description description Необходимый
membership_status membership_status
integration_code integration_code
membership_life_span membership_duration

Продолжительность пребывания участника аудитории в списке после добавления. Значение должно соответствовать целым дням. Если не задано, используется максимальное значение по умолчанию.

Отформатируйте значение, используя формат «Меток времени» .

size_for_display size_info.display_network_members_count
size_range_for_display Аналогов нет. Для получения информации о размере сети используйте параметр size_info.display_network_members_count .
size_for_search size_info.search_network_members_count
size_range_for_search Аналогов нет. Для получения информации о размере сети используйте параметр size_info.search_network_members_count .
type Аналогов нет.
access_reason access_reason
account_user_list_status account_access_status
closing_reason closing_reason
eligible_for_search target_network_info.eligible_for_search
eligible_for_display target_network_info.eligible_for_display
match_rate_percentage ingested_user_list_info.contact_id_info.match_rate_percentage
basic_user_list ingested_user_list_info.pseudonymous_id_info Не используется для сопоставления клиентов.
crm_based_user_list ingested_user_list_info Обязательно. См. информацию об аудитории Customer Match .
Аналогов нет. ingested_user_list_info.pair_id_info Не используется для сопоставления клиентов.
Аналогов нет. ingested_user_list_info.partner_audience_info Не используется для сопоставления клиентов.
logical_user_list Аналогов нет. Не используется для сопоставления клиентов.
logical_user_list Аналогов нет. Не используется для сопоставления клиентов.
lookalike_user_list Аналогов нет. Не используется для сопоставления клиентов.
rule_based_user_list Аналогов нет. Не используется для сопоставления клиентов.
similar_user_list Аналогов нет. Не используется для сопоставления клиентов.

Информация об аудитории Customer Match

В API Google Ads поле crm_based_user_list является обязательным при создании аудитории Customer Match.

В API менеджера данных задайте эквивалентные атрибуты, установив для поля ingested_user_list_info значение IngestedUserListInfo , а затем укажите необходимые поля для сопоставления клиентов и тип пользовательских данных.

Контактная информация

upload_key_types
Установите значение в списке, содержащем CONTACT_INFO .
contact_id_info

Установите значение ContactIdInfo .

Установите data_source_type в DATA_SOURCE_TYPE_FIRST_PARTY .

Идентификаторы мобильных телефонов

upload_key_types
Установите значение в списке, содержащем MOBILE_ID .
mobile_id_info

Установите значение типа MobileIdInfo .

  • Установите data_source_type в DATA_SOURCE_TYPE_FIRST_PARTY .
  • Установите key_space в IOS или ANDROID .
  • Установите app_id в виде строки, однозначно идентифицирующей мобильное приложение, из которого были собраны данные. Используйте тот же формат, что и для идентификатора приложения в Google Ads API.

Идентификаторы пользователей

upload_key_types
Установите значение в списке, содержащем USER_ID .
user_id_info

Установите значение типа UserIdInfo .

Установите data_source_type в DATA_SOURCE_TYPE_FIRST_PARTY .

Названия ресурсов

API Data Manager использует другой формат именования ресурсов, чем API Google Ads.

API Google Ads

В API Google Ads имя ресурса UserList имеет следующий формат:

customers/{customer_id}/userLists/{user_list_id}

API менеджера данных

В API Data Manager имя ресурса UserList имеет следующий формат:

accountTypes/{accountType}/accounts/{account}/userLists/{userList}

Загрузка сопоставлений полей

Используйте сопоставления в таблицах, чтобы сопоставить запрос AddOfflineUserDataJobOperationsRequest в API Google Ads с его эквивалентом IngestAudienceMembersRequest в API Data Manager.

Поля запроса

AddOfflineUserDataJobOperationsRequest (Google Ads API) IngestAudienceMembersRequest (API менеджера данных) Примечания
  • поле customer_id
  • поле customer_match_user_list_metadata объекта OfflineUserDataJob
  • заголовок запроса developer-token
  • заголовок запроса login-customer_id
  • заголовок запроса linked-customer-id
 destinations См. поля «Клиент» и «Аудитория» .
consent из таблицы customer_match_user_list_metadata объекта OfflineUserDataJob consent В запросе можно задать необязательные параметры согласия по умолчанию для участников аудитории. Вы можете переопределить это значение для отдельного участника аудитории, задав значение в поле consent поля AudienceMember .
Нет эквивалента encoding Обязательно: укажите Encoding используемую для значений UserIdentifier .
Нет эквивалента encryption_info Укажите, если запрос содержит зашифрованные значения. Подробнее см. в разделе «Шифрование» .
job_id Нет эквивалента Используйте request_id , возвращенный в ответе, для получения диагностической информации .
enable_partial_failure Нет эквивалента API менеджера данных не поддерживает частичные сбои. Если какое-либо поле запроса IngestAudienceMembersRequest не проходит проверку, API менеджера данных отклоняет весь запрос. Для получения информации об ошибках обработки используйте диагностику .
enable_warnings Нет эквивалента API менеджера данных не сообщает о предупреждениях в ответе. Получите предупреждения об обработке с помощью диагностических средств .
validate_only validate_only
operations audience_members Список участников аудитории. Подробности см. в разделе «Поля для участников аудитории» .
Нет эквивалента terms_of_service Обязательно. Установите этот параметр, чтобы указать, принял или отклонил ли пользователь условия предоставления услуг Customer Match.

Поля клиентов и аудитории

API Google Ads поддерживает загрузку участников аудитории только в одну аудиторию на одно задание. Кроме того, требуется заголовок запроса developer-token , а также необходимо установить заголовки запроса login-customer-id и linked-customer-id для различных сценариев аутентификации.

API Data Manager поддерживает отправку данных об участниках нескольких аудиторий в одном запросе . Для работы с API Data Manager не требуется токен разработчика, а информация об авторизации и связанных клиентах указывается с помощью полей объекта Destination , а не заголовков запроса. Дополнительную информацию об объектах Destination см. в разделе «Настройка объектов Destination».

API Data Manager не поддерживает удаление всех участников аудитории. В API Google Ads вы можете удалить всех участников аудитории, установив поле remove_all объекта OfflineUserDataJobOperation в true .

Вот как сопоставить поля API Google Ads для одной аудитории с аналогичными полями в Destination :

API Google Ads Destination (API менеджера данных) Примечания
customer_id запроса operating_account Установите account_id равным идентификатору клиента из целевой аудитории. Установите account_type для operating_account равным GOOGLE_ADS .
заголовок запроса developer-token Нет эквивалента Для использования API Data Manager токен разработчика не требуется.
заголовок запроса login-customer-id login_account Установите account_id равным идентификатору клиента учетной записи для входа. Установите account_type равным GOOGLE_ADS , если учетная запись является учетной записью Google Ads, или DATA_PARTNER если учетная запись является учетной записью партнера по данным.
заголовок запроса linked-customer-id linked_account Установите account_id равным идентификатору клиента связанной учетной записи. Установите account_type равным DATA_PARTNER .
user_list из customer_match_user_list_metadata объекта OfflineUserDataJob product_destination_id Обязательно. Установите числовой идентификатор аудитории. Не используйте имя ресурса UserList .
Нет эквивалента reference Определяемый пользователем идентификатор для Destination . Заполните это поле, если вы отправляете участников аудитории для нескольких аудиторий в одном запросе .

Поля для участников аудитории

UserData (API Google Ads) AudienceMember (API менеджера данных) Примечания
consent consent

Укажите, какое согласие должен дать участник аудитории.

Оба API используют похожий объект Consent (ad_user_data, ad_personalization).

Для API Data Manager вы также можете установить согласие для всех участников аудитории в запросе, задав поле consent на уровне запроса.

transaction_attribute Аналогов нет. Не относится к функции «Сопоставление клиентов».
user_attribute Аналогов нет. Не относится к функции «Сопоставление клиентов».
user_identifiers
  • mobile_id_data
  • user_id_data
  • user_identifiers

Заполните поле, соответствующее типу данных, которые вы отправляете участникам аудитории. Подробнее см. в разделе «Поля идентификатора пользователя» .

Поля идентификатора пользователя

В API Google Ads для отправки контактной информации, идентификаторов мобильных телефонов или идентификаторов пользователей используется UserIdentifier . API Data Manager использует другой подход, с разными полями для каждого типа данных.

В API менеджера данных заполните поле, соответствующее типу отправляемых данных:

Контактная информация

При использовании контактной информации, такой как адрес электронной почты, номер телефона или адрес, установите для UserData user_data с отдельной записью в user_identifiers для каждого элемента контактной информации.

UserIdentifier (API Google Ads) UserIdentifier (API менеджера данных) Примечания
address_info address Подробности см. в разделе «Поля адреса» .
hashed_email email_address Укажите отформатированный и хешированный адрес электронной почты. Вы также можете зашифровать хешированный адрес электронной почты .
hashed_phone_number phone_number Установите значение для отформатированного и хешированного номера телефона. Вы также можете зашифровать хешированный номер телефона .
user_identifier_source Аналогов нет.

Поля адреса

Ниже приведено сопоставление полей OfflineUserAddressInfo в API Google Ads и AddressInfo в API Data Manager. Используйте эти сопоставления, если вы используете контактную информацию для заполнения вашей аудитории Customer Match.

OfflineUserAddressInfo (Google Ads API) AddressInfo (API менеджера данных) Примечания
city Аналогов нет.
country_code region_code
hashed_first_name given_name

Установите значение в формате и с помощью хеширования . Вы также можете зашифровать хешированное имя .

hashed_last_name family_name

Установите форматированное и хешированное имя семьи. Вы также можете зашифровать хешированное имя семьи .

hashed_street_address Аналогов нет.
postal_code postal_code
state Аналогов нет.

Идентификаторы мобильных телефонов

При использовании мобильных идентификаторов установите для параметра mobile_data значение типа MobileData , в котором для каждого идентификатора будет запись в параметре mobile_ids .

UserIdentifier (API Google Ads) MobileData (API менеджера данных) Примечания
mobile_id mobile_ids Предоставьте список мобильных идентификаторов участника аудитории.

В API Google Ads для каждого идентификатора мобильного телефона участника аудитории добавляется отдельный UserIdentifier с mobile_id . В API Data Manager добавляется один MobileData с mobile_ids , содержащий список всех идентификаторов мобильных телефонов участника аудитории.

user_identifier_source Аналогов нет.

Идентификаторы пользователей

При использовании идентификаторов пользователей установите для параметра user_id_data значение типа UserIdData , а для параметра user_id — идентификатор пользователя, являющегося участником аудитории.

UserIdentifier (API Google Ads) UserIdData (API менеджера данных) Примечания
third_party_user_id user_id

В Google Ads API для каждого идентификатора пользователя в составе аудитории добавляется отдельный UserIdentifier с third_party_user_id .

В API Data Manager установите поле user_id_data в UserIdData , а поле user_id — в идентификатор пользователя, являющегося участником аудитории. Вы не можете отправлять несколько идентификаторов пользователей для одного и того же участника аудитории.

user_identifier_source Аналогов нет.
Назад
Шаги по обновлению