แสดงรายงานที่กำหนดเองของระเบียนการเข้าถึงข้อมูล รายงานจะแสดงบันทึกในแต่ละครั้งที่ผู้ใช้อ่านข้อมูลการรายงาน 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=accounts/*}:runAccessReport
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
entity |
รายงานการเข้าถึงข้อมูลรองรับคำขอที่ระดับพร็อพเพอร์ตี้หรือบัญชี หากขอที่ระดับบัญชี รายงานการเข้าถึงข้อมูลจะรวมสิทธิ์การเข้าถึงทั้งหมดสำหรับพร็อพเพอร์ตี้ทั้งหมดภายใต้บัญชีนั้น หากต้องการขอที่ระดับพร็อพเพอร์ตี้ เอนทิตีควรเป็น เช่น "properties/123" หาก "123" คือรหัสพร็อพเพอร์ตี้ GA4 หากต้องการขอที่ระดับบัญชี ควรเป็นเอนทิตี เช่น "accounts/1234" หาก "1234" คือรหัสบัญชี GA4 |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "dimensions": [ { object ( |
ช่อง | |
---|---|
dimensions[] |
มิติข้อมูลที่ขอและแสดงในคำตอบ คำขออนุญาตให้มีมิติข้อมูลได้สูงสุด 9 รายการ |
metrics[] |
เมตริกที่ขอและแสดงในการตอบกลับ คำขอมีเมตริกได้ไม่เกิน 10 รายการ |
dateRanges[] |
ช่วงวันที่ของระเบียนการเข้าถึงที่จะอ่าน หากมีการขอช่วงวันที่หลายช่วง แถวการตอบกลับแต่ละแถวจะมีดัชนีช่วงวันที่ที่ยึดตาม 0 หากช่วงวันที่ 2 ช่วงทับซ้อนกัน บันทึกการเข้าถึงสำหรับวันที่ซ้อนทับกันจะรวมอยู่ในแถวการตอบกลับสำหรับช่วงวันที่ทั้งสอง คำขออนุญาตให้มีช่วงวันที่ได้ไม่เกิน 2 ช่วง |
dimensionFilter |
ตัวกรองมิติข้อมูลช่วยให้คุณจำกัดการตอบกลับของรายงานไว้สำหรับค่ามิติข้อมูลที่เฉพาะเจาะจงที่ตรงกับตัวกรองได้ เช่น การกรองบันทึกการเข้าถึงของผู้ใช้รายเดียว ดูข้อมูลเพิ่มเติมได้ที่พื้นฐานของตัวกรองมิติข้อมูล ใช้เมตริกในตัวกรองนี้ไม่ได้ |
metricFilter |
ตัวกรองเมตริกช่วยให้คุณจำกัดการตอบกลับของรายงานไว้สำหรับค่าเมตริกที่เฉพาะเจาะจงที่ตรงกับตัวกรองได้ ระบบจะใช้ตัวกรองเมตริกหลังจากรวมแถวของรายงาน ซึ่งคล้ายกับเงื่อนไขที่มี SQL ใช้มิติข้อมูลในตัวกรองนี้ไม่ได้ |
offset |
จำนวนแถวของแถวเริ่มต้น แถวแรกจะนับเป็นแถว 0 หากไม่ได้ระบุออฟเซ็ต ระบบจะถือว่าค่านี้เป็น 0 หากออฟเซ็ตเป็น 0 วิธีนี้จะแสดงหน้าแรกของผลลัพธ์ที่มี ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้านี้ได้ที่การใส่เลขหน้า |
limit |
จำนวนแถวที่จะแสดงผล หากไม่ระบุ ระบบจะแสดงผล 10,000 แถว API จะส่งกลับจำนวนแถวสูงสุด 100,000 แถวต่อคำขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม API อาจแสดงผลแถวน้อยกว่า ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้านี้ได้ที่การใส่เลขหน้า |
timeZone |
เขตเวลาของคำขอนี้ หากระบุไว้ หากไม่ระบุ ระบบจะใช้เขตเวลาของพร็อพเพอร์ตี้ เขตเวลาของคำขอใช้เพื่อตีความเวลาเริ่มต้นและ วันที่สิ้นสุดของรายงาน มีการจัดรูปแบบเป็นสตริงจากฐานข้อมูลเขตเวลาของ IANA (https://www.iana.org/time-zones) ตัวอย่างเช่น "America/New_York" หรือ "เอเชีย/โตเกียว" |
orderBys[] |
ระบุลำดับแถวในการตอบกลับ |
returnEntityQuota |
สลับว่าจะส่งคืนสถานะปัจจุบันของโควต้าของพร็อพเพอร์ตี้ Analytics นี้หรือไม่ โควต้าจะส่งคืนใน AccessQuota สำหรับคำขอระดับบัญชี ช่องนี้ต้องเป็น "เท็จ" |
includeAllUsers |
ไม่บังคับ กำหนดว่าจะรวมผู้ใช้ที่ไม่เคยเรียกใช้ API ในการตอบกลับหรือไม่ หากเป็นจริง ผู้ใช้ทั้งหมดที่มีสิทธิ์เข้าถึงพร็อพเพอร์ตี้หรือบัญชีที่ระบุจะรวมอยู่ในการตอบกลับด้วย ไม่ว่าจะเรียก API หรือไม่ก็ตาม ถ้าเป็น "เท็จ" ระบบจะรวมเฉพาะผู้ใช้ที่ทำการเรียก API ไว้ |
expandGroups |
ไม่บังคับ ตัดสินใจว่าจะแสดงผลผู้ใช้ภายในกลุ่มผู้ใช้หรือไม่ ช่องนี้จะทำงานเมื่อมีการตั้งค่า includeAllUsers เป็น "จริง" เท่านั้น หากจริง ระบบจะแสดงผลผู้ใช้ทั้งหมดที่มีสิทธิ์เข้าถึงพร็อพเพอร์ตี้หรือบัญชีที่ระบุ หากเป็น "เท็จ" ระบบจะแสดงผลเฉพาะผู้ใช้ที่มีสิทธิ์เข้าถึงโดยตรงเท่านั้น |
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ RunAccessReportResponse
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics.edit