Class: Google::Apis::DfareportingV2_5::OrderDocument

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_5/classes.rb,
generated/google/apis/dfareporting_v2_5/representations.rb,
generated/google/apis/dfareporting_v2_5/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.



7506
7507
7508
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7506

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) 


7419
7420
7421
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7419

def 
  @account_id
end

#advertiser_id ⇒ String

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

Returns:

  • (String) 


7424
7425
7426
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7424

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) 


7431
7432
7433
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7431

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


7436
7437
7438
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7436

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) 


7441
7442
7443
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7441

def cancelled
  @cancelled
end

#created_info ⇒ Google::Apis::DfareportingV2_5::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



7447
7448
7449
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7447

def created_info
  @created_info
end

#effective_date ⇒ Date

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

Returns:

  • (Date) 


7452
7453
7454
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7452

def effective_date
  @effective_date
end

#id ⇒ String

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

Returns:

  • (String) 


7457
7458
7459
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7457

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) 


7463
7464
7465
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7463

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


7468
7469
7470
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7468

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) 


7473
7474
7475
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7473

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) 


7478
7479
7480
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7478

def order_id
  @order_id
end

#project_id ⇒ String

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

Returns:

  • (String) 


7483
7484
7485
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7483

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) 


7488
7489
7490
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7488

def signed
  @signed
end

#subaccount_id ⇒ String

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

Returns:

  • (String) 


7494
7495
7496
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7494

def subaccount_id
  @subaccount_id
end

#title ⇒ String

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

Returns:

  • (String) 


7499
7500
7501
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7499

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


7504
7505
7506
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7504

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7511

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