تتضمّن واجهة برمجة التطبيقات
لأداء الأعمال في Google طريقة واجهة برمجة تطبيقات
جديدة تتيح جلب عدة "مقاييس يومية" في طلب واحد لواجهة برمجة التطبيقات.
يُرجى مراجعة
الجدول الزمني للإيقاف وتعليمات نقل البيانات من طريقة v4 reportInsights API إلى واجهة برمجة التطبيقات الخاصة بأداء "الملف التجاري على Google".
Method: accounts.list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
يسرد جميع حسابات المستخدم الذي تمت مصادقته. ويشمل ذلك جميع الحسابات التي يملكها هذا المستخدم، بالإضافة إلى أي حسابات يمتلك المستخدم حقوق إدارة لها.
طلب HTTP
GET https://mybusiness.googleapis.com/v4/accounts
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
معامِلات طلب البحث
| المعلمات |
pageSize |
integer
عدد الحسابات المطلوب جلبها لكل صفحة القيمة التلقائية هي 20، والحد الأدنى هو 2، والحد الأقصى لحجم الصفحة هو 20.
|
pageToken |
string
وفي حال تحديده، يتم استرداد الصفحة التالية من الحسابات. ويتم عرض pageToken عندما يعرض استدعاء الدالة accounts.list نتائج أكثر مما يمكن احتواء حجم الصفحة المطلوب.
|
name |
string
اسم المورد للحساب الذي سيتم استرداد قائمة الحسابات التي يمكن الوصول إليها مباشرةً. وهذا الإجراء منطقي فقط بالنسبة إلى المؤسسات ومجموعات المستخدمين. في حال ترك الحقل فارغًا، سيتم عرض accounts.list للمستخدم الذي تمت مصادقته.
|
filter |
string
فلتر يقيد الحسابات للعودة. لا يتضمن الردّ سوى الإدخالات التي تتطابق مع الفلتر. إذا كان الحقل filter فارغًا، لن يتم تطبيق أي قيود وسيتم استرداد جميع الحسابات (المقسّمة على صفحات) للحساب المطلوب. على سبيل المثال، سيؤدي الطلب الذي يتضمّن الفلتر type=USER_GROUP إلى عرض مجموعات مستخدمين فقط.
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
رسالة ردّ لـ accounts.ListAccounts.
| تمثيل JSON |
{
"accounts": [
{
object (Account)
}
],
"nextPageToken": string
} |
| الحقول |
accounts[] |
object (Account)
مجموعة من الحسابات التي يمكن للمستخدم الوصول إليها. سيكون الحساب الشخصي للمستخدم الذي يقوم بالاستعلام دائمًا هو العنصر الأول في النتيجة، ما لم تتم تصفيته.
|
nextPageToken |
string
إذا تجاوز عدد الحسابات حجم الصفحة المطلوب، يتم ملء هذا الحقل برمز مميز لجلب الصفحة التالية من الحسابات عند إجراء استدعاء لاحق للرقم accounts.list. إذا لم يكن هناك حسابات أخرى، هذا الحقل غير متوفر في الردّ.
|
نطاقات التفويض
يتطلب هذا الإعداد أحد نطاقات 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\u003eThis API endpoint, now deprecated, was used to retrieve a list of Google My Business accounts for the authenticated user, including owned and managed accounts.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes account details and a pagination token for retrieving additional results.\u003c/p\u003e\n"],["\u003cp\u003eFiltering options were available to narrow down the returned accounts based on criteria like account type.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization required either \u003ccode\u003ehttps://www.googleapis.com/auth/plus.business.manage\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUsers should now utilize the Account Management API for similar functionality.\u003c/p\u003e\n"]]],["This document outlines how to retrieve a list of accounts for an authenticated user via a `GET` request to `https://mybusiness.googleapis.com/v4/accounts`. The request can utilize query parameters like `pageSize`, `pageToken`, `name`, and `filter` to control the results. The request body must be empty. A successful response includes an array of `accounts` and optionally a `nextPageToken` for pagination. Authorization requires specific OAuth scopes.\n"],null,["# Method: accounts.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAccountsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\n| Deprecated. Please use the [Account Management API](https://developers.google.com/my-business/reference/accountmanagement/rest/v1/accounts/list) instead.\nLists all of the accounts for the authenticated user. This includes all accounts that the user owns, as well as any accounts for which the user has management rights.\n\n### HTTP request\n\n`GET https://mybusiness.googleapis.com/v4/accounts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` How many accounts to fetch per page. Default is 20, minimum is 2, and maximum page size is 20. |\n| `pageToken` | `string` If specified, the next page of accounts is retrieved. The `pageToken` is returned when a call to `accounts.list` returns more results than can fit into the requested page size. |\n| `name` | `string` The resource name of the account for which the list of directly accessible accounts is to be retrieved. This only makes sense for Organizations and User Groups. If empty, will return `accounts.list` for the authenticated user. |\n| `filter` | `string` A filter constraining the accounts to return. The response includes only entries that match the filter. If `filter` is empty, then no constraints are applied and all accounts (paginated) are retrieved for the requested account. For example, a request with the filter `type=USER_GROUP` will only return user groups. |\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 Accounts.ListAccounts.\n\n| JSON representation ||\n|-------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"accounts\": [ { object (/my-business/reference/rest/v4/accounts#Account) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `accounts[]` | `object (`[Account](/my-business/reference/rest/v4/accounts#Account)`)` A collection of accounts to which the user has access. The personal account of the user doing the query will always be the first item of the result, unless it is filtered out. |\n| `nextPageToken` | `string` If the number of accounts exceeds the requested page size, this field is populated with a token to fetch the next page of accounts on a subsequent call to `accounts.list`. If there are no more accounts, this field is not present in the response. |\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)."]]
