Class: Google::Apis::DfareportingV2_6::OrderDocument

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



7696
7697
7698
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7696

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) 


7609
7610
7611
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7609

def 
  @account_id
end

#advertiser_id ⇒ String

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

Returns:

  • (String) 


7614
7615
7616
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7614

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) 


7621
7622
7623
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7621

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


7626
7627
7628
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7626

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) 


7631
7632
7633
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7631

def cancelled
  @cancelled
end

#created_info ⇒ Google::Apis::DfareportingV2_6::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



7637
7638
7639
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7637

def created_info
  @created_info
end

#effective_date ⇒ Date

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

Returns:

  • (Date) 


7642
7643
7644
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7642

def effective_date
  @effective_date
end

#id ⇒ String

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

Returns:

  • (String) 


7647
7648
7649
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7647

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) 


7653
7654
7655
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7653

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


7658
7659
7660
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7658

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) 


7663
7664
7665
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7663

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) 


7668
7669
7670
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7668

def order_id
  @order_id
end

#project_id ⇒ String

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

Returns:

  • (String) 


7673
7674
7675
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7673

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) 


7678
7679
7680
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7678

def signed
  @signed
end

#subaccount_id ⇒ String

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

Returns:

  • (String) 


7684
7685
7686
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7684

def subaccount_id
  @subaccount_id
end

#title ⇒ String

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

Returns:

  • (String) 


7689
7690
7691
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7689

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


7694
7695
7696
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7694

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7701

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