พร็อพเพอร์ตี้ Universal Analytics (UA) มาตรฐานหยุดประมวลผลข้อมูลเมื่อวันที่ 1 กรกฎาคม 2023 พร็อพเพอร์ตี้ UA 360 จะหยุดการประมวลผลข้อมูลในวันที่ 1 กรกฎาคม 2024 และเราจะเลิกใช้งานฟีเจอร์บางอย่างของ UA 360ก่อนวันดังกล่าว เนื่องจากเราจะย้ายข้อมูลไปยัง Google Analytics 4 ใช้ Data API เพื่อเข้าถึงฟีเจอร์การรายงานสําหรับพร็อพเพอร์ตี้ GA4

หน้านี้ได้รับการแปลโดย Cloud Translation API

Core Reporting API - คู่มืออ้างอิง

เอกสารนี้มีข้อมูลอ้างอิงที่สมบูรณ์สำหรับทั้งการค้นหาและคำตอบสำหรับ Core Reporting API เวอร์ชัน 3.0

เกริ่นนำ

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

ส่งคำขอ

API มีวิธีเดียวในการขอข้อมูล ดังนี้

analytics.data.ga.get()

เมธอดนี้จะปรากฏในไลบรารีของไคลเอ็นต์หลายรายการ และมีอินเทอร์เฟซเฉพาะภาษาสำหรับการตั้งค่าพารามิเตอร์การค้นหา

นอกจากนี้ ยังค้นหา API เป็นปลายทางแบบ REST ได้ด้วย

Authorization: Bearer {oauth2-token}

GET https://www.googleapis.com/analytics/v3/data/ga
  ?ids=ga:12345
  &start-date=2008-10-01
  &end-date=2008-10-31
  &metrics=ga:sessions,ga:bounces

พารามิเตอร์การค้นหาของ URL แต่ละรายการจะระบุพารามิเตอร์การค้นหาของ API ที่ต้องเป็นการเข้ารหัส URL

สรุปพารามิเตอร์การค้นหา

ตารางต่อไปนี้สรุปพารามิเตอร์การค้นหาทั้งหมดที่ API การรายงานหลักยอมรับ คลิกชื่อพารามิเตอร์แต่ละรายการเพื่อดูคำอธิบายโดยละเอียด

ชื่อ	ค่า	จำเป็น	สรุป
`ids`	`string`	ใช่	รหัสตารางที่ไม่ซ้ำของแบบฟอร์ม ga:XXXX โดยที่ XXXX คือรหัสข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) Analytics ที่การค้นหาจะเรียกข้อมูล
`start-date`	`string`	ใช่	วันที่เริ่มต้นการดึงข้อมูล Analytics คำขออาจระบุวันที่เริ่มต้นในรูปแบบ `YYYY-MM-DD` หรือเป็นวันที่สัมพัทธ์ (เช่น `today`, `yesterday` หรือ `NdaysAgo` โดยที่ `N` เป็นจำนวนเต็มบวก)
`end-date`	`string`	ใช่	วันที่สิ้นสุดการดึงข้อมูล Analytics คําขออาจระบุวันที่สิ้นสุดในรูปแบบ `YYYY-MM-DD` หรือเป็นวันที่สัมพัทธ์ (เช่น `today`, `yesterday` หรือ `NdaysAgo` โดยที่ `N` เป็นจำนวนเต็มบวก)
`metrics`	`string`	ใช่	รายการเมตริกที่คั่นด้วยคอมมา เช่น `ga:sessions,ga:bounces`
`dimensions`	`string`	ไม่	รายการมิติข้อมูลที่คั่นด้วยคอมมาสำหรับข้อมูล Analytics เช่น `ga:browser,ga:city`
`sort`	`string`	ไม่	รายการมิติข้อมูลและเมตริกที่คั่นด้วยคอมมาที่ระบุลำดับการจัดเรียงและทิศทางการจัดเรียงสำหรับข้อมูลที่แสดงผล
`filters`	`string`	ไม่	ตัวกรองมิติข้อมูลหรือเมตริกที่จํากัดข้อมูลที่แสดงผลสําหรับคําขอของคุณ
`segment`	`string`	ไม่	จัดกลุ่มข้อมูลที่แสดงผลสำหรับคำขอของคุณ
`samplingLevel`	`string`	ไม่	ระดับการสุ่มตัวอย่างที่ต้องการ ค่าที่อนุญาตมีดังนี้ `DEFAULT` — แสดงผลคำตอบที่มีขนาดตัวอย่างซึ่งรักษาสมดุลระหว่างความเร็วกับความแม่นยำ `FASTER` — แสดงผลการตอบสนองอย่างรวดเร็วในขนาดการสุ่มตัวอย่างที่เล็กลง `HIGHER_PRECISION` — แสดงผลคำตอบที่แม่นยำยิ่งขึ้นโดยใช้ขนาดตัวอย่างขนาดใหญ่ แต่อาจส่งผลให้การตอบสนองช้าลง
`include-empty-rows`	`boolean`	ไม่	ค่าเริ่มต้นคือ "จริง" หากตั้งค่าเป็น "เท็จ" แถวที่ค่าเมตริกทั้งหมดเป็น 0 จะไม่รวมอยู่ในคำตอบ
`start-index`	`integer`	ไม่	แถวแรกของข้อมูลที่จะดึง โดยเริ่มต้นที่ 1 ใช้พารามิเตอร์นี้เป็นกลไกการใส่เลขหน้าร่วมกับพารามิเตอร์ `max-results`
`max-results`	`integer`	ไม่	จำนวนแถวสูงสุดที่จะรวมในคำตอบ
`output`	`string`	ไม่	ประเภทเอาต์พุตที่ต้องการสําหรับข้อมูล Analytics ที่แสดงในคำตอบ ค่าที่ยอมรับได้คือ `json` และ `dataTable` ค่าเริ่มต้น: `json`
`fields`	`string`	ไม่	ตัวเลือกที่ระบุชุดย่อยของฟิลด์ที่จะรวมไว้ในการตอบกลับ
`prettyPrint`	`string`	ไม่	แสดงการตอบกลับด้วยการเยื้องและการขึ้นบรรทัดใหม่ `false` เริ่มต้น
`userIp`	`string`	ไม่	ระบุที่อยู่ IP ของผู้ใช้ปลายทางที่จะเรียกใช้ API ใช้เพื่อจำกัดการใช้งานต่อ IP
`quotaUser`	`string`	ไม่	เป็นอีกทางเลือกหนึ่งแทนการใช้ userIp ในกรณีที่ไม่ทราบที่อยู่ IP ของผู้ใช้
`access_token`	`string`	ไม่	วิธีหนึ่งที่เป็นไปได้ในการระบุโทเค็น OAuth 2.0
`callback`	`string`	ไม่	ชื่อของฟังก์ชันเรียกกลับของ JavaScript ที่จัดการการตอบกลับ ใช้ในคำขอ JavaScript JSON-P
`key`	`string`	ไม่	ใช้สำหรับการให้สิทธิ์ OAuth 1.0a เพื่อระบุแอปพลิเคชันของคุณเพื่อรับโควต้า เช่น `key=AldefliuhSFADSfasdfasdfASdf`

รายละเอียดพารามิเตอร์การค้นหา

ids

ids=ga:12345

ต้องระบุ

รหัสที่ไม่ซ้ำกันที่ใช้เพื่อดึงข้อมูล Analytics รหัสนี้คือการเชื่อมโยงเนมสเปซ ga: กับรหัสข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) ของ Analytics คุณเรียกดูรหัสข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) ได้โดยใช้เมธอด analytics.management.profiles.list ซึ่งจะให้ id ในแหล่งข้อมูลข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) ใน API การจัดการของ Google Analytics

วันที่เริ่มต้น

start-date=2009-04-20

ต้องระบุ

คำขอข้อมูล Analytics ทั้งหมดต้องระบุช่วงวันที่ หากคุณไม่ใส่พารามิเตอร์ start-date และ end-date ในคำขอ เซิร์ฟเวอร์จะแสดงข้อผิดพลาด คุณจะป้อนค่าวันที่สำหรับวันที่ที่ระบุได้โดยใช้รูปแบบ YYYY-MM-DD หรือแบบสัมพัทธ์โดยใช้ today, yesterday หรือรูปแบบ NdaysAgo ค่าต้องตรงกับ [0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)

start-date ที่ถูกต้องเร็วที่สุดคือ 2005-01-01 ไม่มีข้อจำกัดสูงสุดสำหรับวันที่เริ่มต้น

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

ตัวอย่างช่วงวันที่สำหรับ 7 วันที่ผ่านมา (เริ่มตั้งแต่เมื่อวาน) ที่ใช้วันที่สัมพัทธ์

  &start-date=7daysAgo
  &end-date=yesterday

วันที่สิ้นสุด

end-date=2009-05-20

ต้องระบุ

end-date ที่ถูกต้องเร็วที่สุดคือ 2005-01-01 ไม่มีข้อจำกัดสูงสุดสำหรับ end-date

ตัวอย่างช่วงวันที่สำหรับ 10 วันที่ผ่านมา (เริ่มต้นวันนี้) ที่ใช้วันที่สัมพัทธ์

  &start-date=9daysAgo
  &end-date=today

ขนาด

dimensions=ga:browser,ga:city

ไม่บังคับ

พารามิเตอร์ dimensions จะแจกแจงเมตริกต่างๆ ตามเกณฑ์ทั่วไป เช่น ตาม ga:browser หรือ ga:city แม้ว่าคุณจะขอจำนวนการดูหน้าเว็บทั้งหมดในเว็บไซต์ได้ แต่การขอจำนวนการดูหน้าเว็บแยกตามเบราว์เซอร์ก็อาจน่าสนใจมากกว่า ในกรณีนี้ คุณจะเห็นจำนวนการดูหน้าเว็บจาก Firefox, Internet Explorer, Chrome และอื่นๆ

โปรดคำนึงถึงข้อจำกัดต่อไปนี้เมื่อใช้ dimensions ในคำขอข้อมูล

คุณสามารถระบุมิติข้อมูลได้สูงสุด 7 รายการในคำค้นหาใดๆ
คุณไม่ส่งคำค้นหาที่ประกอบด้วยมิติข้อมูลเพียงอย่างเดียวได้ คุณต้องรวมมิติข้อมูลที่ขอกับเมตริกอย่างน้อย 1 รายการ
คุณสามารถค้นหาเฉพาะมิติข้อมูลบางรายการในคำค้นหาเดียวกันได้ ใช้เครื่องมือชุดค่าผสมที่ใช้ได้ใน การอ้างอิงมิติข้อมูลและเมตริกเพื่อดูว่ามิติข้อมูลใดใช้ด้วยกันได้

metrics

metrics=ga:sessions,ga:bounces

ต้องระบุ

สถิติแบบรวมสำหรับกิจกรรมของผู้ใช้ในเว็บไซต์ของคุณ เช่น การคลิกหรือการดูหน้าเว็บ หากการค้นหาไม่มีพารามิเตอร์ dimensions เมตริกที่แสดงผลจะแสดงค่ารวมสำหรับช่วงวันที่ที่ขอ เช่น การดูหน้าเว็บโดยรวมหรือการตีกลับทั้งหมด อย่างไรก็ตาม เมื่อมีการขอมิติข้อมูล ระบบจะแบ่งกลุ่มค่าตามค่ามิติข้อมูล ตัวอย่างเช่น คำขอ ga:pageviews ด้วย ga:country จะแสดงผลการดูหน้าเว็บทั้งหมดต่อประเทศ ข้อควรทราบเมื่อขอเมตริกมีดังนี้

คำขอใดก็ตามต้องมีเมตริกอย่างน้อย 1 รายการ โดยคำขอต้องไม่มีเฉพาะมิติข้อมูล
คุณสามารถระบุเมตริกสำหรับการค้นหาได้สูงสุด 10 รายการ
ชุดค่าผสมของเมตริกส่วนใหญ่จากหลายๆ หมวดหมู่สามารถใช้ด้วยกันได้หากไม่ได้ระบุมิติข้อมูล
เมตริกใช้ร่วมกับมิติข้อมูลหรือเมตริกอื่นๆ ได้ แต่จะใช้ชุดค่าผสมที่ถูกต้องสำหรับเมตริกดังกล่าวเท่านั้น ดูรายละเอียดได้ที่การอ้างอิงมิติข้อมูลและเมตริก

จัดเรียง

sort=ga:country,ga:browser

ไม่บังคับ

รายการเมตริกและมิติข้อมูลที่ระบุลำดับการจัดเรียงและทิศทางการจัดเรียงสำหรับข้อมูลที่แสดงผล

การจัดเรียงลำดับจะระบุตามลำดับจากซ้ายไปขวาของเมตริกและมิติข้อมูลที่แสดงอยู่
directionการจัดเรียงจะมีค่าเริ่มต้นเป็นจากน้อยไปมาก และเปลี่ยนให้เป็นมากไปน้อยได้โดยใช้เครื่องหมายลบ (-) นำหน้าในช่องที่ขอ

การจัดเรียงผลการค้นหาจะช่วยให้คุณถามคำถามต่างๆ เกี่ยวกับข้อมูลของคุณได้ เช่น เพื่อตอบคำถามที่ว่า "ประเทศยอดนิยมของฉันคือประเทศใด และเบราว์เซอร์ใดที่ใช้มากที่สุด" คุณสามารถสร้างการค้นหาด้วยพารามิเตอร์ต่อไปนี้ โดยจะจัดเรียงตาม ga:country ก่อน แล้วจึงจัดเรียงตาม ga:browser โดยเรียงลำดับจากน้อยไปหามากดังนี้

sort=ga:country,ga:browser

หากต้องการตอบคำถามที่เกี่ยวข้องว่า "เบราว์เซอร์ยอดนิยมของฉันคืออะไร และประเทศใดที่ใช้เบราว์เซอร์ดังกล่าวมากที่สุด" คุณสามารถทำการค้นหาด้วยพารามิเตอร์ต่อไปนี้ โดยจะจัดเรียงตาม ga:browser ก่อน แล้วจึงจัดเรียงตาม ga:country โดยเรียงลำดับจากน้อยไปหามากดังนี้

sort=ga:browser,ga:country

โปรดคำนึงถึงสิ่งต่อไปนี้เมื่อใช้พารามิเตอร์ sort

จัดเรียงตามค่ามิติข้อมูลหรือค่าเมตริกที่คุณใช้ในพารามิเตอร์ dimensions หรือ metrics เท่านั้น หากคำขอจัดเรียงในช่องที่ไม่ได้ระบุไว้ในพารามิเตอร์มิติข้อมูลหรือเมตริก คุณจะได้รับข้อผิดพลาด
โดยค่าเริ่มต้น สตริงจะจัดเรียงตามลำดับตัวอักษรจากน้อยไปมากในภาษาen-US
ตามค่าเริ่มต้น ระบบจะจัดเรียงตัวเลขจากน้อยไปหามาก
วันที่จะเรียงลำดับจากน้อยไปหามากตามวันที่โดยค่าเริ่มต้น

ตัวกรอง

filters=ga:medium%3D%3Dreferral

ไวยากรณ์ตัวกรอง
โอเปอเรเตอร์ตัวกรอง
กรองนิพจน์
การรวมตัวกรอง
- โอเปอเรเตอร์ OR
- โอเปอเรเตอร์ AND

ไม่บังคับ

พารามิเตอร์สตริงคำค้นหา filters จะจำกัดข้อมูลที่แสดงผลจากคำขอของคุณ หากต้องการใช้พารามิเตอร์ filters ให้ระบุมิติข้อมูลหรือเมตริกที่ต้องการกรอง ตามด้วยนิพจน์ตัวกรอง เช่น การค้นหาต่อไปนี้จะส่งคำขอ ga:pageviews และ ga:browser สำหรับข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) 12134 โดยที่มิติข้อมูล ga:browser ขึ้นต้นด้วยสตริง Firefox

https://www.googleapis.com/analytics/v3/data/ga
?ids=ga:12134
&dimensions=ga:browser
&metrics=ga:pageviews
&filters=ga:browser%3D~%5EFirefox
&start-date=2007-01-01
&end-date=2007-12-31

การค้นหาที่กรองจะจํากัดแถวที่จะ (หรือไม่ได้) รวมในผลลัพธ์ ระบบจะทดสอบแต่ละแถวในผลลัพธ์กับตัวกรอง หากตัวกรองตรงกัน ระบบจะเก็บรักษาแถวนั้นไว้ และหากไม่ตรงกัน ระบบก็จะละทิ้งแถวนั้น

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

ไวยากรณ์ตัวกรอง

ตัวกรองรายการเดียวจะใช้แบบฟอร์มดังนี้

ga:name operator expression

ในรูปแบบไวยากรณ์นี้

name — ชื่อของมิติข้อมูลหรือเมตริกที่จะกรอง เช่น ตัวกรอง ga:pageviews ในเมตริกการดูหน้าเว็บ
โอเปอเรเตอร์ — กำหนดประเภทการจับคู่ตัวกรองที่จะใช้ โอเปอเรเตอร์จะใช้เฉพาะกับมิติข้อมูลหรือเมตริกอย่างใดอย่างหนึ่ง
นิพจน์ — ระบุค่าที่จะรวมหรือยกเว้นจากผลลัพธ์ นิพจน์ใช้ไวยากรณ์ของนิพจน์ทั่วไป

โอเปอเรเตอร์ตัวกรอง

มีโอเปอเรเตอร์ตัวกรอง 6 รายการสำหรับมิติข้อมูลและโอเปอเรเตอร์ตัวกรอง 6 รายการสำหรับเมตริก โอเปอเรเตอร์ต้องมีการเข้ารหัส URL เพื่อให้รวมอยู่ในสตริงการค้นหา URL

เคล็ดลับ: ใช้ตัวสำรวจการค้นหาฟีดข้อมูลเพื่อออกแบบตัวกรองที่ต้องเข้ารหัส URL เนื่องจากเครื่องมือสำรวจการค้นหาจะเข้ารหัส URL ที่มีสตริงและการเว้นวรรคโดยอัตโนมัติ

**ตัวกรองเมตริก**
ผู้ประกอบธุรกิจ	คำอธิบาย	แบบฟอร์มที่เข้ารหัส URL	ตัวอย่าง
`==`	เท่ากับ	`%3D%3D`	แสดงผลการค้นหาโดยให้เวลาบนหน้าเว็บเท่ากับ 10 วินาทีพอดี `filters=ga:timeOnPage%3D%3D10`
`!=`	ไม่เท่ากับ	`!%3D`	แสดงผลการค้นหาโดยที่เวลาบนหน้าเว็บไม่ใช่ 10 วินาที `filters=ga:timeOnPage!%3D10`
`>`	มากกว่า	`%3E`	แสดงผลการค้นหาที่มีเวลาบนหน้าเว็บมากกว่า 10 วินาทีอย่างเคร่งครัด: `filters=ga:timeOnPage%3E10`
`<`	น้อยกว่า	`%3C`	แสดงผลการค้นหาที่เวลาบนหน้าเว็บน้อยกว่า 10 วินาทีอย่างเคร่งครัด: `filters=ga:timeOnPage%3C10`
`>=`	มากกว่าหรือเท่ากับ	`%3E%3D`	แสดงผลการค้นหาที่มีเวลาบนหน้าเว็บเท่ากับ 10 วินาทีขึ้นไป `filters=ga:timeOnPage%3E%3D10`
`<=`	น้อยกว่าหรือเท่ากับ	`%3C%3D`	แสดงผลการค้นหาโดยที่เวลาบนหน้าเว็บไม่เกิน 10 วินาที `filters=ga:timeOnPage%3C%3D10`

**ตัวกรองมิติข้อมูล**
ผู้ประกอบธุรกิจ	คำอธิบาย	แบบฟอร์มที่เข้ารหัส URL	ตัวอย่าง
`==`	การทำงานแบบตรงทั้งหมด	`%3D%3D`	รวบรวมเมตริกที่มีเมือง Irvine: `filters=ga:city%3D%3DIrvine`
`!=`	ไม่ตรงกัน	`!%3D`	รวบรวมเมตริกที่เมืองไม่ใช่ เออร์ไวน์: `filters=ga:city!%3DIrvine`
`=@`	มีสตริงย่อย	`%3D@`	รวบรวมเมตริกที่เมืองมีคำว่า York: `filters=ga:city%3D@York`
`!@`	ไม่มีสตริงย่อย	`!@`	รวมเมตริกที่เมืองไม่มี York: `filters=ga:city!@York`
`=~`	มีรายการที่ตรงกันสำหรับนิพจน์ทั่วไป	`%3D~`	รวมเมตริกที่เมืองขึ้นต้นด้วยใหม่ `filters=ga:city%3D~%5ENew.*` (%5E คือ URL ที่เข้ารหัสจากอักขระ ^ ซึ่งเชื่อมโยงรูปแบบไปยังจุดเริ่มต้นของสตริง)
`!~`	ไม่ตรงกับนิพจน์ทั่วไป	`!~`	รวมเมตริกที่เมืองไม่ได้ขึ้นต้นด้วยใหม่: `filters=ga:city!~%5ENew.*`

กรองนิพจน์

มีกฎที่สำคัญ 2 ข้อสำหรับนิพจน์ตัวกรอง

อักขระที่สงวน URL — อักขระอย่าง & ต้องเข้ารหัส URL ด้วยวิธีปกติ
อักขระที่ห้ามใช้ — เครื่องหมายเซมิโคลอนและคอมมาจะต้องกำหนดเป็นแบ็กสแลชเป็นอักขระหลีกเมื่อปรากฏในนิพจน์
- เซมิโคลอน \;
- คอมมา \,
นิพจน์ทั่วไป — คุณยังใช้นิพจน์ทั่วไปในนิพจน์ตัวกรองได้โดยใช้โอเปอเรเตอร์ =~ และ !~ โดยไวยากรณ์คล้ายกับนิพจน์ทั่วไปของ Perl และมีกฎเพิ่มเติมต่อไปนี้
- ความยาวสูงสุด 128 อักขระ - นิพจน์ทั่วไปที่มีความยาวมากกว่า 128 อักขระจะส่งผลให้รหัสสถานะ 400 Bad Request แสดงผลจากเซิร์ฟเวอร์
- การคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ — การจับคู่นิพจน์ทั่วไปจะไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

ตัวกรอง

ตัวกรองสามารถรวมได้โดยใช้ตรรกะบูลีน OR และ AND วิธีนี้ช่วยให้คุณขยายขีดจำกัดอักขระสูงสุด 128 ตัวของนิพจน์ตัวกรองได้อย่างมีประสิทธิภาพ

หรือ

โอเปอเรเตอร์ OR กำหนดโดยใช้คอมมา (,) ซึ่งจะมีลำดับความสำคัญเหนือโอเปอเรเตอร์ AND และต้องไม่ใช้เพื่อรวมมิติข้อมูลและเมตริกในนิพจน์เดียวกัน

ตัวอย่าง: (แต่ละรายการจะต้องเป็น URL ที่เข้ารหัส)

ประเทศเป็นอย่างใดอย่างหนึ่งต่อไปนี้ (สหรัฐอเมริกาหรือแคนาดา):
ga:country==United%20States,ga:country==Canada

ผู้ใช้ Firefox ในระบบปฏิบัติการ (Windows หรือ Macintosh):
ga:browser==Firefox;ga:operatingSystem==Windows,ga:operatingSystem==Macintosh

และ

โอเปอเรเตอร์ AND กำหนดโดยใช้เครื่องหมายเซมิโคลอน (;) ซึ่งนำหน้าด้วยโอเปอเรเตอร์ OR และสามารถใช้ CAN เพื่อรวมมิติข้อมูลและเมตริกในนิพจน์เดียวกัน

ตัวอย่าง: (แต่ละรายการจะต้องเป็น URL ที่เข้ารหัส)

ประเทศคือสหรัฐอเมริกา และเบราว์เซอร์คือ Firefox
ga:country==United%20States;ga:browser==Firefox

ประเทศเป็นสหรัฐอเมริกา AND ภาษาไม่ได้ขึ้นต้นด้วย "en"
ga:country==United%20States;ga:language!~^en.*

ระบบปฏิบัติการคือ (Windows หรือ Macintosh) และเบราว์เซอร์คือ (Firefox หรือ Chrome):
ga:operatingSystem==Windows,ga:operatingSystem==Macintosh;ga:browser==Firefox,ga:browser==Chrome

ประเทศเป็นสหรัฐอเมริกา AND เซสชันมากกว่า 5:
ga:country==United%20States;ga:sessions>5

กลุ่ม

segment=gaid::-10

    segment=sessions::condition::ga:medium%3D%3Dreferral

    segment=users::condition::ga:browser%3D%3DChrome

ไม่บังคับ

โปรดดูรายละเอียดทั้งหมดเกี่ยวกับวิธีขอกลุ่มใน API การรายงานหลักที่คู่มือการพัฒนากลุ่ม

ดูภาพรวมแนวคิดของกลุ่มต่างๆ ได้ที่ข้อมูลอ้างอิงฟีเจอร์กลุ่มและ กลุ่มในศูนย์ช่วยเหลือ

อนุญาตให้ใช้มิติข้อมูลและเมตริกในกลุ่ม
มิติข้อมูลและเมตริกบางรายการไม่สามารถใช้ในกลุ่มได้ หากต้องการดูว่ามิติข้อมูลและเมตริกใดบ้างที่ได้รับอนุญาตในกลุ่ม ให้ไปที่ เครื่องมือสำรวจมิติข้อมูลและเมตริก

หมายเหตุ: เราเลิกใช้งานคำนำหน้า dynamic:: แล้วตั้งแต่วันที่ 27 มีนาคม 2014 ขอแนะนําให้คุณ ย้ายข้อมูลไปยังไวยากรณ์ใหม่โดยเร็วที่สุด

samplingLevel

samplingLevel=DEFAULT

ไม่บังคับ

ใช้พารามิเตอร์นี้เพื่อกำหนดระดับการสุ่มตัวอย่าง (จำนวนเซสชันที่ใช้ในการคำนวณผลลัพธ์) สำหรับการค้นหาการรายงาน ค่าที่อนุญาตสอดคล้องกับอินเทอร์เฟซเว็บและรวมถึง

DEFAULT — แสดงผลคำตอบที่มีขนาดตัวอย่างซึ่งรักษาสมดุลระหว่างความเร็วกับความแม่นยำ
FASTER — แสดงผลการตอบสนองอย่างรวดเร็วในขนาดการสุ่มตัวอย่างที่เล็กลง
HIGHER_PRECISION — แสดงผลคำตอบที่แม่นยำยิ่งขึ้นโดยใช้ขนาดตัวอย่างขนาดใหญ่ แต่อาจส่งผลให้การตอบสนองช้าลง

หากไม่ได้ระบุ ระบบจะใช้ระดับการสุ่มตัวอย่าง DEFAULT

ดูรายละเอียดเกี่ยวกับวิธีคำนวณเปอร์เซ็นต์ของเซสชันที่ใช้สำหรับการค้นหาได้ที่ส่วนการสุ่มตัวอย่าง

รวมแถวที่ว่าง

include-empty-rows=true

ไม่บังคับ

ค่าเริ่มต้นเป็น "จริง" หากตั้งค่าเป็น "เท็จ" แถวที่ค่าเมตริกทั้งหมดเป็น 0 จะไม่รวมอยู่ในคำตอบ ตัวอย่างเช่น หากคุณมีเมตริกมากกว่า 1 รายการในคำค้นหา ระบบจะนำแถวออกก็ต่อเมื่อค่าเมตริกทั้งหมดเป็น 0 วิธีนี้มีประโยชน์เมื่อส่งคําขอที่คาดว่าจะมีจำนวนแถวที่ถูกต้องน้อยกว่ามากเมื่อเทียบกับจํานวนค่ามิติข้อมูลที่คาดไว้

start-index

start-index=10

ไม่บังคับ

หากไม่ได้ระบุไว้ ดัชนีเริ่มต้นจะเป็น 1 (ดัชนีผลลัพธ์เป็นแบบ 1 กล่าวคือ แถวแรกคือแถว 1 ไม่ใช่แถว 0) ใช้พารามิเตอร์นี้เป็นกลไกการใส่เลขหน้าร่วมกับพารามิเตอร์ max-results สำหรับสถานการณ์ที่ totalResults เกิน 10,000 และคุณต้องการเรียกข้อมูลแถวที่มีการจัดทำดัชนีที่ 10,001 ขึ้นไป

max-results

max-results=100

ไม่บังคับ

จำนวนแถวสูงสุดที่จะรวมอยู่ในคำตอบนี้ คุณใช้ค่านี้ร่วมกับ start-index เพื่อเรียกข้อมูลชุดย่อยขององค์ประกอบได้ หรือใช้อย่างเดียวเพื่อจำกัดจำนวนองค์ประกอบที่แสดงผลโดยเริ่มจากรายการแรก หากไม่ระบุ max-results การค้นหาจะแสดงแถวสูงสุด 1, 000 แถวตามค่าเริ่มต้น

Analytics หลัก Reporting API แสดงผลแถวสูงสุด 10,000 แถวต่อคําขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม นอกจากนี้ ยังอาจแสดงผลแถวน้อยกว่าที่ขอด้วย หากไม่มีกลุ่มมิติข้อมูลมากเท่ากับที่คาดไว้ ตัวอย่างเช่น ค่าที่เป็นไปได้สำหรับ ga:country มีค่าน้อยกว่า 300 ค่า ดังนั้นเมื่อแบ่งกลุ่มตามประเทศเท่านั้น จะมีแถวได้ไม่เกิน 300 แถว แม้ว่าคุณจะตั้งค่า max-results เป็นค่าที่สูงกว่าก็ตาม

เอาต์พุต

output=dataTable

ไม่บังคับ

ใช้พารามิเตอร์นี้เพื่อตั้งค่าประเภทเอาต์พุตของข้อมูล Analytics ที่ส่งคืนในการตอบกลับ ค่าที่อนุญาตมีดังนี้

json - แสดงเอาต์พุตพร็อพเพอร์ตี้ rows เริ่มต้นในการตอบสนอง ซึ่งมีออบเจ็กต์ JSON
dataTable — แสดงพร็อพเพอร์ตี้ dataTable ในการตอบสนอง ซึ่งมีออบเจ็กต์ ตารางข้อมูล ออบเจ็กต์ Data Table นี้ใช้กับการแสดงข้อมูลผ่านภาพ Google Charts ได้โดยตรง

หากไม่ระบุ ระบบจะใช้การตอบสนอง JSON เริ่มต้น

Fields

fields=rows,columnHeaders(name,dataType)

ไม่บังคับ

ระบุช่องที่จะส่งคืนในการตอบกลับบางส่วน หากคุณใช้เพียงช่องย่อยในการตอบสนองของ API คุณจะใช้พารามิเตอร์ fields เพื่อระบุช่องที่จะใส่ได้

รูปแบบของค่าพารามิเตอร์คำขอของช่องจะอิงตามไวยากรณ์ XPath อย่างคร่าวๆ ดูสรุปไวยากรณ์ที่รองรับได้ที่ด้านล่าง

ใช้รายการที่คั่นด้วยเครื่องหมายจุลภาคเพื่อเลือกหลายช่อง
ใช้ a/b เพื่อเลือกช่อง b ที่ฝังอยู่ภายในช่อง a ให้ใช้ a/b/c เพื่อเลือกช่อง c ที่ฝังอยู่ภายใน b
ใช้ตัวเลือกย่อยเพื่อขอชุดช่องย่อยที่เจาะจงของอาร์เรย์หรือออบเจ็กต์โดยวางนิพจน์ในวงเล็บ "( )"
เช่น fields=columnHeaders(name,dataType) จะแสดงผลเฉพาะช่อง name และ dataType ในอาร์เรย์ columnHeaders หรือจะระบุช่องย่อยช่องเดียวก็ได้ ซึ่ง fields=columnHeader(name) เทียบเท่ากับ fields=columnHeader/name

prettyPrint

prettyPrint=false

ไม่บังคับ

แสดงผลคำตอบในรูปแบบที่มนุษย์อ่านได้ หาก true ค่าเริ่มต้น: false

quotaUser

quotaUser=4kh4r2h4

ไม่บังคับ

ช่วยให้คุณ บังคับใช้โควต้าต่อผู้ใช้จากแอปพลิเคชันฝั่งเซิร์ฟเวอร์ได้ในกรณีที่ไม่ทราบที่อยู่ IP ของผู้ใช้ ตัวอย่างเช่น กรณีนี้อาจเกิดขึ้นกับแอปพลิเคชันที่เรียกใช้งาน Cron บน App Engine ในนามของผู้ใช้ คุณเลือกสตริงที่กำหนดเองที่ระบุผู้ใช้ได้โดยไม่ซ้ำกัน แต่จำกัดอักขระที่ 40 ตัว

การดำเนินการนี้จะลบล้าง userIp หากมีการระบุทั้ง 2 อย่าง

คำตอบ

หากสำเร็จ คำขอนี้จะแสดงผลเนื้อหาการตอบกลับที่มีโครงสร้าง JSON ตามที่ระบุไว้ด้านล่าง หากพารามิเตอร์ output ตั้งค่าเป็น dataTable คำขอจะแสดงผลเนื้อหาการตอบกลับที่มีโครงสร้าง JSON (ตารางข้อมูล) ที่กำหนดไว้ด้านล่าง

หมายเหตุ: คำว่า "ผลลัพธ์" หมายถึงแถวทั้งชุดที่ตรงกับคำค้นหา ส่วน "response" หมายถึงชุดแถวที่แสดงในหน้าปัจจุบันของผลการค้นหา และอาจแตกต่างกันหากจำนวนผลลัพธ์ทั้งหมดมากกว่าขนาดหน้าเว็บสำหรับคำตอบปัจจุบัน ตามที่อธิบายไว้ใน itemsPerPage

JSON

{
  "kind": "analytics#gaData",
  "id": string,
  "selfLink": string,
  "containsSampledData": boolean,
  "query": {
    "start-date": string,
    "end-date": string,
    "ids": string,
    "dimensions": [
      string
    ],
    "metrics": [
      string
    ],
    "include-empty-rows": boolean
    "samplingLevel": string,
    "sort": [
      string
    ],
    "filters": string,
    "segment": string,
    "start-index": integer,
    "max-results": integer
  },
  "itemsPerPage": integer,
  "totalResults": integer,
  "previousLink": string,
  "nextLink": string,
  "profileInfo": {
    "profileId": string,
    "accountId": string,
    "webPropertyId": string,
    "internalWebPropertyId": string,
    "profileName": string,
    "tableId": string
  },
  "columnHeaders": [
    {
      "name": string,
      "columnType": string,
      "dataType": string
    }
  ],
  "rows": [
    [
      string
    ]
  ],
  "sampleSize": string,
  "sampleSpace": string,
  "totalsForAllResults": [
    {
      metricName: string,
      ...
    }
  ]
}

ช่องคำตอบ

สมบัติของโครงสร้างโครงสร้างการตอบสนองมีดังนี้

ชื่อพร็อพเพอร์ตี้	ค่า	คำอธิบาย
`kind`	`string`	ประเภททรัพยากร ค่าคือ "analytics#gaData"
`id`	`string`	รหัสสำหรับการตอบกลับข้อมูลนี้
`query`	`object`	ออบเจ็กต์นี้มีค่าทั้งหมดที่ส่งผ่านเป็นพารามิเตอร์ไปยังการค้นหา ความหมายของแต่ละช่องอธิบายอยู่ในคำอธิบายของพารามิเตอร์การค้นหาที่เกี่ยวข้อง
`query.start-date`	`string`	วันที่เริ่มต้น
`query.end-date`	`string`	วันที่สิ้นสุด
`query.ids`	`string`	รหัสตารางที่ไม่ซ้ำกัน
`query.dimensions[]`	`list`	รายการมิติข้อมูลการวิเคราะห์
`query.metrics[]`	`list`	รายการเมตริกข้อมูลวิเคราะห์
`query.samplingLevel`	`string`	`Requested sampling level.`
`query.include-empty-rows`	`boolean`	ค่าเริ่มต้นคือ "จริง" หากตั้งค่าเป็น "เท็จ" แถวที่ค่าเมตริกทั้งหมดเป็น 0 จะไม่รวมอยู่ในคำตอบ
`query.sort[]`	`list`	รายการเมตริกหรือมิติข้อมูลที่จัดเรียงข้อมูล
`query.filters`	`string`	รายการเมตริกหรือตัวกรองมิติข้อมูลที่คั่นด้วยคอมมา
`query.segment`	`string`	กลุ่ม Analytics
`query.start-index`	`integer`	ดัชนีเริ่มต้น
`query.max-results`	`integer`	ผลลัพธ์สูงสุดต่อหน้า
`startIndex`	`integer`	ดัชนีเริ่มต้นของแถวที่ระบุโดยพารามิเตอร์การค้นหา `start-index` ค่าเริ่มต้นคือ 1
`itemsPerPage`	`integer`	จำนวนแถวสูงสุดที่การตอบกลับมีได้ โดยไม่คำนึงถึงจำนวนแถวที่แสดงผลจริง หากระบุพารามิเตอร์การค้นหา `max-results` ไว้ ค่าของ `itemsPerPage` จะน้อยกว่า `max-results` หรือ 10,000 ค่าเริ่มต้นของ `itemsPerPage` คือ 1,000
`totalResults`	`integer`	จำนวนแถวทั้งหมดในผลการค้นหา โดยไม่คำนึงถึงจำนวนแถวที่แสดงในคำตอบ สำหรับการค้นหาที่ส่งผลให้เกิดแถวจำนวนมาก `totalResults` อาจมากกว่า `itemsPerPage` ได้ ดูคำอธิบายเพิ่มเติมของ `totalResults` และ `itemsPerPage` สำหรับคำค้นหาขนาดใหญ่ได้ในการแบ่งหน้า
`startDate`	`string`	วันที่เริ่มต้นของการค้นหาข้อมูลตามที่พารามิเตอร์ `start-date` ระบุไว้
`endDate`	`string`	วันที่สิ้นสุดของการค้นหาข้อมูลตามที่พารามิเตอร์ `end-date` ระบุไว้
`selfLink`	`string`	ลิงก์ไปที่หน้านี้ของผลการค้นหาสำหรับการค้นหาข้อมูลนี้
`previousLink`	`string`	ลิงก์ไปยังหน้าก่อนหน้าของผลการค้นหาสำหรับการค้นหาข้อมูลนี้
`nextLink`	`string`	ลิงก์ไปยังหน้าถัดไปของผลการค้นหาสำหรับการค้นหาข้อมูลนี้
`profileInfo`	`object`	ข้อมูลเกี่ยวกับข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) ที่มีการขอข้อมูล ดูข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) ได้ผ่าน Google Analytics Management API
`profileInfo.profileId`	`string`	รหัส (โปรไฟล์) เช่น `1174`
`profileInfo.accountId`	`string`	รหัสบัญชีของข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) นี้ เช่น `30481`
`profileInfo.webPropertyId`	`string`	รหัสเว็บพร็อพเพอร์ตี้ที่เป็นเจ้าของข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) นี้ เช่น `UA-30481-1`
`profileInfo.internalWebPropertyId`	`string`	รหัสภายในสำหรับเว็บพร็อพเพอร์ตี้ที่เป็นเจ้าของข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) นี้ เช่น `UA-30481-1`
`profileInfo.profileName`	`string`	ชื่อของข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์)
`profileInfo.tableId`	`string`	รหัสตารางของข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) ซึ่งประกอบด้วย "ga:" ตามด้วยรหัสข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์)
`containsSampledData`	`boolean`	เป็นจริงหากการตอบกลับมีข้อมูลตัวอย่าง
`sampleSize`	`string`	จำนวนตัวอย่างที่ใช้ในการคำนวณข้อมูลจากการสุ่มตัวอย่าง
`sampleSpace`	`string`	ขนาดพื้นที่การสุ่มตัวอย่างทั้งหมด ข้อมูลนี้ระบุขนาดพื้นที่ตัวอย่างทั้งหมดซึ่งมีการเลือกตัวอย่าง
`columnHeaders[]`	`list`	ส่วนหัวคอลัมน์ที่แสดงชื่อมิติข้อมูลตามด้วยชื่อเมตริก ลำดับของมิติข้อมูลและเมตริกเหมือนกับที่ระบุไว้ในคำขอผ่านพารามิเตอร์ `metrics` และ `dimensions` จำนวนส่วนหัวคือจำนวนมิติข้อมูล + จำนวนเมตริก
`columnHeaders[].name`	`string`	ชื่อของมิติข้อมูลหรือเมตริก
`columnHeaders[].columnType`	`string`	ประเภทคอลัมน์ "DIMENSION" หรือ "METRIC"
`columnHeaders[].dataType`	`string`	ประเภทข้อมูล ส่วนหัวคอลัมน์มิติข้อมูลมีประเภทข้อมูลเพียง `STRING` เท่านั้น ส่วนหัวของคอลัมน์เมตริกมีประเภทข้อมูลสำหรับค่าเมตริก เช่น `INTEGER`, `PERCENT`, `TIME`, `CURRENCY`, `FLOAT` ฯลฯ ดูการตอบกลับ API ข้อมูลเมตาสำหรับข้อมูลประเภทที่เป็นไปได้ทั้งหมด
`totalsForAllResults`	`object`	ค่ารวมสำหรับเมตริกที่ขอในรูปแบบคู่คีย์-ค่าของชื่อและค่าเมตริก ลำดับของผลรวมของเมตริกจะเหมือนกับลำดับเมตริกที่ระบุในคำขอ
`rows[]`	`list`	แถวข้อมูล Analytics ซึ่งแต่ละแถวจะมีรายการค่ามิติข้อมูลตามด้วยค่าเมตริก ลำดับของมิติข้อมูลและเมตริกเหมือนกับที่ระบุไว้ในคำขอ แต่ละแถวมีรายการช่อง N ช่อง โดยที่ N = จำนวนมิติข้อมูล + จำนวนเมตริก

JSON (ตารางข้อมูล)

{
  "kind": "analytics#gaData",
  "id": string,
  "selfLink": string,
  "containsSampledData": boolean,
  "query": {
    "start-date": string,
    "end-date": string,
    "ids": string,
    "dimensions": [
      string
    ],
    "metrics": [
      string
    ],
    "samplingLevel": string,
    "include-empty-rows": boolean,
    "sort": [
      string
    ],
    "filters": string,
    "segment": string,
    "start-index": integer,
    "max-results": integer
  },
  "itemsPerPage": integer,
  "totalResults": integer,
  "previousLink": string,
  "nextLink": string,
  "profileInfo": {
    "profileId": string,
    "accountId": string,
    "webPropertyId": string,
    "internalWebPropertyId": string,
    "profileName": string,
    "tableId": string
  },
  "columnHeaders": [
    {
      "name": string,
      "columnType": string,
      "dataType": string
    }
  ],
  "dataTable": {
    "cols": [
      {
        "id": string,
        "label": string,
        "type": string
      }
    ],
    "rows": [
      {
        "c": [
          {    
            "v": string
          }
        ]
      }   
    ]
  },
  "sampleSize": string,
  "sampleSpace": string,
  "totalsForAllResults": [
    {
      metricName: string,
      ...
    }
  ]
}

ช่องคำตอบ

สมบัติของโครงสร้างโครงสร้างการตอบสนองมีดังนี้

ชื่อพร็อพเพอร์ตี้	ค่า	คำอธิบาย
`kind`	`string`	ประเภททรัพยากร ค่าคือ "analytics#gaData"
`id`	`string`	รหัสสำหรับการตอบกลับข้อมูลนี้
`query`	`object`	ออบเจ็กต์นี้มีค่าทั้งหมดที่ส่งผ่านเป็นพารามิเตอร์ไปยังการค้นหา ความหมายของแต่ละช่องอธิบายอยู่ในคำอธิบายของพารามิเตอร์การค้นหาที่เกี่ยวข้อง
`query.start-date`	`string`	วันที่เริ่มต้น
`query.end-date`	`string`	วันที่สิ้นสุด
`query.ids`	`string`	รหัสตารางที่ไม่ซ้ำกัน
`query.dimensions[]`	`list`	รายการมิติข้อมูลการวิเคราะห์
`query.metrics[]`	`list`	รายการเมตริกข้อมูลวิเคราะห์
`query.samplingLevel`	`string`	`Requested sampling level.`
`query.include-empty-rows`	`boolean`	ค่าเริ่มต้นคือ "จริง" หากตั้งค่าเป็น "เท็จ" แถวที่ค่าเมตริกทั้งหมดเป็น 0 จะไม่รวมอยู่ในคำตอบ
`query.sort[]`	`list`	รายการเมตริกหรือมิติข้อมูลที่จัดเรียงข้อมูล
`query.filters`	`string`	รายการเมตริกหรือตัวกรองมิติข้อมูลที่คั่นด้วยคอมมา
`query.segment`	`string`	กลุ่ม Analytics
`query.start-index`	`integer`	ดัชนีเริ่มต้น
`query.max-results`	`integer`	ผลลัพธ์สูงสุดต่อหน้า
`startIndex`	`integer`	ดัชนีเริ่มต้นของแถวที่ระบุโดยพารามิเตอร์การค้นหา `start-index` ค่าเริ่มต้นคือ 1
`itemsPerPage`	`integer`	จำนวนแถวสูงสุดที่การตอบกลับมีได้ โดยไม่คำนึงถึงจำนวนแถวที่แสดงผลจริง หากระบุพารามิเตอร์การค้นหา `max-results` ไว้ ค่าของ `itemsPerPage` จะน้อยกว่า `max-results` หรือ 10,000 ค่าเริ่มต้นของ `itemsPerPage` คือ 1,000
`totalResults`	`integer`	จำนวนแถวทั้งหมดในผลการค้นหา โดยไม่คำนึงถึงจำนวนแถวที่แสดงในคำตอบ สำหรับการค้นหาที่ส่งผลให้เกิดแถวจำนวนมาก `totalResults` อาจมากกว่า `itemsPerPage` ได้ ดูคำอธิบายเพิ่มเติมของ `totalResults` และ `itemsPerPage` สำหรับคำค้นหาขนาดใหญ่ได้ในการแบ่งหน้า
`startDate`	`string`	วันที่เริ่มต้นของการค้นหาข้อมูลตามที่พารามิเตอร์ `start-date` ระบุไว้
`endDate`	`string`	วันที่สิ้นสุดของการค้นหาข้อมูลตามที่พารามิเตอร์ `end-date` ระบุไว้
`selfLink`	`string`	ลิงก์ไปที่หน้านี้ของผลการค้นหาสำหรับการค้นหาข้อมูลนี้
`previousLink`	`string`	ลิงก์ไปยังหน้าก่อนหน้าของผลการค้นหาสำหรับการค้นหาข้อมูลนี้
`nextLink`	`string`	ลิงก์ไปยังหน้าถัดไปของผลการค้นหาสำหรับการค้นหาข้อมูลนี้
`profileInfo`	`object`	ข้อมูลเกี่ยวกับข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) ที่มีการขอข้อมูล ดูข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) ได้ผ่าน Google Analytics Management API
`profileInfo.profileId`	`string`	รหัส (โปรไฟล์) เช่น `1174`
`profileInfo.accountId`	`string`	รหัสบัญชีของข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) นี้ เช่น `30481`
`profileInfo.webPropertyId`	`string`	รหัสเว็บพร็อพเพอร์ตี้ที่เป็นเจ้าของข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) นี้ เช่น `UA-30481-1`
`profileInfo.internalWebPropertyId`	`string`	รหัสภายในสำหรับเว็บพร็อพเพอร์ตี้ที่เป็นเจ้าของข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) นี้ เช่น `UA-30481-1`
`profileInfo.profileName`	`string`	ชื่อของข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์)
`profileInfo.tableId`	`string`	รหัสตารางของข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์) ซึ่งประกอบด้วย "ga:" ตามด้วยรหัสข้อมูลพร็อพเพอร์ตี้ (โปรไฟล์)
`containsSampledData`	`boolean`	เป็นจริงหากการตอบกลับมีข้อมูลตัวอย่าง
`sampleSize`	`string`	จำนวนตัวอย่างที่ใช้ในการคำนวณข้อมูลจากการสุ่มตัวอย่าง
`sampleSpace`	`string`	ขนาดพื้นที่การสุ่มตัวอย่างทั้งหมด ข้อมูลนี้ระบุขนาดพื้นที่ตัวอย่างทั้งหมดซึ่งมีการเลือกตัวอย่าง
`columnHeaders[]`	`list`	ส่วนหัวคอลัมน์ที่แสดงชื่อมิติข้อมูลตามด้วยชื่อเมตริก ลำดับของมิติข้อมูลและเมตริกเหมือนกับที่ระบุไว้ในคำขอผ่านพารามิเตอร์ `metrics` และ `dimensions` จำนวนส่วนหัวคือจำนวนมิติข้อมูล + จำนวนเมตริก
`columnHeaders[].name`	`string`	ชื่อของมิติข้อมูลหรือเมตริก
`columnHeaders[].columnType`	`string`	ประเภทคอลัมน์ "DIMENSION" หรือ "METRIC"
`columnHeaders[].dataType`	`string`	ประเภทข้อมูล ส่วนหัวคอลัมน์มิติข้อมูลมีประเภทข้อมูลเพียง `STRING` เท่านั้น ส่วนหัวของคอลัมน์เมตริกมีประเภทข้อมูลสำหรับค่าเมตริก เช่น `INTEGER`, `PERCENT`, `TIME`, `CURRENCY`, `FLOAT` ฯลฯ ดูการตอบกลับ API ข้อมูลเมตาสำหรับข้อมูลประเภทที่เป็นไปได้ทั้งหมด
`totalsForAllResults`	`object`	ค่ารวมสำหรับเมตริกที่ขอในรูปแบบคู่คีย์-ค่าของชื่อและค่าเมตริก ลำดับของผลรวมของเมตริกจะเหมือนกับลำดับเมตริกที่ระบุไว้ในคำขอ
`dataTable`	`object`	ออบเจ็กต์ตารางข้อมูลที่ใช้กับ Google แผนภูมิได้
`dataTable.cols[]`	`list`	รายการข้อบ่งชี้คอลัมน์สำหรับมิติข้อมูลตามด้วยเมตริก ลำดับของมิติข้อมูลและเมตริกจะเหมือนกับที่ระบุไว้ในคำขอผ่านพารามิเตอร์ `metrics` และ `dimensions` จำนวนคอลัมน์คือจำนวนมิติข้อมูล + จำนวนเมตริก
`dataTable.cols[].id`	`string`	รหัสที่ใช้อ้างถึงคอลัมน์หนึ่งๆ ได้ (เป็นทางเลือกในการใช้ดัชนีของคอลัมน์) รหัสมิติข้อมูลหรือเมตริกจะใช้ในการตั้งค่านี้
`dataTable.cols[].label`	`string`	ป้ายกำกับของคอลัมน์ (ซึ่งอาจแสดงโดยการแสดงภาพ) รหัสมิติข้อมูลหรือเมตริกจะใช้ในการตั้งค่านี้
`dataTable.cols[].type`	`string`	ประเภทข้อมูลสำหรับคอลัมน์นี้
`dataTable.rows[]`	`list`	แถวข้อมูล Analytics ในรูปแบบตารางข้อมูล ซึ่งแต่ละแถวคือออบเจ็กต์ที่มีรายการค่าของเซลล์สำหรับมิติข้อมูลตามด้วยเมตริก ลำดับของมิติข้อมูลและเมตริกเหมือนกับที่ระบุไว้ในคำขอ แต่ละเซลล์มีรายการช่อง N ช่อง โดยที่ N = จำนวนมิติข้อมูล + จำนวนเมตริก

รหัสข้อผิดพลาด

Core Reporting API จะแสดงรหัสสถานะ HTTP 200 หากคําขอสําเร็จ หากเกิดข้อผิดพลาดระหว่างการประมวลผลการค้นหา API จะแสดงผลรหัสข้อผิดพลาดและคำอธิบาย แต่ละแอปพลิเคชันที่ใช้ Analytics API จะต้องใช้ตรรกะการจัดการข้อผิดพลาดที่เหมาะสม อ่านรายละเอียดเกี่ยวกับรหัสข้อผิดพลาดและวิธีจัดการได้ใน คู่มืออ้างอิงสำหรับการตอบกลับข้อผิดพลาด

ลองเลย

คุณสามารถลองใช้การค้นหาใน Core Reporting API ได้

หากต้องการดูชุดค่าผสมที่ถูกต้องของเมตริกและมิติข้อมูลในการค้นหา ให้ป้อนค่าตัวอย่างสำหรับพารามิเตอร์ในเครื่องมือสำรวจการค้นหา ผลลัพธ์ของการค้นหาตัวอย่างจะแสดงเป็นตารางที่มีค่าสำหรับเมตริกและมิติข้อมูลที่ระบุทั้งหมด
หากต้องการส่งคำขอเกี่ยวกับข้อมูลที่เผยแพร่และดูการตอบกลับในรูปแบบ JSON ให้ลองใช้เมธอด analytics.data.ga.get ใน Google Data API Explorer

ทดสอบผลิตภัณฑ์

Google Analytics จะคำนวณชุดค่าผสมของมิติข้อมูลและเมตริกบางอย่างทันที หากต้องการให้ส่งคืนข้อมูลภายในเวลาที่เหมาะสม Google Analytics อาจประมวลผลเฉพาะข้อมูลตัวอย่างเท่านั้น

คุณระบุระดับการสุ่มตัวอย่างที่จะใช้สำหรับคำขอได้โดยการตั้งค่าพารามิเตอร์ samplingLevel

หากการตอบกลับจาก Core Reporting API มีข้อมูลตัวอย่าง ช่องการตอบกลับ containsSampledData จะเป็น true นอกจากนี้ พร็อพเพอร์ตี้ 2 รายการจะให้ข้อมูลเกี่ยวกับระดับการสุ่มตัวอย่างสำหรับการค้นหา ได้แก่ sampleSize และ sampleSpace ด้วย 2 ค่านี้ คุณจะคำนวณเปอร์เซ็นต์ของเซสชันที่ใช้สำหรับการค้นหาได้ ตัวอย่างเช่น หาก sampleSize คือ 201,000 และ sampleSpace คือ 220,000 รายงานจะอิงตาม (201,000 / 220,000) * 100 = 91.36% ของเซสชัน

ดูการสุ่มตัวอย่างสำหรับคำอธิบายทั่วไปของการสุ่มตัวอย่างและวิธีนำไปใช้ใน Google Analytics

การจัดการผลลัพธ์ของข้อมูลขนาดใหญ่

หากต้องการให้การค้นหาแสดงผลชุดผลลัพธ์ขนาดใหญ่ ให้ใช้หลักเกณฑ์ด้านล่างเพื่อช่วยเพิ่มประสิทธิภาพการค้นหา API, หลีกเลี่ยงข้อผิดพลาด และลดการใช้งานเกินโควต้า โปรดทราบว่าเรากำหนดพื้นฐานประสิทธิภาพโดยอนุญาตให้มีมิติข้อมูลสูงสุด 7 รายการและเมตริก 10 รายการในคําขอ API 1 รายการ แม้ว่าการค้นหาบางรายการที่ระบุเมตริกและมิติข้อมูลจำนวนมากอาจใช้เวลาประมวลผลนานกว่าการค้นหาอื่นๆ แต่การจำกัดจำนวนเมตริกที่ขออาจไม่เพียงพอที่จะปรับปรุงประสิทธิภาพการค้นหา แต่คุณใช้เทคนิคต่อไปนี้เพื่อผลลัพธ์ด้านประสิทธิภาพที่ดีที่สุดได้

การลดมิติข้อมูลต่อการค้นหา

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

การแยกข้อความค้นหาตามช่วงวันที่

ลองสร้างการค้นหาแยกกันเป็นเวลา 1 สัปดาห์หรือครั้งละ 1 วัน แทนที่จะเปิดดูผลการค้นหาที่อิงตามวันที่ในช่วงวันที่ยาวๆ เพียงช่วงเดียว แน่นอนว่าสำหรับชุดข้อมูลขนาดใหญ่ แม้แต่คำขอข้อมูลของวันเดียวก็อาจแสดงผลมากกว่า max-results ซึ่งในกรณีนี้คุณจะหลีกเลี่ยงการแบ่งหน้าไม่ได้ แต่ไม่ว่าในกรณีใด หากจำนวนแถวที่ตรงกับคำค้นหาของคุณสูงกว่า max-results การแยกช่วงวันที่อาจลดเวลารวมในการดึงข้อมูลผลลัพธ์ แนวทางนี้ช่วยปรับปรุงประสิทธิภาพได้ทั้งในการค้นหาแบบชุดข้อความเดี่ยวและคู่ขนาน

การกำหนดหน้า

การแบ่งหน้าผ่านผลลัพธ์อาจเป็นวิธีที่มีประโยชน์ในการแบ่งชุดผลลัพธ์ขนาดใหญ่ออกเป็นส่วนๆ ที่จัดการได้ ช่อง totalResults จะบอกจำนวนแถวที่ตรงกัน และ itemsPerPage ให้จำนวนแถวสูงสุดที่แสดงผลในผลลัพธ์ได้ หากมีอัตราส่วน totalResults ต่อ itemsPerPage สูง การค้นหาแต่ละรายการอาจใช้เวลานานกว่าที่จำเป็น หากต้องการแถวในจำนวนที่จำกัด เช่น เพื่อการแสดงผล คุณอาจสะดวกที่จะตั้งขีดจำกัดที่ชัดเจนเกี่ยวกับขนาดคำตอบผ่านพารามิเตอร์ max-results อย่างไรก็ตาม หากแอปพลิเคชันต้องประมวลผลผลลัพธ์จำนวนมากทั้งหมด การขอจำนวนแถวสูงสุดที่อนุญาตอาจมีประสิทธิภาพมากกว่า

การใช้ gzip

วิธีที่ง่ายและสะดวกในการลดแบนด์วิดท์ที่ต้องใช้สำหรับแต่ละคำขอคือการเปิดใช้การบีบอัด gzip แม้ว่าการดำเนินการนี้จะต้องใช้เวลา CPU เพิ่มเติมในการยกเลิกการบีบอัดผลลัพธ์ แต่การแลกกับค่าใช้จ่ายของเครือข่ายมักทำให้คุ้มค่ามาก หากต้องการได้รับการตอบกลับที่เข้ารหัสด้วย gzip คุณต้องทำ 2 อย่าง ได้แก่ ตั้งค่าส่วนหัว Accept-Encoding และแก้ไข User Agent ให้มีสตริง gzip ต่อไปนี้คือตัวอย่างของส่วนหัว HTTP ที่มีรูปแบบถูกต้องสำหรับการเปิดใช้การบีบอัด gzip

Accept-Encoding: gzip
User-Agent: my program (gzip)