Users.sessions: list

แสดงรายการเซสชันที่สร้างไว้ก่อนหน้านี้ ลองใช้เลย

ส่งคำขอ

คำขอ HTTP

GET https://www.googleapis.com/fitness/v1/users/userId/sessions

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์เส้นทาง
userId string แสดงรายการเซสชันของบุคคลที่ระบุ ใช้ me เพื่อระบุ ผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว รองรับ me เท่านั้นในขณะนี้
พารามิเตอร์การค้นหาที่ไม่บังคับ
activityType integer หากไม่ว่างเปล่า ควรแสดงผลเฉพาะเซสชันที่มีประเภทกิจกรรมเหล่านี้เท่านั้น
endTime string การประทับเวลา RFC3339 เฉพาะเซสชันที่สิ้นสุดระหว่างเวลาเริ่มต้นและเวลาสิ้นสุดเท่านั้นที่จะรวมอยู่ใน คำตอบ หากละเว้นเวลานี้ แต่ startTime มีค่า เซสชันทั้งหมดตั้งแต่ startTime จนถึงสิ้นสุดเวลาจะ
includeDeleted boolean หากเป็นจริง และหากทั้ง startTime และ endTime เป็น ละเว้น ระบบจะแสดงผลการลบเซสชัน
pageToken string โทเค็นต่อเนื่อง ซึ่งใช้สำหรับการซิงค์ส่วนเพิ่ม หากต้องการรับการเปลี่ยนแปลงชุดถัดไป ให้ตั้งค่าพารามิเตอร์นี้เป็นค่า nextPageToken จากคำตอบก่อนหน้า โทเค็นของหน้าเว็บคือ จะถูกละเว้นหากระบุเวลาเริ่มต้นหรือเวลาสิ้นสุด หากไม่มีเวลาเริ่มต้น เวลาสิ้นสุด และมีการระบุโทเค็นของหน้าเว็บ เซสชันที่แก้ไขในช่วง คืนสินค้าได้ภายใน 30 วัน
startTime string การประทับเวลา RFC3339 เฉพาะเซสชันที่สิ้นสุดระหว่างเวลาเริ่มต้นและเวลาสิ้นสุดเท่านั้นที่จะรวมอยู่ใน คำตอบ หากไม่ระบุเวลานี้แต่ได้ระบุ endTime ไว้ เซสชันทั้งหมดตั้งแต่เริ่มต้นจนถึง endTime จะ ส่งคืนแล้ว

การให้สิทธิ์

คำขอนี้ต้องได้รับการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 ขอบเขต

ขอบเขต
https://www.googleapis.com/auth/fitness.activity.read
https://www.googleapis.com/auth/fitness.activity.write
https://www.googleapis.com/auth/fitness.location.read
https://www.googleapis.com/auth/fitness.location.write
https://www.googleapis.com/auth/fitness.body.read
https://www.googleapis.com/auth/fitness.body.write
https://www.googleapis.com/auth/fitness.nutrition.read
https://www.googleapis.com/auth/fitness.nutrition.write
https://www.googleapis.com/auth/fitness.blood_pressure.read
https://www.googleapis.com/auth/fitness.blood_pressure.write
https://www.googleapis.com/auth/fitness.blood_glucose.read
https://www.googleapis.com/auth/fitness.blood_glucose.write
https://www.googleapis.com/auth/fitness.oxygen_saturation.read
https://www.googleapis.com/auth/fitness.oxygen_saturation.write
https://www.googleapis.com/auth/fitness.body_temperature.read
https://www.googleapis.com/auth/fitness.body_temperature.write
https://www.googleapis.com/auth/fitness.reproductive_health.read
https://www.googleapis.com/auth/fitness.reproductive_health.write

สำหรับข้อมูลเพิ่มเติม โปรดดูที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์

เนื้อหาของคำขอ

โปรดอย่าให้เนื้อหาคำขอตามวิธีการนี้

คำตอบ

หากทำสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบกลับพร้อมโครงสร้างต่อไปนี้

{
  "session": [
    {
      "id": string,
      "name": string,
      "description": string,
      "startTimeMillis": long,
      "endTimeMillis": long,
      "modifiedTimeMillis": long,
      "application": {
        "packageName": string,
        "version": string,
        "detailsUrl": string,
        "name": string
      },
      "activityType": integer,
      "activeTimeMillis": long
    }
  ],
  "deletedSession": [
    {
      "id": string,
      "name": string,
      "description": string,
      "startTimeMillis": long,
      "endTimeMillis": long,
      "modifiedTimeMillis": long,
      "application": {
        "packageName": string,
        "version": string,
        "detailsUrl": string,
        "name": string
      },
      "activityType": integer,
      "activeTimeMillis": long
    }
  ],
  "nextPageToken": string,
  "hasMoreData": boolean
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
session[] list เซสชันที่มีเวลาสิ้นสุดอยู่ระหว่าง startTime ถึง endTime ของคำขอ

session[].id string ตัวระบุที่ลูกค้าสร้างขึ้นซึ่งจะไม่ซ้ำกันในเซสชันทั้งหมดที่ผู้ใช้รายนี้เป็นเจ้าของ
session[].name string ชื่อเซสชันที่มนุษย์อ่านได้
session[].description string คำอธิบายของเซสชันนี้
session[].startTimeMillis long เวลาเริ่มต้นในหน่วยมิลลิวินาทีตั้งแต่ Epoch รวมด้วย
session[].endTimeMillis long เวลาสิ้นสุดในหน่วยมิลลิวินาทีตั้งแต่ Epoch รวมด้วย
session[].modifiedTimeMillis long การประทับเวลาที่ระบุว่าเซสชันได้รับการแก้ไขครั้งล่าสุดเมื่อใด
session[].application nested object แอปพลิเคชันที่สร้างเซสชัน
session[].application.packageName string ชื่อแพ็กเกจสำหรับแอปพลิเคชันนี้ ชื่อนี้จะใช้เป็นตัวระบุที่ไม่ซ้ำกันเมื่อสร้างโดยแอปพลิเคชัน Android แต่ไคลเอ็นต์ REST จะระบุไม่ได้ ไคลเอ็นต์ REST จะแสดงหมายเลขโปรเจ็กต์ของนักพัฒนาซอฟต์แวร์ในรหัสสตรีมข้อมูลของแหล่งข้อมูล แทนชื่อแพ็กเกจ
session[].application.version string เวอร์ชันของแอปพลิเคชัน คุณควรอัปเดตฟิลด์นี้เมื่อแอปพลิเคชันมีการเปลี่ยนแปลงในลักษณะที่ส่งผลต่อการคำนวณข้อมูล
session[].application.detailsUrl string URI ที่ไม่บังคับซึ่งสามารถใช้เพื่อลิงก์กลับไปยังแอปพลิเคชันได้
session[].application.name string ชื่อของแอปพลิเคชันนี้ ชื่อนี้จำเป็นสำหรับไคลเอ็นต์ REST แต่เราไม่บังคับให้ชื่อนี้มีลักษณะเฉพาะ มีไว้เพื่ออำนวยความสะดวกสำหรับนักพัฒนาซอฟต์แวร์คนอื่นๆ ที่ต้องการระบุว่า REST ใดเป็นการสร้างแอปพลิเคชันหรือแหล่งข้อมูล
session[].activityType integer ประเภทของกิจกรรมที่เซสชันนี้แสดง
deletedSession[] list หากตั้งค่า includeDeleted เป็น "จริง" ในคำขอและละเว้น startTime และ endTime จะรวมเซสชันที่ลบตั้งแต่การซิงค์ครั้งล่าสุดด้วย
deletedSession[].id string ตัวระบุที่ลูกค้าสร้างขึ้นซึ่งจะไม่ซ้ำกันในเซสชันทั้งหมดที่ผู้ใช้รายนี้เป็นเจ้าของ
deletedSession[].name string ชื่อเซสชันที่มนุษย์อ่านได้
deletedSession[].description string คำอธิบายของเซสชันนี้
deletedSession[].startTimeMillis long เวลาเริ่มต้นในหน่วยมิลลิวินาทีตั้งแต่ Epoch รวมด้วย
deletedSession[].endTimeMillis long เวลาสิ้นสุดในหน่วยมิลลิวินาทีตั้งแต่ Epoch รวมด้วย
deletedSession[].modifiedTimeMillis long การประทับเวลาที่ระบุว่าเซสชันได้รับการแก้ไขครั้งล่าสุดเมื่อใด
deletedSession[].application nested object แอปพลิเคชันที่สร้างเซสชัน
deletedSession[].application.packageName string ชื่อแพ็กเกจสำหรับแอปพลิเคชันนี้ ชื่อนี้จะใช้เป็นตัวระบุที่ไม่ซ้ำกันเมื่อสร้างโดยแอปพลิเคชัน Android แต่ไคลเอ็นต์ REST จะระบุไม่ได้ ไคลเอ็นต์ REST จะแสดงหมายเลขโปรเจ็กต์ของนักพัฒนาซอฟต์แวร์ในรหัสสตรีมข้อมูลของแหล่งข้อมูล แทนชื่อแพ็กเกจ
deletedSession[].application.version string เวอร์ชันของแอปพลิเคชัน คุณควรอัปเดตฟิลด์นี้เมื่อแอปพลิเคชันมีการเปลี่ยนแปลงในลักษณะที่ส่งผลต่อการคำนวณข้อมูล
deletedSession[].application.detailsUrl string URI ที่ไม่บังคับซึ่งสามารถใช้เพื่อลิงก์กลับไปยังแอปพลิเคชันได้
deletedSession[].application.name string ชื่อของแอปพลิเคชันนี้ ชื่อนี้จำเป็นสำหรับไคลเอ็นต์ REST แต่เราไม่บังคับให้ชื่อนี้มีลักษณะเฉพาะ มีไว้เพื่ออำนวยความสะดวกสำหรับนักพัฒนาซอฟต์แวร์คนอื่นๆ ที่ต้องการระบุว่า REST ใดเป็นการสร้างแอปพลิเคชันหรือแหล่งข้อมูล
deletedSession[].activityType integer ประเภทของกิจกรรมที่เซสชันนี้แสดง
nextPageToken string โทเค็นการซิงค์ที่จะใช้เพื่อซิงค์การเปลี่ยนแปลงเพิ่มเติม โดยจะแสดงเฉพาะในกรณีที่ละเว้นทั้ง startTime และ endTime ในคำขอ
session[].activeTimeMillis long เวลาที่ใช้งานเซสชัน แม้ start_time_millis และ end_time_millis จะกำหนดเวลาเซสชันเต็ม เวลาที่แอ็กทีฟจะสั้นลงและระบุด้วย active_time_millis หากทราบเวลาที่ไม่มีการใช้งานระหว่างเซสชัน ควรแทรกค่าดังกล่าวผ่านจุดข้อมูล com.google.activity.segment ที่มีค่ากิจกรรม STILL

deletedSession[].activeTimeMillis long เวลาที่ใช้งานเซสชัน แม้ start_time_millis และ end_time_millis จะกำหนดเวลาเซสชันเต็ม เวลาที่แอ็กทีฟจะสั้นลงและระบุด้วย active_time_millis หากทราบเวลาที่ไม่มีการใช้งานระหว่างเซสชัน ควรแทรกค่าดังกล่าวผ่านจุดข้อมูล com.google.activity.segment ที่มีค่ากิจกรรม STILL

hasMoreData boolean ติดธงเพื่อระบุว่าเซิร์ฟเวอร์มีข้อมูลที่จะโอนมากกว่า ห้ามใช้ช่องนี้ โดยจะไม่มีการป้อนข้อมูลในการตอบสนองจากเซิร์ฟเวอร์

ลองใช้งาน

ใช้ API Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลแบบสดและดูการตอบกลับ