Fitness API . users . sessions

Instance Methods

close()

Close httplib2 connections.

delete(userId, sessionId, x__xgafv=None)

Deletes a session specified by the given session ID.

list(userId, activityType=None, endTime=None, includeDeleted=None, pageToken=None, startTime=None, x__xgafv=None)

Lists sessions previously created.

list_next()

Retrieves the next page of results.

update(userId, sessionId, body=None, x__xgafv=None)

Updates or insert a given session.

Method Details

close()
Close httplib2 connections.
delete(userId, sessionId, x__xgafv=None)
Deletes a session specified by the given session ID.

Args:
  userId: string, Delete a session for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  sessionId: string, The ID of the session to be deleted. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
list(userId, activityType=None, endTime=None, includeDeleted=None, pageToken=None, startTime=None, x__xgafv=None)
Lists sessions previously created.

Args:
  userId: string, List sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  activityType: integer, If non-empty, only sessions with these activity types should be returned. (repeated)
  endTime: string, An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. If this time is omitted but startTime is specified, all sessions from startTime to the end of time will be returned.
  includeDeleted: boolean, If true, and if both startTime and endTime are omitted, session deletions will be returned.
  pageToken: string, The continuation token, which is used for incremental syncing. To get the next batch of changes, set this parameter to the value of nextPageToken from the previous response. The page token is ignored if either start or end time is specified. If none of start time, end time, and the page token is specified, sessions modified in the last 30 days are returned.
  startTime: string, An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. If this time is omitted but endTime is specified, all sessions from the start of time up to endTime will be returned.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "deletedSession": [ # If includeDeleted is set to true in the request, and startTime and endTime are omitted, this will include sessions which were deleted since the last sync.
    { # Sessions contain metadata, such as a user-friendly name and time interval information.
      "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
      "activityType": 42, # The type of activity this session represents.
      "application": { # The application that created the session.
        "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
        "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
        "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
        "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
      },
      "description": "A String", # A description for this session.
      "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
      "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
      "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
      "name": "A String", # A human readable name of the session.
      "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
    },
  ],
  "hasMoreData": True or False, # Flag to indicate server has more data to transfer. DO NOT USE THIS FIELD. It is never populated in responses from the server.
  "nextPageToken": "A String", # The sync token which is used to sync further changes. This will only be provided if both startTime and endTime are omitted from the request.
  "session": [ # Sessions with an end time that is between startTime and endTime of the request.
    { # Sessions contain metadata, such as a user-friendly name and time interval information.
      "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
      "activityType": 42, # The type of activity this session represents.
      "application": { # The application that created the session.
        "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
        "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
        "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
        "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
      },
      "description": "A String", # A description for this session.
      "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
      "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
      "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
      "name": "A String", # A human readable name of the session.
      "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
    },
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
update(userId, sessionId, body=None, x__xgafv=None)
Updates or insert a given session.

Args:
  userId: string, Create sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. (required)
  sessionId: string, The ID of the session to be created. (required)
  body: object, The request body.
    The object takes the form of:

{ # Sessions contain metadata, such as a user-friendly name and time interval information.
  "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
  "activityType": 42, # The type of activity this session represents.
  "application": { # The application that created the session.
    "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
    "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
    "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
    "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
  },
  "description": "A String", # A description for this session.
  "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
  "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
  "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
  "name": "A String", # A human readable name of the session.
  "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Sessions contain metadata, such as a user-friendly name and time interval information.
  "activeTimeMillis": "A String", # Session active time. While start_time_millis and end_time_millis define the full session time, the active time can be shorter and specified by active_time_millis. If the inactive time during the session is known, it should also be inserted via a com.google.activity.segment data point with a STILL activity value
  "activityType": 42, # The type of activity this session represents.
  "application": { # The application that created the session.
    "detailsUrl": "A String", # An optional URI that can be used to link back to the application.
    "name": "A String", # The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
    "packageName": "A String", # Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
    "version": "A String", # Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
  },
  "description": "A String", # A description for this session.
  "endTimeMillis": "A String", # An end time, in milliseconds since epoch, inclusive.
  "id": "A String", # A client-generated identifier that is unique across all sessions owned by this particular user.
  "modifiedTimeMillis": "A String", # A timestamp that indicates when the session was last modified.
  "name": "A String", # A human readable name of the session.
  "startTimeMillis": "A String", # A start time, in milliseconds since epoch, inclusive.
}