Class: Google::Apis::DfareportingV3_3::OrderDocument

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_3/classes.rb,
generated/google/apis/dfareporting_v3_3/representations.rb,
generated/google/apis/dfareporting_v3_3/representations.rb

Overview

Contains properties of a 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



7946
7947
7948
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7946

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) 


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

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

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) 


7871
7872
7873
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7871

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


7876
7877
7878
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7876

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) 


7881
7882
7883
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7881

def cancelled
  @cancelled
end

#created_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



7887
7888
7889
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7887

def created_info
  @created_info
end

#effective_date ⇒ Date

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

Returns:

  • (Date) 


7892
7893
7894
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7892

def effective_date
  @effective_date
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7897
7898
7899
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7897

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) 


7903
7904
7905
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7903

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


7908
7909
7910
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7908

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) 


7913
7914
7915
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7913

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) 


7918
7919
7920
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7918

def order_id
  @order_id
end

#project_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7923
7924
7925
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7923

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) 


7928
7929
7930
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7928

def signed
  @signed
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7934
7935
7936
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7934

def subaccount_id
  @subaccount_id
end

#title ⇒ String

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

Returns:

  • (String) 


7939
7940
7941
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7939

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


7944
7945
7946
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7944

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 7951

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