Package google.ads.drx.video.v1

Índice

AdBreakNotificationService

Es un servicio de API que permite a los publicadores crear pausas publicitarias en una transmisión en vivo.

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

Es una API para crear una pausa publicitaria dentro de la transmisión en vivo.

Alcances de la autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
ListAdBreaks

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

API para mostrar una lista de las pausas publicitarias en la transmisión en vivo.

Alcances de la autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

VideoContentIngestionService

Es un servicio de API para la transferencia de contenido que permite crear o actualizar contenido de video y sus metadatos asociados en Google Ad Manager.

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API para crear contenido nuevo o actualizar sus metadatos si el contenido ya existe en Ad Manager. Muestra el contenido en caso de éxito o una google.rpc.Code en caso de error.

Una solicitud de ejemplo se ve de la siguiente manera:

{
   "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"],
       }
   }
}
Alcances de la autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

AdBreak

Son metadatos de pausas publicitarias que se usan para tomar decisiones sobre los anuncios de una pausa publicitaria en un evento de video en vivo.

Campos
name

string

Solo salida. Es el nombre del recurso de la pausa publicitaria. Este campo tendrá el formato "networks//assets//adBreaks/".

network_code es el código de red en Google Ad Manager al que pertenece este contenido.

asset_key es la clave del evento de transmisión en vivo en Google Ad Manager en el que se creó la pausa publicitaria.

ad_break_id es la clave de la pausa publicitaria. SOLO SALIDA.
expected_duration

Duration

Obligatorio. Es la duración de la pausa esperada.
custom_params

string

Son los pares clave-valor que se incluirán en las solicitudes de anuncios de esta pausa para la segmentación de criterios personalizados en Ad Manager. Ejemplo: "key1=value&key2=value2,value22"
scte_35_cue_out

string

Datos codificados en Base 64 a partir del indicador de scte35. Puede incluir el comando splice_insert() o time_signal(). Ejemplos: - con time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - con splice_insert(): "/DAvAAAAAAAA///wFAVIAACAAAAAAALUVBowJAAA
pod_template_name

string

Es el nombre de la plantilla de grupos de anuncios de Google Ad Manager.
break_state

BreakState

Es el estado actual de la pausa publicitaria.

BreakState

Es el estado de una pausa publicitaria.

Enumeraciones
BREAK_STATE_UNSPECIFIED Se desconoce el estado de la pausa publicitaria.
BREAK_STATE_DECISIONED Se inició la toma de decisiones sobre las pausas publicitarias, pero aún no se publican para los usuarios.
BREAK_STATE_COMPLETE Se publicó la pausa publicitaria a los usuarios.

ClosedCaptionFormat

Los formatos en los que pueden estar los archivos de subtítulos.

Enumeraciones
CLOSED_CAPTION_FORMAT_UNSPECIFIED No se especificó el formato de los subtítulos.
TTML application/ttaf+xml
WEB_VTT text/vtt

ClosedCaptionUrlInfo

Metadatos de un archivo de subtítulos

Campos
language_code

string

Es el código de idioma IETF BCP-47 que representa el idioma en el que se encuentra el archivo de subtítulos.
closed_caption_format

ClosedCaptionFormat

El formato del archivo de subtítulos.
url

string

Es la URL del archivo de subtítulos.

CreateAdBreakRequest

Solicitud para AdBreakNotificationService.CreateAdBreak.

Campos
parent

string

Este campo identifica el LiveStreamEvent al que debe asociarse esta pausa publicitaria con la clave del recurso de transmisión en vivo. Debe tener el formato "networks/{network_code}/assets/{asset_code}".
custom_parent

string

Este campo identifica el LiveStreamEvent al que se debe asociar esta pausa publicitaria con la clave del activo personalizado. Debe tener el formato "networks/{network_code}/customAssets/{asset_code}".
content

string

Esta es una forma alternativa de identificar el LiveStreamEvent si está asociado con un contenido dentro de GAM. Debe tener el siguiente formato: “networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}”
ad_break

AdBreak

Obligatorio. La pausa publicitaria real.
ad_break_id

string

Este es el ad_break_id que los usuarios pueden proporcionar a través de la solicitud.

DynamicAdInsertionInfo

Información relacionada con la inserción de anuncios dinámicos.

Campos
video_ingest_url_info

VideoIngestUrlInfo

Es un vínculo al archivo m3u8 principal que se usa para el acondicionamiento y la generación de la playlist.
media_update_time

Timestamp

Hora en la que se modificó por última vez el archivo de video al que se hace referencia en video_ingest_url_info.
closed_caption_url_info[]

ClosedCaptionUrlInfo

Es la URL del archivo de subtítulos.
fw_caid

string

Es el ID del activo personalizado de FreeWheel que se usa para segmentar anuncios.

GracenoteMetadata

Los metadatos de Gracenote para el contenido.

Campos
gracenote_id

string

Obligatorio. Se refiere al ID de Gracenote para el contenido. Debe tener uno de estos prefijos válidos: 1. EP - episodio de una serie 2. "MV": película 3. 'SP' - evento deportivo
gracenote_series_id

string

Opcional. Este campo hace referencia al ID de la serie de Gracenote. Debe tener el prefijo “SH”.

ListAdBreaksRequest

Solicitud para AdBreakNotificationService.ListAdBreaks.

Campos
parent

string

Opcional. Este campo identifica el LiveStreamEvent al que se debe asociar esta pausa publicitaria con la clave del activo de transmisión en vivo. Debe tener el formato "networks/{network_code}/assets/{asset_code}".
custom_parent

string

Opcional. Este campo identifica el LiveStreamEvent al que se debe asociar esta pausa publicitaria con la clave del activo personalizado. Debe tener el formato "networks/{network_code}/customAssets/{asset_code}".
content

string

Opcional. Esta es una forma alternativa de identificar el LiveStreamEvent si está asociado con un contenido dentro de GAM. Debe tener el formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}".
page_size

int32

Opcional. Es la cantidad máxima de pausas publicitarias que se mostrarán. El servicio puede mostrar menos que este valor. Si no se especifica, se mostrarán como máximo 10 pausas publicitarias. El valor máximo es 100. los valores superiores a 100 se convertirán en 100.
page_token

string

Opcional. Un token de página, recibido desde una llamada ListAdBreaks anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListAdBreaks deben coincidir con la llamada que proporcionó el token de la página.

ListAdBreaksResponse

La respuesta para AdBreakNotificationService.ListAdBreaks.

Campos
ad_breaks[]

AdBreak

Solo salida. Una lista de pausas publicitarias que coinciden con el LiveStreamEvent solicitado.
next_page_token

string

Un token que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Metadatos

Metadatos personalizados del contenido

Campos
key_values

map<string, Value>

Identifica los metadatos personalizados del contenido como un par clave-valor. Solo se aceptan cadenas o listas de cadenas para los valores.

SyndicatedVideoContentNames

Es la lista de nombres de todo el contenido distribuido.

Campos
syndicated_video_content[]

string

Campo repetido para el nombre del contenido distribuible Deben tener el formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" y pertenecer a la misma cadena que el contenido que contiene este campo.

UpdateVideoContentRequest

Solicitud de [VideoContentIngestionService.UpdateVideoContentRequest][].

Campos
video_content

VideoContent

Obligatorio. Son los metadatos del contenido.

Contenido del video

Son los metadatos del contenido.

Campos
name

string

Solo salida. Es el nombre del recurso del contenido de video. Este campo tiene el siguiente formato: 'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}'

network_code es el código de red de Google Ad Manager al que pertenece este contenido.

content_source_id es el ID de la fuente de contenido en Google Ad Manager al que debe pertenecer este contenido.

cms_content_id es el ID de contenido del CMS en Google Ad Manager, que se forma como parte de la solicitud de anuncio para identificar qué anuncios puede publicar Ad Manager en el video correspondiente. Este valor puede ser numérico o alfanumérico.
status

VideoContentStatus

Es el estado del contenido. Si se omite, el valor predeterminado estará activo.
title

string

Obligatorio. Es el título del contenido.
update_time

Timestamp

Obligatorio. Hora de la última modificación del contenido.
publish_time

Timestamp

Indica la hora de publicación del contenido. Este es un campo obligatorio si el video está diseñado para incluirse en reglas de anuncios que especifican una hora de inicio y finalización.
duration

Duration

Es la duración del contenido. La duración se admite hasta el nivel de milisegundos.
cue_points[]

Duration

Identifica los puntos de inserción. Los puntos de inserción son momentos específicos en los que se puede insertar un anuncio en el video. Los puntos de inserción se admiten en milisegundos. Este es un campo obligatorio si el video contiene pausas publicitarias para anuncios durante el video.
thumbnail_url

string

Es la URL en miniatura del contenido.
metadata

Metadata

Identifica los metadatos personalizados del contenido.
gracenote_metadata

GracenoteMetadata

Metadatos relacionados con Gracenote del contenido
syndication_metadata

VideoContentSyndicationInfo

Metadatos del contenido relacionados con la distribución.
dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

Metadatos del contenido relacionados con la inserción de anuncios dinámicos.

VideoContentStatus

Son opciones de estado para publicar o no anuncios segmentados para un contenido.

Enumeraciones
ACTIVE Se publicarán anuncios orientados por contenido.
BLOCKED No se publicarán anuncios en este contenido si el estado es BLOQUEADO.
DELETED El contenido se archivará en Ad Manager. Si Ad Manager recibe una solicitud de anuncio para un contenido marcado como BORRADO, se pueden seguir publicando anuncios propios o orientados a unidades de inventario, o bien otros criterios de segmentación. Para bloquear los anuncios, establece el estado como BLOQUEADO.

VideoContentSyndicationInfo

Los metadatos para especificar las relaciones entre el contenido canónico y el contenido distribuible.

Campos
Campo de unión syndication. VideoContentSyndiationMetadata solo puede contener uno de los siguientes elementos. Las direcciones (syndication) solo pueden ser una de las siguientes opciones:
canonical_video_content

string

Es el nombre del contenido canónico. Debe tener el formato "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" y debe pertenecer a la misma cadena que el contenido que contiene este campo.
syndicated_video_content_names

SyndicatedVideoContentNames

Una colección de contenido distribuido

Formato del video

Son los formatos en los que se puede codificar el contenido de un video.

Enumeraciones
VIDEO_FORMAT_UNSPECIFIED No se especificó el formato del video.
HLS application/x-mpegURL
DASH application/dash+xml

VideoIngestUrlInfo

Son metadatos que especifican el vínculo al archivo m3u8 que se usa para el acondicionamiento y la generación de playlists.

Campos
video_format

VideoFormat

Es el formato del video.
video_preconditioned

VideoPreconditioned

Para indicar si el contenido ya está acondicionado para anuncios durante el video, lo que significa que tus segmentos ya están divididos en función de las pausas publicitarias.
url

string

Es el vínculo al archivo m3u8.

VideoPreconditioned

Es el estado ingerido del contenido de video.

Enumeraciones
NO Aún sin acondicionar.
YES El video se acondicionó o se dividió.