Reference documentation and code samples for the Google Ads Ad Manager V1 Client class Order.
The Order
resource.
Generated from protobuf message google.ads.admanager.v1.Order
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The resource name of the Order
. Format: networks/{network_code}/orders/{order_id}
↳ order_id
int|string
Output only. Order ID.
↳ display_name
string
Required. The display name of the Order. This value has a maximum length of 255 characters.
↳ programmatic
bool
Optional. Specifies whether or not the Order is a programmatic order.
↳ trafficker
string
Required. The resource name of the User responsible for trafficking the Order. Format: "networks/{network_code}/users/{user_id}"
↳ advertiser_contacts
array
Optional. The resource names of Contacts from the advertiser of this Order. Format: "networks/{network_code}/contacts/{contact_id}"
↳ advertiser
string
Required. The resource name of the Company, which is of type Company.Type.ADVERTISER, to which this order belongs. Format: "networks/{network_code}/companies/{company_id}"
↳ agency_contacts
array
Optional. The resource names of Contacts from the advertising Agency of this Order. Format: "networks/{network_code}/contacts/{contact_id}"
↳ agency
string
Optional. The resource name of the Company, which is of type Company.Type.AGENCY, with which this order is associated. Format: "networks/{network_code}/companies/{company_id}"
↳ applied_teams
array
Optional. The resource names of Teams directly applied to this Order. Format: "networks/{network_code}/teams/{team_id}"
↳ effective_teams
array
Output only. The resource names of Teams applied to this Order including inherited values. Format: "networks/{network_code}/teams/{team_id}"
↳ creator
string
Output only. The resource name of the User who created the Order on behalf of the advertiser. This value is assigned by Google. Format: "networks/{network_code}/users/{user_id}"
↳ currency_code
string
Output only. The ISO 4217 3-letter currency code for the currency used by the Order. This value is the network's currency code.
↳ start_time
Google\Protobuf\Timestamp
Output only. The instant at which the Order and its associated line items are eligible to begin serving. This attribute is derived from the line item of the order that has the earliest LineItem.start_time.
↳ end_time
Google\Protobuf\Timestamp
Output only. The instant at which the Order and its associated line items stop being served. This attribute is derived from the line item of the order that has the latest LineItem.end_time.
↳ unlimited_end_time
bool
Output only. Indicates whether or not this Order has an end time.
↳ external_order_id
int|string
Optional. An arbitrary ID to associate to the Order, which can be used as a key to an external system.
↳ archived
bool
Output only. The archival status of the Order.
↳ last_modified_by_app
string
Output only. The application which modified this order. This attribute is assigned by Google.
↳ update_time
↳ notes
string
Optional. Provides any additional notes that may annotate the Order. This attribute has a maximum length of 65,535 characters.
↳ po_number
string
Optional. The purchase order number for the Order. This value has a maximum length of 63 characters.
↳ status
int
Output only. The status of the Order.
↳ salesperson
string
Optional. The resource name of the User responsible for the sales of the Order. Format: "networks/{network_code}/users/{user_id}"
↳ secondary_salespeople
array
Optional. Unordered list. The resource names of the secondary salespeople associated with the order. Format: "networks/{network_code}/users/{user_id}"
↳ secondary_traffickers
array
Optional. Unordered list. The resource names of the secondary traffickers associated with the order. Format: "networks/{network_code}/users/{user_id}"
↳ applied_labels
array< Google\Ads\AdManager\V1\AppliedLabel
>
Optional. The set of labels applied directly to this order.
↳ effective_applied_labels
array< Google\Ads\AdManager\V1\AppliedLabel
>
Output only. Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is assigned by Google.
↳ custom_field_values
array< Google\Ads\AdManager\V1\CustomFieldValue
>
Optional. The set of custom field values to this order.
getName
Identifier. The resource name of the Order
.
Format: networks/{network_code}/orders/{order_id}
string
setName
Identifier. The resource name of the Order
.
Format: networks/{network_code}/orders/{order_id}
var
string
$this
getOrderId
Output only. Order ID.
int|string
setOrderId
Output only. Order ID.
var
int|string
$this
getDisplayName
Required. The display name of the Order. This value has a maximum length of 255 characters.
string
setDisplayName
Required. The display name of the Order. This value has a maximum length of 255 characters.
var
string
$this
getProgrammatic
Optional. Specifies whether or not the Order is a programmatic order.
bool
setProgrammatic
Optional. Specifies whether or not the Order is a programmatic order.
var
bool
$this
getTrafficker
Required. The resource name of the User responsible for trafficking the Order. Format: "networks/{network_code}/users/{user_id}"
string
setTrafficker
Required. The resource name of the User responsible for trafficking the Order. Format: "networks/{network_code}/users/{user_id}"
var
string
$this
getAdvertiserContacts
Optional. The resource names of Contacts from the advertiser of this Order.
Format: "networks/{network_code}/contacts/{contact_id}"
setAdvertiserContacts
Optional. The resource names of Contacts from the advertiser of this Order.
Format: "networks/{network_code}/contacts/{contact_id}"
var
string[]
$this
getAdvertiser
Required. The resource name of the Company, which is of type Company.Type.ADVERTISER, to which this order belongs. Format: "networks/{network_code}/companies/{company_id}"
string
setAdvertiser
Required. The resource name of the Company, which is of type Company.Type.ADVERTISER, to which this order belongs. Format: "networks/{network_code}/companies/{company_id}"
var
string
$this
getAgencyContacts
Optional. The resource names of Contacts from the advertising Agency of this Order. Format: "networks/{network_code}/contacts/{contact_id}"
setAgencyContacts
Optional. The resource names of Contacts from the advertising Agency of this Order. Format: "networks/{network_code}/contacts/{contact_id}"
var
string[]
$this
getAgency
Optional. The resource name of the Company, which is of type Company.Type.AGENCY, with which this order is associated. Format: "networks/{network_code}/companies/{company_id}"
string
setAgency
Optional. The resource name of the Company, which is of type Company.Type.AGENCY, with which this order is associated. Format: "networks/{network_code}/companies/{company_id}"
var
string
$this
getAppliedTeams
Optional. The resource names of Teams directly applied to this Order.
Format: "networks/{network_code}/teams/{team_id}"
setAppliedTeams
Optional. The resource names of Teams directly applied to this Order.
Format: "networks/{network_code}/teams/{team_id}"
var
string[]
$this
getEffectiveTeams
Output only. The resource names of Teams applied to this Order including inherited values. Format: "networks/{network_code}/teams/{team_id}"
setEffectiveTeams
Output only. The resource names of Teams applied to this Order including inherited values. Format: "networks/{network_code}/teams/{team_id}"
var
string[]
$this
getCreator
Output only. The resource name of the User who created the Order on behalf of the advertiser. This value is assigned by Google. Format: "networks/{network_code}/users/{user_id}"
string
setCreator
Output only. The resource name of the User who created the Order on behalf of the advertiser. This value is assigned by Google. Format: "networks/{network_code}/users/{user_id}"
var
string
$this
getCurrencyCode
Output only. The ISO 4217 3-letter currency code for the currency used by the Order. This value is the network's currency code.
string
setCurrencyCode
Output only. The ISO 4217 3-letter currency code for the currency used by the Order. This value is the network's currency code.
var
string
$this
getStartTime
Output only. The instant at which the Order and its associated line items are eligible to begin serving. This attribute is derived from the line item of the order that has the earliest LineItem.start_time.
hasStartTime
clearStartTime
setStartTime
Output only. The instant at which the Order and its associated line items are eligible to begin serving. This attribute is derived from the line item of the order that has the earliest LineItem.start_time.
$this
getEndTime
Output only. The instant at which the Order and its associated line items stop being served. This attribute is derived from the line item of the order that has the latest LineItem.end_time.
hasEndTime
clearEndTime
setEndTime
Output only. The instant at which the Order and its associated line items stop being served. This attribute is derived from the line item of the order that has the latest LineItem.end_time.
$this
getUnlimitedEndTime
Output only. Indicates whether or not this Order has an end time.
bool
setUnlimitedEndTime
Output only. Indicates whether or not this Order has an end time.
var
bool
$this
getExternalOrderId
Optional. An arbitrary ID to associate to the Order, which can be used as a key to an external system.
int|string
setExternalOrderId
Optional. An arbitrary ID to associate to the Order, which can be used as a key to an external system.
var
int|string
$this
getArchived
Output only. The archival status of the Order.
bool
setArchived
Output only. The archival status of the Order.
var
bool
$this
getLastModifiedByApp
Output only. The application which modified this order. This attribute is assigned by Google.
string
setLastModifiedByApp
Output only. The application which modified this order. This attribute is assigned by Google.
var
string
$this
getUpdateTime
Output only. The instant this Order was last modified.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The instant this Order was last modified.
$this
getNotes
Optional. Provides any additional notes that may annotate the Order. This attribute has a maximum length of 65,535 characters.
string
setNotes
Optional. Provides any additional notes that may annotate the Order. This attribute has a maximum length of 65,535 characters.
var
string
$this
getPoNumber
Optional. The purchase order number for the Order. This value has a maximum length of 63 characters.
string
setPoNumber
Optional. The purchase order number for the Order. This value has a maximum length of 63 characters.
var
string
$this
getStatus
Output only. The status of the Order.
int
setStatus
Output only. The status of the Order.
var
int
$this
getSalesperson
Optional. The resource name of the User responsible for the sales of the Order. Format: "networks/{network_code}/users/{user_id}"
string
setSalesperson
Optional. The resource name of the User responsible for the sales of the Order. Format: "networks/{network_code}/users/{user_id}"
var
string
$this
getSecondarySalespeople
Optional. Unordered list. The resource names of the secondary salespeople associated with the order. Format: "networks/{network_code}/users/{user_id}"
setSecondarySalespeople
Optional. Unordered list. The resource names of the secondary salespeople associated with the order. Format: "networks/{network_code}/users/{user_id}"
var
string[]
$this
getSecondaryTraffickers
Optional. Unordered list. The resource names of the secondary traffickers associated with the order. Format: "networks/{network_code}/users/{user_id}"
setSecondaryTraffickers
Optional. Unordered list. The resource names of the secondary traffickers associated with the order. Format: "networks/{network_code}/users/{user_id}"
var
string[]
$this
getAppliedLabels
Optional. The set of labels applied directly to this order.
setAppliedLabels
Optional. The set of labels applied directly to this order.
$this
getEffectiveAppliedLabels
Output only. Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is assigned by Google.
setEffectiveAppliedLabels
Output only. Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is assigned by Google.
$this
getCustomFieldValues
Optional. The set of custom field values to this order.
setCustomFieldValues
Optional. The set of custom field values to this order.
$this
