Class Order.Builder (0.13.0)

public static final class Order.Builder extends GeneratedMessageV3.Builder<Order.Builder> implements OrderOrBuilder

The Order resource.

Protobuf type google.ads.admanager.v1.Order

Implements

OrderOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAdvertiserContacts(String value)

public Order.Builder addAdvertiserContacts(String value)

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

repeated string advertiser_contacts = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The advertiserContacts to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addAdvertiserContactsBytes(ByteString value)

public Order.Builder addAdvertiserContactsBytes(ByteString value)

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

repeated string advertiser_contacts = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the advertiserContacts to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addAgencyContacts(String value)

public Order.Builder addAgencyContacts(String value)

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

repeated string agency_contacts = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The agencyContacts to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addAgencyContactsBytes(ByteString value)

public Order.Builder addAgencyContactsBytes(ByteString value)

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

repeated string agency_contacts = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the agencyContacts to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addAllAdvertiserContacts(Iterable<String> values)

public Order.Builder addAllAdvertiserContacts(Iterable<String> values)

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

repeated string advertiser_contacts = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The advertiserContacts to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addAllAgencyContacts(Iterable<String> values)

public Order.Builder addAllAgencyContacts(Iterable<String> values)

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

repeated string agency_contacts = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The agencyContacts to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addAllAppliedLabels(Iterable<? extends AppliedLabel> values)

public Order.Builder addAllAppliedLabels(Iterable<? extends AppliedLabel> values)

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.AppliedLabel>
Returns
Type Description
Order.Builder

addAllAppliedTeams(Iterable<String> values)

public Order.Builder addAllAppliedTeams(Iterable<String> values)

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

repeated string applied_teams = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The appliedTeams to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addAllCustomFieldValues(Iterable<? extends CustomFieldValue> values)

public Order.Builder addAllCustomFieldValues(Iterable<? extends CustomFieldValue> values)

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.CustomFieldValue>
Returns
Type Description
Order.Builder

addAllEffectiveAppliedLabels(Iterable<? extends AppliedLabel> values)

public Order.Builder addAllEffectiveAppliedLabels(Iterable<? extends AppliedLabel> values)

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.AppliedLabel>
Returns
Type Description
Order.Builder

addAllEffectiveTeams(Iterable<String> values)

public Order.Builder addAllEffectiveTeams(Iterable<String> values)

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

repeated string effective_teams = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The effectiveTeams to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addAllSecondarySalespeople(Iterable<String> values)

public Order.Builder addAllSecondarySalespeople(Iterable<String> values)

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

repeated string secondary_salespeople = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The secondarySalespeople to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addAllSecondaryTraffickers(Iterable<String> values)

public Order.Builder addAllSecondaryTraffickers(Iterable<String> values)

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

repeated string secondary_traffickers = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The secondaryTraffickers to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addAppliedLabels(AppliedLabel value)

public Order.Builder addAppliedLabels(AppliedLabel value)

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AppliedLabel
Returns
Type Description
Order.Builder

addAppliedLabels(AppliedLabel.Builder builderForValue)

public Order.Builder addAppliedLabels(AppliedLabel.Builder builderForValue)

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AppliedLabel.Builder
Returns
Type Description
Order.Builder

addAppliedLabels(int index, AppliedLabel value)

public Order.Builder addAppliedLabels(int index, AppliedLabel value)

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
Order.Builder

addAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public Order.Builder addAppliedLabels(int index, AppliedLabel.Builder builderForValue)

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
Order.Builder

addAppliedLabelsBuilder()

public AppliedLabel.Builder addAppliedLabelsBuilder()

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AppliedLabel.Builder

addAppliedLabelsBuilder(int index)

public AppliedLabel.Builder addAppliedLabelsBuilder(int index)

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

addAppliedTeams(String value)

public Order.Builder addAppliedTeams(String value)

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

repeated string applied_teams = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The appliedTeams to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addAppliedTeamsBytes(ByteString value)

public Order.Builder addAppliedTeamsBytes(ByteString value)

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

repeated string applied_teams = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the appliedTeams to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addCustomFieldValues(CustomFieldValue value)

public Order.Builder addCustomFieldValues(CustomFieldValue value)

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CustomFieldValue
Returns
Type Description
Order.Builder

addCustomFieldValues(CustomFieldValue.Builder builderForValue)

public Order.Builder addCustomFieldValues(CustomFieldValue.Builder builderForValue)

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue CustomFieldValue.Builder
Returns
Type Description
Order.Builder

addCustomFieldValues(int index, CustomFieldValue value)

public Order.Builder addCustomFieldValues(int index, CustomFieldValue value)

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value CustomFieldValue
Returns
Type Description
Order.Builder

addCustomFieldValues(int index, CustomFieldValue.Builder builderForValue)

public Order.Builder addCustomFieldValues(int index, CustomFieldValue.Builder builderForValue)

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue CustomFieldValue.Builder
Returns
Type Description
Order.Builder

addCustomFieldValuesBuilder()

public CustomFieldValue.Builder addCustomFieldValuesBuilder()

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomFieldValue.Builder

addCustomFieldValuesBuilder(int index)

public CustomFieldValue.Builder addCustomFieldValuesBuilder(int index)

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CustomFieldValue.Builder

addEffectiveAppliedLabels(AppliedLabel value)

public Order.Builder addEffectiveAppliedLabels(AppliedLabel value)

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value AppliedLabel
Returns
Type Description
Order.Builder

addEffectiveAppliedLabels(AppliedLabel.Builder builderForValue)

public Order.Builder addEffectiveAppliedLabels(AppliedLabel.Builder builderForValue)

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue AppliedLabel.Builder
Returns
Type Description
Order.Builder

addEffectiveAppliedLabels(int index, AppliedLabel value)

public Order.Builder addEffectiveAppliedLabels(int index, AppliedLabel value)

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
Order.Builder

addEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public Order.Builder addEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
Order.Builder

addEffectiveAppliedLabelsBuilder()

public AppliedLabel.Builder addEffectiveAppliedLabelsBuilder()

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AppliedLabel.Builder

addEffectiveAppliedLabelsBuilder(int index)

public AppliedLabel.Builder addEffectiveAppliedLabelsBuilder(int index)

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

addEffectiveTeams(String value)

public Order.Builder addEffectiveTeams(String value)

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

repeated string effective_teams = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The effectiveTeams to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addEffectiveTeamsBytes(ByteString value)

public Order.Builder addEffectiveTeamsBytes(ByteString value)

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

repeated string effective_teams = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the effectiveTeams to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Order.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Order.Builder
Overrides

addSecondarySalespeople(String value)

public Order.Builder addSecondarySalespeople(String value)

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

repeated string secondary_salespeople = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The secondarySalespeople to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addSecondarySalespeopleBytes(ByteString value)

public Order.Builder addSecondarySalespeopleBytes(ByteString value)

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

repeated string secondary_salespeople = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the secondarySalespeople to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addSecondaryTraffickers(String value)

public Order.Builder addSecondaryTraffickers(String value)

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

repeated string secondary_traffickers = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The secondaryTraffickers to add.

Returns
Type Description
Order.Builder

This builder for chaining.

addSecondaryTraffickersBytes(ByteString value)

public Order.Builder addSecondaryTraffickersBytes(ByteString value)

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

repeated string secondary_traffickers = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the secondaryTraffickers to add.

Returns
Type Description
Order.Builder

This builder for chaining.

build()

public Order build()
Returns
Type Description
Order

buildPartial()

public Order buildPartial()
Returns
Type Description
Order

clear()

public Order.Builder clear()
Returns
Type Description
Order.Builder
Overrides

clearAdvertiser()

public Order.Builder clearAdvertiser()

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 advertiser = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
Order.Builder

This builder for chaining.

clearAdvertiserContacts()

public Order.Builder clearAdvertiserContacts()

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

repeated string advertiser_contacts = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
Order.Builder

This builder for chaining.

clearAgency()

public Order.Builder clearAgency()

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 agency = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
Order.Builder

This builder for chaining.

clearAgencyContacts()

public Order.Builder clearAgencyContacts()

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

repeated string agency_contacts = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
Order.Builder

This builder for chaining.

clearAppliedLabels()

public Order.Builder clearAppliedLabels()

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Order.Builder

clearAppliedTeams()

public Order.Builder clearAppliedTeams()

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

repeated string applied_teams = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
Order.Builder

This builder for chaining.

clearArchived()

public Order.Builder clearArchived()

Output only. The archival status of the Order.

bool archived = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.Builder

This builder for chaining.

clearCreator()

public Order.Builder clearCreator()

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 creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
Order.Builder

This builder for chaining.

clearCurrencyCode()

public Order.Builder clearCurrencyCode()

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 currency_code = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.Builder

This builder for chaining.

clearCustomFieldValues()

public Order.Builder clearCustomFieldValues()

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Order.Builder

clearDisplayName()

public Order.Builder clearDisplayName()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Order.Builder

This builder for chaining.

clearEffectiveAppliedLabels()

public Order.Builder clearEffectiveAppliedLabels()

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.Builder

clearEffectiveTeams()

public Order.Builder clearEffectiveTeams()

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

repeated string effective_teams = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
Order.Builder

This builder for chaining.

clearEndTime()

public Order.Builder clearEndTime()

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.

.google.protobuf.Timestamp end_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.Builder

clearExternalOrderId()

public Order.Builder clearExternalOrderId()

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

int64 external_order_id = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Order.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Order.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Order.Builder
Overrides

clearLastModifiedByApp()

public Order.Builder clearLastModifiedByApp()

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

string last_modified_by_app = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.Builder

This builder for chaining.

clearName()

public Order.Builder clearName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
Order.Builder

This builder for chaining.

clearNotes()

public Order.Builder clearNotes()

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

string notes = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Order.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Order.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Order.Builder
Overrides

clearOrderId()

public Order.Builder clearOrderId()

Output only. Order ID.

int64 order_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.Builder

This builder for chaining.

clearPoNumber()

public Order.Builder clearPoNumber()

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

string po_number = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Order.Builder

This builder for chaining.

clearProgrammatic()

public Order.Builder clearProgrammatic()

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

bool programmatic = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Order.Builder

This builder for chaining.

clearSalesperson()

public Order.Builder clearSalesperson()

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

string salesperson = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
Order.Builder

This builder for chaining.

clearSecondarySalespeople()

public Order.Builder clearSecondarySalespeople()

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

repeated string secondary_salespeople = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Returns
Type Description
Order.Builder

This builder for chaining.

clearSecondaryTraffickers()

public Order.Builder clearSecondaryTraffickers()

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

repeated string secondary_traffickers = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Returns
Type Description
Order.Builder

This builder for chaining.

clearStartTime()

public Order.Builder clearStartTime()

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.

.google.protobuf.Timestamp start_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.Builder

clearStatus()

public Order.Builder clearStatus()

Output only. The status of the Order.

.google.ads.admanager.v1.OrderStatusEnum.OrderStatus status = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.Builder

This builder for chaining.

clearTrafficker()

public Order.Builder clearTrafficker()

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

string trafficker = 23 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
Order.Builder

This builder for chaining.

clearUnlimitedEndTime()

public Order.Builder clearUnlimitedEndTime()

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

bool unlimited_end_time = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.Builder

This builder for chaining.

clearUpdateTime()

public Order.Builder clearUpdateTime()

Output only. The instant this Order was last modified.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Order.Builder

clone()

public Order.Builder clone()
Returns
Type Description
Order.Builder
Overrides

getAdvertiser()

public String 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 advertiser = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The advertiser.

getAdvertiserBytes()

public ByteString getAdvertiserBytes()

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 advertiser = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for advertiser.

getAdvertiserContacts(int index)

public String getAdvertiserContacts(int index)

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

repeated string advertiser_contacts = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The advertiserContacts at the given index.

getAdvertiserContactsBytes(int index)

public ByteString getAdvertiserContactsBytes(int index)

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

repeated string advertiser_contacts = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the advertiserContacts at the given index.

getAdvertiserContactsCount()

public int getAdvertiserContactsCount()

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

repeated string advertiser_contacts = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of advertiserContacts.

getAdvertiserContactsList()

public ProtocolStringList getAdvertiserContactsList()

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

repeated string advertiser_contacts = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the advertiserContacts.

getAgency()

public String 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 agency = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The agency.

getAgencyBytes()

public ByteString getAgencyBytes()

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 agency = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for agency.

getAgencyContacts(int index)

public String getAgencyContacts(int index)

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

repeated string agency_contacts = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The agencyContacts at the given index.

getAgencyContactsBytes(int index)

public ByteString getAgencyContactsBytes(int index)

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

repeated string agency_contacts = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the agencyContacts at the given index.

getAgencyContactsCount()

public int getAgencyContactsCount()

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

repeated string agency_contacts = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of agencyContacts.

getAgencyContactsList()

public ProtocolStringList getAgencyContactsList()

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

repeated string agency_contacts = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the agencyContacts.

getAppliedLabels(int index)

public AppliedLabel getAppliedLabels(int index)

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel

getAppliedLabelsBuilder(int index)

public AppliedLabel.Builder getAppliedLabelsBuilder(int index)

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

getAppliedLabelsBuilderList()

public List<AppliedLabel.Builder> getAppliedLabelsBuilderList()

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getAppliedLabelsCount()

public int getAppliedLabelsCount()

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAppliedLabelsList()

public List<AppliedLabel> getAppliedLabelsList()

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AppliedLabel>

getAppliedLabelsOrBuilder(int index)

public AppliedLabelOrBuilder getAppliedLabelsOrBuilder(int index)

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabelOrBuilder

getAppliedLabelsOrBuilderList()

public List<? extends AppliedLabelOrBuilder> getAppliedLabelsOrBuilderList()

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.AppliedLabelOrBuilder>

getAppliedTeams(int index)

public String getAppliedTeams(int index)

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

repeated string applied_teams = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The appliedTeams at the given index.

getAppliedTeamsBytes(int index)

public ByteString getAppliedTeamsBytes(int index)

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

repeated string applied_teams = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the appliedTeams at the given index.

getAppliedTeamsCount()

public int getAppliedTeamsCount()

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

repeated string applied_teams = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of appliedTeams.

getAppliedTeamsList()

public ProtocolStringList getAppliedTeamsList()

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

repeated string applied_teams = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the appliedTeams.

getArchived()

public boolean getArchived()

Output only. The archival status of the Order.

bool archived = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The archived.

getCreator()

public String 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 creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The creator.

getCreatorBytes()

public ByteString getCreatorBytes()

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 creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for creator.

getCurrencyCode()

public String 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 currency_code = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public ByteString getCurrencyCodeBytes()

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 currency_code = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for currencyCode.

getCustomFieldValues(int index)

public CustomFieldValue getCustomFieldValues(int index)

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CustomFieldValue

getCustomFieldValuesBuilder(int index)

public CustomFieldValue.Builder getCustomFieldValuesBuilder(int index)

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CustomFieldValue.Builder

getCustomFieldValuesBuilderList()

public List<CustomFieldValue.Builder> getCustomFieldValuesBuilderList()

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getCustomFieldValuesCount()

public int getCustomFieldValuesCount()

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getCustomFieldValuesList()

public List<CustomFieldValue> getCustomFieldValuesList()

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<CustomFieldValue>

getCustomFieldValuesOrBuilder(int index)

public CustomFieldValueOrBuilder getCustomFieldValuesOrBuilder(int index)

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CustomFieldValueOrBuilder

getCustomFieldValuesOrBuilderList()

public List<? extends CustomFieldValueOrBuilder> getCustomFieldValuesOrBuilderList()

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.CustomFieldValueOrBuilder>

getDefaultInstanceForType()

public Order getDefaultInstanceForType()
Returns
Type Description
Order

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEffectiveAppliedLabels(int index)

public AppliedLabel getEffectiveAppliedLabels(int index)

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel

getEffectiveAppliedLabelsBuilder(int index)

public AppliedLabel.Builder getEffectiveAppliedLabelsBuilder(int index)

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabel.Builder

getEffectiveAppliedLabelsBuilderList()

public List<AppliedLabel.Builder> getEffectiveAppliedLabelsBuilderList()

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getEffectiveAppliedLabelsCount()

public int getEffectiveAppliedLabelsCount()

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getEffectiveAppliedLabelsList()

public List<AppliedLabel> getEffectiveAppliedLabelsList()

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<AppliedLabel>

getEffectiveAppliedLabelsOrBuilder(int index)

public AppliedLabelOrBuilder getEffectiveAppliedLabelsOrBuilder(int index)

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppliedLabelOrBuilder

getEffectiveAppliedLabelsOrBuilderList()

public List<? extends AppliedLabelOrBuilder> getEffectiveAppliedLabelsOrBuilderList()

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.AppliedLabelOrBuilder>

getEffectiveTeams(int index)

public String getEffectiveTeams(int index)

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

repeated string effective_teams = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The effectiveTeams at the given index.

getEffectiveTeamsBytes(int index)

public ByteString getEffectiveTeamsBytes(int index)

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

repeated string effective_teams = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the effectiveTeams at the given index.

getEffectiveTeamsCount()

public int getEffectiveTeamsCount()

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

repeated string effective_teams = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of effectiveTeams.

getEffectiveTeamsList()

public ProtocolStringList getEffectiveTeamsList()

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

repeated string effective_teams = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the effectiveTeams.

getEndTime()

public Timestamp 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.

.google.protobuf.Timestamp end_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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.

.google.protobuf.Timestamp end_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

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.

.google.protobuf.Timestamp end_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getExternalOrderId()

public long getExternalOrderId()

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

int64 external_order_id = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The externalOrderId.

getLastModifiedByApp()

public String getLastModifiedByApp()

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

string last_modified_by_app = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The lastModifiedByApp.

getLastModifiedByAppBytes()

public ByteString getLastModifiedByAppBytes()

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

string last_modified_by_app = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for lastModifiedByApp.

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNotes()

public String getNotes()

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

string notes = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The notes.

getNotesBytes()

public ByteString getNotesBytes()

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

string notes = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for notes.

getOrderId()

public long getOrderId()

Output only. Order ID.

int64 order_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The orderId.

getPoNumber()

public String getPoNumber()

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

string po_number = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The poNumber.

getPoNumberBytes()

public ByteString getPoNumberBytes()

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

string po_number = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for poNumber.

getProgrammatic()

public boolean getProgrammatic()

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

bool programmatic = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The programmatic.

getSalesperson()

public String getSalesperson()

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

string salesperson = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The salesperson.

getSalespersonBytes()

public ByteString getSalespersonBytes()

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

string salesperson = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for salesperson.

getSecondarySalespeople(int index)

public String getSecondarySalespeople(int index)

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

repeated string secondary_salespeople = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The secondarySalespeople at the given index.

getSecondarySalespeopleBytes(int index)

public ByteString getSecondarySalespeopleBytes(int index)

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

repeated string secondary_salespeople = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the secondarySalespeople at the given index.

getSecondarySalespeopleCount()

public int getSecondarySalespeopleCount()

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

repeated string secondary_salespeople = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of secondarySalespeople.

getSecondarySalespeopleList()

public ProtocolStringList getSecondarySalespeopleList()

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

repeated string secondary_salespeople = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the secondarySalespeople.

getSecondaryTraffickers(int index)

public String getSecondaryTraffickers(int index)

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

repeated string secondary_traffickers = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The secondaryTraffickers at the given index.

getSecondaryTraffickersBytes(int index)

public ByteString getSecondaryTraffickersBytes(int index)

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

repeated string secondary_traffickers = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the secondaryTraffickers at the given index.

getSecondaryTraffickersCount()

public int getSecondaryTraffickersCount()

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

repeated string secondary_traffickers = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of secondaryTraffickers.

getSecondaryTraffickersList()

public ProtocolStringList getSecondaryTraffickersList()

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

repeated string secondary_traffickers = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the secondaryTraffickers.

getStartTime()

public Timestamp 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.

.google.protobuf.Timestamp start_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

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.

.google.protobuf.Timestamp start_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

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.

.google.protobuf.Timestamp start_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getStatus()

public OrderStatusEnum.OrderStatus getStatus()

Output only. The status of the Order.

.google.ads.admanager.v1.OrderStatusEnum.OrderStatus status = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OrderStatusEnum.OrderStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. The status of the Order.

.google.ads.admanager.v1.OrderStatusEnum.OrderStatus status = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getTrafficker()

public String getTrafficker()

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

string trafficker = 23 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The trafficker.

getTraffickerBytes()

public ByteString getTraffickerBytes()

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

string trafficker = 23 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for trafficker.

getUnlimitedEndTime()

public boolean getUnlimitedEndTime()

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

bool unlimited_end_time = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The unlimitedEndTime.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The instant this Order was last modified.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The instant this Order was last modified.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The instant this Order was last modified.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasEndTime()

public boolean hasEndTime()

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.

.google.protobuf.Timestamp end_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

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.

.google.protobuf.Timestamp start_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The instant this Order was last modified.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public Order.Builder mergeEndTime(Timestamp value)

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.

.google.protobuf.Timestamp end_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Order.Builder

mergeFrom(Order other)

public Order.Builder mergeFrom(Order other)
Parameter
Name Description
other Order
Returns
Type Description
Order.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Order.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Order.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Order.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Order.Builder
Overrides

mergeStartTime(Timestamp value)

public Order.Builder mergeStartTime(Timestamp value)

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.

.google.protobuf.Timestamp start_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Order.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Order.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Order.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Order.Builder mergeUpdateTime(Timestamp value)

Output only. The instant this Order was last modified.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Order.Builder

removeAppliedLabels(int index)

public Order.Builder removeAppliedLabels(int index)

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Order.Builder

removeCustomFieldValues(int index)

public Order.Builder removeCustomFieldValues(int index)

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Order.Builder

removeEffectiveAppliedLabels(int index)

public Order.Builder removeEffectiveAppliedLabels(int index)

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Order.Builder

setAdvertiser(String value)

public Order.Builder setAdvertiser(String value)

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 advertiser = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The advertiser to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setAdvertiserBytes(ByteString value)

public Order.Builder setAdvertiserBytes(ByteString value)

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 advertiser = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for advertiser to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setAdvertiserContacts(int index, String value)

public Order.Builder setAdvertiserContacts(int index, String value)

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

repeated string advertiser_contacts = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The advertiserContacts to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setAgency(String value)

public Order.Builder setAgency(String value)

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 agency = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The agency to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setAgencyBytes(ByteString value)

public Order.Builder setAgencyBytes(ByteString value)

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 agency = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for agency to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setAgencyContacts(int index, String value)

public Order.Builder setAgencyContacts(int index, String value)

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

repeated string agency_contacts = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The agencyContacts to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setAppliedLabels(int index, AppliedLabel value)

public Order.Builder setAppliedLabels(int index, AppliedLabel value)

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
Order.Builder

setAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public Order.Builder setAppliedLabels(int index, AppliedLabel.Builder builderForValue)

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

repeated .google.ads.admanager.v1.AppliedLabel applied_labels = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
Order.Builder

setAppliedTeams(int index, String value)

public Order.Builder setAppliedTeams(int index, String value)

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

repeated string applied_teams = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The appliedTeams to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setArchived(boolean value)

public Order.Builder setArchived(boolean value)

Output only. The archival status of the Order.

bool archived = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The archived to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setCreator(String value)

public Order.Builder setCreator(String value)

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 creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The creator to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setCreatorBytes(ByteString value)

public Order.Builder setCreatorBytes(ByteString value)

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 creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for creator to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setCurrencyCode(String value)

public Order.Builder setCurrencyCode(String value)

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 currency_code = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The currencyCode to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setCurrencyCodeBytes(ByteString value)

public Order.Builder setCurrencyCodeBytes(ByteString value)

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 currency_code = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for currencyCode to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setCustomFieldValues(int index, CustomFieldValue value)

public Order.Builder setCustomFieldValues(int index, CustomFieldValue value)

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value CustomFieldValue
Returns
Type Description
Order.Builder

setCustomFieldValues(int index, CustomFieldValue.Builder builderForValue)

public Order.Builder setCustomFieldValues(int index, CustomFieldValue.Builder builderForValue)

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

repeated .google.ads.admanager.v1.CustomFieldValue custom_field_values = 38 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue CustomFieldValue.Builder
Returns
Type Description
Order.Builder

setDisplayName(String value)

public Order.Builder setDisplayName(String value)

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Order.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setEffectiveAppliedLabels(int index, AppliedLabel value)

public Order.Builder setEffectiveAppliedLabels(int index, AppliedLabel value)

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value AppliedLabel
Returns
Type Description
Order.Builder

setEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

public Order.Builder setEffectiveAppliedLabels(int index, AppliedLabel.Builder builderForValue)

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.

repeated .google.ads.admanager.v1.AppliedLabel effective_applied_labels = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue AppliedLabel.Builder
Returns
Type Description
Order.Builder

setEffectiveTeams(int index, String value)

public Order.Builder setEffectiveTeams(int index, String value)

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

repeated string effective_teams = 28 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The effectiveTeams to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setEndTime(Timestamp value)

public Order.Builder setEndTime(Timestamp value)

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.

.google.protobuf.Timestamp end_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Order.Builder

setEndTime(Timestamp.Builder builderForValue)

public Order.Builder setEndTime(Timestamp.Builder builderForValue)

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.

.google.protobuf.Timestamp end_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Order.Builder

setExternalOrderId(long value)

public Order.Builder setExternalOrderId(long value)

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

int64 external_order_id = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The externalOrderId to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Order.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Order.Builder
Overrides

setLastModifiedByApp(String value)

public Order.Builder setLastModifiedByApp(String value)

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

string last_modified_by_app = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The lastModifiedByApp to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setLastModifiedByAppBytes(ByteString value)

public Order.Builder setLastModifiedByAppBytes(ByteString value)

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

string last_modified_by_app = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for lastModifiedByApp to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setName(String value)

public Order.Builder setName(String value)

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Order.Builder setNameBytes(ByteString value)

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setNotes(String value)

public Order.Builder setNotes(String value)

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

string notes = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The notes to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setNotesBytes(ByteString value)

public Order.Builder setNotesBytes(ByteString value)

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

string notes = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for notes to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setOrderId(long value)

public Order.Builder setOrderId(long value)

Output only. Order ID.

int64 order_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The orderId to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setPoNumber(String value)

public Order.Builder setPoNumber(String value)

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

string po_number = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The poNumber to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setPoNumberBytes(ByteString value)

public Order.Builder setPoNumberBytes(ByteString value)

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

string po_number = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for poNumber to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setProgrammatic(boolean value)

public Order.Builder setProgrammatic(boolean value)

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

bool programmatic = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The programmatic to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Order.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Order.Builder
Overrides

setSalesperson(String value)

public Order.Builder setSalesperson(String value)

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

string salesperson = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The salesperson to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setSalespersonBytes(ByteString value)

public Order.Builder setSalespersonBytes(ByteString value)

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

string salesperson = 21 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for salesperson to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setSecondarySalespeople(int index, String value)

public Order.Builder setSecondarySalespeople(int index, String value)

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

repeated string secondary_salespeople = 22 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The secondarySalespeople to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setSecondaryTraffickers(int index, String value)

public Order.Builder setSecondaryTraffickers(int index, String value)

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

repeated string secondary_traffickers = 24 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = UNORDERED_LIST, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The secondaryTraffickers to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setStartTime(Timestamp value)

public Order.Builder setStartTime(Timestamp value)

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.

.google.protobuf.Timestamp start_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Order.Builder

setStartTime(Timestamp.Builder builderForValue)

public Order.Builder setStartTime(Timestamp.Builder builderForValue)

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.

.google.protobuf.Timestamp start_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Order.Builder

setStatus(OrderStatusEnum.OrderStatus value)

public Order.Builder setStatus(OrderStatusEnum.OrderStatus value)

Output only. The status of the Order.

.google.ads.admanager.v1.OrderStatusEnum.OrderStatus status = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value OrderStatusEnum.OrderStatus

The status to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setStatusValue(int value)

public Order.Builder setStatusValue(int value)

Output only. The status of the Order.

.google.ads.admanager.v1.OrderStatusEnum.OrderStatus status = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for status to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setTrafficker(String value)

public Order.Builder setTrafficker(String value)

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

string trafficker = 23 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The trafficker to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setTraffickerBytes(ByteString value)

public Order.Builder setTraffickerBytes(ByteString value)

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

string trafficker = 23 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for trafficker to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Order.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Order.Builder
Overrides

setUnlimitedEndTime(boolean value)

public Order.Builder setUnlimitedEndTime(boolean value)

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

bool unlimited_end_time = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The unlimitedEndTime to set.

Returns
Type Description
Order.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public Order.Builder setUpdateTime(Timestamp value)

Output only. The instant this Order was last modified.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Order.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Order.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The instant this Order was last modified.

.google.protobuf.Timestamp update_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Order.Builder