API Linear de inserção de anúncios dinâmicos

Com a API Dynamic Ad Insert, é possível solicitar e rastrear a DAI transmissões lineares (AO VIVO).

Serviço: dai.google.com

Todos os URIs abaixo são relativos a https://dai.google.com

Método: stream

Solicitação HTTP

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/stream

Cabeçalho da solicitação

Authorization: DCLKDAI key="<api-key>"

Parâmetros de caminho

Corpo da solicitação

O corpo da solicitação é do tipo application/x-www-form-urlencoded e contém a parâmetros a seguir:

Corpo da resposta

Se bem-sucedido, o corpo da resposta conterá uma nova Stream Para streams de beacon do lado do servidor, este Stream contém apenas os campos stream_id e stream_manifest.

Open Measurement

A API DAI contém informações para a verificação do Open Measurement no Verifications. Este campo contém um ou mais Elementos Verification que listam os recursos e metadados necessários para execução código de medição de terceiros para verificar a reprodução do criativo. Somente JavaScriptResource é compatível. Para mais informações, consulte a IAB Tech Lab e os Especificação VAST 4.1.

Método: verificação de mídia

Após encontrar um identificador de mídia do anúncio durante a reprodução, faça imediatamente uma solicitação usando o media_verification_url obtido do stream endpoint, acima. Essas solicitações não são necessárias para beacon do servidor streams, em que o servidor inicia a verificação de mídia.

As solicitações para o endpoint media verification são idempotentes.

Solicitação HTTP

GET https://{media-verification-url}/{ad-media-id}

Corpo da resposta

media verification retorna as seguintes respostas:

• HTTP/1.1 204 No Content se a verificação de mídia for bem-sucedida e todos os pings forem enviados.
• HTTP/1.1 404 Not Found se a solicitação não puder verificar a mídia devido à formatação ou à expiração incorreta do URL.
• HTTP/1.1 404 Not Found se uma solicitação de verificação anterior para esse ID tiver sido bem-sucedida.
• HTTP/1.1 409 Conflict se outra solicitação já estiver enviando pings no momento.

IDs de mídia do anúncio (HLS)

Os identificadores de mídia do anúncio serão codificados em metadados com marcação de tempo HLS usando a chave TXXX, reservado para "informações de texto definidas pelo usuário" frames. A o conteúdo do frame não será criptografado e sempre começará com o texto "google_":

Todo o conteúdo do texto do frame deve ser anexado à verificação do anúncio. antes de fazer cada solicitação de verificação de anúncios.

Método: metadata

O endpoint de metadados em metadata_url retorna as informações usadas para criar um anúncio. de ML pela IU. O endpoint de metadados não está disponível para streams de beacon do servidor, em que o servidor é responsável por iniciar a verificação da mídia do anúncio.

Solicitação HTTP

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

Corpo da resposta

Se bem-sucedido, a resposta retorna uma instância de PodMetadata

Como trabalhar com metadados

Os metadados têm três seções distintas: tags, ads e anúncio breaks. A entrada aos dados é a seção tags. A partir daí, itere as tags e encontre a primeira entrada cujo nome seja um prefixo do ID da mídia do anúncio encontrado no stream de vídeo. Por exemplo, pode ter um ID de mídia do anúncio que se parece com:

google_1234567890

Em seguida, você encontrará um objeto de tag chamado google_12345. Nesse caso, ele corresponde ao seu ID da mídia do anúncio. Após encontrar o objeto correto de prefixo de mídia do anúncio, você pode procurar IDs de anúncio, IDs de intervalo de anúncio e o tipo de evento. Os IDs dos anúncios são usados para indexar Os objetos ads e os IDs de intervalos de anúncio são usados para indexar os objetos breaks.

Dados de resposta

Stream

{
  "stream_id": string,
  "stream_manifest": string,
  "hls_master_playlist": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "polling_frequency": number,
}

PodMetadata

{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}

TagSegment

{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}

AdBreak

{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}

Anúncio

{
  "ad_break_id": string,
  "position": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}

Ícone

{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}

ClickData

{
  "url": string,
}

FallbackImage

{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}

Wrapper

{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}

Verificação

{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}

JavaScriptResource

{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}

TrackingEvent

{
  "event": string,
  "uri": string,
}

UniversalAdID

{
  "id_value": string,
  "id_registry": string,
}

Complementar

{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}

InteractiveFile

{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}