Interface HomepageServiceGrpc.AsyncService (0.8.0) 

public static interface HomepageServiceGrpc.AsyncService

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

Methods

claimHomepage(ClaimHomepageRequest request, StreamObserver<Homepage> responseObserver)

public default void claimHomepage(ClaimHomepageRequest request, StreamObserver<Homepage> responseObserver)

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).
Parameters
Name Description
request ClaimHomepageRequest
responseObserver io.grpc.stub.StreamObserver<Homepage>

getHomepage(GetHomepageRequest request, StreamObserver<Homepage> responseObserver)

public default void getHomepage(GetHomepageRequest request, StreamObserver<Homepage> responseObserver)

Retrieves a store's homepage.

Parameters
Name Description
request GetHomepageRequest
responseObserver io.grpc.stub.StreamObserver<Homepage>

unclaimHomepage(UnclaimHomepageRequest request, StreamObserver<Homepage> responseObserver)

public default void unclaimHomepage(UnclaimHomepageRequest request, StreamObserver<Homepage> responseObserver)

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

Parameters
Name Description
request UnclaimHomepageRequest
responseObserver io.grpc.stub.StreamObserver<Homepage>

updateHomepage(UpdateHomepageRequest request, StreamObserver<Homepage> responseObserver)

public default void updateHomepage(UpdateHomepageRequest request, StreamObserver<Homepage> responseObserver)

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

Parameters
Name Description
request UpdateHomepageRequest
responseObserver io.grpc.stub.StreamObserver<Homepage>