Class: Google::Apis::DisplayvideoV3::Campaign

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

Overview

A single campaign.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Campaign

Returns a new instance of Campaign.



3007
3008
3009
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 3007

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

Instance Attribute Details

#advertiser_id ⇒ Fixnum

Output only. The unique ID of the advertiser the campaign belongs to. Corresponds to the JSON property advertiserId

Returns:

  • (Fixnum) 


2953
2954
2955
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 2953

def advertiser_id
  @advertiser_id
end

#campaign_budgets ⇒ Array<Google::Apis::DisplayvideoV3::CampaignBudget>

The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget. Corresponds to the JSON property campaignBudgets

Returns:



2959
2960
2961
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 2959

def campaign_budgets
  @campaign_budgets
end

#campaign_flight ⇒ Google::Apis::DisplayvideoV3::CampaignFlight

Settings that track the planned spend and duration of a campaign. Corresponds to the JSON property campaignFlight

Returns:



2964
2965
2966
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 2964

def campaign_flight
  @campaign_flight
end

#campaign_goal ⇒ Google::Apis::DisplayvideoV3::CampaignGoal

Settings that control the goal of a campaign. Corresponds to the JSON property campaignGoal

Returns:



2969
2970
2971
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 2969

def campaign_goal
  @campaign_goal
end

#campaign_id ⇒ Fixnum

Output only. The unique ID of the campaign. Assigned by the system. Corresponds to the JSON property campaignId

Returns:

  • (Fixnum) 


2974
2975
2976
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 2974

def campaign_id
  @campaign_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


2980
2981
2982
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 2980

def display_name
  @display_name
end

#entity_status ⇒ String

Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, and ENTITY_STATUS_PAUSED. * For CreateCampaign method, ENTITY_STATUS_ARCHIVED is not allowed. Corresponds to the JSON property entityStatus

Returns:

  • (String) 


2988
2989
2990
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 2988

def entity_status
  @entity_status
end

#frequency_cap ⇒ Google::Apis::DisplayvideoV3::FrequencyCap

Settings that control the number of times a user may be shown with the same ad during a given time period. Corresponds to the JSON property frequencyCap

Returns:



2994
2995
2996
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 2994

def frequency_cap
  @frequency_cap
end

#name ⇒ String

Output only. The resource name of the campaign. Corresponds to the JSON property name

Returns:

  • (String) 


2999
3000
3001
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 2999

def name
  @name
end

#update_time ⇒ String

Output only. The timestamp when the campaign was last updated. Assigned by the system. Corresponds to the JSON property updateTime

Returns:

  • (String) 


3005
3006
3007
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 3005

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 3012

def update!(**args)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @campaign_budgets = args[:campaign_budgets] if args.key?(:campaign_budgets)
  @campaign_flight = args[:campaign_flight] if args.key?(:campaign_flight)
  @campaign_goal = args[:campaign_goal] if args.key?(:campaign_goal)
  @campaign_id = args[:campaign_id] if args.key?(:campaign_id)
  @display_name = args[:display_name] if args.key?(:display_name)
  @entity_status = args[:entity_status] if args.key?(:entity_status)
  @frequency_cap = args[:frequency_cap] if args.key?(:frequency_cap)
  @name = args[:name] if args.key?(:name)
  @update_time = args[:update_time] if args.key?(:update_time)
end