API การรายงานหลัก - คู่มืออ้างอิง

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

Google Analytics Reporting API มีเวอร์ชันที่อัปเดตแล้ว เราขอแนะนําให้ย้ายข้อมูลโค้ดวันนี้เพื่อใช้ประโยชน์จากฟีเจอร์สําคัญของ API ใหม่

บทนำ

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

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

รหัส

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

ต้องระบุ

คําขอข้อมูล 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)

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=ga:sessions,ga:bounces

ต้องระบุ

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

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

---

จัดเรียง

sort=ga:country,ga:browser

ไม่บังคับ

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

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

การจัดเรียงผลลัพธ์ของการค้นหาช่วยให้คุณถามคําถามที่แตกต่างกันเกี่ยวกับข้อมูลของคุณได้ เช่น หากต้องการตอบคําถามที่ว่า "" ประเทศยอดนิยมของฉันประเทศใด และเบราว์เซอร์ใดที่ใช้ส่วนใหญ่ {5/} คุณก็สร้างการสืบค้นข้อมูลด้วยพารามิเตอร์ต่อไปนี้ได้ จะจัดเรียงตาม ga:country ก่อน จากนั้นก็ตามด้วย ga:browser ทั้งคู่ตามลําดับจากน้อยไปหามาก ดังนี้

sort=ga:country,ga:browser

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

sort=ga:browser,ga:country

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

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

---

ตัวกรอง

filters=ga:medium%3D%3Dreferral

1. ไวยากรณ์ตัวกรอง
2. โอเปอเรเตอร์ตัวกรอง
3. กรองนิพจน์
4. การรวมตัวกรอง
   • หรือโอเปอเรเตอร์
   • โอเปอเรเตอร์ 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 ได้

เคล็ดลับ: ใช้ Data Explorer Query ของฟีดข้อมูลเพื่อออกแบบตัวกรองที่ต้องการการเข้ารหัส 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	เมตริกรวมที่เมืองคือเออร์ไวน์ filters=ga:city%3D%3DIrvine
!=	ไม่ตรงกัน	!%3D	รวบรวมเมตริกที่เมืองไม่ใช่เออร์ไวน์ filters=ga:city!%3DIrvine
=@	มีสตริงย่อย	%3D@	รวบรวมเมตริกที่เมืองมียอร์ก filters=ga:city%3D@York
!@	ไม่มีสตริงย่อย	!@	รวบรวมเมตริกที่เมืองไม่มียอร์ก filters=ga:city!@York
=~	มีการจับคู่สําหรับนิพจน์ทั่วไป	%3D~	เมตริกรวมที่เมืองขึ้นต้นด้วยใหม่: filters=ga:city%3D~%5ENew.* (%5E คือ URL ที่เข้ารหัสจากอักขระ ^ ที่ยึดรูปแบบไว้หน้าสตริง)
!~	ไม่ตรงกับนิพจน์ทั่วไป	!~	รวบรวมเมตริกที่ไม่ได้เริ่มเมืองด้วยใหม่: filters=ga:city!~%5ENew.*

กรองนิพจน์

กฎสําคัญ 2-3 ข้อสําหรับนิพจน์ตัวกรองมีดังนี้

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

ตัวกรองรวม

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

หรือ

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

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

ประเทศ (สหรัฐอเมริกาหรือแคนาดา):
ga:country==United%20States,ga:country==Canada

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

และ

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

ตัวอย่าง: (แต่ละรายการจะต้องเข้ารหัส 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

ประเทศคือสหรัฐอเมริกา "และ" มากกว่า 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

ไม่บังคับ

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

สําหรับภาพรวมของแนวคิดของกลุ่ม โปรดดูการอ้างอิงฟีเจอร์กลุ่มและกลุ่มในศูนย์ช่วยเหลือ

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

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

---

ระดับการสุ่มตัวอย่าง

samplingLevel=DEFAULT

ไม่บังคับ

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

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

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

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

---

รวมแถวว่าง

include-empty-rows=true

ไม่บังคับ

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

---

ดัชนีเริ่มต้น

start-index=10

ไม่บังคับ

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

---

ผลลัพธ์สูงสุด

max-results=100

ไม่บังคับ

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

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

---

เอาต์พุต

output=dataTable

ไม่บังคับ

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

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

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

---

Fields

fields=rows,columnHeaders(name,dataType)

ไม่บังคับ

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

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

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

---

ภาพก่อนพิมพ์

prettyPrint=false

ไม่บังคับ

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

---

ผู้ใช้โควต้า

quotaUser=4kh4r2h4

ไม่บังคับ

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

การดําเนินการนี้จะลบล้าง userIp หากมีการระบุไว้ทั้ง 2 รายการ

---

คำตอบ

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

หมายเหตุ: คําว่า "results" หมายถึงชุดแถวทั้งหมดที่ตรงกับคําค้นหา ขณะที่ "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 คือ 1000
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 คือ 1000
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 Charts ได้
dataTable.cols[]	list	รายการตัวบ่งชี้คอลัมน์สําหรับมิติข้อมูลตามด้วยเมตริก ลําดับของมิติข้อมูลและเมตริกตรงกับที่ระบุไว้ในคําขอผ่านพารามิเตอร์ metrics และ dimensions จํานวนคอลัมน์คือจํานวนมิติข้อมูล + จํานวนเมตริก
dataTable.cols[].id	string	รหัสที่ใช้เพื่ออ้างถึงคอลัมน์ที่เจาะจงได้ (เป็นทางเลือกแทนการใช้ดัชนีคอลัมน์) รหัสมิติข้อมูลหรือเมตริก ใช้สําหรับตั้งค่าค่านี้
dataTable.cols[].label	string	ป้ายกํากับสําหรับคอลัมน์ (ซึ่งอาจแสดงด้วยภาพ) รหัสมิติข้อมูลหรือเมตริกใช้เพื่อกําหนดค่านี้
dataTable.cols[].type	string	ประเภทข้อมูลสําหรับคอลัมน์นี้
dataTable.rows[]	list	แถวข้อมูล Analytics ในรูปแบบตารางข้อมูล โดยแต่ละแถวคือออบเจ็กต์ที่มีรายการค่าของเซลล์สําหรับมิติข้อมูลตามด้วยเมตริก ลําดับของมิติข้อมูลและเมตริกตรงกับที่ระบุไว้ในคําขอ แต่ละเซลล์จะมีรายการช่อง N ซึ่ง โดยที่ N = จํานวนมิติข้อมูล + จํานวนเมตริก

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

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

ลองเลย

คุณจะลองใช้คําค้นหา API การรายงานหลักได้

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

• หากต้องการส่งคําขอเกี่ยวกับข้อมูลสดและดูการตอบกลับในรูปแบบ JSON ให้ลองใช้เมธอด analytics.data.ga.get ใน Google Data API Explorer

การสุ่มตัวอย่าง

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

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

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

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

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

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

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

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

การแบ่งคําค้นหาตามช่วงวันที่

แทนที่จะแบ่งเป็นหน้าผลลัพธ์ตามช่วงวันที่ที่ระบุซึ่งมีระยะเวลานาน 1 วัน ให้พิจารณาสร้างคําค้นหาแยกต่างหากสําหรับ 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)