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
}
Поля
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

FirstPartyAndPartnerAudienceType

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

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

AudienceType

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

Перечисления
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 Аудитория лицензирована для использования третьей стороной.
COMMERCE Аудитория, предоставляемая партнерами-поставщиками за плату.
LINEAR Аудитория контента на линейном ТВ.
AGENCY Аудитория, предоставленная агентством.

AudienceSource

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

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

Методы

get

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

list

Собственные аудитории и аудитории партнеров.