سرور MCP را برای Google Analytics امتحان کنید. از
GitHub نصب کنید و برای جزئیات بیشتر به
اطلاعیه مراجعه کنید.
Method: properties.customDimensions.list
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
CustomDimensions را در یک ویژگی فهرست می کند.
درخواست HTTP
GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/customDimensions
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها |
---|
parent | string مورد نیاز. فرمت مثال: properties/1234 |
پارامترهای پرس و جو
پارامترها |
---|
pageSize | integer حداکثر تعداد منابع برای بازگشت. اگر نامشخص باشد، حداکثر 50 منبع برگردانده می شود. حداکثر مقدار 200 است (مقادیر بالاتر به حداکثر اعمال می شود). |
pageToken | string یک نشانه صفحه، دریافت شده از تماس قبلی customDimensions.list . این را برای بازیابی صفحه بعدی ارائه کنید. هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به customDimensions.list باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
پیام پاسخ برای customDimensions.list RPC.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"customDimensions": [
{
object (CustomDimension )
}
],
"nextPageToken": string
} |
فیلدها |
---|
customDimensions[] | object ( CustomDimension ) لیست ابعاد سفارشی |
nextPageToken | string یک نشانه، که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/analytics.readonly
-
https://www.googleapis.com/auth/analytics.edit
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eLists all CustomDimensions configured for a specified Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large lists of CustomDimensions.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003eanalytics.readonly\u003c/code\u003e or \u003ccode\u003eanalytics.edit\u003c/code\u003e authorization scopes for access.\u003c/p\u003e\n"],["\u003cp\u003eProvides details on the HTTP request structure, including path and query parameters.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of CustomDimensions and a token for retrieving subsequent pages if available.\u003c/p\u003e\n"]]],["This document details how to list CustomDimensions within a property using the Google Analytics Admin API. The core action is performing a `GET` request to the specified URL, which includes a required `parent` path parameter (e.g., properties/1234). Optional query parameters `pageSize` and `pageToken` enable pagination. The request body is empty. A successful response returns a JSON structure containing a list of `customDimensions` and a `nextPageToken` for further pages. Authorization requires specific OAuth scopes.\n"],null,["# Method: properties.customDimensions.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.ListCustomDimensionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists CustomDimensions on a property.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/customDimensions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------|\n| `parent` | `string` Required. Example format: properties/1234 |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |\n| `pageToken` | `string` A page token, received from a previous `customDimensions.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `customDimensions.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for customDimensions.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"customDimensions\": [ { object (/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions#CustomDimension) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customDimensions[]` | `object (`[CustomDimension](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions#CustomDimension)`)` List of CustomDimensions. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/analytics.readonly`\n- `https://www.googleapis.com/auth/analytics.edit`"]]