تتضمّن واجهة برمجة التطبيقات
لأداء الأعمال في Google طريقة واجهة برمجة تطبيقات
جديدة تتيح جلب عدة "مقاييس يومية" في طلب واحد لواجهة برمجة التطبيقات.
يُرجى مراجعة
الجدول الزمني للإيقاف وتعليمات نقل البيانات من طريقة v4 reportInsights API إلى واجهة برمجة التطبيقات الخاصة بأداء "الملف التجاري على Google".
Method: accounts.list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
يسرد جميع حسابات المستخدم الذي تمت مصادقته. ويشمل ذلك جميع الحسابات التي يملكها هذا المستخدم، بالإضافة إلى أي حسابات يمتلك المستخدم حقوق إدارة لها.
طلب HTTP
GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
معامِلات طلب البحث
| المعلمات |
parentAccount |
string
اختياريّ. اسم المورد للحساب الذي سيتم استرداد قائمة الحسابات التي يمكن الوصول إليها مباشرةً. وهذا الإجراء منطقي فقط بالنسبة إلى المؤسسات ومجموعات المستخدمين. في حال ترك الحقل فارغًا، سيتم عرض accounts.list للمستخدم الذي تمت مصادقته. accounts/{account_id}
|
pageSize |
integer
اختياريّ. عدد الحسابات المطلوب جلبها لكل صفحة القيمة التلقائية والحد الأقصى هي 20.
|
pageToken |
string
اختياريّ. وفي حال تحديده، يتم استرداد الصفحة التالية من الحسابات. ويتم عرض pageToken عندما يعرض استدعاء الدالة accounts.list نتائج أكثر مما يمكن احتواء حجم الصفحة المطلوب.
|
filter |
string
اختياريّ. فلتر يقيد الحسابات للعودة. لا يتضمن الردّ سوى الإدخالات التي تتطابق مع الفلتر. إذا كان الحقل filter فارغًا، لن يتم تطبيق أي قيود وسيتم استرداد جميع الحسابات (المقسّمة على صفحات) للحساب المطلوب. على سبيل المثال، سيؤدي الطلب الذي يتضمّن الفلتر type=USER_GROUP إلى عرض مجموعات مستخدمين فقط. والحقل type هو الفلتر الوحيد المتوافق.
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
رسالة ردّ لـ accounts.ListAccounts.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل JSON |
{
"accounts": [
{
object (Account)
}
],
"nextPageToken": string
} |
| الحقول |
accounts[] |
object (Account)
مجموعة من الحسابات التي يمكن للمستخدم الوصول إليها. سيكون الحساب الشخصي للمستخدم الذي يقوم بالاستعلام دائمًا هو العنصر الأول في النتيجة، ما لم تتم تصفيته.
|
nextPageToken |
string
إذا تجاوز عدد الحسابات حجم الصفحة المطلوب، يتم ملء هذا الحقل برمز مميز لجلب الصفحة التالية من الحسابات عند إجراء استدعاء لاحق للرقم accounts.list. إذا لم يكن هناك حسابات أخرى، هذا الحقل غير متوفر في الردّ.
|
نطاقات الأذونات
يجب توفير نطاق OAuth التالي:
https://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 accounts owned by or accessible to the authenticated user, including their personal account.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering accounts by type and specifying the parent account for retrieval.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large lists of accounts using \u003ccode\u003epageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an array of \u003ccode\u003eAccount\u003c/code\u003e objects and a \u003ccode\u003enextPageToken\u003c/code\u003e for further results.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This API retrieves a list of accounts for an authenticated user via a `GET` request to a specified URL. The user can filter the accounts by type, specify the page size, and use a `pageToken` for pagination. An optional `parentAccount` parameter retrieves accounts directly accessible from that account. The request body must be empty, and the successful response includes an array of account objects and, if applicable, a `nextPageToken` for further pagination. This uses OAuth 2.0 with the `business.manage` scope.\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\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://mybusinessaccountmanagement.googleapis.com/v1/accounts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parentAccount` | `string` Optional. 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. `accounts/{account_id}`. |\n| `pageSize` | `integer` Optional. How many accounts to fetch per page. The default and maximum is 20. |\n| `pageToken` | `string` Optional. 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| `filter` | `string` Optional. 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. The `type` field is the only supported filter. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for Accounts.ListAccounts.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"accounts\": [ { object (/my-business/reference/accountmanagement/rest/v1/accounts#Account) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `accounts[]` | `object (`[Account](/my-business/reference/accountmanagement/rest/v1/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 the following OAuth scope:\n\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)."]]
