Class AccountsService.AccountsServiceClient

Client for AccountsService

Inheritance

object

ClientBase

ClientBase<AccountsService.AccountsServiceClient>

AccountsService.AccountsServiceClient

Inherited Members

ClientBase<AccountsService.AccountsServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Shopping.Merchant.Accounts.V1

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

Syntax

public class AccountsService.AccountsServiceClient : ClientBase<AccountsService.AccountsServiceClient>

Constructors

AccountsServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected AccountsServiceClient()

AccountsServiceClient(CallInvoker)

Creates a new client for AccountsService that uses a custom CallInvoker.

Declaration

public AccountsServiceClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

AccountsServiceClient(ChannelBase)

Creates a new client for AccountsService

Declaration

public AccountsServiceClient(ChannelBase channel)

Parameters

Type	Name	Description
ChannelBase	channel	The channel to use to make remote calls.

AccountsServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected AccountsServiceClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

CreateAndConfigureAccount(CreateAndConfigureAccountRequest, CallOptions)

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

Declaration

public virtual Account CreateAndConfigureAccount(CreateAndConfigureAccountRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateAndConfigureAccountRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Account	The response received from the server.

CreateAndConfigureAccount(CreateAndConfigureAccountRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual Account CreateAndConfigureAccount(CreateAndConfigureAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateAndConfigureAccountRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Account	The response received from the server.

CreateAndConfigureAccountAsync(CreateAndConfigureAccountRequest, CallOptions)

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

Declaration

public virtual AsyncUnaryCall<Account> CreateAndConfigureAccountAsync(CreateAndConfigureAccountRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateAndConfigureAccountRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Account>	The call object.

CreateAndConfigureAccountAsync(CreateAndConfigureAccountRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual AsyncUnaryCall<Account> CreateAndConfigureAccountAsync(CreateAndConfigureAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateAndConfigureAccountRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Account>	The call object.

DeleteAccount(DeleteAccountRequest, CallOptions)

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 virtual Empty DeleteAccount(DeleteAccountRequest request, CallOptions options)

Parameters

Type	Name	Description
DeleteAccountRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Empty	The response received from the server.

DeleteAccount(DeleteAccountRequest, Metadata, DateTime?, CancellationToken)

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 virtual Empty DeleteAccount(DeleteAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DeleteAccountRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Empty	The response received from the server.

DeleteAccountAsync(DeleteAccountRequest, CallOptions)

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 virtual AsyncUnaryCall<Empty> DeleteAccountAsync(DeleteAccountRequest request, CallOptions options)

Parameters

Type	Name	Description
DeleteAccountRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Empty>	The call object.

DeleteAccountAsync(DeleteAccountRequest, Metadata, DateTime?, CancellationToken)

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 virtual AsyncUnaryCall<Empty> DeleteAccountAsync(DeleteAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DeleteAccountRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Empty>	The call object.

GetAccount(GetAccountRequest, CallOptions)

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 virtual Account GetAccount(GetAccountRequest request, CallOptions options)

Parameters

Type	Name	Description
GetAccountRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Account	The response received from the server.

GetAccount(GetAccountRequest, Metadata, DateTime?, CancellationToken)

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 virtual Account GetAccount(GetAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetAccountRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Account	The response received from the server.

GetAccountAsync(GetAccountRequest, CallOptions)

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 virtual AsyncUnaryCall<Account> GetAccountAsync(GetAccountRequest request, CallOptions options)

Parameters

Type	Name	Description
GetAccountRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Account>	The call object.

GetAccountAsync(GetAccountRequest, Metadata, DateTime?, CancellationToken)

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 virtual AsyncUnaryCall<Account> GetAccountAsync(GetAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetAccountRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Account>	The call object.

ListAccounts(ListAccountsRequest, CallOptions)

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 virtual ListAccountsResponse ListAccounts(ListAccountsRequest request, CallOptions options)

Parameters

Type	Name	Description
ListAccountsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
ListAccountsResponse	The response received from the server.

ListAccounts(ListAccountsRequest, Metadata, DateTime?, CancellationToken)

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 virtual ListAccountsResponse ListAccounts(ListAccountsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListAccountsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
ListAccountsResponse	The response received from the server.

ListAccountsAsync(ListAccountsRequest, CallOptions)

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 virtual AsyncUnaryCall<ListAccountsResponse> ListAccountsAsync(ListAccountsRequest request, CallOptions options)

Parameters

Type	Name	Description
ListAccountsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<ListAccountsResponse>	The call object.

ListAccountsAsync(ListAccountsRequest, Metadata, DateTime?, CancellationToken)

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 virtual AsyncUnaryCall<ListAccountsResponse> ListAccountsAsync(ListAccountsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListAccountsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<ListAccountsResponse>	The call object.

ListSubAccounts(ListSubAccountsRequest, CallOptions)

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 virtual ListSubAccountsResponse ListSubAccounts(ListSubAccountsRequest request, CallOptions options)

Parameters

Type	Name	Description
ListSubAccountsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
ListSubAccountsResponse	The response received from the server.

ListSubAccounts(ListSubAccountsRequest, Metadata, DateTime?, CancellationToken)

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 virtual ListSubAccountsResponse ListSubAccounts(ListSubAccountsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSubAccountsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
ListSubAccountsResponse	The response received from the server.

ListSubAccountsAsync(ListSubAccountsRequest, CallOptions)

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 virtual AsyncUnaryCall<ListSubAccountsResponse> ListSubAccountsAsync(ListSubAccountsRequest request, CallOptions options)

Parameters

Type	Name	Description
ListSubAccountsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<ListSubAccountsResponse>	The call object.

ListSubAccountsAsync(ListSubAccountsRequest, Metadata, DateTime?, CancellationToken)

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 virtual AsyncUnaryCall<ListSubAccountsResponse> ListSubAccountsAsync(ListSubAccountsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSubAccountsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<ListSubAccountsResponse>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override AccountsService.AccountsServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
AccountsService.AccountsServiceClient

Overrides

Grpc.Core.ClientBase<Google.Shopping.Merchant.Accounts.V1.AccountsService.AccountsServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateAccount(UpdateAccountRequest, CallOptions)

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

Declaration

public virtual Account UpdateAccount(UpdateAccountRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateAccountRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Account	The response received from the server.

UpdateAccount(UpdateAccountRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual Account UpdateAccount(UpdateAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateAccountRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Account	The response received from the server.

UpdateAccountAsync(UpdateAccountRequest, CallOptions)

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

Declaration

public virtual AsyncUnaryCall<Account> UpdateAccountAsync(UpdateAccountRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateAccountRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Account>	The call object.

UpdateAccountAsync(UpdateAccountRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual AsyncUnaryCall<Account> UpdateAccountAsync(UpdateAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateAccountRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Account>	The call object.