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 |
objectEl 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. |
timing.type |
stringEs el método de sincronización que determina cuándo se muestra la imagen de marca de agua durante la reproducción del video. Si el valor es offsetFromStart, el campo offsetMs representa una compensación desde el inicio del video. Si el valor es offsetFromEnd, el campo offsetMs representa un desplazamiento desde el final del video. |
timing.offsetMs |
unsigned longEs la compensación de tiempo, especificada en milisegundos, que determina cuándo aparece el elemento promocionado durante la reproducción de videos. El valor de la propiedad type determina si la compensación se mide desde el inicio o el final del video. |
timing.durationMs |
unsigned longEs la cantidad de tiempo, en milisegundos, durante la que se debe mostrar la imagen de marca de agua. |
position |
objectEl objeto position encapsula información sobre la posición espacial dentro del video en la que se mostrará la imagen de marca de agua. |
position.type |
stringEs la forma en que se posiciona el elemento promocionado en el reproductor de video. Los valores válidos para esta propiedad son los siguientes:
|
position.cornerPosition |
stringEs la esquina del reproductor en la que aparecerá el elemento promocionado. El elemento siempre aparece en la esquina superior derecha del reproductor. Los valores válidos para esta propiedad son los siguientes:
|
imageUrl |
stringEs 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 watermark.set. |
imageBytes |
bytesTamaño de la imagen de marca de agua, en bytes. |
targetChannelId |
stringEs el ID del canal de YouTube al que se vincula la imagen de la marca de agua. |