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

Например, 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 Цель эффективности задается в 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 Цель производительности установлена на «Другое».

CampaignFlight

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

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

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

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

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

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

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

listAssignedTargetingOptions

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

patch

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