Method: brands.agents.list

Répertorie tous les agents associés à une marque.

Requête HTTP

GET https://businesscommunications.googleapis.com/v1/{parent=brands/*}/agents

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Identifiant unique de la marque. Si l'identifiant de marque est "1234", ce paramètre correspond à "marques/1234". L'identifiant de marque doit être "-" pour renvoyer tous les agents d'un transporteur RBM.

Paramètres de requête

Paramètres
pageSize

integer

Spécifiez le nombre maximal de résultats à renvoyer par le serveur. Le serveur peut également limiter le nombre maximal de résultats renvoyés sur une seule page. Si la valeur de pageSize est de 0, le serveur décide du nombre de résultats à renvoyer.

pageToken

string

La valeur nextPageToken affichée par une requête "List" antérieure, le cas échéant.

Corps de la requête

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

Corps de la réponse

Une liste d'agents

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

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

object (Agent)

Liste d'informations sur l'agent.

nextPageToken

string

Jeton de pagination pour récupérer la page de résultats suivante. Si la valeur est "", cela signifie qu'il n'y a plus aucun résultat pour la requête.