REST Resource: sellers.availabilityOrders.availabilityLines

Resource: AvailabilityLine

An availability line represents a set of settings for which the buyer requests inventory availability and the response from the seller. For workflow see AvailabilityOrder.

JSON representation
{
  "name": string,
  "product": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "budget": {
    object (Money)
  },
  "targeting": {
    object (Targeting)
  },
  "availabilityLineTerms": {
    object (LineTerms)
  },
  "state": enum (State),
  "rejection": {
    object (Rejection)
  },
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Output only. The resource name of the availability line in the format: sellers/111/availabilityOrders/123/availabilityLines/321.

product

string

Output only. The name of the Product this availability request is for. Format = products/456

startDate

object (Date)

Output only. The start date of when the availability is requested (inclusive). Same time zone as the ad unit.

endDate

object (Date)

Output only. The end date of when the availability is requested (inclusive). Same time zone as the ad unit.

budget

object (Money)

Output only. The budget of the availability line.

targeting

object (Targeting)

Output only. The targeting for which the availability is requested.

availabilityLineTerms

object (LineTerms)

Output only. Seller can use the [Complete][google.ads.xbid.outofhome.v1.OrderManagementService.CompleteAvailabilityLine] to update [LineTerms].

state

enum (State)

Output only. The state of this availability order. See AvailabilityLine.State for the lifecycle of an AvailabilityLine.

Seller can use the [Complete][google.ads.xbid.outofhome.v1.OrderManagementService.CompleteAvailabilityLine] or [Reject][google.ads.xbid.outofhome.v1.OrderManagementService.RejectAvailabilityLine] custom methods to set to one of:

  • STATE_COMPLETED
  • STATE_REJECTED

respectively.

rejection

object (Rejection)

Rejection details for the availability line.

createTime

string (Timestamp format)

Output only. Creation timestamp for the availability line.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Last updated timestamp for the availability line.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

State

Possible values for availability line state.

Enums
STATE_UNSPECIFIED The default value when availability line state has not been specified or is unknown in this version.
STATE_PENDING Pending availability when the buyer provided the availability request settings.
STATE_COMPLETED Completed state when the seller provided the availability response.
STATE_REJECTED Rejection state when the availability line has been disapproved by the seller. Disapproval details must be provided.
STATE_CANCELLED Cancelled state when buyer cancel the order before seller complete or reject availability response.

Methods

complete

Marks an existing availability line as complete.

get

Retrieves an individual line for an availability order.

list

Lists lines for an availability order.

reject

Marks an existing availability line as rejected.