- 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://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 |
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 |
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 |
Facultatif. Si elle est spécifiée, elle extrait les |
filter |
Facultatif. 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. |
orderBy |
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 |
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 : |
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 ( |
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. Ce champ n'est renvoyé que si |
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.