Method: accounts.locations.list

Répertorie les établissements pour le compte spécifié.

Requête HTTP

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Nom du compte à partir duquel extraire les établissements. Si la valeur de Account est de AccountType PERSONNEL, seules les Adresses détenues directement par le compte sont renvoyées. Sinon, toutes les adresses accessibles à partir du compte sont renvoyées, directement ou indirectement.

Paramètres de requête

Paramètres
pageSize

integer

Nombre d'établissements à extraire par page. La valeur par défaut est 100, la minimale est 1 et la maximale est 100.
pageToken

string

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

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.
languageCode
(deprecated)

string

Code de langue BCP 47 dans lequel obtenir les propriétés de localisation d'affichage. Si cette langue n'est pas disponible, elles seront fournies dans la langue du pays. Si aucune de ces informations n'est disponible, elles seront fournies en anglais.

Obsolète. Après le 15 août 2020, ce champ ne sera plus appliqué. À la place, la langue du lieu sera toujours utilisée.
orderBy

string

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 "locationName" et "storeCode". Par exemple : "locationName, storeCode desc". ou "locationName" ou "storeCode desc"

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 :

Message de réponse pour Location.ListLocations.

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.

Champs d'application des autorisations

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

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

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.