Resource: Line
A single order line which represents a configured product.
JSON representation |
---|
{ "name": string, "product": string, "externalId": string, "displayName": string, "description": string, "lineState": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the line in the format: |
product |
Output only. The name of the |
externalId |
Optional. An id used to map this entity to external sources. |
displayName |
Output only. The display name of the line. |
description |
Output only. Additional freeform field to describe the line. |
lineState |
Output only. The state of the line. See Seller can use the following custom methods:
All other line states are set by the buyer. |
rejection |
Optional. Rejection details for the line. |
startTime |
Output only. When the line would start being served (inclusive). A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
Output only. When the line would stop being served (exclusive). A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
startDate |
Output only. The date the line would start being served (inclusive). Same time zone as the ad unit. |
endDate |
Output only. The date the line would stop being served (inclusive). Same time zone as the ad unit. |
budget |
Output only. The budget of the line. |
lineTerms |
Output only. The seller's guaranteed terms for this line. |
pendingReservationExpirationTime |
Output only. Expiration timestamp for the pending reservation. Seller needs to reserve or reject before a pending reservation expires or it will be treated as rejected. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
reservationExpirationTime |
Output only. Expiration timestamp for the reservation. The buyer needs to book before a reservation expires or it will be treated as cancelled. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
targeting |
Output only. The targeting for the line. |
createTime |
Output only. Creation timestamp for line. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. Last updated timestamp for line. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
LineState
State of a line.
Enums | |
---|---|
LINE_STATE_UNSPECIFIED |
The default value when the line state has not been specified or is unknown in this version. |
LINE_STATE_PENDING_RESERVATION |
The line has been created by the buyer and is requesting the products be reserved as well as updated with pricing and availability information. |
LINE_STATE_RESERVED |
The line was reserved by the seller. This state is only possible if the previous state is pending reservation. |
LINE_STATE_PENDING_BOOKING |
The buyer has accepted the reservation and is requesting the line to be booked. |
LINE_STATE_BOOKED |
The seller has booked the line. This state is only possible if the previous state is pending booking. Rejections are not expected at this stage. |
LINE_STATE_REJECTED_BY_SELLER |
The line was rejected by the seller. This state is only possible if the previous state is pending reservation. |
LINE_STATE_CANCELLED_BY_BUYER |
The line was cancelled by buyer. |
LINE_STATE_PENDING_RESERVATION_EXPIRED |
The line expired while pending reservation. |
LINE_STATE_RESERVED_EXPIRED |
The line expired while reserved, waiting for buyer's response. |
Methods |
|
---|---|
|
Books an existing line. |
|
Retrieves an individual line for an order. |
|
Lists lines for an order. |
|
Updates an existing line. |
|
Rejects an existing line. |
|
Reserves an existing line. |