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 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "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 )

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

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

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

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

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),

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

enum ( PerformanceGoalType )

Обязательно. Тип целевого показателя эффективности.

Поле объединения performance_goal_value . Обязательно. Значение целевого показателя производительности, соответствующее заданному типу performance_goal_type . performance_goal_value может принимать только одно из следующих значений:
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

Например, 1 500 000 представляет собой 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 Целевой показатель эффективности устанавливается в единицах 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)
  }
}
Поля
plannedSpendAmountMicros

string ( int64 format)

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

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

plannedDates

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

string ( int64 format)

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

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

displayName

string

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

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

budgetUnit

enum ( BudgetUnit )

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

budgetAmountMicros

string ( int64 format)

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

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

dateRange

object ( DateRange )

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

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

externalBudgetSource

enum ( ExternalBudgetSource )

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

externalBudgetId

string

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

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

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

invoiceGroupingId

string

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

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

prismaConfig

object ( PrismaConfig )

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

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

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

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

Внешний источник информации для одного из разделов бюджета избирательной кампании.

Перечисления
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

Обязательно. Укажите организацию, выделившую этот бюджет (DSP, подразделение и т. д.).

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

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