Watermarks

Un recurso watermark identifica una imagen que se muestra durante la reproducción de los videos de un canal especificado. También puedes especificar un canal de destino al que vinculará la imagen, así como información de sincronización que determina cuándo aparece la marca de agua en las reproducciones de video y el período de tiempo que será visible.

Métodos

La API admite los siguientes métodos para los recursos watermarks:

set
Sube una imagen de marca de agua a YouTube y la configura para un canal.
unset
Borra la imagen de marca de agua de un canal. Pruébala ahora.

Representación de recursos

La siguiente estructura JSON muestra el formato de un recurso watermarks:

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

Propiedades

La siguiente tabla define las propiedades que aparecen en este recurso:

Propiedades
timing object
El objeto timing encapsula información sobre el momento durante la reproducción de un video en el que se mostrará la imagen de marca de agua de un canal. Este objeto es obligatorio cuando se llama a watermarks.set.
timing.type string
Es el método de sincronización que determina cuándo se muestra la imagen de marca de agua durante la reproducción del video. Esta propiedad es obligatoria cuando se llama a watermarks.set.

Los valores válidos son los siguientes:
  • offsetFromStart: El campo offsetMs representa un desplazamiento desde el inicio del video.
  • offsetFromEnd: El campo offsetMs representa un desplazamiento desde el final del video.
timing.offsetMs unsigned long
Es la compensación de tiempo, especificada en milisegundos, que determina cuándo aparece el elemento promocionado durante la reproducción de videos. Esta propiedad es obligatoria cuando se llama a watermarks.set. Cuando type es offsetFromEnd, offsetMs debe ser de al menos 1000 milisegundos.
timing.durationMs unsigned long
Es la cantidad de tiempo, en milisegundos, durante la que se debe mostrar la imagen de marca de agua. Esta propiedad es opcional. Si se especifica, la duración mínima es de 1000 milisegundos. Cuando type es offsetFromEnd, durationMs no debe superar offsetMs.
position object
Obsoleto: El objeto position está obsoleto y YouTube lo ignora. Las marcas de agua siempre se muestran en la esquina superior derecha del reproductor de video.
imageUrl string
Es la URL de la imagen de marca de agua del canal. YouTube generará esta URL y la devolverá en la respuesta de la API a una solicitud de watermark.set.
imageBytes bytes
Tamaño de la imagen de marca de agua, en bytes.
targetChannelId string
Es el ID del canal de YouTube al que se vincula la imagen de la marca de agua.