Skip to main content

TrackerService_ListTrackers​

TODO: add documentation about supported filters.

Path Parameters
  • user string required

    The user id.

Query Parameters
  • pageSize int32

    If unspecified, server will pick an appropriate default.

  • pageToken string

    The value returned from the previous call.

  • filter string

    A filter to be applied to results.

Responses

OK

Schema
  • trackers object[]

    The list of trackers.

    • name string required

      The id of the tracker.

    • resource string required

      The content whose progress is being tracked.

    • startTime date-time

      When the progress started.

    • endTime date-time

      When the progress ended.

    • completedResources string[]

      The list of completed sub-resources (e.g episodes or chapters).

    • progressPercentage object

      Wrapper message for float. The JSON representation for FloatValue is JSON number.

      • value float

        The float value.

    • state enum

      Possible values: [STATE_UNSPECIFIED, IN_PROGRESS, COMPLETED, ON_HOLD]

      The progress state of the tracker.

  • nextPageToken string

    A token to retrieve next page of results.