Class DeveloperRegistrationServiceClient

DeveloperRegistrationService client wrapper, for convenient use.

Inheritance

object

DeveloperRegistrationServiceClient

DeveloperRegistrationServiceClientImpl

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Shopping.Merchant.Accounts.V1

Assembly: Google.Shopping.Merchant.Accounts.V1.dll

Syntax

public abstract class DeveloperRegistrationServiceClient

Remarks

Service to access Developer Registration.

Properties

DefaultEndpoint

The default endpoint for the DeveloperRegistrationService service, which is a host of "merchantapi.googleapis.com" and a port of 443.

Declaration

public static string DefaultEndpoint { get; }

Property Value

Type	Description
string

DefaultScopes

The default DeveloperRegistrationService scopes.

Declaration

public static IReadOnlyList<string> DefaultScopes { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

The default DeveloperRegistrationService scopes are:

• https://www.googleapis.com/auth/content

GrpcClient

The underlying gRPC DeveloperRegistrationService client

Declaration

public virtual DeveloperRegistrationService.DeveloperRegistrationServiceClient GrpcClient { get; }

Property Value

Type	Description
DeveloperRegistrationService.DeveloperRegistrationServiceClient

ServiceMetadata

The service metadata associated with this client type.

Declaration

public static ServiceMetadata ServiceMetadata { get; }

Property Value

Type	Description
ServiceMetadata

Methods

Create()

Synchronously creates a DeveloperRegistrationServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DeveloperRegistrationServiceClientBuilder.

Declaration

public static DeveloperRegistrationServiceClient Create()

Returns

Type	Description
DeveloperRegistrationServiceClient	The created DeveloperRegistrationServiceClient.

CreateAsync(CancellationToken)

Asynchronously creates a DeveloperRegistrationServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DeveloperRegistrationServiceClientBuilder.

Declaration

public static Task<DeveloperRegistrationServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The CancellationToken to use while creating the client.

Returns

Type	Description
Task<DeveloperRegistrationServiceClient>	The task representing the created DeveloperRegistrationServiceClient.

GetDeveloperRegistration(DeveloperRegistrationName, CallSettings)

Retrieves a developer registration for a merchant.

Declaration

public virtual DeveloperRegistration GetDeveloperRegistration(DeveloperRegistrationName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
DeveloperRegistrationName	name	Required. The name (ID) of the developer registration.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
DeveloperRegistration	The RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = DeveloperRegistrationServiceClient.Create();
// Initialize request argument(s)
DeveloperRegistrationName name = DeveloperRegistrationName.FromAccount("[ACCOUNT]");
// Make the request
DeveloperRegistration response = developerRegistrationServiceClient.GetDeveloperRegistration(name);

GetDeveloperRegistration(GetDeveloperRegistrationRequest, CallSettings)

Retrieves a developer registration for a merchant.

Declaration

public virtual DeveloperRegistration GetDeveloperRegistration(GetDeveloperRegistrationRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetDeveloperRegistrationRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
DeveloperRegistration	The RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = DeveloperRegistrationServiceClient.Create();
// Initialize request argument(s)
GetDeveloperRegistrationRequest request = new GetDeveloperRegistrationRequest
{
    DeveloperRegistrationName = DeveloperRegistrationName.FromAccount("[ACCOUNT]"),
};
// Make the request
DeveloperRegistration response = developerRegistrationServiceClient.GetDeveloperRegistration(request);

GetDeveloperRegistration(string, CallSettings)

Retrieves a developer registration for a merchant.

Declaration

public virtual DeveloperRegistration GetDeveloperRegistration(string name, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	name	Required. The name (ID) of the developer registration.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
DeveloperRegistration	The RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = DeveloperRegistrationServiceClient.Create();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/developerRegistration";
// Make the request
DeveloperRegistration response = developerRegistrationServiceClient.GetDeveloperRegistration(name);

GetDeveloperRegistrationAsync(DeveloperRegistrationName, CallSettings)

Retrieves a developer registration for a merchant.

Declaration

public virtual Task<DeveloperRegistration> GetDeveloperRegistrationAsync(DeveloperRegistrationName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
DeveloperRegistrationName	name	Required. The name (ID) of the developer registration.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<DeveloperRegistration>	A Task containing the RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = await DeveloperRegistrationServiceClient.CreateAsync();
// Initialize request argument(s)
DeveloperRegistrationName name = DeveloperRegistrationName.FromAccount("[ACCOUNT]");
// Make the request
DeveloperRegistration response = await developerRegistrationServiceClient.GetDeveloperRegistrationAsync(name);

GetDeveloperRegistrationAsync(DeveloperRegistrationName, CancellationToken)

Retrieves a developer registration for a merchant.

Declaration

public virtual Task<DeveloperRegistration> GetDeveloperRegistrationAsync(DeveloperRegistrationName name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
DeveloperRegistrationName	name	Required. The name (ID) of the developer registration.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<DeveloperRegistration>	A Task containing the RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = await DeveloperRegistrationServiceClient.CreateAsync();
// Initialize request argument(s)
DeveloperRegistrationName name = DeveloperRegistrationName.FromAccount("[ACCOUNT]");
// Make the request
DeveloperRegistration response = await developerRegistrationServiceClient.GetDeveloperRegistrationAsync(name);

GetDeveloperRegistrationAsync(GetDeveloperRegistrationRequest, CallSettings)

Retrieves a developer registration for a merchant.

Declaration

public virtual Task<DeveloperRegistration> GetDeveloperRegistrationAsync(GetDeveloperRegistrationRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetDeveloperRegistrationRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<DeveloperRegistration>	A Task containing the RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = await DeveloperRegistrationServiceClient.CreateAsync();
// Initialize request argument(s)
GetDeveloperRegistrationRequest request = new GetDeveloperRegistrationRequest
{
    DeveloperRegistrationName = DeveloperRegistrationName.FromAccount("[ACCOUNT]"),
};
// Make the request
DeveloperRegistration response = await developerRegistrationServiceClient.GetDeveloperRegistrationAsync(request);

GetDeveloperRegistrationAsync(GetDeveloperRegistrationRequest, CancellationToken)

Retrieves a developer registration for a merchant.

Declaration

public virtual Task<DeveloperRegistration> GetDeveloperRegistrationAsync(GetDeveloperRegistrationRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GetDeveloperRegistrationRequest	request	The request object containing all of the parameters for the API call.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<DeveloperRegistration>	A Task containing the RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = await DeveloperRegistrationServiceClient.CreateAsync();
// Initialize request argument(s)
GetDeveloperRegistrationRequest request = new GetDeveloperRegistrationRequest
{
    DeveloperRegistrationName = DeveloperRegistrationName.FromAccount("[ACCOUNT]"),
};
// Make the request
DeveloperRegistration response = await developerRegistrationServiceClient.GetDeveloperRegistrationAsync(request);

GetDeveloperRegistrationAsync(string, CallSettings)

Retrieves a developer registration for a merchant.

Declaration

public virtual Task<DeveloperRegistration> GetDeveloperRegistrationAsync(string name, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	name	Required. The name (ID) of the developer registration.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<DeveloperRegistration>	A Task containing the RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = await DeveloperRegistrationServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/developerRegistration";
// Make the request
DeveloperRegistration response = await developerRegistrationServiceClient.GetDeveloperRegistrationAsync(name);

GetDeveloperRegistrationAsync(string, CancellationToken)

Retrieves a developer registration for a merchant.

Declaration

public virtual Task<DeveloperRegistration> GetDeveloperRegistrationAsync(string name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	name	Required. The name (ID) of the developer registration.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<DeveloperRegistration>	A Task containing the RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = await DeveloperRegistrationServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/developerRegistration";
// Make the request
DeveloperRegistration response = await developerRegistrationServiceClient.GetDeveloperRegistrationAsync(name);

RegisterGcp(RegisterGcpRequest, CallSettings)

Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on.

Declaration

public virtual DeveloperRegistration RegisterGcp(RegisterGcpRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RegisterGcpRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
DeveloperRegistration	The RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = DeveloperRegistrationServiceClient.Create();
// Initialize request argument(s)
RegisterGcpRequest request = new RegisterGcpRequest
{
    DeveloperRegistrationName = DeveloperRegistrationName.FromAccount("[ACCOUNT]"),
    DeveloperEmail = "",
};
// Make the request
DeveloperRegistration response = developerRegistrationServiceClient.RegisterGcp(request);

RegisterGcpAsync(RegisterGcpRequest, CallSettings)

Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on.

Declaration

public virtual Task<DeveloperRegistration> RegisterGcpAsync(RegisterGcpRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RegisterGcpRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<DeveloperRegistration>	A Task containing the RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = await DeveloperRegistrationServiceClient.CreateAsync();
// Initialize request argument(s)
RegisterGcpRequest request = new RegisterGcpRequest
{
    DeveloperRegistrationName = DeveloperRegistrationName.FromAccount("[ACCOUNT]"),
    DeveloperEmail = "",
};
// Make the request
DeveloperRegistration response = await developerRegistrationServiceClient.RegisterGcpAsync(request);

RegisterGcpAsync(RegisterGcpRequest, CancellationToken)

Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on.

Declaration

public virtual Task<DeveloperRegistration> RegisterGcpAsync(RegisterGcpRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
RegisterGcpRequest	request	The request object containing all of the parameters for the API call.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<DeveloperRegistration>	A Task containing the RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = await DeveloperRegistrationServiceClient.CreateAsync();
// Initialize request argument(s)
RegisterGcpRequest request = new RegisterGcpRequest
{
    DeveloperRegistrationName = DeveloperRegistrationName.FromAccount("[ACCOUNT]"),
    DeveloperEmail = "",
};
// Make the request
DeveloperRegistration response = await developerRegistrationServiceClient.RegisterGcpAsync(request);

ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Declaration

public static Task ShutdownDefaultChannelsAsync()

Returns

Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UnregisterGcp(UnregisterGcpRequest, CallSettings)

Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister succussful call.

Declaration

public virtual void UnregisterGcp(UnregisterGcpRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UnregisterGcpRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = DeveloperRegistrationServiceClient.Create();
// Initialize request argument(s)
UnregisterGcpRequest request = new UnregisterGcpRequest
{
    DeveloperRegistrationName = DeveloperRegistrationName.FromAccount("[ACCOUNT]"),
};
// Make the request
developerRegistrationServiceClient.UnregisterGcp(request);

UnregisterGcpAsync(UnregisterGcpRequest, CallSettings)

Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister succussful call.

Declaration

public virtual Task UnregisterGcpAsync(UnregisterGcpRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UnregisterGcpRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task containing the RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = await DeveloperRegistrationServiceClient.CreateAsync();
// Initialize request argument(s)
UnregisterGcpRequest request = new UnregisterGcpRequest
{
    DeveloperRegistrationName = DeveloperRegistrationName.FromAccount("[ACCOUNT]"),
};
// Make the request
await developerRegistrationServiceClient.UnregisterGcpAsync(request);

UnregisterGcpAsync(UnregisterGcpRequest, CancellationToken)

Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister succussful call.

Declaration

public virtual Task UnregisterGcpAsync(UnregisterGcpRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
UnregisterGcpRequest	request	The request object containing all of the parameters for the API call.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task	A Task containing the RPC response.

Sample code

// Create client
DeveloperRegistrationServiceClient developerRegistrationServiceClient = await DeveloperRegistrationServiceClient.CreateAsync();
// Initialize request argument(s)
UnregisterGcpRequest request = new UnregisterGcpRequest
{
    DeveloperRegistrationName = DeveloperRegistrationName.FromAccount("[ACCOUNT]"),
};
// Make the request
await developerRegistrationServiceClient.UnregisterGcpAsync(request);