Google Business Performance API یک روش API
جدید دارد که امکان واکشی چندین «DailyMetrics» را در یک درخواست API فراهم می‌کند.
زمان‌بندی منسوخ شدن و دستورالعمل‌های انتقال از روش API reportInsights v4 به API عملکرد نمایه کسب‌وکار Google را مرور کنید.
Method: accounts.list
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
همه اکانت ها را برای کاربر احراز هویت شده فهرست می کند. این شامل تمام حساب‌هایی است که کاربر مالک آن است، و همچنین هر حسابی که کاربر برای آن حقوق مدیریت دارد.
درخواست HTTP
GET https://mybusiness.googleapis.com/v4/accounts
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
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.manage -
https://www.googleapis.com/auth/business.manage
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده 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)."]]
