Cette page a été traduite par l'API Cloud Translation.

Subscriptions: list

Affiche les ressources d'abonnement qui correspondent aux critères de requête API.

Impact sur les quotas:un appel à cette méthode entraîne un coût du quota de 1 unité.

Cas d'utilisation courants

Requête

Requête HTTP

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

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 une liste d'une ou de plusieurs propriétés de ressources `subscription` séparées par une virgule qui seront incluses dans la réponse de l'API. Si le paramètre identifie une propriété contenant des propriétés enfants, celles-ci seront incluses dans la réponse. Par exemple, dans une ressource `subscription`, la propriété `snippet` contient d'autres propriétés, telles qu'un titre à afficher pour l'abonnement. Si vous définissez `part=snippet`, la réponse de l'API contiendra également toutes ces propriétés imbriquées. La liste suivante contient les noms `part` que vous pouvez inclure dans la valeur du paramètre: `contentDetails` `id` `snippet` `subscriberSnippet`
Filtres (spécifiez exactement un des paramètres suivants)
`channelId`	`string` Le paramètre `channelId` spécifie un ID de chaîne YouTube. L'API affichera uniquement les abonnements de cette chaîne.
`id`	`string` Le paramètre `id` spécifie une liste des ID d'abonnement YouTube séparés par une virgule pour la ou les ressources en cours de récupération. Dans une ressource `subscription`, la propriété `id` spécifie l'ID d'abonnement YouTube.
`mine`	`boolean` Ce paramètre ne peut être utilisé que dans une demande autorisée correctement. Définissez la valeur de ce paramètre sur `true` pour récupérer un flux des abonnements de l'utilisateur authentifié.
`myRecentSubscribers`	`boolean` Ce paramètre ne peut être utilisé que dans une demande autorisée correctement. Définissez la valeur de ce paramètre sur `true` pour récupérer un flux des abonnés de l'utilisateur authentifié dans l'ordre chronologique inverse (le plus récent d'abord). Notez que le nombre maximal d'abonnés renvoyés via cette API peut être limité.
`mySubscribers`	`boolean` Ce paramètre ne peut être utilisé que dans une demande autorisée correctement. Définissez la valeur de ce paramètre sur `true` pour récupérer le flux des abonnés de l'utilisateur authentifié, sans ordre particulier. Notez que le nombre maximal d'abonnés renvoyés via cette API peut être limité.
Paramètres facultatifs
`forChannelId`	`string` Le paramètre `forChannelId` spécifie une liste d'ID de chaînes séparés par une virgule. La réponse de l'API ne contiendra alors que les abonnements correspondant à ces chaînes.
`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`.
`onBehalfOfContentOwner`	`string` Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube. Le paramètre `onBehalfOfContentOwner` indique que les identifiants d'autorisation de la demande identifient un utilisateur du CMS YouTube qui agit au nom du propriétaire de contenu spécifié dans la valeur du paramètre. Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent un grand nombre de chaînes YouTube. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes les données de leurs vidéos et de leur chaîne, sans avoir à fournir d'identifiants d'authentification pour chaque chaîne. Le compte CMS avec lequel l'utilisateur s'authentifie doit être associé au propriétaire de contenu YouTube spécifié.
`onBehalfOfContentOwnerChannel`	`string` Ce paramètre ne peut être utilisé que dans une demande autorisée correctement. Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube. Le paramètre `onBehalfOfContentOwnerChannel` spécifie l'ID de la chaîne YouTube à laquelle la vidéo est ajoutée. Ce paramètre est obligatoire lorsqu'une requête spécifie une valeur pour le paramètre `onBehalfOfContentOwner`. Il ne peut être utilisé qu'avec ce paramètre. En outre, la demande doit être autorisée à l'aide d'un compte CMS associé au propriétaire de contenu spécifié par le paramètre `onBehalfOfContentOwner`. Enfin, la chaîne indiquée par le paramètre `onBehalfOfContentOwnerChannel` doit être associée au propriétaire de contenu indiqué par le paramètre `onBehalfOfContentOwner`. Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent de nombreuses chaînes YouTube. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'effectuer des actions au nom de la chaîne spécifiée dans la valeur du paramètre, sans avoir à fournir d'identifiants d'authentification pour chaque canal.
`order`	`string` Le paramètre `order` spécifie la méthode qui sera utilisée pour trier les ressources dans la réponse de l'API. La valeur par défaut est `SUBSCRIPTION_ORDER_RELEVANCE`. Valeurs acceptées : `alphabetical` : tri par ordre alphabétique. `relevance` : tri par pertinence. `unread` : tri par ordre d'activité.
`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#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription 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#subscriptionListResponse`.
`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.
`prevPageToken`	`string` Jeton pouvant être utilisé comme valeur du paramètre `pageToken` pour récupérer la page précédente 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 des abonnements correspondant aux critères de la requête.

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)`	`accountClosed`	Impossible de récupérer les abonnements, car le compte de l'abonné est clôturé.
`forbidden (403)`	`accountSuspended`	Impossible de récupérer les abonnements, car le compte de l'abonné est suspendu.
`forbidden (403)`	`subscriptionForbidden`	Le demandeur n'est pas autorisé à accéder aux abonnements demandés.
`notFound (404)`	`subscriberNotFound`	L'abonné identifié avec la requête est introuvable.

Essayer

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