Package google.ads.drx.video.v1

Índice

Servicio de notificación de pausa

Servicio de API que permite a los editores crear pausas publicitarias dentro de una transmisión en vivo.

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

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

Alcances de la autorización

Se necesita uno de los siguientes alcances 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 pausas publicitarias en la transmisión en vivo

Alcances de la autorización

Se necesita uno de los siguientes alcances 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.

Servicio de transferencia de contenido de video

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

ActualizarVideoContenido

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API para crear contenido nuevo o actualizar los metadatos si el contenido ya existe en Ad Manager. Muestra el contenido en caso de éxito o un 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 alcances 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 los metadatos de pausas publicitarias que se usan para decidir si se tomarán pausas publicitarias en un evento de video en vivo.

Campos
name

string

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

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

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

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

Duration

Obligatorio. Duración esperada de la pausa.
custom_params

string

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 punto de salida scte35. Puede incluir el comando splice_insert() o time_signal(). Ejemplos: - con time_signal(): "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==", con splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1
pod_template_name

string

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

BreakState

Es el estado actual de la pausa publicitaria.

Estado de interrupción

Es el estado de una pausa publicitaria.

Enumeradores
BREAK_STATE_UNSPECIFIED Se desconoce el estado de la pausa publicitaria.
BREAK_STATE_DECISIONED Las decisiones de pausas publicitarias comenzaron a publicarse, pero aún no se publicaron para los usuarios.
BREAK_STATE_COMPLETE Se publicó la pausa publicitaria a los usuarios.

Formato de subtítulos

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

Enumeradores
CLOSED_CAPTION_FORMAT_UNSPECIFIED No se especificó el formato de subtítulos.
TTML aplicación/ttaf+xml
WEB_VTT texto/vtt

Información de URL de subtítulos

Metadatos de un archivo de subtítulos.

Campos
language_code

string

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

La URL al archivo de subtítulos.

CreateAdBreakRequest

Solicitud para AdBreakNotificationService.CreateAdBreak.

Campos
parent

string

Este campo identifica el evento de transmisión en vivo que se debe asociar con la clave del elemento de transmisión en vivo. Debe tener el formato “networks/{network_code}/assets/{asset_code}”
custom_parent

string

Este campo identifica el evento de transmisión en vivo que se debe asociar con la clave de elemento 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 formato “networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}.
ad_break

AdBreak

Obligatorio. Es 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.

InformaciónDinámicaDelAnuncio

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

Campos
video_ingest_url_info

VideoIngestUrlInfo

Vínculo al archivo m3u8 principal que se usa para el acondicionamiento y generación de listas de reproducción.
media_update_time

Timestamp

La hora en 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

La URL al archivo de subtítulos.
fw_caid

string

Es el ID de recurso personalizado de Freewheel que se usa para la segmentación de 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 Gracenote. Debe tener el prefijo “SH”.

ListAdBreaksRequest

Solicitud para AdBreakNotificationService.ListAdBreaks.

Campos
parent

string

Opcional. Este campo identifica el evento de transmisión en vivo que se debe asociar con la clave del elemento de transmisión en vivo. Debe tener el formato “networks/{network_code}/assets/{asset_code}”
custom_parent

string

Opcional. Este campo identifica el evento de transmisión en vivo que se debe asociar con la clave de elemento 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. Es posible que el servicio muestre menos de 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. Lista de pausas publicitarias que coinciden con la solicitud de LiveStreamEvent.
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

Son los metadatos personalizados del contenido.

Campos
key_values

map<string, Value>

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

Nombresdecontenidodevideosdistribuidos

Es la lista de nombres de todo el contenido distribuible.

Campos
syndicated_video_content[]

string

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

UpdateVideoContentRequest

Solicitud de [VideoContentIngestionService.UpdateVideoContentRequest][].

Campos
video_content

VideoContent

Obligatorio. Los metadatos del contenido

Contenido del video

Los metadatos del contenido

Campos
name

string

Solo salida. Es el nombre de 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 del contenido de Google Ad Manager al que debe pertenecer este contenido.

cms_content_id es el ID de contenido de 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. Corresponde a la hora de la última modificación del contenido.
publish_time

Timestamp

Es la hora de publicación del contenido. Este es un campo obligatorio si el video está diseñado para incluirse en las 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 concretos en los que se puede insertar un anuncio en el video. Los puntos de inserción se admiten hasta el nivel de milisegundos. Este campo es obligatorio si el video contiene pausas publicitarias de anuncios durante el video.
thumbnail_url

string

URL del miniatura del contenido.
metadata

Metadata

Identifica los metadatos personalizados del contenido.
gracenote_metadata

GracenoteMetadata

Metadatos relacionados con el contenido de Gracenote.
syndication_metadata

VideoContentSyndicationInfo

Son los metadatos relacionados con la distribución del contenido.
dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

Son los metadatos relacionados con la inserción de anuncios dinámicos del contenido.

Estado del contenido del video

Opciones de estado para publicar o no anuncios segmentados para un contenido.

Enumeradores
ACTIVE Se publicarán los 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, podrá publicar anuncios propios o anuncios segmentados para unidades de inventario, o bien otros criterios de segmentación. Para bloquear anuncios, establece el estado en BLOCK.

Información del canal de distribución de contenido de video

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 red que el contenido de este campo.
syndicated_video_content_names

SyndicatedVideoContentNames

Una colección de contenido distribuible

Formato de video

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

Enumeradores
VIDEO_FORMAT_UNSPECIFIED No se especificó el formato de video.
HLS aplicación/x-mpegURL
DASH aplicación/dash+xml

InformaciónDeURLDeVideoTransf.

Metadatos que especifican el vínculo al archivo m3u8 que se usa para el acondicionamiento y generación de listas de reproducción

Campos
video_format

VideoFormat

Indica el formato del video.
video_preconditioned

VideoPreconditioned

Para indicar si el contenido ya está condicionado o no para los anuncios durante el video, significa que tus segmentos ya están divididos en el momento de las pausas publicitarias.
url

string

Es el vínculo al archivo m3u8.

Video preacondicionado

El estado acondicionado del contenido de video.

Enumeradores
NO Todavía no está acondicionado.
YES Se acondicionó o empleó el video.