DV360 Out of Home Seller API

DV360 Out of Home Seller API allows managing inventory, booking orders, getting creatives and submitting ad play events.

Service: dv360outofhomeseller.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://dv360outofhomeseller.googleapis.com

REST Resource: v1beta1

Methods
lookupByExternalId POST /v1beta1:lookupByExternalId
Retrieves all entities by external id listed in the request.

REST Resource: v1beta1.adPlays

Methods
create POST /v1beta1/adPlays
Creates an ad play.
createWithExternalIds POST /v1beta1/adPlays:createWithExternalIds
Creates an ad play with external ids.

REST Resource: v1beta1.adUnits

Methods
create POST /v1beta1/adUnits
Creates a new ad unit.
delete DELETE /v1beta1/{name=adUnits/*}
Deletes an existing ad unit.
get GET /v1beta1/{name=adUnits/*}
Retrieves an individual ad unit.
list GET /v1beta1/adUnits
Lists ad units.
patch PATCH /v1beta1/{adUnit.name=adUnits/*}
Updates an existing ad unit.

REST Resource: v1beta1.availabilityOrders

Methods
complete POST /v1beta1/{name=availabilityOrders/*}:complete
Marks an existing availability order as complete.
get GET /v1beta1/{name=availabilityOrders/*}
Retrieves an individual availability order.
list GET /v1beta1/availabilityOrders
Lists availability orders.

REST Resource: v1beta1.availabilityOrders.availabilityLines

Methods
complete POST /v1beta1/{name=availabilityOrders/*/availabilityLines/*}:complete
Marks an existing availability line as complete.
get GET /v1beta1/{name=availabilityOrders/*/availabilityLines/*}
Retrieves an individual line for an availability order.
list GET /v1beta1/{parent=availabilityOrders/*}/availabilityLines
Lists lines for an availability order.
reject POST /v1beta1/{name=availabilityOrders/*/availabilityLines/*}:reject
Marks an existing availability line as rejected.

REST Resource: v1beta1.creativeAssets

Methods
get GET /v1beta1/{name=creativeAssets/*}
Retrieves an individual creative asset.
list GET /v1beta1/creativeAssets
Lists creative assets.
patch PATCH /v1beta1/{creativeAsset.name=creativeAssets/*}
Updates an existing creative asset.

REST Resource: v1beta1.orders

Methods
get GET /v1beta1/{name=orders/*}
Retrieves an individual order.
list GET /v1beta1/orders
Lists orders.
patch PATCH /v1beta1/{order.name=orders/*}
Updates an existing order.

REST Resource: v1beta1.orders.lines

Methods
book POST /v1beta1/{name=orders/*/lines/*}:book
Books an existing line.
get GET /v1beta1/{name=orders/*/lines/*}
Retrieves an individual line for an order.
list GET /v1beta1/{parent=orders/*}/lines
Lists lines for an order.
patch PATCH /v1beta1/{line.name=orders/*/lines/*}
Updates an existing line.
reject POST /v1beta1/{name=orders/*/lines/*}:reject
Rejects an existing line.
reserve POST /v1beta1/{name=orders/*/lines/*}:reserve
Reserves an existing line.

REST Resource: v1beta1.orders.lines.assignments

Methods
approve POST /v1beta1/{name=orders/*/lines/*/assignments/*}:approve
Approves an existing assignment.
disapprove POST /v1beta1/{name=orders/*/lines/*/assignments/*}:disapprove
Disapproves an existing assignment.
get GET /v1beta1/{name=orders/*/lines/*/assignments/*}
Retrieves an individual assignment for a line.
list GET /v1beta1/{parent=orders/*/lines/*}/assignments
Lists assignments for a line.
patch PATCH /v1beta1/{assignment.name=orders/*/lines/*/assignments/*}
Updates an existing assignment.

REST Resource: v1beta1.products

Methods
create POST /v1beta1/products
Creates a new product.
get GET /v1beta1/{name=products/*}
Retrieves an individual product.
list GET /v1beta1/products
Lists products.
patch PATCH /v1beta1/{product.name=products/*}
Updates an existing product.

REST Resource: v1.sellers.adPlays

Methods
batchCreate POST /v1/{parent=sellers/*}/adPlays:batchCreate
Creates new ad plays in batch.
create POST /v1/{parent=sellers/*}/adPlays
Creates an ad play.

REST Resource: v1.sellers.adUnits

Methods
create POST /v1/{parent=sellers/*}/adUnits
Creates a new ad unit.
delete DELETE /v1/{name=sellers/*/adUnits/*}
Deletes an existing ad unit.
get GET /v1/{name=sellers/*/adUnits/*}
Retrieves an individual ad unit.
list GET /v1/{parent=sellers/*}/adUnits
Lists ad units.
patch PATCH /v1/{adUnit.name=sellers/*/adUnits/*}
Updates an existing ad unit.

REST Resource: v1.sellers.adUnits.impressionSchedules

Methods
batchUpdate POST /v1/{parent=sellers/*/adUnits/*}/impressionSchedules:batchUpdate
Updates impression schedules in batch.
create POST /v1/{parent=sellers/*/adUnits/*}/impressionSchedules
Creates a new impression schedule.
get GET /v1/{name=sellers/*/adUnits/*/impressionSchedules/*}
Retrieves an individual impression schedule.
list GET /v1/{parent=sellers/*/adUnits/*}/impressionSchedules
Lists impression schedules.
patch PATCH /v1/{impressionSchedule.name=sellers/*/adUnits/*/impressionSchedules/*}
Updates an existing impression schedule.

REST Resource: v1.sellers.availabilityOrders

Methods
complete POST /v1/{name=sellers/*/availabilityOrders/*}:complete
Marks an existing availability order as complete.
get GET /v1/{name=sellers/*/availabilityOrders/*}
Retrieves an individual availability order.
list GET /v1/{parent=sellers/*}/availabilityOrders
Lists availability orders.

REST Resource: v1.sellers.availabilityOrders.availabilityLines

Methods
complete POST /v1/{name=sellers/*/availabilityOrders/*/availabilityLines/*}:complete
Marks an existing availability line as complete.
get GET /v1/{name=sellers/*/availabilityOrders/*/availabilityLines/*}
Retrieves an individual line for an availability order.
list GET /v1/{parent=sellers/*/availabilityOrders/*}/availabilityLines
Lists lines for an availability order.
reject POST /v1/{name=sellers/*/availabilityOrders/*/availabilityLines/*}:reject
Marks an existing availability line as rejected.

REST Resource: v1.sellers.creativeAssets

Methods
get GET /v1/{name=sellers/*/creativeAssets/*}
Retrieves an individual creative asset.
list GET /v1/{parent=sellers/*}/creativeAssets
Lists creative assets.
patch PATCH /v1/{creativeAsset.name=sellers/*/creativeAssets/*}
Updates an existing creative asset.

REST Resource: v1.sellers.orders

Methods
completeOrderBooking POST /v1/{order=sellers/*/orders/*}:completeOrderBooking
Completes the order booking.
completeOrderReservation POST /v1/{order=sellers/*/orders/*}:completeOrderReservation
Completes the order reservation.
create POST /v1/{parent=sellers/*}/orders
Creates a new order.
get GET /v1/{name=sellers/*/orders/*}
Retrieves an individual order.
list GET /v1/{parent=sellers/*}/orders
Lists orders.
patch PATCH /v1/{order.name=sellers/*/orders/*}
Updates an existing order.

REST Resource: v1.sellers.orders.lines

Methods
book POST /v1/{name=sellers/*/orders/*/lines/*}:book
Books an existing line.
create POST /v1/{parent=sellers/*/orders/*}/lines
Creates a new line.
get GET /v1/{name=sellers/*/orders/*/lines/*}
Retrieves an individual line for an order.
list GET /v1/{parent=sellers/*/orders/*}/lines
Lists lines for an order.
patch PATCH /v1/{line.name=sellers/*/orders/*/lines/*}
Updates an existing line.
reject POST /v1/{name=sellers/*/orders/*/lines/*}:reject
Rejects an existing line.
reserve POST /v1/{name=sellers/*/orders/*/lines/*}:reserve
Reserves an existing line.

REST Resource: v1.sellers.orders.lines.assignments

Methods
approve POST /v1/{name=sellers/*/orders/*/lines/*/assignments/*}:approve
Approves an existing assignment.
disapprove POST /v1/{name=sellers/*/orders/*/lines/*/assignments/*}:disapprove
Disapproves an existing assignment.
get GET /v1/{name=sellers/*/orders/*/lines/*/assignments/*}
Retrieves an individual assignment for a line.
list GET /v1/{parent=sellers/*/orders/*/lines/*}/assignments
Lists assignments for a line.
patch PATCH /v1/{assignment.name=sellers/*/orders/*/lines/*/assignments/*}
Updates an existing assignment.

REST Resource: v1.sellers.products

Methods
create POST /v1/{parent=sellers/*}/products
Creates a new product.
delete DELETE /v1/{name=sellers/*/products/*}
Deletes an existing product.
get GET /v1/{name=sellers/*/products/*}
Retrieves an individual product.
list GET /v1/{parent=sellers/*}/products
Lists products.
patch PATCH /v1/{product.name=sellers/*/products/*}
Updates an existing product.