Method: properties.reportingDataAnnotations.list

Liệt kê tất cả Chú thích dữ liệu báo cáo trên một tài sản.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
parent

string

Bắt buộc. Tên tài nguyên của thuộc tính. Định dạng: properties/property_id Ví dụ: properties/123

Tham số truy vấn

Thông số
filter

string

Không bắt buộc. Bộ lọc hạn chế những chú thích dữ liệu báo cáo nào trong tài sản mẹ được liệt kê.

Các trường được hỗ trợ là:

  • 'name'
  • title
  • description
  • annotationDate
  • annotationDateRange
  • color

Ngoài ra, API này còn cung cấp các hàm trợ giúp sau:

  • annotation_duration() : thời lượng mà chú thích này đánh dấu, durations. dự kiến một giá trị biểu thị bằng số của giây, theo sau là hậu tố s.
  • is_annotation_in_range(startDate, endDate) : nếu chú thích nằm trong phạm vi do startDate và endDate chỉ định. Ngày ở định dạng ISO-8601, ví dụ: 2031-06-28.

Các toán tử được hỗ trợ:

  • = : bằng
  • != : không bằng
  • < : nhỏ hơn
  • > : lớn hơn
  • <= : nhỏ hơn hoặc bằng
  • >= : lớn hơn hoặc bằng
  • : : có toán tử
  • =~ : khớp biểu thức chính quy
  • !~ : biểu thức chính quy không khớp
  • NOT : Không logic
  • AND : Dấu logic và
  • OR : Logic hoặc

Ví dụ:

  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

Không bắt buộc. Số lượng tài nguyên tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này, ngay cả khi có các trang khác. Nếu không chỉ định, hệ thống sẽ trả về tối đa 50 tài nguyên. Giá trị tối đa là 200; (các giá trị cao hơn sẽ được ép thành giá trị tối đa)
pageToken

string

Không bắt buộc. Mã thông báo trang, nhận được từ lệnh gọi reportingDataAnnotations.list trước đó. Cung cấp giá trị này để truy xuất trang tiếp theo. Khi phân trang, tất cả các tham số khác được cung cấp cho reportingDataAnnotations.list phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Thông báo phản hồi cho RPC ListReportingDataAnnotation.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
Trường
reportingDataAnnotations[]

object (ReportingDataAnnotation)

Danh sách chú thích dữ liệu báo cáo.
nextPageToken

string

Mã thông báo có thể được gửi dưới dạng pageToken để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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