Method: users.list

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

Questo metodo ha requisiti di autenticazione unici. Prima di utilizzare questo metodo, leggi i prerequisiti nella nostra guida alla gestione degli utenti.

La funzionalità "Prova questo metodo" non funziona per questo metodo.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
pageSize

integer

Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 200. Se non specificato, il valore predefinito è 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 chiamata precedente 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 accettabili sono:

  • displayName (valore predefinito)

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

string

Consente di filtrare in base ai campi utente.

Sintassi supportata:

  • Le espressioni di filtro sono composte da una o più limitazioni.
  • Le limitazioni possono essere combinate con l'operatore logico AND.
  • Una restrizione ha la forma {field} {operator} {value}.
  • I campi displayName e email devono utilizzare l'operatore HAS (:).
  • Il campo lastLoginTime deve utilizzare l'operatore LESS THAN OR EQUAL TO (<=) o GREATER THAN OR EQUAL TO (>=).
  • Tutti gli altri campi devono utilizzare l'operatore EQUALS (=).

Campi supportati:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: questo è il 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: si tratta di un campo sintetico di AssignedUserRole utilizzato per i filtri. Identifica il partner principale dell'entità a cui è assegnato il ruolo utente.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (da inserire nel formato ISO 8601 o YYYY-MM-DDTHH:MM:SSZ)

Esempi:

  • L'utente con displayName contenente "foo": displayName:"foo"
  • L'utente con 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 del partner 123: parentPartnerId="123"
  • Tutti gli utenti che hanno eseguito l'accesso per l'ultima volta il giorno 01-01-2023T00:00:00Z o in una data successiva (formato ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

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

Per saperne di più, consulta la nostra guida su come filtrare le richieste LIST.

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 di 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 sezione OAuth 2.0 Overview.