Method: brands.agents.list

Elenca tutti gli agenti associati a un brand.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. L'identificatore univoco del brand. Se l'identificatore del brand è "1234", questo parametro si risolve in "brands/1234". L'identificatore del brand deve essere "-" per restituire tutti gli agenti di un corriere RBM.

Parametri di ricerca

Parametri
pageSize

integer

Specifica il numero massimo di risultati che il server deve restituire. Il server può limitare ulteriormente il numero massimo di risultati restituiti in una singola pagina. Se pageSize è 0, il server deciderà il numero di risultati da restituire.
pageToken

string

Il valore nextPageToken restituito da una precedente richiesta di elenco, se presente.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Un elenco di agenti.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "agents": [
    {
      object (Agent)
    }
  ],
  "nextPageToken": string
}
Campi
agents[]

object (Agent)

Elenco di informazioni sull'agente.
nextPageToken

string

Il token di impaginazione per recuperare la pagina successiva dei risultati. Se il valore è "", significa che non ci sono ulteriori risultati per la richiesta.