Package google.ads.drx.video.v1

Índice

Serviço de intervalo de notificação

Um serviço de API que permite aos editores criar intervalos de anúncio em uma transmissão ao vivo.

Criar intervalo comercial

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

API para criar um intervalo comercial na transmissão ao vivo.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Para mais informações, consulte a Visão geral do OAuth 2.0.
ListBreaks

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

API para listar intervalos de anúncios na transmissão ao vivo.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Para mais informações, consulte a Visão geral do OAuth 2.0.

Serviço de processamento de conteúdo de vídeo

É um serviço de API para processamento de conteúdo que permite criar ou atualizar o conteúdo de vídeo e os metadados associados no Google Ad Manager.

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API para criar conteúdo novo ou atualizar metadados se o conteúdo já existir no Ad Manager. Retorna o conteúdo em caso de sucesso ou um google.rpc.Code em caso de falha.

Veja abaixo um exemplo de solicitação:

{
   "status": "ACTIVE",
   "title": "Best video ever",
   "updateTime": "2019-01-24T01:30:15.01Z",
   "duration": "230s",
   "cuePoints": ["55.532s", "192s"],
   "publishTime": "2019-01-24T01:30:15.01Z",
   "thumbnailUrl": "http://www.domain.com/tn.jpg",
   "metadata": {
       "keyValues": {
           "category": "sports",
           "tag": ["soccer", "messi"],
       }
   }
}
Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Para mais informações, consulte a Visão geral do OAuth 2.0.

AdBreak

Metadados de intervalo de anúncio usados para decidir anúncios de um intervalo de anúncio em um evento de vídeo ao vivo.

Campos
name

string

Apenas saída. O nome do recurso do intervalo comercial. Esse campo terá o formato de "networks//assets//adBreaks/".

network_code é o código de rede do Google Ad Manager ao qual este conteúdo pertence.

asset_key é a chave do evento de transmissão ao vivo no Google Ad Manager em que o intervalo comercial foi criado.

ad_break_id é a chave do intervalo comercial. APENAS OUTPUT.
expected_duration

Duration

Obrigatório. Duração esperada do intervalo.
custom_params

string

Pares de chave-valor serão incluídos nas solicitações de anúncio desse intervalo para a segmentação de critérios personalizados no Ad Manager. Exemplo: 'key1=value&key2=value2,value22'
scte_35_cue_out

string

Dados codificados em base 64 da saída scte35. Pode incluir o comando splice_insert() ou time_signal(). Exemplos: - com time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - com splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUszWAAAAAAAAAbow
pod_template_name

string

Nome do modelo de conjunto do Google Ad Manager.
break_state

BreakState

O estado atual do intervalo comercial.

BreakState (em inglês)

O estado de um intervalo comercial.

Enums
BREAK_STATE_UNSPECIFIED O estado do intervalo de anúncio é desconhecido.
BREAK_STATE_DECISIONED A decisão do intervalo comercial começou, mas ainda não foi entregue aos usuários.
BREAK_STATE_COMPLETE O intervalo comercial foi exibido aos usuários.

Formato de closed captions

Os formatos em que os arquivos de closed caption podem estar.

Enums
CLOSED_CAPTION_FORMAT_UNSPECIFIED O formato de legenda não foi especificado.
TTML aplicativo/ttaf+xml
WEB_VTT texto/vtt

ClosedCaptionUrlInfo

Metadados de um arquivo de legenda.

Campos
language_code

string

O código IETF BCP-47 que representa o idioma do arquivo de closed caption.
closed_caption_format

ClosedCaptionFormat

O formato do arquivo de closed caption.
url

string

O URL para o arquivo de legenda.

CreateAdBreakRequest

Solicitação de AdBreakNotificationService.CreateAdBreak.

Campos
parent

string

Esse campo identifica o LiveStreamEvent ao qual esse intervalo de anúncio deve ser associado ao uso da chave de recurso de transmissão ao vivo. Ele precisa ter o formato "networks/{network_code}/assets/{asset_code}"
custom_parent

string

Esse campo identifica o LiveStreamEvent ao qual esse intervalo de anúncio deve ser associado ao uso da chave de recurso personalizada. Ele precisa estar no formato "networks/{network_code}/customAssets/{asset_code}"
content

string

Essa é uma maneira alternativa de identificar o LiveStreamEvent, se ele estiver associado a uma parte do conteúdo no GAM. Ele precisa estar no formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}".
ad_break

AdBreak

Obrigatório. O intervalo de anúncio real.
ad_break_id

string

Este é o ad_break_id que os usuários podem fornecer por meio da solicitação.

Informações de DynamicAdInsertion

Informações relacionadas à inserção de anúncios dinâmicos.

Campos
video_ingest_url_info

VideoIngestUrlInfo

Um link para o arquivo m3u8 principal usado para condicionamento e geração de playlist.
media_update_time

Timestamp

A hora da última modificação do arquivo de vídeo mencionado no video_ingest_url_info.
closed_caption_url_info[]

ClosedCaptionUrlInfo

O URL para o arquivo de legenda/legenda oculta.
fw_caid

string

Código de recurso personalizado do Freewheel usado para segmentação de anúncios.

Metadados do Gracenote

Os metadados da Gracenote para o conteúdo.

Campos
gracenote_id

string

Obrigatório. Refere-se ao Gracenote ID do conteúdo. Precisa ter um destes prefixos válidos: 1. "EP": episódio da série 2. "MV" — filme 3. "SP": evento esportivo
gracenote_series_id

string

Opcional. Esse campo se refere ao código da série da Gracenote. Precisa ser prefixado com "SH".

ListAdBreaksRequest

Solicitação de AdBreakNotificationService.ListAdBreaks.

Campos
parent

string

Opcional. Esse campo identifica o LiveStreamEvent ao qual esse intervalo de anúncio deve ser associado ao uso da chave de recurso de transmissão ao vivo. Ele precisa ter o formato "networks/{network_code}/assets/{asset_code}"
custom_parent

string

Opcional. Esse campo identifica o LiveStreamEvent ao qual esse intervalo de anúncio deve ser associado ao uso da chave de recurso personalizada. Ele precisa estar no formato "networks/{network_code}/customAssets/{asset_code}"
content

string

Opcional. Essa é uma maneira alternativa de identificar o LiveStreamEvent, se ele estiver associado a uma parte do conteúdo no GAM. Ele precisa estar no formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}".
page_size

int32

Opcional. O número máximo de intervalos de anúncio a serem retornados. O serviço pode retornar menos que esse valor. Se não for especificado, serão retornados no máximo 10 intervalos de anúncio. O valor máximo é 100. Valores acima de 100 são convertidos para 100.
page_token

string

Opcional. Um token de página recebido de uma chamada ListAdBreaks anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListAdBreaks precisam corresponder à chamada que forneceu o token da página.

ListAdBreaksResponse

Resposta para AdBreakNotificationService.ListAdBreaks.

Campos
ad_breaks[]

AdBreak

Apenas saída. Uma lista de intervalos de anúncio que correspondem ao LiveStreamEvent solicitado.
next_page_token

string

Um token que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Metadados

Metadados personalizados do conteúdo.

Campos
key_values

map<string, Value>

Identifica os metadados personalizados do conteúdo como um par de chave-valor. Somente strings ou lista de strings são aceitas como valores.

SyndicatedVideoContentNames

A lista de nomes de todo o conteúdo distribuído.

Campos
syndicated_video_content[]

string

Campo repetido do nome do conteúdo distribuído. É preciso usar o formato "redes/{network_code}/sources/{content_source_id}/content/{cms_content_id}" e pertencer à mesma rede do conteúdo que contém esse campo.

UpdateVideoContentRequest

Solicitação para [VideoContentIngestionService.UpdateVideoContentRequest][].

Campos
video_content

VideoContent

Obrigatório. Os metadados do conteúdo.

VideoContent

Os metadados do conteúdo.

Campos
name

string

Apenas saída. O nome do recurso do conteúdo de vídeo. Este campo tem o formato: 'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}'

network_code é o código de rede do Google Ad Manager ao qual este conteúdo pertence.

content_source_id é o código da fonte de conteúdo no Google Ad Manager ao qual este conteúdo deve pertencer.

cms_content_id é o código de conteúdo do CMS no Google Ad Manager, formado como parte da solicitação de anúncio para identificar quais anúncios o Ad Manager pode veicular em relação ao vídeo correspondente. Esse valor pode ser numérico ou alfanumérico.
status

VideoContentStatus

O status do conteúdo. Se for omitido, o valor padrão será ativado.
title

string

Obrigatório. O título do conteúdo.
update_time

Timestamp

Obrigatório. O horário da última modificação do conteúdo.
publish_time

Timestamp

O horário de publicação do conteúdo. Este é um campo obrigatório se o vídeo for criado para ser incluído nas regras de anúncios que especificam o horário de início e término.
duration

Duration

Duração do conteúdo. A duração é suportada até o nível de milissegundos.
cue_points[]

Duration

Identifica os pontos de indicação. Os pontos de indicação são momentos em que um anúncio pode ser inserido no vídeo. Os pontos de inserção são compatíveis até o nível de milissegundos. Este é um campo obrigatório se o vídeo tiver intervalos de anúncios intermediários.
thumbnail_url

string

URL da miniatura do conteúdo.
metadata

Metadata

Identifica os metadados personalizados do conteúdo.
gracenote_metadata

GracenoteMetadata

Metadados relacionados ao Gracenote do conteúdo.
syndication_metadata

VideoContentSyndicationInfo

Metadados relacionados à distribuição do conteúdo.
dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

Metadados do conteúdo relacionado à inserção de anúncios dinâmicos.

Status do conteúdo de vídeo

Opções de status para exibir ou não anúncios segmentados para um conteúdo.

Enums
ACTIVE Anúncios segmentados por conteúdo serão exibidos.
BLOCKED Nenhum anúncio será exibido nesse conteúdo se o status for BLOCKED.
DELETED O conteúdo será arquivado no Ad Manager. Se o Ad Manager receber uma solicitação de anúncio para um conteúdo marcado como EXCLUÍDO, os anúncios internos ou anúncios segmentados para unidades de inventário ou outros critérios de segmentação ainda poderão ser veiculados. Para bloquear anúncios, defina o status como "BLOQUEADO".

VideoContentSyndicationInfo

Os metadados para especificar as relações entre o conteúdo canônico e o conteúdo distribuído.

Campos
Campo de união syndication. VideoContentSyndiationMetadata só pode conter um dos seguintes. syndication pode ser apenas de um dos tipos a seguir:
canonical_video_content

string

O nome do conteúdo canônico. Ele precisa ter o formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" e pertencer à mesma rede que o conteúdo que contém esse campo.
syndicated_video_content_names

SyndicatedVideoContentNames

Uma coleção de conteúdo distribuído

Formato de vídeo

Os formatos em que um conteúdo de vídeo pode ser codificado.

Enums
VIDEO_FORMAT_UNSPECIFIED O formato do vídeo não foi especificado.
HLS aplicativo/x-mpegURL
DASH aplicativo/dash+xml

VideoIngestUrlInfo

Metadados que especificam o link para o arquivo m3u8 usado para condicionamento e geração de playlist.

Campos
video_format

VideoFormat

O formato do vídeo.
video_preconditioned

VideoPreconditioned

Indica se o conteúdo já está condicionado para anúncios intermediários. Isso significa que seus segmentos já estão divididos no momento dos intervalos comerciais.
url

string

O link para o arquivo m3u8.

Precondicionado

O estado condicionado do conteúdo de vídeo.

Enums
NO Ainda não está condicionado.
YES O vídeo foi condicionado.