Class CustomFieldService.CustomFieldServiceClient

Client for CustomFieldService

Inheritance

object

ClientBase

ClientBase<CustomFieldService.CustomFieldServiceClient>

CustomFieldService.CustomFieldServiceClient

Inherited Members

ClientBase<CustomFieldService.CustomFieldServiceClient>.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 CustomFieldService.CustomFieldServiceClient : ClientBase<CustomFieldService.CustomFieldServiceClient>

Constructors

CustomFieldServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected CustomFieldServiceClient()

CustomFieldServiceClient(CallInvoker)

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

Declaration

public CustomFieldServiceClient(CallInvoker callInvoker)

Parameters

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

CustomFieldServiceClient(ChannelBase)

Creates a new client for CustomFieldService

Declaration

public CustomFieldServiceClient(ChannelBase channel)

Parameters

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

CustomFieldServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected CustomFieldServiceClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

BatchActivateCustomFields(BatchActivateCustomFieldsRequest, CallOptions)

Activates a list of CustomField objects.

Declaration

public virtual BatchActivateCustomFieldsResponse BatchActivateCustomFields(BatchActivateCustomFieldsRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
BatchActivateCustomFieldsResponse	The response received from the server.

BatchActivateCustomFields(BatchActivateCustomFieldsRequest, Metadata, DateTime?, CancellationToken)

Activates a list of CustomField objects.

Declaration

public virtual BatchActivateCustomFieldsResponse BatchActivateCustomFields(BatchActivateCustomFieldsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchActivateCustomFieldsRequest	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
BatchActivateCustomFieldsResponse	The response received from the server.

BatchActivateCustomFieldsAsync(BatchActivateCustomFieldsRequest, CallOptions)

Activates a list of CustomField objects.

Declaration

public virtual AsyncUnaryCall<BatchActivateCustomFieldsResponse> BatchActivateCustomFieldsAsync(BatchActivateCustomFieldsRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<BatchActivateCustomFieldsResponse>	The call object.

BatchActivateCustomFieldsAsync(BatchActivateCustomFieldsRequest, Metadata, DateTime?, CancellationToken)

Activates a list of CustomField objects.

Declaration

public virtual AsyncUnaryCall<BatchActivateCustomFieldsResponse> BatchActivateCustomFieldsAsync(BatchActivateCustomFieldsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchActivateCustomFieldsRequest	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<BatchActivateCustomFieldsResponse>	The call object.

BatchCreateCustomFields(BatchCreateCustomFieldsRequest, CallOptions)

API to batch create CustomField objects.

Declaration

public virtual BatchCreateCustomFieldsResponse BatchCreateCustomFields(BatchCreateCustomFieldsRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
BatchCreateCustomFieldsResponse	The response received from the server.

BatchCreateCustomFields(BatchCreateCustomFieldsRequest, Metadata, DateTime?, CancellationToken)

API to batch create CustomField objects.

Declaration

public virtual BatchCreateCustomFieldsResponse BatchCreateCustomFields(BatchCreateCustomFieldsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchCreateCustomFieldsRequest	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
BatchCreateCustomFieldsResponse	The response received from the server.

BatchCreateCustomFieldsAsync(BatchCreateCustomFieldsRequest, CallOptions)

API to batch create CustomField objects.

Declaration

public virtual AsyncUnaryCall<BatchCreateCustomFieldsResponse> BatchCreateCustomFieldsAsync(BatchCreateCustomFieldsRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<BatchCreateCustomFieldsResponse>	The call object.

BatchCreateCustomFieldsAsync(BatchCreateCustomFieldsRequest, Metadata, DateTime?, CancellationToken)

API to batch create CustomField objects.

Declaration

public virtual AsyncUnaryCall<BatchCreateCustomFieldsResponse> BatchCreateCustomFieldsAsync(BatchCreateCustomFieldsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchCreateCustomFieldsRequest	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<BatchCreateCustomFieldsResponse>	The call object.

BatchDeactivateCustomFields(BatchDeactivateCustomFieldsRequest, CallOptions)

Deactivates a list of CustomField objects.

Declaration

public virtual BatchDeactivateCustomFieldsResponse BatchDeactivateCustomFields(BatchDeactivateCustomFieldsRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
BatchDeactivateCustomFieldsResponse	The response received from the server.

BatchDeactivateCustomFields(BatchDeactivateCustomFieldsRequest, Metadata, DateTime?, CancellationToken)

Deactivates a list of CustomField objects.

Declaration

public virtual BatchDeactivateCustomFieldsResponse BatchDeactivateCustomFields(BatchDeactivateCustomFieldsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchDeactivateCustomFieldsRequest	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
BatchDeactivateCustomFieldsResponse	The response received from the server.

BatchDeactivateCustomFieldsAsync(BatchDeactivateCustomFieldsRequest, CallOptions)

Deactivates a list of CustomField objects.

Declaration

public virtual AsyncUnaryCall<BatchDeactivateCustomFieldsResponse> BatchDeactivateCustomFieldsAsync(BatchDeactivateCustomFieldsRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<BatchDeactivateCustomFieldsResponse>	The call object.

BatchDeactivateCustomFieldsAsync(BatchDeactivateCustomFieldsRequest, Metadata, DateTime?, CancellationToken)

Deactivates a list of CustomField objects.

Declaration

public virtual AsyncUnaryCall<BatchDeactivateCustomFieldsResponse> BatchDeactivateCustomFieldsAsync(BatchDeactivateCustomFieldsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchDeactivateCustomFieldsRequest	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<BatchDeactivateCustomFieldsResponse>	The call object.

BatchUpdateCustomFields(BatchUpdateCustomFieldsRequest, CallOptions)

API to batch update CustomField objects.

Declaration

public virtual BatchUpdateCustomFieldsResponse BatchUpdateCustomFields(BatchUpdateCustomFieldsRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
BatchUpdateCustomFieldsResponse	The response received from the server.

BatchUpdateCustomFields(BatchUpdateCustomFieldsRequest, Metadata, DateTime?, CancellationToken)

API to batch update CustomField objects.

Declaration

public virtual BatchUpdateCustomFieldsResponse BatchUpdateCustomFields(BatchUpdateCustomFieldsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchUpdateCustomFieldsRequest	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
BatchUpdateCustomFieldsResponse	The response received from the server.

BatchUpdateCustomFieldsAsync(BatchUpdateCustomFieldsRequest, CallOptions)

API to batch update CustomField objects.

Declaration

public virtual AsyncUnaryCall<BatchUpdateCustomFieldsResponse> BatchUpdateCustomFieldsAsync(BatchUpdateCustomFieldsRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<BatchUpdateCustomFieldsResponse>	The call object.

BatchUpdateCustomFieldsAsync(BatchUpdateCustomFieldsRequest, Metadata, DateTime?, CancellationToken)

API to batch update CustomField objects.

Declaration

public virtual AsyncUnaryCall<BatchUpdateCustomFieldsResponse> BatchUpdateCustomFieldsAsync(BatchUpdateCustomFieldsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchUpdateCustomFieldsRequest	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<BatchUpdateCustomFieldsResponse>	The call object.

CreateCustomField(CreateCustomFieldRequest, CallOptions)

API to create a CustomField object.

Declaration

public virtual CustomField CreateCustomField(CreateCustomFieldRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
CustomField	The response received from the server.

CreateCustomField(CreateCustomFieldRequest, Metadata, DateTime?, CancellationToken)

API to create a CustomField object.

Declaration

public virtual CustomField CreateCustomField(CreateCustomFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateCustomFieldRequest	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
CustomField	The response received from the server.

CreateCustomFieldAsync(CreateCustomFieldRequest, CallOptions)

API to create a CustomField object.

Declaration

public virtual AsyncUnaryCall<CustomField> CreateCustomFieldAsync(CreateCustomFieldRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<CustomField>	The call object.

CreateCustomFieldAsync(CreateCustomFieldRequest, Metadata, DateTime?, CancellationToken)

API to create a CustomField object.

Declaration

public virtual AsyncUnaryCall<CustomField> CreateCustomFieldAsync(CreateCustomFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateCustomFieldRequest	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<CustomField>	The call object.

GetCustomField(GetCustomFieldRequest, CallOptions)

API to retrieve a CustomField object.

Declaration

public virtual CustomField GetCustomField(GetCustomFieldRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
CustomField	The response received from the server.

GetCustomField(GetCustomFieldRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a CustomField object.

Declaration

public virtual CustomField GetCustomField(GetCustomFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetCustomFieldRequest	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
CustomField	The response received from the server.

GetCustomFieldAsync(GetCustomFieldRequest, CallOptions)

API to retrieve a CustomField object.

Declaration

public virtual AsyncUnaryCall<CustomField> GetCustomFieldAsync(GetCustomFieldRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<CustomField>	The call object.

GetCustomFieldAsync(GetCustomFieldRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a CustomField object.

Declaration

public virtual AsyncUnaryCall<CustomField> GetCustomFieldAsync(GetCustomFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetCustomFieldRequest	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<CustomField>	The call object.

ListCustomFields(ListCustomFieldsRequest, CallOptions)

API to retrieve a list of CustomField objects.

Declaration

public virtual ListCustomFieldsResponse ListCustomFields(ListCustomFieldsRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
ListCustomFieldsResponse	The response received from the server.

ListCustomFields(ListCustomFieldsRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a list of CustomField objects.

Declaration

public virtual ListCustomFieldsResponse ListCustomFields(ListCustomFieldsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListCustomFieldsRequest	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
ListCustomFieldsResponse	The response received from the server.

ListCustomFieldsAsync(ListCustomFieldsRequest, CallOptions)

API to retrieve a list of CustomField objects.

Declaration

public virtual AsyncUnaryCall<ListCustomFieldsResponse> ListCustomFieldsAsync(ListCustomFieldsRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<ListCustomFieldsResponse>	The call object.

ListCustomFieldsAsync(ListCustomFieldsRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a list of CustomField objects.

Declaration

public virtual AsyncUnaryCall<ListCustomFieldsResponse> ListCustomFieldsAsync(ListCustomFieldsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListCustomFieldsRequest	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<ListCustomFieldsResponse>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override CustomFieldService.CustomFieldServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
CustomFieldService.CustomFieldServiceClient

Overrides

Grpc.Core.ClientBase<Google.Ads.AdManager.V1.CustomFieldService.CustomFieldServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateCustomField(UpdateCustomFieldRequest, CallOptions)

API to update a CustomField object.

Declaration

public virtual CustomField UpdateCustomField(UpdateCustomFieldRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
CustomField	The response received from the server.

UpdateCustomField(UpdateCustomFieldRequest, Metadata, DateTime?, CancellationToken)

API to update a CustomField object.

Declaration

public virtual CustomField UpdateCustomField(UpdateCustomFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateCustomFieldRequest	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
CustomField	The response received from the server.

UpdateCustomFieldAsync(UpdateCustomFieldRequest, CallOptions)

API to update a CustomField object.

Declaration

public virtual AsyncUnaryCall<CustomField> UpdateCustomFieldAsync(UpdateCustomFieldRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<CustomField>	The call object.

UpdateCustomFieldAsync(UpdateCustomFieldRequest, Metadata, DateTime?, CancellationToken)

API to update a CustomField object.

Declaration

public virtual AsyncUnaryCall<CustomField> UpdateCustomFieldAsync(UpdateCustomFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateCustomFieldRequest	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<CustomField>	The call object.