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



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

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) 


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

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

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) 


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

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


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

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) 


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

def cancelled
  @cancelled
end

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

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



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

def created_info
  @created_info
end

#effective_date ⇒ Date

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

Returns:

  • (Date) 


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

def effective_date
  @effective_date
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

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) 


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

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


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

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) 


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

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) 


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

def order_id
  @order_id
end

#project_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

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) 


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

def signed
  @signed
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

def subaccount_id
  @subaccount_id
end

#title ⇒ String

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

Returns:

  • (String) 


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

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


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

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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