REST Resource: firstAndThirdPartyAudiences

Ресурс: FirstAndThirdPartyAudience

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

JSON-представление
{
  "name": string,
  "firstAndThirdPartyAudienceId": string,
  "displayName": string,
  "description": string,
  "firstAndThirdPartyAudienceType": enum (FirstAndThirdPartyAudienceType),
  "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

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

firstAndThirdPartyAudienceId

string ( int64 format)

Только вывод. Уникальный идентификатор собственной и сторонней аудитории. Назначается системой.

displayName

string

Отображаемое имя собственной и сторонней аудитории.

description

string

Предоставленное пользователем описание аудитории.

Применимо только к собственной аудитории.

firstAndThirdPartyAudienceType

enum ( FirstAndThirdPartyAudienceType )

Является ли аудитория собственной или третьей стороной.

audienceType

enum ( AudienceType )

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

audienceSource

enum ( AudienceSource )

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

membershipDurationDays

string ( int64 format)

Продолжительность в днях, в течение которой запись остается в аудитории после квалификационного мероприятия. Если у аудитории нет срока действия, установите значение этого поля равным 10000. В противном случае установленное значение должно быть больше 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 Союза. Первые участники аудитории списков электронных адресов. members может быть только одно из следующих:
contactInfoList

object ( ContactInfoList )

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

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

mobileDeviceIdList

object ( MobileDeviceIdList )

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

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

Тип первой и третьей стороны аудитории

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

Перечисления
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED Значение по умолчанию, если тип не указан или неизвестен.
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY Аудитория, созданная с использованием данных клиента.
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY Аудитория, предоставленная сторонними поставщиками данных.

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

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

Перечисления
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.
LICENSED Подтип стороннего типа аудитории.

АудиторияИсточник

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

Перечисления
AUDIENCE_SOURCE_UNSPECIFIED Значение по умолчанию, если источник аудитории не указан или неизвестен.
DISPLAY_VIDEO_360 Создано из Дисплея и Видео 360.
CAMPAIGN_MANAGER Создано из Менеджера кампаний 360.
AD_MANAGER Создано из Google Ad Manager.
SEARCH_ADS_360 Создано из Поисковой рекламы 360.
YOUTUBE Возникло с Youtube.
ADS_DATA_HUB Источник: Ads Data Hub.

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

Сообщение-оболочка со списком контактной информации, определяющей членов аудитории списков электронных адресов.

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

object ( ContactInfo )

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

consent

object ( Consent )

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

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

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

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

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

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 В согласии отказано.

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

Сообщение-оболочка для списка идентификаторов мобильных устройств, определяющих членов аудитории списков электронных адресов.

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

string

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

consent

object ( Consent )

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

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

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

Методы

create

 Создает FirstAndThirdPartyAudience.

editCustomerMatchMembers

 Обновляет список участников аудитории списков электронных адресов.

get

 Получает первую и стороннюю аудиторию.

list

 Перечисляет собственную и стороннюю аудитории.

patch

 Обновляет существующую FirstAndThirdPartyAudience.
,

Ресурс: FirstAndThirdPartyAudience

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

JSON-представление
{
  "name": string,
  "firstAndThirdPartyAudienceId": string,
  "displayName": string,
  "description": string,
  "firstAndThirdPartyAudienceType": enum (FirstAndThirdPartyAudienceType),
  "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

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

firstAndThirdPartyAudienceId

string ( int64 format)

Только вывод. Уникальный идентификатор собственной и сторонней аудитории. Назначается системой.

displayName

string

Отображаемое имя собственной и сторонней аудитории.

description

string

Предоставленное пользователем описание аудитории.

Применимо только к собственной аудитории.

firstAndThirdPartyAudienceType

enum ( FirstAndThirdPartyAudienceType )

Является ли аудитория собственной или третьей стороной.

audienceType

enum ( AudienceType )

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

audienceSource

enum ( AudienceSource )

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

membershipDurationDays

string ( int64 format)

Продолжительность в днях, в течение которой запись остается в аудитории после квалификационного мероприятия. Если у аудитории нет срока действия, установите значение этого поля равным 10000. В противном случае установленное значение должно быть больше 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 Союза. Первые участники аудитории списков электронных адресов. members может быть только одно из следующих:
contactInfoList

object ( ContactInfoList )

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

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

mobileDeviceIdList

object ( MobileDeviceIdList )

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

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

Тип первой и третьей стороны аудитории

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

Перечисления
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED Значение по умолчанию, если тип не указан или неизвестен.
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY Аудитория, созданная с использованием данных клиента.
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY Аудитория, предоставленная сторонними поставщиками данных.

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

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

Перечисления
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.
LICENSED Подтип стороннего типа аудитории.

АудиторияИсточник

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

Перечисления
AUDIENCE_SOURCE_UNSPECIFIED Значение по умолчанию, если источник аудитории не указан или неизвестен.
DISPLAY_VIDEO_360 Создано из Дисплея и Видео 360.
CAMPAIGN_MANAGER Создано из Менеджера кампаний 360.
AD_MANAGER Создано из Google Ad Manager.
SEARCH_ADS_360 Создано из Поисковой рекламы 360.
YOUTUBE Возникло с Youtube.
ADS_DATA_HUB Источник: Ads Data Hub.

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

Сообщение-оболочка со списком контактной информации, определяющей членов аудитории списков электронных адресов.

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

object ( ContactInfo )

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

consent

object ( Consent )

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

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

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

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

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

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 В согласии отказано.

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

Сообщение-оболочка для списка идентификаторов мобильных устройств, определяющих членов аудитории списков электронных адресов.

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

string

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

consent

object ( Consent )

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

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

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

Методы

create

 Создает FirstAndThirdPartyAudience.

editCustomerMatchMembers

 Обновляет список участников аудитории списков электронных адресов.

get

 Получает первую и стороннюю аудиторию.

list

 Перечисляет собственную и стороннюю аудитории.

patch

 Обновляет существующую FirstAndThirdPartyAudience.