Show / Hide Table of Contents

Class PlacementService.PlacementServiceClient

Client for PlacementService

Inheritance
object
ClientBase
ClientBase<PlacementService.PlacementServiceClient>
PlacementService.PlacementServiceClient
Inherited Members
ClientBase<PlacementService.PlacementServiceClient>.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 PlacementService.PlacementServiceClient : ClientBase<PlacementService.PlacementServiceClient>

Constructors

PlacementServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration
protected PlacementServiceClient()

PlacementServiceClient(CallInvoker)

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

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

The callInvoker to use to make remote calls.

PlacementServiceClient(ChannelBase)

Creates a new client for PlacementService

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

The channel to use to make remote calls.

PlacementServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

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

The client configuration.

Methods

BatchActivatePlacements(BatchActivatePlacementsRequest, CallOptions)

Activates a list of Placement objects.

Declaration
public virtual BatchActivatePlacementsResponse BatchActivatePlacements(BatchActivatePlacementsRequest request, CallOptions options)
Parameters
Type Name Description
BatchActivatePlacementsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchActivatePlacementsResponse

The response received from the server.

BatchActivatePlacements(BatchActivatePlacementsRequest, Metadata, DateTime?, CancellationToken)

Activates a list of Placement objects.

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

The response received from the server.

BatchActivatePlacementsAsync(BatchActivatePlacementsRequest, CallOptions)

Activates a list of Placement objects.

Declaration
public virtual AsyncUnaryCall<BatchActivatePlacementsResponse> BatchActivatePlacementsAsync(BatchActivatePlacementsRequest request, CallOptions options)
Parameters
Type Name Description
BatchActivatePlacementsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchActivatePlacementsResponse>

The call object.

BatchActivatePlacementsAsync(BatchActivatePlacementsRequest, Metadata, DateTime?, CancellationToken)

Activates a list of Placement objects.

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

The call object.

BatchArchivePlacements(BatchArchivePlacementsRequest, CallOptions)

Archives a list of Placement objects.

Declaration
public virtual BatchArchivePlacementsResponse BatchArchivePlacements(BatchArchivePlacementsRequest request, CallOptions options)
Parameters
Type Name Description
BatchArchivePlacementsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchArchivePlacementsResponse

The response received from the server.

BatchArchivePlacements(BatchArchivePlacementsRequest, Metadata, DateTime?, CancellationToken)

Archives a list of Placement objects.

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

The response received from the server.

BatchArchivePlacementsAsync(BatchArchivePlacementsRequest, CallOptions)

Archives a list of Placement objects.

Declaration
public virtual AsyncUnaryCall<BatchArchivePlacementsResponse> BatchArchivePlacementsAsync(BatchArchivePlacementsRequest request, CallOptions options)
Parameters
Type Name Description
BatchArchivePlacementsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchArchivePlacementsResponse>

The call object.

BatchArchivePlacementsAsync(BatchArchivePlacementsRequest, Metadata, DateTime?, CancellationToken)

Archives a list of Placement objects.

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

The call object.

BatchCreatePlacements(BatchCreatePlacementsRequest, CallOptions)

API to batch create Placement objects.

Declaration
public virtual BatchCreatePlacementsResponse BatchCreatePlacements(BatchCreatePlacementsRequest request, CallOptions options)
Parameters
Type Name Description
BatchCreatePlacementsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchCreatePlacementsResponse

The response received from the server.

BatchCreatePlacements(BatchCreatePlacementsRequest, Metadata, DateTime?, CancellationToken)

API to batch create Placement objects.

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

The response received from the server.

BatchCreatePlacementsAsync(BatchCreatePlacementsRequest, CallOptions)

API to batch create Placement objects.

Declaration
public virtual AsyncUnaryCall<BatchCreatePlacementsResponse> BatchCreatePlacementsAsync(BatchCreatePlacementsRequest request, CallOptions options)
Parameters
Type Name Description
BatchCreatePlacementsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchCreatePlacementsResponse>

The call object.

BatchCreatePlacementsAsync(BatchCreatePlacementsRequest, Metadata, DateTime?, CancellationToken)

API to batch create Placement objects.

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

The call object.

BatchDeactivatePlacements(BatchDeactivatePlacementsRequest, CallOptions)

Deactivates a list of Placement objects.

Declaration
public virtual BatchDeactivatePlacementsResponse BatchDeactivatePlacements(BatchDeactivatePlacementsRequest request, CallOptions options)
Parameters
Type Name Description
BatchDeactivatePlacementsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchDeactivatePlacementsResponse

The response received from the server.

BatchDeactivatePlacements(BatchDeactivatePlacementsRequest, Metadata, DateTime?, CancellationToken)

Deactivates a list of Placement objects.

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

The response received from the server.

BatchDeactivatePlacementsAsync(BatchDeactivatePlacementsRequest, CallOptions)

Deactivates a list of Placement objects.

Declaration
public virtual AsyncUnaryCall<BatchDeactivatePlacementsResponse> BatchDeactivatePlacementsAsync(BatchDeactivatePlacementsRequest request, CallOptions options)
Parameters
Type Name Description
BatchDeactivatePlacementsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchDeactivatePlacementsResponse>

The call object.

BatchDeactivatePlacementsAsync(BatchDeactivatePlacementsRequest, Metadata, DateTime?, CancellationToken)

Deactivates a list of Placement objects.

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

The call object.

BatchUpdatePlacements(BatchUpdatePlacementsRequest, CallOptions)

API to batch update Placement objects.

Declaration
public virtual BatchUpdatePlacementsResponse BatchUpdatePlacements(BatchUpdatePlacementsRequest request, CallOptions options)
Parameters
Type Name Description
BatchUpdatePlacementsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
BatchUpdatePlacementsResponse

The response received from the server.

BatchUpdatePlacements(BatchUpdatePlacementsRequest, Metadata, DateTime?, CancellationToken)

API to batch update Placement objects.

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

The response received from the server.

BatchUpdatePlacementsAsync(BatchUpdatePlacementsRequest, CallOptions)

API to batch update Placement objects.

Declaration
public virtual AsyncUnaryCall<BatchUpdatePlacementsResponse> BatchUpdatePlacementsAsync(BatchUpdatePlacementsRequest request, CallOptions options)
Parameters
Type Name Description
BatchUpdatePlacementsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<BatchUpdatePlacementsResponse>

The call object.

BatchUpdatePlacementsAsync(BatchUpdatePlacementsRequest, Metadata, DateTime?, CancellationToken)

API to batch update Placement objects.

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

The call object.

CreatePlacement(CreatePlacementRequest, CallOptions)

API to create an Placement object.

Declaration
public virtual Placement CreatePlacement(CreatePlacementRequest request, CallOptions options)
Parameters
Type Name Description
CreatePlacementRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Placement

The response received from the server.

CreatePlacement(CreatePlacementRequest, Metadata, DateTime?, CancellationToken)

API to create an Placement object.

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

The response received from the server.

CreatePlacementAsync(CreatePlacementRequest, CallOptions)

API to create an Placement object.

Declaration
public virtual AsyncUnaryCall<Placement> CreatePlacementAsync(CreatePlacementRequest request, CallOptions options)
Parameters
Type Name Description
CreatePlacementRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Placement>

The call object.

CreatePlacementAsync(CreatePlacementRequest, Metadata, DateTime?, CancellationToken)

API to create an Placement object.

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

The call object.

GetPlacement(GetPlacementRequest, CallOptions)

API to retrieve a Placement object.

Declaration
public virtual Placement GetPlacement(GetPlacementRequest request, CallOptions options)
Parameters
Type Name Description
GetPlacementRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Placement

The response received from the server.

GetPlacement(GetPlacementRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a Placement object.

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

The response received from the server.

GetPlacementAsync(GetPlacementRequest, CallOptions)

API to retrieve a Placement object.

Declaration
public virtual AsyncUnaryCall<Placement> GetPlacementAsync(GetPlacementRequest request, CallOptions options)
Parameters
Type Name Description
GetPlacementRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Placement>

The call object.

GetPlacementAsync(GetPlacementRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a Placement object.

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

The call object.

ListPlacements(ListPlacementsRequest, CallOptions)

API to retrieve a list of Placement objects.

Declaration
public virtual ListPlacementsResponse ListPlacements(ListPlacementsRequest request, CallOptions options)
Parameters
Type Name Description
ListPlacementsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
ListPlacementsResponse

The response received from the server.

ListPlacements(ListPlacementsRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a list of Placement objects.

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

The response received from the server.

ListPlacementsAsync(ListPlacementsRequest, CallOptions)

API to retrieve a list of Placement objects.

Declaration
public virtual AsyncUnaryCall<ListPlacementsResponse> ListPlacementsAsync(ListPlacementsRequest request, CallOptions options)
Parameters
Type Name Description
ListPlacementsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListPlacementsResponse>

The call object.

ListPlacementsAsync(ListPlacementsRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a list of Placement objects.

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

The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

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

UpdatePlacement(UpdatePlacementRequest, CallOptions)

API to update an Placement object.

Declaration
public virtual Placement UpdatePlacement(UpdatePlacementRequest request, CallOptions options)
Parameters
Type Name Description
UpdatePlacementRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Placement

The response received from the server.

UpdatePlacement(UpdatePlacementRequest, Metadata, DateTime?, CancellationToken)

API to update an Placement object.

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

The response received from the server.

UpdatePlacementAsync(UpdatePlacementRequest, CallOptions)

API to update an Placement object.

Declaration
public virtual AsyncUnaryCall<Placement> UpdatePlacementAsync(UpdatePlacementRequest request, CallOptions options)
Parameters
Type Name Description
UpdatePlacementRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Placement>

The call object.

UpdatePlacementAsync(UpdatePlacementRequest, Metadata, DateTime?, CancellationToken)

API to update an Placement object.

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

The call object.

In this article
Back to top Generated by DocFX