Class Order (0.16.0)

  public 
  
 final 
  
 class 
 Order 
  
 extends 
  
 GeneratedMessageV3 
  
 implements 
  
 OrderOrBuilder 
 

The Order resource.

Protobuf type google.ads.admanager.v1.Order

Implements

OrderOrBuilder

Static Fields

ADVERTISER_CONTACTS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ADVERTISER_CONTACTS_FIELD_NUMBER 
 
Field Value
Type
Description
int

ADVERTISER_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ADVERTISER_FIELD_NUMBER 
 
Field Value
Type
Description
int

AGENCY_CONTACTS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 AGENCY_CONTACTS_FIELD_NUMBER 
 
Field Value
Type
Description
int

AGENCY_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 AGENCY_FIELD_NUMBER 
 
Field Value
Type
Description
int

APPLIED_LABELS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 APPLIED_LABELS_FIELD_NUMBER 
 
Field Value
Type
Description
int

APPLIED_TEAMS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 APPLIED_TEAMS_FIELD_NUMBER 
 
Field Value
Type
Description
int

ARCHIVED_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ARCHIVED_FIELD_NUMBER 
 
Field Value
Type
Description
int

CREATOR_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CREATOR_FIELD_NUMBER 
 
Field Value
Type
Description
int

CURRENCY_CODE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CURRENCY_CODE_FIELD_NUMBER 
 
Field Value
Type
Description
int

CUSTOM_FIELD_VALUES_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CUSTOM_FIELD_VALUES_FIELD_NUMBER 
 
Field Value
Type
Description
int

DISPLAY_NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DISPLAY_NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

EFFECTIVE_APPLIED_LABELS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 EFFECTIVE_APPLIED_LABELS_FIELD_NUMBER 
 
Field Value
Type
Description
int

EFFECTIVE_TEAMS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 EFFECTIVE_TEAMS_FIELD_NUMBER 
 
Field Value
Type
Description
int

END_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 END_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

EXTERNAL_ORDER_ID_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 EXTERNAL_ORDER_ID_FIELD_NUMBER 
 
Field Value
Type
Description
int

LAST_MODIFIED_BY_APP_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 LAST_MODIFIED_BY_APP_FIELD_NUMBER 
 
Field Value
Type
Description
int

NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

NOTES_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 NOTES_FIELD_NUMBER 
 
Field Value
Type
Description
int

ORDER_ID_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ORDER_ID_FIELD_NUMBER 
 
Field Value
Type
Description
int

PO_NUMBER_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 PO_NUMBER_FIELD_NUMBER 
 
Field Value
Type
Description
int

PROGRAMMATIC_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 PROGRAMMATIC_FIELD_NUMBER 
 
Field Value
Type
Description
int

SALESPERSON_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 SALESPERSON_FIELD_NUMBER 
 
Field Value
Type
Description
int

SECONDARY_SALESPEOPLE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 SECONDARY_SALESPEOPLE_FIELD_NUMBER 
 
Field Value
Type
Description
int

SECONDARY_TRAFFICKERS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 SECONDARY_TRAFFICKERS_FIELD_NUMBER 
 
Field Value
Type
Description
int

START_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 START_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

STATUS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 STATUS_FIELD_NUMBER 
 
Field Value
Type
Description
int

TRAFFICKER_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 TRAFFICKER_FIELD_NUMBER 
 
Field Value
Type
Description
int

UNLIMITED_END_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 UNLIMITED_END_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

UPDATE_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 UPDATE_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

Static Methods

getDefaultInstance()

  public 
  
 static 
  
 Order 
  
 getDefaultInstance 
 () 
 
Returns
Type
Description

getDescriptor()

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

newBuilder()

  public 
  
 static 
  
 Order 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type
Description

newBuilder(Order prototype)

  public 
  
 static 
  
 Order 
 . 
 Builder 
  
 newBuilder 
 ( 
 Order 
  
 prototype 
 ) 
 
Parameter
Name
Description
prototype
Returns
Type
Description

parseDelimitedFrom(InputStream input)

  public 
  
 static 
  
 Order 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Exceptions
Type
Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Order 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(byte[] data)

  public 
  
 static 
  
 Order 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 ) 
 
Parameter
Name
Description
data
byte []
Returns
Type
Description
Exceptions
Type
Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Order 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
byte []
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteString data)

  public 
  
 static 
  
 Order 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Order 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(CodedInputStream input)

  public 
  
 static 
  
 Order 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Exceptions
Type
Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Order 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(InputStream input)

  public 
  
 static 
  
 Order 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
Exceptions
Type
Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Order 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteBuffer data)

  public 
  
 static 
  
 Order 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
Exceptions
Type
Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Order 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
Exceptions
Type
Description

parser()

  public 
  
 static 
  
 Parser<Order> 
  
 parser 
 () 
 
Returns
Type
Description

Methods

equals(Object obj)

  public 
  
 boolean 
  
 equals 
 ( 
 Object 
  
 obj 
 ) 
 
Parameter
Name
Description
obj
Returns
Type
Description
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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The endTime.

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

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

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

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

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

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

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

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

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

The orderId.

getParserForType()

  public 
  
 Parser<Order> 
  
 getParserForType 
 () 
 
Returns
Type
Description
Overrides

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

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

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

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

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

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

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

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

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

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

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

A list containing the secondaryTraffickers.

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type
Description
int
Overrides

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

The startTime.

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

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

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

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

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

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

The updateTime.

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

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

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

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

Whether the updateTime field is set.

hashCode()

  public 
  
 int 
  
 hashCode 
 () 
 
Returns
Type
Description
int
Overrides

internalGetFieldAccessorTable()

  protected 
  
 GeneratedMessageV3 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type
Description
Overrides

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type
Description
Overrides

newBuilderForType()

  public 
  
 Order 
 . 
 Builder 
  
 newBuilderForType 
 () 
 
Returns
Type
Description

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

  protected 
  
 Order 
 . 
 Builder 
  
 newBuilderForType 
 ( 
 GeneratedMessageV3 
 . 
 BuilderParent 
  
 parent 
 ) 
 
Parameter
Name
Description
parent
Returns
Type
Description
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

  protected 
  
 Object 
  
 newInstance 
 ( 
 GeneratedMessageV3 
 . 
 UnusedPrivateParameter 
  
 unused 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
Overrides

toBuilder()

  public 
  
 Order 
 . 
 Builder 
  
 toBuilder 
 () 
 
Returns
Type
Description

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name
Description
Overrides
Exceptions
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: