คู่มือนักพัฒนา

เอกสารนี้จะอธิบายวิธีใช้ Real Time Reporting API เพื่อรับข้อมูล Google Analytics

เกริ่นนำ

Real Time Reporting API เพื่อช่วยให้คุณรายงานกิจกรรมที่เกิดขึ้นในพร็อพเพอร์ตี้ในขณะนี้ได้ หากต้องการเข้าถึงข้อมูลแบบเรียลไทม์ คุณต้องสร้างการค้นหาที่ระบุข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) และเมตริกอย่างน้อย 1 รายการ นอกจากนี้ คุณยังให้พารามิเตอร์การค้นหาเพิ่มเติม เช่น มิติข้อมูลและตัวกรอง เพื่อปรับแต่งการค้นหาได้อีกด้วย ระบบจะส่งคำค้นหานี้ไปยัง Real Time Reporting API ซึ่งแสดงข้อมูลในรูปแบบของตาราง

หากคุณเพิ่งเริ่มใช้ API ให้อ่านภาพรวมของ Real Time Reporting API เพื่อดูข้อมูลเบื้องต้นเกี่ยวกับ Real Time Reporting API และข้อมูลที่มี

วิชาบังคับก่อน

ก่อนที่จะใช้ Real Time Reporting API เพื่อรับข้อมูล Google Analytics ให้ทำดังนี้

  • อ่านหน้า ไลบรารีของไคลเอ็นต์เพื่อดูรายการไลบรารีไคลเอ็นต์ทั้งหมดของภาษาโปรแกรมที่ใช้งานร่วมกับ API ได้
  • อ่าน คู่มืออ้างอิงเพื่อดูวิธีใช้ API เพียงอย่างเดียว (โดยไม่ใช้ไลบรารีของไคลเอ็นต์) เพื่อรับข้อมูล Google Analytics

ไลบรารีของไคลเอ็นต์แต่ละรายการมีออบเจ็กต์บริการการวิเคราะห์รายการเดียวเพื่อเข้าถึงข้อมูล Real Time Reporting API ทั้งหมด วิธีสร้างออบเจ็กต์บริการ

  1. ลงทะเบียนแอปพลิเคชันใน คอนโซล Google API
  2. ให้สิทธิ์เข้าถึงข้อมูล Google Analytics
  3. สร้างออบเจ็กต์บริการ Analytics

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

การใช้ API การรายงานแบบเรียลไทม์

หากต้องการใช้ Real Time Reporting API แอปพลิเคชัน ให้ทำดังนี้

  1. ค้นหา Real Time Reporting API
  2. จัดการการตอบสนองของ API

การค้นหา API การรายงานแบบเรียลไทม์

ออบเจ็กต์บริการข้อมูลวิเคราะห์ให้วิธีสร้างการค้นหา Real Time Reporting API โปรดดูรายละเอียดเกี่ยวกับพารามิเตอร์การค้นหาและข้อมูลที่ API ใช้ได้ที่หัวข้อต่อไปนี้

หลังจากกำหนดการค้นหาแล้ว ให้เรียกใช้เมธอด execute เพื่อส่งการค้นหาไปยังเซิร์ฟเวอร์ Google Analytics

การจัดการการตอบกลับจาก API

หากการค้นหา Real Time Reporting API สำเร็จ API นั้นจะส่งกลับข้อมูลที่ขอเป็นส่วนหนึ่งของแหล่งข้อมูลข้อมูลแบบเรียลไทม์ ดูรายละเอียดเกี่ยวกับโครงสร้างและรูปแบบการตอบกลับของ API ได้ที่ ข้อมูลอ้างอิงของ Real Time Reporting API

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

ตัวอย่างโค้ด

ส่วน ตัวอย่างในหน้า ข้อมูลแบบเรียลไทม์: get มีโค้ดตัวอย่างในภาษาโปรแกรมต่างๆ เพื่อค้นหา Real Time Reporting API และจัดการการตอบสนองของ API

ข้อจำกัดการค้นหา

ข้อจำกัดสำหรับการค้นหาแบบเรียลไทม์ของ API มีดังนี้

  • หากเมตริก rt:activeUsers รวมอยู่ในการค้นหาที่มีตัวกรองมิติข้อมูลต่อไปนี้ ระบบจะรองรับเฉพาะโอเปอเรเตอร์ AND และประเภทการทำงานของคีย์เวิร์ดความเท่าเทียม (==)
    • rt:goalId
    • rt:eventAction
    • rt:eventCategory
    • rt:eventLabel

    เนื่องจากเมตริก rt:activeUsers ดึงเฉพาะจํานวนผู้ใช้ที่ใช้งานอยู่ในเว็บไซต์ในขณะนี้ โปรดอย่าใช้ rt:minutesAgo กับ rt:activeUsers กล่าวคือ rt:activeUsers หมายความว่า rt:minutesAgo เป็น 0

  • ระบบไม่รองรับตัวกรองเมตริก
  • ระบบไม่สนับสนุนพารามิเตอร์ fields

การจัดการโควต้า

ตามที่อธิบายไว้ในขีดจำกัดและโควต้า จะมีโควต้ารายวันสำหรับ Real Time Reporting API ที่แชร์กับ API อื่นๆ ของ Google Analytics หากสำรวจ Real Time Reporting API ในช่วงเวลาสั้นๆ คุณจะเข้าถึงขีดจำกัดโควต้ารายวันได้อย่างรวดเร็วมาก เมื่อเกิดกรณีนี้ขึ้น คำขอจาก Google Analytics API อื่นๆ ก็จะหยุดทำงานด้วยจนกว่าจะมีการรีเฟรชโควต้า

ตัวอย่างการติดตั้งใช้งานที่อาจใช้โควต้าหมดอย่างรวดเร็วมีดังนี้

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

วิธีลดการใช้งานโควต้าและจัดการอย่างมีประสิทธิภาพ

  • ใช้การแคชฝั่งเซิร์ฟเวอร์ เมื่อผู้ใช้หลายคนส่งคำขอข้อมูลแบบเรียลไทม์เดียวกัน คุณควรส่งคืนการตอบกลับที่แคชไว้แทนที่จะค้นหา Real Time Reporting API โดยตรงสำหรับคำขอของผู้ใช้แต่ละราย จากนั้นให้รีเฟรชแคชด้วยข้อมูลแบบเรียลไทม์ล่าสุดเป็นระยะๆ ตามช่วงเวลารีเฟรชที่สมเหตุสมผล เพื่อหลีกเลี่ยงไม่ให้เกินขีดจำกัดโควต้ารายวัน
  • รวมคำค้นหาหลายรายการด้วยการระบุมิติข้อมูลเพิ่มเติมและแยกวิเคราะห์การตอบกลับบนเซิร์ฟเวอร์หรือฝั่งไคลเอ็นต์
  • เพิ่มช่วงเวลาที่คุณขอข้อมูลแบบเรียลไทม์

ตัวอย่าง: การคำนวณช่วงเวลารีเฟรช

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

เช่น ข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) ของ Google Analytics รายการเดียวมีขีดจำกัดโควต้ารายวันอยู่ที่ 10,000 คำขอต่อวัน ใน 1 วัน หากคุณคาดว่าจะสร้างคำค้นหา 6,000 รายการไปยัง API การรายงานหลักสำหรับข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) รายการเดียว คุณจะมีโควต้าคำขอ 4,000 รายการสำหรับข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) นั้นเหลืออยู่

สมมติว่าคุณตัดสินใจที่จะใช้ Real Time Reporting API ในแบบเรียลไทม์เพื่อใช้แดชบอร์ดแบบเรียลไทม์ 3 รายการซึ่งเรียกใช้การค้นหาข้อมูลแบบเรียลไทม์ทั้งวันจากข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) เดียวกัน แต่ละหน้าแดชบอร์ดจะสร้างคำค้นหาได้ประมาณ 1,333 รายการต่อวัน (4,000 การค้นหา / 3 หน้าแดชบอร์ด) ใน 1 วันมี 86,400 วินาที ดังนั้นช่วงเวลารีเฟรชสำหรับหน้าแดชบอร์ดแต่ละรายการต้องมากกว่า 65 วินาที (86,400 / 1,333) เพื่อให้จำนวนคำขอรายวันสำหรับข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) ทั้งหมดต่ำกว่าขีดจำกัด 4,000 ครั้งต่อวัน