Activities: list

Muestra una lista de eventos de actividad del canal que cumplen con los criterios de la solicitud. Por ejemplo, puedes recuperar los eventos asociados a un canal en particular, los eventos relacionados con las suscripciones y los amigos de Google+ del usuario, o el feed de la página principal de YouTube, que personalizó para cada usuario. Pruébalo ahora.

Solicitud

Solicitud HTTP

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

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 especifica una lista separada por comas de una o más propiedades de recursos de activity que la respuesta de API va a incluir. Los nombres de part que se pueden incluir en el valor del parámetro son id, snippet y contentDetails.

Si el parámetro identifica una propiedad que contiene propiedades secundarias, estas se incluirán en la respuesta. Por ejemplo, en un recurso de activity, la propiedad snippet contiene otras propiedades que identifican el tipo de actividad, un título para mostrar para la actividad, y así sucesivamente. Si estableces part=snippet, la respuesta de la API también contendrá todas esas propiedades anidadas.
Filtros (especifica exactamente uno de los siguientes parámetros)
channelId string
El parámetro channelId especifica un ID de canal de YouTube exclusivo. Al establecerlo, la API muestra las actividades de ese canal.
home boolean
Este parámetro solo se puede utilizar en una solicitud autorizada debidamente. Establece el valor de este parámetro en true para recuperar el feed de actividad que se muestra en la página principal de YouTube para el usuario autenticado actualmente.
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 el número máximo 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 primera fecha y hora en la 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 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
Tipo de recurso de la API. El valor será youtube#activityListResponse.
etag etag
Etag de este recurso.
nextPageToken string
Token que se puede utilizar como valor del parámetro pageToken para recuperar la página siguiente en el conjunto de resultados.
prevPageToken string
Token que se puede utilizar como valor del parámetro pageToken para recuperar la página anterior en el conjunto de resultados.
pageInfo object
El objeto pageInfo contiene información de paginación para el conjunto de resultados de búsqueda.
pageInfo.totalResults integer
Número total de resultados en el conjunto de resultados.
pageInfo.resultsPerPage integer
Número 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 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
notFound channelNotFound No se puede encontrar el ID del canal identificado por el parámetro channelId de la solicitud.
notFound homeChannelNotFound No se puede encontrar un feed de página principal de YouTube para el usuario autenticado actualmente.
unauthorized authorizationRequired La solicitud utiliza el parámetro home, pero no está debidamente autorizado.

¡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.