A API Campaign Manager 360 v3.3 foi descontinuada e será desativada em 30 de junho de 2021. Até essa data, todos os usuários precisam migrar para uma versão mais recente da API.

CreativeAssets

Para ver uma lista de métodos desse recurso, consulte o final desta página.

Representações de recursos

CreativeAssets contém propriedades de um arquivo de material do criativo que será enviado ou que já foi enviado. Consulte o código de amostra do criativo para saber como fazer o upload de recursos e inserir um criativo.

{
  "kind": "dfareporting#creativeAssetMetadata",
  "assetIdentifier": {
    "type": string,
    "name": string
  },
  "detectedFeatures": [
    string
  ],
  "warnedValidationRules": [
    string
  ],
  "clickTags": [
    {
      "name": string,
      "eventName": string,
      "clickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ],
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "richMedia": boolean,
  "counterCustomEvents": [
    {
      "artworkLabel": string,
      "id": long,
      "videoReportingId": string,
      "artworkType": string,
      "advertiserCustomEventName": string,
      "targetType": string,
      "advertiserCustomEventType": string,
      "popupWindowProperties": {
        "offset": {
          "top": integer,
          "left": integer
        },
        "showScrollBar": boolean,
        "showToolBar": boolean,
        "showMenuBar": boolean,
        "showAddressBar": boolean,
        "showStatusBar": boolean,
        "positionType": string,
        "dimension": sizes Resource,
        "title": string
      },
      "advertiserCustomEventId": long,
      "exitClickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ],
  "exitCustomEvents": [
    {
      "artworkLabel": string,
      "id": long,
      "videoReportingId": string,
      "artworkType": string,
      "advertiserCustomEventName": string,
      "targetType": string,
      "advertiserCustomEventType": string,
      "popupWindowProperties": {
        "offset": {
          "top": integer,
          "left": integer
        },
        "showScrollBar": boolean,
        "showToolBar": boolean,
        "showMenuBar": boolean,
        "showAddressBar": boolean,
        "showStatusBar": boolean,
        "positionType": string,
        "dimension": sizes Resource,
        "title": string
      },
      "advertiserCustomEventId": long,
      "exitClickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ],
  "timerCustomEvents": [
    {
      "artworkLabel": string,
      "id": long,
      "videoReportingId": string,
      "artworkType": string,
      "advertiserCustomEventName": string,
      "targetType": string,
      "advertiserCustomEventType": string,
      "popupWindowProperties": {
        "offset": {
          "top": integer,
          "left": integer
        },
        "showScrollBar": boolean,
        "showToolBar": boolean,
        "showMenuBar": boolean,
        "showAddressBar": boolean,
        "showStatusBar": boolean,
        "positionType": string,
        "dimension": sizes Resource,
        "title": string
      },
      "advertiserCustomEventId": long,
      "exitClickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ]
}
Nome da propriedade Valor Descrição Notas
assetIdentifier nested object É o ID do material do criativo. Este campo é obrigatório.
assetIdentifier.name string É o nome do material do criativo. Este é um campo obrigatório ao inserir um material. Após a inserção, o assetIdentifier é usado para identificar o material enviado. Os caracteres no nome precisam ser alfanuméricos ou um dos seguintes: ".-_ ". Espaços são permitidos.
assetIdentifier.type string É o tipo de recurso a ser enviado. Este campo é obrigatório. FLASH e IMAGE não são mais compatíveis com novos uploads. Todos os recursos de imagem precisam usar HTML_IMAGE.

Os valores aceitáveis são:
  • "AUDIO"
  • "FLASH"
  • "HTML"
  • "HTML_IMAGE"
  • "IMAGE"
  • "VIDEO"
clickTags[] list Lista de click tags detectadas pelos recursos. Este é um campo somente leitura gerado automaticamente. Este campo está vazio para um recurso rich media.
clickTags[].clickThroughUrl nested object É o valor do parâmetro para a click tag especificada. Este campo contém um URL de clique.
clickTags[].clickThroughUrl.computedClickThroughUrl string É o campo de conveniência somente leitura que representa o URL real que será usado para esse clique. O URL é calculado da seguinte forma:
  • Se landingPageId for especificado, o URL da página de destino será atribuído a este campo.
  • Caso contrário, customClickThroughUrl será atribuído a este campo.
clickTags[].clickThroughUrl.customClickThroughUrl string É o URL de clique personalizado. Aplicável se o campo landingPageId não for definido.
clickTags[].clickThroughUrl.landingPageId long É o ID da página de destino do URL de clique.
clickTags[].eventName string É o nome do evento do anunciante associado à click tag. Este campo é usado por criativos DISPLAY_IMAGE_GALLERY e HTML5_BANNER. Aplicável a DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.
clickTags[].name string É o nome do parâmetro para a click tag especificada. Para materiais do criativo DISPLAY_IMAGE_GALLERY, este campo precisa corresponder ao valor do campo creativeAssetId.name do material do criativo.
counterCustomEvents[] list É a lista de eventos de contador configurados para o recurso. Este é um campo somente leitura gerado automaticamente e aplicável somente a um recurso rich media.
counterCustomEvents[].advertiserCustomEventId long É o ID exclusivo deste evento usado pela Geração de Relatórios e pela Transferência de dados. Este é um campo somente leitura.
counterCustomEvents[].advertiserCustomEventName string É o nome inserido pelo usuário para o evento.
counterCustomEvents[].advertiserCustomEventType string É o tipo de evento. Este é um campo somente leitura.

Os valores aceitáveis são:
  • "ADVERTISER_EVENT_COUNTER"
  • "ADVERTISER_EVENT_EXIT"
  • "ADVERTISER_EVENT_TIMER"
counterCustomEvents[].artworkLabel string É a coluna "Rótulo da arte", usada para vincular eventos no Campaign Manager a eventos no Studio. Este campo é obrigatório e não pode ser modificado após a inserção.
counterCustomEvents[].artworkType string É o tipo de arte usada pelo criativo. Este é um campo somente leitura.

Os valores aceitáveis são:
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
counterCustomEvents[].exitClickThroughUrl nested object É o URL de clique de saída do evento. Este campo é usado somente para eventos de saída.
counterCustomEvents[].exitClickThroughUrl.computedClickThroughUrl string É o campo de conveniência somente leitura que representa o URL real que será usado para esse clique. O URL é calculado da seguinte forma:
  • Se landingPageId for especificado, o URL da página de destino será atribuído a este campo.
  • Caso contrário, customClickThroughUrl será atribuído a este campo.
counterCustomEvents[].exitClickThroughUrl.customClickThroughUrl string É o URL de clique personalizado. Aplicável se o campo landingPageId não for definido.
counterCustomEvents[].exitClickThroughUrl.landingPageId long É o ID da página de destino do URL de clique.
counterCustomEvents[].id long É o ID deste evento. Este campo é obrigatório e não pode ser modificado após a inserção.
counterCustomEvents[].popupWindowProperties nested object São as propriedades para janelas pop-up rich media. Este campo é usado somente para eventos de saída.
counterCustomEvents[].popupWindowProperties.dimension nested object É a dimensão pop-up de um criativo. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativos: todos os RICH_MEDIA e todos os VPAID.
counterCustomEvents[].popupWindowProperties.offset nested object São as coordenadas do canto superior esquerdo da janela pop-up. Aplicável se positionType for COORDINATES.
counterCustomEvents[].popupWindowProperties.offset.left integer É a distância de deslocamento do lado esquerdo de um recurso ou de uma janela.
counterCustomEvents[].popupWindowProperties.offset.top integer É a distância de deslocamento da parte superior de um recurso ou de uma janela.
counterCustomEvents[].popupWindowProperties.positionType string É a posição da janela pop-up centralizada ou em uma coordenada específica.

Os valores aceitáveis são:
  • "CENTER"
  • "COORDINATES"
counterCustomEvents[].popupWindowProperties.showAddressBar boolean Indica se a barra de endereço do navegador será exibida.
counterCustomEvents[].popupWindowProperties.showMenuBar boolean Indica se a barra de menu do navegador será exibida.
counterCustomEvents[].popupWindowProperties.showScrollBar boolean Indica se a barra de rolagem do navegador será exibida.
counterCustomEvents[].popupWindowProperties.showStatusBar boolean Indica se a barra de status do navegador será exibida.
counterCustomEvents[].popupWindowProperties.showToolBar boolean Indica se a barra de ferramentas do navegador será exibida.
counterCustomEvents[].popupWindowProperties.title string É o título da janela pop-up.
counterCustomEvents[].targetType string É o tipo de segmentação usado pelo evento.

Os valores aceitáveis são:
  • "TARGET_BLANK"
  • "TARGET_PARENT"
  • "TARGET_POPUP"
  • "TARGET_SELF"
  • "TARGET_TOP"
counterCustomEvents[].videoReportingId string É o ID do relatório de vídeo, usado para diferenciar vários vídeos em um único criativo. Este é um campo somente leitura.
detectedFeatures[] list É a lista de dependências de recurso para o material do criativo que são detectadas pelo Campaign Manager. Essas dependências são os recursos a que um navegador precisa oferecer suporte a fim de renderizar seu criativo HTML5 corretamente. Este é um campo somente leitura gerado automaticamente.
exitCustomEvents[] list É a lista de eventos de saída configurados para o recurso. Este é um campo somente leitura gerado automaticamente e aplicável somente a um recurso rich media.
exitCustomEvents[].advertiserCustomEventId long É o ID exclusivo deste evento usado pela Geração de Relatórios e pela Transferência de dados. Este é um campo somente leitura.
exitCustomEvents[].advertiserCustomEventName string É o nome inserido pelo usuário para o evento.
exitCustomEvents[].advertiserCustomEventType string É o tipo de evento. Este é um campo somente leitura.

Os valores aceitáveis são:
  • "ADVERTISER_EVENT_COUNTER"
  • "ADVERTISER_EVENT_EXIT"
  • "ADVERTISER_EVENT_TIMER"
exitCustomEvents[].artworkLabel string É a coluna "Rótulo da arte", usada para vincular eventos no Campaign Manager a eventos no Studio. Este campo é obrigatório e não pode ser modificado após a inserção.
exitCustomEvents[].artworkType string É o tipo de arte usada pelo criativo. Este é um campo somente leitura.

Os valores aceitáveis são:
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
exitCustomEvents[].exitClickThroughUrl nested object É o URL de clique de saída do evento. Este campo é usado somente para eventos de saída.
exitCustomEvents[].exitClickThroughUrl.computedClickThroughUrl string É o campo de conveniência somente leitura que representa o URL real que será usado para esse clique. O URL é calculado da seguinte forma:
  • Se landingPageId for especificado, o URL da página de destino será atribuído a este campo.
  • Caso contrário, customClickThroughUrl será atribuído a este campo.
exitCustomEvents[].exitClickThroughUrl.customClickThroughUrl string É o URL de clique personalizado. Aplicável se o campo landingPageId não for definido.
exitCustomEvents[].exitClickThroughUrl.landingPageId long É o ID da página de destino do URL de clique.
exitCustomEvents[].id long É o ID deste evento. Este campo é obrigatório e não pode ser modificado após a inserção.
exitCustomEvents[].popupWindowProperties nested object São as propriedades para janelas pop-up rich media. Este campo é usado somente para eventos de saída.
exitCustomEvents[].popupWindowProperties.dimension nested object É a dimensão pop-up de um criativo. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativos: todos os RICH_MEDIA e todos os VPAID.
exitCustomEvents[].popupWindowProperties.offset nested object São as coordenadas do canto superior esquerdo da janela pop-up. Aplicável se positionType for COORDINATES.
exitCustomEvents[].popupWindowProperties.offset.left integer É a distância de deslocamento do lado esquerdo de um recurso ou de uma janela.
exitCustomEvents[].popupWindowProperties.offset.top integer É a distância de deslocamento da parte superior de um recurso ou de uma janela.
exitCustomEvents[].popupWindowProperties.positionType string É a posição da janela pop-up centralizada ou em uma coordenada específica.

Os valores aceitáveis são:
  • "CENTER"
  • "COORDINATES"
exitCustomEvents[].popupWindowProperties.showAddressBar boolean Indica se a barra de endereço do navegador será exibida.
exitCustomEvents[].popupWindowProperties.showMenuBar boolean Indica se a barra de menu do navegador será exibida.
exitCustomEvents[].popupWindowProperties.showScrollBar boolean Indica se a barra de rolagem do navegador será exibida.
exitCustomEvents[].popupWindowProperties.showStatusBar boolean Indica se a barra de status do navegador será exibida.
exitCustomEvents[].popupWindowProperties.showToolBar boolean Indica se a barra de ferramentas do navegador será exibida.
exitCustomEvents[].popupWindowProperties.title string É o título da janela pop-up.
exitCustomEvents[].targetType string É o tipo de segmentação usado pelo evento.

Os valores aceitáveis são:
  • "TARGET_BLANK"
  • "TARGET_PARENT"
  • "TARGET_POPUP"
  • "TARGET_SELF"
  • "TARGET_TOP"
exitCustomEvents[].videoReportingId string É o ID do relatório de vídeo, usado para diferenciar vários vídeos em um único criativo. Este é um campo somente leitura.
id long É o ID numérico do recurso. Este é um campo somente leitura gerado automaticamente.
idDimensionValue nested object É o valor da dimensão do ID numérico do recurso. Este é um campo somente leitura gerado automaticamente.
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#creativeAssetMetadata".
richMedia boolean Verdadeiro se o recurso enviado for um recurso rich media. Este é um campo somente leitura gerado automaticamente.
timerCustomEvents[] list É a lista de eventos de tempo configurados para o recurso. Este é um campo somente leitura gerado automaticamente e aplicável somente a um recurso rich media.
timerCustomEvents[].advertiserCustomEventId long É o ID exclusivo deste evento usado pela Geração de Relatórios e pela Transferência de dados. Este é um campo somente leitura.
timerCustomEvents[].advertiserCustomEventName string É o nome inserido pelo usuário para o evento.
timerCustomEvents[].advertiserCustomEventType string É o tipo de evento. Este é um campo somente leitura.

Os valores aceitáveis são:
  • "ADVERTISER_EVENT_COUNTER"
  • "ADVERTISER_EVENT_EXIT"
  • "ADVERTISER_EVENT_TIMER"
timerCustomEvents[].artworkLabel string É a coluna "Rótulo da arte", usada para vincular eventos no Campaign Manager a eventos no Studio. Este campo é obrigatório e não pode ser modificado após a inserção.
timerCustomEvents[].artworkType string É o tipo de arte usada pelo criativo. Este é um campo somente leitura.

Os valores aceitáveis são:
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
timerCustomEvents[].exitClickThroughUrl nested object É o URL de clique de saída do evento. Este campo é usado somente para eventos de saída.
timerCustomEvents[].exitClickThroughUrl.computedClickThroughUrl string É o campo de conveniência somente leitura que representa o URL real que será usado para esse clique. O URL é calculado da seguinte forma:
  • Se landingPageId for especificado, o URL da página de destino será atribuído a este campo.
  • Caso contrário, customClickThroughUrl será atribuído a este campo.
timerCustomEvents[].exitClickThroughUrl.customClickThroughUrl string É o URL de clique personalizado. Aplicável se o campo landingPageId não for definido.
timerCustomEvents[].exitClickThroughUrl.landingPageId long É o ID da página de destino do URL de clique.
timerCustomEvents[].id long É o ID deste evento. Este campo é obrigatório e não pode ser modificado após a inserção.
timerCustomEvents[].popupWindowProperties nested object São as propriedades para janelas pop-up rich media. Este campo é usado somente para eventos de saída.
timerCustomEvents[].popupWindowProperties.dimension nested object É a dimensão pop-up de um criativo. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativos: todos os RICH_MEDIA e todos os VPAID.
timerCustomEvents[].popupWindowProperties.offset nested object São as coordenadas do canto superior esquerdo da janela pop-up. Aplicável se positionType for COORDINATES.
timerCustomEvents[].popupWindowProperties.offset.left integer É a distância de deslocamento do lado esquerdo de um recurso ou de uma janela.
timerCustomEvents[].popupWindowProperties.offset.top integer É a distância de deslocamento da parte superior de um recurso ou de uma janela.
timerCustomEvents[].popupWindowProperties.positionType string É a posição da janela pop-up centralizada ou em uma coordenada específica.

Os valores aceitáveis são:
  • "CENTER"
  • "COORDINATES"
timerCustomEvents[].popupWindowProperties.showAddressBar boolean Indica se a barra de endereço do navegador será exibida.
timerCustomEvents[].popupWindowProperties.showMenuBar boolean Indica se a barra de menu do navegador será exibida.
timerCustomEvents[].popupWindowProperties.showScrollBar boolean Indica se a barra de rolagem do navegador será exibida.
timerCustomEvents[].popupWindowProperties.showStatusBar boolean Indica se a barra de status do navegador será exibida.
timerCustomEvents[].popupWindowProperties.showToolBar boolean Indica se a barra de ferramentas do navegador será exibida.
timerCustomEvents[].popupWindowProperties.title string É o título da janela pop-up.
timerCustomEvents[].targetType string É o tipo de segmentação usado pelo evento.

Os valores aceitáveis são:
  • "TARGET_BLANK"
  • "TARGET_PARENT"
  • "TARGET_POPUP"
  • "TARGET_SELF"
  • "TARGET_TOP"
timerCustomEvents[].videoReportingId string É o ID do relatório de vídeo, usado para diferenciar vários vídeos em um único criativo. Este é um campo somente leitura.
warnedValidationRules[] list Regras validadas durante a geração do código que geraram um aviso. Este é um campo somente leitura gerado automaticamente.

Os valores possíveis são:
  • "ADMOB_REFERENCED"
  • "ASSET_FORMAT_UNSUPPORTED_DCM"
  • "ASSET_INVALID"
  • "CLICK_TAG_HARD_CODED"
  • "CLICK_TAG_INVALID"
  • "CLICK_TAG_IN_GWD"
  • "CLICK_TAG_MISSING"
  • "CLICK_TAG_MORE_THAN_ONE"
  • "CLICK_TAG_NON_TOP_LEVEL"
  • "COMPONENT_UNSUPPORTED_DCM"
  • "ENABLER_UNSUPPORTED_METHOD_DCM"
  • "EXTERNAL_FILE_REFERENCED"
  • "FILE_DETAIL_EMPTY"
  • "FILE_TYPE_INVALID"
  • "GWD_PROPERTIES_INVALID"
  • "HTML5_FEATURE_UNSUPPORTED"
  • "LINKED_FILE_NOT_FOUND"
  • "MAX_FLASH_VERSION_11"
  • "MRAID_REFERENCED"
  • "NOT_SSL_COMPLIANT"
  • "ORPHANED_ASSET"
  • "PRIMARY_HTML_MISSING"
  • "SVG_INVALID"
  • "ZIP_INVALID"

Métodos

insert
Insere um novo material do criativo.