REST Resource: firstPartyAndPartnerAudiences

Источник: FirstPartyAndPartnerAudience

Описывает список целевой аудитории, созданный собственными силами или партнерами, используемый для таргетинга. Собственные аудитории создаются на основе данных клиента. Партнерские аудитории предоставляются сторонними поставщиками данных и могут быть лицензированы только клиентам.

JSON-представление 
{
  "name": string,
  "firstPartyAndPartnerAudienceId": string,
  "displayName": string,
  "description": string,
  "firstPartyAndPartnerAudienceType": enum (FirstPartyAndPartnerAudienceType),
  "audienceType": enum (AudienceType),
  "audienceSource": enum (AudienceSource),
  "membershipDurationDays": string,
  "displayAudienceSize": string,
  "activeDisplayAudienceSize": string,
  "youtubeAudienceSize": string,
  "gmailAudienceSize": string,
  "displayMobileAppAudienceSize": string,
  "displayMobileWebAudienceSize": string,
  "displayDesktopAudienceSize": string,
  "appId": string,

  // Union field members can be only one of the following:
  "contactInfoList": {
    object (ContactInfoList)
  },
  "mobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of list of possible types for union field members.
}
Поля
name

string

Только для вывода. Название ресурса для целевой аудитории (собственной и партнерской стороны).

firstPartyAndPartnerAudienceId

string ( int64 format)

Идентификатор. Уникальный идентификатор целевой аудитории (как самой компании, так и её партнёров). Присваивается системой.

displayName

string

Необязательно. Отображаемое имя целевой аудитории (как собственной, так и партнерской).

description

string

Необязательно. Описание целевой аудитории, предоставленное пользователем.

Применимо только к аудитории, представляющей интересы самой компании.

firstPartyAndPartnerAudienceType

enum ( FirstPartyAndPartnerAudienceType )

Только вывод. Указывает, является ли аудитория собственной или партнерской.

audienceType

enum ( AudienceType )

Неизменный. Тип аудитории.

audienceSource

enum ( AudienceSource )

Только вывод. Источник аудитории.

membershipDurationDays

string ( int64 format)

Необязательно. Продолжительность в днях, в течение которой заявка остается в аудитории после квалификационного мероприятия. Заданное значение должно быть больше 0 и меньше или равно 540.

Применимо только к аудитории, представляющей интересы самой компании.

Это поле обязательно для заполнения, если используется один из следующих audienceType :

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID
displayAudienceSize

string ( int64 format)

Только для вывода. Ориентировочный размер аудитории для контекстно-медийной сети.

Если размер меньше 1000, число будет скрыто, и будет возвращено 0 по соображениям конфиденциальности. В противном случае число будет округлено до двух значащих цифр.

Возвращается только в GET-запросах.

activeDisplayAudienceSize

string ( int64 format)

Только для вывода. Предполагаемый размер аудитории в контекстно-медийной сети за последний месяц.

Если размер меньше 1000, число будет скрыто, и будет возвращено 0 по соображениям конфиденциальности. В противном случае число будет округлено до двух значащих цифр.

Возвращается только в GET-запросах.

youtubeAudienceSize

string ( int64 format)

Только вывод. Ориентировочный размер аудитории для сети YouTube.

Если размер меньше 1000, число будет скрыто, и будет возвращено 0 по соображениям конфиденциальности. В противном случае число будет округлено до двух значащих цифр.

Применимо только к аудитории, представляющей интересы самой компании.

Возвращается только в GET-запросах.

gmailAudienceSize

string ( int64 format)

Только вывод. Примерный размер аудитории для сети Gmail.

Если размер меньше 1000, число будет скрыто, и будет возвращено 0 по соображениям конфиденциальности. В противном случае число будет округлено до двух значащих цифр.

Применимо только к аудитории, представляющей интересы самой компании.

Возвращается только в GET-запросах.

displayMobileAppAudienceSize

string ( int64 format)

Только для вывода. Примерный размер аудитории мобильного приложения в контекстно-медийной сети.

Если размер меньше 1000, число будет скрыто, и будет возвращено 0 по соображениям конфиденциальности. В противном случае число будет округлено до двух значащих цифр.

Применимо только к аудитории, представляющей интересы самой компании.

Возвращается только в GET-запросах.

displayMobileWebAudienceSize

string ( int64 format)

Только для вывода. Примерный размер мобильной веб-аудитории в контекстно-медийной сети.

Если размер меньше 1000, число будет скрыто, и будет возвращено 0 по соображениям конфиденциальности. В противном случае число будет округлено до двух значащих цифр.

Применимо только к аудитории, представляющей интересы самой компании.

Возвращается только в GET-запросах.

displayDesktopAudienceSize

string ( int64 format)

Только для вывода. Предполагаемый размер аудитории на настольных компьютерах в контекстно-медийной сети.

Если размер меньше 1000, число будет скрыто, и будет возвращено 0 по соображениям конфиденциальности. В противном случае число будет округлено до двух значащих цифр.

Применимо только к аудитории, представляющей интересы самой компании.

Возвращается только в GET-запросах.

appId

string

Необязательно. appId соответствует типу загружаемых mobileDeviceIds.

Применимо только к audienceType CUSTOMER_MATCH_DEVICE_ID

members профсоюза, работающие на местах. Первоначальные участники аудитории Customer Match могут быть только одним из следующих members :
contactInfoList

object ( ContactInfoList )

Только ввод данных. Список контактной информации для определения первоначальной целевой аудитории.

Применимо только к audienceType CUSTOMER_MATCH_CONTACT_INFO

mobileDeviceIdList

object ( MobileDeviceIdList )

Только ввод данных. Список идентификаторов мобильных устройств для определения первоначальной целевой аудитории.

Применимо только к audienceType CUSTOMER_MATCH_DEVICE_ID

FirstPartyAndPartnerAudienceType

Возможные типы ресурсов для целевой аудитории, как собственных, так и партнерских.

Перечисления
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED Значение по умолчанию, если тип не указан или неизвестен.
TYPE_FIRST_PARTY Аудитория, сформированная на основе данных клиента.
TYPE_PARTNER Аудитория, предоставленная сторонними поставщиками данных.

Тип аудитории

Возможные типы аудитории.

Перечисления
AUDIENCE_TYPE_UNSPECIFIED Значение по умолчанию, если тип не указан или неизвестен.
CUSTOMER_MATCH_CONTACT_INFO Целевая аудитория была сформирована путем сопоставления клиентов с известной контактной информацией.
CUSTOMER_MATCH_DEVICE_ID Аудитория формировалась путем сопоставления клиентов с известными идентификаторами мобильных устройств.
CUSTOMER_MATCH_USER_ID Аудитория формировалась путем сопоставления клиентов с известными идентификаторами пользователей.
ACTIVITY_BASED

Целевая аудитория была сформирована на основе активности в рамках рекламной кампании.

FREQUENCY_CAP

Целевая аудитория была сформирована без учета количества показов.

TAG_BASED Аудитория была сформирована на основе пользовательских переменных, прикрепленных к пикселю.
YOUTUBE_USERS Аудитория была сформирована на основе предыдущего взаимодействия с видеороликами, рекламой на YouTube или каналом YouTube.
THIRD_PARTY Лицензия на использование ресурса Audience была получена от третьей стороны.
COMMERCE Аудитория предоставляется коммерческими партнерами за определенную плату.
LINEAR Аудитория, интересующаяся контентом линейного телевидения.
AGENCY Аудитория предоставлена ​​агентством.

AudienceSource

Возможные источники аудитории.

Перечисления
AUDIENCE_SOURCE_UNSPECIFIED Значение по умолчанию, если источник аудитории не указан или неизвестен.
DISPLAY_VIDEO_360 Первоначально разработано компанией Display & Video 360.
CAMPAIGN_MANAGER Создано на основе Campaign Manager 360.
AD_MANAGER Изначально это было в Google Ad Manager.
SEARCH_ADS_360 Первоначально создано компанией Search Ads 360.
YOUTUBE Оригинальное видео взято с YouTube.
ADS_DATA_HUB Источник: Ads Data Hub.

ContactInfoList

Вспомогательное сообщение для списка контактной информации, определяющей участников целевой аудитории Customer Match.

JSON-представление 
{
  "contactInfos": [
    {
      object (ContactInfo)
    }
  ],
  "consent": {
    object (Consent)
  }
}
Поля
contactInfos[]

object ( ContactInfo )

Список объектов ContactInfo, определяющих участников аудитории Customer Match. Количество участников после разделения объектов ContactInfo не должно превышать 500 000.

consent

object ( Consent )

Только для ввода. Настройки согласия для пользователей в contactInfos .

Если оставить это поле незаполненным, это означает, что согласие не указано.

Если поля adUserData или adPersonalization имеют значение CONSENT_STATUS_DENIED , запрос вернет ошибку.

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

Контактная информация, определяющая участника целевой аудитории Customer Match.

JSON-представление 
{
  "hashedEmails": [
    string
  ],
  "hashedPhoneNumbers": [
    string
  ],
  "zipCodes": [
    string
  ],
  "hashedFirstName": string,
  "hashedLastName": string,
  "countryCode": string
}
Поля
hashedEmails[]

string

Список хешированных адресов электронной почты участников с использованием алгоритма SHA256. Перед хешированием удалите все пробелы и убедитесь, что все строки написаны строчными буквами.

hashedPhoneNumbers[]

string

Список хешированных по алгоритму SHA256 телефонных номеров участника. Перед хешированием все телефонные номера должны быть отформатированы в формате E.164 и включать код страны.

zipCodes[]

string

Список почтовых индексов участников.

Также необходимо заполнить следующие поля:

hashedFirstName

string

Хэшированное с помощью SHA256 имя участника. Перед хэшированием удалите все пробелы и убедитесь, что строка написана строчными буквами.

Также необходимо заполнить следующие поля:

hashedLastName

string

Хэшированная с помощью SHA256 фамилия участника. Перед хэшированием удалите все пробелы и убедитесь, что строка написана строчными буквами.

Также необходимо заполнить следующие поля:

countryCode

string

Код страны участника.

Также необходимо заполнить следующие поля:

Статус согласия

Статус согласия.

Перечисления
CONSENT_STATUS_UNSPECIFIED В данной версии тип значения не указан или неизвестен.
CONSENT_STATUS_GRANTED Согласие получено.
CONSENT_STATUS_DENIED В согласии отказано.

MobileDeviceIdList

Вспомогательное сообщение для списка идентификаторов мобильных устройств, определяющих участников аудитории Customer Match.

JSON-представление 
{
  "mobileDeviceIds": [
    string
  ],
  "consent": {
    object (Consent)
  }
}
Поля
mobileDeviceIds[]

string

Список идентификаторов мобильных устройств, определяющих участников аудитории Customer Match. Размер массива mobileDeviceIds не должен превышать 500 000.

consent

object ( Consent )

Только для ввода. Настройки согласия для пользователей в mobileDeviceIds .

Если оставить это поле незаполненным, это означает, что согласие не указано.

Если поля adUserData или adPersonalization имеют значение CONSENT_STATUS_DENIED , запрос вернет ошибку.

Методы

create

 Создает аудиторию FirstPartyAndPartnerAudience.

editCustomerMatchMembers

 Обновляет список участников аудитории Customer Match.

get

 Привлекает аудиторию из числа собственных клиентов или партнеров.

list

 Содержит список целевых аудиторий от первого лица и от партнеров.

patch

 Обновляет существующую аудиторию FirstPartyAndPartnerAudience.