سرور MCP را برای Google Analytics امتحان کنید. از
GitHub نصب کنید و برای جزئیات بیشتر به
اطلاعیه مراجعه کنید.
Method: properties.reportingDataAnnotations.list
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
فهرست تمام حاشیه نویسی های داده های گزارش شده در یک ملک.
درخواست HTTP
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
parent | string مورد نیاز. نام منبع ملک فرمت: properties/property_id مثال: properties/123 |
پارامترهای پرس و جو
| پارامترها |
|---|
filter | string اختیاری. فیلتری که فهرست حاشیه‌نویسی داده‌های گزارش‌دهی را تحت ویژگی والد محدود می‌کند. زمینه های پشتیبانی شده عبارتند از: - 'نام'
-
title -
description -
annotationDate -
annotationDateRange -
color
علاوه بر این، این API توابع کمکی زیر را ارائه می دهد: - annotation_duration(): مدت زمانی که این حاشیه نویسی مشخص می کند، duration . انتظار یک نمایش عددی از ثانیه به دنبال پسوند
s را داشته باشید. - is_annotation_in_range(startDate, endDate): اگر حاشیه نویسی در محدوده مشخص شده توسط
startDate و endDate باشد. تاریخ ها در قالب ISO-8601 هستند، به عنوان مثال 2031-06-28 .
عملیات پشتیبانی شده: -
= : برابر است -
!= : مساوی نیست -
< : کمتر از -
> : بیشتر از -
<= : کمتر یا مساوی است -
>= : بزرگتر یا مساوی -
: : دارای اپراتور -
=~ : مطابقت عبارت منظم -
!~ : عبارت منظم مطابقت ندارد -
NOT : منطقی نیست -
AND : منطقی و -
OR : منطقی یا
مثال ها: -
title="Holiday Sale" -
description=~"[Bb]ig [Gg]ame.*[Ss]ale" -
is_annotation_in_range("2025-12-25", "2026-01-16") = true -
annotation_duration() >= 172800s AND title:BOGO
|
pageSize | integer اختیاری. حداکثر تعداد منابع برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند، حتی اگر صفحات اضافی وجود داشته باشد. اگر نامشخص باشد، حداکثر 50 منبع برگردانده می شود. حداکثر مقدار 200 است. (مقادیر بالاتر تا حداکثر اجباری خواهد بود) |
pageToken | string اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی reportingDataAnnotations.list . این را برای بازیابی صفحه بعدی ارائه کنید. هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به reportingDataAnnotations.list باید با فراخوانی که نشانه صفحه را ارائه می کند مطابقت داشته باشد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
پیام پاسخ برای ListReportingDataAnnotation RPC.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| فیلدها |
|---|
reportingDataAnnotations[] | object ( ReportingDataAnnotation ) فهرست حاشیه نویسی داده های گزارش. |
nextPageToken | string یک نشانه، که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/analytics.readonly -
https://www.googleapis.com/auth/analytics.edit
،
فهرست تمام حاشیه نویسی های داده های گزارش شده در یک ملک.
درخواست HTTP
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
parent | string مورد نیاز. نام منبع ملک فرمت: properties/property_id مثال: properties/123 |
پارامترهای پرس و جو
| پارامترها |
|---|
filter | string اختیاری. فیلتری که فهرست حاشیه‌نویسی داده‌های گزارش‌دهی را تحت ویژگی والد محدود می‌کند. زمینه های پشتیبانی شده عبارتند از: - 'نام'
-
title -
description -
annotationDate -
annotationDateRange -
color
علاوه بر این، این API توابع کمکی زیر را ارائه می دهد: - annotation_duration(): مدت زمانی که این حاشیه نویسی مشخص می کند، duration . انتظار یک نمایش عددی از ثانیه به دنبال پسوند
s را داشته باشید. - is_annotation_in_range(startDate, endDate): اگر حاشیه نویسی در محدوده مشخص شده توسط
startDate و endDate باشد. تاریخ ها در قالب ISO-8601 هستند، به عنوان مثال 2031-06-28 .
عملیات پشتیبانی شده: -
= : برابر است -
!= : مساوی نیست -
< : کمتر از -
> : بیشتر از -
<= : کمتر یا مساوی است -
>= : بزرگتر یا مساوی -
: : دارای اپراتور -
=~ : مطابقت عبارت منظم -
!~ : عبارت منظم مطابقت ندارد -
NOT : منطقی نیست -
AND : منطقی و -
OR : منطقی یا
مثال ها: -
title="Holiday Sale" -
description=~"[Bb]ig [Gg]ame.*[Ss]ale" -
is_annotation_in_range("2025-12-25", "2026-01-16") = true -
annotation_duration() >= 172800s AND title:BOGO
|
pageSize | integer اختیاری. حداکثر تعداد منابع برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند، حتی اگر صفحات اضافی وجود داشته باشد. اگر نامشخص باشد، حداکثر 50 منبع برگردانده می شود. حداکثر مقدار 200 است. (مقادیر بالاتر تا حداکثر اجباری خواهد بود) |
pageToken | string اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی reportingDataAnnotations.list . این را برای بازیابی صفحه بعدی ارائه کنید. هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به reportingDataAnnotations.list باید با فراخوانی که نشانه صفحه را ارائه می کند مطابقت داشته باشد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
پیام پاسخ برای ListReportingDataAnnotation RPC.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| فیلدها |
|---|
reportingDataAnnotations[] | object ( ReportingDataAnnotation ) فهرست حاشیه نویسی داده های گزارش. |
nextPageToken | string یک نشانه، که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/analytics.readonly -
https://www.googleapis.com/auth/analytics.edit
،
فهرست تمام حاشیه نویسی های داده های گزارش شده در یک ملک.
درخواست HTTP
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
parent | string مورد نیاز. نام منبع ملک فرمت: properties/property_id مثال: properties/123 |
پارامترهای پرس و جو
| پارامترها |
|---|
filter | string اختیاری. فیلتری که فهرست حاشیه‌نویسی داده‌های گزارش‌دهی را تحت ویژگی والد محدود می‌کند. زمینه های پشتیبانی شده عبارتند از: - 'نام'
-
title -
description -
annotationDate -
annotationDateRange -
color
علاوه بر این، این API توابع کمکی زیر را ارائه می دهد: - annotation_duration(): مدت زمانی که این حاشیه نویسی مشخص می کند، duration . انتظار یک نمایش عددی از ثانیه به دنبال پسوند
s را داشته باشید. - is_annotation_in_range(startDate, endDate): اگر حاشیه نویسی در محدوده مشخص شده توسط
startDate و endDate باشد. تاریخ ها در قالب ISO-8601 هستند، به عنوان مثال 2031-06-28 .
عملیات پشتیبانی شده: -
= : برابر است -
!= : مساوی نیست -
< : کمتر از -
> : بیشتر از -
<= : کمتر یا مساوی است -
>= : بزرگتر یا مساوی -
: : دارای اپراتور -
=~ : مطابقت عبارت منظم -
!~ : عبارت منظم مطابقت ندارد -
NOT : منطقی نیست -
AND : منطقی و -
OR : منطقی یا
مثال ها: -
title="Holiday Sale" -
description=~"[Bb]ig [Gg]ame.*[Ss]ale" -
is_annotation_in_range("2025-12-25", "2026-01-16") = true -
annotation_duration() >= 172800s AND title:BOGO
|
pageSize | integer اختیاری. حداکثر تعداد منابع برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند، حتی اگر صفحات اضافی وجود داشته باشد. اگر نامشخص باشد، حداکثر 50 منبع برگردانده می شود. حداکثر مقدار 200 است. (مقادیر بالاتر تا حداکثر اجباری خواهد بود) |
pageToken | string اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی reportingDataAnnotations.list . این را برای بازیابی صفحه بعدی ارائه کنید. هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به reportingDataAnnotations.list باید با فراخوانی که نشانه صفحه را ارائه می کند مطابقت داشته باشد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
پیام پاسخ برای ListReportingDataAnnotation RPC.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| فیلدها |
|---|
reportingDataAnnotations[] | object ( ReportingDataAnnotation ) فهرست حاشیه نویسی داده های گزارش. |
nextPageToken | string یک نشانه، که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد. |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/analytics.readonly -
https://www.googleapis.com/auth/analytics.edit
،
فهرست تمام حاشیه نویسی های داده های گزارش شده در یک ملک.
درخواست HTTP
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
parent | string مورد نیاز. نام منبع ملک فرمت: properties/property_id مثال: properties/123 |
پارامترهای پرس و جو
| پارامترها |
|---|
filter | string اختیاری. فیلتری که فهرست حاشیه‌نویسی داده‌های گزارش‌دهی را تحت ویژگی والد محدود می‌کند. زمینه های پشتیبانی شده عبارتند از: - 'نام'
-
title -
description -
annotationDate -
annotationDateRange -
color
علاوه بر این، این API توابع کمکی زیر را ارائه می دهد: - annotation_duration(): مدت زمانی که این حاشیه نویسی مشخص می کند، duration . انتظار یک نمایش عددی از ثانیه به دنبال پسوند
s را داشته باشید. - is_annotation_in_range(startDate, endDate): اگر حاشیه نویسی در محدوده مشخص شده توسط
startDate و endDate باشد. تاریخ ها در قالب ISO-8601 هستند، به عنوان مثال 2031-06-28 .
عملیات پشتیبانی شده: -
= : برابر است -
!= : مساوی نیست -
< : کمتر از -
> : بیشتر از -
<= : کمتر یا مساوی است -
>= : بزرگتر یا مساوی -
: : دارای اپراتور -
=~ : مطابقت عبارت منظم -
!~ : عبارت منظم مطابقت ندارد -
NOT : منطقی نیست -
AND : منطقی و -
OR : منطقی یا
مثال ها: -
title="Holiday Sale" -
description=~"[Bb]ig [Gg]ame.*[Ss]ale" -
is_annotation_in_range("2025-12-25", "2026-01-16") = true -
annotation_duration() >= 172800s AND title:BOGO
|
pageSize | integer اختیاری. حداکثر تعداد منابع برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند، حتی اگر صفحات اضافی وجود داشته باشد. اگر نامشخص باشد، حداکثر 50 منبع برگردانده می شود. حداکثر مقدار 200 است. (مقادیر بالاتر تا حداکثر اجباری خواهد بود) |
pageToken | string اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی reportingDataAnnotations.list . این را برای بازیابی صفحه بعدی ارائه کنید. هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به reportingDataAnnotations.list باید با فراخوانی که نشانه صفحه را ارائه می کند مطابقت داشته باشد. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
پیام پاسخ برای ListReportingDataAnnotation RPC.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| فیلدها |
|---|
reportingDataAnnotations[] | object ( ReportingDataAnnotation ) فهرست حاشیه نویسی داده های گزارش. |
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 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: properties.reportingDataAnnotations.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.ListReportingDataAnnotationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nList all Reporting Data Annotations on a property.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. Resource name of the property. Format: properties/property_id Example: properties/123 |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` Optional. Filter that restricts which reporting data annotations under the parent property are listed. Supported fields are: - 'name' - `title` - `description` - `annotationDate` - `annotationDateRange` - `color` Additionally, this API provides the following helper functions: - annotation_duration() : the duration that this annotation marks, [durations](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/duration.proto). expect a numeric representation of seconds followed by an `s` suffix. - is_annotation_in_range(startDate, endDate) : if the annotation is in the range specified by the `startDate` and `endDate`. The dates are in ISO-8601 format, for example `2031-06-28`. Supported operations: - `=` : equals - `!=` : not equals - `\u003c` : less than - `\u003e` : greater than - `\u003c=` : less than or equals - `\u003e=` : greater than or equals - `:` : has operator - `=~` : [regular expression](https://github.com/google/re2/wiki/Syntax) match - `!~` : [regular expression](https://github.com/google/re2/wiki/Syntax) does not match - `NOT` : Logical not - `AND` : Logical and - `OR` : Logical or Examples: 1. `title=\"Holiday Sale\"` 2. `description=~\"[Bb]ig [Gg]ame.*[Ss]ale\"` 3. `is_annotation_in_range(\"2025-12-25\", \"2026-01-16\") = true` 4. `annotation_duration() \u003e= 172800s AND title:BOGO` |\n| `pageSize` | `integer` Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. 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` Optional. A page token, received from a previous `reportingDataAnnotations.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `reportingDataAnnotations.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 ListReportingDataAnnotation RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"reportingDataAnnotations\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#ReportingDataAnnotation) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `reportingDataAnnotations[]` | `object (`[ReportingDataAnnotation](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.reportingDataAnnotations#ReportingDataAnnotation)`)` List of Reporting Data Annotations. |\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`"]]
