חובה. שם המשאב של הנכס. פורמט: properties/property_id. דוגמה: properties/123
פרמטרים של שאילתה
פרמטרים
filter
string
אופציונלי. מסנן שמגביל את רשימת ההערות על נתוני הדיווח בנכס ההורה.
השדות הנתמכים הם:
'name'
title
description
annotationDate
annotationDateRange
color
בנוסף, ה-API הזה מספק את פונקציות העזר הבאות:
annotation_duration(): משך הזמן שההערה הזו מסמנת, durations. מצפה לייצוג מספרי של שניות ואחריו סיומת s.
is_annotation_in_range(startDate, endDate) : אם ההערה נמצאת בטווח שצוין על ידי startDate ו-endDate. התאריכים צריכים להיות בפורמט ISO-8601, לדוגמה 2031-06-28.
אופציונלי. המספר המקסימלי של המשאבים להחזרה. יכול להיות שהשירות יחזיר פחות מהערך הזה, גם אם יש דפים נוספים. אם לא צוין, יוחזרו עד 50 משאבים. הערך המקסימלי הוא 200 (ערכים גבוהים יותר יומרו לערך המקסימלי)
pageToken
string
אופציונלי. אסימון דף, שהתקבל משיחה קודמת של reportingDataAnnotations.list. צריך לספק אותו כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-reportingDataAnnotations.list חייבים להתאים לקריאה שסיפקה את אסימון הדף.
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
הודעת תגובה ל-RPC של ListReportingDataAnnotation.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2025-07-26 (שעון UTC)."],[],[],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`"]]
