Videos: list

Renvoie une liste de vidéos correspondant aux paramètres de la requête API.

Impact sur le quota : un appel à cette méthode coûte 1 unité de quota.

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 acceptés par cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
part string
Le paramètre part spécifie une liste de une ou plusieurs propriétés de ressource video séparées par une virgule que la réponse de l'API inclura.

Si le paramètre identifie une propriété contenant des propriétés enfants, ces dernières 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 part noms que vous pouvez inclure dans la valeur du paramètre :
  • brandPartner
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • paidProductPlacementDetails
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
Filtres (spécifiez exactement l'un des paramètres suivants)
chart string
Le paramètre chart identifie le graphique que vous souhaitez récupérer.

Les valeurs acceptables sont les suivantes :
id string
Le paramètre id spécifie une liste d'un ou plusieurs ID de vidéos YouTube séparés par une virgule 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 demander à l'API de ne renvoyer que les vidéos aimées ou non par l'utilisateur authentifié.



L'API limite l'ensemble de résultats renvoyés à un maximum de 1 000 vidéos. Même si la propriété pageInfo.totalResults de la réponse indique un total plus élevé, la pagination à l'aide du paramètre pageToken ne permet de récupérer que les 1 000 éléments les plus récents.



Le paramètre accepte les valeurs suivantes :

  • dislike : ne renvoie que les vidéos que l'utilisateur authentifié n'a pas aimées.
  • like : ne renvoie que les vidéos que l'utilisateur authentifié a aimées.
Paramètres facultatifs
hl string
Le paramètre hl demande à 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 i18nLanguages.list méthode.

Si des informations sur les ressources localisées sont disponibles dans cette langue, l'objet snippet.localized de la ressource contiendra les valeurs localisées. Toutefois, si aucune information localisée n'est disponible, l'objet snippet.localized contiendra des informations sur les ressources 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 spécifier que, 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 afin de ne pas dépasser la largeur maximale. Les valeurs acceptables sont comprises entre 72 et 8192 inclus.
maxResults unsigned integer
Le paramètre maxResults spécifie le nombre maximal d'éléments à renvoyer 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 acceptables sont comprises entre 1 et 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 spécifier que, 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 maxHeight est également fourni, le lecteur peut être plus étroit que maxWidth afin de ne pas dépasser la hauteur maximale. Les valeurs acceptables sont comprises entre 72 et 8192 inclus.
onBehalfOfContentOwner string
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Remarque : Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube.

Le onBehalfOfContentOwner paramètre indique que les identifiants d'autorisation de la requête identifient un utilisateur du CMS YouTube qui agit au nom du propriétaire du 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 YouTube différentes. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes leurs données de vidéos et de chaînes, 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 de l'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 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 de paramètre est un code pays ISO 3166-1 alpha-2.
videoCategoryId string
Le paramètre videoCategoryId identifie la catégorie de 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 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 vidéos 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 à 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 vidéo demandé n'est pas compatible ou n'est pas disponible.
forbidden (403) forbidden La requête n'est pas correctement autorisée à accéder aux informations sur le fichier vidéo ou le 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 l'évaluation de l'utilisateur. Cette erreur peut se produire, car 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 la valeur du paramètre id de la requête pour vous assurer qu'elle est correcte.

Essayer

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