Class OrderServiceClientImpl

OrderService client wrapper implementation, for convenient use.

Inheritance
object
OrderServiceClient
OrderServiceClientImpl
Inherited Members
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
public sealed class OrderServiceClientImpl : OrderServiceClient

Provides methods for handling Order objects.

Constructors

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

Declaration
public OrderServiceClientImpl(OrderService.OrderServiceClient grpcClient, OrderServiceSettings settings, ILogger logger)
Parameters
Type Name Description
OrderService.OrderServiceClient grpcClient

The underlying gRPC client.
OrderServiceSettings settings

The base OrderServiceSettings used within this client.
ILogger logger

Optional ILogger to use within this client.

Properties

The underlying gRPC OrderService client

Declaration
public override OrderService.OrderServiceClient GrpcClient { get; }
Property Value
Type Description
OrderService.OrderServiceClient
Overrides

Methods

Approves and overbooks a list of Order objects.

Declaration
public override BatchApproveAndOverbookOrdersResponse BatchApproveAndOverbookOrders(BatchApproveAndOverbookOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchApproveAndOverbookOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchApproveAndOverbookOrdersResponse

The RPC response.
Overrides

Approves and overbooks a list of Order objects.

Declaration
public override Task<BatchApproveAndOverbookOrdersResponse> BatchApproveAndOverbookOrdersAsync(BatchApproveAndOverbookOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchApproveAndOverbookOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchApproveAndOverbookOrdersResponse>

A Task containing the RPC response.
Overrides

Approves a list of Order objects.

Declaration
public override BatchApproveOrdersResponse BatchApproveOrders(BatchApproveOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchApproveOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchApproveOrdersResponse

The RPC response.
Overrides

Approves a list of Order objects.

Declaration
public override Task<BatchApproveOrdersResponse> BatchApproveOrdersAsync(BatchApproveOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchApproveOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchApproveOrdersResponse>

A Task containing the RPC response.
Overrides

Approves a list of Order objects without changing reservation status.

Declaration
public override BatchApproveOrdersWithoutReservationResponse BatchApproveOrdersWithoutReservation(BatchApproveOrdersWithoutReservationRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchApproveOrdersWithoutReservationRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchApproveOrdersWithoutReservationResponse

The RPC response.
Overrides

Approves a list of Order objects without changing reservation status.

Declaration
public override Task<BatchApproveOrdersWithoutReservationResponse> BatchApproveOrdersWithoutReservationAsync(BatchApproveOrdersWithoutReservationRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchApproveOrdersWithoutReservationRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchApproveOrdersWithoutReservationResponse>

A Task containing the RPC response.
Overrides

Archives a list of Order objects.

Declaration
public override BatchArchiveOrdersResponse BatchArchiveOrders(BatchArchiveOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchArchiveOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchArchiveOrdersResponse

The RPC response.
Overrides

Archives a list of Order objects.

Declaration
public override Task<BatchArchiveOrdersResponse> BatchArchiveOrdersAsync(BatchArchiveOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchArchiveOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchArchiveOrdersResponse>

A Task containing the RPC response.
Overrides

Creates Order objects.

Declaration
public override BatchCreateOrdersResponse BatchCreateOrders(BatchCreateOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchCreateOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchCreateOrdersResponse

The RPC response.
Overrides

Creates Order objects.

Declaration
public override Task<BatchCreateOrdersResponse> BatchCreateOrdersAsync(BatchCreateOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchCreateOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchCreateOrdersResponse>

A Task containing the RPC response.
Overrides

Deletes a list of Order objects.

Declaration
public override BatchDeleteOrdersResponse BatchDeleteOrders(BatchDeleteOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchDeleteOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchDeleteOrdersResponse

The RPC response.
Overrides

Deletes a list of Order objects.

Declaration
public override Task<BatchDeleteOrdersResponse> BatchDeleteOrdersAsync(BatchDeleteOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchDeleteOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchDeleteOrdersResponse>

A Task containing the RPC response.
Overrides

Disapproves a list of Order objects.

Declaration
public override BatchDisapproveOrdersResponse BatchDisapproveOrders(BatchDisapproveOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchDisapproveOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchDisapproveOrdersResponse

The RPC response.
Overrides

Disapproves a list of Order objects.

Declaration
public override Task<BatchDisapproveOrdersResponse> BatchDisapproveOrdersAsync(BatchDisapproveOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchDisapproveOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchDisapproveOrdersResponse>

A Task containing the RPC response.
Overrides

Disapproves a list of Order objects without changing reservation status.

Declaration
public override BatchDisapproveOrdersWithoutReservationChangesResponse BatchDisapproveOrdersWithoutReservationChanges(BatchDisapproveOrdersWithoutReservationChangesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchDisapproveOrdersWithoutReservationChangesRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchDisapproveOrdersWithoutReservationChangesResponse

The RPC response.
Overrides

Disapproves a list of Order objects without changing reservation status.

Declaration
public override Task<BatchDisapproveOrdersWithoutReservationChangesResponse> BatchDisapproveOrdersWithoutReservationChangesAsync(BatchDisapproveOrdersWithoutReservationChangesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchDisapproveOrdersWithoutReservationChangesRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchDisapproveOrdersWithoutReservationChangesResponse>

A Task containing the RPC response.
Overrides

Pauses a list of Order objects.

Declaration
public override BatchPauseOrdersResponse BatchPauseOrders(BatchPauseOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchPauseOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchPauseOrdersResponse

The RPC response.
Overrides

Pauses a list of Order objects.

Declaration
public override Task<BatchPauseOrdersResponse> BatchPauseOrdersAsync(BatchPauseOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchPauseOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchPauseOrdersResponse>

A Task containing the RPC response.
Overrides

Resumes and overbooks a list of Order objects.

Declaration
public override BatchResumeAndOverbookOrdersResponse BatchResumeAndOverbookOrders(BatchResumeAndOverbookOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchResumeAndOverbookOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchResumeAndOverbookOrdersResponse

The RPC response.
Overrides

Resumes and overbooks a list of Order objects.

Declaration
public override Task<BatchResumeAndOverbookOrdersResponse> BatchResumeAndOverbookOrdersAsync(BatchResumeAndOverbookOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchResumeAndOverbookOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchResumeAndOverbookOrdersResponse>

A Task containing the RPC response.
Overrides

Resumes a list of Order objects.

Declaration
public override BatchResumeOrdersResponse BatchResumeOrders(BatchResumeOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchResumeOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchResumeOrdersResponse

The RPC response.
Overrides

Resumes a list of Order objects.

Declaration
public override Task<BatchResumeOrdersResponse> BatchResumeOrdersAsync(BatchResumeOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchResumeOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchResumeOrdersResponse>

A Task containing the RPC response.
Overrides

Retracts a list of Order objects.

Declaration
public override BatchRetractOrdersResponse BatchRetractOrders(BatchRetractOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchRetractOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchRetractOrdersResponse

The RPC response.
Overrides

Retracts a list of Order objects.

Declaration
public override Task<BatchRetractOrdersResponse> BatchRetractOrdersAsync(BatchRetractOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchRetractOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchRetractOrdersResponse>

A Task containing the RPC response.
Overrides

Retracts a list of Order objects without changing reservation status.

Declaration
public override BatchRetractOrdersWithoutReservationChangesResponse BatchRetractOrdersWithoutReservationChanges(BatchRetractOrdersWithoutReservationChangesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchRetractOrdersWithoutReservationChangesRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchRetractOrdersWithoutReservationChangesResponse

The RPC response.
Overrides

Retracts a list of Order objects without changing reservation status.

Declaration
public override Task<BatchRetractOrdersWithoutReservationChangesResponse> BatchRetractOrdersWithoutReservationChangesAsync(BatchRetractOrdersWithoutReservationChangesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchRetractOrdersWithoutReservationChangesRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchRetractOrdersWithoutReservationChangesResponse>

A Task containing the RPC response.
Overrides

Submits a list of Order objects for approval.

Declaration
public override BatchSubmitOrdersForApprovalResponse BatchSubmitOrdersForApproval(BatchSubmitOrdersForApprovalRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchSubmitOrdersForApprovalRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchSubmitOrdersForApprovalResponse

The RPC response.
Overrides

Submits and overbooks a list of Order objects for approval.

Declaration
public override BatchSubmitOrdersForApprovalAndOverbookResponse BatchSubmitOrdersForApprovalAndOverbook(BatchSubmitOrdersForApprovalAndOverbookRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchSubmitOrdersForApprovalAndOverbookRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchSubmitOrdersForApprovalAndOverbookResponse

The RPC response.
Overrides

Submits and overbooks a list of Order objects for approval.

Declaration
public override Task<BatchSubmitOrdersForApprovalAndOverbookResponse> BatchSubmitOrdersForApprovalAndOverbookAsync(BatchSubmitOrdersForApprovalAndOverbookRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchSubmitOrdersForApprovalAndOverbookRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchSubmitOrdersForApprovalAndOverbookResponse>

A Task containing the RPC response.
Overrides

Submits a list of Order objects for approval.

Declaration
public override Task<BatchSubmitOrdersForApprovalResponse> BatchSubmitOrdersForApprovalAsync(BatchSubmitOrdersForApprovalRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchSubmitOrdersForApprovalRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchSubmitOrdersForApprovalResponse>

A Task containing the RPC response.
Overrides

Submits a list of Order objects for approval without changing reservation status.

Declaration
public override BatchSubmitOrdersForApprovalWithoutReservationChangesResponse BatchSubmitOrdersForApprovalWithoutReservationChanges(BatchSubmitOrdersForApprovalWithoutReservationChangesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchSubmitOrdersForApprovalWithoutReservationChangesRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchSubmitOrdersForApprovalWithoutReservationChangesResponse

The RPC response.
Overrides

Submits a list of Order objects for approval without changing reservation status.

Declaration
public override Task<BatchSubmitOrdersForApprovalWithoutReservationChangesResponse> BatchSubmitOrdersForApprovalWithoutReservationChangesAsync(BatchSubmitOrdersForApprovalWithoutReservationChangesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchSubmitOrdersForApprovalWithoutReservationChangesRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchSubmitOrdersForApprovalWithoutReservationChangesResponse>

A Task containing the RPC response.
Overrides

Unarchives a list of Order objects.

Declaration
public override BatchUnarchiveOrdersResponse BatchUnarchiveOrders(BatchUnarchiveOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchUnarchiveOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchUnarchiveOrdersResponse

The RPC response.
Overrides

Unarchives a list of Order objects.

Declaration
public override Task<BatchUnarchiveOrdersResponse> BatchUnarchiveOrdersAsync(BatchUnarchiveOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchUnarchiveOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchUnarchiveOrdersResponse>

A Task containing the RPC response.
Overrides

Batch updates Order objects.

Declaration
public override BatchUpdateOrdersResponse BatchUpdateOrders(BatchUpdateOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchUpdateOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchUpdateOrdersResponse

The RPC response.
Overrides

Batch updates Order objects.

Declaration
public override Task<BatchUpdateOrdersResponse> BatchUpdateOrdersAsync(BatchUpdateOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
BatchUpdateOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<BatchUpdateOrdersResponse>

A Task containing the RPC response.
Overrides

Retrieves an Order object.

Declaration
public override Order GetOrder(GetOrderRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetOrderRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Order

The RPC response.
Overrides

Retrieves an Order object.

Declaration
public override Task<Order> GetOrderAsync(GetOrderRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetOrderRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Order>

A Task containing the RPC response.
Overrides

Lists Order objects.

Fields used for literal matching in filter string:

  • order_id
  • display_name
  • external_order_id
Declaration
public override PagedEnumerable<ListOrdersResponse, Order> ListOrders(ListOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListOrdersResponse, Order>

A pageable sequence of Order resources.
Overrides

Lists Order objects.

Fields used for literal matching in filter string:

  • order_id
  • display_name
  • external_order_id
Declaration
public override PagedAsyncEnumerable<ListOrdersResponse, Order> ListOrdersAsync(ListOrdersRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListOrdersRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListOrdersResponse, Order>

A pageable asynchronous sequence of Order resources.
Overrides