FanFundingEvents: list

Remarque : Ceci est une annonce d'abandon.

La fonctionnalité de financement par les fans a été abandonnée et l'API de financement par les fans sera désactivée le 28 février 2017. Cette annonce coïncide avec le lancement de la nouvelle fonctionnalité Super Chat de YouTube.

Répertorie les événements de financement par les fans d'une chaîne. La demande d'API doit être autorisée par le propriétaire de la chaîne.

Demande

Requête HTTP :

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

Autorisation

Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation

Portée
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

Paramètres

Le tableau suivant répertorie les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Réglages obligatoires
part string
Le paramètre part spécifie les parties de la ressource fanFundingEvent qui seront incluses dans la réponse de l'API. Les valeurs acceptées sont id et snippet.
Paramètres facultatifs
hl string
Le paramètre hl indique à l'API de récupérer une chaîne d'affichage de devise localisée pour une langue d'application spécifique compatible avec le site Web YouTube. Par exemple, en anglais, elle s'afficherait sous la forme $1.50, mais en français, elle serait affichée sous la forme 1,50$.

La valeur du paramètre doit être un code de langue inclus dans la liste renvoyée par la méthode i18nLanguages.list.
maxResults unsigned integer
Le paramètre maxResults spécifie le nombre maximal d'éléments à renvoyer dans l'ensemble de résultats. Les valeurs autorisées vont de 0 à 50, inclus. La valeur par défaut est 5.
pageToken string
Le paramètre pageToken identifie la page spécifique de l'ensemble de résultats que le serveur d'API doit renvoyer. Dans une réponse d'API, la propriété nextPageToken identifie la page de résultats suivante de la requête.

Corps de la requête

Ne fournissez pas de corps de requête lorsque vous appelez cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "kind": "youtube#fanFundingEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    fanFundingEvent resource
  ]
}

Propriétés

Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:

Propriétés
kind string
Identifie le type de ressource de l'API. La valeur sera youtube#fanFundingEventListResponse.
etag etag
ETag de cette ressource.
nextPageToken string
Jeton pouvant être utilisé comme valeur du paramètre pageToken pour extraire la page suivante de l'ensemble de résultats.
pageInfo object
L'objet pageInfo encapsule les informations de pagination pour l'ensemble de résultats.
pageInfo.totalResults integer
Nombre total de résultats dans l'ensemble de résultats.
pageInfo.resultsPerPage integer
Nombre de résultats inclus dans la réponse de l'API.
items[] list
Liste d'événements de financement par les fans correspondant aux critères de demande.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API pourrait renvoyer en réponse à un appel à cette méthode. Veuillez consulter la documentation sur les messages d'erreur pour en savoir plus.

Type d'erreur Détails de l'erreur Description
forbidden (403) insufficientPermissions Vous ne disposez pas des autorisations nécessaires pour afficher les événements de financement par les fans de la chaîne.
invalidValue (400) fanFundingNotEnabledForChannelId Le financement par les fans n'est pas activé sur la chaîne.

Essayer

Utilisez l'explorateur d'API pour appeler cette méthode sur des données réelles et afficher la requête API et la réponse.