Class Order

The Order resource.

Inheritance

object

Order

Implements

IMessage<Order>

IEquatable<Order>

IDeepCloneable<Order>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class Order : IMessage<Order>, IEquatable<Order>, IDeepCloneable<Order>, IBufferMessage, IMessage

Constructors

Order()

Declaration

public Order()

Order(Order)

Declaration

public Order(Order other)

Parameters

Type	Name	Description
Order	other

Properties

Advertiser

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}"

Declaration

public string Advertiser { get; set; }

Property Value

Type	Description
string

AdvertiserAsCompanyName

CompanyName-typed view over the Advertiser resource name property.

Declaration

public CompanyName AdvertiserAsCompanyName { get; set; }

Property Value

Type	Description
CompanyName

AdvertiserContacts

Optional. The resource names of Contacts from the advertiser of this Order. Format: "networks/{network_code}/contacts/{contact_id}"

Declaration

public RepeatedField<string> AdvertiserContacts { get; }

Property Value

Type	Description
RepeatedField<string>

AdvertiserContactsAsContactNames

ContactName-typed view over the AdvertiserContacts resource name property.

Declaration

public ResourceNameList<ContactName> AdvertiserContactsAsContactNames { get; }

Property Value

Type	Description
ResourceNameList<ContactName>

Agency

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}"

Declaration

public string Agency { get; set; }

Property Value

Type	Description
string

AgencyAsCompanyName

CompanyName-typed view over the Agency resource name property.

Declaration

public CompanyName AgencyAsCompanyName { get; set; }

Property Value

Type	Description
CompanyName

AgencyContacts

Optional. The resource names of Contacts from the advertising Agency of this Order. Format: "networks/{network_code}/contacts/{contact_id}"

Declaration

public RepeatedField<string> AgencyContacts { get; }

Property Value

Type	Description
RepeatedField<string>

AgencyContactsAsContactNames

ContactName-typed view over the AgencyContacts resource name property.

Declaration

public ResourceNameList<ContactName> AgencyContactsAsContactNames { get; }

Property Value

Type	Description
ResourceNameList<ContactName>

AppliedLabels

Optional. The set of labels applied directly to this order.

Declaration

public RepeatedField<AppliedLabel> AppliedLabels { get; }

Property Value

Type	Description
RepeatedField<AppliedLabel>

AppliedTeams

Optional. The resource names of Teams directly applied to this Order. Format: "networks/{network_code}/teams/{team_id}"

Declaration

public RepeatedField<string> AppliedTeams { get; }

Property Value

Type	Description
RepeatedField<string>

AppliedTeamsAsTeamNames

TeamName-typed view over the AppliedTeams resource name property.

Declaration

public ResourceNameList<TeamName> AppliedTeamsAsTeamNames { get; }

Property Value

Type	Description
ResourceNameList<TeamName>

Archived

Output only. The archival status of the Order.

Declaration

public bool Archived { get; set; }

Property Value

Type	Description
bool

Creator

Output only. The resource name of the User who created the Order on behalf of the advertiser. Format: "networks/{network_code}/users/{user_id}"

Declaration

public string Creator { get; set; }

Property Value

Type	Description
string

CreatorAsUserName

UserName-typed view over the Creator resource name property.

Declaration

public UserName CreatorAsUserName { get; set; }

Property Value

Type	Description
UserName

CurrencyCode

Output only. The ISO 4217 3-letter currency code for the currency used by the Order. This value is the network's currency code.

Declaration

public string CurrencyCode { get; set; }

Property Value

Type	Description
string

CustomFieldValues

Optional. The set of custom field values to this order.

Declaration

public RepeatedField<CustomFieldValue> CustomFieldValues { get; }

Property Value

Type	Description
RepeatedField<CustomFieldValue>

DisplayName

Required. The display name of the Order. This value has a maximum length of 255 characters.

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
string

EffectiveAppliedLabels

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.

Declaration

public RepeatedField<AppliedLabel> EffectiveAppliedLabels { get; }

Property Value

Type	Description
RepeatedField<AppliedLabel>

EffectiveTeams

Output only. The resource names of Teams applied to this Order including inherited values. Format: "networks/{network_code}/teams/{team_id}"

Declaration

public RepeatedField<string> EffectiveTeams { get; }

Property Value

Type	Description
RepeatedField<string>

EffectiveTeamsAsTeamNames

TeamName-typed view over the EffectiveTeams resource name property.

Declaration

public ResourceNameList<TeamName> EffectiveTeamsAsTeamNames { get; }

Property Value

Type	Description
ResourceNameList<TeamName>

EndTime

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.

Declaration

public Timestamp EndTime { get; set; }

Property Value

Type	Description
Timestamp

ExternalOrderId

Optional. An arbitrary ID to associate to the Order, which can be used as a key to an external system.

Declaration

public int ExternalOrderId { get; set; }

Property Value

Type	Description
int

HasAdvertiser

Gets whether the "advertiser" field is set

Declaration

public bool HasAdvertiser { get; }

Property Value

Type	Description
bool

HasAgency

Gets whether the "agency" field is set

Declaration

public bool HasAgency { get; }

Property Value

Type	Description
bool

HasArchived

Gets whether the "archived" field is set

Declaration

public bool HasArchived { get; }

Property Value

Type	Description
bool

HasCreator

Gets whether the "creator" field is set

Declaration

public bool HasCreator { get; }

Property Value

Type	Description
bool

HasCurrencyCode

Gets whether the "currency_code" field is set

Declaration

public bool HasCurrencyCode { get; }

Property Value

Type	Description
bool

HasDisplayName

Gets whether the "display_name" field is set

Declaration

public bool HasDisplayName { get; }

Property Value

Type	Description
bool

HasExternalOrderId

Gets whether the "external_order_id" field is set

Declaration

public bool HasExternalOrderId { get; }

Property Value

Type	Description
bool

HasLastModifiedByApp

Gets whether the "last_modified_by_app" field is set

Declaration

public bool HasLastModifiedByApp { get; }

Property Value

Type	Description
bool

HasNotes

Gets whether the "notes" field is set

Declaration

public bool HasNotes { get; }

Property Value

Type	Description
bool

HasOrderId

Gets whether the "order_id" field is set

Declaration

public bool HasOrderId { get; }

Property Value

Type	Description
bool

HasPoNumber

Gets whether the "po_number" field is set

Declaration

public bool HasPoNumber { get; }

Property Value

Type	Description
bool

HasProgrammatic

Gets whether the "programmatic" field is set

Declaration

public bool HasProgrammatic { get; }

Property Value

Type	Description
bool

HasSalesperson

Gets whether the "salesperson" field is set

Declaration

public bool HasSalesperson { get; }

Property Value

Type	Description
bool

HasStatus

Gets whether the "status" field is set

Declaration

public bool HasStatus { get; }

Property Value

Type	Description
bool

HasTrafficker

Gets whether the "trafficker" field is set

Declaration

public bool HasTrafficker { get; }

Property Value

Type	Description
bool

HasUnlimitedEndTime

Gets whether the "unlimited_end_time" field is set

Declaration

public bool HasUnlimitedEndTime { get; }

Property Value

Type	Description
bool

LastModifiedByApp

Output only. The application which modified this order. This attribute is assigned by Google.

Declaration

public string LastModifiedByApp { get; set; }

Property Value

Type	Description
string

Name

Identifier. The resource name of the Order. Format: networks/{network_code}/orders/{order_id}

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Notes

Optional. Provides any additional notes that may annotate the Order. This attribute has a maximum length of 65,535 characters.

Declaration

public string Notes { get; set; }

Property Value

Type	Description
string

OrderId

Output only. Order ID.

Declaration

public long OrderId { get; set; }

Property Value

Type	Description
long

OrderName

OrderName-typed view over the Name resource name property.

Declaration

public OrderName OrderName { get; set; }

Property Value

Type	Description
OrderName

PoNumber

Optional. The purchase order number for the Order. This value has a maximum length of 63 characters.

Declaration

public string PoNumber { get; set; }

Property Value

Type	Description
string

Programmatic

Optional. Specifies whether or not the Order is a programmatic order.

Declaration

public bool Programmatic { get; set; }

Property Value

Type	Description
bool

Salesperson

Optional. The resource name of the User responsible for the sales of the Order. Format: "networks/{network_code}/users/{user_id}"

Declaration

public string Salesperson { get; set; }

Property Value

Type	Description
string

SalespersonAsUserName

UserName-typed view over the Salesperson resource name property.

Declaration

public UserName SalespersonAsUserName { get; set; }

Property Value

Type	Description
UserName

SecondarySalespeople

Optional. Unordered list. The resource names of the secondary salespeople associated with the order. Format: "networks/{network_code}/users/{user_id}"

Declaration

public RepeatedField<string> SecondarySalespeople { get; }

Property Value

Type	Description
RepeatedField<string>

SecondarySalespeopleAsUserNames

UserName-typed view over the SecondarySalespeople resource name property.

Declaration

public ResourceNameList<UserName> SecondarySalespeopleAsUserNames { get; }

Property Value

Type	Description
ResourceNameList<UserName>

SecondaryTraffickers

Optional. Unordered list. The resource names of the secondary traffickers associated with the order. Format: "networks/{network_code}/users/{user_id}"

Declaration

public RepeatedField<string> SecondaryTraffickers { get; }

Property Value

Type	Description
RepeatedField<string>

SecondaryTraffickersAsUserNames

UserName-typed view over the SecondaryTraffickers resource name property.

Declaration

public ResourceNameList<UserName> SecondaryTraffickersAsUserNames { get; }

Property Value

Type	Description
ResourceNameList<UserName>

StartTime

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.

Declaration

public Timestamp StartTime { get; set; }

Property Value

Type	Description
Timestamp

Status

Output only. The status of the Order.

Declaration

public OrderStatusEnum.Types.OrderStatus Status { get; set; }

Property Value

Type	Description
OrderStatusEnum.Types.OrderStatus

Trafficker

Required. The resource name of the User responsible for trafficking the Order. Format: "networks/{network_code}/users/{user_id}"

Declaration

public string Trafficker { get; set; }

Property Value

Type	Description
string

TraffickerAsUserName

UserName-typed view over the Trafficker resource name property.

Declaration

public UserName TraffickerAsUserName { get; set; }

Property Value

Type	Description
UserName

UnlimitedEndTime

Output only. Indicates whether or not this Order has an end time.

Declaration

public bool UnlimitedEndTime { get; set; }

Property Value

Type	Description
bool

UpdateTime

Output only. The instant this Order was last modified.

Declaration

public Timestamp UpdateTime { get; set; }

Property Value

Type	Description
Timestamp