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.") จะสร้างแหล่งข้อมูลที่มีประเภทข้อมูลที่กำหนดเอง แอปพลิเคชันที่สร้างประเภทข้อมูลที่กำหนดเองจะอ่านได้เฉพาะประเภทข้อมูลที่กำหนดเองเท่านั้น ระบบจะเลิกใช้งานประเภทข้อมูลที่กำหนดเอง โปรดใช้ประเภทข้อมูลมาตรฐานแทน

นอกเหนือจากช่องแหล่งข้อมูลที่รวมอยู่ในรหัสแหล่งข้อมูลแล้ว ยังมีหมายเลขโปรเจ็กต์ของนักพัฒนาซอฟต์แวร์ที่ผ่านการตรวจสอบสิทธิ์เมื่อสร้างแหล่งข้อมูลด้วย หมายเลขโปรเจ็กต์ของนักพัฒนาซอฟต์แวร์นี้จะมีการสร้างความสับสนเมื่อนักพัฒนาซอฟต์แวร์รายอื่นๆ อ่านข้อมูลสาธารณะประเภทต่างๆ
ลบ 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

สำหรับรายละเอียดทรัพยากรของ Users.dataSources.dataPointChanges ดูที่หน้าการแสดงทรัพยากร

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

Users.dataSources.datasets

สำหรับรายละเอียดทรัพยากรของ Users.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 ชุด

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

Users.dataset

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

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

Users.sessions

สำหรับรายละเอียดทรัพยากรของ Users.sessions โปรดดูหน้าการแสดงทรัพยากร

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