Class: Google::Apis::DfareportingV2_3::OrderDocument

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_3/classes.rb,
generated/google/apis/dfareporting_v2_3/representations.rb,
generated/google/apis/dfareporting_v2_3/representations.rb

Overview

Contains properties of a DoubleClick Planning order document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ OrderDocument

Returns a new instance of OrderDocument.



7121
7122
7123
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7121

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_id ⇒ String

Account ID of this order document. Corresponds to the JSON property accountId

Returns:

  • (String) 


7034
7035
7036
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7034

def 
  @account_id
end

#advertiser_id ⇒ String

Advertiser ID of this order document. Corresponds to the JSON property advertiserId

Returns:

  • (String) 


7039
7040
7041
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7039

def advertiser_id
  @advertiser_id
end

#amended_order_document_id ⇒ String

The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved. Corresponds to the JSON property amendedOrderDocumentId

Returns:

  • (String) 


7046
7047
7048
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7046

def amended_order_document_id
  @amended_order_document_id
end

#approved_by_user_profile_ids ⇒ Array<String>

IDs of users who have approved this order document. Corresponds to the JSON property approvedByUserProfileIds

Returns:

  • (Array<String>) 


7051
7052
7053
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7051

def 
  @approved_by_user_profile_ids
end

#cancelled ⇒ Boolean Also known as: cancelled?

Whether this order document is cancelled. Corresponds to the JSON property cancelled

Returns:

  • (Boolean) 


7056
7057
7058
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7056

def cancelled
  @cancelled
end

#created_info ⇒ Google::Apis::DfareportingV2_3::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



7062
7063
7064
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7062

def created_info
  @created_info
end

#effective_date ⇒ Date

Effective date of this order document. Corresponds to the JSON property effectiveDate

Returns:

  • (Date) 


7067
7068
7069
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7067

def effective_date
  @effective_date
end

#id ⇒ String

ID of this order document. Corresponds to the JSON property id

Returns:

  • (String) 


7072
7073
7074
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7072

def id
  @id
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string " dfareporting#orderDocument". Corresponds to the JSON property kind

Returns:

  • (String) 


7078
7079
7080
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7078

def kind
  @kind
end

#last_sent_recipients ⇒ Array<String>

List of email addresses that received the last sent document. Corresponds to the JSON property lastSentRecipients

Returns:

  • (Array<String>) 


7083
7084
7085
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7083

def last_sent_recipients
  @last_sent_recipients
end

#last_sent_time ⇒ DateTime

Timestamp of the last email sent with this order document. Corresponds to the JSON property lastSentTime

Returns:

  • (DateTime) 


7088
7089
7090
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7088

def last_sent_time
  @last_sent_time
end

#order_id ⇒ String

ID of the order from which this order document is created. Corresponds to the JSON property orderId

Returns:

  • (String) 


7093
7094
7095
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7093

def order_id
  @order_id
end

#project_id ⇒ String

Project ID of this order document. Corresponds to the JSON property projectId

Returns:

  • (String) 


7098
7099
7100
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7098

def project_id
  @project_id
end

#signed ⇒ Boolean Also known as: signed?

Whether this order document has been signed. Corresponds to the JSON property signed

Returns:

  • (Boolean) 


7103
7104
7105
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7103

def signed
  @signed
end

#subaccount_id ⇒ String

Subaccount ID of this order document. Corresponds to the JSON property subaccountId

Returns:

  • (String) 


7109
7110
7111
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7109

def subaccount_id
  @subaccount_id
end

#title ⇒ String

Title of this order document. Corresponds to the JSON property title

Returns:

  • (String) 


7114
7115
7116
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7114

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


7119
7120
7121
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7119

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7126

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @amended_order_document_id = args[:amended_order_document_id] if args.key?(:amended_order_document_id)
  @approved_by_user_profile_ids = args[:approved_by_user_profile_ids] if args.key?(:approved_by_user_profile_ids)
  @cancelled = args[:cancelled] if args.key?(:cancelled)
  @created_info = args[:created_info] if args.key?(:created_info)
  @effective_date = args[:effective_date] if args.key?(:effective_date)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @last_sent_recipients = args[:last_sent_recipients] if args.key?(:last_sent_recipients)
  @last_sent_time = args[:last_sent_time] if args.key?(:last_sent_time)
  @order_id = args[:order_id] if args.key?(:order_id)
  @project_id = args[:project_id] if args.key?(:project_id)
  @signed = args[:signed] if args.key?(:signed)
  @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id)
  @title = args[:title] if args.key?(:title)
  @type = args[:type] if args.key?(:type)
end