API Reference

ข้อมูลอ้างอิง API นี้จัดเรียงตามประเภททรัพยากร ทรัพยากรแต่ละประเภทจะมีการนําเสนอข้อมูลอย่างน้อย 1 รายการและวิธีการอย่างน้อย 1 วิธี

ประเภททรัพยากร

  1. Users.dataSources
  2. Users.dataSources.dataPointChanges
  3. Users.dataSources.datasets
  4. Users.dataset
  5. Users.sessions

Users.dataSources

โปรดดูรายละเอียดของทรัพยากร Users.dataSources ในหน้าการนําเสนอแหล่งข้อมูล

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/fitness/v1/users เว้นแต่จะระบุไว้เป็นอย่างอื่น
สร้าง POST  /userId/dataSources สร้างแหล่งข้อมูลใหม่ที่ไม่ซ้ํากันในแหล่งข้อมูลทั้งหมดของผู้ใช้รายนี้

แหล่งข้อมูลคือแหล่งข้อมูลเฉพาะของเซ็นเซอร์ แหล่งข้อมูลอาจเปิดเผยข้อมูลข้อมูลดิบจากเซ็นเซอร์ฮาร์ดแวร์ในอุปกรณ์ที่ใช้ร่วมกันหรืออุปกรณ์ที่ใช้ร่วมกัน นอกจากนี้ยังอาจเผยให้เห็นข้อมูลที่ได้มาโดยการเปลี่ยนรูปแบบหรือผสานแหล่งข้อมูลอื่นๆ แหล่งข้อมูลประเภทเดียวกันอาจมีได้หลายประเภท จุดข้อมูลทุกจุดในชุดข้อมูลทั้งหมดที่แทรกหรืออ่านจาก Fitness API จะมีแหล่งข้อมูลที่เกี่ยวข้อง

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

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

การระบุ DataType ที่ไม่ใช่ประเภทที่รู้จัก (เริ่มต้นด้วย "com.google.") จะสร้าง DataSource ที่มีประเภทข้อมูลที่กําหนดเอง แอปพลิเคชันที่สร้างขึ้นจะอ่านประเภทข้อมูลที่กําหนดเองได้เท่านั้น ประเภทข้อมูลที่กําหนดเองจะเลิกใช้งาน โปรดใช้ประเภทข้อมูลมาตรฐานแทน

นอกเหนือจากช่องแหล่งข้อมูลที่รวมอยู่ในรหัสแหล่งข้อมูลแล้ว ยังมีหมายเลขโปรเจ็กต์นักพัฒนาซอฟต์แวร์ที่ได้รับการตรวจสอบสิทธิ์เมื่อสร้างแหล่งข้อมูลด้วย หมายเลขโปรเจ็กต์นักพัฒนาซอฟต์แวร์นี้จะมีความสับสนเมื่ออ่านโดยนักพัฒนาแอปรายอื่นๆ ที่อ่านข้อมูลสาธารณะประเภทต่างๆ
ลบ DELETE  /userId/dataSources/dataSourceId ลบแหล่งข้อมูลที่ระบุ คําขอจะล้มเหลวหากแหล่งข้อมูลมีจุดข้อมูลอยู่
รับ GET  /userId/dataSources/dataSourceId แสดงผลแหล่งข้อมูลที่ระบุ
list GET  /userId/dataSources แสดงแหล่งข้อมูลทั้งหมดที่นักพัฒนาแอปเห็นโดยใช้ขอบเขต OAuth ที่ให้ไว้ รายการนี้ยังไม่ครบทั้งหมด ผู้ใช้อาจมีแหล่งข้อมูลส่วนตัวที่มองเห็นได้เฉพาะนักพัฒนาแอปรายอื่นๆ หรือการโทรโดยใช้ขอบเขตอื่นๆ
อัปเดต PUT  /userId/dataSources/dataSourceId อัปเดตแหล่งข้อมูลที่ระบุ แก้ไขพร็อพเพอร์ตี้ dataStreamId, dataType, type, dataStreamName และ device ที่มีการยกเว้น version ไม่ได้

dataStreamId มีการระบุแหล่งข้อมูล

Users.dataSources.dataPointChanges

โปรดดูรายละเอียดใน User.dataSources.dataPointChanges ในหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/fitness/v1/users เว้นแต่จะระบุไว้เป็นอย่างอื่น
list GET  /userId/dataSources/dataSourceId/dataPointChanges การค้นหาจุดข้อมูลของผู้ใช้จะได้รับการเปลี่ยนแปลงในแหล่งข้อมูลบางแห่ง

Users.dataSources.datasets

โปรดดูรายละเอียดใน User.dataSources.datasets ในหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/fitness/v1/users เว้นแต่จะระบุไว้เป็นอย่างอื่น
ลบ DELETE  /userId/dataSources/dataSourceId/datasets/datasetId ดําเนินการลบจุดข้อมูลทั้งหมดซึ่งเวลาเริ่มต้นและสิ้นสุดมีค่าทับซ้อนกับช่วงเวลาที่ระบุด้วยรหัสชุดข้อมูล สําหรับประเภทข้อมูลส่วนใหญ่ จุดข้อมูลทั้งหมดจะถูกลบ สําหรับประเภทข้อมูลที่ช่วงระยะเวลาแสดงถึงค่าที่สอดคล้องกัน (เช่น com.google.activity.segment) และจุดข้อมูลก็อาจอยู่ในจุดสิ้นสุดของชุดข้อมูล แต่ระบบจะลบส่วนที่ซ้อนทับของจุดข้อมูลเท่านั้น
รับ GET  /userId/dataSources/dataSourceId/datasets/datasetId แสดงผลชุดข้อมูลที่มีจุดข้อมูลทั้งหมดที่เวลาเริ่มต้นและเวลาสิ้นสุดทับซ้อนกับช่วงที่ระบุของเวลาเริ่มต้นขั้นต่ําของชุดข้อมูลและเวลาสิ้นสุดสูงสุด โดยเฉพาะอย่างยิ่ง จุดข้อมูลที่มีเวลาเริ่มต้นน้อยกว่าหรือเท่ากับเวลาสิ้นสุดของชุดข้อมูล และมีเวลาสิ้นสุดมากกว่าหรือเท่ากับเวลาเริ่มต้นของชุดข้อมูล
แพตช์ PATCH  /userId/dataSources/dataSourceId/datasets/datasetId เพิ่มจุดข้อมูลในชุดข้อมูล โดยไม่จําเป็นต้องสร้างชุดข้อมูลก่อนหน้านี้ คะแนนทั้งหมดภายในชุดข้อมูลจะแสดงพร้อมการเรียกครั้งต่อๆ ไปเพื่อเรียกชุดข้อมูลนี้ จุดข้อมูลอยู่ในชุดข้อมูลได้มากกว่า 1 ชุด

วิธีนี้ไม่ได้ใช้ความหมายของแพตช์: ระบบจะแทรกจุดข้อมูลที่ให้ไว้เท่านั้น โดยไม่แทนที่ข้อมูลที่มีอยู่

ชุดข้อมูลผู้ใช้

โปรดดูรายละเอียดของ Resource.dataset ในหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/fitness/v1/users เว้นแต่จะระบุไว้เป็นอย่างอื่น
รวม POST  /userId/dataset:aggregate รวบรวมข้อมูลบางประเภทหรือสตรีมไปยังที่เก็บข้อมูลหารด้วยประเภทขอบเขตที่กําหนด ชุดข้อมูลหลายชุดหลายประเภทและจากแหล่งที่มาหลายแห่งสามารถรวมกันเป็นที่เก็บข้อมูลประเภทเดียวต่อคําขอได้

User.sessions

ดูรายละเอียดทรัพยากร User.sessions ในหน้าการนําเสนอแหล่งข้อมูล

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://www.googleapis.com/fitness/v1/users เว้นแต่จะระบุไว้เป็นอย่างอื่น
ลบ DELETE  /userId/sessions/sessionId ลบเซสชันที่ระบุตามรหัสเซสชันที่ระบุไว้
list GET  /userId/sessions แสดงรายการเซสชันที่สร้างไว้ก่อนหน้านี้
อัปเดต PUT  /userId/sessions/sessionId อัปเดตหรือแทรกเซสชันที่ระบุ