REST Resource: advertisers.creatives

Recurso: Creative

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 do 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 só é aplicável a criativos que são sincronizados no Campaign Manager.
displayName

string

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

Precisa ser codificado em UTF-8 com um 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. É o carimbo de data/hora em que o criativo foi atualizado pela última vez pelo usuário ou pelo sistema (por exemplo, revisão do criativo). Atribuído pelo sistema.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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. É o carimbo de data/hora em que o criativo foi criado. Atribuído pelo sistema.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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 de 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 padrão será 0 quando creativeType for uma destas opções:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
additionalDimensions[]

object (Dimensions)

Dimensões adicionais. Aplicável quando creativeType é uma das seguintes opções:

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

Se esse 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. Duração da mídia do criativo. Aplicável quando creativeType é uma das seguintes opções:

  • 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 que é gerada pelo sistema.
reviewStatus

object (ReviewStatusInfo)

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

object (AssetAssociation)

Obrigatório. 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 Enabler (Enabler.exit()) para rastrear saídas em formatos rich media.
timerEvents[]

object (TimerEvent)

Eventos personalizados de timer 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 a opção em branco ou sem definição 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 o usuário interage com qualquer parte de um criativo rich media de uma maneira especificada (passagem e saída do mouse, cliques, toques, carregamento de dados, uso do teclado etc.). Qualquer evento capturado no criativo pode ser registrado como um contador. Deixe a opção em branco ou sem definição 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 código usadas para vincular este criativo a um sistema externo. Precisa ser codificado em UTF-8 com um comprimento de no máximo 10.000 caracteres.
notes

string

Observações do usuário para este criativo. Precisa ser codificado em UTF-8 com um comprimento de no máximo 20.000 caracteres.
iasCampaignMonitoring

boolean

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

string (int64 format)

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

É possível atribuir criativos de display existentes (com recursos de imagem ou HTML5) 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.

Os criativos que contêm additional dimensions não podem ser complementares.

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

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
skippable

boolean

Indica se o usuário pode optar por pular um criativo em vídeo.

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

  • CREATIVE_TYPE_VIDEO
skipOffset

object (AudioVideoOffset)

Tempo que o vídeo é reproduzido antes de o botão "Pular" ser exibido.

Este campo é obrigatório quando skippable é verdadeiro.

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

  • CREATIVE_TYPE_VIDEO
progressOffset

object (AudioVideoOffset)

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

Este campo é obrigatório quando skippable é verdadeiro.

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

  • CREATIVE_TYPE_VIDEO
universalAdId

object (UniversalAdId)

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

O ID universal do anúncio faz parte do padrão VAST 4.0. Ele pode ser modificado depois da criação do criativo.

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

  • CREATIVE_TYPE_VIDEO
thirdPartyUrls[]

object (ThirdPartyUrl)

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

Esse campo só é compatível com os seguintes 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 distintos ou têm propriedades variadas (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.

Essas transcodificações oferecem ao sistema do editor mais opções para cada impressão no seu vídeo e garantem a veiculação do arquivo adequado com base no tamanho da tela e na conexão do usuário.

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.

Esse campo só pode ser gravado nas seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

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

Esse campo só pode ser gravado nas seguintes 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 o Campaign Manager 360 e a veiculação de anúncios 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 de terceiros original usada para o 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 exige MRAID (sistema de definições de interface para anúncios rich media para dispositivos móveis).

Defina essa opção se o criativo depender de 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 atribuição.

Válido somente quando um anúncio de rastreamento do Campaign Manager 360 é usado 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 criativos 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 têm 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.

Os criativos expansíveis de terceiros têm a seguinte origem de hospedagem:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_EXPANDABLE
expandOnHover

boolean

Opcional. Indica que o criativo se expande automaticamente ao passar o cursor.

Opcional e válido somente para criativos expansíveis de terceiros. Os criativos expansíveis de terceiros têm 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 de tag VAST de terceiros.

Os criativos de tag VAST de terceiros têm 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 de tag VAST de terceiros exige VPAID (interface digital de player de vídeo-anúncio).

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

Os criativos de tag VAST de terceiros têm os seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com os seguintes creativeType:

  • CREATIVE_TYPE_VIDEO
html5Video

boolean

Apenas saída. Indica que o criativo da tag VAST de terceiros exige suporte a vídeo HTML5.

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

Os criativos de tag VAST de terceiros têm 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 aos quais este criativo está associado.

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

boolean

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

Somente saída e válida somente para criativos em á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 em á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 de um criativo. Indica onde um criativo é criado e hospedado.

Enums
HOSTING_SOURCE_UNSPECIFIED A origem da hospedagem não está 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 "create" e "update" têm 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 criado no DV360 e hospedado pelo Campaign Manager 360.

Os métodos "create" e "update" têm 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

Atributos possíveis de um criativo.

Enums
CREATIVE_ATTRIBUTE_UNSPECIFIED O atributo do criativo não está 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)

É o status da revisão do criativo e da página de destino para o criativo.
contentAndPolicyReviewStatus

enum (ReviewStatus)

É o status da análise de compliance com a política do criativo.
exchangeReviewStatuses[]

object (ExchangeReviewStatus)

Troque o status de revisão do criativo.
publisherReviewStatuses[]

object (PublisherReviewStatus)

Status da revisão do editor para o criativo.

ApprovalStatus

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

Enums
APPROVAL_STATUS_UNSPECIFIED O valor do tipo não é 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 análise adicional de conteúdo e política.
APPROVAL_STATUS_APPROVED_SERVABLE As revisões de criativos e páginas de destino, assim como de conteúdo e políticas foram aprovadas. O criativo pode ser veiculado.
APPROVAL_STATUS_REJECTED_NOT_SERVABLE É necessário corrigir um problema com o criativo antes de ele ser veiculado.

ReviewStatus

Possíveis tipos de status de revisão.

Enums
REVIEW_STATUS_UNSPECIFIED O valor do tipo não é 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

Trocar o status da revisão 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 da revisão do editor para o criativo.

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

string

O editor que está revisando o criativo.
status

enum (ReviewStatus)

Status da avaliação do editor.

AssetAssociation

Associação de recursos 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 do recurso no 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 a outras chamadas de API, por exemplo, creatives.create para associar o recurso a um criativo.

O espaço do ID de 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, recupere o novo ID nos recursos de criativos associados ou refaça o upload do recurso.
content

string

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

AssetRole

É a função do recurso no criativo.

Enums
ASSET_ROLE_UNSPECIFIED O papel do recurso não é especificado ou é desconhecido nesta versão.
ASSET_ROLE_MAIN O recurso é o recurso 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 com até 25 caracteres.

Esse 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.

Esse 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 de texto de um criativo nativo.

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

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

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_BODY

Corpo de texto longo de um criativo nativo.

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

Esse 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 otimizada do URL da página de destino que será exibida 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 de legenda poderá ser "example.com". O protocolo (http://) é opcional, mas o URL não pode conter espaços ou caracteres especiais.

Esse 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 que será usado no botão de call-to-action de um criativo nativo.

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

Esse 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 com até 25 caracteres.

Esse 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 app na Google Play Store ou na app store do iOS (por exemplo, R$ 5,99).

Esse valor não é sincronizado automaticamente com o valor real listado na loja. Ele será sempre o fornecido quando o criativo for salvo.

O content precisa ser codificado em UTF-8 com até 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.

Ele pode ser encontrado no URL do app na Google Play Store, depois de "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 identificação pode ser encontrado no URL da App Store da Apple 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 aplicativo na Google Play Store ou na App Store do iOS.

Esse valor não é sincronizado automaticamente com a classificação real na loja. Ele será sempre o fornecido quando o criativo for salvo.

Os recursos desse papel são somente leitura.
ASSET_ROLE_ICON

O ícone de um criativo.

Esse 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.

Esse 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 do 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.

Cada criativo precisa ter um nome exclusivo.

Deixe a opção em branco ou sem definição para criativos que contêm somente recursos de imagem.
reportingName

string

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

ExitEventType

O tipo de um evento de saída.

Enums
EXIT_EVENT_TYPE_UNSPECIFIED O tipo de evento de saída não é 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 de timer do criativo.

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

string

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

string

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

CounterEvent

Evento de 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 em relatórios.

AudioVideoOffset

A duração de um áudio ou vídeo foi reproduzido.

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 pode ser apenas de um dos tipos a seguir:
percentage

string (int64 format)

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

string (int64 format)

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

UniversalAdId

Um identificador de criativo fornecido por um registro 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 universal do anúncio.

Enums
UNIVERSAL_AD_REGISTRY_UNSPECIFIED O registro de anúncios universais 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 fornecer o ID universal do anúncio.
UNIVERSAL_AD_REGISTRY_CLEARCAST Use clearcast.co.uk para fornecer 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 informar 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 opcional ou string de consulta, 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.

Enums
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 o 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% da 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% da 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% da duração.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE Usado para rastrear o número de vezes que o áudio ou o 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 reproduz o áudio ou o vídeo novamente.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN Usado para rastrear o número de vezes que um usuário expande o player para o tamanho de 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 o vídeo é reproduzido até 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)

São as dimensões do vídeo transcodificado.
bitRateKbps

string (int64 format)

É a 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 do 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 stream de áudio do vídeo transcodificado, ou a taxa de amostragem do áudio transcodificado, em hertz.
fileSizeBytes

string (int64 format)

É o tamanho do arquivo transcodificado em bytes.

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 do í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)

São as dimensões do ícone da OBA.
program

string

O 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 URLs dos seguintes domínios são permitidos:
clickTrackingUrl

string

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

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

string

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

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

ObaIconPosition

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

Enums
OBA_ICON_POSITION_UNSPECIFIED A posição do ícone da OBA não foi especificada.
OBA_ICON_POSITION_UPPER_RIGHT No lado superior direito do criativo.
OBA_ICON_POSITION_UPPER_LEFT No lado superior esquerdo do criativo.
OBA_ICON_POSITION_LOWER_RIGHT No lado inferior direito do criativo.
OBA_ICON_POSITION_LOWER_LEFT No lado inferior esquerdo do criativo.

ExpandingDirection

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

Enums
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 Expande para cima.
EXPANDING_DIRECTION_DOWN Expande para baixo.
EXPANDING_DIRECTION_LEFT Expande-se para a esquerda.
EXPANDING_DIRECTION_RIGHT Expande-se para a direita.
EXPANDING_DIRECTION_UP_AND_LEFT Expande-se 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 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 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.