Class: Google::Apis::DisplayvideoV2::Advertiser

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

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.



195
196
197
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 195

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

Instance Attribute Details

#ad_server_configGoogle::Apis::DisplayvideoV2::AdvertiserAdServerConfig

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



115
116
117
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 115

def ad_server_config
  @ad_server_config
end

#advertiser_idFixnum

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

Returns:

  • (Fixnum)


120
121
122
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 120

def advertiser_id
  @advertiser_id
end

#billing_configGoogle::Apis::DisplayvideoV2::AdvertiserBillingConfig

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



125
126
127
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 125

def billing_config
  @billing_config
end

#creative_configGoogle::Apis::DisplayvideoV2::AdvertiserCreativeConfig

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



130
131
132
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 130

def creative_config
  @creative_config
end

#data_access_configGoogle::Apis::DisplayvideoV2::AdvertiserDataAccessConfig

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



135
136
137
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 135

def data_access_config
  @data_access_config
end

#display_nameString

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)


141
142
143
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 141

def display_name
  @display_name
end

#entity_statusString

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)


151
152
153
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 151

def entity_status
  @entity_status
end

#general_configGoogle::Apis::DisplayvideoV2::AdvertiserGeneralConfig

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



156
157
158
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 156

def general_config
  @general_config
end

#integration_detailsGoogle::Apis::DisplayvideoV2::IntegrationDetails

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



161
162
163
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 161

def integration_details
  @integration_details
end

#nameString

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

Returns:

  • (String)


166
167
168
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 166

def name
  @name
end

#partner_idFixnum

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

Returns:

  • (Fixnum)


172
173
174
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 172

def partner_id
  @partner_id
end

#prisma_enabledBoolean 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)


181
182
183
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 181

def prisma_enabled
  @prisma_enabled
end

#serving_configGoogle::Apis::DisplayvideoV2::AdvertiserTargetingConfig

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



187
188
189
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 187

def serving_config
  @serving_config
end

#update_timeString

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

Returns:

  • (String)


193
194
195
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 193

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 200

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