Method: customers.userLists.list

Elenca gli elenchi di utenti gestiti dal cliente Ads Data Hub specificato.

Richiesta HTTP

GET https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userLists

L'URL utilizza la sintassi gRPC Transcoding.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Nome risorsa cliente principale, ad esempio 'customers/123'.

Parametri di ricerca

Parametri
pageSize

integer

Numero massimo di articoli da restituire. Se il valore è 0, il server determinerà il numero di elenchi di utenti da restituire.
pageToken

string

Token di pagina, restituito da una chiamata precedente, utilizzato per richiedere la pagina di risultati successiva.
filter

string

Filtro di esempio: title = "user*" AND title = "*name*" AND -type = FREQUENCY_BASED AND createEmail = "creator@email.com" AND listSize > 10 AND popTime > "2012-04-2001
view

enum (UserListView)

Specifica i campi da includere in ogni elenco utente.
showDeleted

boolean

Se è impostata su true, gli elenchi di utenti eliminati verranno inclusi nella risposta.

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:

Risposta a una richiesta userLists.list. Contiene gli elenchi di utenti gestiti dal cliente Ads Data Hub specificato.

Rappresentazione JSON 
{
  "userLists": [
    {
      object (UserList)
    }
  ],
  "nextPageToken": string
}
Campi
userLists[]

object (UserList)

Un elenco di elenchi di utenti.
nextPageToken

string

Un token che può essere utilizzato per richiedere la pagina dei risultati successiva. Il campo è vuoto se non vengono restituiti risultati aggiuntivi.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/adsdatahub

Visualizzazione elenco utenti

Enumerazione per indicare quali campi includere in ogni elenco di utenti restituito dall'API [userLists.list].

Enum
USER_LIST_VIEW_UNSPECIFIED Il valore predefinito / non impostato. Per impostazione predefinita, l'API utilizza la visualizzazione COMPLETA.
BASIC Includi i campi tranne [recipientAdsDataLinks].
FULL Includi tutto.