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'
  • title
  • description
  • annotationDate
  • annotationDateRange
  • color

بالإضافة إلى ذلك، توفّر واجهة برمجة التطبيقات هذه الوظائف المساعِدة التالية:

  • annotation_duration()‎: المدة التي تشير إليها علامة التعليق التوضيحي هذه، durations. توقَّع تمثيلًا رقميًا للثواني متبوعًا بلاحقة s.
  • is_annotation_in_range(startDate, endDate) : إذا كان التعليق التوضيحي ضمن النطاق المحدّد من خلال startDate وendDate. تكون التواريخ بتنسيق ISO-8601، على سبيل المثال 2031-06-28.

العمليات المتوافقة:

  • = : يساوي
  • != : لا يساوي
  • < : أقل من
  • > : أكبر من
  • <= : أقل من أو يساوي
  • >= : أكبر من أو يساوي
  • : : عامل التشغيل has
  • =~ : مطابقة التعبير العادي
  • !~ : لا يتطابق التعبير العادي
  • NOT : Logical not
  • AND : Logical and
  • OR : رمز المعامل المنطقي 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 مع الطلب الذي قدّم الرمز المميّز للصفحة.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

رسالة الاستجابة لاستدعاء إجراء عن بُعد 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