Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesAccountBudgetProposal

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

Overview

An account-level budget proposal. All fields prefixed with 'proposed' may not necessarily be applied directly. For example, proposed spending limits may be adjusted before their application. This is true if the 'proposed' field has an 'approved' counterpart, for example, spending limits. Note that the proposal type (proposal_type) changes which fields are required and which must remain empty.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23ResourcesAccountBudgetProposal

Returns a new instance of GoogleAdsSearchads360V23ResourcesAccountBudgetProposal.



19630
19631
19632
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19630

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

Instance Attribute Details

#account_budget ⇒ String

Immutable. The resource name of the account-level budget associated with this proposal. Corresponds to the JSON property accountBudget

Returns:

  • (String) 


19508
19509
19510
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19508

def 
  @account_budget
end

#approval_date_time ⇒ String

Output only. The date time when this account-level budget was approved, if applicable. Corresponds to the JSON property approvalDateTime

Returns:

  • (String) 


19514
19515
19516
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19514

def approval_date_time
  @approval_date_time
end

#approved_end_date_time ⇒ String

Output only. The approved end date time in yyyy-mm-dd hh:mm:ss format. Corresponds to the JSON property approvedEndDateTime

Returns:

  • (String) 


19519
19520
19521
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19519

def approved_end_date_time
  @approved_end_date_time
end

#approved_end_time_type ⇒ String

Output only. The approved end date time as a well-defined type, for example, FOREVER. Corresponds to the JSON property approvedEndTimeType

Returns:

  • (String) 


19525
19526
19527
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19525

def approved_end_time_type
  @approved_end_time_type
end

#approved_spending_limit_micros ⇒ Fixnum

Output only. The approved spending limit in micros. One million is equivalent to one unit. Corresponds to the JSON property approvedSpendingLimitMicros

Returns:

  • (Fixnum) 


19531
19532
19533
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19531

def approved_spending_limit_micros
  @approved_spending_limit_micros
end

#approved_spending_limit_type ⇒ String

Output only. The approved spending limit as a well-defined type, for example, INFINITE. Corresponds to the JSON property approvedSpendingLimitType

Returns:

  • (String) 


19537
19538
19539
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19537

def approved_spending_limit_type
  @approved_spending_limit_type
end

#approved_start_date_time ⇒ String

Output only. The approved start date time in yyyy-mm-dd hh:mm:ss format. Corresponds to the JSON property approvedStartDateTime

Returns:

  • (String) 


19542
19543
19544
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19542

def approved_start_date_time
  @approved_start_date_time
end

#billing_setup ⇒ String

Immutable. The resource name of the billing setup associated with this proposal. Corresponds to the JSON property billingSetup

Returns:

  • (String) 


19548
19549
19550
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19548

def billing_setup
  @billing_setup
end

#creation_date_time ⇒ String

Output only. The date time when this account-level budget proposal was created, which is not the same as its approval date time, if applicable. Corresponds to the JSON property creationDateTime

Returns:

  • (String) 


19554
19555
19556
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19554

def creation_date_time
  @creation_date_time
end

#id ⇒ Fixnum

Output only. The ID of the proposal. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


19559
19560
19561
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19559

def id
  @id
end

#proposal_type ⇒ String

Immutable. The type of this proposal, for example, END to end the budget associated with this proposal. Corresponds to the JSON property proposalType

Returns:

  • (String) 


19565
19566
19567
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19565

def proposal_type
  @proposal_type
end

#proposed_end_date_time ⇒ String

Immutable. The proposed end date time in yyyy-mm-dd hh:mm:ss format. Corresponds to the JSON property proposedEndDateTime

Returns:

  • (String) 


19570
19571
19572
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19570

def proposed_end_date_time
  @proposed_end_date_time
end

#proposed_end_time_type ⇒ String

Immutable. The proposed end date time as a well-defined type, for example, FOREVER. Corresponds to the JSON property proposedEndTimeType

Returns:

  • (String) 


19576
19577
19578
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19576

def proposed_end_time_type
  @proposed_end_time_type
end

#proposed_name ⇒ String

Immutable. The name to assign to the account-level budget. Corresponds to the JSON property proposedName

Returns:

  • (String) 


19581
19582
19583
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19581

def proposed_name
  @proposed_name
end

#proposed_notes ⇒ String

Immutable. Notes associated with this budget. Corresponds to the JSON property proposedNotes

Returns:

  • (String) 


19586
19587
19588
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19586

def proposed_notes
  @proposed_notes
end

#proposed_purchase_order_number ⇒ String

Immutable. A purchase order number is a value that enables the user to help them reference this budget in their monthly invoices. Corresponds to the JSON property proposedPurchaseOrderNumber

Returns:

  • (String) 


19592
19593
19594
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19592

def proposed_purchase_order_number
  @proposed_purchase_order_number
end

#proposed_spending_limit_micros ⇒ Fixnum

Immutable. The proposed spending limit in micros. One million is equivalent to one unit. Corresponds to the JSON property proposedSpendingLimitMicros

Returns:

  • (Fixnum) 


19598
19599
19600
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19598

def proposed_spending_limit_micros
  @proposed_spending_limit_micros
end

#proposed_spending_limit_type ⇒ String

Immutable. The proposed spending limit as a well-defined type, for example, INFINITE. Corresponds to the JSON property proposedSpendingLimitType

Returns:

  • (String) 


19604
19605
19606
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19604

def proposed_spending_limit_type
  @proposed_spending_limit_type
end

#proposed_start_date_time ⇒ String

Immutable. The proposed start date time in yyyy-mm-dd hh:mm:ss format. Corresponds to the JSON property proposedStartDateTime

Returns:

  • (String) 


19609
19610
19611
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19609

def proposed_start_date_time
  @proposed_start_date_time
end

#proposed_start_time_type ⇒ String

Immutable. The proposed start date time as a well-defined type, for example, NOW. Corresponds to the JSON property proposedStartTimeType

Returns:

  • (String) 


19615
19616
19617
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19615

def proposed_start_time_type
  @proposed_start_time_type
end

#resource_name ⇒ String

Immutable. The resource name of the proposal. AccountBudgetProposal resource names have the form: customers/customer_id/accountBudgetProposals/ account_budget_proposal_id` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


19622
19623
19624
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19622

def resource_name
  @resource_name
end

#status ⇒ String

Output only. The status of this proposal. When a new proposal is created, the status defaults to PENDING. Corresponds to the JSON property status

Returns:

  • (String) 


19628
19629
19630
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19628

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19635
19636
19637
19638
19639
19640
19641
19642
19643
19644
19645
19646
19647
19648
19649
19650
19651
19652
19653
19654
19655
19656
19657
19658
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 19635

def update!(**args)
  @account_budget = args[:account_budget] if args.key?(:account_budget)
  @approval_date_time = args[:approval_date_time] if args.key?(:approval_date_time)
  @approved_end_date_time = args[:approved_end_date_time] if args.key?(:approved_end_date_time)
  @approved_end_time_type = args[:approved_end_time_type] if args.key?(:approved_end_time_type)
  @approved_spending_limit_micros = args[:approved_spending_limit_micros] if args.key?(:approved_spending_limit_micros)
  @approved_spending_limit_type = args[:approved_spending_limit_type] if args.key?(:approved_spending_limit_type)
  @approved_start_date_time = args[:approved_start_date_time] if args.key?(:approved_start_date_time)
  @billing_setup = args[:billing_setup] if args.key?(:billing_setup)
  @creation_date_time = args[:creation_date_time] if args.key?(:creation_date_time)
  @id = args[:id] if args.key?(:id)
  @proposal_type = args[:proposal_type] if args.key?(:proposal_type)
  @proposed_end_date_time = args[:proposed_end_date_time] if args.key?(:proposed_end_date_time)
  @proposed_end_time_type = args[:proposed_end_time_type] if args.key?(:proposed_end_time_type)
  @proposed_name = args[:proposed_name] if args.key?(:proposed_name)
  @proposed_notes = args[:proposed_notes] if args.key?(:proposed_notes)
  @proposed_purchase_order_number = args[:proposed_purchase_order_number] if args.key?(:proposed_purchase_order_number)
  @proposed_spending_limit_micros = args[:proposed_spending_limit_micros] if args.key?(:proposed_spending_limit_micros)
  @proposed_spending_limit_type = args[:proposed_spending_limit_type] if args.key?(:proposed_spending_limit_type)
  @proposed_start_date_time = args[:proposed_start_date_time] if args.key?(:proposed_start_date_time)
  @proposed_start_time_type = args[:proposed_start_time_type] if args.key?(:proposed_start_time_type)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @status = args[:status] if args.key?(:status)
end