Class: Google::Apis::DisplayvideoV1::CampaignBudget

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



2089
2090
2091
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 2089

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

Instance Attribute Details

#budget_amount_micros ⇒ Fixnum

Required. The budget amount the insertion order will spend for the given date_range. 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) 


2040
2041
2042
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 2040

def budget_amount_micros
  @budget_amount_micros
end

#budget_id ⇒ Fixnum

The unique ID of the campaign budget. If not included, budget is assumed to be new. Corresponds to the JSON property budgetId

Returns:

  • (Fixnum) 


2046
2047
2048
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 2046

def budget_id
  @budget_id
end

#budget_unit ⇒ String

Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. Corresponds to the JSON property budgetUnit

Returns:

  • (String) 


2052
2053
2054
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 2052

def budget_unit
  @budget_unit
end

#date_range ⇒ Google::Apis::DisplayvideoV1::DateRange

A date range. Corresponds to the JSON property dateRange

Returns:



2057
2058
2059
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 2057

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) 


2063
2064
2065
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 2063

def display_name
  @display_name
end

#external_budget_id ⇒ String

Immutable. Must be unique under the campaign. If set, all impressions served against this budget will include this ID on the invoice if the customer has opted into budget-segment-level billing. Corresponds to the JSON property externalBudgetId

Returns:

  • (String) 


2070
2071
2072
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 2070

def external_budget_id
  @external_budget_id
end

#external_budget_source ⇒ String

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

Returns:

  • (String) 


2075
2076
2077
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 2075

def external_budget_source
  @external_budget_source
end

#invoice_grouping_id ⇒ String

Immutable. If set, all external_budget_id sharing the same invoice_grouping_id will include this ID on the invoice if the customer has opted into budget- segment-level billing. Corresponds to the JSON property invoiceGroupingId

Returns:

  • (String) 


2082
2083
2084
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 2082

def invoice_grouping_id
  @invoice_grouping_id
end

#prisma_config ⇒ Google::Apis::DisplayvideoV1::PrismaConfig

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

Returns:



2087
2088
2089
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 2087

def prisma_config
  @prisma_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 2094

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