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 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).
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> |