Class: Google::Apis::DfareportingV3_5::OrderDocument

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

Overview

Contains properties of a Planning order document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrderDocument

Returns a new instance of OrderDocument.



8163
8164
8165
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8163

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

Instance Attribute Details

#account_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8076
8077
8078
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8076

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8081
8082
8083
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8081

def advertiser_id
  @advertiser_id
end

#amended_order_document_id ⇒ Fixnum

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:

  • (Fixnum) 


8088
8089
8090
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8088

def amended_order_document_id
  @amended_order_document_id
end

#approved_by_user_profile_ids ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


8093
8094
8095
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8093

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) 


8098
8099
8100
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8098

def cancelled
  @cancelled
end

#created_info ⇒ Google::Apis::DfareportingV3_5::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



8104
8105
8106
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8104

def created_info
  @created_info
end

#effective_date ⇒ Date

Corresponds to the JSON property effectiveDate

Returns:

  • (Date) 


8109
8110
8111
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8109

def effective_date
  @effective_date
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8114
8115
8116
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8114

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) 


8120
8121
8122
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8120

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>) 


8125
8126
8127
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8125

def last_sent_recipients
  @last_sent_recipients
end

#last_sent_time ⇒ DateTime

Corresponds to the JSON property lastSentTime

Returns:

  • (DateTime) 


8130
8131
8132
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8130

def last_sent_time
  @last_sent_time
end

#order_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8135
8136
8137
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8135

def order_id
  @order_id
end

#project_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8140
8141
8142
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8140

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) 


8145
8146
8147
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8145

def signed
  @signed
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8151
8152
8153
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8151

def subaccount_id
  @subaccount_id
end

#title ⇒ String

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

Returns:

  • (String) 


8156
8157
8158
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8156

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


8161
8162
8163
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8161

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 8168

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