Criativos

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

Representações de recursos

Contém propriedades de um Criativo.

{
  "kind": "dfareporting#creative",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "renderingIdDimensionValue": dimensionValues Resource,
  "name": string,
  "renderingId": long,
  "advertiserId": long,
  "accountId": long,
  "subaccountId": long,
  "active": boolean,
  "archived": boolean,
  "version": integer,
  "size": sizes Resource,
  "additionalSizes": [
    sizes Resource
  ],
  "creativeFieldAssignments": [
    {
      "creativeFieldId": long,
      "creativeFieldValueId": long
    }
  ],
  "lastModifiedInfo": {
    "time": long
  },
  "sslCompliant": boolean,
  "compatibility": [
    string
  ],
  "type": string,
  "creativeAssets": [
    {
      "id": long,
      "assetIdentifier": {
        "type": string,
        "name": string
      },
      "sslCompliant": boolean,
      "size": sizes Resource,
      "additionalSizes": [
        sizes Resource
      ],
      "fileSize": long,
      "flashVersion": integer,
      "actionScript3": boolean,
      "zipFilename": string,
      "zipFilesize": string,
      "detectedFeatures": [
        string
      ],
      "displayType": string,
      "artworkType": string,
      "collapsedSize": sizes Resource,
      "offset": {
        "top": integer,
        "left": integer
      },
      "zIndex": integer,
      "windowMode": string,
      "transparency": boolean,
      "pushdown": boolean,
      "pushdownDuration": float,
      "position": {
        "top": integer,
        "left": integer
      },
      "positionTopUnit": string,
      "positionLeftUnit": string,
      "verticallyLocked": boolean,
      "horizontallyLocked": boolean,
      "startTimeType": string,
      "customStartTimeValue": integer,
      "durationType": string,
      "duration": integer,
      "hideFlashObjects": boolean,
      "hideSelectionBoxes": boolean,
      "alignment": string,
      "childAssetType": string,
      "originalBackup": boolean,
      "bitRate": integer,
      "mimeType": string,
      "active": boolean,
      "progressiveServingUrl": string,
      "streamingServingUrl": string,
      "mediaDuration": float,
      "expandedDimension": sizes Resource,
      "role": string,
      "backupImageExit": {
        "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
        }
      },
      "companionCreativeIds": [
        long
      ],
      "idDimensionValue": dimensionValues Resource,
      "orientation": string,
      "audioBitRate": integer,
      "audioSampleRate": integer,
      "frameRate": float,
      "politeLoad": boolean
    }
  ],
  "redirectUrl": string,
  "htmlCode": string,
  "htmlCodeLocked": boolean,
  "backgroundColor": string,
  "allowScriptAccess": boolean,
  "fsCommand": {
    "positionOption": string,
    "top": integer,
    "left": integer,
    "windowWidth": integer,
    "windowHeight": integer
  },
  "backupImageClickThroughUrl": {
    "landingPageId": long,
    "customClickThroughUrl": string,
    "computedClickThroughUrl": string
  },
  "backupImageTargetWindow": {
    "targetWindowOption": string,
    "customHtml": string
  },
  "clickTags": [
    {
      "name": string,
      "eventName": string,
      "clickThroughUrl": {
        "landingPageId": long,
        "customClickThroughUrl": string,
        "computedClickThroughUrl": string
      }
    }
  ],
  "backupImageFeatures": [
    string
  ],
  "authoringTool": string,
  "requiredFlashPluginVersion": string,
  "adTagKeys": [
    string
  ],
  "customKeyValues": [
    string
  ],
  "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
      }
    }
  ],
  "artworkType": string,
  "requiredFlashVersion": integer,
  "thirdPartyBackupImageImpressionsUrl": string,
  "thirdPartyRichMediaImpressionsUrl": string,
  "totalFileSize": long,
  "mediaDuration": float,
  "commercialId": string,
  "companionCreatives": [
    long
  ],
  "mediaDescription": string,
  "skippable": boolean,
  "thirdPartyUrls": [
    {
      "thirdPartyUrlType": string,
      "url": string
    }
  ],
  "adParameters": string,
  "overrideCss": string,
  "studioCreativeId": long,
  "studioTraffickedCreativeId": long,
  "latestTraffickedCreativeId": long,
  "studioAdvertiserId": long,
  "autoAdvanceImages": boolean,
  "backupImageReportingLabel": string,
  "convertFlashToHtml5": boolean,
  "sslOverride": boolean,
  "skipOffset": {
    "offsetSeconds": integer,
    "offsetPercentage": integer
  },
  "progressOffset": {
    "offsetSeconds": integer,
    "offsetPercentage": integer
  },
  "obaIcon": {
    "resourceUrl": string,
    "xPosition": string,
    "yPosition": string,
    "size": sizes Resource,
    "program": string,
    "iconClickThroughUrl": string,
    "iconClickTrackingUrl": string,
    "iconViewTrackingUrl": string
  },
  "authoringSource": string,
  "dynamicAssetSelection": boolean,
  "creativeAssetSelection": {
    "rules": [
      {
        "name": string,
        "assetId": long,
        "targetingTemplateId": long
      }
    ],
    "defaultAssetId": long
  },
  "universalAdId": {
    "registry": string,
    "value": string
  }
}
Nome da propriedade Valor Descrição Observações
accountId long É o ID da conta deste criativo. Este campo, se não for definido, será gerado automaticamente para operações de inserção e atualização. Aplicável a todos os tipos de criativo.
active boolean Indica se o criativo está ativo. Aplicável a todos os tipos de criativo.
adParameters string São os parâmetros de anúncio usados para o criativo VPAID. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os VPAID.
adTagKeys[] list São as palavras-chave para um criativo rich media. As palavras-chave permitem personalizar as configurações dos criativos de anúncios rich media exibidos no seu site sem ter que entrar em contato com o anunciante. Você pode usar palavras-chave para mudar dinamicamente a aparência ou a funcionalidade de um criativo. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA e todos os VPAID.
additionalSizes[] list São tamanhos adicionais associados a um criativo responsivo. Ao inserir ou atualizar um criativo, é possível usar o campo de ID do tamanho ou os campos de largura e altura. Aplicável a criativos DISPLAY quando o tipo de recurso principal é HTML_IMAGE.
advertiserId long É o ID do anunciante deste criativo. Este campo é obrigatório. Aplicável a todos os tipos de criativo.
allowScriptAccess boolean Indica se o acesso ao script é permitido para este criativo. Este é um campo obsoleto somente leitura que será definido automaticamente como verdadeiro na atualização. Aplicável aos seguintes tipos de criativos: FLASH_INPAGE.
archived boolean Indica se o criativo está arquivado. Aplicável a todos os tipos de criativo.
artworkType string É o tipo de arte usada para o criativo. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA e todos os VPAID.

Estes são os valores aceitáveis:
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
authoringSource string É o aplicativo de origem em que o criativo foi criado. Atualmente, só os criativos gerados pelo DBM terão esse campo definido. Aplicável a todos os tipos de criativo.

Estes são os valores aceitáveis:
  • "CREATIVE_AUTHORING_SOURCE_DBM"
  • "CREATIVE_AUTHORING_SOURCE_DCM"
  • "CREATIVE_AUTHORING_SOURCE_GWD"
  • "CREATIVE_AUTHORING_SOURCE_STUDIO"
authoringTool string É a ferramenta de criação para criativos de banner HTML5. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: HTML5_BANNER.

Estes são os valores aceitáveis:
  • "NINJA"
  • "SWIFFY"
autoAdvanceImages boolean Indica se as imagens são automaticamente avançadas para criativos da galeria de imagens. Aplicável aos seguintes tipos de criativos: DISPLAY_IMAGE_GALLERY.
backgroundColor string É o código de cor HTML de seis caracteres, começando com #, referente ao plano de fundo da área da janela em que o arquivo Flash é exibido. O padrão é branco. Aplicável aos seguintes tipos de criativos: FLASH_INPAGE.
backupImageClickThroughUrl nested object É o URL de clique para a imagem de backup. Aplicável a ENHANCED_BANNER quando o tipo de recurso principal não é HTML_IMAGE.
backupImageClickThroughUrl.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.
backupImageClickThroughUrl.customClickThroughUrl string É o URL de clique personalizado. Aplicável se o campo landingPageId não for definido.
backupImageClickThroughUrl.landingPageId long É o ID da página de destino do URL de clique.
backupImageFeatures[] list É a lista de dependências de recursos que farão com que uma imagem de backup seja veiculada caso o navegador que exibe o anúncio não seja compatível. As dependências são recursos a que um navegador precisa oferecer suporte a fim de renderizar o material do criativo HTML5 corretamente. Inicialmente, esse campo é gerado automaticamente para conter todas as funcionalidades detectadas pelo Campaign Manager para todos os recursos deste criativo. Ele pode ser modificado pelo cliente posteriormente. Para redefinir esse campo, copie todos os recursos detectados do creativeAssets. Aplicável aos seguintes tipos de criativo: HTML5_BANNER. Aplicável a DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.
backupImageReportingLabel string É a etiqueta de relatório usada para a imagem de backup do banner HTML5. Aplicável aos seguintes tipos de criativos: DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.
backupImageTargetWindow nested object É a janela de segmentação para a imagem de backup. Aplicável aos seguintes tipos de criativo: FLASH_INPAGE e HTML5_BANNER. Aplicável a DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.
backupImageTargetWindow.customHtml string É o valor inserido pelo usuário.
backupImageTargetWindow.targetWindowOption string É o tipo de janela do navegador em que a imagem de backup do criativo em Flash pode ser exibida.

Estes são os valores aceitáveis:
  • "CURRENT_WINDOW"
  • "CUSTOM"
  • "NEW_WINDOW"
clickTags[] list São as click tags do criativo. Para criativos DISPLAY, FLASH_INPAGE e HTML5_BANNER, esse é um subconjunto de click tags detectadas para os recursos associados a esse criativo. Depois de criar um material em Flash, as click tags detectadas serão retornadas no creativeAssetMetadata. Ao inserir o criativo, preencha o campo clickTags usando o campo creativeAssetMetadata.clickTags. Para criativos DISPLAY_IMAGE_GALLERY, deve haver exatamente uma entrada nesta lista para cada material do criativo de imagem. Uma click tag combina com um material do criativo quando o campo clickTag.name corresponde ao campo creativeAsset.assetIdentifier.name. Aplicável aos seguintes tipos de criativo: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE e HTML5_BANNER. Aplicável a DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.
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, esse campo precisa corresponder ao valor do campo creativeAssetId.name do material do criativo.
commercialId string É o ID padrão do setor atribuído ao criativo para alcance e frequência. Aplicável a criativos INSTREAM_VIDEO_REDIRECT.
companionCreatives[] list É a lista de criativos complementares atribuídos a um criativo de vídeo in-stream. Os valores aceitáveis incluem IDs de criativos em Flash e de imagem existentes. Aplicável aos seguintes tipos de criativos: todos os VPAID, todos os INSTREAM_AUDIO e todos os INSTREAM_VIDEO com dynamicAssetSelection definido como "falso".
compatibility[] list São as compatibilidades associadas a este criativo. Este é um campo somente leitura. DISPLAY e DISPLAY_INTERSTITIAL referem-se à renderização em computadores, dispositivos móveis ou apps para dispositivos móveis para anúncios normais ou intersticiais, respectivamente. APP e APP_INTERSTITIAL são usados para renderização em apps para dispositivos móveis. Somente criativos preexistentes podem ter essas compatibilidades, já que novos criativos serão atribuídos a DISPLAY ou DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refere-se à renderização de anúncios em vídeo in-stream desenvolvidos com o padrão VAST. IN_STREAM_AUDIO refere-se à renderização de anúncios em áudio in-stream desenvolvidos com o padrão VAST. Aplicável a todos os tipos de criativo.

Os valores aceitáveis são os seguintes:
  • "APP"
  • "APP_INTERSTITIAL"
  • "IN_STREAM_VIDEO"
  • "IN_STREAM_AUDIO"
  • "DISPLAY"
  • "DISPLAY_INTERSTITIAL"
convertFlashToHtml5 boolean Indica se os materiais em Flash associados ao criativo precisam ser convertidos automaticamente em HTML5. Essa sinalização é ativada por padrão, e os usuários podem optar por desativá-la se não quiserem que o sistema gere e use o recurso HTML5 para esse criativo. Aplicável ao seguinte tipo de criativo: FLASH_INPAGE. Aplicável a DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.
counterCustomEvents[] list É a lista de eventos de contador configurados para o criativo. Para criativos DISPLAY_IMAGE_GALLERY, eles são somente leitura e gerados automaticamente a partir de clickTags. Aplicável aos seguintes tipos de criativo: DISPLAY_IMAGE_GALLERY, todos os RICH_MEDIA e todos os VPAID.
counterCustomEvents[].advertiserCustomEventId long É o ID exclusivo desse 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.
creativeAssetSelection nested object Obrigatório se dynamicAssetSelection for verdadeiro.
creativeAssetSelection.defaultAssetId long É um creativeAssets[].id. Isso se refere a um dos recursos pais neste criativo e será veiculado se nenhuma das regras corresponder. Este campo é obrigatório.
creativeAssetSelection.rules[] list As regras determinam qual recurso será veiculado para um espectador. As regras serão avaliadas na ordem em que forem armazenadas nessa lista. Essa lista deve conter pelo menos uma regra. Aplicável a criativos INSTREAM_VIDEO.
creativeAssetSelection.rules[].assetId long É um creativeAssets[].id. Refere-se a um dos recursos pais neste criativo. Este campo é obrigatório.
creativeAssetSelection.rules[].name string É um nome fácil de usar para essa regra. Este campo é obrigatório.
creativeAssetSelection.rules[].targetingTemplateId long É um ID de modelo de segmentação. A segmentação do modelo será usada para determinar se esse recurso deve ser veiculado. Este campo é obrigatório.
creativeAssets[] list São os recursos associados a um criativo. Aplicável a todos os tipos de criativos, exceto os seguintes: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT e REDIRECT.
creativeAssets[].actionScript3 boolean Indica se ActionScript3 está ativado para o material em Flash. Este é um campo somente leitura. Aplicável ao seguinte tipo de criativo: FLASH_INPAGE. Aplicável a DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.
creativeAssets[].active boolean Indica se o recurso de vídeo ou áudio está ativo. Este é um campo somente leitura para recursos VPAID_NON_LINEAR_VIDEO. Aplicável aos seguintes tipos de criativo: INSTREAM_AUDIO, INSTREAM_VIDEO e todos os VPAID.
creativeAssets[].additionalSizes[] list São os tamanhos adicionais associados a este material do criativo. O recurso HTML5 gerado por um software compatível, como o GWD, oferecerá suporte a mais tamanhos que esse material do criativo poderá renderizar.
creativeAssets[].alignment string São os possíveis alinhamentos para um recurso. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.

Estes são os valores aceitáveis:
  • "ALIGNMENT_BOTTOM"
  • "ALIGNMENT_LEFT"
  • "ALIGNMENT_RIGHT"
  • "ALIGNMENT_TOP"
creativeAssets[].artworkType string É o tipo de arte do criativo rich media. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.

Estes são os valores aceitáveis:
  • "ARTWORK_TYPE_FLASH"
  • "ARTWORK_TYPE_HTML5"
  • "ARTWORK_TYPE_IMAGE"
  • "ARTWORK_TYPE_MIXED"
creativeAssets[].assetIdentifier nested object É o identificador desse recurso. Esse é o mesmo identificador retornado durante a operação de inserção do material do criativo. Este campo é obrigatório. Aplicável a todos os tipos de criativos, exceto os seguintes: todos os REDIRECT e TRACKING_TEXT.
creativeAssets[].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.
creativeAssets[].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"
creativeAssets[].audioBitRate integer É a taxa de bits do streaming de áudio em kbps. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: INSTREAM_AUDIO, INSTREAM_VIDEO e todos os VPAID.
creativeAssets[].audioSampleRate integer É a taxa de bits de amostra de áudio em hertz. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: INSTREAM_AUDIO, INSTREAM_VIDEO e todos os VPAID.
creativeAssets[].backupImageExit nested object É o evento de saída configurado para a imagem de backup. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.
creativeAssets[].backupImageExit.advertiserCustomEventId long É o ID exclusivo desse evento usado pela Geração de Relatórios e pela Transferência de dados. Este é um campo somente leitura.
creativeAssets[].backupImageExit.advertiserCustomEventName string É o nome inserido pelo usuário para o evento.
creativeAssets[].backupImageExit.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"
creativeAssets[].backupImageExit.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.
creativeAssets[].backupImageExit.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"
creativeAssets[].backupImageExit.exitClickThroughUrl nested object É o URL de clique de saída do evento. Este campo é usado somente para eventos de saída.
creativeAssets[].backupImageExit.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.
creativeAssets[].backupImageExit.exitClickThroughUrl.customClickThroughUrl string É o URL de clique personalizado. Aplicável se o campo landingPageId não for definido.
creativeAssets[].backupImageExit.exitClickThroughUrl.landingPageId long É o ID da página de destino do URL de clique.
creativeAssets[].backupImageExit.id long É o ID deste evento. Este campo é obrigatório e não pode ser modificado após a inserção.
creativeAssets[].backupImageExit.popupWindowProperties nested object São as propriedades para janelas pop-up rich media. Este campo é usado somente para eventos de saída.
creativeAssets[].backupImageExit.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.
creativeAssets[].backupImageExit.popupWindowProperties.offset nested object São as coordenadas do canto superior esquerdo da janela pop-up. Aplicável se positionType for COORDINATES.
creativeAssets[].backupImageExit.popupWindowProperties.offset.left integer É a distância de deslocamento do lado esquerdo de um recurso ou de uma janela.
creativeAssets[].backupImageExit.popupWindowProperties.offset.top integer É a distância de deslocamento da parte superior de um recurso ou de uma janela.
creativeAssets[].backupImageExit.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"
creativeAssets[].backupImageExit.popupWindowProperties.showAddressBar boolean Indica se a barra de endereço do navegador será exibida.
creativeAssets[].backupImageExit.popupWindowProperties.showMenuBar boolean Indica se a barra de menu do navegador será exibida.
creativeAssets[].backupImageExit.popupWindowProperties.showScrollBar boolean Indica se a barra de rolagem do navegador será exibida.
creativeAssets[].backupImageExit.popupWindowProperties.showStatusBar boolean Indica se a barra de status do navegador será exibida.
creativeAssets[].backupImageExit.popupWindowProperties.showToolBar boolean Indica se a barra de ferramentas do navegador será exibida.
creativeAssets[].backupImageExit.popupWindowProperties.title string É o título da janela pop-up.
creativeAssets[].backupImageExit.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"
creativeAssets[].backupImageExit.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.
creativeAssets[].bitRate integer É a taxa de bits detectada para recursos de áudio ou vídeo. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: INSTREAM_AUDIO, INSTREAM_VIDEO e todos os VPAID.
creativeAssets[].childAssetType string É o tipo de recurso filho de rich media. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os VPAID.

Estes são os valores aceitáveis:
  • "CHILD_ASSET_TYPE_DATA"
  • "CHILD_ASSET_TYPE_FLASH"
  • "CHILD_ASSET_TYPE_IMAGE"
  • "CHILD_ASSET_TYPE_VIDEO"
creativeAssets[].collapsedSize nested object É o tamanho de um recurso quando recolhido. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativos: todos os RICH_MEDIA e todos os VPAID. Além disso, aplicável a recursos cujo displayType seja ASSET_DISPLAY_TYPE_EXPANDING ou ASSET_DISPLAY_TYPE_PEEL_DOWN.
creativeAssets[].companionCreativeIds[] list É a lista de criativos complementares atribuídos a um recurso de criativo em vídeo in-stream. Os valores aceitáveis incluem IDs de criativos em Flash e de imagem existentes. Aplicável ao tipo de criativo INSTREAM_VIDEO com dynamicAssetSelection definido como verdadeiro.
creativeAssets[].customStartTimeValue integer É o horário de início personalizado em segundos para tornar o recurso visível. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA. O valor deve ser maior ou igual a 0.
creativeAssets[].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. Aplicável aos seguintes tipos de criativo: HTML5_BANNER. Aplicável a DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.
creativeAssets[].displayType string É o tipo de recurso rich media. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.

Estes são os valores aceitáveis:
  • "ASSET_DISPLAY_TYPE_BACKDROP"
  • "ASSET_DISPLAY_TYPE_EXPANDING"
  • "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH"
  • "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING"
  • "ASSET_DISPLAY_TYPE_FLOATING"
  • "ASSET_DISPLAY_TYPE_INPAGE"
  • "ASSET_DISPLAY_TYPE_OVERLAY"
  • "ASSET_DISPLAY_TYPE_PEEL_DOWN"
  • "ASSET_DISPLAY_TYPE_VPAID_LINEAR"
  • "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR"
creativeAssets[].duration integer É a duração em segundos da exibição de um recurso. Aplicável aos seguintes tipos de criativo: INSTREAM_AUDIO, INSTREAM_VIDEO e VPAID_LINEAR_VIDEO. O valor deve ser maior ou igual a 1.
creativeAssets[].durationType string É o tipo de duração da exibição de um recurso. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.

Estes são os valores aceitáveis:
  • "ASSET_DURATION_TYPE_AUTO"
  • "ASSET_DURATION_TYPE_CUSTOM"
  • "ASSET_DURATION_TYPE_NONE"
creativeAssets[].expandedDimension nested object É a dimensão expandida detectada para o recurso de vídeo. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: INSTREAM_VIDEO e todos os VPAID.
creativeAssets[].fileSize long É o tamanho do arquivo associado a este material do criativo. Este é um campo somente leitura. Aplicável a todos os tipos de criativos, exceto os seguintes: todos os REDIRECT e TRACKING_TEXT.
creativeAssets[].flashVersion integer É a versão em Flash do recurso. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: FLASH_INPAGE, todos os RICH_MEDIA e todos os VPAID. Aplicável a DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.
creativeAssets[].frameRate float É o frame rate do recurso de vídeo em quadros por segundo. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: INSTREAM_VIDEO e todos os VPAID.
creativeAssets[].hideFlashObjects boolean Indica se a sinalização de objetos Flash para um recurso será oculta. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.
creativeAssets[].hideSelectionBoxes boolean Indica se a sinalização das caixas de seleção para um recurso será oculta. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.
creativeAssets[].horizontallyLocked boolean Indica se o recurso está bloqueado horizontalmente. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.
creativeAssets[].id long É o ID numérico do material do criativo. Este campo é obrigatório e não deve ser modificado. Aplicável a todos os tipos de criativos, exceto os seguintes: todos os REDIRECT e TRACKING_TEXT.
creativeAssets[].idDimensionValue nested object É o valor da dimensão para o ID do recurso. Este é um campo somente leitura gerado automaticamente.
creativeAssets[].mediaDuration float É a duração detectada para o recurso de áudio ou vídeo. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: INSTREAM_AUDIO, INSTREAM_VIDEO e todos os VPAID.
creativeAssets[].mimeType string É o tipo MIME detectado para o recurso de áudio ou vídeo. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: INSTREAM_AUDIO, INSTREAM_VIDEO e todos os VPAID.
creativeAssets[].offset nested object É a posição de deslocamento de um recurso no modo recolhido. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativos: todos os RICH_MEDIA e todos os VPAID. Além disso, aplicável somente a recursos cujo displayType seja ASSET_DISPLAY_TYPE_EXPANDING ou ASSET_DISPLAY_TYPE_PEEL_DOWN.
creativeAssets[].offset.left integer É a distância de deslocamento do lado esquerdo de um recurso ou de uma janela.
creativeAssets[].offset.top integer É a distância de deslocamento da parte superior de um recurso ou de uma janela.
creativeAssets[].orientation string É a orientação do recurso de vídeo. Este é um campo somente leitura gerado automaticamente.

Os valores aceitáveis são os seguintes:
  • "LANDSCAPE"
  • "PORTRAIT"
  • "SQUARE"
creativeAssets[].originalBackup boolean Indica se o recurso de backup é original ou foi mudado pelo usuário no Campaign Manager. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.
creativeAssets[].politeLoad boolean Indica se este recurso é usado como um recurso de carregamento discreto.
creativeAssets[].position nested object É a posição de deslocamento de um recurso. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.
creativeAssets[].position.left integer É a distância de deslocamento do lado esquerdo de um recurso ou de uma janela.
creativeAssets[].position.top integer É a distância de deslocamento da parte superior de um recurso ou de uma janela.
creativeAssets[].positionLeftUnit string É a unidade de deslocamento à esquerda para um recurso. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.

Estes são os valores aceitáveis:
  • "OFFSET_UNIT_PERCENT"
  • "OFFSET_UNIT_PIXEL"
  • "OFFSET_UNIT_PIXEL_FROM_CENTER"
creativeAssets[].positionTopUnit string É o deslocamento da unidade superior de um recurso. Este é um campo somente leitura se o recurso displayType for ASSET_DISPLAY_TYPE_OVERLAY. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.

Estes são os valores aceitáveis:
  • "OFFSET_UNIT_PERCENT"
  • "OFFSET_UNIT_PIXEL"
  • "OFFSET_UNIT_PIXEL_FROM_CENTER"
creativeAssets[].progressiveServingUrl string É o URL progressivo para o recurso de vídeo. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: INSTREAM_VIDEO e todos os VPAID.
creativeAssets[].pushdown boolean Indica se o recurso exerce push-down em outros conteúdos. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA. Além disso, aplicável somente quando os deslocamentos de recursos são 0, o collapsedSize.width corresponde a size.width e o collapsedSize.height é menor que size.height.
creativeAssets[].pushdownDuration float É a duração do push-down em segundos para um recurso. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA. Além disso, aplicável somente quando o campo push-down do recurso é verdadeiro, os deslocamentos são 0, o collapsedSize.width corresponde a size.width, e o collapsedSize.height é menor que size.height. Os valores aceitáveis são de 0 a 9.99, inclusive.
creativeAssets[].role string É a função do recurso em relação ao criativo. Aplicável a todos os tipos de criativos, exceto os seguintes: todos os REDIRECT e TRACKING_TEXT. Este campo é obrigatório.

PRIMARY aplica-se a DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, todos os RICH_MEDIA (que podem conter vários recursos principais) e todos os criativos VPAID.

BACKUP_IMAGE se aplica a FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA e todos os criativos VPAID. Aplicável a DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.

ADDITIONAL_IMAGE e ADDITIONAL_FLASH se aplicam a criativos FLASH_INPAGE.

OTHER refere-se a recursos de origens diferentes do Campaign Manager, como recursos enviados pelo Studio, aplicáveis a todos os criativos RICH_MEDIA e VPAID.

PARENT_VIDEO refere-se a vídeos enviados pelo usuário no Campaign Manager e se aplica aos criativos INSTREAM_VIDEO e VPAID_LINEAR_VIDEO.

TRANSCODED_VIDEO refere-se a vídeos transcodificados pelo Campaign Manager a partir de recursos PARENT_VIDEO e é aplicável a criativos INSTREAM_VIDEO e VPAID_LINEAR_VIDEO.

ALTERNATE_VIDEO refere-se à representação do Campaign Manager de vídeos de recursos filhos do Studio e é aplicável a criativos VPAID_LINEAR_VIDEO. Eles não podem ser adicionados nem removidos no Campaign Manager.

Para criativos VPAID_LINEAR_VIDEO, recursos PARENT_VIDEO, TRANSCODED_VIDEO e ALTERNATE_VIDEO marcados como active servem como backup, caso o criativo VPAID não possa ser veiculado. Somente recursos PARENT_VIDEO podem ser adicionados ou removidos de um criativo INSTREAM_VIDEO ou VPAID_LINEAR_VIDEO.

PARENT_AUDIO refere-se aos áudios enviados pelo usuário no Campaign Manager e se aplica a criativos INSTREAM_AUDIO.

TRANSCODED_AUDIO refere-se a áudios transcodificados pelo Campaign Manager a partir de recursos PARENT_AUDIO e é aplicável a criativos INSTREAM_AUDIO.



Estes são os valores aceitáveis:
  • "ADDITIONAL_FLASH"
  • "ADDITIONAL_IMAGE"
  • "ALTERNATE_VIDEO"
  • "BACKUP_IMAGE"
  • "OTHER"
  • "PARENT_AUDIO"
  • "PARENT_VIDEO"
  • "PRIMARY"
  • "TRANSCODED_AUDIO"
  • "TRANSCODED_VIDEO"
creativeAssets[].size nested object É o tamanho associado a este recurso do criativo. Este é um campo obrigatório quando aplicável. No entanto, para criativos IMAGE e FLASH_INPAGE, se deixados em branco, esse campo será definido automaticamente usando o tamanho real do recurso de imagem associado. Aplicável aos seguintes tipos de criativos: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE e todos os RICH_MEDIA. Aplicável a DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.
creativeAssets[].sslCompliant boolean Indica se o recurso é compatível com SSL. Este é um campo somente leitura. Aplicável a todos os tipos de criativos, exceto os seguintes: todos os REDIRECT e TRACKING_TEXT.
creativeAssets[].startTimeType string É o tipo de tempo de espera inicial antes de tornar o recurso visível. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.

Estes são os valores aceitáveis:
  • "ASSET_START_TIME_TYPE_CUSTOM"
  • "ASSET_START_TIME_TYPE_NONE"
creativeAssets[].streamingServingUrl string É o URL de streaming para um recurso de vídeo. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: INSTREAM_VIDEO e todos os VPAID.
creativeAssets[].transparency boolean Indica se o recurso é transparente. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA. Além disso, só se aplica a recursos HTML5.
creativeAssets[].verticallyLocked boolean Indica se o recurso está bloqueado verticalmente. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.
creativeAssets[].windowMode string São as opções do modo de janela para materiais em Flash. Aplicável aos seguintes tipos de criativo: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER e RICH_MEDIA_INPAGE_FLOATING.

Estes são os valores aceitáveis:
  • "OPAQUE"
  • "TRANSPARENT"
  • "WINDOW"
creativeAssets[].zIndex integer É o valor Z-index de um recurso. Aplicável aos seguintes tipos de criativos: todos os RICH_MEDIA. Além disso, aplicável somente a recursos em que displayType NÃO É um dos seguintes tipos: ASSET_DISPLAY_TYPE_INPAGE ou ASSET_DISPLAY_TYPE_OVERLAY. Os valores aceitáveis são de -999999999 a 999999999, inclusive.
creativeAssets[].zipFilename string É o nome do arquivo ZIP. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: HTML5_BANNER.
creativeAssets[].zipFilesize string É o tamanho do arquivo ZIP. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: HTML5_BANNER.
creativeFieldAssignments[] list São as atribuições do campo do criativo para este criativo. Aplicável a todos os tipos de criativo.
creativeFieldAssignments[].creativeFieldId long É o ID do campo do criativo.
creativeFieldAssignments[].creativeFieldValueId long É o ID do valor do campo do criativo.
customKeyValues[] list São as chaves-valor personalizadas para um criativo rich media. As chaves-valor permitem personalizar as configurações dos criativos de anúncios rich media exibidos no seu site sem ter que entrar em contato com o anunciante. Você pode usar chaves-valor para mudar dinamicamente a aparência ou a funcionalidade de um criativo. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA e todos os VPAID.
dynamicAssetSelection boolean Defina como verdadeiro para permitir o uso de regras e segmentar recursos individuais nesse criativo. Quando definido como verdadeiro, creativeAssetSelection precisa ser definido. Isso também controla os complementares no nível do recurso. Quando definido como verdadeiro, os criativos complementares devem ser atribuídos aos materiais do criativo. Saiba mais Aplicável a criativos INSTREAM_VIDEO.
exitCustomEvents[] list É a lista de eventos de saída configurados para o criativo. Para criativos DISPLAY e DISPLAY_IMAGE_GALLERY, eles são somente leitura e gerados automaticamente a partir de clickTags. Para DISPLAY, um evento também é criado a partir do backupImageReportingLabel. Aplicável aos seguintes tipos de criativo: DISPLAY_IMAGE_GALLERY, todos os RICH_MEDIA e todos os VPAID. Aplicável a DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.
exitCustomEvents[].advertiserCustomEventId long É o ID exclusivo desse 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.
fsCommand nested object É o OpenWindow FSCommand deste criativo. Isso permite que o arquivo SWF se comunique com o Flash Player ou com o programa que hospeda o Flash Player, como um navegador da Web. Isso só será acionado se o campo allowScriptAccess for verdadeiro. Aplicável aos seguintes tipos de criativos: FLASH_INPAGE.
fsCommand.left integer É a distância a partir da esquerda do navegador. Aplicável quando positionOption é DISTANCE_FROM_TOP_LEFT_CORNER.
fsCommand.positionOption string É a posição no navegador onde a janela será aberta.

Estes são os valores aceitáveis:
  • "CENTERED"
  • "DISTANCE_FROM_TOP_LEFT_CORNER"
fsCommand.top integer É a distância da parte superior do navegador. Aplicável quando positionOption é DISTANCE_FROM_TOP_LEFT_CORNER.
fsCommand.windowHeight integer É a altura da janela.
fsCommand.windowWidth integer É a largura da janela.
htmlCode string É o código HTML do criativo. Este é um campo obrigatório quando aplicável. Este campo será ignorado se htmlCodeLocked for verdadeiro. Aplicável aos seguintes tipos de criativo: todos os CUSTOM, FLASH_INPAGE e HTML5_BANNER e todos os RICH_MEDIA.
htmlCodeLocked boolean Indica se o código HTML é gerado pelo Campaign Manager ou inserido manualmente. Defina como verdadeiro para ignorar mudanças em htmlCode. Aplicável aos seguintes tipos de criativo: FLASH_INPAGE e HTML5_BANNER.
id long É o ID deste criativo. Este é um campo somente leitura gerado automaticamente. Aplicável a todos os tipos de criativo.
idDimensionValue nested object É o valor da dimensão para o ID deste criativo. Este é um campo somente leitura. Aplicável a todos os tipos de criativo.
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#creative".
lastModifiedInfo nested object São as informações da última modificação do criativo. Este é um campo somente leitura. Aplicável a todos os tipos de criativo.
lastModifiedInfo.time long É o carimbo de data/hora da última mudança em milissegundos desde a época.
latestTraffickedCreativeId long É o ID do criativo programado no Studio mais recente associado a criativos Rich Media e VPAID. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA e todos os VPAID.
mediaDescription string É a descrição do anúncio em áudio ou vídeo. Aplicável aos seguintes tipos de criativo: todos os INSTREAM_VIDEO, INSTREAM_AUDIO e todos os VPAID.
mediaDuration float É a duração do áudio ou do vídeo do criativo em segundos. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: INSTREAM_VIDEO, INSTREAM_AUDIO, todos os RICH_MEDIA e todos os VPAID.
name string É o nome do criativo. Este campo é obrigatório e deve ter menos de 256 caracteres. Aplicável a todos os tipos de criativo.
obaIcon nested object É o ícone de publicidade comportamental on-line a ser adicionado ao criativo. Aplicável aos seguintes tipos de criativo: todos os INSTREAM_VIDEO.
obaIcon.iconClickThroughUrl string É o URL a ser redirecionado quando um ícone da OBA é clicado.
obaIcon.iconClickTrackingUrl string É o URL para rastrear o clique quando um ícone da OBA é clicado.
obaIcon.iconViewTrackingUrl string É o URL para rastrear a visualização quando um ícone da OBA é clicado.
obaIcon.program string Identifica a iniciativa industrial com que o ícone tem compatibilidade. Por exemplo, Opções de anúncios.
obaIcon.resourceUrl string É o URL do recurso do ícone da OBA. O Campaign Manager só é compatível com ícones de imagem e JavaScript. Saiba mais
obaIcon.size nested object É o tamanho do ícone da OBA.
obaIcon.xPosition string É a posição da coordenada x do ícone da OBA. Os valores aceitos são "left" (esquerda) ou "right" (direita).
obaIcon.yPosition string É a posição da coordenada y do ícone da OBA. Os valores aceitos são superior ou inferior.
overrideCss string É o valor do CSS de substituição para criativos rich media. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.
progressOffset nested object Indica por quanto tempo o vídeo é reproduzido antes de contar uma visualização. Aplicável aos seguintes tipos de criativo: todos os INSTREAM_VIDEO.
progressOffset.offsetPercentage integer É a duração, como uma porcentagem da duração do vídeo. Não defina quando offsetSeconds estiver definido. Os valores aceitáveis são de 0 a 100, inclusive.
progressOffset.offsetSeconds integer É a duração em segundos. Não defina quando offsetPercentage estiver definido. Os valores aceitáveis são de 0 a 86399, inclusive.
redirectUrl string É o URL da imagem hospedada, do vídeo hospedado ou de outra tag de anúncio. Para criativos INSTREAM_VIDEO_REDIRECT, este é o URL de redirecionamento do vídeo in-stream. O padrão para uma resposta de anúncio VAST (Modelo de veiculação de anúncio em vídeo) permite que um redirecionamento seja vinculado a outra chamada VAST 2.0 ou 3.0. Este é um campo obrigatório quando aplicável. Aplicável aos seguintes tipos de criativos: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT e INSTREAM_VIDEO_REDIRECT
renderingId long É o ID da versão de renderização atual. Este é um campo somente leitura. Aplicável a todos os tipos de criativo.
renderingIdDimensionValue nested object É o valor da dimensão do ID de renderização deste criativo. Este é um campo somente leitura. Aplicável a todos os tipos de criativo.
requiredFlashPluginVersion string É a versão mínima do plug-in de Flash necessária para este criativo. Exemplo: 11.2.202.235. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA e todos os VPAID.
requiredFlashVersion integer É a versão interna do Flash para este criativo, conforme calculada pelo Studio. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: FLASH_INPAGE, todos os RICH_MEDIA e todos os VPAID. Aplicável a DISPLAY quando o tipo de recurso principal não é HTML_IMAGE.
size nested object É o tamanho associado a este criativo. Ao inserir ou atualizar um criativo, é possível usar o campo de ID do tamanho ou os campos de largura e altura. Este campo é obrigatório quando aplicável. No entanto, para IMAGE, criativos FLASH_INPAGE e para criativos DISPLAY com um recurso principal do tipo HTML_IMAGE, se esse campo for deixado em branco, ele será definido automaticamente usando o tamanho real dos recursos de imagem associados. Aplicável aos seguintes tipos de criativo: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE e todos os RICH_MEDIA.
skipOffset nested object Indica por quanto tempo o vídeo será reproduzido antes de o botão "Pular" ser exibido. Aplicável aos seguintes tipos de criativo: todos os INSTREAM_VIDEO.
skipOffset.offsetPercentage integer É a duração, como uma porcentagem da duração do vídeo. Não defina quando offsetSeconds estiver definido. Os valores aceitáveis são de 0 a 100, inclusive.
skipOffset.offsetSeconds integer É a duração em segundos. Não defina quando offsetPercentage estiver definido. Os valores aceitáveis são de 0 a 86399, inclusive.
skippable boolean Indica se o usuário pode pular o criativo. Aplicável aos seguintes tipos de criativos: todos os INSTREAM_VIDEO e todos os VPAID.
sslCompliant boolean Indica se o criativo é compatível com SSL. Este é um campo somente leitura. Aplicável a todos os tipos de criativo.
sslOverride boolean Indica se o criativo deve ser tratado como compatível com SSL, mesmo que a verificação do sistema mostre que não é. Aplicável a todos os tipos de criativo.
studioAdvertiserId long É o ID do anunciante do Studio associado aos criativos VPAID e rich media. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA e todos os VPAID.
studioCreativeId long É o ID do criativo do Studio associado a criativos rich media e VPAID. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA e todos os VPAID.
studioTraffickedCreativeId long É o ID do criativo programado pelo Studio associado a criativos rich media e VPAID. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA e todos os VPAID.
subaccountId long É o ID da subconta deste criativo. Este campo, se não for definido, será gerado automaticamente para operações de inserção e atualização. Aplicável a todos os tipos de criativo.
thirdPartyBackupImageImpressionsUrl string É o URL de terceiros usado para registrar impressões de imagem de backup. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.
thirdPartyRichMediaImpressionsUrl string É o URL de terceiros usado para registrar impressões de rich media. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA.
thirdPartyUrls[] list São os URLs de terceiros para rastrear eventos dos criativos in-stream. Aplicável aos seguintes tipos de criativo: todos os INSTREAM_VIDEO, INSTREAM_AUDIO e VPAID.
thirdPartyUrls[].thirdPartyUrlType string É o tipo de URL de terceiros para criativos de vídeo e áudio in-stream.

Estes são os valores aceitáveis:
  • "CLICK_TRACKING"
  • "IMPRESSION"
  • "RICH_MEDIA_BACKUP_IMPRESSION"
  • "RICH_MEDIA_IMPRESSION"
  • "RICH_MEDIA_RM_IMPRESSION"
  • "SURVEY"
  • "VIDEO_COMPLETE"
  • "VIDEO_CUSTOM"
  • "VIDEO_FIRST_QUARTILE"
  • "VIDEO_FULLSCREEN"
  • "VIDEO_MIDPOINT"
  • "VIDEO_MUTE"
  • "VIDEO_PAUSE"
  • "VIDEO_PROGRESS"
  • "VIDEO_REWIND"
  • "VIDEO_SKIP"
  • "VIDEO_START"
  • "VIDEO_STOP"
  • "VIDEO_THIRD_QUARTILE"
thirdPartyUrls[].url string É o URL para o tipo de URL de terceiros especificado.
timerCustomEvents[] list É a lista de eventos de timer configurados para o criativo. Para criativos DISPLAY_IMAGE_GALLERY, eles são somente leitura e gerados automaticamente a partir de clickTags. Aplicável aos seguintes tipos de criativo: DISPLAY_IMAGE_GALLERY, todos os RICH_MEDIA e todos os VPAID. Aplicável a DISPLAY quando o recurso principal não é HTML_IMAGE.
timerCustomEvents[].advertiserCustomEventId long É o ID exclusivo desse 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.
totalFileSize long É o tamanho combinado de todos os materiais do criativo. Este é um campo somente leitura. Aplicável aos seguintes tipos de criativo: todos os RICH_MEDIA e todos os VPAID.
type string É o tipo deste criativo. Este campo é obrigatório. Aplicável a todos os tipos de criativo.

Observação: FLASH_INPAGE, HTML5_BANNER e IMAGE são usados somente com criativos existentes. Os novos criativos usarão DISPLAY como substituto desses tipos.

Os valores aceitáveis são os seguintes:
  • "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO"
  • "CUSTOM_DISPLAY"
  • "CUSTOM_DISPLAY_INTERSTITIAL"
  • "DISPLAY"
  • "DISPLAY_IMAGE_GALLERY"
  • "DISPLAY_REDIRECT"
  • "FLASH_INPAGE"
  • "HTML5_BANNER"
  • "IMAGE"
  • "INSTREAM_AUDIO"
  • "INSTREAM_VIDEO"
  • "INSTREAM_VIDEO_REDIRECT"
  • "INTERNAL_REDIRECT"
  • "INTERSTITIAL_INTERNAL_REDIRECT"
  • "RICH_MEDIA_DISPLAY_BANNER"
  • "RICH_MEDIA_DISPLAY_EXPANDING"
  • "RICH_MEDIA_DISPLAY_INTERSTITIAL"
  • "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL"
  • "RICH_MEDIA_IM_EXPAND"
  • "RICH_MEDIA_INPAGE_FLOATING"
  • "RICH_MEDIA_MOBILE_IN_APP"
  • "RICH_MEDIA_PEEL_DOWN"
  • "TRACKING_TEXT"
  • "VPAID_LINEAR_VIDEO"
  • "VPAID_NON_LINEAR_VIDEO"
universalAdId nested object É um ID universal do anúncio de acordo com a especificação VAST 4.0. Aplicável aos seguintes tipos de criativo: INSTREAM_AUDIO, INSTREAM_VIDEO e VPAID.
universalAdId.registry string É o registro usado para o valor do ID do anúncio.

Estes são os valores aceitáveis:
  • "AD_ID.ORG"
  • "CLEARCAST"
  • "DCM"
  • "OTHER"
universalAdId.value string É o valor de ID deste criativo. Somente caracteres alfanuméricos e os seguintes símbolos são válidos: "_/\-". O tamanho máximo é de 64 caracteres. Somente leitura quando registry for DCM.
version integer O número da versão ajuda você a manter o controle das diversas versões de seu criativo nos relatórios. O número da versão sempre será gerado automaticamente durante as operações de inserção para iniciar em 1. Para criativos de rastreamento, a versão não pode ser incrementada e permanecerá sempre em 1. Para todos os outros tipos de criativos, a versão só pode ser incrementada em 1 durante as operações de atualização. Além disso, a versão será incrementada automaticamente em 1 durante a integração de criativos rich media. Aplicável a todos os tipos de criativo.

Métodos

get
Recebe um criativo por ID.
insert
Insere um novo criativo.
list
Recupera uma lista de criativos, possivelmente filtrada. Esse método é compatível com paginação.
patch
Atualiza um criativo existente. Esse método é compatível com a semântica de patch.
update
Atualiza um criativo existente.