Class 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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Operation>
GoogleHealthAPIBaseServiceRequest<Operation>
ProjectsResource.SubscribersResource.CreateRequest
Implements
Inherited Members
Namespace: Google.Apis.GoogleHealthAPI.v4
Assembly: Google.Apis.GoogleHealthAPI.v4.dll
Syntax
public class ProjectsResource.SubscribersResource.CreateRequest : GoogleHealthAPIBaseServiceRequest<Operation>, IClientServiceRequest<Operation>, IClientServiceRequest

Constructors

CreateRequest(IClientService, CreateSubscriberPayload, string)

Constructs a new Create request.

Declaration
public CreateRequest(IClientService service, CreateSubscriberPayload body, string parent)
Parameters
Type Name Description
IClientService service
CreateSubscriberPayload body
string parent

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Parent

Required. The parent resource where this subscriber will be created. Format: projects/{project} Example: projects/my-project-123

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

SubscriberId

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/.

Declaration
[RequestParameter("subscriberId", RequestParameterType.Query)]
public virtual string SubscriberId { get; set; }
Property Value
Type Description
string

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes Create parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements