Class AccountsServiceClientImpl

AccountsService client wrapper implementation, for convenient use.

Inheritance

object

AccountsServiceClient

AccountsServiceClientImpl

Inherited Members

AccountsServiceClient.DefaultEndpoint

AccountsServiceClient.DefaultScopes

AccountsServiceClient.ServiceMetadata

AccountsServiceClient.CreateAsync(CancellationToken)

AccountsServiceClient.Create()

AccountsServiceClient.ShutdownDefaultChannelsAsync()

AccountsServiceClient.GetAccountAsync(GetAccountRequest, CancellationToken)

AccountsServiceClient.GetAccount(string, CallSettings)

AccountsServiceClient.GetAccountAsync(string, CallSettings)

AccountsServiceClient.GetAccountAsync(string, CancellationToken)

AccountsServiceClient.GetAccount(AccountName, CallSettings)

AccountsServiceClient.GetAccountAsync(AccountName, CallSettings)

AccountsServiceClient.GetAccountAsync(AccountName, CancellationToken)

AccountsServiceClient.CreateAndConfigureAccountAsync(CreateAndConfigureAccountRequest, CancellationToken)

AccountsServiceClient.DeleteAccountAsync(DeleteAccountRequest, CancellationToken)

AccountsServiceClient.DeleteAccount(string, CallSettings)

AccountsServiceClient.DeleteAccountAsync(string, CallSettings)

AccountsServiceClient.DeleteAccountAsync(string, CancellationToken)

AccountsServiceClient.DeleteAccount(AccountName, CallSettings)

AccountsServiceClient.DeleteAccountAsync(AccountName, CallSettings)

AccountsServiceClient.DeleteAccountAsync(AccountName, CancellationToken)

AccountsServiceClient.UpdateAccountAsync(UpdateAccountRequest, CancellationToken)

AccountsServiceClient.UpdateAccount(Account, FieldMask, CallSettings)

AccountsServiceClient.UpdateAccountAsync(Account, FieldMask, CallSettings)

AccountsServiceClient.UpdateAccountAsync(Account, FieldMask, CancellationToken)

AccountsServiceClient.ListSubAccounts(string, string, int?, CallSettings)

AccountsServiceClient.ListSubAccountsAsync(string, string, int?, CallSettings)

AccountsServiceClient.ListSubAccounts(AccountName, string, int?, CallSettings)

AccountsServiceClient.ListSubAccountsAsync(AccountName, string, int?, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Shopping.Merchant.Accounts.V1

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

Syntax

public sealed class AccountsServiceClientImpl : AccountsServiceClient

Remarks

Service to support Accounts API.

Constructors

AccountsServiceClientImpl(AccountsServiceClient, AccountsServiceSettings, ILogger)

Constructs a client wrapper for the AccountsService service, with the specified gRPC client and settings.

Declaration

public AccountsServiceClientImpl(AccountsService.AccountsServiceClient grpcClient, AccountsServiceSettings settings, ILogger logger)

Parameters

Type	Name	Description
AccountsService.AccountsServiceClient	grpcClient	The underlying gRPC client.
AccountsServiceSettings	settings	The base AccountsServiceSettings used within this client.
ILogger	logger	Optional ILogger to use within this client.

Properties

GrpcClient

The underlying gRPC AccountsService client

Declaration

public override AccountsService.AccountsServiceClient GrpcClient { get; }

Property Value

Type	Description
AccountsService.AccountsServiceClient

Overrides

AccountsServiceClient.GrpcClient

Methods

CreateAndConfigureAccount(CreateAndConfigureAccountRequest, CallSettings)

Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.

Declaration

public override Account CreateAndConfigureAccount(CreateAndConfigureAccountRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
CreateAndConfigureAccountRequest	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
Account	The RPC response.

Overrides

AccountsServiceClient.CreateAndConfigureAccount(CreateAndConfigureAccountRequest, CallSettings)

CreateAndConfigureAccountAsync(CreateAndConfigureAccountRequest, CallSettings)

Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.

Declaration

public override Task<Account> CreateAndConfigureAccountAsync(CreateAndConfigureAccountRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
CreateAndConfigureAccountRequest	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<Account>	A Task containing the RPC response.

Overrides

AccountsServiceClient.CreateAndConfigureAccountAsync(CreateAndConfigureAccountRequest, CallSettings)

DeleteAccount(DeleteAccountRequest, CallSettings)

Deletes the specified account regardless of its type: standalone, advanced account or sub-account. Deleting an advanced account leads to the deletion of all of its sub-accounts. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the force parameter to override this.

Declaration

public override void DeleteAccount(DeleteAccountRequest request, CallSettings callSettings = null)

Parameters

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

Overrides

AccountsServiceClient.DeleteAccount(DeleteAccountRequest, CallSettings)

DeleteAccountAsync(DeleteAccountRequest, CallSettings)

Deletes the specified account regardless of its type: standalone, advanced account or sub-account. Deleting an advanced account leads to the deletion of all of its sub-accounts. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the force parameter to override this.

Declaration

public override Task DeleteAccountAsync(DeleteAccountRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
DeleteAccountRequest	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.

Overrides

AccountsServiceClient.DeleteAccountAsync(DeleteAccountRequest, CallSettings)

GetAccount(GetAccountRequest, CallSettings)

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

Declaration

public override Account GetAccount(GetAccountRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetAccountRequest	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
Account	The RPC response.

Overrides

AccountsServiceClient.GetAccount(GetAccountRequest, CallSettings)

GetAccountAsync(GetAccountRequest, CallSettings)

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

Declaration

public override Task<Account> GetAccountAsync(GetAccountRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetAccountRequest	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<Account>	A Task containing the RPC response.

Overrides

AccountsServiceClient.GetAccountAsync(GetAccountRequest, CallSettings)

ListAccounts(ListAccountsRequest, CallSettings)

Note: For the accounts.list method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the accounts.listSubaccounts method, which is more suitable for advanced accounts use case.

Declaration

public override PagedEnumerable<ListAccountsResponse, Account> ListAccounts(ListAccountsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListAccountsRequest	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<ListAccountsResponse, Account>	A pageable sequence of Account resources.

Overrides

AccountsServiceClient.ListAccounts(ListAccountsRequest, CallSettings)

ListAccountsAsync(ListAccountsRequest, CallSettings)

Note: For the accounts.list method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the accounts.listSubaccounts method, which is more suitable for advanced accounts use case.

Declaration

public override PagedAsyncEnumerable<ListAccountsResponse, Account> ListAccountsAsync(ListAccountsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListAccountsRequest	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<ListAccountsResponse, Account>	A pageable asynchronous sequence of Account resources.

Overrides

AccountsServiceClient.ListAccountsAsync(ListAccountsRequest, CallSettings)

ListSubAccounts(ListSubAccountsRequest, CallSettings)

List all sub-accounts for a given advanced account. This is a convenience wrapper for the more powerful accounts.list method. This method will produce the same results as calling ListsAccounts with the following filter: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

Declaration

public override PagedEnumerable<ListSubAccountsResponse, Account> ListSubAccounts(ListSubAccountsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListSubAccountsRequest	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<ListSubAccountsResponse, Account>	A pageable sequence of Account resources.

Overrides

AccountsServiceClient.ListSubAccounts(ListSubAccountsRequest, CallSettings)

ListSubAccountsAsync(ListSubAccountsRequest, CallSettings)

List all sub-accounts for a given advanced account. This is a convenience wrapper for the more powerful accounts.list method. This method will produce the same results as calling ListsAccounts with the following filter: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

Declaration

public override PagedAsyncEnumerable<ListSubAccountsResponse, Account> ListSubAccountsAsync(ListSubAccountsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListSubAccountsRequest	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<ListSubAccountsResponse, Account>	A pageable asynchronous sequence of Account resources.

Overrides

AccountsServiceClient.ListSubAccountsAsync(ListSubAccountsRequest, CallSettings)

UpdateAccount(UpdateAccountRequest, CallSettings)

Updates an account regardless of its type: standalone, advanced account or sub-account. Executing this method requires admin access.

Declaration

public override Account UpdateAccount(UpdateAccountRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UpdateAccountRequest	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
Account	The RPC response.

Overrides

AccountsServiceClient.UpdateAccount(UpdateAccountRequest, CallSettings)

UpdateAccountAsync(UpdateAccountRequest, CallSettings)

Updates an account regardless of its type: standalone, advanced account or sub-account. Executing this method requires admin access.

Declaration

public override Task<Account> UpdateAccountAsync(UpdateAccountRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UpdateAccountRequest	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<Account>	A Task containing the RPC response.

Overrides

AccountsServiceClient.UpdateAccountAsync(UpdateAccountRequest, CallSettings)