Class: Google::Apis::DisplayvideoV1::Campaign

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

Overview

A single campaign.

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

Returns a new instance of Campaign.



1380
1381
1382
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 1380

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

Instance Attribute Details

#advertiser_idFixnum

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

Returns:

  • (Fixnum)


1329
1330
1331
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 1329

def advertiser_id
  @advertiser_id
end

#campaign_flightGoogle::Apis::DisplayvideoV1::CampaignFlight

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



1334
1335
1336
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 1334

def campaign_flight
  @campaign_flight
end

#campaign_goalGoogle::Apis::DisplayvideoV1::CampaignGoal

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



1339
1340
1341
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 1339

def campaign_goal
  @campaign_goal
end

#campaign_idFixnum

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

Returns:

  • (Fixnum)


1344
1345
1346
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 1344

def campaign_id
  @campaign_id
end

#display_nameString

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)


1350
1351
1352
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 1350

def display_name
  @display_name
end

#entity_statusString

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)


1361
1362
1363
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 1361

def entity_status
  @entity_status
end

#frequency_capGoogle::Apis::DisplayvideoV1::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



1367
1368
1369
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 1367

def frequency_cap
  @frequency_cap
end

#nameString

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

Returns:

  • (String)


1372
1373
1374
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 1372

def name
  @name
end

#update_timeString

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

Returns:

  • (String)


1378
1379
1380
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 1378

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 1385

def update!(**args)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @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