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,
  "adPolicy": {
    object (AdPolicy)
  },
  "entityStatus": enum (EntityStatus),
  "adUrls": [
    {
      object (AdUrl)
    }
  ],
  "dcmTrackingInfo": {
    object (DcmTrackingInfo)
  },

  // 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)
  },
  "demandGenVideoAd": {
    object (DemandGenVideoAd)
  },
  "demandGenImageAd": {
    object (DemandGenImageAd)
  },
  "demandGenCarouselAd": {
    object (DemandGenCarouselAd)
  },
  "demandGenProductAd": {
    object (DemandGenProductAd)
  }
  // End of list of possible types for union field ad_details.
}
Campos
name

string

Apenas saída. O nome do recurso do anúncio.

advertiserId

string (int64 format)

Apenas saída. O ID exclusivo do anunciante a que o anúncio pertence.

adGroupAdId

string (int64 format)

Apenas saída. O ID exclusivo do anúncio. Atribuído pelo sistema.

adGroupId

string (int64 format)

Obrigatório. Imutável. O ID exclusivo do grupo de anúncios a que o anúncio pertence.

displayName

string

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

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

adPolicy

object (AdPolicy)

Apenas saída. O status de aprovação da política do anúncio.

entityStatus

enum (EntityStatus)

Obrigatório. O status da entidade do anúncio.

adUrls[]

object (AdUrl)

Apenas saída. Lista de URLs usados pelo anúncio.

dcmTrackingInfo

object (DcmTrackingInfo)

Opcional. As informações do anúncio de acompanhamento do DCM. Válido apenas para anúncios da Geração de demanda.

Para remover as informações do anúncio de rastreamento do DCM, deixe este campo em branco.

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)

Apenas saída. Detalhes de um anúncio originado de um criativo do Display & Video 360.

mastheadAd

object (MastheadAd)

Apenas saída. Detalhes de um anúncio veiculado no feed da página inicial do YouTube.

inStreamAd

object (InStreamAd)

Apenas saída. Detalhes de um anúncio in-stream pulável após 5 segundos, usado para objetivos de marketing de reconhecimento da marca ou alcance.

nonSkippableAd

object (NonSkippableAd)

Apenas saída. Detalhes de um anúncio em vídeo in-stream curto não pulável, entre 6 e 15 segundos, usado para objetivos de marketing de alcance.

bumperAd

object (BumperAd)

Apenas saída. Detalhes de um anúncio em vídeo curto não pulável, com duração igual ou inferior a 6 segundos, usado para alcance.

audioAd

object (AudioAd)

Apenas saída. Detalhes de um anúncio em áudio usado para alcançar objetivos de marketing.

videoDiscoverAd

object (VideoDiscoveryAd)

Apenas saída. Detalhes de um anúncio que promove um vídeo e aparece em locais de descoberta.

videoPerformanceAd

object (VideoPerformanceAd)

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

demandGenVideoAd

object (DemandGenVideoAd)

Detalhes de um anúncio em vídeo da Geração de demanda.

demandGenImageAd

object (DemandGenImageAd)

Detalhes de um anúncio gráfico da Geração de demanda.

demandGenProductAd

object (DemandGenProductAd)

Detalhes de um anúncio de produto da Geração de demanda.

AdPolicy

Uma única política de anúncios associada a um anúncio de grupo de anúncios.

Representação JSON
{
  "adPolicyApprovalStatus": enum (AdPolicyApprovalStatus),
  "adPolicyReviewStatus": enum (AdPolicyReviewStatus),
  "adPolicyTopicEntry": [
    {
      object (AdPolicyTopicEntry)
    }
  ]
}
Campos
adPolicyApprovalStatus

enum (AdPolicyApprovalStatus)

O status de aprovação da política de um anúncio, indicando a decisão de aprovação.

adPolicyReviewStatus

enum (AdPolicyReviewStatus)

O status da análise de conformidade com a política de um anúncio, indicando em que etapa do processo de análise ele está.

adPolicyTopicEntry[]

object (AdPolicyTopicEntry)

As entradas de cada tema de política identificado como relacionado ao anúncio. Cada entrada inclui o tópico, o nível de restrição e orientações sobre como corrigir problemas de política.

AdPolicyApprovalStatus

Possíveis status de aprovação de uma política de anúncios.

Tipos enumerados
AD_POLICY_APPROVAL_STATUS_UNKNOWN Desconhecido ou não especificado.
DISAPPROVED Não será disponibilizado.
APPROVED_LIMITED Será veiculado com restrições.
APPROVED Será veiculado sem restrições.
AREA_OF_INTEREST_ONLY Não será veiculado nos países de destino, mas poderá ser veiculado para usuários que pesquisam informações sobre eles.

AdPolicyReviewStatus

Possíveis status de uma análise de conformidade com a política de anúncios.

Tipos enumerados
AD_POLICY_REVIEW_STATUS_UNKNOWN Desconhecido ou não especificado.
REVIEW_IN_PROGRESS No momento, está em revisão.
REVIEWED Análise principal concluída. Outras análises ainda podem estar em andamento.
UNDER_APPEAL Foi reenviado para aprovação ou uma decisão sobre políticas foi contestada.
ELIGIBLE_MAY_SERVE Considerado qualificado e pode estar sendo veiculado. Outras análises ainda podem ser feitas.

AdPolicyTopicEntry

Uma entrada que descreve como um anúncio foi identificado como relacionado a uma política de anúncios.

Representação JSON
{
  "policyTopic": string,
  "policyLabel": string,
  "policyTopicDescription": string,
  "policyTopicType": enum (AdPolicyTopicEntryType),
  "policyDecisionType": enum (AdPolicyDecisionType),
  "policyEnforcementMeans": enum (AdPolicyEnforcementMeans),
  "policyTopicEvidences": [
    {
      object (AdPolicyTopicEvidence)
    }
  ],
  "policyTopicConstraints": [
    {
      object (AdPolicyTopicConstraint)
    }
  ],
  "helpCenterLink": string,
  "appealInfo": {
    object (AdPolicyTopicAppealInfo)
  }
}
Campos
policyTopic

string

O tópico da política.

Por exemplo, "MARCAS COMERCIAIS", "ÁLCOOL" etc.

policyLabel

string

Texto do rótulo localizado para a política.

Por exemplo, "Marcas registradas em texto", "Contém álcool" etc.

policyTopicDescription

string

Uma breve descrição do tema da política.

policyTopicType

enum (AdPolicyTopicEntryType)

Como a veiculação de anúncios será afetada devido à relação com o tema da política de anúncios.

policyDecisionType

enum (AdPolicyDecisionType)

A origem da decisão relacionada à política.

policyEnforcementMeans

enum (AdPolicyEnforcementMeans)

Os meios de aplicação da política usados na análise de conformidade com a política.

policyTopicEvidences[]

object (AdPolicyTopicEvidence)

As evidências usadas na decisão da política.

policyTopicConstraints[]

object (AdPolicyTopicConstraint)

As restrições de veiculação relevantes para a decisão relacionada à política.

appealInfo

object (AdPolicyTopicAppealInfo)

Informações sobre como contestar a decisão relacionada à política.

AdPolicyTopicEntryType

Possíveis impactos na veiculação de um tema da política de anúncios.

Tipos enumerados
AD_POLICY_TOPIC_ENTRY_TYPE_UNKNOWN Desconhecido ou não especificado.
PROHIBITED O recurso não será veiculado.
FULLY_LIMITED O recurso não será veiculado em todos os países de destino.
LIMITED O recurso não pode ser veiculado em alguns países.
DESCRIPTIVE O recurso pode veicular.
BROADENING O recurso pode veicular e veicular além da cobertura normal.
AREA_OF_INTEREST_ONLY O recurso é restrito para todos os países de destino, mas pode ser veiculado para usuários que estão pesquisando informações sobre esses países.

AdPolicyDecisionType

Possíveis fontes de uma decisão relacionada à política.

Tipos enumerados
AD_POLICY_DECISION_TYPE_UNKNOWN Desconhecido ou não especificado.
PURSUANT_TO_NOTICE A decisão é de uma notificação judicial, uma ordem judicial, uma reclamação do proprietário do conteúdo da marca registrada etc.
GOOGLE_INVESTIGATION A decisão é de uma investigação do Google.

AdPolicyEnforcementMeans

Possíveis meios de aplicação da política usados na análise de conformidade com a política.

Tipos enumerados
AD_POLICY_ENFORCEMENT_MEANS_UNKNOWN Desconhecido ou não especificado.
AUTOMATED O processo de aplicação era totalmente automatizado.
HUMAN_REVIEW Um humano participou parcial ou totalmente do processo de aplicação da decisão.

AdPolicyTopicEvidence

Informações de evidências usadas na decisão da política.

Representação JSON
{

  // Union field value can be only one of the following:
  "textList": {
    object (TextList)
  },
  "websiteList": {
    object (WebsiteList)
  },
  "httpCode": integer,
  "languageCode": string,
  "destinationTextList": {
    object (DestinationTextList)
  },
  "destinationMismatch": {
    object (DestinationMismatch)
  },
  "destinationNotWorking": {
    object (DestinationNotWorking)
  },
  "trademark": {
    object (Trademark)
  },
  "legalRemoval": {
    object (LegalRemoval)
  },
  "counterfeit": {
    object (Counterfeit)
  },
  "regionalRequirements": {
    object (RegionalRequirements)
  }
  // End of list of possible types for union field value.
}
Campos
Campo de união value. A evidência da decisão relacionada à política. value pode ser apenas de um dos tipos a seguir:
textList

object (TextList)

Lista de evidências encontradas no texto do anúncio.

websiteList

object (WebsiteList)

Lista de sites vinculados ao anúncio.

httpCode

integer

Código HTTP retornado quando o URL final foi rastreado.

languageCode

string

O idioma em que o anúncio foi detectado.

Esse campo usa tags de idioma IETF, como "en-US".

destinationTextList

object (DestinationTextList)

O texto no destino do anúncio que está causando uma violação da política.

destinationMismatch

object (DestinationMismatch)

Uma incompatibilidade entre os URLs de destino do anúncio.

destinationNotWorking

object (DestinationNotWorking)

Informações sobre erros de HTTP ou DNS relacionados ao destino do anúncio.

trademark

object (Trademark)

Termos de marca registrada que causaram uma violação da política.

legalRemoval

object (LegalRemoval)

Aplicação de regulamentação relacionada a questões legais que causou uma violação da política.

counterfeit

object (Counterfeit)

Aplicação de política contra falsificação que causou uma violação da política.

regionalRequirements

object (RegionalRequirements)

A aplicação proativa de T&S que causou uma violação da política.

TextList

Uma lista de fragmentos de texto que violaram a política.

Representação JSON
{
  "texts": [
    string
  ]
}
Campos
texts[]

string

Os fragmentos de texto do recurso que causaram a descoberta da política.

WebsiteList

Uma lista de sites que violaram a política.

Representação JSON
{
  "websites": [
    string
  ]
}
Campos
websites[]

string

Sites que causaram a descoberta da política.

DestinationTextList

Uma lista de texto de destino que violou a política.

Representação JSON
{
  "destinationTexts": [
    string
  ]
}
Campos
destinationTexts[]

string

Texto de destino que causou a descoberta da política.

DestinationMismatch

Detalhes sobre uma incompatibilidade entre tipos de URL de destino.

Representação JSON
{
  "uriTypes": [
    enum (AdPolicyTopicEvidenceDestinationMismatchUrlType)
  ]
}
Campos
uriTypes[]

enum (AdPolicyTopicEvidenceDestinationMismatchUrlType)

O conjunto de URLs que não correspondem. A lista pode incluir um ou vários tipos de URI.

Exemplo 1: [DISPLAY_URL, FINAL_URL] significa que o URL de visualização do anúncio não corresponde ao URL final do anúncio.

Exemplo 2: [FINAL_URL] significa que o URL final do anúncio não corresponde ao URL rastreado, o que também é considerado um destino não correspondente.

AdPolicyTopicEvidenceDestinationMismatchUrlType

Tipos de URL possíveis.

Tipos enumerados
AD_POLICY_TOPIC_EVIDENCE_DESTINATION_MISMATCH_URL_TYPE_UNKNOWN Não especificado ou desconhecido.
DISPLAY_URL O URL de visualização.
FINAL_URL O URL final.
FINAL_MOBILE_URL O URL final para dispositivos móveis.
TRACKING_URL O URL de rastreamento.
MOBILE_TRACKING_URL O URL de rastreamento para dispositivos móveis.

DestinationNotWorking

Detalhes sobre erros de HTTP ou DNS relacionados ao destino do anúncio.

Representação JSON
{
  "expandedUri": string,
  "device": enum (AdPolicyTopicEvidenceDestinationNotWorkingDeviceType),
  "lastCheckedTime": string,

  // Union field reason can be only one of the following:
  "dnsErrorType": enum (AdPolicyTopicEvidenceDestinationNotWorkingDnsErrorType),
  "httpErrorCode": string
  // End of list of possible types for union field reason.
}
Campos
expandedUri

string

O URL completo que não funcionou.

device

enum (AdPolicyTopicEvidenceDestinationNotWorkingDeviceType)

O dispositivo em que a visita ao URL resultou no erro.

lastCheckedTime

string (Timestamp format)

A última vez que o erro foi detectado ao navegar até o URL.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Campo de união reason. O erro HTTP ou de DNS. reason pode ser apenas de um dos tipos a seguir:
dnsErrorType

enum (AdPolicyTopicEvidenceDestinationNotWorkingDnsErrorType)

O tipo de erro de DNS.

httpErrorCode

string (int64 format)

O código de erro HTTP.

AdPolicyTopicEvidenceDestinationNotWorkingDnsErrorType

Possíveis tipos de erros de DNS.

Tipos enumerados
AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DNS_ERROR_TYPE_UNKNOWN Não especificado ou desconhecido.
HOSTNAME_NOT_FOUND O nome do host não foi encontrado no DNS ao buscar a página de destino.
GOOGLE_CRAWLER_DNS_ISSUE O Google não conseguiu rastrear a página de destino ao se comunicar com o DNS.

AdPolicyTopicEvidenceDestinationNotWorkingDeviceType

Possíveis dispositivos que encontraram um erro ao acessar o URL.

Tipos enumerados
AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DEVICE_TYPE_UNKNOWN Não especificado ou desconhecido.
DESKTOP Dispositivo desktop.
ANDROID Dispositivo Android.
IOS dispositivo iOS.

Marca registrada

Termos de marca registrada que causaram uma violação da política.

Representação JSON
{
  "owner": string,
  "term": string,
  "countryRestrictions": [
    {
      object (AdPolicyCriterionRestriction)
    }
  ]
}
Campos
owner

string

O proprietário do conteúdo da marca registrada.

term

string

O termo da marca registrada.

countryRestrictions[]

object (AdPolicyCriterionRestriction)

Países em que a violação da política é relevante.

AdPolicyCriterionRestriction

Representa uma restrição de país.

Representação JSON
{
  "countryCriterionId": string,
  "countryLabel": string
}
Campos
countryCriterionId

string (int64 format)

O ID do critério de país.

countryLabel

string

Nome localizado do país. Pode estar vazio.

LegalRemoval

Aplicação de regulamentações relacionadas a questões legais, seja da DMCA ou de regulamentações legais locais.

Representação JSON
{
  "complaintType": enum (AdPolicyTopicEvidenceLegalRemovalComplaintType),
  "countryRestrictions": [
    {
      object (AdPolicyCriterionRestriction)
    }
  ],
  "restrictedUris": [
    string
  ],

  // Union field type can be only one of the following:
  "dmca": {
    object (Dmca)
  },
  "localLegal": {
    object (LocalLegal)
  }
  // End of list of possible types for union field type.
}
Campos
complaintType

enum (AdPolicyTopicEvidenceLegalRemovalComplaintType)

O tipo de petição inicial que causou a remoção judicial.

countryRestrictions[]

object (AdPolicyCriterionRestriction)

Os países restritos devido à remoção legal.

restrictedUris[]

string

Os URLs restritos devido à remoção legal.

Campo de união type. Detalhes sobre o tipo de remoção judicial. type pode ser apenas de um dos tipos a seguir:
dmca

object (Dmca)

Detalhes sobre a remoção judicial da regulamentação da DMCA.

DMCA

Detalhes da denúncia com base na DMCA.

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

string

A entidade que fez a denúncia por motivos jurídicos.

LocalLegal

Detalhes da regulamentação legal local.

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

string

Tipo de legislação para o aviso legal.

AdPolicyTopicEvidenceLegalRemovalComplaintType

Possíveis tipos de denúncia para remoção judicial.

Tipos enumerados
COPYRIGHT

Direitos autorais.

Aplicável apenas à DMCA.

COURT_ORDER

Mandado judicial.

Válido apenas para legislação local.

Falsificação

Detalhes sobre a restrição contra pirataria que causou uma violação da política.

Representação JSON
{
  "owners": [
    string
  ]
}
Campos
owners[]

string

Os proprietários do conteúdo ou produto que fizeram uma denúncia.

RegionalRequirements

Aplicação proativa de confiança e segurança (T&S) para políticas destinadas a atender aos requisitos regionais. Isso é considerado uma investigação do Google em vez de uma notificação de regulamentação, já que é uma aplicação proativa dos T&S.

Representação JSON
{
  "regionalRequirementsEntries": [
    {
      object (RegionalRequirementsEntry)
    }
  ]
}
Campos
regionalRequirementsEntries[]

object (RegionalRequirementsEntry)

Lista de requisitos regionais.

RegionalRequirementsEntry

Detalhes da violação legal regional no nível da política.

Representação JSON
{
  "legalPolicy": string,
  "countryRestrictions": [
    {
      object (AdPolicyCriterionRestriction)
    }
  ]
}
Campos
legalPolicy

string

A política jurídica que está sendo violada.

countryRestrictions[]

object (AdPolicyCriterionRestriction)

Os países restritos devido à política jurídica.

AdPolicyTopicConstraint

Detalhes sobre restrições de veiculação de anúncios.

Representação JSON
{
  "requestCertificateFormLink": string,

  // Union field constraint can be only one of the following:
  "countryConstraint": {
    object (AdPolicyCountryConstraintList)
  },
  "resellerConstraint": {
    object (AdPolicyResellerConstraint)
  },
  "certificateMissingCountryList": {
    object (AdPolicyCountryConstraintList)
  },
  "certificateDomainMismatchCountryList": {
    object (AdPolicyCountryConstraintList)
  },
  "globalCertificateMissing": {
    object (AdPolicyGlobalCertificateMissingConstraint)
  },
  "globalCertificateDomainMismatch": {
    object (AdPolicyGlobalCertificateDomainMismatchConstraint)
  }
  // End of list of possible types for union field constraint.
}
Campos
Campo de união constraint. A restrição de veiculação. constraint pode ser apenas de um dos tipos a seguir:
countryConstraint

object (AdPolicyCountryConstraintList)

Países onde o anúncio não pode ser veiculado.

resellerConstraint

object (AdPolicyResellerConstraint)

Restrição do revendedor.

certificateMissingCountryList

object (AdPolicyCountryConstraintList)

Países em que um certificado é necessário para veiculação.

certificateDomainMismatchCountryList

object (AdPolicyCountryConstraintList)

Países em que o domínio do recurso não é coberto pelos certificados associados a ele.

globalCertificateMissing

object (AdPolicyGlobalCertificateMissingConstraint)

O certificado é obrigatório para veiculação em qualquer país.

globalCertificateDomainMismatch

object (AdPolicyGlobalCertificateDomainMismatchConstraint)

O certificado é obrigatório para veiculação em qualquer país, e o certificado atual não cobre o domínio do anúncio.

AdPolicyCountryConstraintList

Uma lista de países em que o anúncio não pode ser veiculado devido a restrições da política.

Representação JSON
{
  "countries": [
    {
      object (AdPolicyCriterionRestriction)
    }
  ]
}
Campos
countries[]

object (AdPolicyCriterionRestriction)

Países onde o anúncio não pode ser veiculado.

AdPolicyResellerConstraint

Esse tipo não tem campos.

O tema da política foi restrito devido à reprovação do site para fins de revenda.

AdPolicyGlobalCertificateMissingConstraint

Esse tipo não tem campos.

O certificado é obrigatório para veiculação em qualquer país.

AdPolicyGlobalCertificateDomainMismatchConstraint

Esse tipo não tem campos.

O certificado é obrigatório para veiculação em qualquer país, e o certificado atual não cobre o domínio do anúncio.

AdPolicyTopicAppealInfo

Informações sobre como contestar uma decisão baseada na política.

Representação JSON
{
  "appealType": enum (AdPolicyAppealType),
  "appealFormLink": string
}
Campos
appealType

enum (AdPolicyAppealType)

Se a decisão pode ser contestada por um formulário ou um processo de autoatendimento.

AdPolicyAppealType

Possíveis tipos de contestação.

Tipos enumerados
AD_POLICY_APPEAL_TYPE_UNKNOWN Desconhecido ou não especificado.
SELF_SERVICE_APPEAL É possível contestar a decisão usando um recurso de autoatendimento.
APPEAL_FORM A decisão pode ser contestada usando um formulário de contestação.

DisplayVideoSourceAd

O anúncio foi criado com 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

O 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 após o qual o vídeo vai começar a ser reproduzido.

autoplayVideoDuration

string (Duration format)

A duração do tempo em que o vídeo será reproduzido automaticamente.

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 você quer mostrar um plano de fundo ou banner que aparece na parte de cima 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 que dois.

YoutubeVideoDetails

Detalhes de um vídeo do YouTube.

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

string

Apenas saída. 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 de vídeo não estão disponíveis.

videoAssetId

string (int64 format)

Obrigatório. O ID do recurso de vídeo do YouTube. É o adAssetId de um recurso AdAsset.

VideoUnavailableReason

Possíveis motivos para um vídeo não estar disponível.

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

VideoAspectRatio

Proporções possíveis para um vídeo do YouTube.

Tipos enumerados
VIDEO_ASPECT_RATIO_UNSPECIFIED Não especificado ou desconhecido.
VIDEO_ASPECT_RATIO_WIDESCREEN O vídeo está esticado, e as partes de cima e de baixo estã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 comuns de anúncios.

customParameters

map (key: string, value: string)

Os parâmetros personalizados e os valores correspondentes a serem adicionados ao 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, não puláveis e bumper.

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 da página da Web que as pessoas acessam depois de clicar no anúncio.

trackingUrl

string

O endereço 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 YouTube do anúncio.

companionBanner

object (ImageAsset)

A imagem que aparece 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,
  "assetId": string
}
Campos
mimeType

string

Apenas saída. Tipo MIME do recurso de imagem.

fullSize

object (Dimensions)

Apenas saída. Metadados da imagem no tamanho original.

fileSize

string (int64 format)

Apenas saída. Tamanho do arquivo do recurso de imagem em bytes.

assetId

string (int64 format)

Obrigatório. O ID exclusivo do recurso.

NonSkippableAd

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

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

object (CommonInStreamAttribute)

Atributos comuns de anúncios.

customParameters

map (key: string, value: string)

Os parâmetros personalizados e os valores correspondentes a serem adicionados ao 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 comuns de anúncios.

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 da página da Web que as pessoas acessam depois de clicar no anúncio.

trackingUrl

string

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

video

object (YoutubeVideoDetails)

O vídeo do YouTube do anúncio.

VideoDiscoveryAd

Detalhes de um anúncio Discovery em vídeo.

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

string

O 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 miniatura nos anúncios Discovery em vídeo.

Tipos enumerados
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 com base no vídeo.
THUMBNAIL_2 Miniatura 2, gerada com base no vídeo.
THUMBNAIL_3 Miniatura 3, gerada com base no vídeo.

VideoPerformanceAd

Detalhes de um anúncio de performance 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 da página da Web que as pessoas acessam depois de clicar no anúncio.

trackingUrl

string

O endereço 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 manchetes mostradas no banner de call-to-action.

longHeadlines[]

string

A lista de títulos longos mostrados no banner de call-to-action.

descriptions[]

string

A lista de descrições mostradas no banner de call-to-action.

displayUrlBreadcrumb1

string

A primeira parte depois do 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 e os valores correspondentes a serem adicionados ao 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.

DemandGenVideoAd

Detalhes de um anúncio em vídeo da Geração de demanda.

Representação JSON
{
  "finalUrl": string,
  "trackingUrl": string,
  "userSpecifiedTrackingUrl": string,
  "callToAction": enum (CallToAction),
  "headlines": [
    string
  ],
  "longHeadlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string,
  "videos": [
    {
      object (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanner": {
    object (ImageAsset)
  },
  "logo": {
    object (ImageAsset)
  },
  "finalMobileUrl": string,
  "finalUrlSuffix": string,
  "businessName": string
}
Campos
finalUrl

string

Obrigatório. O endereço da página da Web que as pessoas acessam depois de clicar no anúncio.

trackingUrl

string

Apenas saída. O endereço URL carregado em segundo plano para fins de rastreamento.

userSpecifiedTrackingUrl

string

Opcional. O URL de rastreamento especificado manualmente pelo usuário.

callToAction

enum (CallToAction)

Obrigatório. O botão de call-to-action mostrado no anúncio.

Os valores compatíveis são:

  • AUTOMATED
  • LEARN_MORE
  • GET_QUOTE
  • APPLY_NOW
  • SIGN_UP
  • CONTACT_US
  • SUBSCRIBE
  • DOWNLOAD
  • BOOK_NOW
  • SHOP_NOW
  • BUY_NOW
  • DONATE_NOW
  • ORDER_NOW
  • PLAY_NOW
  • SEE_MORE
  • START_NOW
  • VISIT_SITE
  • WATCH_NOW
headlines[]

string

Obrigatório. A lista de títulos mostrados no anúncio.

longHeadlines[]

string

Obrigatório. A lista de títulos longos mostrados no anúncio.

descriptions[]

string

Obrigatório. A lista de descrições mostradas no anúncio.

displayUrlBreadcrumb1

string

Opcional. A primeira parte depois do domínio no URL de visualização.

displayUrlBreadcrumb2

string

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

videos[]

object (YoutubeVideoDetails)

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

customParameters

map (key: string, value: string)

Opcional. Os parâmetros personalizados e os valores correspondentes a serem adicionados ao URL de rastreamento.

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

companionBanner

object (ImageAsset)

Opcional. O banner complementar usado por este anúncio.

finalMobileUrl

string

Opcional. O endereço da página da Web que as pessoas acessam depois de clicar no anúncio em um dispositivo móvel.

finalUrlSuffix

string

Opcional. O sufixo a ser anexado aos URLs da página de destino.

businessName

string

Obrigatório. O nome da empresa mostrado no anúncio.

CallToAction

Possíveis valores de call-to-action para anúncios de produto/vídeo da Geração de demanda.

Tipos enumerados
CALL_TO_ACTION_UNSPECIFIED Não especificado ou desconhecido.
AUTOMATED Automatização.
LEARN_MORE Saiba mais.
GET_QUOTE Receber uma cotação.
APPLY_NOW Inscreva-se agora.
SIGN_UP Inscreva-se.
CONTACT_US Fale conosco.
SUBSCRIBE Inscreva-se.
DOWNLOAD Fazer o download.
BOOK_NOW Reserve agora.
SHOP_NOW Compre agora mesmo.
BUY_NOW Comprar agora.
DONATE_NOW Doe agora.
ORDER_NOW Compre agora.
PLAY_NOW Ouça agora.
SEE_MORE Saiba mais.
START_NOW Comece agora.
VISIT_SITE Acesse o site.
WATCH_NOW Assista agora.

DemandGenImageAd

Detalhes de um anúncio gráfico da Geração de demanda.

Representação JSON
{
  "finalUrl": string,
  "trackingUrl": string,
  "userSpecifiedTrackingUrl": string,
  "callToAction": string,
  "headlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "customParameters": {
    string: string,
    ...
  },
  "finalMobileUrl": string,
  "finalUrlSuffix": string,
  "businessName": string,
  "marketingImages": [
    {
      object (ImageAsset)
    }
  ],
  "squareMarketingImages": [
    {
      object (ImageAsset)
    }
  ],
  "portraitMarketingImages": [
    {
      object (ImageAsset)
    }
  ],
  "logoImages": [
    {
      object (ImageAsset)
    }
  ]
}
Campos
finalUrl

string

Obrigatório. O endereço da página da Web que as pessoas acessam depois de clicar no anúncio.

trackingUrl

string

Apenas saída. O endereço URL carregado em segundo plano para fins de rastreamento.

userSpecifiedTrackingUrl

string

Opcional. O URL de rastreamento especificado manualmente pelo usuário.

callToAction

string

Obrigatório. O botão de call-to-action mostrado no anúncio.

headlines[]

string

Obrigatório. A lista de títulos mostrados no anúncio.

descriptions[]

string

Obrigatório. A lista de descrições mostradas no anúncio.

customParameters

map (key: string, value: string)

Opcional. Os parâmetros personalizados e os valores correspondentes a serem adicionados ao URL de rastreamento.

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

finalMobileUrl

string

Opcional. O endereço da página da Web que as pessoas acessam depois de clicar no anúncio em um dispositivo móvel.

finalUrlSuffix

string

Opcional. O sufixo a ser anexado aos URLs da página de destino.

businessName

string

Obrigatório. O nome da empresa mostrado no anúncio.

marketingImages[]

object (ImageAsset)

A lista de imagens de marketing mostradas no anúncio.

squareMarketingImages[]

object (ImageAsset)

A lista de imagens de marketing quadradas mostradas no anúncio.

portraitMarketingImages[]

object (ImageAsset)

A lista de imagens de marketing em modo retrato mostradas no anúncio.

logoImages[]

object (ImageAsset)

A lista de imagens de logotipo mostradas no anúncio.

DemandGenCarouselAd

Detalhes de um anúncio de carrossel da Geração de demanda.

Representação JSON
{
  "finalUrl": string,
  "headline": string,
  "description": string,
  "cards": [
    {
      object (CarouselCard)
    }
  ],
  "finalUrlSuffix": string,
  "trackingUrl": string,
  "userSpecifiedTrackingUrl": string,
  "businessName": string,
  "customParameters": {
    string: string,
    ...
  },
  "logo": {
    object (ImageAsset)
  }
}
Campos
finalUrl

string

Obrigatório. O endereço da página da Web que as pessoas acessam depois de clicar no anúncio.

headline

string

Obrigatório. O título do anúncio.

description

string

Obrigatório. Descrição do anúncio.

cards[]

object (CarouselCard)

Obrigatório. A lista de cards mostrados no anúncio.

finalUrlSuffix

string

Opcional. O sufixo a ser anexado aos URLs da página de destino.

trackingUrl

string

Apenas saída. O endereço URL carregado em segundo plano para fins de rastreamento.

userSpecifiedTrackingUrl

string

Opcional. O URL de rastreamento especificado manualmente pelo usuário.

businessName

string

Obrigatório. O nome da empresa mostrado no anúncio.

customParameters

map (key: string, value: string)

Opcional. Os parâmetros personalizados e os valores correspondentes a serem adicionados ao URL de rastreamento.

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

CarouselCard

Detalhes de um card de carrossel da Geração de demanda.

Representação JSON
{
  "finalUrl": string,
  "finalMobileUrl": string,
  "headline": string,
  "callToAction": string,
  "marketingImage": {
    object (ImageAsset)
  },
  "squareMarketingImage": {
    object (ImageAsset)
  },
  "portraitMarketingImage": {
    object (ImageAsset)
  }
}
Campos
finalUrl

string

Obrigatório. O endereço da página da Web que as pessoas acessam depois de clicar no card.

finalMobileUrl

string

Opcional. O endereço da página da Web que as pessoas acessam depois de clicar no card em um dispositivo móvel.

headline

string

Obrigatório. O título do card.

callToAction

string

Obrigatório. O texto no botão de call-to-action mostrado no card.

Precisa ter até 10 caracteres.

marketingImage

object (ImageAsset)

Opcional. A imagem de marketing mostrada no card.

squareMarketingImage

object (ImageAsset)

Opcional. A imagem de marketing quadrada mostrada no card.

portraitMarketingImage

object (ImageAsset)

Opcional. A imagem de marketing em modo retrato mostrada no card.

DemandGenProductAd

Detalhes de um anúncio de produto da Geração de demanda.

Representação JSON
{
  "finalUrl": string,
  "headline": string,
  "description": string,
  "finalUrlSuffix": string,
  "callToAction": enum (CallToAction),
  "trackingUrl": string,
  "userSpecifiedTrackingUrl": string,
  "businessName": string,
  "customParameters": {
    string: string,
    ...
  },
  "logo": {
    object (ImageAsset)
  },
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string
}
Campos
finalUrl

string

Obrigatório. O endereço da página da Web que as pessoas acessam depois de clicar no anúncio.

headline

string

Obrigatório. O título do anúncio.

description

string

Obrigatório. Descrição do anúncio.

finalUrlSuffix

string

Opcional. O sufixo a ser anexado aos URLs da página de destino.

callToAction

enum (CallToAction)

Obrigatório. O botão de call-to-action mostrado no anúncio.

Os valores compatíveis são:

  • AUTOMATED
  • APPLY_NOW
  • BOOK_NOW
  • CONTACT_US
  • DOWNLOAD
  • GET_QUOTE
  • LEARN_MORE
  • SHOP_NOW
  • SIGN_UP
  • SUBSCRIBE
trackingUrl

string

Apenas saída. O endereço URL carregado em segundo plano para fins de rastreamento.

userSpecifiedTrackingUrl

string

Opcional. O URL de rastreamento especificado manualmente pelo usuário.

businessName

string

Obrigatório. O nome da empresa mostrado no anúncio.

customParameters

map (key: string, value: string)

Opcional. Os parâmetros personalizados e os valores correspondentes a serem adicionados ao URL de rastreamento.

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

displayUrlBreadcrumb1

string

Opcional. A primeira parte depois do domínio no URL de visualização.

displayUrlBreadcrumb2

string

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

AdUrl

URLs adicionais relacionados ao anúncio, incluindo beacons.

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

enum (AdUrlType)

O tipo do URL do anúncio.

url

string

O valor da string do URL.

AdUrlType

Possíveis tipos de URL do anúncio.

Tipos enumerados
AD_URL_TYPE_UNSPECIFIED Desconhecido ou não especificado.
AD_URL_TYPE_BEACON_IMPRESSION Um pixel de rastreamento 1 x 1 para enviar um ping quando uma impressão de um criativo é veiculada.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Beacon de impressão expansível do DCM. No momento da veiculação, ele é expandido para vários beacons.
AD_URL_TYPE_BEACON_CLICK URL de rastreamento para ping quando o evento de clique é acionado.
AD_URL_TYPE_BEACON_SKIP URL de rastreamento para ping quando o evento de pular é acionado.

DcmTrackingInfo

Detalhes sobre o rastreamento do DCM.

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

string (int64 format)

Obrigatório. O ID da posição do DCM.

trackingAdId

string (int64 format)

Obrigatório. O ID do anúncio de rastreamento do DCM.

creativeId

string (int64 format)

Obrigatório. O ID do criativo do DCM.

Métodos

create

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

delete

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

get

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

list

Lista anúncios do grupo de anúncios.

patch

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