REST Resource: adBreak.networks.assets.adBreaks

Ressource : AdBreak

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

Représentation JSON 
{
  "name": string,
  "createTime": string,
  "expectedDuration": string,
  "customParams": string,
  "scte35CueOut": string,
  "podTemplateName": string,
  "breakState": enum (BreakState),
  "expectedStartTime": string,
  "expireDuration": string,
  "breakSequence": string,
  "breakParams": {
    object (BreakParams)
  },
  "matchParams": {
    object (MatchParams)
  },
  "servedBreak": {
    object (ServedBreak)
  }
}
Champs
name

string

Uniquement en sortie. Nom de ressource de la coupure publicitaire. Ce champ se présente au format "networks//assets//adBreaks/".

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

asset_key correspond à la clé de l'événement de diffusion en direct dans Google Ad Manager sous lequel l'insertion publicitaire a été créée.

adBreakId est la clé de la coupure publicitaire. SORTIE UNIQUEMENT.
createTime

string (Timestamp format)

Uniquement en sortie. Date et heure de création de la coupure publicitaire.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
expectedDuration

string (Duration format)

Obligatoire. Durée de la pause attendue.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
customParams
(deprecated)

string

Facultatif. Paires clé-valeur à inclure dans les demandes d'annonces liées à cette coupure publicitaire pour le ciblage par critères personnalisés dans Ad Manager. Exemple : "key1=value&key2=value2,value22" Obsolète : veuillez définir cust_params dans breakParams.ad_tag_params à l'aide de la clé "cust_params".
scte35CueOut

string

Facultatif. Données encodées en base64 à partir du point de sortie scte35. La commande splice_insert() ou time_signal() peut être incluse. Exemples : - avec time_signal() : "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==" - avec splice_insert() : "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

Facultatif. Nom du modèle de série d'annonces Google Ad Manager. Obsolète : veuillez définir cust_params dans breakParams.ad_tag_params à l'aide de la clé "ptpln".
breakState

enum (BreakState)

Uniquement en sortie. État actuel de la coupure publicitaire.
expectedStartTime

string (Timestamp format)

Facultatif. Heure de début prévue de la coupure publicitaire.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
expireDuration

string (Duration format)

Facultatif. La coupure publicitaire expire à expectedStartTime + expireDuration. Si expectedStartTime n'est pas défini, le bloc d'annonces expirera expireDuration après le début de la prise de décision. Par défaut : 30 min Minimum : 5 min Maximum : 6 h

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
breakSequence

string (int64 format)

Uniquement en sortie. ID de la séquence mid-roll de la coupure publicitaire. Plusieurs pauses publicitaires peuvent avoir la même valeur breakSequence si elle est spécifiée explicitement via breakParams.ad_tag_params avec la clé mridx. Cela permet d'associer deux coupures publicitaires GAM.
breakParams

object (BreakParams)

Facultatif. Paramètres de coupure à inclure dans les demandes d'annonces pour cette coupure.
matchParams

object (MatchParams)

Facultatif. Utilisé pour l'insertion dynamique d'annonces assemblées afin de déterminer comment un emplacement publicitaire créé via l'API est associé à un emplacement publicitaire dans le fichier manifeste. Lorsqu'une nouvelle coupure est détectée, une fonction de correspondance est exécutée sur toutes les coupures publicitaires d'un événement dont la valeur breakState est SCHEDULED ou DECISIONED pour vérifier si tous les paramètres définis dans matchParams d'une coupure publicitaire correspondent à la coupure détectée. Une correspondance est établie si l'une des conditions suivantes est remplie : 1. L'insertion publicitaire comporte un champ "matchParams", et tous les paramètres qui y sont définis correspondent à la nouvelle insertion. 2. La coupure publicitaire est DECISIONED et ne comporte pas de champ matchParams.

Pour éviter tout comportement "tout correspond" accidentel (qui se produirait avec un matchParams vide, mais présent), matchParams ne peut pas être vide s'il est défini. Si le champ est présent dans une requête, au moins l'un de ses propres champs doit être défini.

Les coupures publicitaires sont vérifiées dans cet ordre : 1. avec matchParams, classées par ordre croissant de expectedStartTime, puis de createTime, où les coupures publicitaires sans expectedStartTime sont prioritaires lors du tri ; 2. sans matchParams, classées par ordre croissant de expectedStartTime, puis de createTime, où les coupures publicitaires sans expectedStartTime sont prioritaires lors du tri.

Si toutes les EABN en attente ne correspondent pas, la DAI reviendra au comportement de décision JIT en utilisant le prochain index de mid-roll disponible.
servedBreak

object (ServedBreak)

Uniquement en sortie. Cela reflète les informations réelles de la coupure publicitaire diffusée. Défini uniquement pour les coupures publicitaires avec un COMPLETE breakState.

BreakState

État d'une coupure publicitaire.

Enums
BREAK_STATE_UNSPECIFIED L'état de l'insertion publicitaire est inconnu.
BREAK_STATE_DECISIONED La décision concernant l'insertion publicitaire a été prise, mais n'a pas encore été communiquée aux utilisateurs.
BREAK_STATE_COMPLETE L'emplacement publicitaire a été diffusé auprès des utilisateurs.
BREAK_STATE_SCHEDULED La coupure publicitaire est programmée pour la prise de décision.
BREAK_STATE_EXPIRED La coupure publicitaire a expiré et ne peut pas être utilisée. Par défaut, les coupures publicitaires expirent 30 minutes après expectedStartTime ou 30 minutes après le début de la prise de décision concernant la coupure publicitaire si expectedStartTime n'est pas défini. Une date d'expiration peut être définie explicitement à l'aide du champ "expireDuration".

BreakParams

Paramètres associés à une coupure publicitaire.

Représentation JSON 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
Champs
macros[]

object (KeyValue)

Facultatif. Valeurs de macro personnalisées qui remplacent un espace réservé arbitraire dans le tag d'emplacement publicitaire. Au moment de la demande d'annonce, l'insertion dynamique d'annonces développe les macros de tag d'emplacement publicitaire au format %%DAI_PATTERN:[MACRO_KEY]%%, où MACRO_KEY est la clé.

Si elles sont définies, ces macros auront la priorité sur celles définies dans une demande de diffusion de pod.
adTagParams[]

object (KeyValue)

Facultatif. Remplace les paramètres du tag d'emplacement publicitaire dans la demande d'annonce principale.

Ils sont utilisés pour la prise de décision s'ils se déclenchent avant les requêtes de diffusion de pods avec des cust_params définis.

En général, les paramètres remplacent un paramètre de chaîne de requête dans la demande d'annonce principale pour l'insertion. Pour certains serveurs publicitaires avec des formats d'URL personnalisés, les paramètres peuvent remplacer des emplacements spécifiques dans le tag d'annonce afin de répondre aux exigences du serveur publicitaire. Si vous définissez la valeur "mridx" sur AdBreak, le champ breakSequence sera remplacé par la valeur fournie, à condition qu'il s'agisse d'un entier positif valide. Cela s'applique même aux ad servers autres que GAM.

Si ces paramètres sont définis, ils prévaudront sur ceux définis dans une requête de diffusion de pod.

KeyValue

Représente une paire clé-valeur.

Représentation JSON 
{
  "key": string,
  "value": string
}
Champs
key

string

Obligatoire. Clé de cette paire clé-valeur.
value

string

Obligatoire. Valeur de cette paire clé-valeur.

MatchParams

Paramètres à faire correspondre à une coupure publicitaire DAI assemblée détectée.

Représentation JSON 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
Champs
scte35Binary

string

Facultatif. Binaire SCTE-35. Pour que ce champ corresponde, la coupure publicitaire dans le fichier manifeste doit avoir la même chaîne binaire SCTE-35 (encodée en base64). Si ce champ est vide, il est ignoré.
scte35Upid

string

Facultatif. UPID (Unique Program Identifier) SCTE-35. Pour que ce champ corresponde, le point d'insertion publicitaire dans le fichier manifeste doit avoir le même UPID SCTE-35. L'UPID est une valeur analysée à partir du binaire SCTE-35. Si ce champ est vide, il est ignoré.
scte35EventId

integer (uint32 format)

Facultatif. ID d'événement SCTE-35. Pour que ce champ corresponde, le point d'insertion publicitaire dans le fichier manifeste doit avoir le même ID d'événement (ID d'événement d'insertion/ID d'événement de segmentation). L'ID d'événement est une valeur analysée à partir du binaire SCTE-35. Si ce champ est vide, il est ignoré.
breakDuration

boolean

Facultatif. Durée de la pause. Pour que ce champ corresponde, l'insertion publicitaire dans le fichier manifeste doit avoir la même durée que celle de expectedDuration de l'insertion publicitaire, avec une tolérance de 1 ms. Si la valeur est "false", cette étape est ignorée.

ServedBreak

Représente les informations réelles sur la coupure publicitaire diffusée.

Représentation JSON 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
Champs
breakDetectTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la coupure publicitaire correspondante est détectée. Pour la diffusion de pods, il s'agit du moment où le premier segment/manifeste du pod publicitaire est demandé. Pour l'insertion dynamique d'annonces assemblées, il s'agit du moment où la coupure publicitaire est détectée pour la première fois dans le fichier manifeste.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
detectedDuration

string (Duration format)

Uniquement en sortie. Durée détectée transmise à la coupure publicitaire correspondante.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
scte35CueOut

string

Uniquement en sortie. Le message SCTE-35 encodé en base64 détecté a été transmis à la coupure publicitaire correspondante.

Méthodes

create

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

delete

 API permettant de supprimer une coupure publicitaire dans la diffusion en direct.

get

 API permettant d'obtenir une coupure publicitaire dans la diffusion en direct.

list

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

patch

 API permettant de modifier une coupure publicitaire dans la diffusion en direct.