Method: accounts.locations.list

Liste les établissements pour le 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. Si le parent [Account] [google.mybusiness.accountmanagement.v1.Account] est de type [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONNEL, seuls les établissements directement détenus par le compte sont renvoyés. Sinon, tous les établissements accessibles à partir du compte sont renvoyés, directement ou indirectement.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre d'établissements à extraire par page. Si ce paramètre n'est pas défini, la valeur par défaut est 10. La taille minimale est 1 et la taille de page maximale : 100.
pageToken

string

Facultatif. Si elle est spécifiée, elle extrait les page d'établissements suivants. Le jeton de page est renvoyé par les appels précédents à locations.list lorsqu'il y avait plus d'emplacements que la taille de page demandée.
filter

string

Facultatif. Filtre contraignant les emplacements à afficher. La réponse n'inclut que les entrées qui correspondent au filtre. Si filter est vide, les contraintes sont appliquées et toutes les zones géographiques (paginées) sont récupérées pour le compte demandé.

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

string

Facultatif. Ordre de tri de la requête. S'il y a plusieurs champs, ils doivent être séparés par une virgule, en respectant la syntaxe SQL. Par défaut, l'ordre de tri est croissant. Pour spécifier l'ordre décroissant, un suffixe " desc" doit être ajouté. 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 pour spécifier les champs à renvoyer dans la réponse.

Il s'agit d'une liste de noms complets de champs 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 d'établissements suivante lors d'un prochain appel à locations.list. S'il n'y a plus d'établissements, ce champ n'est pas présent 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 en savoir plus, consultez la présentation d'OAuth 2.0.