Class: Google::Apis::DfareportingV2_1::OrderDocument

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

Overview

Contains properties of a DoubleClick Planning order document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ OrderDocument

Returns a new instance of OrderDocument.



7036
7037
7038
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7036

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_id ⇒ String

Account ID of this order document. Corresponds to the JSON property accountId

Returns:

  • (String) 


6959
6960
6961
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6959

def 
  @account_id
end

#advertiser_id ⇒ String

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

Returns:

  • (String) 


6964
6965
6966
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6964

def advertiser_id
  @advertiser_id
end

#amended_order_document_id ⇒ String

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:

  • (String) 


6971
6972
6973
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6971

def amended_order_document_id
  @amended_order_document_id
end

#approved_by_user_profile_ids ⇒ Array<String>

IDs of users who have approved this order document. Corresponds to the JSON property approvedByUserProfileIds

Returns:

  • (Array<String>) 


6976
6977
6978
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6976

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) 


6981
6982
6983
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6981

def cancelled
  @cancelled
end

#created_info ⇒ Google::Apis::DfareportingV2_1::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



6987
6988
6989
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6987

def created_info
  @created_info
end

#effective_date ⇒ Date

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

Returns:

  • (Date) 


6992
6993
6994
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6992

def effective_date
  @effective_date
end

#id ⇒ String

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

Returns:

  • (String) 


6997
6998
6999
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6997

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) 


7003
7004
7005
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7003

def kind
  @kind
end

#order_id ⇒ String

ID of the order from which this order document is created. Corresponds to the JSON property orderId

Returns:

  • (String) 


7008
7009
7010
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7008

def order_id
  @order_id
end

#project_id ⇒ String

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

Returns:

  • (String) 


7013
7014
7015
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7013

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) 


7018
7019
7020
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7018

def signed
  @signed
end

#subaccount_id ⇒ String

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

Returns:

  • (String) 


7024
7025
7026
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7024

def subaccount_id
  @subaccount_id
end

#title ⇒ String

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

Returns:

  • (String) 


7029
7030
7031
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7029

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


7034
7035
7036
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7034

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7041

def update!(**args)
  @account_id = args[:account_id] unless args[:account_id].nil?
  @advertiser_id = args[:advertiser_id] unless args[:advertiser_id].nil?
  @amended_order_document_id = args[:amended_order_document_id] unless args[:amended_order_document_id].nil?
  @approved_by_user_profile_ids = args[:approved_by_user_profile_ids] unless args[:approved_by_user_profile_ids].nil?
  @cancelled = args[:cancelled] unless args[:cancelled].nil?
  @created_info = args[:created_info] unless args[:created_info].nil?
  @effective_date = args[:effective_date] unless args[:effective_date].nil?
  @id = args[:id] unless args[:id].nil?
  @kind = args[:kind] unless args[:kind].nil?
  @order_id = args[:order_id] unless args[:order_id].nil?
  @project_id = args[:project_id] unless args[:project_id].nil?
  @signed = args[:signed] unless args[:signed].nil?
  @subaccount_id = args[:subaccount_id] unless args[:subaccount_id].nil?
  @title = args[:title] unless args[:title].nil?
  @type = args[:type] unless args[:type].nil?
end