Method: accounts.locations.list
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Перечисляет местоположения для указанной учетной записи.
HTTP-запрос
GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры |
---|
parent | string Имя учетной записи, из которой нужно получить данные о местоположениях. Если Account имеет AccountType PERSONAL, возвращаются только местоположения, которые непосредственно принадлежат учетной записи, в противном случае будут возвращены все доступные местоположения из учетной записи, прямо или косвенно. |
Параметры запроса
Параметры |
---|
pageSize | integer Сколько местоположений нужно получить на странице. По умолчанию — 100, минимум — 1, максимальный размер страницы — 100. |
pageToken | string Если указано, извлекается следующая page местоположений. Токен страницы возвращается предыдущими вызовами locations.list когда мест было больше, чем могло поместиться в запрошенный размер страницы. |
filter | string Фильтр, ограничивающий возвращаемые местоположения. Ответ включает только записи, соответствующие фильтру. Если filter пуст, применяются ограничения и извлекаются все местоположения (с разбивкой на страницы) для запрошенной учетной записи. Дополнительные сведения о допустимых полях и примерах их использования см. в Руководстве по работе с данными о местоположении . |
languageCode (deprecated) | string Код языка BCP 47, на котором будут отображаться свойства местоположения. Если этот язык недоступен, они будут предоставлены на языке местоположения. Если ни один из них недоступен, они будут предоставлены на английском языке. Устарело. После 15 августа 2020 г. это поле больше не будет применяться. Вместо этого всегда будет использоваться язык местоположения. |
orderBy | string Порядок сортировки запроса. Несколько полей должны быть разделены запятыми в соответствии с синтаксисом SQL. По умолчанию порядок сортировки — по возрастанию. Чтобы указать порядок убывания, следует добавить суффикс «desc». Допустимыми полями для orderBy являются locationName и storeCode. Например: "locationName, storeCode desc" или "locationName" или "storeCode desc". |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит данные следующей структуры:
Ответное сообщение для Locations.ListLocations.
JSON-представление |
---|
{
"locations": [
{
object (Location )
}
],
"nextPageToken": string,
"totalSize": integer
} |
Поля |
---|
locations[] | object ( Location ) Локации. |
nextPageToken | string Если количество местоположений превысило запрошенный размер страницы, это поле заполняется токеном для получения следующей страницы местоположений при последующем вызове locations.list . Если местоположений больше нет, это поле отсутствует в ответе. |
totalSize | integer Примерное количество локаций в списке независимо от нумерации страниц. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/plus.business.manage
-
https://www.googleapis.com/auth/business.manage
Дополнительную информацию см. в обзоре OAuth 2.0 .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 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)."]]