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 : منطقی یا

مثال ها:

  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 RPC.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی 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
،

فهرست تمام حاشیه نویسی های داده های گزارش شده در یک ملک.

درخواست 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 : منطقی یا

مثال ها:

  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 RPC.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی 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
،

فهرست تمام حاشیه نویسی های داده های گزارش شده در یک ملک.

درخواست 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 : منطقی یا

مثال ها:

  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 RPC.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی 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
،

فهرست تمام حاشیه نویسی های داده های گزارش شده در یک ملک.

درخواست 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 : منطقی یا

مثال ها:

  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 RPC.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی 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