activities.list
ne renvoie toujours pas de bulletins de canal, et la méthode activities.insert
n'est plus acceptée. Pour en savoir plus, consultez le Centre d'aide YouTube.
Affiche la liste des événements d'activité de la chaîne qui correspondent aux critères de la requête. Par exemple, vous pouvez récupérer les événements associés à un canal spécifique ou à sa propre chaîne.
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/activities
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 activity 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 activity , la propriété snippet contient d'autres propriétés qui identifient le type d'activité, un titre à afficher pour l'activité, etc. 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:
|
|
Filtres (spécifier exactement l'un des paramètres suivants) | ||
channelId |
string Le paramètre channelId spécifie un ID de chaîne YouTube unique. L'API renvoie ensuite la liste des activités de cette chaîne. |
|
home |
boolean Remarque : Ce paramètre est obsolète. Pour les requêtes qui définissent ce paramètre, la réponse de l'API contient des éléments semblables à ceux qu'un utilisateur déconnecté peut voir sur la page d'accueil YouTube. Notez que ce paramètre ne peut être utilisé que dans une requête correctement autorisée. |
|
mine |
boolean Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Définissez la valeur de ce paramètre sur true pour récupérer un flux des activités de l'utilisateur authentifié. |
|
Paramètres facultatifs | ||
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 . |
|
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. |
|
publishedAfter |
datetime Le paramètre publishedAfter spécifie la date et l'heure les plus anciennes auxquelles une activité aurait pu être incluse dans la réponse de l'API. Si la valeur du paramètre spécifie un jour, mais pas une heure, toutes les activités ayant eu lieu ce jour-là seront incluses dans l'ensemble de résultats. La valeur est spécifiée au format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ ). |
|
publishedBefore |
datetime Le paramètre publishedBefore spécifie la date et l'heure auxquelles une activité doit s'être produite pour qu'elle soit incluse dans la réponse de l'API. Si la valeur du paramètre spécifie un jour, mais pas une heure, toutes les activités ayant eu lieu ce jour-là seront exclues de l'ensemble de résultats. La valeur est spécifiée au format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ ). |
|
regionCode |
string Le paramètre regionCode indique à l'API de renvoyer les résultats pour le pays spécifié. La valeur du paramètre est un code pays ISO 3166-1 alpha-2. YouTube utilise cette valeur lorsque l'activité précédente de l'utilisateur autorisé sur YouTube ne fournit pas suffisamment d'informations pour générer le flux d'activités. |
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#activityListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ activity 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#activityListResponse . |
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 d'activités ou d'événements qui correspondent aux critères de la 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 |
---|---|---|
forbidden (403) |
forbidden |
La requête n'est pas correctement autorisée. |
forbidden (403) |
homeParameterDeprecated |
Les données de l'activité de la page d'accueil de l'utilisateur ne sont pas disponibles via cette API. Cette erreur peut se produire si vous avez défini le paramètre home sur true dans une requête non autorisée. |
notFound (404) |
channelNotFound |
L'ID de canal identifié par le paramètre channelId de la requête est introuvable. |
notFound (404) |
homeChannelNotFound |
Impossible de trouver le flux de la page d'accueil YouTube pour l'utilisateur actuellement authentifié. |
unauthorized (401) |
authorizationRequired |
La requête utilise le paramètre home , mais n'est pas correctement autorisée. |
Essayer
Utilisez APIs Explorer pour appeler cette API et afficher la requête API et la réponse.