Watermarks

Une ressource watermark identifie une image qui s'affiche lors de la lecture des vidéos d'une chaîne spécifiée. Vous pouvez également spécifier un canal cible vers lequel l'image sera redirigée, ainsi que des informations sur le timing qui déterminent quand le filigrane apparaît pendant la lecture de la vidéo et pendant combien de temps il est visible.

Méthodes

L'API accepte les méthodes suivantes pour les ressources watermarks :

set
Met en ligne une image de filigrane sur YouTube et la définit pour une chaîne.
unset
Supprime l'image de filigrane d'une chaîne. Essayer

Représentation de la ressource

La structure JSON ci-dessous montre le format d'une ressource watermarks :

{
  "timing": {
    "type": string,
    "offsetMs": unsigned long,
    "durationMs": unsigned long
  },
  "position": {
    "type": string,
    "cornerPosition": string
  },
  "imageUrl": string,
  "imageBytes": bytes,
  "targetChannelId": string
}

Propriétés

Le tableau suivant définit les propriétés qui apparaissent dans cette ressource :

Propriétés
timing object
L'objet timing contient des informations sur le moment où l'image du filigrane d'une chaîne s'affiche pendant la lecture d'une vidéo. Cet objet est obligatoire lorsque vous appelez watermarks.set.
timing.type string
Méthode de synchronisation qui détermine quand l'image du filigrane s'affiche pendant la lecture de la vidéo. Cette propriété est obligatoire lorsque vous appelez watermarks.set.

Les valeurs valides sont les suivantes :
  • offsetFromStart : le champ offsetMs représente un décalage par rapport au début de la vidéo.
  • offsetFromEnd : le champ offsetMs représente un décalage par rapport à la fin de la vidéo.
timing.offsetMs unsigned long
Décalage temporel, spécifié en millisecondes, qui détermine le moment où l'élément promu apparaît pendant la lecture de la vidéo. Cette propriété est obligatoire lorsque vous appelez watermarks.set. Lorsque type est défini sur offsetFromEnd, offsetMs doit être d'au moins 1000 millisecondes.
timing.durationMs unsigned long
Durée d'affichage de l'image en filigrane, en millisecondes. Cette propriété est facultative. Si elle est spécifiée, la durée minimale est de 1000 millisecondes. Lorsque type est défini sur offsetFromEnd, durationMs ne doit pas dépasser offsetMs.
position object
Obsolète : L'objet position est obsolète et ignoré par YouTube. Les filigranes s'affichent toujours en haut à droite du lecteur vidéo.
imageUrl string
URL de l'image du filigrane de la chaîne. YouTube générera cette URL et la renverra dans la réponse de l'API à une requête watermark.set.
imageBytes bytes
Taille de l'image en filigrane, en octets.
targetChannelId string
ID de la chaîne YouTube vers laquelle l'image du filigrane redirige.