Class HomepageService.HomepageServiceClient

Client for HomepageService

Inheritance

object

ClientBase

ClientBase<HomepageService.HomepageServiceClient>

HomepageService.HomepageServiceClient

Inherited Members

ClientBase<HomepageService.HomepageServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Shopping.Merchant.Accounts.V1

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

Syntax

public class HomepageService.HomepageServiceClient : ClientBase<HomepageService.HomepageServiceClient>

Constructors

HomepageServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected HomepageServiceClient()

HomepageServiceClient(CallInvoker)

Creates a new client for HomepageService that uses a custom CallInvoker.

Declaration

public HomepageServiceClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

HomepageServiceClient(ChannelBase)

Creates a new client for HomepageService

Declaration

public HomepageServiceClient(ChannelBase channel)

Parameters

Type	Name	Description
ChannelBase	channel	The channel to use to make remote calls.

HomepageServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected HomepageServiceClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

ClaimHomepage(ClaimHomepageRequest, CallOptions)

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 Homepage ClaimHomepage(ClaimHomepageRequest request, CallOptions options)

Parameters

Type	Name	Description
ClaimHomepageRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Homepage	The response received from the server.

ClaimHomepage(ClaimHomepageRequest, Metadata, DateTime?, CancellationToken)

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 Homepage ClaimHomepage(ClaimHomepageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ClaimHomepageRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Homepage	The response received from the server.

ClaimHomepageAsync(ClaimHomepageRequest, CallOptions)

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 AsyncUnaryCall<Homepage> ClaimHomepageAsync(ClaimHomepageRequest request, CallOptions options)

Parameters

Type	Name	Description
ClaimHomepageRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Homepage>	The call object.

ClaimHomepageAsync(ClaimHomepageRequest, Metadata, DateTime?, CancellationToken)

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 AsyncUnaryCall<Homepage> ClaimHomepageAsync(ClaimHomepageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ClaimHomepageRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Homepage>	The call object.

GetHomepage(GetHomepageRequest, CallOptions)

Retrieves a store's homepage.

Declaration

public virtual Homepage GetHomepage(GetHomepageRequest request, CallOptions options)

Parameters

Type	Name	Description
GetHomepageRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Homepage	The response received from the server.

GetHomepage(GetHomepageRequest, Metadata, DateTime?, CancellationToken)

Retrieves a store's homepage.

Declaration

public virtual Homepage GetHomepage(GetHomepageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetHomepageRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Homepage	The response received from the server.

GetHomepageAsync(GetHomepageRequest, CallOptions)

Retrieves a store's homepage.

Declaration

public virtual AsyncUnaryCall<Homepage> GetHomepageAsync(GetHomepageRequest request, CallOptions options)

Parameters

Type	Name	Description
GetHomepageRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Homepage>	The call object.

GetHomepageAsync(GetHomepageRequest, Metadata, DateTime?, CancellationToken)

Retrieves a store's homepage.

Declaration

public virtual AsyncUnaryCall<Homepage> GetHomepageAsync(GetHomepageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetHomepageRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Homepage>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override HomepageService.HomepageServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
HomepageService.HomepageServiceClient

Overrides

Grpc.Core.ClientBase<Google.Shopping.Merchant.Accounts.V1.HomepageService.HomepageServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UnclaimHomepage(UnclaimHomepageRequest, CallOptions)

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

Declaration

public virtual Homepage UnclaimHomepage(UnclaimHomepageRequest request, CallOptions options)

Parameters

Type	Name	Description
UnclaimHomepageRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Homepage	The response received from the server.

UnclaimHomepage(UnclaimHomepageRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual Homepage UnclaimHomepage(UnclaimHomepageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UnclaimHomepageRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Homepage	The response received from the server.

UnclaimHomepageAsync(UnclaimHomepageRequest, CallOptions)

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

Declaration

public virtual AsyncUnaryCall<Homepage> UnclaimHomepageAsync(UnclaimHomepageRequest request, CallOptions options)

Parameters

Type	Name	Description
UnclaimHomepageRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Homepage>	The call object.

UnclaimHomepageAsync(UnclaimHomepageRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual AsyncUnaryCall<Homepage> UnclaimHomepageAsync(UnclaimHomepageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UnclaimHomepageRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Homepage>	The call object.

UpdateHomepage(UpdateHomepageRequest, CallOptions)

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

Declaration

public virtual Homepage UpdateHomepage(UpdateHomepageRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateHomepageRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Homepage	The response received from the server.

UpdateHomepage(UpdateHomepageRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual Homepage UpdateHomepage(UpdateHomepageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateHomepageRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Homepage	The response received from the server.

UpdateHomepageAsync(UpdateHomepageRequest, CallOptions)

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

Declaration

public virtual AsyncUnaryCall<Homepage> UpdateHomepageAsync(UpdateHomepageRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateHomepageRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Homepage>	The call object.

UpdateHomepageAsync(UpdateHomepageRequest, Metadata, DateTime?, CancellationToken)

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

Declaration

public virtual AsyncUnaryCall<Homepage> UpdateHomepageAsync(UpdateHomepageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateHomepageRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Homepage>	The call object.