REST Resource: advertisers

Ресурс: рекламодатель

Один рекламодатель в Дисплее и Видео 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. Допустимы и другие типы нормализации. Примеры: "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 и в кампаниях для создания спроса, если название компании не указано.
defaultLogoAssetId

string (int64 format)

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

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

Чтобы загрузить этот объект с помощью API, используйте advertisers.adAssets.upload.

AdvertiserGeneralConfig

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

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

string

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

Укажите URL без пути или строки запроса, который начинается с http: или https:. Пример: http://www.example.com.
timeZone

string

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

Подробнее: 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 – перуанский новый соль;
  • PLN – польский злотый;
  • RON – новый румынский лей;
  • RUB – российский рубль;
  • SEK – шведская крона;
  • TRY – турецкая лира;
  • TWD – новый тайваньский доллар;
  • USD – доллар США;
  • ZAR – южноафриканский рэнд;

AdvertiserAdServerConfig

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "thirdPartyOnlyConfig": {
    object (ThirdPartyOnlyConfig)
  },
  "cmHybridConfig": {
    object (CmHybridConfig)
  }
  // End of mutually exclusive fields.
}
Поля
Обязательно. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
thirdPartyOnlyConfig

object (ThirdPartyOnlyConfig)

Конфигурация для рекламодателей, которые используют только сторонние серверы объявлений.
cmHybridConfig

object (CmHybridConfig)

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

ThirdPartyOnlyConfig

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

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

boolean

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

CmHybridConfig

Настройки для рекламодателей, которые используют и Менеджер кампаний 360, и сторонние серверы объявлений.

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

Если в методе advertisers.create это поле отсутствует или не заполнено, система автоматически создаст сайт Менеджера кампаний 360.

Если вы удалите сайты из этого списка, креативы Дисплея и Видео 360, синхронизированные из Менеджера кампаний 360, могут быть удалены. Необходимо указать хотя бы один сайт.
dv360ToCmDataSharingEnabled

boolean

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

boolean

Указывает, нужно ли передавать данные о расходах в Дисплее и Видео 360 в Менеджер кампаний 360.
cmFloodlightLinkingAuthorized

boolean

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

AdvertiserCreativeConfig

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

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

string (int64 format)

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

boolean

Вы можете отключить функцию Google "Об этой рекламе", которая добавляет в объявления значок рекламы и информацию о рекламодателе (показывается при взаимодействии с функцией "Об этой рекламе"). Это необходимо для соблюдения нормативных требований и правил в отношении поведенческой рекламы. Функция "Об этой рекламе" позволяет пользователям более эффективно управлять рекламой, которая им показывается, а вам – объяснять пользователям, почему они видят ваше объявление. Подробнее…

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

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

boolean

Включены ли динамические объявления для рекламодателя.
videoCreativeDataSharingAuthorized

boolean

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

Применимо, только если у рекламодателя есть конфигурация сервера объявлений CM360 hybrid.

AdvertiserDataAccessConfig

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

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

object (AdvertiserSdfConfig)

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

Если не указано, используются настройки 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

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

AdvertiserBillingConfig

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

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

string (int64 format)

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

Методы

audit

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

create

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

delete

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

editAssignedTargetingOptions

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

get

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

list

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

listAssignedTargetingOptions

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

patch

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