Package google.ads.drx.video.v1

Índice

AdBreakNotificationService

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

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

API para criar um intervalo de anúncio na transmissão ao vivo.

Escopos de autorização

Requer um dos seguintes escopos do 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.
ListAdBreaks

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

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

Escopos de autorização

Requer um dos seguintes escopos do 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.

VideoContentIngestionService

Um serviço de API para ingestão de conteúdo que permite criar ou atualizar 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 os 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.

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 do 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 para um intervalo em um evento de vídeo ao vivo.

Campos
name

string

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

network_code é o código da rede no Google Ad Manager a que esse conteúdo pertence.

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

ad_break_id é a chave do intervalo de anúncio. SOMENTE SAÍDA.
expected_duration

Duration

Obrigatório. Duração esperada da pausa.
custom_params

string

Pares de chave-valor serão incluídos nas solicitações de anúncios para este intervalo na segmentação por 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 de cue scte35. Pode incluir o comando splice_insert() ou time_signal(). Exemplos: - com time_signal(): "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==" - com splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
pod_template_name

string

Nome do modelo do conjunto do Google Ad Manager.
break_state

BreakState

O estado atual do intervalo de anúncio.

BreakState

O estado de um intervalo de anúncio.

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

ClosedCaptionFormat

Os formatos em que os arquivos de legenda podem estar.

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

ClosedCaptionUrlInfo

Metadados de um arquivo de legenda.

Campos
language_code

string

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

ClosedCaptionFormat

O formato do arquivo de legendas.
url

string

O URL do arquivo de legenda.

CreateAdBreakRequest

Solicitação de AdBreakNotificationService.CreateAdBreak.

Campos
parent

string

Esse campo identifica o LiveStreamEvent ao qual este intervalo de anúncio deve estar associado usando a chave de recurso de transmissão ao vivo. Ele precisa estar no formato "networks/{network_code}/assets/{asset_code}"
custom_parent

string

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

string

Essa é uma forma alternativa de identificar o LiveStreamEvent, se ele estiver associado a um 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

Esse é o ad_break_id que os usuários podem fornecer na solicitação.

DynamicAdInsertionInfo

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 o condicionamento e a geração de playlists.
media_update_time

Timestamp

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

ClosedCaptionUrlInfo

O URL do arquivo de legenda.
fw_caid

string

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

GracenoteMetadata

Os metadados da Gracenote para o conteúdo.

Campos
gracenote_id

string

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

string

Opcional. Este campo se refere ao ID da série da Gracenote. Precisa ter o prefixo "SH".

ListAdBreaksRequest

Solicitação de AdBreakNotificationService.ListAdBreaks.

Campos
parent

string

Opcional. Esse campo identifica o LiveStreamEvent ao qual este intervalo de anúncio deve estar associado usando a chave de recurso de transmissão ao vivo. Ele precisa estar no formato "networks/{network_code}/assets/{asset_code}"
custom_parent

string

Opcional. Esse campo identifica o LiveStreamEvent que esse intervalo de anúncio precisa associar usando a chave de recurso personalizada. Ele precisa estar no formato "networks/{network_code}/customAssets/{asset_code}".
content

string

Opcional. Essa é uma forma alternativa de identificar o LiveStreamEvent, se ele estiver associado a um 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úncios a serem retornados. O serviço pode retornar menos que esse valor. Se não for especificado, no máximo 10 intervalos de anúncios serão retornados. O valor máximo é 100. Valores acima disso vão ser 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 listas 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. Elas precisam estar no formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" e precisa pertencer à mesma rede que o conteúdo que contém este 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 de recurso do conteúdo em vídeo. Esse campo tem o formato: 'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}'

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

content_source_id é o ID da origem do conteúdo no Google Ad Manager a que esse conteúdo pertence.

cms_content_id é o ID do conteúdo do CMS no Google Ad Manager, formado como parte da solicitação de anúncio para identificar os anúncios que 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 omitido, o valor padrão ficará ativo.
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

A hora de publicação do conteúdo. Esse é um campo obrigatório se o vídeo for incluído em regras de anúncio que especificam um horário de início e término.
duration

Duration

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

Duration

Identifica os pontos de inserção. Os pontos de inserção são momentos em que um anúncio pode ser inserido no vídeo. Os pontos de inserção são suportados até o nível dos milissegundos. Esse 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

Os metadados do conteúdo relacionados à Gracenote.
syndication_metadata

VideoContentSyndicationInfo

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

DynamicAdInsertionInfo

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

VideoContentStatus

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

Enums
ACTIVE Anúncios segmentados por conteúdo serão veiculados.
BLOCKED Nenhum anúncio será veiculado nesse conteúdo se o status for BLOQUEADO.
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 DELETADO, 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 relações entre o conteúdo canônico e o conteúdo distribuído.

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

string

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

SyndicatedVideoContentNames

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

VideoFormat

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

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

VideoIngestUrlInfo

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

Campos
video_format

VideoFormat

O formato do vídeo.
video_preconditioned

VideoPreconditioned

Indicar se o conteúdo já está condicionado para anúncios intermediários, o que significa que seus segmentos já estão divididos no momento dos intervalos de anúncio.
url

string

O link para o arquivo m3u8.

VideoPreconditioned

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

Enums
NO Ainda não condicionado.
YES O vídeo foi condicionado/incluído.