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)

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

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

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

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

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

Перечисления
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-представление
{
  "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.

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

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

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

enum ( PrismaType )

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

prismaCpeCode

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

string

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

prismaProductCode

string

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

prismaEstimateCode

string

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

Методы

bulkListCampaignAssignedTargetingOptions

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

create

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

delete

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

get

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

list

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

patch

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