Используйте сопоставления в таблицах, чтобы сопоставить методы управления аудиториями на основе списков эл. адресов и поля в Дисплей и Видео 360 API с их эквивалентами в Data Manager API.
Аутентификация
Для Data Manager API требуются учетные данные с областью действия, отличной от Display & Video 360 API. Следуйте инструкциям в разделе Настройте доступ к API, чтобы создать новые учетные данные, включающие область действия Data Manager API.
Сопоставление методов
В таблице ниже приведены методы Display & Video 360 API и соответствующие им методы Data Manager API.
| Методы Display & Video 360 API | Методы Data Manager API | Примечания |
|---|---|---|
firstPartyAndPartnerAudiences.get |
userLists.get |
Data Manager API позволяет получать только аудитории на основе списков электронных адресов. |
firstPartyAndPartnerAudiences.list |
userLists.list |
Data Manager API возвращает только аудитории на основе списков электронных адресов. |
firstPartyAndPartnerAudiences.create |
userLists.create |
Пользовательские данные необходимо загрузить в последующем запросе в Data Manager API. |
| Ранее такого отчета не существовало | userLists.delete |
Недоступно в Display & Video 360 API. |
firstPartyAndPartnerAudiences.patch |
userLists.patch |
|
firstPartyAndPartnerAudiences.editCustomerMatchMembers |
audienceMembers.ingest |
Для добавления и удаления пользователей из аудиторий на основе списков электронных адресов используются разные методы Data Manager API. |
firstPartyAndPartnerAudiences.editCustomerMatchMembers |
audienceMembers.remove |
Для добавления и удаления пользователей из аудиторий на основе списков электронных адресов используются разные методы Data Manager API. |
| Нет эквивалента. | audienceMembers.removeAll |
Data Manager API поддерживает удаление всех участников аудитории с помощью одного запроса. |
Запрос на сопоставление
В таблицах ниже поля запросов методов Display & Video 360 API сопоставлены с их аналогами в Data Manager API.
userLists.get
firstPartyAndPartnerAudiences.get (Display & Video 360 API) |
userLists.get (Data Manager API) |
Примечания |
|---|---|---|
|
name |
Название UserList содержит идентификатор родительского рекламодателя или партнера, а также идентификатор аудитории. Подробнее о названиях ресурсов… |
userLists.list
firstPartyAndPartnerAudiences.list (Display & Video 360 API) |
userLists.list (Data Manager API) |
Примечания |
|---|---|---|
|
parent |
parent – идентификатор родительского рекламодателя или партнера. |
pageSize |
pageSize |
Максимальный размер страницы в Data Manager API – 1000. |
pageToken |
pageToken |
|
filter |
filter |
|
orderBy |
Ранее такого отчета не существовало |
userLists.create
firstPartyAndPartnerAudiences.create (Display & Video 360 API) |
userLists.create (Data Manager API) |
Примечания |
|---|---|---|
|
parent |
parent содержит идентификатор родительского рекламодателя или партнера новой аудитории. |
| Ранее такого отчета не существовало | validateOnly |
|
тело запроса FirstPartyAndPartnerAudience |
тело запроса UserList |
Сопоставление тела запроса приведено в разделе UserList. |
userLists.update
firstPartyAndPartnerAudiences.patch (Display & Video 360 API) |
userLists.patch (Data Manager API) |
Примечания |
|---|---|---|
|
Параметр userList.name |
Название ресурса для обновления UserList. |
updateMask |
updateMask |
Это поле рекомендуется, но не является обязательным в Data Manager API. Если оставить его пустым, все включенные поля будут заменены. |
| Ранее такого отчета не существовало | validateOnly |
|
тело запроса FirstPartyAndPartnerAudience |
тело запроса UserList |
Сопоставление тела запроса приведено в разделе UserList. |
audienceMembers.ingest
firstPartyAndPartnerAudiences.editCustomerMatchMembers (Display & Video 360 API) |
audienceMembers.ingest (Data Manager API) |
Примечания |
|---|---|---|
|
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 |
Обязательный параметр. Указывает, принял или отклонил пользователь условия использования Списков клиентов. |
audienceMembers.remove
firstPartyAndPartnerAudiences.editCustomerMatchMembers (Display & Video 360 API) |
audienceMembers.remove (Data Manager API) |
Примечания |
|---|---|---|
|
destinations |
|
removedContactInfoList.contactInfos |
audienceMembers |
Идентификаторы отдельных пользователей можно задать в поле compositeData.userData в объектах AudienceMember. Подробнее об идентификаторах пользователей… |
removedMobileDeviceIdList.mobileDeviceIds |
audienceMembers |
Идентификаторы отдельных мобильных устройств задаются в поле mobileData в объектах AudienceMember. |
| Ранее такого отчета не существовало | validateOnly |
|
| Ранее такого отчета не существовало | encoding |
Обязательный параметр. Укажите Encoding, используемый для значений UserIdentifier. |
| Ранее такого отчета не существовало | encryptionInfo |
Указывается, если запрос содержит зашифрованные значения. Подробнее о шифровании… |
Сопоставления полей объектов
Ниже приведены соответствия между объектами Display & Video 360 API и аналогичными объектами Data Manager API.
UserList
FirstPartyAndPartnerAudience (Display & Video 360 API) |
UserList (Data Manager 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 |
В Data Manager API добавляйте и удаляйте участников с помощью методов ingest и remove, а также removeAll audienceMembers.
|
mobileDeviceIdList |
Методы audienceMembers |
В Data Manager API добавляйте и удаляйте участников с помощью методов ingest и remove, а также removeAll audienceMembers.
|
Названия ресурсов
В Data Manager API используется формат названий ресурсов, отличный от формата в Display & Video 360 API.
- Display & Video 360 API
В Display & Video 360 API название ресурса
UserListимеет формат, который содержит только идентификатор аудитории:firstAndThirdPartyAudiences/{first_and_third_party_audience_id}- Data Manager API
В Data Manager API имя ресурса
UserListимеет формат, который содержит идентификатор аудитории, а также идентификаторыAccountTypeи аккаунта партнера или рекламодателя, которому принадлежит аудитория:accountTypes/{accountType}/accounts/{account}/userLists/{userList}
Идентификаторы пользователей
Хотя userData
по-прежнему поддерживается, мы рекомендуем использовать
compositeData
для обеспечения совместимости с будущими улучшениями. Подробнее о составных данных…
ContactInfo (Display & Video 360 API) |
CompositeData (Data Manager 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. |
Место назначения
| Display & Video 360 API | Destination (Data Manager API) |
Примечания |
|---|---|---|
| Идентификатор рекламодателя или партнера, к которому у пользователя Дисплея и Видео 360 есть доступ. | loginAccount |
Это необходимо только в сценарии доступа партнера к Дисплею и Видео 360, когда аудитория относится к рекламодателю, но пользователь Дисплея и Видео 360 получил доступ к родительскому партнеру рекламодателя. В противном случае его можно не указывать. |
| Идентификатор родительского рекламодателя или партнера аудитории. | operatingAccount |
|
firstPartyAndPartnerAudienceId |
productDestinationId |
|
| Ранее такого отчета не существовало | reference |