FanFundingEvents: list

Nota: Este es un anuncio de baja.

La función Financiación de fans dejó de estar disponible y la API de Financiación de fans dejará de estar disponible el 28 de febrero de 2017. Este anuncio de baja coincide con el lanzamiento de la nueva función de YouTube, Super Chat.

Enumera los eventos de financiación de fans de un canal. El propietario del canal debe autorizar la solicitud a la API.

Solicitud

Solicitud HTTP

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

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

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 las partes del recurso fanFundingEvent que incluirá la respuesta de la API. Los valores admitidos son id y snippet.
Parámetros opcionales
hl string
El parámetro hl le indica a la API que recupere una string de visualización de moneda localizada para un idioma de aplicación compatible con el sitio web de YouTube específico. Por ejemplo, en inglés, la moneda se mostraría como $1.50, pero en francés se mostraría como 1,50$.

El valor del parámetro debe ser un código de idioma incluido en la lista que muestra el método i18nLanguages.list.
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 la página específica en el conjunto de resultados que se le solicita al servidor de la API que muestre. En una respuesta de la API, la propiedad nextPageToken identifica la siguiente página de resultados de la solicitud.

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#fanFundingEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    fanFundingEvent 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#fanFundingEventListResponse.
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.
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 eventos de financiación de fans 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) insufficientPermissions No tienes los permisos necesarios para ver los eventos de financiación de fans del canal.
invalidValue (400) fanFundingNotEnabledForChannelId El canal no tiene habilitada la financiación de fans.

Pruébela.

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.