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



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

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) 


8021
8022
8023
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8021

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8026
8027
8028
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8026

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) 


8033
8034
8035
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8033

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


8038
8039
8040
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8038

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) 


8043
8044
8045
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8043

def cancelled
  @cancelled
end

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

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



8049
8050
8051
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8049

def created_info
  @created_info
end

#effective_date ⇒ Date

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

Returns:

  • (Date) 


8054
8055
8056
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8054

def effective_date
  @effective_date
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8059
8060
8061
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8059

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) 


8065
8066
8067
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8065

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


8070
8071
8072
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8070

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) 


8075
8076
8077
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8075

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) 


8080
8081
8082
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8080

def order_id
  @order_id
end

#project_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8085
8086
8087
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8085

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) 


8090
8091
8092
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8090

def signed
  @signed
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8096
8097
8098
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8096

def subaccount_id
  @subaccount_id
end

#title ⇒ String

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

Returns:

  • (String) 


8101
8102
8103
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8101

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


8106
8107
8108
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8106

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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