Class OmnichannelSettingsServiceClient

OmnichannelSettingsService client wrapper, for convenient use.

Inheritance
object
OmnichannelSettingsServiceClient
OmnichannelSettingsServiceClientImpl
Inherited Members
Namespace: Google.Shopping.Merchant.Accounts.V1
Assembly: Google.Shopping.Merchant.Accounts.V1.dll
Syntax
public abstract class OmnichannelSettingsServiceClient
Remarks

The service facilitates the management of a merchant's omnichannel settings.

This API defines the following resource model:

[OmnichannelSetting][google.shopping.merchant.accounts.v1.OmnichannelSetting]

Properties

DefaultEndpoint

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

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

The default OmnichannelSettingsService scopes are:

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

GrpcClient

The underlying gRPC OmnichannelSettingsService client

Declaration
public virtual OmnichannelSettingsService.OmnichannelSettingsServiceClient GrpcClient { get; }
Property Value
Type Description
OmnichannelSettingsService.OmnichannelSettingsServiceClient

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

Declaration
public static OmnichannelSettingsServiceClient Create()
Returns
Type Description
OmnichannelSettingsServiceClient

The created OmnichannelSettingsServiceClient.

CreateAsync(CancellationToken)

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

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

The CancellationToken to use while creating the client.
Returns
Type Description
Task<OmnichannelSettingsServiceClient>

The task representing the created OmnichannelSettingsServiceClient.

CreateOmnichannelSetting(AccountName, OmnichannelSetting, CallSettings)

Create the omnichannel settings for a given merchant.

Declaration
public virtual OmnichannelSetting CreateOmnichannelSetting(AccountName parent, OmnichannelSetting omnichannelSetting, CallSettings callSettings = null)
Parameters
Type Name Description
AccountName parent

Required. The parent resource where this omnichannel setting will be created. Format: accounts/{account}
OmnichannelSetting omnichannelSetting

Required. The omnichannel setting to create.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OmnichannelSetting

The RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
OmnichannelSetting omnichannelSetting = new OmnichannelSetting();
// Make the request
OmnichannelSetting response = omnichannelSettingsServiceClient.CreateOmnichannelSetting(parent, omnichannelSetting);

CreateOmnichannelSetting(CreateOmnichannelSettingRequest, CallSettings)

Create the omnichannel settings for a given merchant.

Declaration
public virtual OmnichannelSetting CreateOmnichannelSetting(CreateOmnichannelSettingRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateOmnichannelSettingRequest 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
OmnichannelSetting

The RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
CreateOmnichannelSettingRequest request = new CreateOmnichannelSettingRequest
{
    ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
    OmnichannelSetting = new OmnichannelSetting(),
};
// Make the request
OmnichannelSetting response = omnichannelSettingsServiceClient.CreateOmnichannelSetting(request);

CreateOmnichannelSetting(string, OmnichannelSetting, CallSettings)

Create the omnichannel settings for a given merchant.

Declaration
public virtual OmnichannelSetting CreateOmnichannelSetting(string parent, OmnichannelSetting omnichannelSetting, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent resource where this omnichannel setting will be created. Format: accounts/{account}
OmnichannelSetting omnichannelSetting

Required. The omnichannel setting to create.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OmnichannelSetting

The RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
OmnichannelSetting omnichannelSetting = new OmnichannelSetting();
// Make the request
OmnichannelSetting response = omnichannelSettingsServiceClient.CreateOmnichannelSetting(parent, omnichannelSetting);

CreateOmnichannelSettingAsync(AccountName, OmnichannelSetting, CallSettings)

Create the omnichannel settings for a given merchant.

Declaration
public virtual Task<OmnichannelSetting> CreateOmnichannelSettingAsync(AccountName parent, OmnichannelSetting omnichannelSetting, CallSettings callSettings = null)
Parameters
Type Name Description
AccountName parent

Required. The parent resource where this omnichannel setting will be created. Format: accounts/{account}
OmnichannelSetting omnichannelSetting

Required. The omnichannel setting to create.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
OmnichannelSetting omnichannelSetting = new OmnichannelSetting();
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.CreateOmnichannelSettingAsync(parent, omnichannelSetting);

CreateOmnichannelSettingAsync(AccountName, OmnichannelSetting, CancellationToken)

Create the omnichannel settings for a given merchant.

Declaration
public virtual Task<OmnichannelSetting> CreateOmnichannelSettingAsync(AccountName parent, OmnichannelSetting omnichannelSetting, CancellationToken cancellationToken)
Parameters
Type Name Description
AccountName parent

Required. The parent resource where this omnichannel setting will be created. Format: accounts/{account}
OmnichannelSetting omnichannelSetting

Required. The omnichannel setting to create.
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
OmnichannelSetting omnichannelSetting = new OmnichannelSetting();
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.CreateOmnichannelSettingAsync(parent, omnichannelSetting);

CreateOmnichannelSettingAsync(CreateOmnichannelSettingRequest, CallSettings)

Create the omnichannel settings for a given merchant.

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

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
CreateOmnichannelSettingRequest request = new CreateOmnichannelSettingRequest
{
    ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
    OmnichannelSetting = new OmnichannelSetting(),
};
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.CreateOmnichannelSettingAsync(request);

CreateOmnichannelSettingAsync(CreateOmnichannelSettingRequest, CancellationToken)

Create the omnichannel settings for a given merchant.

Declaration
public virtual Task<OmnichannelSetting> CreateOmnichannelSettingAsync(CreateOmnichannelSettingRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateOmnichannelSettingRequest 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<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
CreateOmnichannelSettingRequest request = new CreateOmnichannelSettingRequest
{
    ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
    OmnichannelSetting = new OmnichannelSetting(),
};
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.CreateOmnichannelSettingAsync(request);

CreateOmnichannelSettingAsync(string, OmnichannelSetting, CallSettings)

Create the omnichannel settings for a given merchant.

Declaration
public virtual Task<OmnichannelSetting> CreateOmnichannelSettingAsync(string parent, OmnichannelSetting omnichannelSetting, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent resource where this omnichannel setting will be created. Format: accounts/{account}
OmnichannelSetting omnichannelSetting

Required. The omnichannel setting to create.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
OmnichannelSetting omnichannelSetting = new OmnichannelSetting();
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.CreateOmnichannelSettingAsync(parent, omnichannelSetting);

CreateOmnichannelSettingAsync(string, OmnichannelSetting, CancellationToken)

Create the omnichannel settings for a given merchant.

Declaration
public virtual Task<OmnichannelSetting> CreateOmnichannelSettingAsync(string parent, OmnichannelSetting omnichannelSetting, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. The parent resource where this omnichannel setting will be created. Format: accounts/{account}
OmnichannelSetting omnichannelSetting

Required. The omnichannel setting to create.
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
OmnichannelSetting omnichannelSetting = new OmnichannelSetting();
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.CreateOmnichannelSettingAsync(parent, omnichannelSetting);

GetOmnichannelSetting(GetOmnichannelSettingRequest, CallSettings)

Get the omnichannel settings for a given merchant.

Declaration
public virtual OmnichannelSetting GetOmnichannelSetting(GetOmnichannelSettingRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetOmnichannelSettingRequest 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
OmnichannelSetting

The RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
GetOmnichannelSettingRequest request = new GetOmnichannelSettingRequest
{
    OmnichannelSettingName = OmnichannelSettingName.FromAccountOmnichannelSetting("[ACCOUNT]", "[OMNICHANNEL_SETTING]"),
};
// Make the request
OmnichannelSetting response = omnichannelSettingsServiceClient.GetOmnichannelSetting(request);

GetOmnichannelSetting(OmnichannelSettingName, CallSettings)

Get the omnichannel settings for a given merchant.

Declaration
public virtual OmnichannelSetting GetOmnichannelSetting(OmnichannelSettingName name, CallSettings callSettings = null)
Parameters
Type Name Description
OmnichannelSettingName name

Required. The name of the omnichannel setting to retrieve. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OmnichannelSetting

The RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
OmnichannelSettingName name = OmnichannelSettingName.FromAccountOmnichannelSetting("[ACCOUNT]", "[OMNICHANNEL_SETTING]");
// Make the request
OmnichannelSetting response = omnichannelSettingsServiceClient.GetOmnichannelSetting(name);

GetOmnichannelSetting(string, CallSettings)

Get the omnichannel settings for a given merchant.

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

Required. The name of the omnichannel setting to retrieve. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OmnichannelSetting

The RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/omnichannelSettings/[OMNICHANNEL_SETTING]";
// Make the request
OmnichannelSetting response = omnichannelSettingsServiceClient.GetOmnichannelSetting(name);

GetOmnichannelSettingAsync(GetOmnichannelSettingRequest, CallSettings)

Get the omnichannel settings for a given merchant.

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

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
GetOmnichannelSettingRequest request = new GetOmnichannelSettingRequest
{
    OmnichannelSettingName = OmnichannelSettingName.FromAccountOmnichannelSetting("[ACCOUNT]", "[OMNICHANNEL_SETTING]"),
};
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.GetOmnichannelSettingAsync(request);

GetOmnichannelSettingAsync(GetOmnichannelSettingRequest, CancellationToken)

Get the omnichannel settings for a given merchant.

Declaration
public virtual Task<OmnichannelSetting> GetOmnichannelSettingAsync(GetOmnichannelSettingRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetOmnichannelSettingRequest 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<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
GetOmnichannelSettingRequest request = new GetOmnichannelSettingRequest
{
    OmnichannelSettingName = OmnichannelSettingName.FromAccountOmnichannelSetting("[ACCOUNT]", "[OMNICHANNEL_SETTING]"),
};
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.GetOmnichannelSettingAsync(request);

GetOmnichannelSettingAsync(OmnichannelSettingName, CallSettings)

Get the omnichannel settings for a given merchant.

Declaration
public virtual Task<OmnichannelSetting> GetOmnichannelSettingAsync(OmnichannelSettingName name, CallSettings callSettings = null)
Parameters
Type Name Description
OmnichannelSettingName name

Required. The name of the omnichannel setting to retrieve. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
OmnichannelSettingName name = OmnichannelSettingName.FromAccountOmnichannelSetting("[ACCOUNT]", "[OMNICHANNEL_SETTING]");
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.GetOmnichannelSettingAsync(name);

GetOmnichannelSettingAsync(OmnichannelSettingName, CancellationToken)

Get the omnichannel settings for a given merchant.

Declaration
public virtual Task<OmnichannelSetting> GetOmnichannelSettingAsync(OmnichannelSettingName name, CancellationToken cancellationToken)
Parameters
Type Name Description
OmnichannelSettingName name

Required. The name of the omnichannel setting to retrieve. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
OmnichannelSettingName name = OmnichannelSettingName.FromAccountOmnichannelSetting("[ACCOUNT]", "[OMNICHANNEL_SETTING]");
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.GetOmnichannelSettingAsync(name);

GetOmnichannelSettingAsync(string, CallSettings)

Get the omnichannel settings for a given merchant.

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

Required. The name of the omnichannel setting to retrieve. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/omnichannelSettings/[OMNICHANNEL_SETTING]";
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.GetOmnichannelSettingAsync(name);

GetOmnichannelSettingAsync(string, CancellationToken)

Get the omnichannel settings for a given merchant.

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

Required. The name of the omnichannel setting to retrieve. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/omnichannelSettings/[OMNICHANNEL_SETTING]";
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.GetOmnichannelSettingAsync(name);

ListOmnichannelSettings(AccountName, string, int?, CallSettings)

List all the omnichannel settings for a given merchant.

Declaration
public virtual PagedEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting> ListOmnichannelSettings(AccountName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
AccountName parent

Required. The parent, which owns this collection of omnichannel settings. Format: accounts/{account}
string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.
int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting>

A pageable sequence of OmnichannelSetting resources.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
// Make the request
PagedEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting> response = omnichannelSettingsServiceClient.ListOmnichannelSettings(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (OmnichannelSetting item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListOmnichannelSettingsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (OmnichannelSetting item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<OmnichannelSetting> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (OmnichannelSetting item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListOmnichannelSettings(ListOmnichannelSettingsRequest, CallSettings)

List all the omnichannel settings for a given merchant.

Declaration
public virtual PagedEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting> ListOmnichannelSettings(ListOmnichannelSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListOmnichannelSettingsRequest 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
PagedEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting>

A pageable sequence of OmnichannelSetting resources.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
ListOmnichannelSettingsRequest request = new ListOmnichannelSettingsRequest
{
    ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
};
// Make the request
PagedEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting> response = omnichannelSettingsServiceClient.ListOmnichannelSettings(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (OmnichannelSetting item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListOmnichannelSettingsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (OmnichannelSetting item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<OmnichannelSetting> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (OmnichannelSetting item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListOmnichannelSettings(string, string, int?, CallSettings)

List all the omnichannel settings for a given merchant.

Declaration
public virtual PagedEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting> ListOmnichannelSettings(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of omnichannel settings. Format: accounts/{account}
string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.
int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting>

A pageable sequence of OmnichannelSetting resources.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
// Make the request
PagedEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting> response = omnichannelSettingsServiceClient.ListOmnichannelSettings(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (OmnichannelSetting item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListOmnichannelSettingsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (OmnichannelSetting item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<OmnichannelSetting> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (OmnichannelSetting item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListOmnichannelSettingsAsync(AccountName, string, int?, CallSettings)

List all the omnichannel settings for a given merchant.

Declaration
public virtual PagedAsyncEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting> ListOmnichannelSettingsAsync(AccountName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
AccountName parent

Required. The parent, which owns this collection of omnichannel settings. Format: accounts/{account}
string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.
int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting>

A pageable asynchronous sequence of OmnichannelSetting resources.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccount("[ACCOUNT]");
// Make the request
PagedAsyncEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting> response = omnichannelSettingsServiceClient.ListOmnichannelSettingsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((OmnichannelSetting item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListOmnichannelSettingsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (OmnichannelSetting item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<OmnichannelSetting> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (OmnichannelSetting item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListOmnichannelSettingsAsync(ListOmnichannelSettingsRequest, CallSettings)

List all the omnichannel settings for a given merchant.

Declaration
public virtual PagedAsyncEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting> ListOmnichannelSettingsAsync(ListOmnichannelSettingsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListOmnichannelSettingsRequest 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
PagedAsyncEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting>

A pageable asynchronous sequence of OmnichannelSetting resources.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
ListOmnichannelSettingsRequest request = new ListOmnichannelSettingsRequest
{
    ParentAsAccountName = AccountName.FromAccount("[ACCOUNT]"),
};
// Make the request
PagedAsyncEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting> response = omnichannelSettingsServiceClient.ListOmnichannelSettingsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((OmnichannelSetting item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListOmnichannelSettingsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (OmnichannelSetting item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<OmnichannelSetting> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (OmnichannelSetting item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListOmnichannelSettingsAsync(string, string, int?, CallSettings)

List all the omnichannel settings for a given merchant.

Declaration
public virtual PagedAsyncEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting> ListOmnichannelSettingsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent, which owns this collection of omnichannel settings. Format: accounts/{account}
string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.
int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting>

A pageable asynchronous sequence of OmnichannelSetting resources.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accounts/[ACCOUNT]";
// Make the request
PagedAsyncEnumerable<ListOmnichannelSettingsResponse, OmnichannelSetting> response = omnichannelSettingsServiceClient.ListOmnichannelSettingsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((OmnichannelSetting item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListOmnichannelSettingsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (OmnichannelSetting item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<OmnichannelSetting> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (OmnichannelSetting item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

RequestInventoryVerification(OmnichannelSettingName, CallSettings)

Requests inventory verification for a given merchant in a given country.

Declaration
public virtual RequestInventoryVerificationResponse RequestInventoryVerification(OmnichannelSettingName name, CallSettings callSettings = null)
Parameters
Type Name Description
OmnichannelSettingName name

Required. The name of the omnichannel setting to request inventory verification. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RequestInventoryVerificationResponse

The RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
OmnichannelSettingName name = OmnichannelSettingName.FromAccountOmnichannelSetting("[ACCOUNT]", "[OMNICHANNEL_SETTING]");
// Make the request
RequestInventoryVerificationResponse response = omnichannelSettingsServiceClient.RequestInventoryVerification(name);

RequestInventoryVerification(RequestInventoryVerificationRequest, CallSettings)

Requests inventory verification for a given merchant in a given country.

Declaration
public virtual RequestInventoryVerificationResponse RequestInventoryVerification(RequestInventoryVerificationRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
RequestInventoryVerificationRequest 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
RequestInventoryVerificationResponse

The RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
RequestInventoryVerificationRequest request = new RequestInventoryVerificationRequest
{
    OmnichannelSettingName = OmnichannelSettingName.FromAccountOmnichannelSetting("[ACCOUNT]", "[OMNICHANNEL_SETTING]"),
};
// Make the request
RequestInventoryVerificationResponse response = omnichannelSettingsServiceClient.RequestInventoryVerification(request);

RequestInventoryVerification(string, CallSettings)

Requests inventory verification for a given merchant in a given country.

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

Required. The name of the omnichannel setting to request inventory verification. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RequestInventoryVerificationResponse

The RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/omnichannelSettings/[OMNICHANNEL_SETTING]";
// Make the request
RequestInventoryVerificationResponse response = omnichannelSettingsServiceClient.RequestInventoryVerification(name);

RequestInventoryVerificationAsync(OmnichannelSettingName, CallSettings)

Requests inventory verification for a given merchant in a given country.

Declaration
public virtual Task<RequestInventoryVerificationResponse> RequestInventoryVerificationAsync(OmnichannelSettingName name, CallSettings callSettings = null)
Parameters
Type Name Description
OmnichannelSettingName name

Required. The name of the omnichannel setting to request inventory verification. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<RequestInventoryVerificationResponse>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
OmnichannelSettingName name = OmnichannelSettingName.FromAccountOmnichannelSetting("[ACCOUNT]", "[OMNICHANNEL_SETTING]");
// Make the request
RequestInventoryVerificationResponse response = await omnichannelSettingsServiceClient.RequestInventoryVerificationAsync(name);

RequestInventoryVerificationAsync(OmnichannelSettingName, CancellationToken)

Requests inventory verification for a given merchant in a given country.

Declaration
public virtual Task<RequestInventoryVerificationResponse> RequestInventoryVerificationAsync(OmnichannelSettingName name, CancellationToken cancellationToken)
Parameters
Type Name Description
OmnichannelSettingName name

Required. The name of the omnichannel setting to request inventory verification. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<RequestInventoryVerificationResponse>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
OmnichannelSettingName name = OmnichannelSettingName.FromAccountOmnichannelSetting("[ACCOUNT]", "[OMNICHANNEL_SETTING]");
// Make the request
RequestInventoryVerificationResponse response = await omnichannelSettingsServiceClient.RequestInventoryVerificationAsync(name);

RequestInventoryVerificationAsync(RequestInventoryVerificationRequest, CallSettings)

Requests inventory verification for a given merchant in a given country.

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

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
RequestInventoryVerificationRequest request = new RequestInventoryVerificationRequest
{
    OmnichannelSettingName = OmnichannelSettingName.FromAccountOmnichannelSetting("[ACCOUNT]", "[OMNICHANNEL_SETTING]"),
};
// Make the request
RequestInventoryVerificationResponse response = await omnichannelSettingsServiceClient.RequestInventoryVerificationAsync(request);

RequestInventoryVerificationAsync(RequestInventoryVerificationRequest, CancellationToken)

Requests inventory verification for a given merchant in a given country.

Declaration
public virtual Task<RequestInventoryVerificationResponse> RequestInventoryVerificationAsync(RequestInventoryVerificationRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
RequestInventoryVerificationRequest 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<RequestInventoryVerificationResponse>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
RequestInventoryVerificationRequest request = new RequestInventoryVerificationRequest
{
    OmnichannelSettingName = OmnichannelSettingName.FromAccountOmnichannelSetting("[ACCOUNT]", "[OMNICHANNEL_SETTING]"),
};
// Make the request
RequestInventoryVerificationResponse response = await omnichannelSettingsServiceClient.RequestInventoryVerificationAsync(request);

RequestInventoryVerificationAsync(string, CallSettings)

Requests inventory verification for a given merchant in a given country.

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

Required. The name of the omnichannel setting to request inventory verification. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<RequestInventoryVerificationResponse>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/omnichannelSettings/[OMNICHANNEL_SETTING]";
// Make the request
RequestInventoryVerificationResponse response = await omnichannelSettingsServiceClient.RequestInventoryVerificationAsync(name);

RequestInventoryVerificationAsync(string, CancellationToken)

Requests inventory verification for a given merchant in a given country.

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

Required. The name of the omnichannel setting to request inventory verification. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<RequestInventoryVerificationResponse>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accounts/[ACCOUNT]/omnichannelSettings/[OMNICHANNEL_SETTING]";
// Make the request
RequestInventoryVerificationResponse response = await omnichannelSettingsServiceClient.RequestInventoryVerificationAsync(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.

UpdateOmnichannelSetting(OmnichannelSetting, FieldMask, CallSettings)

Update the omnichannel setting for a given merchant in a given country.

Declaration
public virtual OmnichannelSetting UpdateOmnichannelSetting(OmnichannelSetting omnichannelSetting, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
OmnichannelSetting omnichannelSetting

Required. The omnichannel setting to update.

The omnichannel setting's name field is used to identify the omnichannel setting to be updated.
FieldMask updateMask

Required. The list of fields to be updated.

The following fields are supported in snake_case only:

  • lsf_type
  • in_stock
  • pickup
  • odo
  • about
  • inventory_verification

Full replacement with wildcard *is supported, while empty/implied update mask is not.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OmnichannelSetting

The RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
OmnichannelSetting omnichannelSetting = new OmnichannelSetting();
FieldMask updateMask = new FieldMask();
// Make the request
OmnichannelSetting response = omnichannelSettingsServiceClient.UpdateOmnichannelSetting(omnichannelSetting, updateMask);

UpdateOmnichannelSetting(UpdateOmnichannelSettingRequest, CallSettings)

Update the omnichannel setting for a given merchant in a given country.

Declaration
public virtual OmnichannelSetting UpdateOmnichannelSetting(UpdateOmnichannelSettingRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateOmnichannelSettingRequest 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
OmnichannelSetting

The RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = OmnichannelSettingsServiceClient.Create();
// Initialize request argument(s)
UpdateOmnichannelSettingRequest request = new UpdateOmnichannelSettingRequest
{
    OmnichannelSetting = new OmnichannelSetting(),
    UpdateMask = new FieldMask(),
};
// Make the request
OmnichannelSetting response = omnichannelSettingsServiceClient.UpdateOmnichannelSetting(request);

UpdateOmnichannelSettingAsync(OmnichannelSetting, FieldMask, CallSettings)

Update the omnichannel setting for a given merchant in a given country.

Declaration
public virtual Task<OmnichannelSetting> UpdateOmnichannelSettingAsync(OmnichannelSetting omnichannelSetting, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
OmnichannelSetting omnichannelSetting

Required. The omnichannel setting to update.

The omnichannel setting's name field is used to identify the omnichannel setting to be updated.
FieldMask updateMask

Required. The list of fields to be updated.

The following fields are supported in snake_case only:

  • lsf_type
  • in_stock
  • pickup
  • odo
  • about
  • inventory_verification

Full replacement with wildcard *is supported, while empty/implied update mask is not.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
OmnichannelSetting omnichannelSetting = new OmnichannelSetting();
FieldMask updateMask = new FieldMask();
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.UpdateOmnichannelSettingAsync(omnichannelSetting, updateMask);

UpdateOmnichannelSettingAsync(OmnichannelSetting, FieldMask, CancellationToken)

Update the omnichannel setting for a given merchant in a given country.

Declaration
public virtual Task<OmnichannelSetting> UpdateOmnichannelSettingAsync(OmnichannelSetting omnichannelSetting, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
Type Name Description
OmnichannelSetting omnichannelSetting

Required. The omnichannel setting to update.

The omnichannel setting's name field is used to identify the omnichannel setting to be updated.
FieldMask updateMask

Required. The list of fields to be updated.

The following fields are supported in snake_case only:

  • lsf_type
  • in_stock
  • pickup
  • odo
  • about
  • inventory_verification

Full replacement with wildcard *is supported, while empty/implied update mask is not.
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
OmnichannelSetting omnichannelSetting = new OmnichannelSetting();
FieldMask updateMask = new FieldMask();
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.UpdateOmnichannelSettingAsync(omnichannelSetting, updateMask);

UpdateOmnichannelSettingAsync(UpdateOmnichannelSettingRequest, CallSettings)

Update the omnichannel setting for a given merchant in a given country.

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

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateOmnichannelSettingRequest request = new UpdateOmnichannelSettingRequest
{
    OmnichannelSetting = new OmnichannelSetting(),
    UpdateMask = new FieldMask(),
};
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.UpdateOmnichannelSettingAsync(request);

UpdateOmnichannelSettingAsync(UpdateOmnichannelSettingRequest, CancellationToken)

Update the omnichannel setting for a given merchant in a given country.

Declaration
public virtual Task<OmnichannelSetting> UpdateOmnichannelSettingAsync(UpdateOmnichannelSettingRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
UpdateOmnichannelSettingRequest 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<OmnichannelSetting>

A Task containing the RPC response.
Sample code
// Create client
OmnichannelSettingsServiceClient omnichannelSettingsServiceClient = await OmnichannelSettingsServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateOmnichannelSettingRequest request = new UpdateOmnichannelSettingRequest
{
    OmnichannelSetting = new OmnichannelSetting(),
    UpdateMask = new FieldMask(),
};
// Make the request
OmnichannelSetting response = await omnichannelSettingsServiceClient.UpdateOmnichannelSettingAsync(request);