REST Resource: campaigns

Источник: Кампания

Ресурс campaign представляет собой конкретную кампанию владельца контента , которая позволяет ему использовать аннотации для продвижения контента на видео, загруженных пользователями и защищенных авторским правом. Например, владелец контента может создать кампанию, которая добавляет ссылки на страницу просмотра фильма для любых видео, загруженных пользователями и содержащих сцены из этого фильма. Владелец контента на YouTube может создать до 5000 кампаний.

JSON-представление 
{
  "kind": string,
  "status": string,
  "campaignData": {
    object (CampaignData)
  },
  "timeCreated": string,
  "timeLastModified": string,
  "id": string
}
Поля
kind

string

Тип ресурса API. Для ресурсов campaign это значение равно youtubePartner#campaign .

status

string

Текущее состояние кампании.

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

  • active
  • inactive
campaignData

object ( CampaignData )

Объект campaignData содержит такие сведения, как даты начала и окончания кампании, целевая аудитория и источник.

timeCreated

string

Время создания кампании.

timeLastModified

string

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

id

string

Уникальный идентификатор, который YouTube использует для идентификации кампании.

CampaignData

Этот объект содержит подробную информацию о кампании, такую ​​как даты начала и окончания, целевая аудитория и источник кампании.

JSON-представление 
{
  "name": string,
  "startTime": string,
  "expireTime": string,
  "campaignSource": {
    object (CampaignSource)
  },
  "promotedContent": [
    {
      object (PromotedContent)
    }
  ]
}
Поля
name

string

Название кампании, присвоенное пользователем.

startTime

string

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

expireTime

string

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

campaignSource

object ( CampaignSource )

Объект campaignSource содержит информацию об ресурсах, для которых кампания будет генерировать ссылки.

promotedContent[]

object ( PromotedContent )

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

CampaignSource

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

JSON-представление 
{
  "sourceType": string,
  "sourceValue": [
    string
  ]
}
Поля
sourceType

string

Тип источника кампании.

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

  • asset_id
  • asset_label_name
sourceValue[]

string

Список значений источника кампании.

Рекламируемый контент

Этот объект содержит ссылки, являющиеся целевым объектом рекламной кампании.

JSON-представление 
{
  "link": [
    {
      object (CampaignTargetLink)
    }
  ]
}
Поля

Методы

delete

 Удаляет указанную кампанию для владельца.

get

 Получает информацию о конкретной кампании для владельца.

insert

 Вставьте новую рекламную кампанию для владельца, используя указанные данные кампании.

list

 Получает список кампаний для владельца.

patch

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

update

 Обновите данные для конкретной кампании.