Show / Hide Table of Contents

Class LabelService.LabelServiceClient

Client for LabelService

Inheritance
object
ClientBase
ClientBase<LabelService.LabelServiceClient>
LabelService.LabelServiceClient
Inherited Members
ClientBase<LabelService.LabelServiceClient>.WithHost(string)
ClientBase.CallInvoker
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public class LabelService.LabelServiceClient : ClientBase<LabelService.LabelServiceClient>

Constructors

LabelServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration
protected LabelServiceClient()

LabelServiceClient(CallInvoker)

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

Declaration
public LabelServiceClient(CallInvoker callInvoker)
Parameters
Type Name Description
CallInvoker callInvoker

The callInvoker to use to make remote calls.

LabelServiceClient(ChannelBase)

Creates a new client for LabelService

Declaration
public LabelServiceClient(ChannelBase channel)
Parameters
Type Name Description
ChannelBase channel

The channel to use to make remote calls.

LabelServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration
protected LabelServiceClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration

The client configuration.

Methods

BatchActivateLabels(BatchActivateLabelsRequest, CallOptions)

API to activate Label objects.

Declaration
public virtual BatchActivateLabelsResponse BatchActivateLabels(BatchActivateLabelsRequest request, CallOptions options)
Parameters
Type Name Description
BatchActivateLabelsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchActivateLabelsResponse

The response received from the server.

BatchActivateLabels(BatchActivateLabelsRequest, Metadata, DateTime?, CancellationToken)

API to activate Label objects.

Declaration
public virtual BatchActivateLabelsResponse BatchActivateLabels(BatchActivateLabelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchActivateLabelsRequest 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
BatchActivateLabelsResponse

The response received from the server.

BatchActivateLabelsAsync(BatchActivateLabelsRequest, CallOptions)

API to activate Label objects.

Declaration
public virtual AsyncUnaryCall<BatchActivateLabelsResponse> BatchActivateLabelsAsync(BatchActivateLabelsRequest request, CallOptions options)
Parameters
Type Name Description
BatchActivateLabelsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchActivateLabelsResponse>

The call object.

BatchActivateLabelsAsync(BatchActivateLabelsRequest, Metadata, DateTime?, CancellationToken)

API to activate Label objects.

Declaration
public virtual AsyncUnaryCall<BatchActivateLabelsResponse> BatchActivateLabelsAsync(BatchActivateLabelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchActivateLabelsRequest 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<BatchActivateLabelsResponse>

The call object.

BatchCreateLabels(BatchCreateLabelsRequest, CallOptions)

API to batch create Label objects.

Declaration
public virtual BatchCreateLabelsResponse BatchCreateLabels(BatchCreateLabelsRequest request, CallOptions options)
Parameters
Type Name Description
BatchCreateLabelsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchCreateLabelsResponse

The response received from the server.

BatchCreateLabels(BatchCreateLabelsRequest, Metadata, DateTime?, CancellationToken)

API to batch create Label objects.

Declaration
public virtual BatchCreateLabelsResponse BatchCreateLabels(BatchCreateLabelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchCreateLabelsRequest 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
BatchCreateLabelsResponse

The response received from the server.

BatchCreateLabelsAsync(BatchCreateLabelsRequest, CallOptions)

API to batch create Label objects.

Declaration
public virtual AsyncUnaryCall<BatchCreateLabelsResponse> BatchCreateLabelsAsync(BatchCreateLabelsRequest request, CallOptions options)
Parameters
Type Name Description
BatchCreateLabelsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchCreateLabelsResponse>

The call object.

BatchCreateLabelsAsync(BatchCreateLabelsRequest, Metadata, DateTime?, CancellationToken)

API to batch create Label objects.

Declaration
public virtual AsyncUnaryCall<BatchCreateLabelsResponse> BatchCreateLabelsAsync(BatchCreateLabelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchCreateLabelsRequest 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<BatchCreateLabelsResponse>

The call object.

BatchDeactivateLabels(BatchDeactivateLabelsRequest, CallOptions)

API to deactivate Label objects.

Declaration
public virtual BatchDeactivateLabelsResponse BatchDeactivateLabels(BatchDeactivateLabelsRequest request, CallOptions options)
Parameters
Type Name Description
BatchDeactivateLabelsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchDeactivateLabelsResponse

The response received from the server.

BatchDeactivateLabels(BatchDeactivateLabelsRequest, Metadata, DateTime?, CancellationToken)

API to deactivate Label objects.

Declaration
public virtual BatchDeactivateLabelsResponse BatchDeactivateLabels(BatchDeactivateLabelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchDeactivateLabelsRequest 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
BatchDeactivateLabelsResponse

The response received from the server.

BatchDeactivateLabelsAsync(BatchDeactivateLabelsRequest, CallOptions)

API to deactivate Label objects.

Declaration
public virtual AsyncUnaryCall<BatchDeactivateLabelsResponse> BatchDeactivateLabelsAsync(BatchDeactivateLabelsRequest request, CallOptions options)
Parameters
Type Name Description
BatchDeactivateLabelsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchDeactivateLabelsResponse>

The call object.

BatchDeactivateLabelsAsync(BatchDeactivateLabelsRequest, Metadata, DateTime?, CancellationToken)

API to deactivate Label objects.

Declaration
public virtual AsyncUnaryCall<BatchDeactivateLabelsResponse> BatchDeactivateLabelsAsync(BatchDeactivateLabelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchDeactivateLabelsRequest 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<BatchDeactivateLabelsResponse>

The call object.

BatchUpdateLabels(BatchUpdateLabelsRequest, CallOptions)

API to batch update Label objects.

Declaration
public virtual BatchUpdateLabelsResponse BatchUpdateLabels(BatchUpdateLabelsRequest request, CallOptions options)
Parameters
Type Name Description
BatchUpdateLabelsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchUpdateLabelsResponse

The response received from the server.

BatchUpdateLabels(BatchUpdateLabelsRequest, Metadata, DateTime?, CancellationToken)

API to batch update Label objects.

Declaration
public virtual BatchUpdateLabelsResponse BatchUpdateLabels(BatchUpdateLabelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchUpdateLabelsRequest 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
BatchUpdateLabelsResponse

The response received from the server.

BatchUpdateLabelsAsync(BatchUpdateLabelsRequest, CallOptions)

API to batch update Label objects.

Declaration
public virtual AsyncUnaryCall<BatchUpdateLabelsResponse> BatchUpdateLabelsAsync(BatchUpdateLabelsRequest request, CallOptions options)
Parameters
Type Name Description
BatchUpdateLabelsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchUpdateLabelsResponse>

The call object.

BatchUpdateLabelsAsync(BatchUpdateLabelsRequest, Metadata, DateTime?, CancellationToken)

API to batch update Label objects.

Declaration
public virtual AsyncUnaryCall<BatchUpdateLabelsResponse> BatchUpdateLabelsAsync(BatchUpdateLabelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BatchUpdateLabelsRequest 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<BatchUpdateLabelsResponse>

The call object.

CreateLabel(CreateLabelRequest, CallOptions)

API to create a Label object.

Declaration
public virtual Label CreateLabel(CreateLabelRequest request, CallOptions options)
Parameters
Type Name Description
CreateLabelRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Label

The response received from the server.

CreateLabel(CreateLabelRequest, Metadata, DateTime?, CancellationToken)

API to create a Label object.

Declaration
public virtual Label CreateLabel(CreateLabelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateLabelRequest 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
Label

The response received from the server.

CreateLabelAsync(CreateLabelRequest, CallOptions)

API to create a Label object.

Declaration
public virtual AsyncUnaryCall<Label> CreateLabelAsync(CreateLabelRequest request, CallOptions options)
Parameters
Type Name Description
CreateLabelRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Label>

The call object.

CreateLabelAsync(CreateLabelRequest, Metadata, DateTime?, CancellationToken)

API to create a Label object.

Declaration
public virtual AsyncUnaryCall<Label> CreateLabelAsync(CreateLabelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateLabelRequest 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<Label>

The call object.

GetLabel(GetLabelRequest, CallOptions)

API to retrieve a Label object.

Declaration
public virtual Label GetLabel(GetLabelRequest request, CallOptions options)
Parameters
Type Name Description
GetLabelRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Label

The response received from the server.

GetLabel(GetLabelRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a Label object.

Declaration
public virtual Label GetLabel(GetLabelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetLabelRequest 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
Label

The response received from the server.

GetLabelAsync(GetLabelRequest, CallOptions)

API to retrieve a Label object.

Declaration
public virtual AsyncUnaryCall<Label> GetLabelAsync(GetLabelRequest request, CallOptions options)
Parameters
Type Name Description
GetLabelRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Label>

The call object.

GetLabelAsync(GetLabelRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a Label object.

Declaration
public virtual AsyncUnaryCall<Label> GetLabelAsync(GetLabelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetLabelRequest 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<Label>

The call object.

ListLabels(ListLabelsRequest, CallOptions)

API to retrieve a list of Label objects.

Declaration
public virtual ListLabelsResponse ListLabels(ListLabelsRequest request, CallOptions options)
Parameters
Type Name Description
ListLabelsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
ListLabelsResponse

The response received from the server.

ListLabels(ListLabelsRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a list of Label objects.

Declaration
public virtual ListLabelsResponse ListLabels(ListLabelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListLabelsRequest 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
ListLabelsResponse

The response received from the server.

ListLabelsAsync(ListLabelsRequest, CallOptions)

API to retrieve a list of Label objects.

Declaration
public virtual AsyncUnaryCall<ListLabelsResponse> ListLabelsAsync(ListLabelsRequest request, CallOptions options)
Parameters
Type Name Description
ListLabelsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListLabelsResponse>

The call object.

ListLabelsAsync(ListLabelsRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a list of Label objects.

Declaration
public virtual AsyncUnaryCall<ListLabelsResponse> ListLabelsAsync(ListLabelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListLabelsRequest 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<ListLabelsResponse>

The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration
protected override LabelService.LabelServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration
Returns
Type Description
LabelService.LabelServiceClient
Overrides
Grpc.Core.ClientBase<Google.Ads.AdManager.V1.LabelService.LabelServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateLabel(UpdateLabelRequest, CallOptions)

API to update a Label object.

Declaration
public virtual Label UpdateLabel(UpdateLabelRequest request, CallOptions options)
Parameters
Type Name Description
UpdateLabelRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Label

The response received from the server.

UpdateLabel(UpdateLabelRequest, Metadata, DateTime?, CancellationToken)

API to update a Label object.

Declaration
public virtual Label UpdateLabel(UpdateLabelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
UpdateLabelRequest 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
Label

The response received from the server.

UpdateLabelAsync(UpdateLabelRequest, CallOptions)

API to update a Label object.

Declaration
public virtual AsyncUnaryCall<Label> UpdateLabelAsync(UpdateLabelRequest request, CallOptions options)
Parameters
Type Name Description
UpdateLabelRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Label>

The call object.

UpdateLabelAsync(UpdateLabelRequest, Metadata, DateTime?, CancellationToken)

API to update a Label object.

Declaration
public virtual AsyncUnaryCall<Label> UpdateLabelAsync(UpdateLabelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
UpdateLabelRequest 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<Label>

The call object.

In this article
Back to top Generated by DocFX