Method: users.list

Elenca gli utenti accessibili all'utente corrente. Se due utenti hanno ruoli utente per lo stesso partner o inserzionista, possono accedere a vicenda.

Richiesta HTTP

GET https://displayvideo.googleapis.com/v1beta2/users

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di ricerca

Parametri
pageSize

integer

Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 100. Se non specificati, il valore predefinito sarà 100.
pageToken

string

Un token che identifica una pagina di risultati che il server deve restituire. In genere, si tratta del valore di nextPageToken restituito dalla precedente chiamata al metodo users.list. Se non specificato, verrà restituita la prima pagina di risultati.
orderBy

string

Campo in base al quale ordinare l'elenco. I valori accettati sono:

  • displayName (valore predefinito)

L'ordinamento predefinito è crescente. Per specificare l'ordine decrescente di un campo, aggiungi un suffisso "desc" al nome del campo. Ad esempio, displayName desc.
filter

string

Consente di filtrare in base alle proprietà utente.

Sintassi supportata:

  • Le espressioni di filtro sono composte da una o più limitazioni.
  • Le restrizioni possono essere combinate dall'operatore logico AND.
  • Una restrizione ha il seguente formato: {field} {operator} {value}.
  • L'operatore deve essere CONTAINS (:) o EQUALS (=).
  • L'operatore deve essere CONTAINS (:) per i seguenti campi:
    • displayName
    • email
  • L'operatore deve essere EQUALS (=) per i seguenti campi:
    • assignedUserRole.userRole
    • assignedUserRole.partnerId
    • assignedUserRole.advertiserId
    • assignedUserRole.entityType: un campo sintetico di AssignedUserRole utilizzato per i filtri. Identifica il tipo di entità a cui è assegnato il ruolo utente. I valori validi sono Partner e Advertiser.
    • assignedUserRole.parentPartnerId: un campo sintetico di AssignedUserRole utilizzato per i filtri. Identifica il partner principale dell'entità a cui è assegnato il ruolo utente."

Esempi:

  • L'utente con displayName contenente foo: displayName:"foo"
  • L'utente con indirizzo email contenente bar: email:"bar"
  • Tutti gli utenti con ruoli utente standard: assignedUserRole.userRole="STANDARD"
  • Tutti gli utenti con ruoli utente per il partner 123: assignedUserRole.partnerId="123"
  • Tutti gli utenti con ruoli utente per l'inserzionista 123: assignedUserRole.advertiserId="123"
  • Tutti gli utenti con ruoli utente a livello di partner: entityType="PARTNER"
  • Tutti gli utenti con ruoli utente per il partner 123 e gli inserzionisti nel partner 123: parentPartnerId="123"

La lunghezza di questo campo non deve superare i 500 caratteri.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

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

Rappresentazione JSON 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Campi
users[]

object (User)

L'elenco di utenti.

Questo elenco non sarà presente se vuoto.
nextPageToken

string

Un token per recuperare la pagina di risultati successiva. Passa questo valore nel campo pageToken nella chiamata successiva al metodo users.list per recuperare la pagina dei risultati successiva. Questo token non sarà presente se non ci sono altri risultati da restituire.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.