Method: customers.userLists.list

Répertorie les listes d'utilisateurs gérées par le client Ads Data Hub spécifié.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource cliente parente, par exemple 'customers/123'.

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal d'éléments à renvoyer. Si la valeur est 0, le serveur détermine le nombre de listes d'utilisateurs à afficher.

pageToken

string

Jeton de page, renvoyé par un appel précédent, utilisé pour demander la page de résultats suivante.

filter

string

Exemple de filtre: title = "user*" AND title = "*name*" AND -type = FREQUENCY_BASED AND createEmail = "creator@email.com" AND listSize > 10 AND insertTime > "2012-04-21T11:30:00:2;

view

enum (UserListView)

Indique les champs à inclure dans chaque liste d'utilisateurs.

showDeleted

boolean

S'il est défini sur "true", les listes d'utilisateurs supprimés seront incluses dans la réponse.

Corps de la requête

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

Corps de la réponse

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

Réponse à une requête userLists.list. Contient les listes d'utilisateurs gérées par le client Ads Data Hub spécifié.

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

object (UserList)

Liste de listes d'utilisateurs.

nextPageToken

string

Jeton permettant de demander la page de résultats suivante. Ce champ est vide s'il n'y a pas de résultats supplémentaires.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Vue de la liste d'utilisateurs

Énumération indiquant les champs à inclure dans chaque liste d'utilisateurs renvoyée par l'API [userLists.list].

Enums
USER_LIST_VIEW_UNSPECIFIED Valeur par défaut / non définie. L'API affiche par défaut la vue COMPLÈTE.
BASIC Inclure des champs, sauf [recipientAdsDataLinks].
FULL Tout inclure.