REST Resource: advertisers

Источник: Рекламодатель

Один рекламодатель в категории Display & Video 360 (DV360).

JSON-представление 
{
  "name": string,
  "advertiserId": string,
  "partnerId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "generalConfig": {
    object (AdvertiserGeneralConfig)
  },
  "adServerConfig": {
    object (AdvertiserAdServerConfig)
  },
  "creativeConfig": {
    object (AdvertiserCreativeConfig)
  },
  "dataAccessConfig": {
    object (AdvertiserDataAccessConfig)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "servingConfig": {
    object (AdvertiserTargetingConfig)
  },
  "prismaEnabled": boolean,
  "billingConfig": {
    object (AdvertiserBillingConfig)
  },
  "containsEuPoliticalAds": enum (EuPoliticalAdvertisingStatus),
  "defaultBusinessName": string,
  "defaultLogoAssetId": string
}
Поля
name

string

Только вывод. Имя ресурса рекламодателя.

advertiserId

string ( int64 format)

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

partnerId

string ( int64 format)

Обязательный параметр. Неизменяемый. Уникальный идентификатор партнера, к которому принадлежит рекламодатель.

displayName

string

Обязательно. Отображаемое имя рекламодателя.

Должен быть закодирован в UTF-8, максимальный размер — 240 байт.

entityStatus

enum ( EntityStatus )

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

  • Допустимые значения: ENTITY_STATUS_ACTIVE , ENTITY_STATUS_PAUSED и ENTITY_STATUS_SCHEDULED_FOR_DELETION .
  • Если установлено значение ENTITY_STATUS_SCHEDULED_FOR_DELETION , рекламодатель будет удален через 30 дней с момента его первоначального запланированного удаления.
updateTime

string ( Timestamp format)

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

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

generalConfig

object ( AdvertiserGeneralConfig )

Обязательно. Общие настройки рекламодателя.

adServerConfig

object ( AdvertiserAdServerConfig )

Обязательный параметр. Неизменяемый. Настройки рекламного сервера рекламодателя.

creativeConfig

object ( AdvertiserCreativeConfig )

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

dataAccessConfig

object ( AdvertiserDataAccessConfig )

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

integrationDetails

object ( IntegrationDetails )

Информация об интеграции с рекламодателем. В настоящее время к рекламодателю применима только integrationCode . Другие поля в IntegrationDetails не поддерживаются и будут игнорироваться, если они указаны.

servingConfig

object ( AdvertiserTargetingConfig )

Настройки таргетинга, связанные с показом рекламы рекламодателем.

prismaEnabled

boolean

Включена ли интеграция с Mediaocean (Prisma). Включив эту функцию, вы соглашаетесь со следующим:

От имени моей компании я уполномочиваю Mediaocean (Prisma) отправлять планы бюджетных сегментов в Google, а также уполномочиваю Google отправлять соответствующие отчеты и счета-фактуры из DV360 в Mediaocean для целей планирования бюджета, выставления счетов и сверки для данного рекламодателя.

billingConfig

object ( AdvertiserBillingConfig )

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

containsEuPoliticalAds

enum ( EuPoliticalAdvertisingStatus )

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

Если для этого поля установлено значение DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING , то произойдет следующее:

  • Любые новые позиции, созданные для данного рекламодателя, будут иметь идентификатор DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING если не указано иное.
  • Все существующие позиции в списке этого рекламодателя, для которых не задано значение, должны быть обновлены до значения DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING в течение суток.
defaultBusinessName

string

Необязательно. Название компании по умолчанию для рекламодателя.

Это значение используется в объявлениях YouTube и Demand Gen для данного рекламодателя, если название компании не указано.

defaultLogoAssetId

string ( int64 format)

Необязательно. Идентификатор ресурса изображения логотипа по умолчанию для рекламодателя.

Это идентификатор ресурса, который будет использоваться в рекламе на YouTube и в контекстной рекламе этого рекламодателя, если логотип не будет предоставлен.

Для загрузки этого ресурса через API необходимо использовать advertisers.adAssets.upload .

AdvertiserGeneralConfig

Общие настройки рекламодателя.

JSON-представление 
{
  "domainUrl": string,
  "timeZone": string,
  "currencyCode": string
}
Поля
domainUrl

string

Обязательно. Домен основного веб-сайта рекламодателя. Система будет отправлять эту информацию издателям, которым требуется URL-адрес веб-сайта для привязки рекламной кампании к рекламодателю.

Укажите URL-адрес без пути или строки запроса, начинающийся с http: или https: . Например, http://www.example.com

timeZone

string

Только для вывода. Стандартное имя часового пояса рекламодателя в базе данных TZ. Например, America/New_York .

Подробнее см.: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

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

currencyCode

string

Обязательно. Неизменяемо. Валюта рекламодателя в формате ISO 4217.

Принимаются следующие коды и соответствующие им валюты:

Код валюты: Название валюты

  • ARS : Аргентинский песо
  • AUD : австралийский доллар
  • BRL : Бразильский реал
  • CAD : Канадский доллар
  • CHF : швейцарский франк
  • Чилийский песо CLP :
  • CNY : Китайский юань
  • COP : колумбийский песо
  • CZK : Чешская крона
  • DKK : датская крона
  • Египетский фунт EGP :
  • EUR : Евро
  • GBP : Британский фунт
  • HKD : Гонконгский доллар
  • Венгерский форинт HUF : Венгерский форинт
  • IDR : индонезийская рупия
  • ILS : Израильский шекель
  • INR : Индийская рупия
  • JPY : японская иена
  • KRW : южнокорейская вона
  • MXN : Мексиканский песо
  • MYR : Малайзийский ринггит
  • NGN : нигерийская найра
  • NOK : Норвежская крона
  • NZD : Новозеландский доллар
  • PEN : Peruvian Nuevo Sol
  • PLN : Польский злотый
  • RON : Новый румынский лей
  • RUB : Российский рубль
  • Шведская крона SEK :
  • TRY : Турецкая лира
  • TWD : Новый тайваньский доллар
  • USD : Доллар США
  • ZAR : южноафриканский ранд

AdvertiserAdServerConfig

Настройки рекламного сервера, относящиеся к рекламодателю.

JSON-представление 
{

  // Union field ad_server_config_scheme can be only one of the following:
  "thirdPartyOnlyConfig": {
    object (ThirdPartyOnlyConfig)
  },
  "cmHybridConfig": {
    object (CmHybridConfig)
  }
  // End of list of possible types for union field ad_server_config_scheme.
}
Поля
Поле объединения ad_server_config_scheme . Обязательное поле. ad_server_config_scheme может принимать только одно из следующих значений:
thirdPartyOnlyConfig

object ( ThirdPartyOnlyConfig )

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

cmHybridConfig

object ( CmHybridConfig )

Настройки для рекламодателей, использующих как Campaign Manager 360 (CM360), так и сторонние рекламные серверы.

ThirdPartyOnlyConfig

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

JSON-представление 
{
  "pixelOrderIdReportingEnabled": boolean
}
Поля
pixelOrderIdReportingEnabled

boolean

Включена ли отправка идентификаторов заказов для пикселей. Это значение нельзя изменить после установки на true .

CmHybridConfig

Настройки для рекламодателей, использующих как Campaign Manager 360 (CM360), так и сторонние рекламные серверы.

JSON-представление 
{
  "cmAccountId": string,
  "cmFloodlightConfigId": string,
  "cmAdvertiserIds": [
    string
  ],
  "cmSyncableSiteIds": [
    string
  ],
  "dv360ToCmDataSharingEnabled": boolean,
  "dv360ToCmCostReportingEnabled": boolean,
  "cmFloodlightLinkingAuthorized": boolean
}
Поля
cmAccountId

string ( int64 format)

Обязательно. Неизменяемо. Идентификатор учетной записи конфигурации прожектора CM360, связанной с рекламодателем DV360.

cmFloodlightConfigId

string ( int64 format)

Обязательный. Неизменяемый. Идентификатор конфигурации прожектора CM360, связанного с рекламодателем DV360.

cmAdvertiserIds[]

string ( int64 format)

Только для вывода. Набор идентификаторов рекламодателей CM360, использующих общую конфигурацию CM360 Floodlight.

cmSyncableSiteIds[]

string ( int64 format)

Список сайтов CM360, размещение рекламы на которых будет синхронизировано с DV360 в качестве креативов.

Если поле advertisers.create отсутствует или пусто, система автоматически создаст сайт CM360.

Удаление сайтов из этого списка может привести к удалению креативов DV360, синхронизированных из CM360. Необходимо указать как минимум один сайт.

dv360ToCmDataSharingEnabled

boolean

Следует ли включать данные DV360 в отчеты о передаче данных CM360.

dv360ToCmCostReportingEnabled

boolean

Следует ли сообщать о затратах, понесенных с помощью DV360, в CM360?

cmFloodlightLinkingAuthorized

boolean

Обязательно. Неизменяемо. Установив для этого поля значение true , вы от имени вашей компании разрешаете передачу информации из данной конфигурации Floodlight этому рекламодателю Display & Video 360.

AdvertiserCreativeConfig

Настройки, связанные с креативами, рекламодателя.

JSON-представление 
{
  "iasClientId": string,
  "obaComplianceDisabled": boolean,
  "dynamicCreativeEnabled": boolean,
  "videoCreativeDataSharingAuthorized": boolean
}
Поля
iasClientId

string ( int64 format)

Идентификатор для настройки мониторинга кампаний, предоставляемый Integral Ad Service (IAS). Система DV360 добавит к тегу креатива тег IAS "Монитор кампаний", содержащий этот идентификатор.

obaComplianceDisabled

boolean

Отключать ли функцию Google «Об этом объявлении», которая добавляет к вашим объявлениям значки (для идентификации контента как рекламы) и информацию о прозрачности (при взаимодействии с функцией «Об этом объявлении») для онлайн-поведенческой рекламы (OBA) и в соответствии с нормативными требованиями. Функция «Об этом объявлении» дает пользователям больший контроль над показываемыми им объявлениями и помогает объяснить, почему они видят именно ваше объявление. Подробнее .

Если вы решите установить для этого поля значение true , обратите внимание, что объявления, показываемые через Display & Video 360, должны соответствовать следующим требованиям:

  • В соответствии с вашим договором с маркетинговой платформой Google, соблюдайте требования поведенческой онлайн-рекламы (OBA).
  • В Европейской экономической зоне (ЕЭЗ) необходимо включить информацию о прозрачности и механизм для сообщения пользователями о незаконном контенте в рекламе. При использовании альтернативного решения для маркировки рекламы, обеспечения прозрачности и отчетности необходимо убедиться, что оно включает необходимую информацию о прозрачности и механизм пометки о незаконном контенте, а также уведомить Google о любых сообщениях о незаконном контенте, используя соответствующую форму .
dynamicCreativeEnabled

boolean

Включена ли функция динамического размещения креативов у рекламодателя.

videoCreativeDataSharingAuthorized

boolean

Установив для этого поля значение true , вы от имени своей компании разрешаете Google использовать видеоролики, связанные с этим рекламодателем Display & Video 360, для предоставления отчетов и функций, относящихся к телевизионным рекламным кампаниям рекламодателя.

Применимо только в том случае, если рекламодатель использует CM360 hybrid .

AdvertiserDataAccessConfig

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

JSON-представление 
{
  "sdfConfig": {
    object (AdvertiserSdfConfig)
  }
}
Поля
sdfConfig

object ( AdvertiserSdfConfig )

Настройки файлов структурированных данных (SDF) для рекламодателя.

Если не указано иное, используются настройки SDF родительского партнера.

AdvertiserSdfConfig

Настройки файлов структурированных данных (SDF) рекламодателя.

JSON-представление 
{
  "overridePartnerSdfConfig": boolean,
  "sdfConfig": {
    object (SdfConfig)
  }
}
Поля
overridePartnerSdfConfig

boolean

Переопределяет ли данный рекламодатель конфигурацию SDF своего родительского партнера.

По умолчанию рекламодатель наследует конфигурацию SDF от родительского партнера. Чтобы переопределить конфигурацию партнера, установите для этого поля значение true и укажите новую конфигурацию в sdfConfig .

sdfConfig

object ( SdfConfig )

Конфигурация SDF для рекламодателя.

AdvertiserTargetingConfig

Настройки таргетинга, связанные с показом рекламы рекламодателем.

JSON-представление 
{
  "exemptTvFromViewabilityTargeting": boolean
}
Поля
exemptTvFromViewabilityTargeting

boolean

Распространяется ли действие таргетинга по показателю видимости для всех видеопродуктов, предлагаемых рекламодателем, на устройства Connected TV?

AdvertiserBillingConfig

Настройки выставления счетов рекламодателя.

JSON-представление 
{
  "billingProfileId": string
}
Поля
billingProfileId

string ( int64 format)

Обязательно. Идентификатор платежного профиля, присвоенного рекламодателю.

Методы

audit

 Проводит аудит рекламодателя.

create

 Создает нового рекламодателя.

delete

 Удаляет рекламодателя.

editAssignedTargetingOptions

 Изменяет параметры таргетинга для одного рекламодателя.

get

 Находит рекламодателя.

list

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

listAssignedTargetingOptions

 Отображает список назначенных рекламодателю параметров таргетинга по различным типам таргетинга.

patch

 Обновляет информацию о существующем рекламодателе.