Class HomepageService.HomepageServiceBase

Base class for server-side implementations of HomepageService

Inheritance

object

HomepageService.HomepageServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Shopping.Merchant.Accounts.V1

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

Syntax

[BindServiceMethod(typeof(HomepageService), "BindService")]
public abstract class HomepageService.HomepageServiceBase

Methods

ClaimHomepage(ClaimHomepageRequest, ServerCallContext)

Claims a store's homepage. Executing this method requires admin access.

If the homepage is already claimed, this will recheck the verification (unless the business is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim.

In case of failure, a canonical error message is returned:

• PERMISSION_DENIED: User doesn't have the necessary permissions on this Merchant Center account.

• FAILED_PRECONDITION:

  • The account is not a Merchant Center account.

  • Merchant Center account doesn't have a homepage.

  • Claiming failed (in this case the error message contains more details).

Declaration

public virtual Task<Homepage> ClaimHomepage(ClaimHomepageRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ClaimHomepageRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Homepage>	The response to send back to the client (wrapped by a task).

GetHomepage(GetHomepageRequest, ServerCallContext)

Retrieves a store's homepage.

Declaration

public virtual Task<Homepage> GetHomepage(GetHomepageRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetHomepageRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Homepage>	The response to send back to the client (wrapped by a task).

UnclaimHomepage(UnclaimHomepageRequest, ServerCallContext)

Unclaims a store's homepage. Executing this method requires admin access.

Declaration

public virtual Task<Homepage> UnclaimHomepage(UnclaimHomepageRequest request, ServerCallContext context)

Parameters

Type	Name	Description
UnclaimHomepageRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Homepage>	The response to send back to the client (wrapped by a task).

UpdateHomepage(UpdateHomepageRequest, ServerCallContext)

Updates a store's homepage. Executing this method requires admin access.

Declaration

public virtual Task<Homepage> UpdateHomepage(UpdateHomepageRequest request, ServerCallContext context)

Parameters

Type	Name	Description
UpdateHomepageRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Homepage>	The response to send back to the client (wrapped by a task).