Package google.ads.drx.video.v1

Index

AdBreakNotificationService

Service d'API permettant aux éditeurs de créer des coupures publicitaires au sein d'une diffusion en direct.

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

API permettant de créer une coupure publicitaire dans la diffusion en direct.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.
ListAdBreaks

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

API permettant de lister les coupures publicitaires dans la diffusion en direct.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

VideoContentIngestionService

Service d'API pour l'ingestion de contenu qui permet de créer ou de mettre à jour du contenu vidéo et ses métadonnées associées dans Google Ad Manager.

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API permettant de créer du contenu ou de mettre à jour ses métadonnées si le contenu existe déjà dans Ad Manager. Renvoie le contenu en cas de réussite ou google.rpc.Code en cas d'échec.

Voici un exemple de requête :

{
   "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"],
       }
   }
}
Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

AdBreak

Métadonnées de coupure publicitaire utilisées pour décider des annonces à diffuser lors d'une coupure publicitaire dans un événement vidéo en direct.

Champs
name

string

Uniquement en sortie. Nom de la ressource de la coupure publicitaire. Ce champ se présentera comme suit : "networks//assets//adBreaks/".

network_code correspond au code de réseau Google Ad Manager auquel ce contenu appartient.

asset_key est la clé de l'événement de diffusion en direct dans Google Ad Manager sous laquelle la coupure publicitaire a été créée.

ad_break_id est la clé de la coupure publicitaire. RÉSULTAT UNIQUEMENT.
expected_duration

Duration

Obligatoire. Durée de la pause prévue.
custom_params

string

Paires clé-valeur à inclure dans les demandes d'annonces pour cette coupure publicitaire pour le ciblage par critères personnalisés dans Ad Manager. Exemple : 'key1=value&key2=value2,value22'
scte_35_cue_out

string

Données encodées en base64 à partir du point de sortie scte35. La commande splice_insert() ou time_signal() peut être incluse. Exemples: - with time_signal(): "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==" - with splice_insert(): "/DAvAAAAAAAA///wFAVIPff+/+c2nALv4UVBAUsWLZ1"
pod_template_name

string

Nom du modèle de série d'annonces Google Ad Manager.
break_state

BreakState

État actuel de la coupure publicitaire.

BreakState

État d'une coupure publicitaire.

Enums
BREAK_STATE_UNSPECIFIED L'état de la coupure publicitaire est inconnu.
BREAK_STATE_DECISIONED La prise de décision concernant les coupures publicitaires a commencé, mais n'a pas encore été transmise aux utilisateurs.
BREAK_STATE_COMPLETE La coupure publicitaire a été diffusée auprès des utilisateurs.

ClosedCaptionFormat

Formats des fichiers de sous-titres.

Enums
CLOSED_CAPTION_FORMAT_UNSPECIFIED Le format des sous-titres n'a pas été spécifié.
TTML application/ttaf+xml
WEB_VTT text/vtt

ClosedCaptionUrlInfo

Métadonnées pour un fichier de sous-titres.

Champs
language_code

string

Code de langue IETF BCP-47 représentant la langue du fichier de sous-titres.
closed_caption_format

ClosedCaptionFormat

Format du fichier de sous-titres.
url

string

URL du fichier de sous-titres.

CreateAdBreakRequest

Demande de AdBreakNotificationService.CreateAdBreak.

Champs
parent

string

Ce champ identifie l'événement LiveStreamEvent auquel cette coupure publicitaire doit être associée à l'aide de la clé de l'élément de diffusion en direct. Il doit être au format "networks/{network_code}/assets/{asset_code}"
custom_parent

string

Ce champ identifie l'événement LiveStreamEvent auquel cette coupure publicitaire doit être associée à l'aide de la clé d'élément personnalisée. Il doit être au format "networks/{network_code}/customAssets/{asset_code}".
content

string

Il s'agit d'une autre façon d'identifier le LiveStreamEvent, s'il est associé à un contenu dans GAM. Il doit être au format "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}".
ad_break

AdBreak

Obligatoire. Coupure publicitaire réelle.
ad_break_id

string

Il s'agit de l'ad_break_id que les utilisateurs peuvent fournir via la requête.

DynamicAdInsertionInfo

Informations concernant l'insertion dynamique d'annonces.

Champs
video_ingest_url_info

VideoIngestUrlInfo

Lien vers le fichier m3u8 principal utilisé pour le fractionnement et la génération de playlists.
media_update_time

Timestamp

Heure de la dernière modification du fichier vidéo référencé dans video_ingest_url_info.
closed_caption_url_info[]

ClosedCaptionUrlInfo

URL du fichier de sous-titres.
fw_caid

string

ID d'élément personnalisé Freewheel utilisé pour le ciblage des annonces.

GracenoteMetadata

Métadonnées Gracenote pour le contenu.

Champs
gracenote_id

string

Obligatoire. Fait référence à l'ID Gracenote du contenu. Doit comporter l'un des préfixes valides suivants: 1. "EP" : épisode d'une série 2. "MV" - film 3. "SP" : événement sportif
gracenote_series_id

string

Facultatif. Ce champ fait référence à l'ID de la série Gracenote. Doit être précédé du préfixe "SH".

ListAdBreaksRequest

Demande de AdBreakNotificationService.ListAdBreaks.

Champs
parent

string

Facultatif. Ce champ identifie le LiveStreamEvent auquel cette coupure publicitaire doit être associée à l'aide de la clé de l'élément de flux en direct. Il doit être au format "networks/{network_code}/assets/{asset_code}"
custom_parent

string

Facultatif. Ce champ identifie l'événement LiveStreamEvent auquel cette coupure publicitaire doit être associée à l'aide de la clé d'élément personnalisée. Il doit être au format "networks/{network_code}/customAssets/{asset_code}"
content

string

Facultatif. Il s'agit d'une autre façon d'identifier le LiveStreamEvent, s'il est associé à un contenu dans GAM. Il doit être au format suivant : "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"
page_size

int32

Facultatif. Nombre maximal de coupures publicitaires à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 10 coupures publicitaires au maximum sont renvoyées. La valeur maximale est 100. Les valeurs supérieures sont réduites à 100.
page_token

string

Facultatif. Jeton de page reçu d'un appel ListAdBreaks précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListAdBreaks doivent correspondre à l'appel ayant fourni le jeton de page.

ListAdBreaksResponse

Réponse pour AdBreakNotificationService.ListAdBreaks.

Champs
ad_breaks[]

AdBreak

Uniquement en sortie. Liste des coupures publicitaires correspondant au LiveStreamEvent demandé.
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Métadonnées

Métadonnées personnalisées du contenu.

Champs
key_values

map<string, Value>

Identifie les métadonnées personnalisées du contenu sous la forme d'une paire clé-valeur. Seules les chaînes ou les listes de chaînes sont acceptées comme valeurs.

SyndicatedVideoContentNames

Liste des noms de tous les contenus syndiqués.

Champs
syndicated_video_content[]

string

Champ répété contenant le nom du contenu syndiqué. Elles doivent avoir le format "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" et appartenir au même réseau que le contenu contenant ce champ.

UpdateVideoContentRequest

Requête pour [VideoContentIngestionService.UpdateVideoContentRequest][].

Champs
video_content

VideoContent

Obligatoire. Métadonnées du contenu.

ContenuVidéo

Métadonnées du contenu.

Champs
name

string

Uniquement en sortie. Nom de ressource du contenu vidéo. Ce champ a le format suivant : "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}".

network_code correspond au code de réseau Google Ad Manager auquel ce contenu appartient.

content_source_id est l'ID de la source de contenu dans Google Ad Manager à laquelle ce contenu doit appartenir.

cms_content_id est l'ID de contenu du CMS dans Google Ad Manager. Il est généré dans le cadre de la demande d'annonce et permet d'identifier les annonces Ad Manager pouvant être diffusées avec la vidéo correspondante. Cette valeur peut être numérique ou alphanumérique.
status

VideoContentStatus

État du contenu. Si cet élément est omis, la valeur par défaut est "Active".
title

string

Obligatoire. Titre du contenu.
update_time

Timestamp

Obligatoire. Heure de la dernière modification du contenu.
publish_time

Timestamp

Heure de publication du contenu. Il s'agit d'un champ obligatoire si la vidéo est conçue pour être incluse dans des règles relatives aux annonces qui spécifient une heure de début et de fin.
duration

Duration

Durée du contenu. La durée est prise en charge jusqu'à la milliseconde.
cue_points[]

Duration

Identifie les points de repère. Ces points de repère correspondent aux moments où une annonce peut être insérée dans la vidéo. Les points de repère sont pris en charge jusqu'à la milliseconde près. Ce champ est obligatoire si la vidéo contient des coupures publicitaires mid-roll.
thumbnail_url

string

URL de la vignette du contenu.
metadata

Metadata

Identifie les métadonnées personnalisées du contenu.
gracenote_metadata

GracenoteMetadata

Métadonnées du contenu liées à Gracenote.
syndication_metadata

VideoContentSyndicationInfo

Métadonnées du contenu liées à la syndication.
dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

Métadonnées du contenu liées à l'insertion dynamique d'annonces.

VideoContentStatus

Options d'état permettant de diffuser ou non des annonces ciblées pour un contenu.

Enums
ACTIVE Des annonces ciblées sur le contenu seront diffusées.
BLOCKED Aucune annonce ne sera diffusée à côté de ce contenu si son état est BLOQUÉ.
DELETED Le contenu sera archivé dans Ad Manager. Si Ad Manager reçoit une demande d'annonce pour un contenu marqué comme SUPPRIMÉ, les auto-promotions, ou les annonces ciblant des blocs d'inventaire ou d'autres critères de ciblage peuvent tout de même être diffusées sur ce contenu. Pour bloquer les annonces, définissez l'état sur "BLOCKED" (Bloqué).

VideoContentSyndicationInfo

Métadonnées permettant de spécifier les relations entre le contenu canonique et le contenu syndiqué.

Champs
Champ d'union syndication. VideoContentSyndiationMetadata ne peut contenir qu'un seul des éléments suivants. syndication ne peut être qu'un des éléments suivants :
canonical_video_content

string

Nom du contenu canonique. Il doit être au format "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" et appartenir au même réseau que le contenu contenant ce champ.
syndicated_video_content_names

SyndicatedVideoContentNames

Ensemble de contenus syndiqués

VideoFormat

Formats dans lesquels un contenu vidéo peut être encodé.

Enums
VIDEO_FORMAT_UNSPECIFIED Le format vidéo n'a pas été spécifié.
HLS application/x-mpegURL
DASH application/dash+xml

VideoIngestUrlInfo

Métadonnées spécifiant le lien vers le fichier m3u8 utilisé pour fractionner le contenu et générer des playlists.

Champs
video_format

VideoFormat

Format de la vidéo.
video_preconditioned

VideoPreconditioned

Indique si le contenu est déjà fractionné pour les annonces mid-roll, ce qui signifie que vos segments sont déjà divisés au moment des coupures publicitaires.
url

string

Lien vers le fichier m3u8.

VideoPreconditioned

État fractionné du contenu vidéo.

Enums
NO Pas encore intégré.
YES La vidéo a été conditionnée/divisée.