Class HomepageServiceClientImpl

HomepageService client wrapper implementation, for convenient use.

Inheritance

object

HomepageServiceClient

HomepageServiceClientImpl

Inherited Members

HomepageServiceClient.DefaultEndpoint

HomepageServiceClient.DefaultScopes

HomepageServiceClient.ServiceMetadata

HomepageServiceClient.CreateAsync(CancellationToken)

HomepageServiceClient.Create()

HomepageServiceClient.ShutdownDefaultChannelsAsync()

HomepageServiceClient.GetHomepageAsync(GetHomepageRequest, CancellationToken)

HomepageServiceClient.GetHomepage(string, CallSettings)

HomepageServiceClient.GetHomepageAsync(string, CallSettings)

HomepageServiceClient.GetHomepageAsync(string, CancellationToken)

HomepageServiceClient.GetHomepage(HomepageName, CallSettings)

HomepageServiceClient.GetHomepageAsync(HomepageName, CallSettings)

HomepageServiceClient.GetHomepageAsync(HomepageName, CancellationToken)

HomepageServiceClient.UpdateHomepageAsync(UpdateHomepageRequest, CancellationToken)

HomepageServiceClient.UpdateHomepage(Homepage, FieldMask, CallSettings)

HomepageServiceClient.UpdateHomepageAsync(Homepage, FieldMask, CallSettings)

HomepageServiceClient.UpdateHomepageAsync(Homepage, FieldMask, CancellationToken)

HomepageServiceClient.ClaimHomepageAsync(ClaimHomepageRequest, CancellationToken)

HomepageServiceClient.UnclaimHomepageAsync(UnclaimHomepageRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Shopping.Merchant.Accounts.V1

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

Syntax

public sealed class HomepageServiceClientImpl : HomepageServiceClient

Remarks

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

Constructors

HomepageServiceClientImpl(HomepageServiceClient, HomepageServiceSettings, ILogger)

Constructs a client wrapper for the HomepageService service, with the specified gRPC client and settings.

Declaration

public HomepageServiceClientImpl(HomepageService.HomepageServiceClient grpcClient, HomepageServiceSettings settings, ILogger logger)

Parameters

Type	Name	Description
HomepageService.HomepageServiceClient	grpcClient	The underlying gRPC client.
HomepageServiceSettings	settings	The base HomepageServiceSettings used within this client.
ILogger	logger	Optional ILogger to use within this client.

Properties

GrpcClient

The underlying gRPC HomepageService client

Declaration

public override HomepageService.HomepageServiceClient GrpcClient { get; }

Property Value

Type	Description
HomepageService.HomepageServiceClient

Overrides

HomepageServiceClient.GrpcClient

Methods

ClaimHomepage(ClaimHomepageRequest, CallSettings)

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 override Homepage ClaimHomepage(ClaimHomepageRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ClaimHomepageRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Homepage	The RPC response.

Overrides

HomepageServiceClient.ClaimHomepage(ClaimHomepageRequest, CallSettings)

ClaimHomepageAsync(ClaimHomepageRequest, CallSettings)

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 override Task<Homepage> ClaimHomepageAsync(ClaimHomepageRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ClaimHomepageRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Homepage>	A Task containing the RPC response.

Overrides

HomepageServiceClient.ClaimHomepageAsync(ClaimHomepageRequest, CallSettings)

GetHomepage(GetHomepageRequest, CallSettings)

Retrieves a store's homepage.

Declaration

public override Homepage GetHomepage(GetHomepageRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetHomepageRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Homepage	The RPC response.

Overrides

HomepageServiceClient.GetHomepage(GetHomepageRequest, CallSettings)

GetHomepageAsync(GetHomepageRequest, CallSettings)

Retrieves a store's homepage.

Declaration

public override Task<Homepage> GetHomepageAsync(GetHomepageRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetHomepageRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Homepage>	A Task containing the RPC response.

Overrides

HomepageServiceClient.GetHomepageAsync(GetHomepageRequest, CallSettings)

UnclaimHomepage(UnclaimHomepageRequest, CallSettings)

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

Declaration

public override Homepage UnclaimHomepage(UnclaimHomepageRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UnclaimHomepageRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Homepage	The RPC response.

Overrides

HomepageServiceClient.UnclaimHomepage(UnclaimHomepageRequest, CallSettings)

UnclaimHomepageAsync(UnclaimHomepageRequest, CallSettings)

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

Declaration

public override Task<Homepage> UnclaimHomepageAsync(UnclaimHomepageRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UnclaimHomepageRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Homepage>	A Task containing the RPC response.

Overrides

HomepageServiceClient.UnclaimHomepageAsync(UnclaimHomepageRequest, CallSettings)

UpdateHomepage(UpdateHomepageRequest, CallSettings)

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

Declaration

public override Homepage UpdateHomepage(UpdateHomepageRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UpdateHomepageRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Homepage	The RPC response.

Overrides

HomepageServiceClient.UpdateHomepage(UpdateHomepageRequest, CallSettings)

UpdateHomepageAsync(UpdateHomepageRequest, CallSettings)

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

Declaration

public override Task<Homepage> UpdateHomepageAsync(UpdateHomepageRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UpdateHomepageRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<Homepage>	A Task containing the RPC response.

Overrides

HomepageServiceClient.UpdateHomepageAsync(UpdateHomepageRequest, CallSettings)