Method: accounts.locations.list

Répertorie 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 les établissements. Si le compte parent [Account] [google.mybusiness.accountmanagement.v1.Account] est associé au type de compte [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL, seules les adresses directement détenues par le compte sont renvoyées. Dans le cas contraire, toutes les adresses accessibles à partir du compte sont renvoyées, directement ou indirectement.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre d'établissements à extraire par page. Si aucune valeur n'est définie, la valeur par défaut est 10. La taille minimale est de 1, et la taille de page maximale est de 100.
pageToken

string

Facultatif. Si spécifié, il récupère les page établissements suivants. Le jeton de page est renvoyé par les appels précédents à locations.list lorsque le nombre d'emplacements était supérieur à la taille de page demandée.
filter

string

Facultatif. Filtre contraignant les établissements à 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 des exemples d'utilisation, consultez le guide Utiliser les données de localisation.
orderBy

string

Facultatif. Ordre de tri de la requête. Les différents champs doivent être séparés par une virgule en suivant la syntaxe SQL. Par défaut, l'ordre de tri est croissant. Pour indiquer l'ordre décroissant, un suffixe " desc" doit être ajouté. Les champs "orderBy" valides sont "title" et "storeCode". Par exemple : "titre, storeCode desc". ou "title" ou "storeCode desc"
readMask

string (FieldMask format)

Obligatoire. Masque de lecture pour spécifier les champs qui seront renvoyés 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 Location.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)

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 appel ultérieur à 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.