Show / Hide Table of Contents

Class AdRuleService.AdRuleServiceClient

Client for AdRuleService

Inheritance
object
ClientBase
ClientBase<AdRuleService.AdRuleServiceClient>
AdRuleService.AdRuleServiceClient
Inherited Members
ClientBase<AdRuleService.AdRuleServiceClient>.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 AdRuleService.AdRuleServiceClient : ClientBase<AdRuleService.AdRuleServiceClient>

Constructors

AdRuleServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration
protected AdRuleServiceClient()

AdRuleServiceClient(CallInvoker)

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

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

The callInvoker to use to make remote calls.

AdRuleServiceClient(ChannelBase)

Creates a new client for AdRuleService

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

The channel to use to make remote calls.

AdRuleServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

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

The client configuration.

Methods

BatchActivateAdRules(BatchActivateAdRulesRequest, CallOptions)

Activates a list of AdRule objects.

Declaration
public virtual BatchActivateAdRulesResponse BatchActivateAdRules(BatchActivateAdRulesRequest request, CallOptions options)
Parameters
Type Name Description
BatchActivateAdRulesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchActivateAdRulesResponse

The response received from the server.

BatchActivateAdRules(BatchActivateAdRulesRequest, Metadata, DateTime?, CancellationToken)

Activates a list of AdRule objects.

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

The response received from the server.

BatchActivateAdRulesAsync(BatchActivateAdRulesRequest, CallOptions)

Activates a list of AdRule objects.

Declaration
public virtual AsyncUnaryCall<BatchActivateAdRulesResponse> BatchActivateAdRulesAsync(BatchActivateAdRulesRequest request, CallOptions options)
Parameters
Type Name Description
BatchActivateAdRulesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchActivateAdRulesResponse>

The call object.

BatchActivateAdRulesAsync(BatchActivateAdRulesRequest, Metadata, DateTime?, CancellationToken)

Activates a list of AdRule objects.

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

The call object.

BatchCreateAdRules(BatchCreateAdRulesRequest, CallOptions)

Batch creates AdRule objects.

Declaration
public virtual BatchCreateAdRulesResponse BatchCreateAdRules(BatchCreateAdRulesRequest request, CallOptions options)
Parameters
Type Name Description
BatchCreateAdRulesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchCreateAdRulesResponse

The response received from the server.

BatchCreateAdRules(BatchCreateAdRulesRequest, Metadata, DateTime?, CancellationToken)

Batch creates AdRule objects.

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

The response received from the server.

BatchCreateAdRulesAsync(BatchCreateAdRulesRequest, CallOptions)

Batch creates AdRule objects.

Declaration
public virtual AsyncUnaryCall<BatchCreateAdRulesResponse> BatchCreateAdRulesAsync(BatchCreateAdRulesRequest request, CallOptions options)
Parameters
Type Name Description
BatchCreateAdRulesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchCreateAdRulesResponse>

The call object.

BatchCreateAdRulesAsync(BatchCreateAdRulesRequest, Metadata, DateTime?, CancellationToken)

Batch creates AdRule objects.

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

The call object.

BatchDeactivateAdRules(BatchDeactivateAdRulesRequest, CallOptions)

Deactivates a list of AdRule objects.

Declaration
public virtual BatchDeactivateAdRulesResponse BatchDeactivateAdRules(BatchDeactivateAdRulesRequest request, CallOptions options)
Parameters
Type Name Description
BatchDeactivateAdRulesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchDeactivateAdRulesResponse

The response received from the server.

BatchDeactivateAdRules(BatchDeactivateAdRulesRequest, Metadata, DateTime?, CancellationToken)

Deactivates a list of AdRule objects.

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

The response received from the server.

BatchDeactivateAdRulesAsync(BatchDeactivateAdRulesRequest, CallOptions)

Deactivates a list of AdRule objects.

Declaration
public virtual AsyncUnaryCall<BatchDeactivateAdRulesResponse> BatchDeactivateAdRulesAsync(BatchDeactivateAdRulesRequest request, CallOptions options)
Parameters
Type Name Description
BatchDeactivateAdRulesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchDeactivateAdRulesResponse>

The call object.

BatchDeactivateAdRulesAsync(BatchDeactivateAdRulesRequest, Metadata, DateTime?, CancellationToken)

Deactivates a list of AdRule objects.

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

The call object.

BatchDeleteAdRules(BatchDeleteAdRulesRequest, CallOptions)

Deletes a list of AdRule objects.

Declaration
public virtual Empty BatchDeleteAdRules(BatchDeleteAdRulesRequest request, CallOptions options)
Parameters
Type Name Description
BatchDeleteAdRulesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Empty

The response received from the server.

BatchDeleteAdRules(BatchDeleteAdRulesRequest, Metadata, DateTime?, CancellationToken)

Deletes a list of AdRule objects.

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

The response received from the server.

BatchDeleteAdRulesAsync(BatchDeleteAdRulesRequest, CallOptions)

Deletes a list of AdRule objects.

Declaration
public virtual AsyncUnaryCall<Empty> BatchDeleteAdRulesAsync(BatchDeleteAdRulesRequest request, CallOptions options)
Parameters
Type Name Description
BatchDeleteAdRulesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Empty>

The call object.

BatchDeleteAdRulesAsync(BatchDeleteAdRulesRequest, Metadata, DateTime?, CancellationToken)

Deletes a list of AdRule objects.

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

The call object.

BatchUpdateAdRules(BatchUpdateAdRulesRequest, CallOptions)

Batch updates AdRule objects.

Declaration
public virtual BatchUpdateAdRulesResponse BatchUpdateAdRules(BatchUpdateAdRulesRequest request, CallOptions options)
Parameters
Type Name Description
BatchUpdateAdRulesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchUpdateAdRulesResponse

The response received from the server.

BatchUpdateAdRules(BatchUpdateAdRulesRequest, Metadata, DateTime?, CancellationToken)

Batch updates AdRule objects.

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

The response received from the server.

BatchUpdateAdRulesAsync(BatchUpdateAdRulesRequest, CallOptions)

Batch updates AdRule objects.

Declaration
public virtual AsyncUnaryCall<BatchUpdateAdRulesResponse> BatchUpdateAdRulesAsync(BatchUpdateAdRulesRequest request, CallOptions options)
Parameters
Type Name Description
BatchUpdateAdRulesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchUpdateAdRulesResponse>

The call object.

BatchUpdateAdRulesAsync(BatchUpdateAdRulesRequest, Metadata, DateTime?, CancellationToken)

Batch updates AdRule objects.

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

The call object.

CreateAdRule(CreateAdRuleRequest, CallOptions)

Creates a AdRule object.

Declaration
public virtual AdRule CreateAdRule(CreateAdRuleRequest request, CallOptions options)
Parameters
Type Name Description
CreateAdRuleRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AdRule

The response received from the server.

CreateAdRule(CreateAdRuleRequest, Metadata, DateTime?, CancellationToken)

Creates a AdRule object.

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

The response received from the server.

CreateAdRuleAsync(CreateAdRuleRequest, CallOptions)

Creates a AdRule object.

Declaration
public virtual AsyncUnaryCall<AdRule> CreateAdRuleAsync(CreateAdRuleRequest request, CallOptions options)
Parameters
Type Name Description
CreateAdRuleRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<AdRule>

The call object.

CreateAdRuleAsync(CreateAdRuleRequest, Metadata, DateTime?, CancellationToken)

Creates a AdRule object.

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

The call object.

GetAdRule(GetAdRuleRequest, CallOptions)

Retrieves an AdRule object.

Declaration
public virtual AdRule GetAdRule(GetAdRuleRequest request, CallOptions options)
Parameters
Type Name Description
GetAdRuleRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AdRule

The response received from the server.

GetAdRule(GetAdRuleRequest, Metadata, DateTime?, CancellationToken)

Retrieves an AdRule object.

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

The response received from the server.

GetAdRuleAsync(GetAdRuleRequest, CallOptions)

Retrieves an AdRule object.

Declaration
public virtual AsyncUnaryCall<AdRule> GetAdRuleAsync(GetAdRuleRequest request, CallOptions options)
Parameters
Type Name Description
GetAdRuleRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<AdRule>

The call object.

GetAdRuleAsync(GetAdRuleRequest, Metadata, DateTime?, CancellationToken)

Retrieves an AdRule object.

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

The call object.

ListAdRules(ListAdRulesRequest, CallOptions)

Lists AdRule objects.

Declaration
public virtual ListAdRulesResponse ListAdRules(ListAdRulesRequest request, CallOptions options)
Parameters
Type Name Description
ListAdRulesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
ListAdRulesResponse

The response received from the server.

ListAdRules(ListAdRulesRequest, Metadata, DateTime?, CancellationToken)

Lists AdRule objects.

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

The response received from the server.

ListAdRulesAsync(ListAdRulesRequest, CallOptions)

Lists AdRule objects.

Declaration
public virtual AsyncUnaryCall<ListAdRulesResponse> ListAdRulesAsync(ListAdRulesRequest request, CallOptions options)
Parameters
Type Name Description
ListAdRulesRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListAdRulesResponse>

The call object.

ListAdRulesAsync(ListAdRulesRequest, Metadata, DateTime?, CancellationToken)

Lists AdRule objects.

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

The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

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

UpdateAdRule(UpdateAdRuleRequest, CallOptions)

Updates a AdRule object.

Declaration
public virtual AdRule UpdateAdRule(UpdateAdRuleRequest request, CallOptions options)
Parameters
Type Name Description
UpdateAdRuleRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AdRule

The response received from the server.

UpdateAdRule(UpdateAdRuleRequest, Metadata, DateTime?, CancellationToken)

Updates a AdRule object.

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

The response received from the server.

UpdateAdRuleAsync(UpdateAdRuleRequest, CallOptions)

Updates a AdRule object.

Declaration
public virtual AsyncUnaryCall<AdRule> UpdateAdRuleAsync(UpdateAdRuleRequest request, CallOptions options)
Parameters
Type Name Description
UpdateAdRuleRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<AdRule>

The call object.

UpdateAdRuleAsync(UpdateAdRuleRequest, Metadata, DateTime?, CancellationToken)

Updates a AdRule object.

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

The call object.

In this article
Back to top Generated by DocFX