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

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

string (int64 format)

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

string (int64 format)

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

string

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

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

enum (EntityStatus)

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

  • Допустимые значения: ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED и ENTITY_STATUS_PAUSED.
  • Для метода campaigns.create не разрешено значение ENTITY_STATUS_ARCHIVED.
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".
campaignGoal

object (CampaignGoal)

Обязательно. Цель кампании.
campaignFlight

object (CampaignFlight)

Обязательно. Запланированные расходы и продолжительность кампании.
frequencyCap

object (FrequencyCap)

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

object (CampaignBudget)

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

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

CampaignGoal

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

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

enum (CampaignGoalType)

Обязательно. Тип цели кампании.
performanceGoal

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

CampaignGoalType

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

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

PerformanceGoal

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of mutually exclusive fields.
}
Поля
performanceGoalType

enum (PerformanceGoalType)

Обязательно. Тип цели по эффективности.
Обязательно. Значение цели по эффективности, соответствующее заданному performance_goal_type. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
performanceGoalAmountMicros

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 стандартной единицы валюты.
performanceGoalPercentageMicros

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).
performanceGoalString

string

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

Применимо, если для параметра performanceGoalType задано значение PERFORMANCE_GOAL_TYPE_OTHER.
Конец взаимоисключающих полей.

PerformanceGoalType

Возможные типы целей по эффективности.

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

CampaignFlight

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

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

string (int64 format)

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

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

object (DateRange)

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

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

CampaignBudget

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

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

string (int64 format)

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

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

string

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

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

enum (BudgetUnit)

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

string (int64 format)

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

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

object (DateRange)

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

Значения startDate и endDate должны быть до 2037 года.
externalBudgetSource

enum (ExternalBudgetSource)

Обязательно. Внешний источник бюджета.
externalBudgetId

string

Не меняется. Идентификатор, по которому этот бюджет определяется во внешнем источнике.

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

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

string

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

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

object (PrismaConfig)

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

Обязательно для бюджетов Mediaocean.

Только для рекламодателей из prismaEnabled.

ExternalBudgetSource

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

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

PrismaConfig

Настройки, относящиеся к инструменту Mediaocean Prisma.

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

enum (PrismaType)

Обязательно. Тип инструмента Prisma.
prismaCpeCode

object (PrismaCpeCode)

Обязательно. Коды, связанные с клиентом, продуктом и расчетами, из инструмента Mediaocean Prisma.
supplier

string

Обязательно. Объект, которому выделен этот бюджет (платформа покупателя, сайт и т. д.).

PrismaType

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

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

PrismaCpeCode

В платежном центре Google можно выполнять поиск и фильтрацию по полям, из которых состоит этот код.

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

string

Код клиента в инструменте Prisma.
prismaProductCode

string

Код продукта в инструменте Prisma.
prismaEstimateCode

string

Расчетный код в инструменте Prisma.

Методы

create

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

delete

 Удаляет кампанию без возможности восстановления.

get

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

list

 Возвращает список кампаний рекламодателя.

patch

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