Class: Google::Apis::DisplayvideoV3::Advertiser

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 advertiser in Display & Video 360 (DV360).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Advertiser

Returns a new instance of Advertiser.



517
518
519
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 517

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

Instance Attribute Details

#ad_server_config ⇒ Google::Apis::DisplayvideoV3::AdvertiserAdServerConfig

Ad server related settings of an advertiser. Corresponds to the JSON property adServerConfig

Returns:



437
438
439
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 437

def ad_server_config
  @ad_server_config
end

#advertiser_id ⇒ Fixnum

Output only. The unique ID of the advertiser. Assigned by the system. Corresponds to the JSON property advertiserId

Returns:

  • (Fixnum) 


442
443
444
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 442

def advertiser_id
  @advertiser_id
end

#billing_config ⇒ Google::Apis::DisplayvideoV3::AdvertiserBillingConfig

Billing related settings of an advertiser. Corresponds to the JSON property billingConfig

Returns:



447
448
449
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 447

def billing_config
  @billing_config
end

#creative_config ⇒ Google::Apis::DisplayvideoV3::AdvertiserCreativeConfig

Creatives related settings of an advertiser. Corresponds to the JSON property creativeConfig

Returns:



452
453
454
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 452

def creative_config
  @creative_config
end

#data_access_config ⇒ Google::Apis::DisplayvideoV3::AdvertiserDataAccessConfig

Settings that control how advertiser related data may be accessed. Corresponds to the JSON property dataAccessConfig

Returns:



457
458
459
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 457

def data_access_config
  @data_access_config
end

#display_name ⇒ String

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

Returns:

  • (String) 


463
464
465
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 463

def display_name
  @display_name
end

#entity_status ⇒ String

Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are ENTITY_STATUS_ACTIVE, ENTITY_STATUS_PAUSED and ENTITY_STATUS_SCHEDULED_FOR_DELETION. * If set to ENTITY_STATUS_SCHEDULED_FOR_DELETION, the advertiser will be deleted 30 days from when it was first scheduled for deletion. Corresponds to the JSON property entityStatus

Returns:

  • (String) 


473
474
475
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 473

def entity_status
  @entity_status
end

#general_config ⇒ Google::Apis::DisplayvideoV3::AdvertiserGeneralConfig

General settings of an advertiser. Corresponds to the JSON property generalConfig

Returns:



478
479
480
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 478

def general_config
  @general_config
end

#integration_details ⇒ Google::Apis::DisplayvideoV3::IntegrationDetails

Integration details of an entry. Corresponds to the JSON property integrationDetails

Returns:



483
484
485
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 483

def integration_details
  @integration_details
end

#name ⇒ String

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

Returns:

  • (String) 


488
489
490
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 488

def name
  @name
end

#partner_id ⇒ Fixnum

Required. Immutable. The unique ID of the partner that the advertiser belongs to. Corresponds to the JSON property partnerId

Returns:

  • (Fixnum) 


494
495
496
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 494

def partner_id
  @partner_id
end

#prisma_enabled ⇒ Boolean Also known as: prisma_enabled?

Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean ( Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. Corresponds to the JSON property prismaEnabled

Returns:

  • (Boolean) 


503
504
505
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 503

def prisma_enabled
  @prisma_enabled
end

#serving_config ⇒ Google::Apis::DisplayvideoV3::AdvertiserTargetingConfig

Targeting settings related to ad serving of an advertiser. Corresponds to the JSON property servingConfig

Returns:



509
510
511
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 509

def serving_config
  @serving_config
end

#update_time ⇒ String

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

Returns:

  • (String) 


515
516
517
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 515

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 522

def update!(**args)
  @ad_server_config = args[:ad_server_config] if args.key?(:ad_server_config)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @billing_config = args[:billing_config] if args.key?(:billing_config)
  @creative_config = args[:creative_config] if args.key?(:creative_config)
  @data_access_config = args[:data_access_config] if args.key?(:data_access_config)
  @display_name = args[:display_name] if args.key?(:display_name)
  @entity_status = args[:entity_status] if args.key?(:entity_status)
  @general_config = args[:general_config] if args.key?(:general_config)
  @integration_details = args[:integration_details] if args.key?(:integration_details)
  @name = args[:name] if args.key?(:name)
  @partner_id = args[:partner_id] if args.key?(:partner_id)
  @prisma_enabled = args[:prisma_enabled] if args.key?(:prisma_enabled)
  @serving_config = args[:serving_config] if args.key?(:serving_config)
  @update_time = args[:update_time] if args.key?(:update_time)
end