2026-04-15
▼ ▲ health.projects.subscribers.create
HTTP Method : POST
Path : v4/{+parent}/subscribers
Parameter Order : parent
Description : 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.
Parameters :
parent
Type : string
Description : Required. The parent resource where this subscriber will be created. Format: projects/{project} Example: projects/my-project-123
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
subscriberId
Location : query
Type : string
Description : Optional. The ID to use for the subscriber, which will become the final component of the subscriber's resource name. This value should be 4-36 characters, and valid characters are /[a-z]([a-z0-9-]{2,34}[a-z0-9])/.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v4/projects/{projectsId}/subscribers
▼ ▲ health.projects.subscribers.patch
Path : v4/{+name}
Parameter Order : name
HTTP Method : PATCH
Flat Path : v4/projects/{projectsId}/subscribers/{subscribersId}
Parameters :
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Optional. A field mask that specifies which fields of the Subscriber message are to be updated. This allows for partial updates. Supported fields: - endpoint_uri - subscriber_configs - endpoint_authorization
name
Type : string
Description : Identifier. The resource name of the Subscriber. Format: projects/{project}/subscribers/{subscriber} The {project} ID is a Google Cloud Project ID or Project Number. The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) if provided during creation, or system-generated otherwise (e.g., a UUID). Example (User-settable subscriber ID): projects/my-project/subscribers/my-sub-123 Example (System-generated subscriber ID): projects/my-project/subscribers/a1b2c3d4-e5f6-7890-1234-567890abcdef
Pattern : ^projects/[^/]+/subscribers/[^/]+$
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : 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.
▼ ▲ health.projects.subscribers.delete
Path : v4/{+name}
Parameter Order : name
HTTP Method : DELETE
Flat Path : v4/projects/{projectsId}/subscribers/{subscribersId}
Parameters :
force
Location : query
Type : boolean
Description : Optional. If set to true, any child resources (e.g., subscriptions) will also be deleted. If false (default) and child resources exist, the request will fail.
name
Type : string
Description : Required. The name of the subscriber to delete. Format: projects/{project}/subscribers/{subscriber} Example: projects/my-project/subscribers/my-subscriber-123 The {subscriber} ID is user-settable (4-36 characters, matching /[a-z]([a-z0-9-]{2,34}[a-z0-9])/) or system-generated if not provided during creation.
Pattern : ^projects/[^/]+/subscribers/[^/]+$
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.
▼ ▲ health.projects.subscribers.list
Description : Lists all subscribers registered within the owned Google Cloud Project.
Parameters :
pageSize
Location : query
Type : integer
Format : int32
Description : Optional. The maximum number of subscribers to return. The service may return fewer than this value. If unspecified, at most 50 subscribers will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
Description : Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.
Location : query
Type : string
parent
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Description : Required. The parent, which owns this collection of subscribers. Format: projects/{project}
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v4/projects/{projectsId}/subscribers
HTTP Method : GET
Path : v4/{+parent}/subscribers
Parameter Order : parent
▼ ▲ health.users.dataTypes.dataPoints.get
Parameters :
name
Pattern : ^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$
Location : path
Required : Yes
Type : string
Description : Required. The name of the data point to retrieve. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` See DataPoint.name for examples and possible values.
Path : v4/{+name}
Flat Path : v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}
Parameter Order : name
Description : Get a single identifyable data point.
HTTP Method : GET