REST Resource: advertisers.adGroupAds

Recurso: adgroupAd

Um único anúncio associado a um grupo de anúncios.

Representação JSON 
{
  "name": string,
  "advertiserId": string,
  "adGroupAdId": string,
  "adGroupId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "adUrls": [
    {
      object (AdUrl)
    }
  ],

  // Union field ad_details can be only one of the following:
  "displayVideoSourceAd": {
    object (DisplayVideoSourceAd)
  },
  "mastheadAd": {
    object (MastheadAd)
  },
  "inStreamAd": {
    object (InStreamAd)
  },
  "nonSkippableAd": {
    object (NonSkippableAd)
  },
  "bumperAd": {
    object (BumperAd)
  },
  "audioAd": {
    object (AudioAd)
  },
  "videoDiscoverAd": {
    object (VideoDiscoveryAd)
  },
  "videoPerformanceAd": {
    object (VideoPerformanceAd)
  }
  // End of list of possible types for union field ad_details.
}
Campos
name

string

O nome do recurso do anúncio.
advertiserId

string (int64 format)

O ID exclusivo do anunciante ao qual o anúncio pertence.
adGroupAdId

string (int64 format)

O ID exclusivo do anúncio. Atribuído pelo sistema.
adGroupId

string (int64 format)

O ID exclusivo do grupo de anúncios ao qual o anúncio pertence.
displayName

string

O nome de exibição do anúncio.

Precisa ser codificado em UTF-8 com um tamanho máximo de 255 bytes.
entityStatus

enum (EntityStatus)

O status de entidade do anúncio.
adUrls[]

object (AdUrl)

Lista de URLs usados pelo anúncio.
Campo de união ad_details. Os detalhes do anúncio. ad_details pode ser apenas de um dos tipos a seguir:
displayVideoSourceAd

object (DisplayVideoSourceAd)

Detalhes de um anúncio originado de um criativo do Display & Video 360.
mastheadAd

object (MastheadAd)

Detalhes de um anúncio veiculado no feed da página inicial do YouTube
inStreamAd

object (InStreamAd)

Detalhes de um anúncio in-stream pulável após cinco segundos usado para reconhecimento da marca ou objetivos de marketing
nonSkippableAd

object (NonSkippableAd)

Detalhes de um anúncio em vídeo in-stream curto e não pulável, de 6 a 15 segundos, usado para alcançar objetivos de marketing
bumperAd

object (BumperAd)

Detalhes de um anúncio em vídeo curto não pulável com até seis segundos, usado para alcance.
audioAd

object (AudioAd)

Detalhes de um anúncio em áudio usado para alcançar objetivos de marketing
videoDiscoverAd

object (VideoDiscoveryAd)

Detalhes de um anúncio que promove um vídeo que é exibido em locais de descoberta.
videoPerformanceAd

object (VideoPerformanceAd)

Detalhes de um anúncio usado em uma campanha de ação em vídeo com o objetivo de gerar ações para a empresa, o serviço ou o produto.

DisplayVideoSourceAd

O anúncio veio de um criativo do DV360.

Representação JSON 
{
  "creativeId": string
}
Campos
creativeId

string (int64 format)

O ID do criativo de origem.

MastheadAd

Detalhes de um anúncio de masthead

Representação JSON 
{
  "video": {
    object (YoutubeVideoDetails)
  },
  "headline": string,
  "description": string,
  "videoAspectRatio": enum (VideoAspectRatio),
  "autoplayVideoStartMillisecond": string,
  "autoplayVideoDuration": string,
  "callToActionButtonLabel": string,
  "callToActionFinalUrl": string,
  "callToActionTrackingUrl": string,
  "showChannelArt": boolean,
  "companionYoutubeVideos": [
    {
      object (YoutubeVideoDetails)
    }
  ]
}
Campos
video

object (YoutubeVideoDetails)

O vídeo do YouTube usado pelo anúncio.
headline

string

Título do anúncio.
description

string

Descrição do anúncio.
videoAspectRatio

enum (VideoAspectRatio)

A proporção do vídeo do YouTube em reprodução automática no masthead.
autoplayVideoStartMillisecond

string (int64 format)

O tempo em milissegundos para que o vídeo comece a ser reproduzido.
autoplayVideoDuration

string (Duration format)

O tempo de reprodução automática do vídeo.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
callToActionButtonLabel

string

O texto no botão de call-to-action.
callToActionFinalUrl

string

O URL de destino do botão de call-to-action.
callToActionTrackingUrl

string

É o URL de rastreamento do botão de call-to-action.
showChannelArt

boolean

Se é necessário mostrar um plano de fundo ou um banner que aparece na parte superior de uma página do YouTube.
companionYoutubeVideos[]

object (YoutubeVideoDetails)

Os vídeos que aparecem ao lado do anúncio de masthead no computador. Não pode ser mais de dois.

YoutubeVideoDetails

Detalhes de um vídeo do YouTube

Representação JSON 
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
Campos
id

string

O ID do vídeo do YouTube, que pode ser pesquisado na página da Web do YouTube.
unavailableReason

enum (VideoUnavailableReason)

É o motivo pelo qual os dados do vídeo não estão disponíveis.

VideoUnavailableReason

Possíveis motivos para a indisponibilidade de um vídeo.

Enums
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED Desconhecido ou não especificado.
VIDEO_UNAVAILABLE_REASON_PRIVATE O vídeo é particular.
VIDEO_UNAVAILABLE_REASON_DELETED O vídeo foi excluído.

VideoAspectRatio

Possíveis proporções de um vídeo do YouTube.

Enums
VIDEO_ASPECT_RATIO_UNSPECIFIED Não especificado ou desconhecido.
VIDEO_ASPECT_RATIO_WIDESCREEN O vídeo fica esticado, e as partes de cima e de baixo são cortadas.
VIDEO_ASPECT_RATIO_FIXED_16_9 O vídeo usa uma proporção fixa de 16:9.

InStreamAd

Detalhes de um anúncio in-stream

Representação JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Campos
commonInStreamAttribute

object (CommonInStreamAttribute)

Atributos de anúncio comuns.
customParameters

map (key: string, value: string)

Os parâmetros personalizados para transmitir valores personalizados ao modelo de URL de rastreamento.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CommonInStreamAttribute

Atributos comuns para anúncios in-stream, bumper e não puláveis.

Representação JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
Campos
displayUrl

string

O endereço da página da Web que aparece com o anúncio.
finalUrl

string

O endereço de URL da página da Web que as pessoas acessam após clicar no anúncio.
trackingUrl

string

O endereço do URL carregado em segundo plano para fins de rastreamento.
actionButtonLabel

string

O texto no botão de call-to-action.
actionHeadline

string

O título do banner de call-to-action.
video

object (YoutubeVideoDetails)

O vídeo do anúncio no YouTube.
companionBanner

object (ImageAsset)

A imagem exibida ao lado do anúncio em vídeo.

ImageAsset

Metadados de um recurso de imagem.

Representação JSON 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
Campos
mimeType

string

Tipo MIME do recurso de imagem.
fullSize

object (Dimensions)

Metadados desta imagem no tamanho original.
fileSize

string (int64 format)

Tamanho do arquivo do recurso de imagem em bytes.

NonSkippableAd

Detalhes de um anúncio não pulável.

Representação JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Campos
commonInStreamAttribute

object (CommonInStreamAttribute)

Atributos de anúncio comuns.
customParameters

map (key: string, value: string)

Os parâmetros personalizados para transmitir valores personalizados ao modelo de URL de rastreamento.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BumperAd

Detalhes de um anúncio bumper

Representação JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
Campos
commonInStreamAttribute

object (CommonInStreamAttribute)

Atributos de anúncio comuns.

AudioAd

Detalhes de um anúncio em áudio

Representação JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
Campos
displayUrl

string

O endereço da página da Web que aparece com o anúncio.
finalUrl

string

O endereço de URL da página da Web que as pessoas acessam após clicar no anúncio.
trackingUrl

string

O endereço do URL carregado em segundo plano para fins de rastreamento.
video

object (YoutubeVideoDetails)

O vídeo do anúncio no YouTube.

VideoDiscoveryAd

Detalhes de um anúncio video discovery.

Representação JSON 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
Campos
headline

string

Título do anúncio.
description1

string

Primeira linha de texto do anúncio.
description2

string

Segunda linha de texto do anúncio.
video

object (YoutubeVideoDetails)

O vídeo do YouTube que o anúncio promove.
thumbnail

enum (Thumbnail)

Imagem em miniatura usada no anúncio.

Miniatura

Possíveis opções de miniaturas nos anúncios Discovery de vídeo.

Enums
THUMBNAIL_UNSPECIFIED Desconhecido ou não especificado.
THUMBNAIL_DEFAULT A miniatura padrão pode ser gerada automaticamente ou enviada pelo usuário.
THUMBNAIL_1 Miniatura 1, gerada do vídeo.
THUMBNAIL_2 Miniatura 2, gerada do vídeo.
THUMBNAIL_3 Miniatura 3, gerada do vídeo.

VideoPerformanceAd

Detalhes de um anúncio de desempenho em vídeo

Representação JSON 
{
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabels": [
    string
  ],
  "headlines": [
    string
  ],
  "longHeadlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string,
  "domain": string,
  "videos": [
    {
      object (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanners": [
    {
      object (ImageAsset)
    }
  ]
}
Campos
finalUrl

string

O endereço de URL da página da Web que as pessoas acessam após clicar no anúncio.
trackingUrl

string

O endereço do URL carregado em segundo plano para fins de rastreamento.
actionButtonLabels[]

string

A lista de recursos de texto mostrados no botão de call-to-action.
headlines[]

string

É a lista de títulos exibidos no banner de call-to-action.
longHeadlines[]

string

É a lista de títulos únicos exibidos no banner de call-to-action.
descriptions[]

string

É a lista de descrições exibidas no banner de call-to-action.
displayUrlBreadcrumb1

string

A primeira parte após o domínio no URL de visualização.
displayUrlBreadcrumb2

string

A segunda parte depois do domínio no URL de visualização.
domain

string

O domínio do URL de visualização.
videos[]

object (YoutubeVideoDetails)

A lista de recursos de vídeo do YouTube usados por este anúncio.
customParameters

map (key: string, value: string)

Os parâmetros personalizados para transmitir valores personalizados ao modelo de URL de rastreamento.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
companionBanners[]

object (ImageAsset)

A lista de banners complementares usados por este anúncio.

AdUrl

URLs adicionais relacionados ao anúncio, incluindo beacons.

Representação JSON 
{
  "type": enum (AdUrlType),
  "url": string
}
Campos
type

enum (AdUrlType)

O tipo de URL do anúncio.
url

string

O valor da string do URL.

AdUrlType

Possíveis tipos de URL do anúncio.

Enums
AD_URL_TYPE_UNSPECIFIED Desconhecido ou não especificado.
AD_URL_TYPE_BEACON_IMPRESSION Um pixel de rastreamento 1 x 1 para executar um ping quando a impressão de um criativo for exibida.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION beacon de impressão do DCM expansível. No momento de disponibilização, ele é expandido para vários beacons.
AD_URL_TYPE_BEACON_CLICK URL de rastreamento para dar um ping quando o evento de clique for acionado.
AD_URL_TYPE_BEACON_SKIP URL de rastreamento para dar um ping quando o evento "skip" for acionado.

Métodos

get

 Recebe um anúncio do grupo de anúncios.

list

 Lista os anúncios do grupo de anúncios.