Class: Google::Apis::DfareportingV3_4::OrderDocument

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



8515
8516
8517
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8515

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) 


8428
8429
8430
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8428

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8433
8434
8435
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8433

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) 


8440
8441
8442
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8440

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


8445
8446
8447
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8445

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) 


8450
8451
8452
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8450

def cancelled
  @cancelled
end

#created_info ⇒ Google::Apis::DfareportingV3_4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



8456
8457
8458
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8456

def created_info
  @created_info
end

#effective_date ⇒ Date

Corresponds to the JSON property effectiveDate

Returns:

  • (Date) 


8461
8462
8463
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8461

def effective_date
  @effective_date
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8466
8467
8468
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8466

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) 


8472
8473
8474
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8472

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


8477
8478
8479
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8477

def last_sent_recipients
  @last_sent_recipients
end

#last_sent_time ⇒ DateTime

Corresponds to the JSON property lastSentTime

Returns:

  • (DateTime) 


8482
8483
8484
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8482

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) 


8487
8488
8489
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8487

def order_id
  @order_id
end

#project_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8492
8493
8494
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8492

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) 


8497
8498
8499
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8497

def signed
  @signed
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8503
8504
8505
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8503

def subaccount_id
  @subaccount_id
end

#title ⇒ String

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

Returns:

  • (String) 


8508
8509
8510
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8508

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


8513
8514
8515
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8513

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8520

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