Esquema e propriedades de acompanhamento de anúncios do lado do cliente

Com o recurso de rastreamento de anúncios MediaTailor do lado do cliente, você pode integrar dados detalhados de rastreamento de anúncios do lado do cliente ao seu ambiente de player. As seções a seguir abordam o esquema geral de acompanhamento de anúncios, bem como as propriedades e valores específicos que compõem o esquema.

Schema

A estrutura JSON a seguir mostra o esquema de acompanhamento de anúncios do MediaTailor lado do cliente. Essa representação ilustra a estrutura de aninhamento do esquema para ajudá-lo a entender as relações entre as diferentes partes.

Para obter informações detalhadas sobre cada propriedade, consultePropriedades.


{
  "avails": [
    {
      "ads": [
        {
          "adID": "string",
          "adParameters": "string",
          "adSystem": "string",
          "adTitle": "string",
          "adVerifications": [
            {
              "executableResource": [
                {
                  "apiFramework": "string",
                  "type": "string",
                  "uri": "string",
                  "language": "string"
                }
              ],
              "javaScriptResource": [
                {
                  "apiFramework": "string",
                  "browserOptional": "string",
                  "uri": "string"
                }
              ],
              "trackingEvents": [
                {
                  "event": "string",
                  "uri": "string"
                }
              ],
              "vendor": "string",
              "verificationParameters": "string"
            }
          ],
          "companionAds": [
            {
              "adParameters": "string",
              "altText": "string",
              "attributes": {
                "adSlotId": "string",
                "apiFramework": "string",
                "assetHeight": "string",
                "assetWidth": "string",
                "expandedHeight": "string",
                "expandedWidth": "string",
                "height": "string",
                "id": "string",
                "pxratio": "string",
                "renderingMode": "string",
                "width": "string"
              },
              "companionClickThrough": "string",
              "companionClickTracking": "string",
              "htmlResource": "string",
              "iFrameResource": "string",
              "sequence": "string",
              "staticResource": "string",
              "trackingEvents": [
                {
                  "event": "string",
                  "uri": "string"
                }
              ]
            }
          ],
          "creativeId": "string",
          "creativeSequence": "string",
          "duration": "string",
          "durationInSeconds": number,
          "extensions": [
            {
              "type": "string",
              "content": "string"
            }
          ],
          "icons": [
            {
              "attributes": {
                "apiFramework": "string",
                "duration": "string",
                "height": "string",
                "offset": "string",
                "program": "string",
                "pxratio": "string",
                "width": "string",
                "xPosition": "string",
                "yPosition": "string"
              },
              "htmlResource": "string",
              "iconClicks": {
                "iconClickThrough": "string",
                "iconClickTracking": {
                  "id": "string"
                },
                "iconClickFallbackImages": [
                  {
                    "altText": "string",
                    "height": "string",
                    "width": "string",
                    "staticResource": {
                      "creativeType": "string",
                      "uri": "string"
                    }
                  }
                ]
              },
              "iconViewTracking": "string",
              "iFrameResource": "string",
              "staticResource": {
                "creativeType": "string",
                "uri": "string"
              }
            }
          ],
          "mediaFiles": {
            "adParameters": "string",
            "duration": "string",
            "durationInSeconds": number,
            "mediaFilesList": [
              {
                "apiFramework": "string",
                "delivery": "string",
                "height": "string",
                "maintainAspectRatio": "string",
                "mediaFileUri": "string",
                "mediaType": "string",
                "scalable": "string",
                "width": "string",
                "bitrate": "string"
              }
            ],
            "mezzanine": "string",
            "startTime": "string",
            "startTimeInSeconds": number,
            "trackingEvents": [
              {
                "beaconUrls": ["string"],
                "duration": "string",
                "durationInSeconds": number,
                "dateTime": "string",
                "eventId": "string",
                "eventType": "string",
                "startTime": "string",
                "startTimeInSeconds": number
              }
            ]
          },
          "startTime": "string",
          "startTimeInSeconds": number,
          "dateTime": "string",
          "adBreakTrackingEvents": [...],
          "vastAdId": "string"
        }
      ],
      "adType": "string",
      "availID": "string",
      "duration": "string",
      "durationInSeconds": number,
      "startTime": "string",
      "startTimeInSeconds": number,
      "dateTime": "string",
      "adMarkerDuration": "string",
      "adProgramDateTime": "string",
      "dashAvailabilityStartTime": "string",
      "hlsAnchorMediaSequenceNumber": "string"
    }
  ],
  "nonLinearAvails": [
    {
      "nonLinearAds": [...],
      "nonLinearAdsList": [...]
    }
  ],
  "nextToken": "string",
  "meta": {}
}

Propriedades

A tabela a seguir lista as propriedades da API de rastreamento do lado do cliente, suas definições, tipos de valor e exemplos.

Propriedade	Definição	Tipo de valor	Exemplo
`adID`	HLS - o número de sequência associado ao início do anúncio DASH - o ID do período do anúncio Caminho: `/avails/ads/adId` Mapeamento VAST: Nenhum	String	`10`
`adBreakTrackingEvents`	Uma matriz que transporta eventos de rastreamento do VMAP da resposta VAST. Para obter mais informações, consulte a seção 2.3.3 da especificação VMAP 1.0. Caminho: `/avails/ads/adBreakTrackingEvents`	Array	`[]`
`adMarkerDuration`	A duração do aproveitamento observada no marcador do anúncio no manifesto.	String	`30`
`adParameters`	Uma sequência de parâmetros de anúncio, do VAST VPAID, que MediaTailor passa para o player. Caminho: `/avails/ads/adParameters` Mapeamento VAST: `VAST/Ad/InLine/Creatives/Creative/Linear/AdParameters`	String
`adProgramDateTime`	HLS — a data, no formato ISO/IEC 8601:2004, que representa a primeira sequência de mídia do anúncio. DASH - [Não especificado]	String
`ads`	Uma matriz contendo os objetos do anúncio que compõem o item. Os anúncios são listados na ordem em que aparecem no manifesto. Caminho: `/avails/ads`	Array	`[]`
`adSystem`	O nome do sistema que veicula o anúncio. Importante Certifique-se de fornecer um valor. Se você não fornecer um valor, podem surgir problemas.	String	`myADS`
`adTitle`	O título do anúncio.	String	`ad1`
`adVerifications`	Contém os recursos e os metadados necessários para executar o código de medição de terceiros a fim de verificar a reprodução criativa. Para obter mais informações sobre essa propriedade, consulte a seção 3.16 da especificação VAST 4.2. MediaTailor suporta `adVerifications` como VAST 3 nós de extensão. Caminho: `/avails/ads/adVerifications` Mapeamento VAST: `VAST/Ad/InLine/AdVerifications`	Array	`[]`
`altText`	O texto alternativo para a imagem de um anúncio complementar. Este texto permite que jogadores com suporte de áudio descritivo para deficientes visuais leiam uma descrição da imagem. Caminho: `/avails/ads/companionAds/altText`	String	`video sequence advertising sneakers`
`apiFramework`	Defina como `VPAID` para informar ao jogador que esse anúncio é um anúncio VPAID. Pode aparecer em vários locais no esquema.	String	`VPAID`
`availID`	HLS - o número de sequência associado ao início da disponibilidade do anúncio. DASH - o ID do período de disponibilidade do anúncio, que geralmente é o ID do período do conteúdo que deve ser substituído por um anúncio. Caminho: `/avails/availID`	String	`34` `PT34S_1`
`avails`	Uma matriz contendo objetos ad-break, ou avails, que são apresentados na janela ativa do manifesto. Os itens são listados na ordem em que aparecem no manifesto. Caminho: `/avails`	Array	`[]`
`adType`	O tipo do anúncio. Caminho: `/avails/adType` e `/avails/ads/adType`	String
`dateTime`	Programe a data e hora, no formato ISO 8601 segundos, para o início da disponibilidade do anúncio ou anúncio. Caminho: `/avails/dateTime` e `/avails/ads/dateTime`	String
`duration`	Duração, no formato ISO 8601 segundos. A resposta inclui durações para toda a disponibilidade do anúncio e para cada anúncio e beacon, embora as durações dos beacons sejam sempre zero. Caminho: `/avails/duration` e `/avails/ads/duration`	String	`15.015`
`durationInSeconds`	Duração, em formato de segundos. Caminho: `/avails/durationInSeconds` e `/avails/ads/durationInSeconds`	Número
`extensions`	Extensões personalizadas do VAST que os servidores de anúncios usam. Para obter mais informações sobre extensões, consulte a seção 3.18 da especificação VAST 4.2. Caminho: `/avails/ads/extensions` Mapeamento VAST: `VAST/Ad/InLine/Extensions`	Array	`[]`
`icons`	Elementos de ícone para o anúncio. Caminho: `/avails/ads/icons` Mapeamento VAST: `VAST/Ad/InLine/Creatives/Creative/Linear/Icons`	Array
`mediaFiles`	Vídeo e outros recursos de que o player precisa para que o anúncio seja disponibilizado. Caminho: `/avails/ads/mediaFiles`	Objeto
`nonLinearAvails`	Matriz de objetos não lineares e disponíveis. Caminho: `/nonLinearAvails`	Array
`executableResource`	Recursos executáveis para verificação. Caminho: `/avails/ads/adVerifications/executableResource` Mapeamento VAST: `VAST/Ad/InLine/AdVerifications/Verification/ExecutableResource`	Array
`javaScriptResource`	JavaScript recursos para verificação. Caminho: `/avails/ads/adVerifications/javaScriptResource` Mapeamento VAST: `VAST/Ad/InLine/AdVerifications/Verification/JavaScriptResource`	Array
`trackingEvents`	Rastreamento de eventos para verificação ou anúncios complementares. Caminho: `/avails/ads/adVerifications/trackingEvents` ou `/avails/ads/companionAds/trackingEvents`	Array
`vendor`	Fornecedor de verificação. Caminho: `/avails/ads/adVerifications/vendor` Mapeamento VAST: `VAST/Ad/InLine/AdVerifications/Verification/@vendor`	String
`uri`	URI que aponta para um ativo executável, um ativo de vídeo ou um endpoint de rastreamento. Caminho: vários locais no esquema Mapeamento VAST: vários elementos CDATA no VAST	String	`https://tracking.example.com/impression`
`verificationParameters`	Parâmetros de verificação. Caminho: `/avails/ads/adVerifications/verificationParameters` Mapeamento VAST: `VAST/Ad/InLine/AdVerifications/Verification/VerificationParameters`	String
`attributes`	Atributos de anúncios complementares, como dimensões e modo de renderização. Caminho: `/avails/ads/companionAds/attributes`	Objeto
`companionClickThrough`	Um URL para a página do anunciante que o media player abre quando o espectador clica no anúncio complementar. Caminho: `/avails/ads/companionAds/companionClickThrough` Mapeamento VAST: `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickThrough`	String	`https://aws.amazon.com/`
`companionClickTracking`	O URL de rastreamento da `companionClickThrough` propriedade. Caminho: `/avails/ads/companionAds/companionClickTracking` Mapeamento VAST: `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/CompanionClickTracking`	String	`https://myads.com/beaconing/event=clicktracking`
`htmlResource`	O HTML codificado em CDATA que é inserido diretamente na página HTML do provedor de streaming. Caminho: `/avails/ads/companionAds/htmlResource` Mapeamento VAST: `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/HTMLResource`	String	`<![CDATA[<!doctype html><html><head><meta name=\"viewport\" content=\"width=1, initial-scale=1.0, minimum-scale=1.0,...]]>`
`iFrameResource`	O URL de um arquivo de recurso HTML que o provedor de streaming carrega em um iframe. Caminho: `/avails/ads/companionAds/iFrameResource` Mapeamento VAST: `VAST/Ad/InLine/Creatives/Creative/CompanionAds/Companion/iFrameResource`	String
`sequence`	O valor da sequência especificado para o criativo na resposta VAST. Caminho: `/avails/ads/companionAds/sequence`	String	`1`
`startTime`	A posição da hora, no formato ISO 8601 segundos. Para o HLS, isso é relativo ao início da sessão de reprodução. Para o DASH, isso é relativo ao AST (Hora de Início da Disponibilidade) do manifesto. A resposta inclui horários de início de toda a disponibilidade de anúncios e de cada anúncio e beacon. Caminho: `/avails/startTime` e `/avails/ads/startTime`	String	`PT18.581355S`
`startTimeInSeconds`	A posição da hora, em formato de segundos. Para o HLS, isso é relativo ao início da sessão de reprodução. Para o DASH, isso é relativo ao AST (Hora de Início da Disponibilidade) do manifesto. A resposta inclui horários de início de toda a disponibilidade de anúncios e de cada anúncio e beacon. Caminho: `/avails/startTimeInSeconds` e `/avails/ads/startTimeInSeconds`	Número	`18.581`
`eventId`	HLS - o número de sequência associado ao farol. DASH - o `ptsTime` do início do anúncio.	String
`event`	O nome do evento de rastreamento. Caminho: `/avails/ads/adVerifications/trackingEvents/event` ou `/avails/ads/companionAds/trackingEvents/event`	String	`impression`, `start`, `firstQuartile`, `midpoint`, `thirdQuartile`, `complete`
`beaconUrls`	O URL para o qual MediaTailor envia o sinalizador de anúncios. Caminho: `/avails/ads/mediaFiles/trackingEvents/beaconUrls`	Array
`bitrate`	A taxa de bits do ativo de vídeo. Essa propriedade normalmente não é incluída em um ativo executável.	String	`2048`
`companionAds`	Uma ou mais especificações complementares de conteúdo publicitário, cada uma das quais especifica um arquivo de recurso a ser usado. Os anúncios complementares acompanham a disponibilidade do anúncio e fornecem conteúdo, como uma moldura ao redor do anúncio ou um banner, para exibição próximo ao vídeo. Caminho: `/avails/ads/companionAds`	Array	`[]`
`creativeId`	O valor do `Id` atributo da `Creative` tag do anúncio.	String	`creative-1`
`creativeSequence`	A sequência na qual um anúncio deve ser reproduzido, de acordo com o `Ad@id` valor na resposta VAST.	String	`1`
`dashAvailabilityStartTime`	Para o live/dynamic DASH, o manifesto `MPD@availabilityStartTime` da origem.	String	`2022-10-05T19:38:39.263Z`
`delivery`	Indica se um `streaming` protocolo `progressive` ou está sendo usado.	String	`progressive`
`eventType`	O tipo de farol. Caminho: `/avails/ads/mediaFiles/trackingEvents/eventType`	String	`impression`
`height`	A altura, em pixels, do ativo de vídeo.	String	`360`
`hlsAnchorMediaSequenceNumber`	O número da sequência de mídia da sequência de first/oldest mídia vista no manifesto de origem do HLS.	String	`77`
`maintainAspectRatio`	Indica se a proporção do vídeo deve ser mantida durante o dimensionamento.	Booleano	`true`
`mediaFilesList`	Especifica o vídeo e outros recursos de que o player precisa para que o anúncio seja disponibilizado. Caminho: `/avails/ads/mediaFiles/mediaFilesList`	Array	`[]`
`mediaFileUri`	URI que aponta para um ativo executável ou um ativo de vídeo.	String	`https://myad.com/ad/ad134/vpaid.js`
`mediaType`	O tipo MIME do ativo criativo ou complementar.	String	`video/mp4`
`meta`	Metadados adicionais para o anúncio.	Objeto
`mezzanine`	O URL do MP4 ativo mezanino, especificado se o anúncio VPAID incluir um. Caminho: `/avails/ads/mediaFiles/mezzanine`	String	`https://gcdn.2mdn.net/videoplayback/id/itag/ck2/file/file.mp4`
`nextToken`	O valor do token que aponta para a próxima página de resultados, quando esse valor existe.	String	`UFQzOS44NzNTXzIwMjMtMDctMzFUMTY6NTA6MDYuMzUwNjI2ODQ1Wl8x`
`nonLinearAds`	Anúncios não lineares que aparecem ao lado do conteúdo do vídeo.	Array	`[]`
`nonLinearAdsList`	Lista de anúncios não lineares.	Array	`[]`
`scalable`	Indica se o vídeo deve ser dimensionado para outras dimensões.	Booleano	`true`
`skipOffset`	O valor do tempo que identifica quando o jogador disponibiliza os controles de salto para o usuário.	String	`00:00:05`
`staticResource`	O URL de um arquivo criativo estático usado para o componente de anúncio. Caminho: `/avails/ads/companionAds/staticResource`	String	`https://very-interactive-ads.com/campaign1/file.json?c=1019113602`
`vastAdId`	O valor do `Id` atributo da `Ad` tag.	String	`ad1`
`width`	A largura, em pixels, do ativo de vídeo.	String	`640`
`xPosition`	A posição horizontal de um ícone dentro do player de vídeo. Pode ser um valor de pixel específico ou uma posição como “esquerda” ou “direita”. Caminho: `/avails/ads/icons/attributes/xPosition`	String	`left` ou `10`
`yPosition`	A posição vertical de um ícone no player de vídeo. Pode ser um valor de pixel específico ou uma posição como “superior” ou “inferior”. Caminho: `/avails/ads/icons/attributes/yPosition`	String	`top` ou `10`
`iconClicks`	Contém informações de clique e rastreamento de um ícone. Caminho: `/avails/ads/icons/iconClicks`	Objeto
`iconClickThrough`	Um URL para a página do anunciante que o media player abre quando o espectador clica no ícone. Caminho: `/avails/ads/icons/iconClicks/iconClickThrough`	String	`https://advertiser.com/landing-page`
`iconClickTracking`	O URL de rastreamento da `iconClickThrough` propriedade. Caminho: `/avails/ads/icons/iconClicks/iconClickTracking`	Objeto
`iconClickFallbackImages`	Uma matriz de imagens alternativas a serem exibidas se o ícone não puder ser exibido. Caminho: `/avails/ads/icons/iconClicks/iconClickFallbackImages`	Array
`iconViewTracking`	O URL para rastrear quando um ícone é visualizado. Caminho: `/avails/ads/icons/iconViewTracking`	String	`https://tracking.example.com/icon-view`
`offset`	O intervalo de tempo em que um ícone deve aparecer durante a reprodução do anúncio. Caminho: `/avails/ads/icons/attributes/offset`	String	`00:00:05`
`program`	O programa ou iniciativa associado ao ícone, como "AdChoices”. Caminho: `/avails/ads/icons/attributes/program`	String	`AdChoices`
`pxratio`	A proporção de pixels do ícone ou anúncio complementar, usada para exibições de alto DPI. Caminho: `/avails/ads/icons/attributes/pxratio` ou `/avails/ads/companionAds/attributes/pxratio`	String	`1` ou `2`
`type`	O tipo de recurso ou extensão. Caminho: `/avails/ads/extensions/type` ou `/avails/ads/adVerifications/executableResource/type`	String	`text/javascript`
`content`	O conteúdo de uma extensão. Caminho: `/avails/ads/extensions/content`	String
`language`	A linguagem de programação de um recurso executável. Caminho: `/avails/ads/adVerifications/executableResource/language`	String	`javascript`
`browserOptional`	Indica se o suporte do navegador é necessário para o JavaScript recurso. Caminho: `/avails/ads/adVerifications/javaScriptResource/browserOptional`	String	`true` ou `false`
`id`	Um identificador para vários elementos no esquema. Caminho: `/avails/ads/companionAds/attributes/id` ou `/avails/ads/icons/iconClicks/iconClickTracking/id`	String	`companion-1`
`assetHeight`	A altura do ativo publicitário complementar. Caminho: `/avails/ads/companionAds/attributes/assetHeight`	String	`250`
`assetWidth`	A largura do ativo do anúncio complementar. Caminho: `/avails/ads/companionAds/attributes/assetWidth`	String	`300`
`expandedHeight`	A altura do anúncio complementar quando expandido. Caminho: `/avails/ads/companionAds/attributes/expandedHeight`	String	`600`
`expandedWidth`	A largura do anúncio complementar quando expandido. Caminho: `/avails/ads/companionAds/attributes/expandedWidth`	String	`600`
`renderingMode`	O modo de renderização do anúncio complementar. Caminho: `/avails/ads/companionAds/attributes/renderingMode`	String	`default` ou `transparent`
`adSlotId`	O ID do espaço publicitário em que o anúncio complementar deve ser exibido. Caminho: `/avails/ads/companionAds/attributes/adSlotId`	String	`banner-1`
`creativeType`	O tipo MIME do ativo criativo. Caminho: `/avails/ads/icons/staticResource/creativeType`	String	`image/png`

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Rastreamento do lado do cliente

Tempo de atividade

Esquema e propriedades de acompanhamento de anúncios do lado do cliente

Schema

Propriedades

Importante