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 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/videos

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 `video` 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 `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écifiez exactement un des paramètres suivants)
`chart`	`string` Le paramètre `chart` identifie le graphique que vous souhaitez récupérer. Valeurs acceptées : `mostPopular` : affiche 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 des ID vidéo YouTube séparés par une virgule pour la ou les ressources à récupérer. 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 demande autorisée correctement. Définissez la valeur de ce paramètre sur `like` ou `dislike` pour indiquer à l'API de ne renvoyer que les vidéos "J'aime" ou "Je n'aime pas" par l'utilisateur authentifié. Les valeurs accepté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 "J'aime" de l'utilisateur authentifié.
Paramètres facultatifs
`hl`	`string` Le paramètre `hl` indique à l'API de récupérer les métadonnées localisées de ressources 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 sur la ressource localisée 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` contiendra 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 utiliser ce paramètre pour indiquer que le code d'intégration doit utiliser une hauteur adaptée à la mise en page de votre application au lieu des dimensions par défaut. 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 devant être renvoyés dans l'ensemble de résultats. Remarque:Ce paramètre peut être utilisé 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 utiliser ce paramètre 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` pour 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 demande autorisée correctement. 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é.
`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 pouvant être récupérées. Remarque:Ce paramètre peut être utilisé avec le paramètre `myRating`, mais pas avec le paramètre `id`.
`regionCode`	`string` Le paramètre `regionCode` demande à 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 est un code 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 d'API. La valeur est `youtube#videoListResponse`.
`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 vidéos correspondant 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
`badRequest (400)`	`videoChartNotFound`	Le graphique demandé pour la vidéo n'est pas compatible ou n'est pas disponible.
`forbidden (403)`	`forbidden`	La demande n'est pas autorisée à accéder au fichier vidéo ou aux informations de traitement. Notez que les parties `fileDetails`, `processingDetails` et `suggestions` ne sont disponibles que pour le propriétaire de cette vidéo.
`forbidden (403)`	`forbidden`	La requête ne peut pas accéder aux informations sur les notes des visiteurs. Cette erreur peut se produire si la requête n'est pas correctement autorisée à utiliser le paramètre `myRating`.
`notFound (404)`	`videoNotFound`	La vidéo que vous essayez de récupérer est introuvable. 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 et la réponse de l'API.