Class: Google::Apis::DfareportingV3_1::OrderDocument

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



8074
8075
8076
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8074

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) 


7987
7988
7989
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 7987

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7992
7993
7994
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 7992

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) 


7999
8000
8001
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 7999

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


8004
8005
8006
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8004

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) 


8009
8010
8011
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8009

def cancelled
  @cancelled
end

#created_info ⇒ Google::Apis::DfareportingV3_1::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createdInfo

Returns:



8015
8016
8017
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8015

def created_info
  @created_info
end

#effective_date ⇒ Date

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

Returns:

  • (Date) 


8020
8021
8022
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8020

def effective_date
  @effective_date
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8025
8026
8027
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8025

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) 


8031
8032
8033
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8031

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


8036
8037
8038
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8036

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) 


8041
8042
8043
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8041

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) 


8046
8047
8048
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8046

def order_id
  @order_id
end

#project_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

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) 


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

def signed
  @signed
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8062
8063
8064
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8062

def subaccount_id
  @subaccount_id
end

#title ⇒ String

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

Returns:

  • (String) 


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

def title
  @title
end

#type ⇒ String

Type of this order document Corresponds to the JSON property type

Returns:

  • (String) 


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

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8079

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