Class HomepageServiceGrpc.HomepageServiceFutureStub (0.26.0) 

public static final class HomepageServiceGrpc.HomepageServiceFutureStub extends AbstractFutureStub<HomepageServiceGrpc.HomepageServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service HomepageService.

Service to support an API for a store's homepage.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > HomepageServiceGrpc.HomepageServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected HomepageServiceGrpc.HomepageServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
HomepageServiceGrpc.HomepageServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

claimHomepage(ClaimHomepageRequest request)

public ListenableFuture<Homepage> claimHomepage(ClaimHomepageRequest request)

Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the merchant 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 will be returned:

  • PERMISSION_DENIED: user doesn't have the necessary permissions on this MC account;
  • FAILED_PRECONDITION:
    • The account is not a Merchant Center account;
    • MC account doesn't have a homepage;
    • claiming failed (in this case the error message will contain more details).
Parameter
Name Description
request ClaimHomepageRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Homepage>

getHomepage(GetHomepageRequest request)

public ListenableFuture<Homepage> getHomepage(GetHomepageRequest request)

Retrieves a store's homepage.

Parameter
Name Description
request GetHomepageRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Homepage>

unclaimHomepage(UnclaimHomepageRequest request)

public ListenableFuture<Homepage> unclaimHomepage(UnclaimHomepageRequest request)

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

Parameter
Name Description
request UnclaimHomepageRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Homepage>

updateHomepage(UpdateHomepageRequest request)

public ListenableFuture<Homepage> updateHomepage(UpdateHomepageRequest request)

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

Parameter
Name Description
request UpdateHomepageRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Homepage>