Method: properties.reportingDataAnnotations.list

הצגת רשימה של כל ההערות על נתוני הדיווח בנכס.

בקשת HTTP

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב של הנכס. פורמט: 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.

הפעולות הנתמכות:

  • = : שווה
  • != : לא שווה
  • < : פחות מ-
  • > : גדול מ-
  • <= : קטן מ- או שווה ל-
  • >= : גדול מ- או שווה ל-
  • : : אופרטור של 'יש'
  • =~ : התאמה לביטוי רגולרי
  • !~ : ביטוי רגולרי לא תואם
  • NOT : שלילה לוגית
  • AND : Logical and
  • OR : או לוגי

דוגמאות:

  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() >= 172800s AND title:BOGO
pageSize

integer

אופציונלי. המספר המקסימלי של המשאבים להחזרה. יכול להיות שהשירות יחזיר פחות מהערך הזה, גם אם יש דפים נוספים. אם לא צוין, יוחזרו עד 50 משאבים. הערך המקסימלי הוא 200 (ערכים גבוהים יותר יומרו לערך המקסימלי)
pageToken

string

אופציונלי. אסימון דף, שהתקבל משיחה קודמת של reportingDataAnnotations.list. צריך לספק אותו כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-reportingDataAnnotations.list חייבים להתאים לקריאה שסיפקה את אסימון הדף.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

הודעת תגובה ל-RPC של ListReportingDataAnnotation.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
שדות
reportingDataAnnotations[]

object (ReportingDataAnnotation)

רשימת ההערות על נתוני הדיווח.
nextPageToken

string

אסימון שאפשר לשלוח כ-pageToken כדי לאחזר את הדף הבא. אם השדה הזה לא יצוין, לא יהיו דפים נוספים.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit