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 a que 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. Esse campo só é aplicável a criativos sincronizados do 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.

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 da última atualização do criativo, feita pelo usuário ou pelo sistema (por exemplo, revisão do criativo). Atribuído pelo sistema.

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".
createTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que o criativo foi criado. Atribuído pelo sistema.

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".
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 é definido por padrão como 0 quando creativeType é um dos seguintes:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
additionalDimensions[]

object (Dimensions)

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

  • 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 opções abaixo:

  • 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. 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 que os usuários podem clicar ou tocar para abrir a página de destino de um anunciante. Todos os criativos precisam incluir pelo menos uma saída. Você pode adicionar uma saída ao criativo das seguintes maneiras:

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

object (TimerEvent)

Opcional. Eventos personalizados de tempo para um criativo rich media. Os timers rastreiam o tempo em que um usuário visualiza e interage com uma parte específica de um criativo rich media. Um criativo pode ter vários eventos de tempo, cada um medido de maneira independente. Deixe em branco ou não defina para criativos que contenham apenas recursos de imagem.
counterEvents[]

object (CounterEvent)

Opcional. 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 em branco ou não defina para criativos que contenham apenas recursos de imagem.
appendedTag

string

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

string

Opcional. Informações de 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

Opcional. Observações do usuário para este criativo. Precisa ser codificado em UTF-8 e ter no máximo 20.000 caracteres.
iasCampaignMonitoring

boolean

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

string (int64 format)

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

Você pode atribuir criativos de display existentes (com recursos HTML5 e de imagem) para serem veiculados em torno do player de vídeo do editor. Os complementares são exibidos ao redor do player de vídeo durante e após o conteúdo.

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

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

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
skippable

boolean

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

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

  • CREATIVE_TYPE_VIDEO
skipOffset

object (AudioVideoOffset)

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

Esse campo é obrigatório quando skippable é verdadeiro.

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

  • CREATIVE_TYPE_VIDEO
progressOffset

object (AudioVideoOffset)

Opcional. Indica por quanto tempo o vídeo é reproduzido antes de contar uma visualização.

Esse 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 que o criativo é criado.

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

  • CREATIVE_TYPE_VIDEO
thirdPartyUrls[]

object (ThirdPartyUrl)

Opcional. URLs de rastreamento de terceiros para acompanhar interações com um criativo de 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 diferentes ou têm propriedades diferentes (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 mais opções ao sistema de um editor para cada impressão no seu vídeo, além de garantir que o arquivo adequado seja veiculado com base no tamanho da tela e na conexão do usuário.

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

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_AUDIO
trackerUrls[]

string

Opcional. URLs de rastreamento para provedores de análise ou fornecedores de tecnologia de publicidade de terceiros.

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.

Use somente URLs padrão. As tags IMG e SCRIPT não são compatíveis.

Este campo só pode ser gravado nos seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

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

Este campo só pode ser gravado nos seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object (CmTrackingAd)

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

Apenas saída para outros casos.
obaIcon

object (ObaIcon)

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

Esse 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 apenas para criativos de tag de terceiros.

Os criativos de tag de terceiros têm as seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com o seguinte 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 isso se o criativo depender de gestos de dispositivos móveis para interatividade, como deslizar ou tocar.

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

Os criativos de tag de terceiros têm as seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com o seguinte creativeType:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireHtml5

boolean

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

Opcional e válido apenas para criativos de tag de terceiros. Os criativos de tag de terceiros têm as seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com o seguinte creativeType:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requirePingForAttribution

boolean

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

Só é válido 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 apenas para criativos de tag de terceiros ou criativos de tag VAST de terceiros.

Os criativos de tag de terceiros têm as seguintes hostingSource:

  • HOSTING_SOURCE_THIRD_PARTY

combinado com o seguinte 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 o seguinte 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 apenas para criativos expansíveis de terceiros.

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

  • HOSTING_SOURCE_THIRD_PARTY

combinado com o seguinte creativeType:

  • CREATIVE_TYPE_EXPANDABLE
expandOnHover

boolean

Opcional. Indica que o criativo vai se expandir automaticamente ao passar o cursor sobre ele.

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

  • HOSTING_SOURCE_THIRD_PARTY

combinado com o seguinte 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 apenas para criativos de tags VAST de terceiros.

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

  • HOSTING_SOURCE_THIRD_PARTY

combinado com o seguinte creativeType:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
vpaid

boolean

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

Saída somente e válida apenas 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 o seguinte creativeType:

  • CREATIVE_TYPE_VIDEO
html5Video

boolean

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

Saída somente e válida apenas 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 o seguinte creativeType:

  • CREATIVE_TYPE_VIDEO
lineItemIds[]

string (int64 format)

Apenas saída. Os IDs dos itens de linha a que o 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.

Apenas saída e válido somente para criativos de áudio de terceiros.

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

  • HOSTING_SOURCE_THIRD_PARTY

combinado com o seguinte creativeType:

  • CREATIVE_TYPE_AUDIO
oggAudio

boolean

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

Apenas saída e válido somente para criativos de áudio de terceiros.

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

  • HOSTING_SOURCE_THIRD_PARTY

combinado com o seguinte 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 esse 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 são compatíveis com 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 de criação e atualização são compatíveis com 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 esse 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 VPAID linear.
CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR O criativo é um VPAID não linear.

ReviewStatusInfo

Status da revisão 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.
contentAndPolicyReviewStatus

enum (ReviewStatus)

Status da revisão do conteúdo e da política para o criativo.
exchangeReviewStatuses[]

object (ExchangeReviewStatus)

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

object (PublisherReviewStatus)

Status de revisão do editor para o criativo.

ApprovalStatus

Tipos possíveis de status de aprovação. É 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 passou pela revisão de criativo e página de destino e pode ser veiculado, mas ainda aguarda uma revisão adicional de conteúdo e política.
APPROVAL_STATUS_APPROVED_SERVABLE As revisões do criativo e da página de destino, bem como do conteúdo e da política, foram aprovadas. O criativo pode ser veiculado.
APPROVAL_STATUS_REJECTED_NOT_SERVABLE É necessário corrigir um problema no criativo antes que ele possa ser veiculado.

ReviewStatus

Tipos possíveis de status de avaliaçã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 é rejeitado.
REVIEW_STATUS_PENDING O criativo está com revisão pendente.

ExchangeReviewStatus

Status da revisão da troca para o criativo.

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

enum (Exchange)

A troca que está revisando o criativo.
status

enum (ReviewStatus)

Status da análise da troca.

PublisherReviewStatus

Status da revisão do editor para o criativo.

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

string

O publisher que está revisando o criativo.
status

enum (ReviewStatus)

Status da revisão do editor.

AssetAssociation

Associação de recursos para o criativo.

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

object (Asset)

Opcional. O recurso associado.
role

enum (AssetRole)

Opcional. É a função deste recurso para o criativo.

Recurso

Um único recurso.

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

string (int64 format)

ID de mídia do recurso enviado. É 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 de 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 recuperando o novo ID de mídia dos recursos de criativo associados ou enviando o recurso novamente.
content

string

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

AssetRole

É a função deste 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 educado 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.

Essa função 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 e ter no máximo 50 caracteres.

Essa função só é compatível com os seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_BODY

Corpo do texto de um criativo nativo.

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

Essa função só é compatível com os seguintes creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_BODY

Corpo do texto longo de um criativo nativo.

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

Essa função 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 simples do URL da página de destino para mostrar no criativo. Esse URL dá às pessoas uma ideia do que elas vão acessar ao clicar no criativo.

O content precisa ser codificado em UTF-8 e ter no máximo 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.

Essa função 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 e ter no máximo 15 caracteres.

Essa função 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.

Essa função 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 app na Google Play Store ou na App Store do iOS (por exemplo, R$ 25,99).

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

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

Os recursos dessa função são somente leitura.
ASSET_ROLE_ANDROID_APP_ID

O ID de um app Android na Google Play Store.

Você pode encontrar esse ID 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 dessa função 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 App Store como a string de números diretamente após "id". Por exemplo, em https://apps.apple.com/us/app/gmail-email-by-google/id422689480, o ID é 422689480.

Os recursos dessa função 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 fornecido ao salvar o criativo.

Os recursos dessa função 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 de capa de um criativo de vídeo nativo.

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

  • CREATIVE_TYPE_VIDEO
ASSET_ROLE_BACKGROUND_COLOR

A cor principal a ser usada em um criativo.

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

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_ACCENT_COLOR

A cor de destaque a ser usada em um criativo.

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

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_REQUIRE_IMAGE

Se o criativo precisa usar um recurso de imagem.

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

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS

Indica se as melhorias de recursos podem ser aplicadas ao criativo.

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

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE

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

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

O nome precisa ser exclusivo em uma peça criativa.

Deixe em branco ou não defina para criativos que contenham apenas recursos de imagem.
reportingName

string

Opcional. O nome usado para identificar esse evento nos relatórios. Deixe em branco ou não defina para criativos que contenham apenas 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 foi 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 de timer.
reportingName

string

Obrigatório. O nome usado para identificar esse evento de tempo em relatórios.

CounterEvent

Evento de contador do criativo.

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

string

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

string

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

AudioVideoOffset

O tempo que 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)

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

string (int64 format)

Opcional. O deslocamento em segundos desde 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

Opcional. O identificador exclusivo da peça criativa.
registry

enum (UniversalAdRegistry)

Opcional. O registro fornece identificadores exclusivos de criativos.

UniversalAdRegistry

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

Tipos enumerados
UNIVERSAL_AD_REGISTRY_UNSPECIFIED O registro de ID do anúncio universal 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 Ad-ID 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 fornecer o ID universal do anúncio.

ThirdPartyUrl

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

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

enum (ThirdPartyUrlType)

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

string

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

Informe 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 rastreado 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 as impressões do criativo depois que o buffer de áudio ou vídeo é concluído.
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 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 desativa o som do áudio ou do 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 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 modo 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 faz um clique personalizado, como clicar em um ponto de acesso 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 pulado.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS Usado para rastrear o número de vezes que o áudio ou vídeo é reproduzido até um deslocamento determinado pelo progressOffset.

transcodificar

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

Opcional. O nome do arquivo transcodificado.
mimeType

string

Opcional. O tipo MIME do arquivo transcodificado.
transcoded

boolean

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

object (Dimensions)

Opcional. As dimensões do vídeo transcodificado.
bitRateKbps

string (int64 format)

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

number

Opcional. A taxa de quadros do vídeo transcodificado, em quadros por segundo.
audioBitRateKbps

string (int64 format)

Opcional. A taxa de bits do stream de áudio do vídeo transcodificado ou do áudio transcodificado, em quilobits por segundo.
audioSampleRateHz

string (int64 format)

Opcional. A taxa de amostragem em hertz do stream de áudio do vídeo transcodificado ou do áudio transcodificado.
fileSizeBytes

string (int64 format)

Opcional. 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)

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

string (int64 format)

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

string (int64 format)

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

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

string

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

enum (ObaIconPosition)

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

object (Dimensions)

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

string

Opcional. É 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:

  • https://info.evidon.com
  • https://l.betrad.com
clickTrackingUrl

string

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

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

  • https://info.evidon.com
  • https://l.betrad.com
viewTrackingUrl

string

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

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

  • https://info.evidon.com
  • https://l.betrad.com

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 foi 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 Expansão para cima.
EXPANDING_DIRECTION_DOWN Expansão para baixo.
EXPANDING_DIRECTION_LEFT Expande para a esquerda.
EXPANDING_DIRECTION_RIGHT Expansão para a direita.
EXPANDING_DIRECTION_UP_AND_LEFT Expande para cima e para a esquerda.
EXPANDING_DIRECTION_UP_AND_RIGHT Expande para cima e para a direita.
EXPANDING_DIRECTION_DOWN_AND_LEFT Expande para baixo e para a esquerda.
EXPANDING_DIRECTION_DOWN_AND_RIGHT Expande para baixo e para a direita.
EXPANDING_DIRECTION_UP_OR_DOWN Expande para cima ou para baixo.
EXPANDING_DIRECTION_LEFT_OR_RIGHT Expande para a esquerda ou para a direita.
EXPANDING_DIRECTION_ANY_DIAGONAL Pode se expandir em qualquer direção diagonal.

Métodos

create

 Cria um criativo.

delete

 Exclui um criativo.

get

 Recebe um criativo.

list

 Lista os criativos de um anunciante.

patch

 Atualiza um criativo existente.