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 соответствует типу загружаемых идентификаторов mobileDeviceId.

Применимо только к 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

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

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

ConsentStatus

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

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

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

Сообщение-оболочка для списка идентификаторов мобильных устройств, определяющих членов аудитории 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.