Users.sessions: list

Répertorie les sessions déjà créées. Essayer maintenant

Requête

Requête HTTP

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

Paramètres

Nom du paramètre Value Description
Paramètres de chemin d'accès
userId string Répertoriez les sessions pour la personne identifiée. Utilisez me pour indiquer l'utilisateur authentifié. Seule la région me est compatible pour le moment.
Paramètres de requête facultatifs
activityType integer S'il n'est pas vide, seules les sessions avec ces types d'activités doivent être renvoyées.
endTime string Un horodatage RFC3339. Seules les sessions se terminant entre les heures de début et de fin seront incluses dans la réponse. Si cette durée est omise, mais que startTime est spécifié, toutes les sessions de startTime jusqu'à la fin sont renvoyées.
includeDeleted boolean Si la valeur est "true", et si startTime et endTime sont omis, les suppressions de sessions sont renvoyées.
pageToken string Jeton de continuité, utilisé pour la synchronisation incrémentielle. Pour obtenir le prochain lot de modifications, définissez ce paramètre sur la valeur de nextPageToken de la réponse précédente. Le jeton de page est ignoré si l'heure de début ou de fin est spécifiée. Si aucune heure de début, heure de fin et jeton de page n'est spécifié, les sessions modifiées au cours des 30 derniers jours sont renvoyées.
startTime string Un horodatage RFC3339. Seules les sessions se terminant entre les heures de début et de fin seront incluses dans la réponse. Si cette valeur est omise, mais que endTime est spécifié, toutes les sessions depuis le début jusqu'à endTime sont renvoyées.

Autorisation

Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants:

Portée
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

Pour en savoir plus, consultez la page Authentification et autorisation.

Corps de la requête

Ne spécifiez pas de corps de requête pour cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "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
}
Nom de propriété Value Description Remarques
session[] list Sessions dont l'heure de fin est comprise entre startTime et endTime de la requête.

session[].id string Identifiant généré par le client et unique pour toutes les sessions appartenant à cet utilisateur.
session[].name string Nom lisible de la session.
session[].description string Description de cette session.
session[].startTimeMillis long Heure de début, en millisecondes depuis l'époque, incluse.
session[].endTimeMillis long Heure de fin, en millisecondes depuis l'époque, incluse.
session[].modifiedTimeMillis long Horodatage indiquant la dernière fois que la session a été modifiée.
session[].application nested object Application qui a créé la session
session[].application.packageName string Nom du package de cette application. Il est utilisé comme identifiant unique lorsqu'il est créé par des applications Android, mais ne peut pas être spécifié par les clients REST. Le numéro de projet du développeur client REST sera reflété dans les ID de flux de données de la source de données plutôt que dans le champ packageName.
session[].application.version string Version de l'application. Vous devez mettre à jour ce champ chaque fois que les modifications apportées à l'application affectent le calcul des données.
session[].application.detailsUrl string URI facultatif pouvant être utilisé pour créer un lien vers l'application.
session[].application.name string Nom de cette application. Cette étape est obligatoire pour les clients REST, mais nous n'imposons pas l'unicité de ce nom. Elle est fournie pour faciliter l'identification des développeurs qui souhaitent créer une application ou une source de données.
session[].activityType integer Type d'activité représenté par cette session.
deletedSession[] list Si includeDeleted est défini sur "true" dans la requête, et que startTime et endTime sont omis, les sessions qui ont été supprimées depuis la dernière synchronisation sont incluses.
deletedSession[].id string Identifiant généré par le client et unique pour toutes les sessions appartenant à cet utilisateur.
deletedSession[].name string Nom lisible de la session.
deletedSession[].description string Description de cette session.
deletedSession[].startTimeMillis long Heure de début, en millisecondes depuis l'époque, incluse.
deletedSession[].endTimeMillis long Heure de fin, en millisecondes depuis l'époque, incluse.
deletedSession[].modifiedTimeMillis long Horodatage indiquant la dernière fois que la session a été modifiée.
deletedSession[].application nested object Application qui a créé la session
deletedSession[].application.packageName string Nom du package de cette application. Il est utilisé comme identifiant unique lorsqu'il est créé par des applications Android, mais ne peut pas être spécifié par les clients REST. Le numéro de projet du développeur client REST sera reflété dans les ID de flux de données de la source de données plutôt que dans le champ packageName.
deletedSession[].application.version string Version de l'application. Vous devez mettre à jour ce champ chaque fois que les modifications apportées à l'application affectent le calcul des données.
deletedSession[].application.detailsUrl string URI facultatif pouvant être utilisé pour créer un lien vers l'application.
deletedSession[].application.name string Nom de cette application. Cette étape est obligatoire pour les clients REST, mais nous n'imposons pas l'unicité de ce nom. Elle est fournie pour faciliter l'identification des développeurs qui souhaitent créer une application ou une source de données.
deletedSession[].activityType integer Type d'activité représenté par cette session.
nextPageToken string Jeton de synchronisation utilisé pour synchroniser d'autres modifications. Ce champ n'est fourni que si les champs startTime et endTime sont tous les deux omis dans la requête.
session[].activeTimeMillis long Durée d'activité de la session. Alors que start_time_millis et end_time_millis définissent la durée complète de la session, la durée d'activité peut être plus courte et spécifiée par active_time_millis. Si la durée d'inactivité de la session est connue, elle doit également être insérée via un point de données com.google.activity.segment avec une valeur d'activité STILL

deletedSession[].activeTimeMillis long Durée d'activité de la session. Alors que start_time_millis et end_time_millis définissent la durée complète de la session, la durée d'activité peut être plus courte et spécifiée par active_time_millis. Si la durée d'inactivité de la session est connue, elle doit également être insérée via un point de données com.google.activity.segment avec une valeur d'activité STILL

hasMoreData boolean Indicateur indiquant que le serveur dispose de davantage de données à transférer. NE PAS UTILISER CE CHAMP. Il ne reçoit jamais de réponses du serveur.

Essayer

Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.