REST Resource: advertisers.creatives

Recurso: criativo

Um único criativo.

Representação JSON 
{
  "name": string,
  "advertiserId": string,
  "creativeId": string,
  "cmPlacementId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "createTime": string,
  "creativeType": enum (CreativeType),
  "hostingSource": enum (HostingSource),
  "dynamic": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "additionalDimensions": [
    {
      object (Dimensions)
    }
  ],
  "mediaDuration": string,
  "creativeAttributes": [
    enum (CreativeAttribute)
  ],
  "reviewStatus": {
    object (ReviewStatusInfo)
  },
  "assets": [
    {
      object (AssetAssociation)
    }
  ],
  "exitEvents": [
    {
      object (ExitEvent)
    }
  ],
  "timerEvents": [
    {
      object (TimerEvent)
    }
  ],
  "counterEvents": [
    {
      object (CounterEvent)
    }
  ],
  "appendedTag": string,
  "integrationCode": string,
  "notes": string,
  "iasCampaignMonitoring": boolean,
  "companionCreativeIds": [
    string
  ],
  "skippable": boolean,
  "skipOffset": {
    object (AudioVideoOffset)
  },
  "progressOffset": {
    object (AudioVideoOffset)
  },
  "universalAdId": {
    object (UniversalAdId)
  },
  "thirdPartyUrls": [
    {
      object (ThirdPartyUrl)
    }
  ],
  "transcodes": [
    {
      object (Transcode)
    }
  ],
  "trackerUrls": [
    string
  ],
  "jsTrackerUrl": string,
  "cmTrackingAd": {
    object (CmTrackingAd)
  },
  "obaIcon": {
    object (ObaIcon)
  },
  "thirdPartyTag": string,
  "requireMraid": boolean,
  "requireHtml5": boolean,
  "requirePingForAttribution": boolean,
  "expandingDirection": enum (ExpandingDirection),
  "expandOnHover": boolean,
  "vastTagUrl": string,
  "vpaid": boolean,
  "html5Video": boolean,
  "lineItemIds": [
    string
  ],
  "mp3Audio": boolean,
  "oggAudio": boolean
}
Campos
name

string

Apenas saída. O nome de recurso do criativo.
advertiserId

string (int64 format)

Apenas saída. O ID exclusivo do anunciante ao qual o criativo pertence.
creativeId

string (int64 format)

Apenas saída. O ID exclusivo do criativo. Atribuído pelo sistema.
cmPlacementId

string (int64 format)

Apenas saída. É o ID exclusivo da posição do Campaign Manager 360 associada ao criativo. Este campo é aplicável somente aos criativos sincronizados do Campaign Manager.
displayName

string

Obrigatório. O nome de exibição do criativo.

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

enum (EntityStatus)

Obrigatório. Controla se o criativo pode ser veiculado ou não.

Os valores aceitos são:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
  • ENTITY_STATUS_PAUSED
updateTime

string (Timestamp format)

Apenas saída. A data e a hora em que o criativo foi atualizado pela última vez, seja pelo usuário ou pelo sistema (por exemplo, pela revisão do criativo). Atribuído pelo sistema.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
createTime

string (Timestamp format)

Apenas saída. A data e a hora em que o criativo foi criado. Atribuído pelo sistema.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
creativeType

enum (CreativeType)

Obrigatório. Imutável. O tipo do criativo.
hostingSource

enum (HostingSource)

Obrigatório. Indica onde o criativo está hospedado.
dynamic

boolean

Apenas saída. Indica se o criativo é dinâmico.
dimensions

object (Dimensions)

Obrigatório. Dimensões principais do criativo. Aplicável a todos os tipos de criativo. O valor de widthPixels e heightPixels é 0 por padrão quando creativeType é um dos seguintes:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
additionalDimensions[]

object (Dimensions)

Dimensões adicionais. Aplicável quando creativeType é um dos seguintes:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_LIGHTBOX
  • CREATIVE_TYPE_PUBLISHER_HOSTED

Se este campo for especificado, widthPixels e heightPixels serão obrigatórios e precisarão ser maiores ou iguais a 0.
mediaDuration

string (Duration format)

Apenas saída. A duração da mídia do criativo. Aplicável quando creativeType é um dos seguintes:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_PUBLISHER_HOSTED

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

enum (CreativeAttribute)

Apenas saída. Uma lista de atributos do criativo gerada pelo sistema.
reviewStatus

object (ReviewStatusInfo)

Apenas saída. É o status atual do processo de revisão de criativos.
assets[]

object (AssetAssociation)

Obrigatório. São os recursos associados a este criativo.
exitEvents[]

object (ExitEvent)

Obrigatório. Eventos de saída para este criativo. Uma saída (também conhecida como click tag) é qualquer área do criativo em que alguém pode clicar ou tocar para abrir a página de destino de um anunciante. Cada criativo precisa incluir pelo menos uma saída. É possível adicionar uma saída ao criativo das seguintes maneiras:

  • Use a área de toque do Google Web Designer.
  • Defina uma variável JavaScript chamada "cliqueTag".
  • Use o ativador (Ativador.exit()) para rastrear saídas em formatos rich media.
timerEvents[]

object (TimerEvent)

Eventos personalizados de tempo para um criativo rich media. Os timers rastreiam o tempo durante o qual um usuário visualiza e interage com uma parte específica de um criativo rich media. Um criativo pode ter vários eventos de timer, cada um medido de maneira independente. Deixe essa opção em branco ou não definida para criativos que contêm somente recursos de imagem.
counterEvents[]

object (CounterEvent)

Eventos de contador para um criativo rich media. Os contadores rastreiam o número de vezes que um usuário interage com qualquer parte de um criativo rich media de uma forma especificada (passagem e afastamento do mouse, cliques, toques, carregamento de dados, uso do teclado etc.). Qualquer evento que possa ser capturado no criativo pode ser registrado como um contador. Deixe essa opção em branco ou não definida para criativos que contêm somente recursos de imagem.
appendedTag

string

Tag de rastreamento HTML de terceiros a ser anexada à tag do criativo.
integrationCode

string

Informações do ID usadas para vincular este criativo a um sistema externo. Precisa ser codificado em UTF-8 e ter no máximo 10.000 caracteres.
notes

string

Notas do usuário para este criativo. Precisa ser codificado em UTF-8 e ter no máximo 20.000 caracteres.
iasCampaignMonitoring

boolean

Indica se o monitoramento de campanha da Integral Ad Science (IAS) está ativado. Para ativar isso para o criativo, verifique se Advertiser.creative_config.ias_client_id foi definido como seu ID de cliente da IAS.
companionCreativeIds[]

string (int64 format)

Os IDs dos criativos complementares para um criativo de vídeo.

É possível atribuir criativos de display existentes (com recursos HTML5 ou de imagem) para veiculação ao redor do player de vídeo do editor. Os complementares são exibidos ao redor do player durante a reprodução do vídeo e permanecem após a conclusão.

Criativos com additional dimensions não podem ser complementares.

Este campo só é compatível com as seguintes creativeType:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
skippable

boolean

Indica se o usuário pode pular um criativo de vídeo.

Este campo só é compatível com o seguinte creativeType:

  • CREATIVE_TYPE_VIDEO
skipOffset

object (AudioVideoOffset)

Por quanto tempo o vídeo será reproduzido antes de o botão "Pular" ser exibido.

Esse campo é obrigatório quando skippable é verdadeiro.

Este campo só é compatível com o seguinte creativeType:

  • CREATIVE_TYPE_VIDEO
progressOffset

object (AudioVideoOffset)

Tempo de reprodução do vídeo antes de contar uma visualização.

Esse campo é obrigatório quando skippable é verdadeiro.

Este campo só é compatível com o seguinte creativeType:

  • CREATIVE_TYPE_VIDEO
universalAdId

object (UniversalAdId)

Opcional. Um identificador de criativo opcional fornecido por um registro que é exclusivo em todas as plataformas.

O ID universal do anúncio faz parte do padrão VAST 4.0. Ela pode ser modificada após a criação do criativo.

Este campo só é compatível com o seguinte creativeType:

  • CREATIVE_TYPE_VIDEO
thirdPartyUrls[]

object (ThirdPartyUrl)

URLs de rastreamento de terceiros para rastrear interações com um criativo de vídeo.

Este campo só é compatível com o seguinte creativeType:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
transcodes[]

object (Transcode)

Apenas saída. Transcodificações de áudio/vídeo.

O Display & Video 360 transcodifica o recurso principal em diversas versões alternativas que usam formatos de arquivo diferentes ou têm propriedades distintas (resolução, taxa de bits de áudio e de vídeo), cada uma projetada para larguras de banda ou players de vídeo específicos.

Com essas transcodificações, o sistema do editor tem mais opções para cada impressão no seu vídeo e garante que o arquivo adequado seja veiculado com base no tamanho da tela e na conexão do espectador.

Este campo só é compatível com os seguintes creativeType:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_AUDIO
trackerUrls[]

string

URLs de rastreamento para provedores de análise ou fornecedores de tecnologia de anúncio terceirizados.

Os URLs precisam começar com https (exceto em inventários que não exigem conformidade com SSL). Se você usar macros no seu URL, utilize somente aquelas compatíveis com o Display & Video 360.

Somente URLs padrão, sem tags IMG ou SCRIPT.

Este campo só pode ser gravado no seguinte creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

É o URL de avaliação JavaScript dos provedores de verificação terceirizados compatíveis (ComScore, DoubleVerify, IAS e Moat). As tags de script HTML não são compatíveis.

Este campo só pode ser gravado no seguinte creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object (CmTrackingAd)

O anúncio de rastreamento do Campaign Manager 360 associado ao criativo.

Opcional para os seguintes creativeType quando criados por um anunciante que usa a veiculação de anúncios do Campaign Manager 360 e de terceiros:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE

Saída apenas para outros casos.
obaIcon

object (ObaIcon)

Especifica o ícone da OBA para um criativo de vídeo.

Este campo só é compatível com os seguintes creativeType:

  • CREATIVE_TYPE_VIDEO
thirdPartyTag

string

Opcional. A tag original de terceiros usada no criativo.

Obrigatório e válido somente para criativos de tags de terceiros.

Os criativos de tags de terceiros têm os seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireMraid

boolean

Opcional. Indica que o criativo requer MRAID (sistema de definições de interface para anúncios rich media para dispositivos móveis).

Defina essa opção se o criativo usar gestos de dispositivos móveis para interatividade, como deslizar ou tocar.

Opcional e válido somente para criativos de tag de terceiros.

Os criativos de tags de terceiros têm os seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireHtml5

boolean

Opcional. Indica que o criativo depende de HTML5 para ser renderizado corretamente.

Opcional e válido somente para criativos de tag de terceiros. Os criativos de tags de terceiros têm os seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requirePingForAttribution

boolean

Opcional. Indica que o criativo aguardará um ping de retorno para a atribuição.

Válido somente ao usar um anúncio de rastreamento do Campaign Manager 360 com um parâmetro do servidor de anúncios de terceiros e a macro ${DC_DBM_TOKEN}.

Opcional e válido somente para criativos de tag de terceiros ou de tag VAST de terceiros.

Os criativos de tags de terceiros têm os seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE

Os criativos de tag VAST de terceiros são aqueles com os seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
expandingDirection

enum (ExpandingDirection)

Opcional. Especifica a direção de expansão do criativo.

Obrigatório e válido somente para criativos expansíveis de terceiros.

Criativos expansíveis de terceiros são criativos com a seguinte origem de hospedagem:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_EXPANDABLE
expandOnHover

boolean

Opcional. Indica que o criativo expandirá automaticamente ao passar o cursor.

Opcional e válido somente para criativos expansíveis de terceiros. Criativos expansíveis de terceiros são criativos com a seguinte origem de hospedagem:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_EXPANDABLE
vastTagUrl

string

Opcional. É o URL da tag VAST de um criativo de tag VAST de terceiros.

Obrigatório e válido somente para criativos com tag VAST de terceiros.

Os criativos de tag VAST de terceiros são aqueles com os seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
vpaid

boolean

Apenas saída. Indica que o criativo com tag VAST de terceiros requer VPAID (interface digital de anúncio e player de vídeo).

Somente saída e válida somente para criativos de tag VAST de terceiros.

Os criativos de tag VAST de terceiros são aqueles com os seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_VIDEO
html5Video

boolean

Apenas saída. Indica que o criativo com tag VAST de terceiros requer suporte para vídeo HTML5.

Somente saída e válida somente para criativos de tag VAST de terceiros.

Os criativos de tag VAST de terceiros são aqueles com os seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_VIDEO
lineItemIds[]

string (int64 format)

Apenas saída. Os IDs dos itens de linha associados ao criativo.

Para associar um criativo a um item de linha, use LineItem.creative_ids.
mp3Audio

boolean

Apenas saída. Indica que o criativo em áudio de terceiros é compatível com MP3.

Somente saída e válida somente para criativos de áudio de terceiros.

Os criativos em áudio de terceiros têm os seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_AUDIO
oggAudio

boolean

Apenas saída. Indica que o criativo em áudio de terceiros é compatível com OGG.

Somente saída e válida somente para criativos de áudio de terceiros.

Os criativos em áudio de terceiros têm os seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_AUDIO

HostingSource

Possíveis origens de hospedagem para um criativo. Indica onde um criativo é criado e hospedado.

Tipos enumerados
HOSTING_SOURCE_UNSPECIFIED A origem da hospedagem não foi especificada ou é desconhecida nesta versão.
HOSTING_SOURCE_CM

É um criativo sincronizado do Campaign Manager 360.

Os métodos de criação e atualização não são compatíveis com este tipo de hospedagem.
HOSTING_SOURCE_THIRD_PARTY

Um criativo hospedado por um servidor de anúncios de terceiros (3PAS).

Os métodos de criação e atualização terão suporte para esse tipo de hospedagem se o creativeType for um dos seguintes:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_HOSTED

Um criativo gerado no DV360 e hospedado pelo Campaign Manager 360.

Os métodos de criação e atualização terão suporte para esse tipo de hospedagem se o creativeType for um dos seguintes:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_RICH_MEDIA

É um criativo rich media criado no Studio e hospedado pelo Campaign Manager 360.

Os métodos de criação e atualização não são compatíveis com este tipo de hospedagem.

CreativeAttribute

Possíveis atributos de um criativo.

Tipos enumerados
CREATIVE_ATTRIBUTE_UNSPECIFIED O atributo do criativo não foi especificado ou é desconhecido nesta versão.
CREATIVE_ATTRIBUTE_VAST O criativo é VAST.
CREATIVE_ATTRIBUTE_VPAID_LINEAR O criativo é um criativo VPAID linear.
CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR O criativo é um criativo VPAID não linear.

ReviewStatusInfo

Revise o status do criativo.

Representação JSON 
{
  "approvalStatus": enum (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ],
  "publisherReviewStatuses": [
    {
      object (PublisherReviewStatus)
    }
  ]
}
Campos
approvalStatus

enum (ApprovalStatus)

Representa a aprovação básica necessária para que um criativo comece a ser veiculado. Resumo de creativeAndLandingPageReviewStatus e contentAndPolicyReviewStatus.
creativeAndLandingPageReviewStatus

enum (ReviewStatus)

Status da revisão do criativo e da página de destino do criativo.
contentAndPolicyReviewStatus

enum (ReviewStatus)

É o status da revisão de política e do conteúdo do criativo.
exchangeReviewStatuses[]

object (ExchangeReviewStatus)

Status da revisão da troca do criativo.
publisherReviewStatuses[]
(deprecated)

object (PublisherReviewStatus)

Status de revisão do editor para o criativo.

ApprovalStatus

Tipos de status de aprovação possíveis. É o resumo de creativeAndLandingPageReviewStatus e contentAndPolicyReviewStatus.

Tipos enumerados
APPROVAL_STATUS_UNSPECIFIED O valor do tipo não foi especificado ou é desconhecido nesta versão.
APPROVAL_STATUS_PENDING_NOT_SERVABLE O criativo ainda está em revisão e não pode ser veiculado.
APPROVAL_STATUS_PENDING_SERVABLE O criativo foi aprovado na revisão do criativo e da página de destino e pode ser veiculado, mas está aguardando uma revisão adicional do conteúdo e da política.
APPROVAL_STATUS_APPROVED_SERVABLE A revisão do criativo e da página de destino e a revisão do conteúdo e da política foram aprovadas. O criativo pode ser veiculado.
APPROVAL_STATUS_REJECTED_NOT_SERVABLE É preciso corrigir um problema com o criativo antes da veiculação.

ReviewStatus

Possíveis tipos de status de revisão.

Tipos enumerados
REVIEW_STATUS_UNSPECIFIED O valor do tipo não foi especificado ou é desconhecido nesta versão.
REVIEW_STATUS_APPROVED O criativo foi aprovado.
REVIEW_STATUS_REJECTED O criativo foi recusado.
REVIEW_STATUS_PENDING A revisão do criativo está pendente.

ExchangeReviewStatus

Status da revisão da troca do criativo.

Representação JSON 
{
  "exchange": enum (Exchange),
  "status": enum (ReviewStatus)
}
Campos
exchange

enum (Exchange)

A troca que revisa o criativo.
status

enum (ReviewStatus)

Status da revisão da troca.

PublisherReviewStatus

É o status de revisão do editor para o criativo.

Representação JSON 
{
  "publisherName": string,
  "status": enum (ReviewStatus)
}
Campos
publisherName

string

O editor que revisa o criativo.
status

enum (ReviewStatus)

Status da revisão do editor.

AssetAssociation

Associação de recurso para o criativo.

Representação JSON 
{
  "asset": {
    object (Asset)
  },
  "role": enum (AssetRole)
}
Campos
asset

object (Asset)

O recurso associado.
role

enum (AssetRole)

A função desse recurso para o criativo.

Recurso

Um único recurso.

Representação JSON 
{
  "mediaId": string,
  "content": string
}
Campos
mediaId

string (int64 format)

ID da mídia do recurso enviado. Esse é um identificador exclusivo do recurso. Esse ID pode ser transmitido para outras chamadas de API, por exemplo, creatives.create, para associar o recurso a um criativo.

O espaço do ID da mídia foi atualizado em 5 de abril de 2023. Atualize os IDs de mídia armazenados em cache antes de 5 de abril de 2023. Para isso, extraia o novo ID dos recursos do criativo associados ou faça upload do recurso novamente.
content

string

O conteúdo do recurso. Para recursos enviados, o conteúdo é o caminho de veiculação.

AssetRole

A função desse recurso para o criativo.

Tipos enumerados
ASSET_ROLE_UNSPECIFIED A função do recurso não foi especificada ou é desconhecida nesta versão.
ASSET_ROLE_MAIN O recurso é o principal do criativo.
ASSET_ROLE_BACKUP O recurso é um recurso de backup do criativo.
ASSET_ROLE_POLITE_LOAD O recurso é um recurso de carregamento discreto do criativo.
ASSET_ROLE_HEADLINE

Título de um criativo nativo.

O content precisa ser codificado em UTF-8 e ter no máximo 25 caracteres.

Este papel só é compatível com os seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_HEADLINE

Título longo de um criativo nativo.

O content precisa ser codificado em UTF-8 com até 50 caracteres.

Este papel só é compatível com os seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_BODY

É o corpo do texto de um criativo nativo.

O content precisa ser codificado em UTF-8 com até 90 caracteres.

Este papel só é compatível com os seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_BODY

Texto longo do corpo de um criativo nativo.

O content precisa ser codificado em UTF-8 com até 150 caracteres.

Este papel só é compatível com os seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CAPTION_URL

Uma versão curta e amigável do URL da página de destino para exibir no criativo. Esse URL dá às pessoas uma ideia da página que vão acessar depois de clicar no criativo.

O content precisa ser codificado em UTF-8 com até 30 caracteres.

Por exemplo, se o URL da página de destino for "http://www.example.com/page", o URL da legenda poderá ser "example.com". O protocolo (http://) é opcional, mas o URL não pode ter espaços nem caracteres especiais.

Este papel só é compatível com os seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CALL_TO_ACTION

O texto a ser usado no botão de call-to-action de um criativo nativo.

O content precisa ser codificado em UTF-8 e ter no máximo 15 caracteres.

Este papel só é compatível com os seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_ADVERTISER_NAME

É o texto que identifica o nome do anunciante ou da marca.

O content precisa ser codificado em UTF-8 e ter no máximo 25 caracteres.

Este papel só é compatível com os seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_PRICE

O preço de compra do seu aplicativo na Google Play Store ou na App Store do iOS (por exemplo, US$ 5,99).

Esse valor não é sincronizado automaticamente com o valor real listado na loja. Ele sempre será o código fornecido ao salvar o criativo.

O content precisa ser codificado em UTF-8 e ter no máximo 15 caracteres.

Os recursos desse papel são somente leitura.
ASSET_ROLE_ANDROID_APP_ID

O ID de um app Android na Google Play Store.

Esse código pode ser encontrado no URL da Google Play Store do app, após "id". Por exemplo, em https://play.google.com/store/apps/details?id=com.company.appname, o identificador é com.company.appname.

Os recursos desse papel são somente leitura.
ASSET_ROLE_IOS_APP_ID

O ID de um app iOS na App Store da Apple.

Esse número de ID pode ser encontrado no URL da Apple App Store como a string de números logo após "id". Por exemplo, em https://apps.apple.com/us/app/gmail-email-by-google/id422689480, o ID é 422689480.

Os recursos desse papel são somente leitura.
ASSET_ROLE_RATING

A classificação de um app na Google Play Store ou na App Store do iOS.

Esse valor não é sincronizado automaticamente com a classificação real na loja. Ele sempre será o código fornecido ao salvar o criativo.

Os recursos desse papel são somente leitura.
ASSET_ROLE_ICON

O ícone de um criativo.

Este papel só é compatível e necessário nos seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

É a imagem da capa de um criativo de vídeo nativo.

Este papel só é compatível e necessário nos seguintes creativeType:

  • CREATIVE_TYPE_VIDEO

ExitEvent

Evento de saída do criativo.

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

enum (ExitEventType)

Obrigatório. O tipo de evento de saída.
url

string

Obrigatório. O URL de clique do evento de saída. Isso é necessário quando type é:

  • EXIT_EVENT_TYPE_DEFAULT
  • EXIT_EVENT_TYPE_BACKUP
name

string

O nome da tag de clique do evento de saída.

O nome precisa ser único no criativo.

Deixe essa opção em branco ou não definida para criativos que contêm somente recursos de imagem.
reportingName

string

O nome usado para identificar esse evento nos relatórios. Deixe essa opção em branco ou não definida para criativos que contêm somente recursos de imagem.

ExitEventType

O tipo de um evento de saída.

Tipos enumerados
EXIT_EVENT_TYPE_UNSPECIFIED O tipo de evento de saída não está especificado ou é desconhecido nesta versão.
EXIT_EVENT_TYPE_DEFAULT O evento de saída é o padrão.
EXIT_EVENT_TYPE_BACKUP O evento de saída é um evento de saída de backup. Pode haver vários eventos de saída de backup em um criativo.

TimerEvent

Evento timer do criativo.

Representação JSON 
{
  "name": string,
  "reportingName": string
}
Campos
name

string

Obrigatório. O nome do evento de timer.
reportingName

string

Obrigatório. O nome usado para identificar esse evento de timer nos relatórios.

CounterEvent

Evento do contador do criativo.

Representação JSON 
{
  "name": string,
  "reportingName": string
}
Campos
name

string

Obrigatório. O nome do evento do contador.
reportingName

string

Obrigatório. O nome usado para identificar esse evento de contador nos relatórios.

AudioVideoOffset

A duração da reprodução de um áudio ou vídeo.

Representação JSON 
{

  // Union field offset can be only one of the following:
  "percentage": string,
  "seconds": string
  // End of list of possible types for union field offset.
}
Campos
Campo de união offset. O valor do deslocamento. offset só pode ser de um dos seguintes tipos:
percentage

string (int64 format)

O deslocamento na porcentagem da duração do áudio ou vídeo.
seconds

string (int64 format)

O deslocamento em segundos do início do áudio ou vídeo.

UniversalAdId

Um identificador de criativo fornecido por um registro que é exclusivo em todas as plataformas. Isso faz parte do padrão VAST 4.0.

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

string

O identificador exclusivo do criativo.
registry

enum (UniversalAdRegistry)

O registro fornece identificadores exclusivos de criativos.

UniversalAdRegistry

O registro fornece identificadores exclusivos de criativos em um ID do anúncio universal.

Tipos enumerados
UNIVERSAL_AD_REGISTRY_UNSPECIFIED O registro universal de anúncios não foi especificado ou é desconhecido nesta versão.
UNIVERSAL_AD_REGISTRY_OTHER Use um provedor personalizado para fornecer o ID universal do anúncio.
UNIVERSAL_AD_REGISTRY_AD_ID Use o ID do anúncio para informar o ID universal do anúncio.
UNIVERSAL_AD_REGISTRY_CLEARCAST Use o Clearcast.co.uk para informar o ID universal do anúncio.
UNIVERSAL_AD_REGISTRY_DV360 Use o Display & Video 360 para fornecer o ID universal do anúncio.
UNIVERSAL_AD_REGISTRY_CM Use o Campaign Manager 360 para fornecer o ID universal do anúncio.

ThirdPartyUrl

URLs de rastreamento de terceiros para rastrear interações com um criativo de áudio ou vídeo.

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

enum (ThirdPartyUrlType)

O tipo de interação precisa ser acompanhado pelo URL de rastreamento.
url

string

URL de rastreamento usado para acompanhar a interação.

Forneça um URL com caminho ou string de consulta opcional, começando com https:. Por exemplo, https://www.example.com/path

ThirdPartyUrlType

O tipo de interação precisa ser acompanhado pelo URL de rastreamento de terceiros.

Tipos enumerados
THIRD_PARTY_URL_TYPE_UNSPECIFIED O tipo de URL de terceiros não foi especificado ou é desconhecido nesta versão.
THIRD_PARTY_URL_TYPE_IMPRESSION Usado para contar impressões do criativo após a conclusão do armazenamento em buffer de áudio ou vídeo.
THIRD_PARTY_URL_TYPE_CLICK_TRACKING Usado para rastrear cliques do usuário no áudio ou vídeo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START Usado para rastrear o número de vezes que um usuário inicia o áudio ou vídeo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE Usado para rastrear o número de vezes que o áudio ou vídeo é reproduzido até 25% de sua duração.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT Usado para rastrear o número de vezes que o áudio ou vídeo é reproduzido até 50% de sua duração.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE Usado para rastrear o número de vezes que o áudio ou vídeo é reproduzido até 75% de sua duração.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE Usado para rastrear o número de vezes que o áudio ou vídeo é reproduzido até o final.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE Usado para rastrear o número de vezes que um usuário silencia o áudio ou o vídeo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE Usado para rastrear o número de vezes que um usuário pausa o áudio ou o vídeo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND Usado para rastrear o número de vezes que um usuário repete o áudio ou o vídeo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN Usado para rastrear o número de vezes que um usuário expande o player para tela cheia.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP Usado para rastrear o número de vezes que um usuário interrompe o áudio ou o vídeo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM Usado para rastrear o número de vezes que um usuário realiza um clique personalizado, como clicar nas partes mais vistas de um vídeo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP Usado para rastrear o número de vezes que o áudio ou vídeo foi ignorado.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS Usado para rastrear o número de vezes que o áudio ou vídeo é reproduzido em um deslocamento determinado pelo progressOffset.

Transcodificação

Representa informações sobre o arquivo de áudio ou vídeo transcodificado.

Representação JSON 
{
  "name": string,
  "mimeType": string,
  "transcoded": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}
Campos
name

string

O nome do arquivo transcodificado.
mimeType

string

O tipo MIME do arquivo transcodificado.
transcoded

boolean

Indica se a transcodificação foi bem-sucedida.
dimensions

object (Dimensions)

As dimensões do vídeo transcodificado.
bitRateKbps

string (int64 format)

Taxa de bits de transcodificação do vídeo transcodificado, em quilobits por segundo.
frameRate

number

É o frame rate do vídeo transcodificado, em quadros por segundo.
audioBitRateKbps

string (int64 format)

É a taxa de bits para o stream de áudio do vídeo transcodificado ou a taxa de bits do áudio transcodificado em quilobits por segundo.
audioSampleRateHz

string (int64 format)

É a taxa de amostragem do fluxo de áudio do vídeo transcodificado ou a taxa de amostragem do áudio transcodificado em hertz.
fileSizeBytes

string (int64 format)

É o tamanho em bytes do arquivo transcodificado.

CmTrackingAd

Um anúncio de rastreamento do Campaign Manager 360.

Representação JSON 
{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}
Campos
cmPlacementId

string (int64 format)

O ID da posição do anúncio de rastreamento do Campaign Manager 360.
cmCreativeId

string (int64 format)

É o ID do criativo do anúncio de rastreamento do Campaign Manager 360.
cmAdId

string (int64 format)

O ID do anúncio de rastreamento do Campaign Manager 360.

ObaIcon

Ícone da OBA para um criativo

Representação JSON 
{
  "resourceUrl": string,
  "resourceMimeType": string,
  "position": enum (ObaIconPosition),
  "dimensions": {
    object (Dimensions)
  },
  "program": string,
  "landingPageUrl": string,
  "clickTrackingUrl": string,
  "viewTrackingUrl": string
}
Campos
resourceUrl

string

É o URL do recurso de ícone da OBA.
resourceMimeType

string

O tipo MIME do recurso de ícone da OBA.
position

enum (ObaIconPosition)

É a posição do ícone da OBA no criativo.
dimensions

object (Dimensions)

As dimensões do ícone da OBA.
program

string

Programa do ícone da OBA. Por exemplo: "Opções de anúncios".
landingPageUrl

string

Obrigatório. É o URL da página de destino do ícone da OBA.

Somente os URLs dos seguintes domínios são permitidos:
clickTrackingUrl

string

Obrigatório. É o URL de rastreamento de cliques do ícone da OBA.

Somente os URLs dos seguintes domínios são permitidos:
viewTrackingUrl

string

Obrigatório. É o URL de rastreamento de visualizações do ícone da OBA.

Somente os URLs dos seguintes domínios são permitidos:

ObaIconPosition

É a posição do ícone da OBA no criativo.

Tipos enumerados
OBA_ICON_POSITION_UNSPECIFIED A posição do ícone da OBA não é especificada.
OBA_ICON_POSITION_UPPER_RIGHT No canto superior direito do criativo.
OBA_ICON_POSITION_UPPER_LEFT No canto superior esquerdo do criativo.
OBA_ICON_POSITION_LOWER_RIGHT No canto inferior direito do criativo.
OBA_ICON_POSITION_LOWER_LEFT No canto inferior esquerdo do criativo.

ExpandingDirection

A direção de expansão do criativo expansível de terceiros.

Tipos enumerados
EXPANDING_DIRECTION_UNSPECIFIED A direção de expansão não foi especificada.
EXPANDING_DIRECTION_NONE Não se expande em nenhuma direção.
EXPANDING_DIRECTION_UP Abre para cima.
EXPANDING_DIRECTION_DOWN Expande para baixo.
EXPANDING_DIRECTION_LEFT Expande para a esquerda.
EXPANDING_DIRECTION_RIGHT Expande-se para a direita.
EXPANDING_DIRECTION_UP_AND_LEFT Expande para cima e para o lado esquerdo.
EXPANDING_DIRECTION_UP_AND_RIGHT Expande para cima e para o lado direito.
EXPANDING_DIRECTION_DOWN_AND_LEFT Expande-se para baixo e para o lado esquerdo.
EXPANDING_DIRECTION_DOWN_AND_RIGHT Expande-se para baixo e para o lado direito.
EXPANDING_DIRECTION_UP_OR_DOWN Expande para cima ou para baixo.
EXPANDING_DIRECTION_LEFT_OR_RIGHT Expande-se para o lado esquerdo ou direito.
EXPANDING_DIRECTION_ANY_DIAGONAL Pode se expandir em qualquer direção diagonal.

Métodos

create

 Gera um novo criativo.

delete

 Exclui um criativo.

get

 Recebe um criativo.

list

 Lista os criativos em um anunciante.

patch

 Atualiza um criativo existente.