Class: Google::Apis::DfareportingV2_8::OrderDocument

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



7866
7867
7868
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7866

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) 


7779
7780
7781
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7779

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7784
7785
7786
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7784

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) 


7791
7792
7793
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7791

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


7796
7797
7798
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7796

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) 


7801
7802
7803
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7801

def cancelled
  @cancelled
end

#created_info ⇒ Google::Apis::DfareportingV2_8::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



7807
7808
7809
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7807

def created_info
  @created_info
end

#effective_date ⇒ Date

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

Returns:

  • (Date) 


7812
7813
7814
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7812

def effective_date
  @effective_date
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7817
7818
7819
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7817

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) 


7823
7824
7825
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7823

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


7828
7829
7830
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7828

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) 


7833
7834
7835
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7833

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) 


7838
7839
7840
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7838

def order_id
  @order_id
end

#project_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7843
7844
7845
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7843

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) 


7848
7849
7850
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7848

def signed
  @signed
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7854
7855
7856
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7854

def subaccount_id
  @subaccount_id
end

#title ⇒ String

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

Returns:

  • (String) 


7859
7860
7861
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7859

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


7864
7865
7866
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7864

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 7871

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