Show / Hide Table of Contents

Class AccountsService.AccountsServiceBase

Base class for server-side implementations of AccountsService

Inheritance
object
AccountsService.AccountsServiceBase
Inherited Members
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Shopping.Merchant.Accounts.V1Beta
Assembly: Google.Shopping.Merchant.Accounts.V1Beta.dll
Syntax
[BindServiceMethod(typeof(AccountsService), "BindService")]
public abstract class AccountsService.AccountsServiceBase

Methods

CreateAndConfigureAccount(CreateAndConfigureAccountRequest, ServerCallContext)

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

Declaration
public virtual Task<Account> CreateAndConfigureAccount(CreateAndConfigureAccountRequest request, ServerCallContext context)
Parameters
Type Name Description
CreateAndConfigureAccountRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<Account>

The response to send back to the client (wrapped by a task).

DeleteAccount(DeleteAccountRequest, ServerCallContext)

Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA 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 Task<Empty> DeleteAccount(DeleteAccountRequest request, ServerCallContext context)
Parameters
Type Name Description
DeleteAccountRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<Empty>

The response to send back to the client (wrapped by a task).

GetAccount(GetAccountRequest, ServerCallContext)

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 Task<Account> GetAccount(GetAccountRequest request, ServerCallContext context)
Parameters
Type Name Description
GetAccountRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<Account>

The response to send back to the client (wrapped by a task).

ListAccounts(ListAccountsRequest, ServerCallContext)

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to.

Declaration
public virtual Task<ListAccountsResponse> ListAccounts(ListAccountsRequest request, ServerCallContext context)
Parameters
Type Name Description
ListAccountsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListAccountsResponse>

The response to send back to the client (wrapped by a task).

ListSubAccounts(ListSubAccountsRequest, ServerCallContext)

List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful ListAccounts 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 Task<ListSubAccountsResponse> ListSubAccounts(ListSubAccountsRequest request, ServerCallContext context)
Parameters
Type Name Description
ListSubAccountsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListSubAccountsResponse>

The response to send back to the client (wrapped by a task).

UpdateAccount(UpdateAccountRequest, ServerCallContext)

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

Declaration
public virtual Task<Account> UpdateAccount(UpdateAccountRequest request, ServerCallContext context)
Parameters
Type Name Description
UpdateAccountRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<Account>

The response to send back to the client (wrapped by a task).

In this article
Back to top Generated by DocFX