REST Resource: campaigns

Recurso: Campaign

O recurso campaign representa uma campanha do proprietário do conteúdo específica, que permite ao proprietário do conteúdo usar anotações para promover conteúdo em vídeos reivindicados enviados por usuários. Por exemplo, um proprietário de conteúdo pode criar uma campanha que adiciona links à página de exibição de um filme para qualquer vídeo reivindicado enviado por um usuário que contenha cenas desse filme. Um proprietário de conteúdo do YouTube pode criar até 5.000 campanhas.

Representação JSON 
{
  "kind": string,
  "status": string,
  "campaignData": {
    object (CampaignData)
  },
  "timeCreated": string,
  "timeLastModified": string,
  "id": string
}
Campos
kind

string

O tipo do recurso da API. Para recursos campaign, esse valor é youtubePartner#campaign.
status

string

É o status da campanha.
campaignData

object (CampaignData)

O objeto campaignData contém detalhes como datas de início e término, segmentação e origem da campanha.
timeCreated

string

A hora em que a campanha foi criada.
timeLastModified

string

A hora em que a campanha foi modificada pela última vez.
id

string

O ID exclusivo que o YouTube usa para identificar a campanha.

CampaignData

Esse objeto contém informações detalhadas sobre uma campanha, como as datas de início e término, a meta e a origem da campanha.

Representação JSON 
{
  "name": string,
  "startTime": string,
  "expireTime": string,
  "campaignSource": {
    object (CampaignSource)
  },
  "promotedContent": [
    {
      object (PromotedContent)
    }
  ]
}
Campos
name

string

Nome da campanha definido pelo usuário.
startTime

string

A hora em que a campanha deve começar. Não especifique um valor se a campanha começar imediatamente.
expireTime

string

A hora em que a campanha deve expirar. Não especifique um valor se a campanha não tiver prazo de validade.
campaignSource

object (CampaignSource)

O objeto campaignSource contém informações sobre os recursos para os quais a campanha vai gerar links.
promotedContent[]

object (PromotedContent)

Uma lista de vídeos ou canais que serão vinculados aos vídeos reivindicados incluídos na campanha.

CampaignSource

Um recurso campaignSource contém o tipo e os valores das origens de uma campanha que determinam quais vídeos serão promovidos com conteúdo promocional.

Representação JSON 
{
  "sourceType": string,
  "sourceValue": [
    string
  ]
}
Campos
sourceType

string

O tipo de origem da campanha.
sourceValue[]

string

Uma lista de valores da origem da campanha.

PromotedContent

Esse objeto contém os links como alvo promocional de uma campanha.

Representação JSON 
{
  "link": [
    {
      object (CampaignTargetLink)
    }
  ]
}
Campos

Métodos

delete

 Exclui a campanha especificada de um proprietário.

get

 Recupera uma campanha específica para um proprietário.

insert

 Insira uma nova campanha para um proprietário usando os dados de campanha especificados.

list

 Recupera uma lista de campanhas de um proprietário.

patch

 Corrija os dados de uma campanha específica.

update

 Atualizar os dados de uma campanha específica.