คุณสามารถใช้ 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 เข้ากับแอปพลิเคชันทางธุรกิจอื่นๆ
ความสอดคล้องกันของข้อมูลและข้อมูลระบุตัวตนในการรายงาน
Google Analytics Data API v1 จะเข้าถึงข้อมูลการรายงานเดียวกันกับอินเทอร์เฟซ Google Analytics ข้อมูลที่ API แสดงผลจะเป็นไปตามการตั้งค่าข้อมูลระบุตัวตนในการรายงานที่กำหนดค่าไว้สำหรับพร็อพเพอร์ตี้ Google Analytics อย่างสมบูรณ์ เพื่อให้จำนวนผู้ใช้ การกรองข้อมูลที่ซ้ำกันออก และการประมาณข้อมูลสอดคล้องกับพื้นที่ข้อมูลระบุตัวตนที่เลือก เช่น แบบผสม แบบสังเกต หรือตามอุปกรณ์ในการตั้งค่าพร็อพเพอร์ตี้
ดูข้อมูลเพิ่มเติมเกี่ยวกับผลกระทบที่พื้นที่การระบุตัวตนที่แตกต่างกันอาจมีต่อรายงานได้ที่ข้อมูลระบุตัวตนในการรายงาน
เริ่มต้นใช้งาน
หากต้องการเริ่มต้นใช้งานไลบรารีของไคลเอ็นต์ใน Java, Python, Node.js, PHP, C#, Go หรือ Ruby โปรดดูคู่มือเริ่มใช้งานฉบับย่อของไลบรารีของไคลเอ็นต์ หากต้องการดูวิธีสร้างการค้นหา กรองมิติข้อมูล และอ่านการตอบกลับ โปรดดูสร้างรายงาน หรือทดสอบการค้นหาแบบอินเทอร์แอกทีฟใน Query Explorer
ตัวอย่างคำขอและการตอบกลับ 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