Method: properties.runAccessReport

แสดงรายงานที่กำหนดเองของบันทึกการเข้าถึงข้อมูล รายงานจะแสดงบันทึกในแต่ละครั้งที่ผู้ใช้อ่านข้อมูลการรายงานของ Google Analytics ระบบจะเก็บรักษาบันทึกการเข้าถึงไว้ไม่เกิน 2 ปี

สามารถขอรายงานการเข้าถึงข้อมูลสำหรับพร็อพเพอร์ตี้ได้ คุณจะขอรายงานสำหรับพร็อพเพอร์ตี้ใดก็ได้ แต่จะขอมิติข้อมูลที่ไม่เกี่ยวข้องกับโควต้าได้เฉพาะในพร็อพเพอร์ตี้ Google Analytics 360 เท่านั้น วิธีนี้ใช้ได้เฉพาะกับผู้ดูแลระบบเท่านั้น

บันทึกการเข้าถึงข้อมูลเหล่านี้ประกอบด้วยการรายงาน UI ของ GA4, การสํารวจ UI ของ GA4, API ข้อมูลของ GA4 และผลิตภัณฑ์อื่นๆ เช่น Firebase และ AdMob ที่สามารถดึงข้อมูลจาก Google Analytics ผ่านการลิงก์ ระเบียนเหล่านี้จะไม่รวมการเปลี่ยนแปลงการกำหนดค่าพร็อพเพอร์ตี้ เช่น การเพิ่มสตรีมหรือการเปลี่ยนเขตเวลาของพร็อพเพอร์ตี้ โปรดดูประวัติการเปลี่ยนแปลงการกำหนดค่าที่ searchChangeHistoryEvents

คำขอ HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=properties/*}:runAccessReport

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
entity

string

รายงานการเข้าถึงข้อมูลจะรองรับการขอที่ระดับพร็อพเพอร์ตี้หรือระดับบัญชี รายงานการเข้าถึงข้อมูลจะรวมการเข้าถึงทั้งหมดสำหรับพร็อพเพอร์ตี้ทั้งหมดในบัญชีนั้นหากมีการขอที่ระดับบัญชี

หากต้องการขอที่ระดับพร็อพเพอร์ตี้ เอนทิตีควรเป็น "พร็อพเพอร์ตี้/123" หาก "123" คือรหัสพร็อพเพอร์ตี้ GA4 หากต้องการส่งคำขอที่ระดับบัญชี เอนทิตีควรเป็น "accounts/1234" หาก "1234" เป็นรหัสบัญชี GA4 ของคุณ

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

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}
ช่อง
dimensions[]

object (AccessDimension)

มิติข้อมูลที่ขอและแสดงในคำตอบ อนุญาตให้มีมิติข้อมูลได้สูงสุด 9 รายการ
metrics[]

object (AccessMetric)

เมตริกที่ขอและแสดงในคำตอบ อนุญาตให้มีเมตริกไม่เกิน 10 รายการ
dateRanges[]

object (AccessDateRange)

ช่วงวันที่ของระเบียนการเข้าถึงที่จะอ่าน หากมีการขอช่วงวันที่หลายช่วง แถวการตอบกลับแต่ละแถวจะมีดัชนีช่วงวันที่ที่อิงกับ 0 หากช่วงวันที่ 2 ช่วงทับซ้อนกัน บันทึกการเข้าถึงของวันที่ทับซ้อนกันจะรวมอยู่ในแถวคำตอบของทั้ง 2 ช่วงวันที่ อนุญาตให้มีช่วงวันที่ได้ไม่เกิน 2 ช่วง
dimensionFilter

object (AccessFilterExpression)

ตัวกรองมิติข้อมูลช่วยให้คุณจำกัดการตอบกลับของรายงานให้แสดงเฉพาะค่ามิติข้อมูลที่เฉพาะเจาะจงซึ่งตรงกับตัวกรองได้ เช่น การกรองบันทึกการเข้าถึงของผู้ใช้รายเดียว หากต้องการเรียนรู้เพิ่มเติม โปรดดูพื้นฐานของตัวกรองมิติข้อมูลเพื่อดูตัวอย่าง เมตริกใช้ในตัวกรองนี้ไม่ได้
metricFilter

object (AccessFilterExpression)

ตัวกรองเมตริกช่วยให้คุณจำกัดการตอบกลับของรายงานให้แสดงเฉพาะค่าเมตริกที่ตรงกับตัวกรองเท่านั้นได้ จะมีการใช้ตัวกรองเมตริกหลังจากรวมแถวของรายงานแล้ว ซึ่งคล้ายกับวลีที่มีเงื่อนไขของ SQL ใช้มิติข้อมูลในตัวกรองนี้ไม่ได้
offset

string (int64 format)

จำนวนแถวของแถวเริ่มต้น แถวแรกจะนับเป็นแถว 0 หากไม่ได้ระบุออฟเซ็ต ระบบจะถือว่าเป็น 0 หากออฟเซ็ตเป็น 0 เมธอดนี้จะแสดงหน้าแรกของผลลัพธ์ที่มี limit รายการ

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้าได้ที่การใส่เลขหน้า
limit

string (int64 format)

จำนวนแถวที่จะแสดงผล หากไม่ระบุ ระบบจะแสดงผล 10,000 แถว API จะแสดงผลแถวสูงสุด 100,000 แถวต่อคำขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม limit ต้องเป็นค่าบวก

API อาจแสดงผลแถวน้อยกว่า limit ที่ขอ หากไม่มีแถวเหลืออยู่มากเท่ากับ limit ตัวอย่างเช่น มิติข้อมูล country มีค่าที่เป็นไปได้น้อยกว่า 300 ค่า ดังนั้นเมื่อรายงานเฉพาะ country คุณจะมีแถวได้ไม่เกิน 300 แถว แม้ว่าคุณจะตั้งค่า limit เป็นค่าที่สูงกว่าก็ตาม

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้าได้ที่การใส่เลขหน้า
timeZone

string

เขตเวลาของคำขอนี้หากระบุ หากไม่ระบุ ระบบจะใช้เขตเวลาของพร็อพเพอร์ตี้ เขตเวลาของคำขอใช้เพื่อตีความวันที่เริ่มต้นและวันที่สิ้นสุดของรายงาน

จัดรูปแบบเป็นสตริงจากฐานข้อมูลเขตเวลาของ IANA (https://www.iana.org/time-zones) เช่น "America/New_York" หรือ "Asia/Tokyo"
orderBys[]

object (AccessOrderBy)

ระบุวิธีเรียงลำดับแถวในคำตอบ
returnEntityQuota

boolean

สลับว่าจะให้แสดงสถานะปัจจุบันของโควต้าพร็อพเพอร์ตี้ Analytics นี้หรือไม่ ระบบจะแสดงผลโควต้าใน AccessQuota ช่องนี้ต้องเป็นเท็จสำหรับคำขอระดับบัญชี
includeAllUsers

boolean

ไม่บังคับ กำหนดว่าจะรวมผู้ใช้ที่ไม่เคยเรียก API ไว้ในการตอบกลับหรือไม่ หากเป็น "จริง" ผู้ใช้ทั้งหมดที่มีสิทธิ์เข้าถึงพร็อพเพอร์ตี้หรือบัญชีที่ระบุจะรวมอยู่ในการตอบกลับ ไม่ว่าผู้ใช้จะเรียกใช้ API หรือไม่ก็ตาม หากเป็นเท็จ ระบบจะรวมเฉพาะผู้ใช้ที่ทำการเรียก API เท่านั้น
expandGroups

boolean

ไม่บังคับ เลือกว่าจะส่งคืนผู้ใช้ภายในกลุ่มผู้ใช้หรือไม่ ช่องนี้จะใช้ได้เฉพาะเมื่อตั้งค่า includeAllUsers เป็น "จริง" เท่านั้น หากเป็น "จริง" ระบบจะแสดงผลผู้ใช้ทั้งหมดที่มีสิทธิ์เข้าถึงพร็อพเพอร์ตี้หรือบัญชีที่ระบุ หากเป็นเท็จ ระบบจะแสดงผลเฉพาะผู้ใช้ที่มีสิทธิ์เข้าถึงโดยตรงเท่านั้น

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ RunAccessReportResponse

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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