Sponsors: list

Remarque: Cette méthode est obsolète depuis le 31 mars 2020. Elle a été remplacée par la méthode members.list. Pour en savoir plus sur cette méthode, consultez la documentation de l'API YouTube Data.

La méthode sponsors.list ne sera plus disponible à partir du 30 septembre 2020. Les clients API doivent mettre à jour les appels à la méthode sponsors.list pour utiliser la méthode members.list à la place.

Liste les membres (anciennement appelés "sponsors") d'une chaîne. La requête API doit être autorisée par le propriétaire de la chaîne.

Cas d'utilisation courants

Requête

Requête HTTP

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

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

Champ d'application
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 répertoriés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
part string
Le paramètre part spécifie les parties de la ressource sponsor qui seront incluses dans la réponse de l'API. Les valeurs acceptées sont id et snippet.
Paramètres facultatifs
filter string
Le paramètre filter indique les sponsors de la chaîne à renvoyer. La valeur par défaut est newest.

Valeurs acceptées :
  • all : renvoie tous les soutiens, du plus récent au plus ancien.
  • newest : affiche la page des derniers sponsors. Les requêtes ultérieures utilisant nextPageToken récupèrent les nouveaux abonnés au fur et à mesure de leur inscription.
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 une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse de l'API, les propriétés nextPageToken et prevPageToken identifient d'autres pages qui peuvent être récupérées.

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#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor 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 d'API. La valeur est youtube#sponsorListResponse.
etag etag
Etag de cette ressource.
nextPageToken string
Jeton pouvant être utilisé comme valeur du paramètre pageToken pour récupérer la page suivante dans 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 de sponsors qui correspondent aux critères de la demande.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel de cette méthode. Pour en savoir plus, consultez la documentation sur les messages d'erreur.

Type d'erreur Détails de l'erreur Description
forbidden (403) insufficientPermissions Vous ne disposez pas des autorisations nécessaires pour afficher les sponsors de la chaîne.
invalidValue (400) invalidValueInRequest La requête contient une valeur non valide.
invalidValue (400) sponsorshipNotEnabledForChannelId Le sponsoring n'est pas activé sur cette chaîne.

Essayer

Utilisez APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.