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

Используйте таблицы соответствия, чтобы сопоставить методы и поля управления аудиторией Customer Match в API Display & Video 360 с их эквивалентами в API Data Manager.

сопоставление методов

В следующей таблице приведено соответствие методов API Display & Video 360 эквивалентным методам API Data Manager:

Методы API для отображения и видео 360 Методы API менеджера данных Примечания
firstPartyAndPartnerAudiences.get userLists.get API менеджера данных может получать только аудитории, соответствующие параметрам Customer Match.
firstPartyAndPartnerAudiences.list userLists.list API Data Manager будет возвращать только аудитории Customer Match.
firstPartyAndPartnerAudiences.create userLists.create Данные пользователя необходимо загрузить в последующем запросе через API менеджера данных.
Нет эквивалента userLists.delete Недоступно в API Display & Video 360.
firstPartyAndPartnerAudiences.patch userLists.patch
firstPartyAndPartnerAudiences.editCustomerMatchMembers audienceMembers.ingest Для добавления и удаления участников из аудиторий Customer Match используются отдельные методы API Data Manager.
firstPartyAndPartnerAudiences.editCustomerMatchMembers audienceMembers.remove Для добавления и удаления участников из аудиторий Customer Match используются отдельные методы API Data Manager.

сопоставление запросов

В следующих таблицах приведены соответствия полей запроса методов API Display & Video 360 их эквивалентам в API Data Manager.

userLists.get

firstPartyAndPartnerAudiences.get (API для отображения и видео 360) userLists.get (API менеджера данных) Примечания
  • advertiserId
  • partnerId
  • firstPartyAndPartnerAudienceId
 name Имя UserList содержит как идентификатор родительского рекламодателя или партнера, так и идентификатор аудитории. Подробнее см. в разделе «Имена ресурсов» .

userLists.list

firstPartyAndPartnerAudiences.list (API для отображения и видео 360) userLists.list (API менеджера данных) Примечания
  • advertiserId
  • partnerId
 parent parent содержится идентификатор родительского рекламодателя или партнера.
pageSize pageSize Максимальный размер страницы в API Data Manager составляет 1000 .
pageToken pageToken
filter filter
orderBy Нет эквивалента

userLists.create

firstPartyAndPartnerAudiences.create (API для отображения и видео 360) userLists.create (API менеджера данных) Примечания
  • advertiserId
  • partnerId
 parent parent содержится идентификатор родительского рекламодателя или партнера новой целевой аудитории.
Нет эквивалента validateOnly
Текст запроса FirstPartyAndPartnerAudience Тело запроса UserList Сопоставление содержимого тела запроса см. в разделе UserList .

userLists.update

firstPartyAndPartnerAudiences.patch (Display & Video 360 API) userLists.patch (API менеджера данных) Примечания
  • advertiserId
  • firstPartyAndPartnerAudienceId
 параметр userList.name Имя ресурса списка UserList , который необходимо обновить.
updateMask updateMask Это поле рекомендуется, но не является обязательным в API Data Manager, и если оно останется пустым, это приведет к полной замене всех включенных полей.
Нет эквивалента validateOnly
Текст запроса FirstPartyAndPartnerAudience Тело запроса UserList Сопоставление содержимого тела запроса см. в разделе UserList .

audienceMembers.ingest

firstPartyAndPartnerAudiences.editCustomerMatchMembers (Display & Video 360 API) audienceMembers.ingest (API менеджера данных) Примечания
  • advertiserId
  • firstPartyAndPartnerAudienceId
 destinations Подробности см. в разделе «Настройка пунктов назначения» .
addedContactInfoList.contactInfos audienceMembers Индивидуальные идентификаторы пользователей можно задать в поле compositeData.userData в объектах AudienceMember . Подробнее см. в разделе «Идентификаторы пользователей» .
addedContactInfoList.consent consent Согласие также можно установить в отдельных объектах AudienceMember .
addedMobileDeviceIdList.mobileDeviceIds audienceMembers Идентификаторы отдельных мобильных устройств задаются в поле mobileData в объектах AudienceMember .
addedMobileDeviceIdList.consent consent Согласие также можно установить в отдельных объектах AudienceMember .
Нет эквивалента validateOnly
Нет эквивалента encoding Обязательно. Установите Encoding используемую для значений UserIdentifier .
Нет эквивалента encryptionInfo Укажите, если запрос содержит зашифрованные значения. Подробнее см. в разделе «Шифрование» .
Нет эквивалента termsOfService Обязательно . Установите этот параметр, чтобы указать, принял или отклонил ли пользователь условия предоставления услуг Customer Match.

audienceMembers.remove

firstPartyAndPartnerAudiences.editCustomerMatchMembers (Display & Video 360 API) audienceMembers.remove (API менеджера данных) Примечания
  • advertiserId
  • firstPartyAndPartnerAudienceId
 destinations
removedContactInfoList.contactInfos audienceMembers Индивидуальные идентификаторы пользователей можно задать в поле compositeData.userData в объектах AudienceMember . Подробнее см. в разделе «Идентификаторы пользователей» .
removedMobileDeviceIdList.mobileDeviceIds audienceMembers Идентификаторы отдельных мобильных устройств задаются в поле mobileData в объектах AudienceMember .
Нет эквивалента validateOnly
Нет эквивалента encoding Обязательно . Установите значение Encoding используемой для значений UserIdentifier .
Нет эквивалента encryptionInfo Укажите, если запрос содержит зашифрованные значения. Подробнее см. в разделе «Шифрование» .

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

Ниже приведено сопоставление объектов API Display & Video 360 с эквивалентными объектами в API Data Manager.

Список пользователей

FirstPartyAndPartnerAudience (API для отображения и видео 360) UserList (API менеджера данных) Примечания
name name Используется другой формат именования ресурсов. Подробнее см. в разделе «Имена ресурсов» .
firstPartyAndPartnerAudienceId id
Нет эквивалента readOnly
displayName displayName
description description
Нет эквивалента membershipStatus
Нет эквивалента integrationCode
membershipDurationDays membershipDuration
Нет эквивалента closingReason
Нет эквивалента accessReason
Нет эквивалента accountAccessStatus
displayAudienceSize sizeInfo.displayNetworkMembersCount
Нет эквивалента sizeInfo.searchNetworkMembersCount
Нет эквивалента targetNetworkInfo
Нет эквивалента ingestedUserListInfo
firstPartyAndPartnerAudienceType Нет эквивалента
audienceType Нет эквивалента
audienceSource Нет эквивалента
activeDisplayAudienceSize Нет эквивалента
youtubeAudienceSize Нет эквивалента
gmailAudienceSize Нет эквивалента
displayMobileAppAudienceSize Нет эквивалента
displayMobileWebAudienceSize Нет эквивалента
displayDesktopAudienceSize Нет эквивалента
appId ingestedUserListInfo.mobileIdInfo.appId
contactInfoList методы audienceMembers В API менеджера данных добавление и удаление участников осуществляется с помощью методов ingest и remove класса audienceMembers .
mobileDeviceIdList методы audienceMembers В API менеджера данных добавление и удаление участников осуществляется с помощью методов ingest и remove класса audienceMembers .

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

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

API для отображения и видео 360

В API Display & Video 360 имя ресурса UserList использует формат, содержащий только идентификатор аудитории:

firstAndThirdPartyAudiences/{first_and_third_party_audience_id}

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

В API Data Manager имя ресурса UserList использует формат, содержащий идентификатор аудитории, а также AccountType и идентификатор учетной записи партнера или рекламодателя, которому принадлежит аудитория:

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

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

Хотя поддержка userData по-прежнему существует, мы рекомендуем использовать compositeData , чтобы обеспечить готовность вашей интеграции к будущим улучшениям. Подробнее см. в разделе «Составные данные» .

ContactInfo (API для отображения и видео 360) CompositeData (API менеджера данных) Примечания
hashedEmails userData.userIdentifiers.emailAddress Установите форматированный и хешированный адрес электронной почты. Вы также можете зашифровать хешированный адрес электронной почты . Для сопоставления одного пользователя можно использовать несколько адресов электронной почты, используя несколько объектов UserIdentifier .
hashedPhoneNumbers userData.userIdentifiers.phoneNumber Установите значение в формате и хешированном виде для номера телефона. Вы также можете зашифровать хешированный номер телефона . Для сопоставления одного пользователя можно использовать несколько номеров телефонов, используя несколько объектов UserIdentifier .
hashedFirstName userData.userIdentifiers.address.givenName Установите значение в формате и с помощью хеширования . Вы также можете зашифровать хешированное имя .
hashedLastName userData.userIdentifiers.address.familyName Установите форматированное и хешированное имя семьи. Вы также можете зашифровать хешированное имя семьи .
countryCode userData.userIdentifiers.address.regionCode
zipCodes userData.userIdentifiers.address.postalCode Для сопоставления одного пользователя можно использовать несколько почтовых индексов, задействовав несколько объектов UserIdentifier .

Место назначения

API для отображения и видео 360 Destination (API менеджера данных) Примечания
Идентификатор рекламодателя или партнера, к которому пользователю Display & Video 360 предоставлен доступ. loginAccount Этот параметр необходимо установить только в сценарии доступа к Display & Video 360 через партнера , когда аудитория находится под управлением рекламодателя, но пользователю Display & Video 360 предоставлен доступ к родительскому партнеру рекламодателя. В противном случае его можно оставить без изменений.
Идентификатор родительского рекламодателя или партнера целевой аудитории. operatingAccount
firstPartyAndPartnerAudienceId productDestinationId
Нет эквивалента reference
Назад
Шаги по обновлению