Method: properties.list

Renvoie les propriétés enfants sous le compte parent spécifié.

Les propriétés seront exclues si l'appelant n'y a pas accès. Les propriétés supprimées de façon réversible (c'est-à-dire placées dans la corbeille) sont exclues par défaut. Renvoie une liste vide si aucune propriété pertinente n'est trouvée.

Requête HTTP

GET https://analyticsadmin.googleapis.com/v1alpha/properties

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
filter

string

Obligatoire. Expression pour filtrer les résultats de la requête. Les champs pouvant être filtrés sont les suivants : parent:(nom de ressource du compte/de la propriété parent), ancestor:(nom de ressource du compte parent) ou firebase_project:(ID ou numéro du projet Firebase associé). Voici quelques exemples de filtres :

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
pageSize

integer

Facultatif. Nombre maximal de ressources à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur, même s'il existe d'autres pages. Si aucune valeur n'est spécifiée, 50 ressources au maximum sont renvoyées. La valeur maximale est de 200 (les valeurs supérieures seront ramenées à la valeur maximale).

pageToken

string

Facultatif. Jeton de page reçu d'un appel properties.list précédent. Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis à properties.list doivent correspondre à l'appel ayant fourni le jeton de page.

showDeleted

boolean

Indique s'il faut inclure les propriétés supprimées de façon réversible (c'est-à-dire mises à la corbeille) dans les résultats. Vous pouvez inspecter les propriétés pour déterminer si elles ont été supprimées ou non.

Corps de la requête

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

Corps de la réponse

Message de réponse pour l'RPC properties.list.

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

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

object (Property)

Résultats correspondant aux critères de filtrage et accessibles à l'appelant.

nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit