PlaylistItems: update

Modifica un elemento de una lista de reproducción. Por ejemplo, puedes actualizar la posición del elemento en la lista de reproducción. Pruébalo ahora.

Solicitud

Solicitud HTTP

PUT https://www.googleapis.com/youtube/v3/playlistItems

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes alcances (obtén más información acerca de la autenticación y autorización).

Alcance
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube

Parámetros

La tabla a continuación muestra los parámetros compatibles con esta consulta. Todos los parámetros mencionados son parámetros de consulta.

Parámetros
Parámetros obligatorios
part string
El parámetro part sirve para dos propósitos en esta operación. Identifica las propiedades que establecerá la operación de escritura, así como las propiedades que incluirá la respuesta de la API.

Los nombres de part que se pueden incluir en el valor del parámetro son snippet, contentDetails y status.

Ten en cuenta que este método anulará los valores existentes para todas las propiedades que pueden modificarse que se encuentran en cualquiera de las partes que especifica el valor del parámetro. Por ejemplo, un elemento de la lista de reproducción puede especificar una hora de inicio y una hora de finalización, que identifican la porción de tiempo del video que se debe reproducir cuando los usuarios vean el video en la lista de reproducción. Si tu solicitud es la actualización de un elemento de la lista de reproducción que establece estos valores, y el valor del parámetro part de la solicitud incluye la par­te contentDetails, las horas de inicio y finalización del elemento de la lista de reproducción se actualizarán según el valor que especifica el cuerpo de la solicitud. Si el cuerpo de la solicitud no especifica valores, se eliminarán las horas de inicio y finalización existentes y se reemplazarán con la configuración predeterminada.

Cuerpo de la solicitud

Proporciona un recurso playlistItem en el cuerpo de la solicitud. Para ese recurso:

  • Debes especificar un valor para estas propiedades:

    • id
    • snippet.playlistId
    • snippet.resourceId

  • Puedes establecer los valores de las siguientes propiedades:

    • snippet.position
    • contentDetails.note
    • contentDetails.startAt
    • contentDetails.endAt

    Si envías una solicitud de actualización sin especificar un valor para una propiedad que ya tiene un valor, el valor actual de la propiedad se eliminará.

Respuesta

Si se aplica correctamente, este método muestra un recurso playlistItem en el cuerpo de la respuesta.

Errores

En la tabla a continuación se identifican los mensajes de error que la API podría mostrar en respuesta a una invocación a este método. Consulta la documentación sobre mensajes de error para obtener más información.

Tipo de error Detalle del error Descripción
invalidValue invalidPlaylistItemPosition La solicitud intenta establecer la posición del elemento de la lista de reproducción en un valor no válido o no admitido. Comprueba el valor de la propiedad de position en el snippet del recurso.
invalidValue invalidResourceType El type especificado para el ID de recurso no se admite en esta operación. El ID identifica el elemento que se agrega a la lista de reproducción, por ejemplo, youtube#video.
invalidValue invalidSnippet La solicitud no especifica una propiedad snippet válida.
notFound playlistItemNotFound No se puede encontrar el elemento identificado de la lista de reproducción con la propiedad id de la solicitud.
notFound playlistNotFound No se puede encontrar la lista de reproducción identificada con el parámetro playlistId de la solicitud.
required channelIdRequired La solicitud no especifica un valor para la propiedad channelId requerida.
required playlistIdRequired La solicitud no especifica un valor para la propiedad playlistId requerida.
required playlistItemIdRequired El recurso del elemento de la lista de reproducción especificado en la solicitud debe utilizar la propiedad id para identificar el elemento de la lista de reproducción que se está actualizando.

¡Pruébalo!

Utiliza el Explorador de la API para invocar este método con datos en directo y ver la solicitud y la respuesta de la API.