تتضمّن واجهة برمجة التطبيقات
لأداء الأعمال في Google طريقة واجهة برمجة تطبيقات
جديدة تتيح جلب عدة "مقاييس يومية" في طلب واحد لواجهة برمجة التطبيقات.
يُرجى مراجعة
الجدول الزمني للإيقاف وتعليمات نقل البيانات من طريقة v4 reportInsights API إلى واجهة برمجة التطبيقات الخاصة بأداء "الملف التجاري على Google".
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. يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي، يجب استخدام لاحقة " وصف" . الحقلان الصالحان لأمر orderBy هو locationName وstoreCode. على سبيل المثال: "locationName, storeCode desc" أو "locationName" أو "storeCode desc"
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
رسالة ردّ لـ Sites.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.managehttps://www.googleapis.com/auth/business.manage
لمزيد من المعلومات، يُرجى الاطِّلاع على نظرة عامة على OAuth 2.0.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\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)."]]
