GuideCategories: list

Remarque:Il s'agit d'une annonce d'abandon.

La ressource guideCategories et la méthode guideCategories.list sont toutes deux obsolètes depuis le 9 septembre 2020.

Affiche une liste de catégories pouvant être associées à des chaînes YouTube.

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

Requête

Requête HTTP

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

Paramètres

Le tableau ci-dessous liste 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 propriétés de la ressource guideCategory qui seront incluses dans la réponse de l'API. Définissez la valeur du paramètre sur snippet.
Filtres (spécifiez exactement un des paramètres suivants)
id string
Le paramètre id spécifie une liste des ID de catégorie de chaîne YouTube séparés par une virgule pour la ou les ressources en cours de récupération. Dans une ressource guideCategory, la propriété id spécifie l'ID de la catégorie de chaîne YouTube.
regionCode string
Le paramètre regionCode indique à l'API de renvoyer la liste des catégories de guides disponibles dans le pays spécifié. La valeur du paramètre est un code pays ISO 3166-1 alpha-2.
Paramètres facultatifs
hl string
Le paramètre hl spécifie la langue à utiliser pour les valeurs textuelles dans la réponse de l'API. La valeur par défaut est en-US.

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#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategory 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#guideCategoryListResponse.
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 de catégories pouvant être associées à des chaînes YouTube. Dans ce mappage, l'ID de la catégorie est la clé de mappage et sa valeur est la ressource guideCategory correspondante.

Erreurs

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

Type d'erreur Détails de l'erreur Description
notFound (404) notFound La catégorie de guide identifiée par le paramètre id est introuvable. Utilisez la méthode guideCategories.list pour récupérer une liste de valeurs valides.

Essayer

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