Class: Google::Apis::DfareportingV3_2::OrderDocument

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



8110
8111
8112
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8110

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) 


8023
8024
8025
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8023

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8028
8029
8030
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8028

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) 


8035
8036
8037
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8035

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


8040
8041
8042
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8040

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) 


8045
8046
8047
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8045

def cancelled
  @cancelled
end

#created_info ⇒ Google::Apis::DfareportingV3_2::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



8051
8052
8053
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8051

def created_info
  @created_info
end

#effective_date ⇒ Date

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

Returns:

  • (Date) 


8056
8057
8058
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8056

def effective_date
  @effective_date
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8061
8062
8063
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8061

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) 


8067
8068
8069
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8067

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


8072
8073
8074
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8072

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) 


8077
8078
8079
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8077

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) 


8082
8083
8084
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8082

def order_id
  @order_id
end

#project_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8087
8088
8089
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8087

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) 


8092
8093
8094
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8092

def signed
  @signed
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8098
8099
8100
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8098

def subaccount_id
  @subaccount_id
end

#title ⇒ String

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

Returns:

  • (String) 


8103
8104
8105
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8103

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


8108
8109
8110
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8108

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8115

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