คุณสามารถใช้ Data API เพื่อ เข้าถึงข้อมูลการรายงานของ Google Analytics แบบเป็นโปรแกรม
ดูข้อมูลเพิ่มเติมเกี่ยวกับพร็อพเพอร์ตี้ ของ Google Analytics
ข้อมูลที่ API แสดงผลจะสอดคล้องกับข้อมูลที่แสดงในอินเทอร์เฟซผู้ใช้ของ Google Analytics และเป็นไปตาม การตั้งค่าข้อมูลระบุตัวตนในการรายงานอย่างครบถ้วน-- เช่น แบบผสาน แบบสังเกต หรือแบบอิงตามอุปกรณ์ ซึ่งกำหนดค่าไว้สำหรับพร็อพเพอร์ตี้ Google Analytics
ตัวอย่างบางส่วนที่คุณอาจรายงานโดยใช้ Google Analytics Data API v1
- แอป Android ของคุณมีผู้ใช้ที่ใช้งานอยู่รายวันเท่าใดในสัปดาห์ที่แล้ว
- หน้าเว็บ 10 อันดับแรกในเว็บไซต์ของคุณมีการดูหน้าเว็บกี่ครั้งในช่วง 28 วันที่ผ่านมา
- แอป iOS ของคุณมีผู้ใช้ที่ใช้งานอยู่ในแต่ละประเทศเท่าใดในช่วง 30 นาทีที่ผ่านมา
นอกจากนี้ คุณยังใช้ Google Analytics Data API v1 เพื่อทำสิ่งต่อไปนี้ได้ด้วย
- สร้างแดชบอร์ดที่กำหนดเองเพื่อแสดงข้อมูล Google Analytics
- ปรับให้งานการรายงานที่ซับซ้อนทำงานโดยอัตโนมัติเพื่อประหยัดเวลา
- ผสานรวมข้อมูล Google Analytics กับแอปพลิเคชันทางธุรกิจอื่นๆ
ความสอดคล้องของข้อมูลและข้อมูลระบุตัวตนในการรายงาน
Data API v1 ของ Google Analytics เข้าถึงข้อมูลรายงานเดียวกันกับอินเทอร์เฟซ Google Analytics ข้อมูลที่ API แสดงผลจะเป็นไปตามการตั้งค่าข้อมูลระบุตัวตนในการรายงาน ที่กำหนดค่าไว้สำหรับพร็อพเพอร์ตี้ Google Analytics อย่างครบถ้วน ดังนั้นจำนวนผู้ใช้ การกรองข้อมูลที่ซ้ำกันออก และโมเดลข้อมูลจึงสอดคล้องกับพื้นที่การระบุตัวตนที่เลือก เช่น แบบผสาน แบบสังเกต หรือแบบอิงตามอุปกรณ์ ในการตั้งค่าพร็อพเพอร์ตี้
ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีที่พื้นที่การระบุตัวตนต่างๆ อาจส่งผลต่อรายงานได้ที่ ข้อมูลระบุตัวตนในการรายงาน
เริ่มต้นใช้งาน
หากต้องการเริ่มต้นใช้งานไลบรารีของไคลเอ็นต์ใน Java, Python, Node.js, PHP, C#, Go หรือ Ruby โปรดดูคู่มือเริ่มต้นใช้งานฉบับย่อของไลบรารีของไคลเอ็นต์ หากต้องการดูวิธีสร้างคําค้นหา กรองมิติข้อมูล และอ่านการตอบกลับ โปรดดูสร้างรายงาน หรือทดสอบคําค้นหาแบบโต้ตอบในเครื่องมือสํารวจคําค้นหา
ตัวอย่างคําขอและคําตอบของ runReport
หากต้องการค้นหาข้อมูลเหตุการณ์ผ่าน REST ให้ส่งคําขอ POST ไปยังปลายทาง
runReport พร้อมเนื้อหา JSON ของ
RunReportRequest
ที่ระบุ dateRanges, dimensions และ metrics ดังนี้
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
"dateRanges": [
{ "startDate": "7daysAgo", "endDate": "yesterday" }
],
"dimensions": [
{ "name": "country" }
],
"metrics": [
{ "name": "activeUsers" }
]
}
หรือเรียกใช้คําสั่ง curl ที่เทียบเท่าโดยใช้ ข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชัน:
curl -X POST \
"https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport" \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "x-goog-user-project: PROJECT_ID" \
-H "Content-Type: application/json" \
-d '{
"dateRanges": [
{ "startDate": "7daysAgo", "endDate": "yesterday" }
],
"dimensions": [
{ "name": "country" }
],
"metrics": [
{ "name": "activeUsers" }
]
}'
API จะแสดงผล RunReportResponse
ที่มีส่วนหัวของคอลัมน์และแถวข้อมูล ดังนี้
{
"dimensionHeaders": [
{ "name": "country" }
],
"metricHeaders": [
{ "name": "activeUsers", "type": "TYPE_INTEGER" }
],
"rows": [
{
"dimensionValues": [{ "value": "United States" }],
"metricValues": [{ "value": "4820" }]
},
{
"dimensionValues": [{ "value": "Japan" }],
"metricValues": [{ "value": "2541" }]
}
],
"rowCount": 2,
"kind": "analyticsData#runReport"
}
เมธอดที่ใช้ได้
ต่อไปนี้คือรายการเมธอด Data API ดูรายละเอียดเพิ่มเติมได้ในเอกสารอ้างอิง
runReportเมธอดนี้ จะแสดงผลรายงานที่กำหนดเองของข้อมูลเหตุการณ์ Google Analytics และเป็น เมธอดที่แนะนําสําหรับ คําค้นหารายงานอย่างง่ายbatchRunReportsเมธอดนี้เป็นเวอร์ชันแบบกลุ่มของเมธอด runReport ซึ่งช่วยให้คุณสร้างรายงานหลายรายการได้โดยใช้การเรียก API เพียงครั้งเดียวrunPivotReportเมธอดนี้ จะแสดงผลรายงาน Pivot ที่กําหนดเองของข้อมูลเหตุการณ์ Google Analytics รายงาน Pivot เป็นรูปแบบที่ซับซ้อนและแสดงข้อมูลได้มากกว่ารายงานปกติ Pivot แต่ละรายการจะอธิบายคอลัมน์และแถวมิติข้อมูลที่มองเห็นได้ในการตอบกลับของรายงานbatchRunPivotReportsเมธอดนี้เป็นเวอร์ชันแบบกลุ่มของเมธอด runPivotReport ซึ่งช่วยให้คุณสร้างรายงานหลายรายการได้โดยใช้การเรียก API เพียงครั้งเดียวgetMetadataเมธอดนี้จะแสดงผลข้อมูลเมตาของมิติข้อมูลและเมตริกที่ใช้ได้ในเมธอดการรายงาน ใช้เพื่อสํารวจมิติข้อมูลและเมตริก การตอบกลับของเมธอดนี้ยังรวมถึงมิติข้อมูลและเมตริกที่กําหนดเองที่ใช้ได้สําหรับพร็อพเพอร์ตี้ Google Analytics ที่ระบุcheckCompatibilityเมธอดนี้จะแสดงรายการมิติข้อมูลและเมตริกที่เพิ่มลงในคําขอรายงานได้โดยยังคงความเข้ากันได้runRealtimeReportเมธอดนี้จะแสดงผลรายงานของข้อมูลเหตุการณ์แบบเรียลไทม์ ที่กําหนดเองสําหรับพร็อพเพอร์ตี้ เหตุการณ์จะปรากฏในรายงานแบบเรียลไทม์ภายในไม่กี่วินาทีหลังจากที่ส่งไปยัง Google Analytics รายงานแบบเรียลไทม์จะแสดงเหตุการณ์และข้อมูลการใช้งานในช่วงเวลาตั้งแต่ปัจจุบันจนถึง 30 นาทีก่อนหน้า (สูงสุด 60 นาทีสําหรับพร็อพเพอร์ตี้ Google Analytics 360)properties.audienceExportsกลุ่มเมธอดที่ช่วยให้คุณสร้างการส่งออกกลุ่มเป้าหมายซึ่งรวมถึงข้อมูลสรุปของผู้ใช้ใน กลุ่มเป้าหมายproperties.recurringAudienceLists(เวอร์ชันพรีวิวล่วงหน้า) กลุ่มเมธอดที่ช่วยให้คุณจัดการการส่งออกกลุ่มเป้าหมายที่เกิดขึ้นซ้ำ การส่งออกกลุ่มเป้าหมายที่เกิดขึ้นซ้ำจะสร้างรายการกลุ่มเป้าหมายใหม่ทุกวันrunFunnelReport(เวอร์ชันตัวอย่างทดลองใช้) เมธอดนี้จะแสดงผลรายงาน Funnel ที่กําหนดเองของข้อมูลเหตุการณ์ Google Analytics ของคุณ การสำรวจ Funnel จะช่วยให้คุณได้เห็นภาพขั้นตอนต่างๆ ที่ผู้ใช้ใช้ในการดำเนินงาน และดูว่าจะประสบความสำเร็จหรือล้มเหลวในแต่ละขั้นตอนได้อย่างรวดเร็วproperties.chat(เวอร์ชันตัวอย่างทดลองใช้) เมธอดนี้ให้สิทธิ์เข้าถึงแบบเป็นโปรแกรมเพื่อสนทนากับ Ask Advisor ใน Google Analytics คุณสามารถถามคำถามเป็นภาษาธรรมชาติเกี่ยวกับข้อมูลเหตุการณ์ วินิจฉัยการเปลี่ยนแปลงประสิทธิภาพ และรับข้อมูลเชิงลึกแบบบรรยายที่มีโครงสร้างและแบบตาราง
มิติข้อมูลและเมตริกที่รองรับ
ดูรายการมิติข้อมูลและเมตริกทั้งหมดที่ Data API รองรับได้ใน เอกสารประกอบสคีมา API