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

นอกจากนี้ API นี้ยังมีฟังก์ชันตัวช่วยต่อไปนี้

  • annotation_duration() : ระยะเวลาที่คําอธิบายประกอบนี้ทําเครื่องหมาย durations คาดว่าจะมีการแสดงวินาทีเป็นตัวเลขตามด้วยส่วนต่อท้าย s
  • is_annotation_in_range(startDate, endDate) : หากคำอธิบายประกอบอยู่ในช่วงที่กำหนดโดย startDate และ endDate วันที่อยู่ในรูปแบบ ISO-8601 เช่น 2031-06-28

การดำเนินการที่รองรับ

  • = : เท่ากับ
  • != : ไม่เท่ากับ
  • < : น้อยกว่า
  • > : มากกว่า
  • <= : น้อยกว่าหรือเท่ากับ
  • >= : มากกว่าหรือเท่ากับ
  • : : โอเปอเรเตอร์ has
  • =~ : การทํางานของนิพจน์ทั่วไป
  • !~ : นิพจน์ทั่วไปไม่ตรงกัน
  • 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 ต้องตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

ข้อความตอบกลับสําหรับ 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