Method: accounts.runAccessReport

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

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

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

หากต้องการแสดงความคิดเห็นเกี่ยวกับ API นี้ โปรดกรอกแบบฟอร์มความคิดเห็นเกี่ยวกับรายงานการเข้าถึงของ Google Analytics

คำขอ HTTP

POST https://analyticsadmin.googleapis.com/v1beta/{entity=accounts/*}:runAccessReport

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

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

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

string

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

หากต้องการส่งคําขอที่ระดับพร็อพเพอร์ตี้ ข้อมูลควรเป็น "properties/123" เช่น หาก "123" คือรหัสพร็อพเพอร์ตี้ Google Analytics หากต้องการขอที่ระดับบัญชี ข้อมูลควรเป็น "accounts/1234" เช่น หาก "1234" คือรหัสบัญชี Google Analytics ของคุณ

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

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

การแสดง 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