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

Videos: list

Renvoie une liste de vidéos qui correspondent aux paramètres de requête de l'API.

Impact du quota : un appel à cette méthode a un coût de quota de 1 unité.

Cas d'utilisation courants

Demande

Requête HTTP :

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

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 une liste d'une ou de plusieurs propriétés de ressources `video` 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 `video`, la propriété `snippet` contient les propriétés `channelId`, `title`, `description`, `tags` et `categoryId`. Par conséquent, si vous définissez `part=snippet`, la réponse de l'API contiendra toutes ces propriétés. La liste suivante contient les noms `part` que vous pouvez inclure dans la valeur du paramètre : `contentDetails` `fileDetails` `id` `liveStreamingDetails` `localizations` `player` `processingDetails` `recordingDetails` `snippet` `statistics` `status` `suggestions` `topicDetails`
Filtres (spécifier exactement l'un des paramètres suivants)
`chart`	`string` Le paramètre `chart` identifie le graphique que vous souhaitez récupérer. Les valeurs autorisées sont les suivantes : `mostPopular` : renvoie les vidéos les plus populaires pour la région de contenu et la catégorie de vidéo spécifiées.
`id`	`string` Le paramètre `id` spécifie une liste d'ID vidéo YouTube séparés par des virgules pour les ressources récupérées. Dans une ressource `video`, la propriété `id` spécifie l'ID de la vidéo.
`myRating`	`string` Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Définissez la valeur de ce paramètre sur `like` ou `dislike` pour indiquer à l'API de ne renvoyer que les vidéos que l'utilisateur authentifié aime ou n'aime pas. Les valeurs autorisées sont les suivantes : `dislike` : renvoie uniquement les vidéos que l'utilisateur authentifié n'a pas aimées. `like` : renvoie uniquement la vidéo que l'utilisateur authentifié aime.
Paramètres facultatifs
`hl`	`string` Le paramètre `hl` indique à l'API de récupérer les métadonnées de ressources localisées pour une langue d'application spécifique compatible avec le site Web YouTube. La valeur du paramètre doit être un code de langue inclus dans la liste renvoyée par la méthode `i18nLanguages.list`. Si des détails de ressource localisés sont disponibles dans cette langue, l'objet `snippet.localized` de la ressource contiendra les valeurs localisées. Toutefois, si les détails localisés ne sont pas disponibles, l'objet `snippet.localized` contient les détails de la ressource dans la langue par défaut de la ressource.
`maxHeight`	`unsigned integer` Le paramètre `maxHeight` spécifie la hauteur maximale du lecteur intégré renvoyé dans la propriété `player.embedHtml`. Vous pouvez l'utiliser pour indiquer qu'au lieu des dimensions par défaut, le code d'intégration doit utiliser une hauteur adaptée à la mise en page de votre application. Si le paramètre `maxWidth` est également fourni, le lecteur peut être plus court que `maxHeight` pour respecter la largeur maximale. Les valeurs autorisées vont de `72` à `8192`, inclus.
`maxResults`	`unsigned integer` Le paramètre `maxResults` indique le nombre maximal d'éléments qui doivent être renvoyés dans l'ensemble de résultats. Remarque:Ce paramètre peut être utilisé conjointement avec le paramètre `myRating`, mais pas avec le paramètre `id`. Les valeurs autorisées vont de `1` à `50`, inclus. La valeur par défaut est `5`.
`maxWidth`	`unsigned integer` Le paramètre `maxWidth` spécifie la largeur maximale du lecteur intégré renvoyé dans la propriété `player.embedHtml`. Vous pouvez l'utiliser pour indiquer qu'au lieu des dimensions par défaut, le code d'intégration doit utiliser une largeur adaptée à la mise en page de votre application. Si le paramètre `maxHeight` est également fourni, la largeur du lecteur peut être inférieure à `maxWidth` afin de respecter la hauteur maximale. Les valeurs autorisées vont de `72` à `8192`, inclus.
`onBehalfOfContentOwner`	`string` Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Remarque : Ce paramètre est réservé 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 de nombreuses chaînes différentes. Elle 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 pour chaque chaîne. Le compte CMS avec lequel l'utilisateur s'authentifie doit être associé au propriétaire de contenu YouTube spécifié.
`pageToken`	`string` Le paramètre `pageToken` identifie une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse d'API, les propriétés `nextPageToken` et `prevPageToken` identifient d'autres pages qui pourraient être récupérées. Remarque : Ce paramètre peut être utilisé conjointement avec le paramètre `myRating`, mais pas avec le paramètre `id`.
`regionCode`	`string` Le paramètre `regionCode` indique à l'API de sélectionner un graphique vidéo disponible dans la région spécifiée. Ce paramètre ne peut être utilisé qu'avec le paramètre `chart`. La valeur du paramètre correspond à un code de pays ISO 3166-1 alpha-2.
`videoCategoryId`	`string` Le paramètre `videoCategoryId` identifie la catégorie de la vidéo pour laquelle le graphique doit être récupéré. Ce paramètre ne peut être utilisé qu'avec le paramètre `chart`. Par défaut, les graphiques ne sont pas limités à une catégorie particulière. La valeur par défaut est `0`.

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#videoListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    video 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#videoListResponse`.
`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.
`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 vidéos correspondant aux critères de requête.

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
`badRequest (400)`	`videoChartNotFound`	Le graphique vidéo demandé n'est pas compatible ou n'est pas disponible.
`forbidden (403)`	`forbidden`	La demande n'est pas correctement autorisée à accéder au fichier vidéo ou à traiter les informations. Sachez que les parties `fileDetails`, `processingDetails` et `suggestions` ne sont disponibles que pour le propriétaire de cette vidéo.
`forbidden (403)`	`forbidden`	La demande ne peut pas accéder aux informations sur les notes des utilisateurs. Cette erreur peut se produire si la requête n'est pas correctement autorisée à utiliser le paramètre `myRating`.
`notFound (404)`	`videoNotFound`	Impossible de trouver la vidéo que vous essayez de récupérer. Vérifiez que la valeur du paramètre `id` de la requête est correcte.

Essayer

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