L'API
Google Business Performance propose une
NOUVELLE méthode qui permet d'extraire plusieurs `DailyMetrics` avec une seule requête API.
Consultez le
planning d'abandon et les instructions pour migrer de la méthode API reportInsights v4 à l'API Google Business Profile Performance.
Method: accounts.locations.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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.managehttps://www.googleapis.com/auth/business.manage
Pour en savoir plus, consultez la Présentation d'OAuth 2.0.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[[["\u003cp\u003eLists all accessible locations for a specified Google My Business account, including directly or indirectly owned locations based on account type.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering, pagination, and sorting of location data through query parameters like \u003ccode\u003efilter\u003c/code\u003e, \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, and \u003ccode\u003eorderBy\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of locations with details like location name, store code, and other properties, along with pagination information if applicable.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific OAuth scopes for accessing and managing business data.\u003c/p\u003e\n"],["\u003cp\u003eProvides a total count of locations irrespective of pagination for easier management and understanding of the data set.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.locations.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListLocationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nLists the locations for the specified account.\n\n### HTTP request\n\n`GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` The name of the account to fetch locations from. If the [Account](/my-business/reference/rest/v4/accounts#Account) is of [AccountType](/my-business/reference/rest/v4/accounts#Account.AccountType) PERSONAL, only Locations that are directly owned by the Account are returned, otherwise it will return all accessible locations from the Account, either directly or indirectly. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` How many locations to fetch per page. Default is 100, minimum is 1, and maximum page size is 100. |\n| `pageToken` | `string` If specified, it fetches the next `page` of locations. The page token is returned by previous calls to `locations.list` when there were more locations than could fit in the requested page size. |\n| `filter` | `string` A filter constraining the locations to return. The response includes only entries that match the filter. If `filter` is empty, then constraints are applied and all locations (paginated) are retrieved for the requested account. For more information about valid fields and example usage, see [Work with Location Data Guide](https://developers.google.com/my-business/content/location-data#filter_results_when_you_list_locations). |\n| `languageCode` **(deprecated)** | `string` The BCP 47 code of language to get display location properties in. If this language is not available, they will be provided in the language of the location. If neither is available, they will be provided in English. Deprecated. After August 15th, 2020, this field will no longer be applied. Instead, the language of the location will always be used. |\n| `orderBy` | `string` Sorting order for the request. Multiple fields should be comma-separated, following SQL syntax. The default sorting order is ascending. To specify descending order, a suffix \" desc\" should be added. Valid fields to orderBy are locationName and storeCode. For example: \"locationName, storeCode desc\" or \"locationName\" or \"storeCode desc\" |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for Locations.ListLocations.\n\n| JSON representation ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"locations\": [ { object (/my-business/reference/rest/v4/accounts.locations#Location) } ], \"nextPageToken\": string, \"totalSize\": integer } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `locations[]` | `object (`[Location](/my-business/reference/rest/v4/accounts.locations#Location)`)` The locations. |\n| `nextPageToken` | `string` If the number of locations exceeded the requested page size, this field is populated with a token to fetch the next page of locations on a subsequent call to `locations.list`. If there are no more locations, this field is not present in the response. |\n| `totalSize` | `integer` The approximate number of Locations in the list irrespective of pagination. |\n\n### Authorization Scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/plus.business.manage`\n- `https://www.googleapis.com/auth/business.manage`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
