جرِّب خادم MCP لخدمة "إحصاءات Google". يمكنك تثبيت التطبيق من
GitHub والاطّلاع على
الإعلان لمعرفة المزيد من التفاصيل.
Method: properties.reportingDataAnnotations.list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
إدراج جميع التعليقات التوضيحية لبيانات إعداد التقارير في موقع معيّن
طلب HTTP
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
| المعلمات |
parent |
string
مطلوب. اسم المورد الخاص بالموقع. التنسيق: properties/property_id، مثال: properties/123
|
مَعلمات طلب البحث
| المعلمات |
filter |
string
اختياريّ. فلتر يحدّ من إدراج التعليقات التوضيحية لبيانات إعداد التقارير ضمن الموقع الأصلي. الحقول المتوافقة هي:
- 'name'
titledescriptionannotationDateannotationDateRangecolor بالإضافة إلى ذلك، توفّر واجهة برمجة التطبيقات هذه الوظائف المساعِدة التالية:
- annotation_duration(): المدة التي تشير إليها علامة التعليق التوضيحي هذه، durations. توقَّع تمثيلًا رقميًا للثواني متبوعًا بلاحقة
s.
- is_annotation_in_range(startDate, endDate) : إذا كان التعليق التوضيحي ضمن النطاق المحدّد من خلال
startDate وendDate. تكون التواريخ بتنسيق ISO-8601، على سبيل المثال 2031-06-28.
العمليات المتوافقة:
= : يساوي!= : لا يساوي< : أقل من> : أكبر من<= : أقل من أو يساوي>= : أكبر من أو يساوي: : عامل التشغيل has=~ : مطابقة التعبير العادي!~ : لا يتطابق التعبير العاديNOT : Logical notAND : Logical andOR : رمز المعامل المنطقي or (أو) أمثلة:
title="Holiday Sale"description=~"[Bb]ig [Gg]ame.*[Ss]ale"is_annotation_in_range("2025-12-25", "2026-01-16") = trueannotation_duration() >= 172800s AND title:BOGO
|
pageSize |
integer
اختياريّ. الحد الأقصى لعدد الموارد التي سيتم عرضها قد تعرض الخدمة عددًا أقل من هذه القيمة، حتى إذا كانت هناك صفحات إضافية. إذا لم يتم تحديد عدد، سيتم عرض 50 موردًا كحد أقصى. الحد الأقصى للقيمة هو 200 (سيتم تحويل القيم الأعلى إلى الحد الأقصى)
|
pageToken |
string
اختياريّ. رمز مميّز للصفحة، تم تلقّيه من مكالمة reportingDataAnnotations.list سابقة قدِّم هذا المرجع لاسترداد الصفحة اللاحقة. عند تقسيم الصفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى reportingDataAnnotations.list مع الطلب الذي قدّم الرمز المميّز للصفحة.
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
رسالة الاستجابة لاستدعاء إجراء عن بُعد ListReportingDataAnnotation
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| الحقول |
reportingDataAnnotations[] |
object (ReportingDataAnnotation)
قائمة التعليقات التوضيحية لبيانات إعداد التقارير
|
nextPageToken |
string
رمز مميّز يمكن إرساله على شكل pageToken لاسترداد الصفحة التالية. في حال حذف هذا الحقل، لن تكون هناك صفحات لاحقة.
|
نطاقات التفويض
يتطلب أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/analytics.readonlyhttps://www.googleapis.com/auth/analytics.edit
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],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`"]]
