Class: Google::Apis::DfareportingV4::OrderDocument

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



8709
8710
8711
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8709

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) 


8622
8623
8624
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8622

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8627
8628
8629
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8627

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) 


8634
8635
8636
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8634

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


8639
8640
8641
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8639

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) 


8644
8645
8646
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8644

def cancelled
  @cancelled
end

#created_info ⇒ Google::Apis::DfareportingV4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



8650
8651
8652
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8650

def created_info
  @created_info
end

#effective_date ⇒ Date

Corresponds to the JSON property effectiveDate

Returns:

  • (Date) 


8655
8656
8657
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8655

def effective_date
  @effective_date
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8660
8661
8662
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8660

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) 


8666
8667
8668
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8666

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


8671
8672
8673
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8671

def last_sent_recipients
  @last_sent_recipients
end

#last_sent_time ⇒ DateTime

Corresponds to the JSON property lastSentTime

Returns:

  • (DateTime) 


8676
8677
8678
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8676

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) 


8681
8682
8683
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8681

def order_id
  @order_id
end

#project_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8686
8687
8688
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8686

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) 


8691
8692
8693
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8691

def signed
  @signed
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8697
8698
8699
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8697

def subaccount_id
  @subaccount_id
end

#title ⇒ String

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

Returns:

  • (String) 


8702
8703
8704
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8702

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


8707
8708
8709
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8707

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8714

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