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.

Impacto en la cuota: Una llamada a este método tiene un costo de cuota de 50 unidades.

Casos de uso habituales

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
https://www.googleapis.com/auth/youtube.force-ssl

Parámetros

En la siguiente tabla, se enumeran los parámetros que admite esta consulta. Todos los parámetros mencionados son parámetros de consulta.

Parámetros
Parámetros obligatorios
part string
El parámetro part tiene 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.

Ten en cuenta que este método anulará los valores existentes de todas las propiedades mutables que se incluyan en las partes que especifique 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 actualiza un elemento de la lista de reproducción que establece estos valores y el valor del parámetro part de la solicitud incluye la parte contentDetails, las horas de inicio y finalización del elemento de la lista de reproducción se actualizarán al valor que especifique el cuerpo de la solicitud. Si el cuerpo de la solicitud no especifica valores, se quitarán las horas de inicio y finalización existentes y se reemplazarán por la configuración predeterminada.

La siguiente lista contiene los nombres part que puedes incluir en el valor del parámetro:
  • contentDetails
  • id
  • snippet
  • status
Parámetros opcionales
onBehalfOfContentOwner string
Nota: El onBehalfOfContentOwner parámetro está destinado exclusivamente a los socios de contenido de YouTube y solo se puede usar en una solicitud autorizada correctamente.

Este parámetro está diseñado para los socios de contenido de YouTube que poseen y administran muchos canales diferentes de YouTube. Permite que los usuarios afiliados al propietario del contenido se autentiquen una vez y, luego, puedan acceder a todos los datos de video y del canal del propietario del contenido y administrarlos sin tener que proporcionar credenciales de autenticación para cada canal individual.

Cuando el parámetro está presente, su valor identifica a un propietario del contenido, y las credenciales de autorización de la solicitud identifican a un usuario de YouTube que está autorizado para actuar en nombre de ese propietario del contenido. La cuenta con la que se autentica el usuario debe estar vinculada al propietario del contenido especificado en la configuración de YouTube Creator Studio.

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 siguiente tabla, se identifican los mensajes de error que la API podría mostrar en respuesta a una llamada 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
forbidden (403) playlistItemsNotAccessible La solicitud no está autorizada correctamente para actualizar el elemento de la lista de reproducción especificado.
invalidValue (400) 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. Verifica el valor de la propiedad position en el snippet del recurso.
invalidValue (400) invalidResourceType El type especificado para el ID del recurso no es compatible con esta operación. El ID del recurso identifica el elemento que se agrega a la lista de reproducción, p.ej., youtube#video.
invalidValue (400) invalidSnippet La solicitud no especifica una propiedad snippet válida.
invalidValue (400) manualSortRequired La solicitud intenta establecer la posición del elemento de la lista de reproducción, pero la lista de reproducción no usa la clasificación manual. (Por ejemplo, los elementos de la lista de reproducción se pueden ordenar por fecha o popularidad). Para solucionar el error, quita el elemento snippet.position del recurso que inserta la solicitud. Si quieres que el elemento de la lista de reproducción tenga una posición determinada en la lista, primero debes actualizar la opción Orden de la lista de reproducción a Manual en la configuración de la lista de reproducción. Esta configuración se puede ajustar en el Administrador de videos de YouTube.
notFound (404) playlistItemNotFound No se puede encontrar el elemento de la lista de reproducción identificado con la propiedad id de la solicitud.
notFound (404) playlistNotFound No se puede encontrar la lista de reproducción identificada con el parámetro playlistId de la solicitud.
required (400) channelIdRequired La solicitud no especifica un valor para la propiedad obligatoria channelId.
required (400) playlistIdRequired La solicitud no especifica un valor para la propiedad obligatoria playlistId.
required (400) playlistItemIdRequired El recurso del elemento de la lista de reproducción especificado en la solicitud debe usar la propiedad id para identificar el elemento de la lista de reproducción que se está actualizando.
invalidValue (400) playlistOperationUnsupported La API no admite la capacidad de actualizar videos en la lista de reproducción especificada. Por ejemplo, no puedes actualizar un video en tu lista de reproducción de videos subidos.

Pruébalo

Usa el APIs Explorer para llamar a esta API y ver la solicitud a la API y la respuesta.