Show / Hide Table of Contents

Class CheckoutSettingsServiceClient

CheckoutSettingsService client wrapper, for convenient use.

Inheritance
object
CheckoutSettingsServiceClient
CheckoutSettingsServiceClientImpl
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 CheckoutSettingsServiceClient
Remarks

Service for supporting checkout settings.

Properties

DefaultEndpoint

The default endpoint for the CheckoutSettingsService 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 CheckoutSettingsService scopes.

Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
Type Description
IReadOnlyList<string>
Remarks

The default CheckoutSettingsService scopes are:

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

GrpcClient

The underlying gRPC CheckoutSettingsService client

Declaration
public virtual CheckoutSettingsService.CheckoutSettingsServiceClient GrpcClient { get; }
Property Value
Type Description
CheckoutSettingsService.CheckoutSettingsServiceClient

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 CheckoutSettingsServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CheckoutSettingsServiceClientBuilder.

Declaration
public static CheckoutSettingsServiceClient Create()
Returns
Type Description
CheckoutSettingsServiceClient

The created CheckoutSettingsServiceClient.

CreateAsync(CancellationToken)

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

Declaration
public static Task<CheckoutSettingsServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
Task<CheckoutSettingsServiceClient>

The task representing the created CheckoutSettingsServiceClient.

CreateCheckoutSettings(CreateCheckoutSettingsRequest, CallSettings)

Creates CheckoutSettings for the given merchant.

Declaration
public virtual CheckoutSettings CreateCheckoutSettings(CreateCheckoutSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateCheckoutSettingsRequest 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
CheckoutSettings

The RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = CheckoutSettingsServiceClient.Create();
// Initialize request argument(s)
CreateCheckoutSettingsRequest request = new CreateCheckoutSettingsRequest
{
    ParentAsProgramName = ProgramName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]"),
    CheckoutSettings = new CheckoutSettings(),
};
// Make the request
CheckoutSettings response = checkoutSettingsServiceClient.CreateCheckoutSettings(request);

CreateCheckoutSettings(ProgramName, CheckoutSettings, CallSettings)

Creates CheckoutSettings for the given merchant.

Declaration
public virtual CheckoutSettings CreateCheckoutSettings(ProgramName parent, CheckoutSettings checkoutSettings, CallSettings callSettings = null)
Parameters
Type Name Description
ProgramName parent

Required. The merchant account for which the CheckoutSettings will be created.

CheckoutSettings checkoutSettings

Required. The CheckoutSettings object to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
CheckoutSettings

The RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = CheckoutSettingsServiceClient.Create();
// Initialize request argument(s)
ProgramName parent = ProgramName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]");
CheckoutSettings checkoutSettings = new CheckoutSettings();
// Make the request
CheckoutSettings response = checkoutSettingsServiceClient.CreateCheckoutSettings(parent, checkoutSettings);

CreateCheckoutSettings(string, CheckoutSettings, CallSettings)

Creates CheckoutSettings for the given merchant.

Declaration
public virtual CheckoutSettings CreateCheckoutSettings(string parent, CheckoutSettings checkoutSettings, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The merchant account for which the CheckoutSettings will be created.

CheckoutSettings checkoutSettings

Required. The CheckoutSettings object to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
CheckoutSettings

The RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = CheckoutSettingsServiceClient.Create();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]/programs/[PROGRAM]";
CheckoutSettings checkoutSettings = new CheckoutSettings();
// Make the request
CheckoutSettings response = checkoutSettingsServiceClient.CreateCheckoutSettings(parent, checkoutSettings);

CreateCheckoutSettingsAsync(CreateCheckoutSettingsRequest, CallSettings)

Creates CheckoutSettings for the given merchant.

Declaration
public virtual Task<CheckoutSettings> CreateCheckoutSettingsAsync(CreateCheckoutSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateCheckoutSettingsRequest 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<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
CreateCheckoutSettingsRequest request = new CreateCheckoutSettingsRequest
{
    ParentAsProgramName = ProgramName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]"),
    CheckoutSettings = new CheckoutSettings(),
};
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.CreateCheckoutSettingsAsync(request);

CreateCheckoutSettingsAsync(CreateCheckoutSettingsRequest, CancellationToken)

Creates CheckoutSettings for the given merchant.

Declaration
public virtual Task<CheckoutSettings> CreateCheckoutSettingsAsync(CreateCheckoutSettingsRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateCheckoutSettingsRequest 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<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
CreateCheckoutSettingsRequest request = new CreateCheckoutSettingsRequest
{
    ParentAsProgramName = ProgramName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]"),
    CheckoutSettings = new CheckoutSettings(),
};
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.CreateCheckoutSettingsAsync(request);

CreateCheckoutSettingsAsync(ProgramName, CheckoutSettings, CallSettings)

Creates CheckoutSettings for the given merchant.

Declaration
public virtual Task<CheckoutSettings> CreateCheckoutSettingsAsync(ProgramName parent, CheckoutSettings checkoutSettings, CallSettings callSettings = null)
Parameters
Type Name Description
ProgramName parent

Required. The merchant account for which the CheckoutSettings will be created.

CheckoutSettings checkoutSettings

Required. The CheckoutSettings object to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
ProgramName parent = ProgramName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]");
CheckoutSettings checkoutSettings = new CheckoutSettings();
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.CreateCheckoutSettingsAsync(parent, checkoutSettings);

CreateCheckoutSettingsAsync(ProgramName, CheckoutSettings, CancellationToken)

Creates CheckoutSettings for the given merchant.

Declaration
public virtual Task<CheckoutSettings> CreateCheckoutSettingsAsync(ProgramName parent, CheckoutSettings checkoutSettings, CancellationToken cancellationToken)
Parameters
Type Name Description
ProgramName parent

Required. The merchant account for which the CheckoutSettings will be created.

CheckoutSettings checkoutSettings

Required. The CheckoutSettings object to create.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
ProgramName parent = ProgramName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]");
CheckoutSettings checkoutSettings = new CheckoutSettings();
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.CreateCheckoutSettingsAsync(parent, checkoutSettings);

CreateCheckoutSettingsAsync(string, CheckoutSettings, CallSettings)

Creates CheckoutSettings for the given merchant.

Declaration
public virtual Task<CheckoutSettings> CreateCheckoutSettingsAsync(string parent, CheckoutSettings checkoutSettings, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The merchant account for which the CheckoutSettings will be created.

CheckoutSettings checkoutSettings

Required. The CheckoutSettings object to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]/programs/[PROGRAM]";
CheckoutSettings checkoutSettings = new CheckoutSettings();
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.CreateCheckoutSettingsAsync(parent, checkoutSettings);

CreateCheckoutSettingsAsync(string, CheckoutSettings, CancellationToken)

Creates CheckoutSettings for the given merchant.

Declaration
public virtual Task<CheckoutSettings> CreateCheckoutSettingsAsync(string parent, CheckoutSettings checkoutSettings, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. The merchant account for which the CheckoutSettings will be created.

CheckoutSettings checkoutSettings

Required. The CheckoutSettings object to create.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]/programs/[PROGRAM]";
CheckoutSettings checkoutSettings = new CheckoutSettings();
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.CreateCheckoutSettingsAsync(parent, checkoutSettings);

DeleteCheckoutSettings(CheckoutSettingsName, CallSettings)

Deletes CheckoutSettings and unenrolls merchant from Checkout program.

Declaration
public virtual void DeleteCheckoutSettings(CheckoutSettingsName name, CallSettings callSettings = null)
Parameters
Type Name Description
CheckoutSettingsName name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = CheckoutSettingsServiceClient.Create();
// Initialize request argument(s)
CheckoutSettingsName name = CheckoutSettingsName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]");
// Make the request
checkoutSettingsServiceClient.DeleteCheckoutSettings(name);

DeleteCheckoutSettings(DeleteCheckoutSettingsRequest, CallSettings)

Deletes CheckoutSettings and unenrolls merchant from Checkout program.

Declaration
public virtual void DeleteCheckoutSettings(DeleteCheckoutSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteCheckoutSettingsRequest 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
CheckoutSettingsServiceClient checkoutSettingsServiceClient = CheckoutSettingsServiceClient.Create();
// Initialize request argument(s)
DeleteCheckoutSettingsRequest request = new DeleteCheckoutSettingsRequest
{
    CheckoutSettingsName = CheckoutSettingsName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]"),
};
// Make the request
checkoutSettingsServiceClient.DeleteCheckoutSettings(request);

DeleteCheckoutSettings(string, CallSettings)

Deletes CheckoutSettings and unenrolls merchant from Checkout program.

Declaration
public virtual void DeleteCheckoutSettings(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = CheckoutSettingsServiceClient.Create();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/programs/[PROGRAM]/checkoutSettings";
// Make the request
checkoutSettingsServiceClient.DeleteCheckoutSettings(name);

DeleteCheckoutSettingsAsync(CheckoutSettingsName, CallSettings)

Deletes CheckoutSettings and unenrolls merchant from Checkout program.

Declaration
public virtual Task DeleteCheckoutSettingsAsync(CheckoutSettingsName name, CallSettings callSettings = null)
Parameters
Type Name Description
CheckoutSettingsName name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

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
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
CheckoutSettingsName name = CheckoutSettingsName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]");
// Make the request
await checkoutSettingsServiceClient.DeleteCheckoutSettingsAsync(name);

DeleteCheckoutSettingsAsync(CheckoutSettingsName, CancellationToken)

Deletes CheckoutSettings and unenrolls merchant from Checkout program.

Declaration
public virtual Task DeleteCheckoutSettingsAsync(CheckoutSettingsName name, CancellationToken cancellationToken)
Parameters
Type Name Description
CheckoutSettingsName name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
CheckoutSettingsName name = CheckoutSettingsName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]");
// Make the request
await checkoutSettingsServiceClient.DeleteCheckoutSettingsAsync(name);

DeleteCheckoutSettingsAsync(DeleteCheckoutSettingsRequest, CallSettings)

Deletes CheckoutSettings and unenrolls merchant from Checkout program.

Declaration
public virtual Task DeleteCheckoutSettingsAsync(DeleteCheckoutSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteCheckoutSettingsRequest 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
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteCheckoutSettingsRequest request = new DeleteCheckoutSettingsRequest
{
    CheckoutSettingsName = CheckoutSettingsName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]"),
};
// Make the request
await checkoutSettingsServiceClient.DeleteCheckoutSettingsAsync(request);

DeleteCheckoutSettingsAsync(DeleteCheckoutSettingsRequest, CancellationToken)

Deletes CheckoutSettings and unenrolls merchant from Checkout program.

Declaration
public virtual Task DeleteCheckoutSettingsAsync(DeleteCheckoutSettingsRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
DeleteCheckoutSettingsRequest 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
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteCheckoutSettingsRequest request = new DeleteCheckoutSettingsRequest
{
    CheckoutSettingsName = CheckoutSettingsName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]"),
};
// Make the request
await checkoutSettingsServiceClient.DeleteCheckoutSettingsAsync(request);

DeleteCheckoutSettingsAsync(string, CallSettings)

Deletes CheckoutSettings and unenrolls merchant from Checkout program.

Declaration
public virtual Task DeleteCheckoutSettingsAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

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
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/programs/[PROGRAM]/checkoutSettings";
// Make the request
await checkoutSettingsServiceClient.DeleteCheckoutSettingsAsync(name);

DeleteCheckoutSettingsAsync(string, CancellationToken)

Deletes CheckoutSettings and unenrolls merchant from Checkout program.

Declaration
public virtual Task DeleteCheckoutSettingsAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
string name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/programs/[PROGRAM]/checkoutSettings";
// Make the request
await checkoutSettingsServiceClient.DeleteCheckoutSettingsAsync(name);

GetCheckoutSettings(CheckoutSettingsName, CallSettings)

Gets CheckoutSettings for the given merchant. This includes information about review state, enrollment state and URL settings.

Declaration
public virtual CheckoutSettings GetCheckoutSettings(CheckoutSettingsName name, CallSettings callSettings = null)
Parameters
Type Name Description
CheckoutSettingsName name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
CheckoutSettings

The RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = CheckoutSettingsServiceClient.Create();
// Initialize request argument(s)
CheckoutSettingsName name = CheckoutSettingsName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]");
// Make the request
CheckoutSettings response = checkoutSettingsServiceClient.GetCheckoutSettings(name);

GetCheckoutSettings(GetCheckoutSettingsRequest, CallSettings)

Gets CheckoutSettings for the given merchant. This includes information about review state, enrollment state and URL settings.

Declaration
public virtual CheckoutSettings GetCheckoutSettings(GetCheckoutSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetCheckoutSettingsRequest 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
CheckoutSettings

The RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = CheckoutSettingsServiceClient.Create();
// Initialize request argument(s)
GetCheckoutSettingsRequest request = new GetCheckoutSettingsRequest
{
    CheckoutSettingsName = CheckoutSettingsName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]"),
};
// Make the request
CheckoutSettings response = checkoutSettingsServiceClient.GetCheckoutSettings(request);

GetCheckoutSettings(string, CallSettings)

Gets CheckoutSettings for the given merchant. This includes information about review state, enrollment state and URL settings.

Declaration
public virtual CheckoutSettings GetCheckoutSettings(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
CheckoutSettings

The RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = CheckoutSettingsServiceClient.Create();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/programs/[PROGRAM]/checkoutSettings";
// Make the request
CheckoutSettings response = checkoutSettingsServiceClient.GetCheckoutSettings(name);

GetCheckoutSettingsAsync(CheckoutSettingsName, CallSettings)

Gets CheckoutSettings for the given merchant. This includes information about review state, enrollment state and URL settings.

Declaration
public virtual Task<CheckoutSettings> GetCheckoutSettingsAsync(CheckoutSettingsName name, CallSettings callSettings = null)
Parameters
Type Name Description
CheckoutSettingsName name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
CheckoutSettingsName name = CheckoutSettingsName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]");
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.GetCheckoutSettingsAsync(name);

GetCheckoutSettingsAsync(CheckoutSettingsName, CancellationToken)

Gets CheckoutSettings for the given merchant. This includes information about review state, enrollment state and URL settings.

Declaration
public virtual Task<CheckoutSettings> GetCheckoutSettingsAsync(CheckoutSettingsName name, CancellationToken cancellationToken)
Parameters
Type Name Description
CheckoutSettingsName name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
CheckoutSettingsName name = CheckoutSettingsName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]");
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.GetCheckoutSettingsAsync(name);

GetCheckoutSettingsAsync(GetCheckoutSettingsRequest, CallSettings)

Gets CheckoutSettings for the given merchant. This includes information about review state, enrollment state and URL settings.

Declaration
public virtual Task<CheckoutSettings> GetCheckoutSettingsAsync(GetCheckoutSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetCheckoutSettingsRequest 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<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
GetCheckoutSettingsRequest request = new GetCheckoutSettingsRequest
{
    CheckoutSettingsName = CheckoutSettingsName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]"),
};
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.GetCheckoutSettingsAsync(request);

GetCheckoutSettingsAsync(GetCheckoutSettingsRequest, CancellationToken)

Gets CheckoutSettings for the given merchant. This includes information about review state, enrollment state and URL settings.

Declaration
public virtual Task<CheckoutSettings> GetCheckoutSettingsAsync(GetCheckoutSettingsRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetCheckoutSettingsRequest 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<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
GetCheckoutSettingsRequest request = new GetCheckoutSettingsRequest
{
    CheckoutSettingsName = CheckoutSettingsName.FromAccountProgram("[ACCOUNT]", "[PROGRAM]"),
};
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.GetCheckoutSettingsAsync(request);

GetCheckoutSettingsAsync(string, CallSettings)

Gets CheckoutSettings for the given merchant. This includes information about review state, enrollment state and URL settings.

Declaration
public virtual Task<CheckoutSettings> GetCheckoutSettingsAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/programs/[PROGRAM]/checkoutSettings";
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.GetCheckoutSettingsAsync(name);

GetCheckoutSettingsAsync(string, CancellationToken)

Gets CheckoutSettings for the given merchant. This includes information about review state, enrollment state and URL settings.

Declaration
public virtual Task<CheckoutSettings> GetCheckoutSettingsAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
string name

Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/programs/[PROGRAM]/checkoutSettings";
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.GetCheckoutSettingsAsync(name);

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.

UpdateCheckoutSettings(CheckoutSettings, FieldMask, CallSettings)

Updates CheckoutSettings for the given merchant.

Declaration
public virtual CheckoutSettings UpdateCheckoutSettings(CheckoutSettings checkoutSettings, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
CheckoutSettings checkoutSettings

Required. The updated version of the CheckoutSettings. The name field is used to identify the CheckoutSettings. Format: accounts/{account}/programs/{program}/checkoutSettings

FieldMask updateMask

Required. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase):

  • eligible_destinations
  • uri_settings
CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
CheckoutSettings

The RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = CheckoutSettingsServiceClient.Create();
// Initialize request argument(s)
CheckoutSettings checkoutSettings = new CheckoutSettings();
FieldMask updateMask = new FieldMask();
// Make the request
CheckoutSettings response = checkoutSettingsServiceClient.UpdateCheckoutSettings(checkoutSettings, updateMask);

UpdateCheckoutSettings(UpdateCheckoutSettingsRequest, CallSettings)

Updates CheckoutSettings for the given merchant.

Declaration
public virtual CheckoutSettings UpdateCheckoutSettings(UpdateCheckoutSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateCheckoutSettingsRequest 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
CheckoutSettings

The RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = CheckoutSettingsServiceClient.Create();
// Initialize request argument(s)
UpdateCheckoutSettingsRequest request = new UpdateCheckoutSettingsRequest
{
    CheckoutSettings = new CheckoutSettings(),
    UpdateMask = new FieldMask(),
};
// Make the request
CheckoutSettings response = checkoutSettingsServiceClient.UpdateCheckoutSettings(request);

UpdateCheckoutSettingsAsync(CheckoutSettings, FieldMask, CallSettings)

Updates CheckoutSettings for the given merchant.

Declaration
public virtual Task<CheckoutSettings> UpdateCheckoutSettingsAsync(CheckoutSettings checkoutSettings, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
CheckoutSettings checkoutSettings

Required. The updated version of the CheckoutSettings. The name field is used to identify the CheckoutSettings. Format: accounts/{account}/programs/{program}/checkoutSettings

FieldMask updateMask

Required. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase):

  • eligible_destinations
  • uri_settings
CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
CheckoutSettings checkoutSettings = new CheckoutSettings();
FieldMask updateMask = new FieldMask();
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.UpdateCheckoutSettingsAsync(checkoutSettings, updateMask);

UpdateCheckoutSettingsAsync(CheckoutSettings, FieldMask, CancellationToken)

Updates CheckoutSettings for the given merchant.

Declaration
public virtual Task<CheckoutSettings> UpdateCheckoutSettingsAsync(CheckoutSettings checkoutSettings, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
Type Name Description
CheckoutSettings checkoutSettings

Required. The updated version of the CheckoutSettings. The name field is used to identify the CheckoutSettings. Format: accounts/{account}/programs/{program}/checkoutSettings

FieldMask updateMask

Required. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase):

  • eligible_destinations
  • uri_settings
CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
CheckoutSettings checkoutSettings = new CheckoutSettings();
FieldMask updateMask = new FieldMask();
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.UpdateCheckoutSettingsAsync(checkoutSettings, updateMask);

UpdateCheckoutSettingsAsync(UpdateCheckoutSettingsRequest, CallSettings)

Updates CheckoutSettings for the given merchant.

Declaration
public virtual Task<CheckoutSettings> UpdateCheckoutSettingsAsync(UpdateCheckoutSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateCheckoutSettingsRequest 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<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateCheckoutSettingsRequest request = new UpdateCheckoutSettingsRequest
{
    CheckoutSettings = new CheckoutSettings(),
    UpdateMask = new FieldMask(),
};
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.UpdateCheckoutSettingsAsync(request);

UpdateCheckoutSettingsAsync(UpdateCheckoutSettingsRequest, CancellationToken)

Updates CheckoutSettings for the given merchant.

Declaration
public virtual Task<CheckoutSettings> UpdateCheckoutSettingsAsync(UpdateCheckoutSettingsRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
UpdateCheckoutSettingsRequest 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<CheckoutSettings>

A Task containing the RPC response.

Sample code
// Create client
CheckoutSettingsServiceClient checkoutSettingsServiceClient = await CheckoutSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateCheckoutSettingsRequest request = new UpdateCheckoutSettingsRequest
{
    CheckoutSettings = new CheckoutSettings(),
    UpdateMask = new FieldMask(),
};
// Make the request
CheckoutSettings response = await checkoutSettingsServiceClient.UpdateCheckoutSettingsAsync(request);
In this article
Back to top Generated by DocFX