Method: partners.channels.list

Liste les canaux pour un partenaire ou un annonceur.

Requête HTTP

GET https://displayvideo.googleapis.com/v1/partners/{partnerId}/channels

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
partnerId

string (int64 format)

ID du partenaire auquel appartient les chaînes.

Paramètres de requête

Paramètres
pageSize

integer

Taille de la page demandée. Doit être compris entre 1 et 200. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. Renvoie le code d'erreur INVALID_ARGUMENT si une valeur non valide est spécifiée.
pageToken

string

Jeton identifiant une page de résultats que le serveur doit renvoyer. En règle générale, il s'agit de la valeur de nextPageToken renvoyée par l'appel précédent à la méthode channels.list. Si aucune valeur n'est spécifiée, la première page de résultats est renvoyée.
orderBy

string

Champ selon lequel la liste doit être triée. Les valeurs acceptées sont les suivantes :

  • displayName (par défaut)
  • channelId

Par défaut, l'ordre de tri est croissant. Pour indiquer un champ dans l'ordre décroissant, vous devez ajouter le suffixe " desc" au nom du champ. Exemple : displayName desc
filter

string

Permet de filtrer par champs de chaîne.

Syntaxe acceptée:

  • Les expressions de filtre pour le canal ne peuvent contenir qu'une restriction au maximum.
  • Une restriction se présente sous la forme {field} {operator} {value}.
  • Tous les champs doivent utiliser l'opérateur HAS (:).

Champs pris en charge:

  • displayName

Exemples :

  • Toutes les chaînes dont le nom à afficher contient "google": displayName : "google".

La longueur de ce champ ne doit pas dépasser 500 caractères.

Pour en savoir plus, consultez notre guide sur le filtrage des requêtes LIST.
advertiserId

string (int64 format)

ID de l'annonceur auquel appartiennent les chaînes.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de ListChannelsResponse.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/display-video

Pour en savoir plus, consultez la présentation d'OAuth 2.0.