Show / Hide Table of Contents

Namespace Google.Apis.GoogleHealthAPI.v4

Classes

GoogleHealthAPIBaseServiceRequest<TResponse>

A base abstract class for GoogleHealthAPI requests.

GoogleHealthAPIService

The GoogleHealthAPI Service.

GoogleHealthAPIService.Scope

Available OAuth 2.0 scopes for use with the Google Health API.

GoogleHealthAPIService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Google Health API.

ProjectsResource

The "projects" collection of methods.

ProjectsResource.SubscribersResource

The "subscribers" collection of methods.

ProjectsResource.SubscribersResource.CreateRequest

Registers a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change notifications for users who have granted consent. Endpoint Verification: For a subscriber to be successfully created, the provided endpoint_uri must be a valid HTTPS endpoint and must pass an automated verification check. The backend will send two HTTP POST requests to the endpoint_uri: 1. Verification with Authorization: * Headers: Includes Content-Type: application/json and Authorization (with the exact value from CreateSubscriberPayload.endpoint_authorization.secret). * Body: {"type": "verification"} * Expected Response: HTTP 201 Created. 2. Verification without Authorization: * Headers: Includes Content-Type: application/json. The Authorization header is OMITTED. * Body: {"type": "verification"} * Expected Response: HTTP 401 Unauthorized or 403 Forbidden. Both tests must pass for the subscriber creation to succeed. If verification fails, the operation will not be completed and an error will be returned. This process ensures the endpoint is reachable and correctly validates the Authorization header.

ProjectsResource.SubscribersResource.DeleteRequest

Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.

ProjectsResource.SubscribersResource.ListRequest

Lists all subscribers registered within the owned Google Cloud Project.

ProjectsResource.SubscribersResource.PatchRequest

Updates the configuration of an existing subscriber, such as the endpoint URI or the data types it's interested in. Endpoint Verification: If the endpoint_uri or endpoint_authorization field is included in the update_mask, the backend will re-verify the endpoint. The verification process is the same as described in CreateSubscriber: 1. Verification with Authorization: POST to the new or existing endpoint_uri with the new or existing Authorization secret. Expects HTTP 201 Created. 2. Verification without Authorization: POST to the endpoint_uri without the Authorization header. Expects HTTP 401 Unauthorized or 403 Forbidden. Both tests must pass using the potentially updated values for the subscriber update to succeed. If verification fails, the update will not be applied, and an error will be returned.

ProjectsResource.SubscribersResource.SubscriptionsResource

The "subscriptions" collection of methods.

ProjectsResource.SubscribersResource.SubscriptionsResource.CreateRequest

Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a SubscriptionCreatePolicy set to MANUAL for the given data types.

ProjectsResource.SubscribersResource.SubscriptionsResource.DeleteRequest

Deletes a specific user subscription, stopping notifications for this user to this subscriber.

ProjectsResource.SubscribersResource.SubscriptionsResource.ListRequest

Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.

ProjectsResource.SubscribersResource.SubscriptionsResource.PatchRequest

Updates the data types for an existing user subscription.

UsersResource

The "users" collection of methods.

UsersResource.DataTypesResource

The "dataTypes" collection of methods.

UsersResource.DataTypesResource.DataPointsResource

The "dataPoints" collection of methods.

UsersResource.DataTypesResource.DataPointsResource.BatchDeleteRequest

Delete a batch of identifyable data points.

UsersResource.DataTypesResource.DataPointsResource.CreateRequest

Creates a single identifiable data point.

UsersResource.DataTypesResource.DataPointsResource.DailyRollUpRequest

Roll up data points over civil time intervals for supported data types.

UsersResource.DataTypesResource.DataPointsResource.ExportExerciseTcxRequest

Exports exercise data in TCX format. IMPORTANT: HTTP clients must append ?alt=media to the request URL to download the raw TCX file. Example: https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media Without alt=media, the server returns a JSON response (ExportExerciseTcxResponse) which is intended primarily for gRPC clients. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the activity_and_fitness scopes (normal or readonly) AND one of the location scopes (normal or readonly) in their access token to succeed.

UsersResource.DataTypesResource.DataPointsResource.GetRequest

Get a single identifyable data point.

UsersResource.DataTypesResource.DataPointsResource.ListRequest

Query user health and fitness data points.

UsersResource.DataTypesResource.DataPointsResource.PatchRequest

Updates a single identifiable data point. If a data point with the specified name is not found, the request will fail.

UsersResource.DataTypesResource.DataPointsResource.ReconcileRequest

Reconcile data points from multiple data sources into a single data stream.

UsersResource.DataTypesResource.DataPointsResource.RollUpRequest

Roll up data points over physical time intervals for supported data types.

UsersResource.GetIdentityRequest

Gets the user's identity. It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.

UsersResource.GetIrnProfileRequest

Returns user's IRN Profile details.

UsersResource.GetProfileRequest

Returns user Profile details.

UsersResource.GetSettingsRequest

Returns user settings details.

UsersResource.PairedDevicesResource

The "pairedDevices" collection of methods.

UsersResource.PairedDevicesResource.GetRequest

Returns user's Device.

UsersResource.PairedDevicesResource.ListRequest

Returns the user's list of paired 1P trackers and smartwatches.

UsersResource.UpdateProfileRequest

Updates the user's profile details.

UsersResource.UpdateSettingsRequest

Updates the user's settings details.

Enums

GoogleHealthAPIBaseServiceRequest<TResponse>.AltEnum

Data format for response.

GoogleHealthAPIBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

In this article
Back to top Generated by DocFX