- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
Liste 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 |
Nom du compte à partir duquel extraire des établissements. Si |
Paramètres de requête
Paramètres | |
---|---|
pageSize |
Nombre d'établissements à extraire par page. La valeur par défaut est 100, la minimale est 1 et la maximale est 100. |
pageToken |
Si elle est spécifiée, elle extrait les |
filter |
Filtre contraignant les emplacements à afficher. La réponse n'inclut que les entrées qui correspondent au filtre. Si Pour en savoir plus sur les champs valides et obtenir des exemples d'utilisation, consultez le guide Utiliser les données de localisation. |
languageCode |
Code BCP 47 de la langue dans laquelle les propriétés de localisation à afficher sont disponibles. Si cette langue n'est pas disponible, elles seront fournies dans la langue du pays. Si ni l'un ni l'autre n'est disponible, ils sont fournis en anglais. Obsolète. Après le 15 août 2020, ce champ ne sera plus appliqué. La langue du lieu sera toujours utilisée. |
orderBy |
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 les champs 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 Locations.ListLocations.
Représentation JSON | |
---|---|
{
"locations": [
{
object ( |
Champs | |
---|---|
locations[] |
Les emplacements. |
nextPageToken |
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 à |
totalSize |
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.