Class ProgramsServiceClientImpl

ProgramsService client wrapper implementation, for convenient use.

Inheritance
object
ProgramsServiceClient
ProgramsServiceClientImpl
Inherited Members
Namespace: Google.Shopping.Merchant.Accounts.V1Beta
Assembly: Google.Shopping.Merchant.Accounts.V1Beta.dll
Syntax
public sealed class ProgramsServiceClientImpl : ProgramsServiceClient
Remarks

Service for program management.

Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the Free product listings program, which enables products from a merchant's store to be shown across Google for free.

This service exposes methods to retrieve a merchant's participation in all available programs, in addition to methods for explicitly enabling or disabling participation in each program.

Constructors

ProgramsServiceClientImpl(ProgramsServiceClient, ProgramsServiceSettings, ILogger)

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

Declaration
public ProgramsServiceClientImpl(ProgramsService.ProgramsServiceClient grpcClient, ProgramsServiceSettings settings, ILogger logger)
Parameters
Type Name Description
ProgramsService.ProgramsServiceClient grpcClient

The underlying gRPC client.
ProgramsServiceSettings settings

The base ProgramsServiceSettings used within this client.
ILogger logger

Optional ILogger to use within this client.

Properties

GrpcClient

The underlying gRPC ProgramsService client

Declaration
public override ProgramsService.ProgramsServiceClient GrpcClient { get; }
Property Value
Type Description
ProgramsService.ProgramsServiceClient
Overrides

Methods

DisableProgram(DisableProgramRequest, CallSettings)

Disable participation in the specified program for the account. Executing this method requires admin access.

Declaration
public override Program DisableProgram(DisableProgramRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DisableProgramRequest 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
Program

The RPC response.
Overrides

DisableProgramAsync(DisableProgramRequest, CallSettings)

Disable participation in the specified program for the account. Executing this method requires admin access.

Declaration
public override Task<Program> DisableProgramAsync(DisableProgramRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DisableProgramRequest 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<Program>

A Task containing the RPC response.
Overrides

EnableProgram(EnableProgramRequest, CallSettings)

Enable participation in the specified program for the account. Executing this method requires admin access.

Declaration
public override Program EnableProgram(EnableProgramRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
EnableProgramRequest 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
Program

The RPC response.
Overrides

EnableProgramAsync(EnableProgramRequest, CallSettings)

Enable participation in the specified program for the account. Executing this method requires admin access.

Declaration
public override Task<Program> EnableProgramAsync(EnableProgramRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
EnableProgramRequest 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<Program>

A Task containing the RPC response.
Overrides

GetProgram(GetProgramRequest, CallSettings)

Retrieves the specified program for the account.

Declaration
public override Program GetProgram(GetProgramRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetProgramRequest 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
Program

The RPC response.
Overrides

GetProgramAsync(GetProgramRequest, CallSettings)

Retrieves the specified program for the account.

Declaration
public override Task<Program> GetProgramAsync(GetProgramRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetProgramRequest 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<Program>

A Task containing the RPC response.
Overrides

ListPrograms(ListProgramsRequest, CallSettings)

Retrieves all programs for the account.

Declaration
public override PagedEnumerable<ListProgramsResponse, Program> ListPrograms(ListProgramsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListProgramsRequest 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
PagedEnumerable<ListProgramsResponse, Program>

A pageable sequence of Program resources.
Overrides

ListProgramsAsync(ListProgramsRequest, CallSettings)

Retrieves all programs for the account.

Declaration
public override PagedAsyncEnumerable<ListProgramsResponse, Program> ListProgramsAsync(ListProgramsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListProgramsRequest 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
PagedAsyncEnumerable<ListProgramsResponse, Program>

A pageable asynchronous sequence of Program resources.
Overrides