Method: videoAdvertisingOptions.getEnabledAds

Recupera detalhes sobre os tipos de anúncios permitidos para um vídeo enviado por um parceiro ou usuário especificado.

Solicitação HTTP

GET https://youtubepartner.googleapis.com/youtube/partner/v1/videoAdvertisingOptions/{videoId}/getEnabledAds

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
videoId

string

O parâmetro videoId especifica o ID do vídeo do YouTube que você quer usar para recuperar as opções de publicidade.

Parâmetros de consulta

Parâmetros
onBehalfOfContentOwner

string

O parâmetro onBehalfOfContentOwner identifica o proprietário do conteúdo em nome de quem o usuário está agindo. Esse parâmetro é compatível com usuários que têm contas associadas a vários proprietários de conteúdo.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Esse recurso identifica as configurações de anúncios de um vídeo reivindicado do YouTube. Ele identifica o vídeo, os horários em que os anúncios podem ser veiculados, os países em que os anúncios podem ser veiculados e os tipos de anúncios permitidos nesses países. Ele também indica se os anúncios podem ser veiculados quando o vídeo é reproduzido em um player incorporado.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "kind": string,
  "countriesRestriction": [
    {
      object (CountriesRestriction)
    }
  ],
  "adBreaks": [
    {
      object (AdBreak)
    }
  ],
  "adsOnEmbeds": boolean,
  "id": string
}
Campos
kind

string

O tipo do recurso da API. Para esse recurso, o valor é youtubePartner#videoAdvertisingOptionGetEnabledAds.

countriesRestriction[]

object (CountriesRestriction)

Uma lista que identifica os países em que os anúncios podem ser veiculados e os tipos de anúncios permitidos nesses países.

adBreaks[]

object (AdBreak)

Uma lista de intervalos de anúncio que ocorrem em um vídeo reivindicado do YouTube.

adsOnEmbeds

boolean

Esse campo indica se o YouTube pode mostrar anúncios quando o vídeo é reproduzido em um player incorporado.

id

string

O ID que o YouTube usa para identificar exclusivamente o vídeo reivindicado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/youtubepartner

Para mais informações, consulte OAuth 2.0 Overview.

CountriesRestriction

Formatos ativados em determinados países, com base na política aplicada.

Representação JSON
{
  "adFormats": [
    string
  ],
  "territories": [
    string
  ]
}
Campos
adFormats[]

string

Uma lista de formatos de anúncio que podem ser usados nos países especificados.

territories[]

string

Uma lista de códigos de países ISO 3166-1 alfa-2 que identificam os países em que os anúncios estão ativados.