REST Resource: advertisers.campaigns

Ресурс: Кампания

Единая кампания.

JSON-представление 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}
Поля
name

string

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

advertiser Id

string ( int64 format)

Только вывод. Уникальный идентификатор рекламодателя, которому принадлежит кампания.

campaign Id

string ( int64 format)

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

display Name

string

Необходимый. Отображаемое название кампании.

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

entity Status

enum ( EntityStatus )

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

  • Допустимые значения: ENTITY_STATUS_ACTIVE , ENTITY_STATUS_ARCHIVED и ENTITY_STATUS_PAUSED .
  • Для метода campaigns.create ENTITY_STATUS_ARCHIVED не разрешен.
update Time

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

campaign Goal

object ( CampaignGoal )

Необходимый. Цель кампании.

campaign Flight

object ( CampaignFlight )

Необходимый. Планируемые расходы и продолжительность кампании.

frequency Cap

object ( FrequencyCap )

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

campaign Budgets[]

object ( CampaignBudget )

Список бюджетов, доступных для этой кампании.

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

Цель кампании

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

JSON-представление 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
Поля
campaign Goal Type

enum ( CampaignGoalType )

Необходимый. Тип цели кампании.

performance Goal

object ( PerformanceGoal )

Необходимый. Цель кампании.

Допустимые значения для performanceGoalType :

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_OTHER

Тип цели кампании

Возможные типы целей кампании.

Перечисления
CAMPAIGN_GOAL_TYPE_UNSPECIFIED В этой версии ценность цели не указана или неизвестна.
CAMPAIGN_GOAL_TYPE_APP_INSTALL Повышайте количество установок приложения или вовлеченность.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Повышайте узнаваемость бренда или продукта.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Увеличьте продажи офлайн или в магазине.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Стимулируйте действия или посещения в Интернете.

Цель производительности

Настройки, определяющие цель эффективности кампании.

JSON-представление 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}
Поля
performance Goal Type

enum ( PerformanceGoalType )

Необходимый. Тип цели производительности.

Поле объединения performance_goal_value . Необходимый. Значение цели производительности, соответствующее данному performance_goal_type . performance_goal_value может быть только одним из следующих:
performance Goal Amount Micros

string ( int64 format)

Целевая сумма в микронах валюты рекламодателя.

Применимо, когда performanceGoalType является одним из:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

Например, 1500000 представляет собой 1,5 стандартных единицы валюты.

performance Goal Percentage Micros

string ( int64 format)

Десятичное представление процента цели в микронах.

Применимо, когда performanceGoalType является одним из:

  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_CLICK_CVR
  • PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
  • PERFORMANCE_GOAL_TYPE_VTR
  • PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
  • PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

Например, 70000 представляет собой 7% (десятичное 0,07).

performance Goal String

string

Строка ключевого показателя эффективности (KPI), которая может быть пустой. Должен иметь кодировку UTF-8 и длину не более 100 символов.

Применимо, если для performanceGoalType установлено значение PERFORMANCE_GOAL_TYPE_OTHER .

Тип цели производительности

Возможные типы целей производительности.

Перечисления
PERFORMANCE_GOAL_TYPE_UNSPECIFIED В этой версии тип цели по эффективности не указан или неизвестен.
PERFORMANCE_GOAL_TYPE_CPM Цель по производительности устанавливается в CPM (стоимость за тысячу показов).
PERFORMANCE_GOAL_TYPE_CPC Цель по эффективности устанавливается в CPC (цена за клик).
PERFORMANCE_GOAL_TYPE_CPA Цель по эффективности устанавливается в CPA (цена за действие).
PERFORMANCE_GOAL_TYPE_CTR Цель эффективности устанавливается в процентах CTR (рейтинг кликов).
PERFORMANCE_GOAL_TYPE_VIEWABILITY Цель эффективности задается в процентах видимости.
PERFORMANCE_GOAL_TYPE_CPIAVC Целью эффективности является CPIAVC (цена за показ слышна и видна при завершении).
PERFORMANCE_GOAL_TYPE_CPE Цель производительности устанавливается в CPE (цена за взаимодействие).
PERFORMANCE_GOAL_TYPE_CPV Цель по эффективности устанавливается в CPV (стоимость за просмотр).
PERFORMANCE_GOAL_TYPE_CLICK_CVR Цель по эффективности устанавливается в процентах от коэффициента конверсии кликов (конверсий на клик).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR Цель по эффективности устанавливается в процентах от коэффициента конверсии показов (конверсий на показ).
PERFORMANCE_GOAL_TYPE_VCPM Цель по эффективности устанавливается в VCPM (стоимость за тысячу видимых показов).
PERFORMANCE_GOAL_TYPE_VTR Цель по эффективности устанавливается в процентах от процента просмотров YouTube (просмотров YouTube на показ).
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE Цель производительности устанавливается в процентах от процента завершения аудио (полных прослушиваний аудио на показ).
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE Цель по эффективности устанавливается в процентах от процента завершения видео (полных просмотров видео на показ).
PERFORMANCE_GOAL_TYPE_OTHER Цель производительности установлена ​​на «Другое».

КампанияПолет

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

JSON-представление 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
Поля
planned Spend Amount Micros

string ( int64 format)

Сумма, которую кампания, как ожидается, потратит за заданные plannedDates . Это не приведет к ограничению показов, но будет использоваться для отслеживания расходов в пользовательском интерфейсе DV360.

Сумма указана в микронах. Должно быть больше или равно 0. Например, 500000000 представляет собой 500 стандартных единиц валюты.

planned Dates

object ( DateRange )

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

  • Указанные здесь даты не повлияют на показ. Они используются для генерации оповещений и предупреждений. Например, если дата окончания любого дочернего заказа на размещение выходит за пределы этих дат, в пользовательском интерфейсе отобразится предупреждение.
  • startDate является обязательным и должен быть текущей датой или более поздней.
  • endDate является необязательным. Если указано, это должна быть startDate или более поздняя.
  • Любая указанная дата должна быть до 2037 года.

Бюджет кампании

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

JSON-представление 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
Поля
budget Id

string ( int64 format)

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

Необходимо включать при обновлении или добавлении бюджетов в campaignBudgets . В противном случае будет создан и присвоен новый идентификатор.

display Name

string

Необходимый. Отображаемое имя бюджета.

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

budget Unit

enum ( BudgetUnit )

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

budget Amount Micros

string ( int64 format)

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

Сумма указана в микронах. Должно быть больше 0. Например, 500000000 представляет 500 стандартных единиц валюты.

date Range

object ( DateRange )

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

И startDate , и endDate должны быть раньше 2037 года.

external Budget Source

enum ( ExternalBudgetSource )

Необходимый. Внешний источник бюджета.

external Budget Id

string

Неизменяемый. Идентификатор, идентифицирующий этот бюджет для внешнего источника.

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

Должно быть уникальным в рамках кампании.

invoice Grouping Id

string

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

Если это поле установлено, а уровень счета соответствующего профиля выставления счетов установлен на «Идентификатор группировки счетов бюджета», все externalBudgetId имеющие один и тот же invoiceGroupingId будут сгруппированы в одном счете.

prisma Config

object ( PrismaConfig )

Дополнительные метаданные для использования инструментом Mediaocean Prisma.

Требуется для бюджетов Mediaocean.

Применимо только к рекламодателям prismaEnabled .

Внешний бюджетный источник

Внешний источник для сегмента бюджета кампании.

Перечисления
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED Значение внешнего источника бюджета в этой версии не указано или неизвестно.
EXTERNAL_BUDGET_SOURCE_NONE Бюджет не имеет внешнего источника.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN Источник бюджета – Mediaocean.

ПризмаКонфиг

Настройки, специфичные для инструмента Mediaocean Prisma.

JSON-представление 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
Поля
prisma Type

enum ( PrismaType )

Необходимый. Тип Призма.

prisma Cpe Code

object ( PrismaCpeCode )

Необходимый. Соответствующие коды клиентов, продуктов и смет из инструмента Mediaocean Prisma.

supplier

string

Необходимый. Организация выделила этот бюджет (DSP, сайт и т. д.).

ПризмаТип

Возможные типы бюджета Prisma.

Перечисления
PRISMA_TYPE_UNSPECIFIED В этой версии тип не указан или неизвестен.
PRISMA_TYPE_DISPLAY Тип дисплея.
PRISMA_TYPE_VIDEO Тип видео.
PRISMA_TYPE_AUDIO Тип аудио.
PRISMA_TYPE_SOCIAL Социальный тип.
PRISMA_TYPE_FEE Тип комиссии.

ПризмаКпеКод

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

JSON-представление 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
Поля
prisma Client Code

string

Клиентский код Prisma.

prisma Product Code

string

Код продукта Prisma.

prisma Estimate Code

string

Оценочный код Prisma.

Методы

create

 Создает новую кампанию.

delete

 Безвозвратно удаляет кампанию.

get

 Получает кампанию.

list

 Перечисляет кампании рекламодателя.

list Assigned Targeting Options

 Перечисляет назначенные параметры таргетинга кампании по типам таргетинга.

patch

 Обновляет существующую кампанию.