Method: partners.list

Liste les partenaires accessibles à l'utilisateur actuel.

L'ordre est défini par le paramètre orderBy.

Requête HTTP

GET https://displayvideo.googleapis.com/v2/partners

L'URL utilise la syntaxe de transcodage gRPC.

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.
pageToken

string

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

string

Champ selon lequel trier la liste. Les valeurs acceptées sont les suivantes :

  • displayName

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

string

Permet de filtrer par champs de partenaire.

Syntaxe acceptée:

  • Les expressions de filtre sont constituées d'une ou de plusieurs restrictions.
  • Les restrictions peuvent être combinées par les opérateurs logiques AND ou OR. Une séquence de restrictions utilise implicitement AND.
  • Une restriction se présente sous la forme {field} {operator} {value}.
  • Tous les champs doivent utiliser l'opérateur EQUALS (=).

Champs acceptés:

  • entityStatus

Exemples :

  • Tous les partenaires actifs: entityStatus="ENTITY_STATUS_ACTIVE"

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

Pour en savoir plus, consultez notre guide sur les requêtes LIST de filtrage.

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 des données présentant la structure suivante :

Représentation JSON 
{
  "partners": [
    {
      object (Partner)
    }
  ],
  "nextPageToken": string
}
Champs
partners[]

object (Partner)

Liste des partenaires.

Si cette liste est vide, elle sera absente.
nextPageToken

string

Jeton permettant de récupérer la page de résultats suivante. Transmettez cette valeur dans le champ pageToken lors de l'appel suivant de la méthode partners.list pour récupérer la page de résultats suivante.

Champs d'application 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.