Method: accounts.locations.list

Liste les établissements du compte spécifié.

Requête HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom du compte à partir duquel extraire des établissements.

  • ID de compte spécifique : si le compte est de type AccountType.PERSONAL, la réponse ne renvoie que les établissements appartenant directement à ce compte. Pour tous les autres types (par exemple, AccountType.LOCATION_GROUP), il renvoie tous les emplacements accessibles.

  • Caractère générique (-) : l'utilisation de accounts/- identifie l'utilisateur authentifié. Ce champ d'application est défini par défaut sur AccountType.PERSONAL, mais inclut les établissements détenus directement et indirectement (par exemple, ceux accessibles via des groupes de membres).

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre d'établissements à extraire par page. La valeur par défaut est 10 si elle n'est pas définie. La valeur minimale est 1 et la maximale est 100.
pageToken

string

Facultatif. Si elle est spécifiée, elle extrait la page d'établissements suivante (page). Le jeton de page est renvoyé par les appels précédents à locations.list lorsque le nombre d'établissements était supérieur à la taille de page demandée.
filter

string

Facultatif. Filtre limitant les emplacements à renvoyer. La réponse n'inclut que les entrées correspondant au filtre. Si filter est vide, les contraintes sont appliquées et tous les établissements (paginés) sont récupérés pour le compte demandé.

Pour en savoir plus sur les champs valides et obtenir un exemple d'utilisation, consultez le guide d'utilisation des données de localisation.
orderBy

string

Facultatif. Ordre de tri de la requête. Les champs multiples doivent être séparés par une virgule, conformément à la syntaxe SQL. L'ordre de tri par défaut est croissant. Pour spécifier l'ordre décroissant, vous devez ajouter le suffixe " desc". Les champs valides pour orderBy sont title et storeCode. Par exemple : "title, storeCode desc", "title" ou "storeCode desc".
readMask

string (FieldMask format)

Obligatoire. Masque de lecture permettant de spécifier les champs à renvoyer dans la réponse.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"

Corps de la requête

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

Corps de la réponse

Message de réponse pour Locations.ListLocations.

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

Représentation JSON 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Champs
locations[]

object (Location)

Les emplacements.
nextPageToken

string

Si le nombre d'établissements dépasse la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page suivante d'établissements lors d'un prochain appel à locations.list. S'il n'y a plus d'établissements, ce champ n'est pas inclus dans la réponse.
totalSize

integer

Nombre approximatif d'établissements dans la liste, quelle que soit la pagination. Ce champ n'est renvoyé que si filter est utilisé comme paramètre de requête.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour plus d'informations, consultez la OAuth 2.0 Overview.