Groups: list

Muestra una lista de grupos que coinciden con los parámetros de solicitud de la API. Por ejemplo, puedes recuperar todos los grupos que posee el usuario autenticado o puedes recuperar uno o más grupos por sus IDs únicos.

Solicitud

Solicitud HTTP

GET https://youtubeanalytics.googleapis.com/v2/groups

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

Permisos
https://www.googleapis.com/auth/yt-analytics.readonly Permite ver informes de YouTube Analytics sobre tu contenido de YouTube. Este alcance proporciona acceso a las métricas de actividad del usuario, como el número de reproducciones y de calificaciones.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Permite ver informes monetarios de YouTube Analytics sobre tu contenido de YouTube. Este permiso proporciona acceso a las métricas de actividad del usuario, así como a las métricas de ingresos estimados y rendimiento de los anuncios.
https://www.googleapis.com/auth/youtube Permite administrar tu cuenta de YouTube. En la API de YouTube Analytics, los propietarios de canales usan este permiso para administrar los grupos y los elementos de YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner Ver y administrar los recursos de YouTube y el contenido asociado en YouTube En la API de YouTube Analytics, los propietarios de contenido usan este permiso para administrar los grupos y los elementos de grupo de YouTube Analytics.

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
Filtros (especifica exactamente uno de los siguientes parámetros)
id string
El parámetro id especifica una lista separada por comas de los IDs de grupo de YouTube para los recursos que se recuperan. Cada grupo debe ser propiedad del usuario autenticado. En un recurso group, la propiedad id especifica el ID del grupo de YouTube.

Ten en cuenta que, si no especificas un valor para el parámetro id, debes establecer el parámetro mine en true.
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 todos los grupos que pertenecen al usuario autenticado.
Parámetros opcionales
onBehalfOfContentOwner string
Este parámetro solo se puede usar en una solicitud autorizada correctamente. Nota: Este parámetro está destinado exclusivamente a los socios de contenido de YouTube que poseen y administran muchos canales de YouTube diferentes.

El parámetro onBehalfOfContentOwner indica que las credenciales de autorización de la solicitud identifican a un usuario de YouTube que actúa en nombre del propietario del contenido especificado en el valor del parámetro. Permite a los propietarios de contenido autenticarse una vez y acceder a todos los datos de sus videos y canales, sin tener que proporcionar credenciales de autenticación para cada canal. La cuenta con la que se autentica el usuario debe estar vinculada al propietario del contenido de YouTube especificado.
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, la propiedad nextPageToken identifica la siguiente página que se puede recuperar.

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#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

Propiedades

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

Propiedades
kind string
Identifica el tipo de recurso de la API. El valor será youtube#groupListResponse.
etag etag
Es la etiqueta de Etag de este recurso.
items[] list
Es una lista de grupos que coinciden con los parámetros de solicitud de la API. Cada elemento de la lista representa un recurso group.
nextPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la siguiente página del conjunto de resultados.

Errores

La API no define ningún mensaje de error exclusivo de este método de la API. Sin embargo, este método aún podría mostrar errores generales de la API que se indican en la documentación del mensaje de error.

Pruébalo

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