Activities: list

YouTube dejó de estar disponible la función de boletín de canal. El método activities.list aún no muestra boletines de canales, y ya no se admite el método activities.insert. Para obtener más información, consulta el Centro de ayuda de YouTube.

Muestra una lista de eventos de actividad del canal que cumplen con los criterios de la solicitud. Por ejemplo, puedes recuperar eventos asociados con un canal en particular o con el propio canal del usuario.

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

Casos de uso habituales

Solicitud

Solicitud HTTP

GET https://www.googleapis.com/youtube/v3/activities

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 especifica una lista separada por comas de una o más propiedades de recursos de activity que la respuesta de la API va a incluir.

Si el parámetro identifica una propiedad que contiene propiedades secundarias, las propiedades secundarias se incluirán en la respuesta. Por ejemplo, en un recurso activity, la propiedad snippet contiene otras propiedades que identifican el tipo de actividad, un título visible para la actividad, etc. Si configuras part=snippet, la respuesta de la API también contendrá todas esas propiedades anidadas.

La siguiente lista contiene los nombres de part que puedes incluir en el valor del parámetro:
  • contentDetails
  • id
  • snippet
Filtros (especifica exactamente uno de los siguientes parámetros)
channelId string
El parámetro channelId especifica un ID de canal de YouTube único. Luego, la API muestra una lista de las actividades de ese canal.
home boolean
Nota: Este parámetro es obsoleto.
En el caso de las solicitudes que establecen este parámetro, la respuesta de la API contiene elementos similares a los que vería un usuario desconectado en la página principal de YouTube. Ten en cuenta que este parámetro solo se puede utilizar en una solicitud autorizada debidamente.
mine boolean
Este parámetro solo se puede utilizar en una solicitud autorizada debidamente. Establece el valor de este parámetro en true para recuperar un feed de las actividades del usuario autenticado.
Parámetros opcionales
maxResults unsigned integer
El parámetro maxResults especifica la cantidad máxima de elementos que se deben mostrar en el conjunto de resultados. Los valores aceptables son 0 a 50, ambos inclusive. El valor predeterminado es 5.
pageToken string
El parámetro pageToken identifica una página específica en el conjunto de resultados que se debe mostrar. En una respuesta de la API, las propiedades nextPageToken y prevPageToken identifican otras páginas que se podrían recuperar.
publishedAfter datetime
El parámetro publishedAfter especifica la fecha y hora más tempranas en las que una actividad podría haber ocurrido para que la actividad se incluya en la respuesta de la API. Si el valor del parámetro especifica un día, pero no una hora, entonces las actividades que se produjeron ese día se incluirán en el conjunto de resultados. El valor se especifica en el formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
publishedBefore datetime
El parámetro publishedBefore especifica la fecha y hora antes de las que debe ocurrir una actividad para que esta se incluya en la respuesta de la API. Si el valor del parámetro especifica un día, pero no una hora, entonces todas las actividades que se produjeron ese día se excluirán del conjunto de resultados. El valor se especifica en el formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
regionCode string
El parámetro regionCode le indica a la API que muestre los resultados para el país especificado. El valor del parámetro es un código de país ISO 3166-1 alpha-2. YouTube utiliza este valor cuando la actividad anterior del usuario autorizado en YouTube no proporciona suficiente información para generar el feed de actividad.

Cuerpo de la solicitud

No proporciones un cuerpo de solicitud cuando invoques este método.

Respuesta

Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:

{
  "kind": "youtube#activityListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    activity Resource
  ]
}

Propiedades

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

Propiedades
kind string
Identifica el tipo de recurso de API. El valor será youtube#activityListResponse.
etag etag
Es la Etag de este recurso.
nextPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la página siguiente en el conjunto de resultados.
prevPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la página anterior en el conjunto de resultados.
pageInfo object
El objeto pageInfo encapsula la información de paginación del conjunto de resultados.
pageInfo.totalResults integer
La cantidad total de resultados en el conjunto de resultados.
pageInfo.resultsPerPage integer
Es la cantidad de resultados incluidos en la respuesta de la API.
items[] list
Lista de actividades o eventos que coinciden con los criterios de la solicitud.

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) forbidden La solicitud no está debidamente autorizada.
forbidden (403) homeParameterDeprecated Los datos de la actividad de la página principal del usuario no están disponibles a través de esta API. Este error puede ocurrir si configuras el parámetro home como true en una solicitud no autorizada.
notFound (404) channelNotFound No se puede encontrar el ID del canal identificado por el parámetro channelId de la solicitud.
notFound (404) homeChannelNotFound No se puede encontrar un feed de página principal de YouTube para el usuario autenticado actualmente.
unauthorized (401) authorizationRequired La solicitud usa el parámetro home, pero no está debidamente autorizado.

Pruébela.

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