Class: Google::Apis::DisplayvideoV2::CampaignBudget

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

Overview

Settings that control how the campaign budget is allocated.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CampaignBudget

Returns a new instance of CampaignBudget.



2624
2625
2626
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 2624

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

Instance Attribute Details

#budget_amount_micros ⇒ Fixnum

Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. Corresponds to the JSON property budgetAmountMicros

Returns:

  • (Fixnum) 


2572
2573
2574
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 2572

def budget_amount_micros
  @budget_amount_micros
end

#budget_id ⇒ Fixnum

The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned. Corresponds to the JSON property budgetId

Returns:

  • (Fixnum) 


2579
2580
2581
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 2579

def budget_id
  @budget_id
end

#budget_unit ⇒ String

Required. Immutable. Specifies whether the budget is measured in currency or impressions. Corresponds to the JSON property budgetUnit

Returns:

  • (String) 


2585
2586
2587
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 2585

def budget_unit
  @budget_unit
end

#date_range ⇒ Google::Apis::DisplayvideoV2::DateRange

A date range. Corresponds to the JSON property dateRange

Returns:



2590
2591
2592
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 2590

def date_range
  @date_range
end

#display_name ⇒ String

Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes. Corresponds to the JSON property displayName

Returns:

  • (String) 


2596
2597
2598
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 2596

def display_name
  @display_name
end

#external_budget_id ⇒ String

Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign. Corresponds to the JSON property externalBudgetId

Returns:

  • (String) 


2604
2605
2606
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 2604

def external_budget_id
  @external_budget_id
end

#external_budget_source ⇒ String

Required. The external source of the budget. Corresponds to the JSON property externalBudgetSource

Returns:

  • (String) 


2609
2610
2611
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 2609

def external_budget_source
  @external_budget_source
end

#invoice_grouping_id ⇒ String

Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice. Corresponds to the JSON property invoiceGroupingId

Returns:

  • (String) 


2617
2618
2619
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 2617

def invoice_grouping_id
  @invoice_grouping_id
end

#prisma_config ⇒ Google::Apis::DisplayvideoV2::PrismaConfig

Settings specific to the Mediaocean Prisma tool. Corresponds to the JSON property prismaConfig

Returns:



2622
2623
2624
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 2622

def prisma_config
  @prisma_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 2629

def update!(**args)
  @budget_amount_micros = args[:budget_amount_micros] if args.key?(:budget_amount_micros)
  @budget_id = args[:budget_id] if args.key?(:budget_id)
  @budget_unit = args[:budget_unit] if args.key?(:budget_unit)
  @date_range = args[:date_range] if args.key?(:date_range)
  @display_name = args[:display_name] if args.key?(:display_name)
  @external_budget_id = args[:external_budget_id] if args.key?(:external_budget_id)
  @external_budget_source = args[:external_budget_source] if args.key?(:external_budget_source)
  @invoice_grouping_id = args[:invoice_grouping_id] if args.key?(:invoice_grouping_id)
  @prisma_config = args[:prisma_config] if args.key?(:prisma_config)
end