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.



1193
1194
1195
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1193

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:



1102
1103
1104
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1102

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) 


1107
1108
1109
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1107

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:



1112
1113
1114
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1112

def billing_config
  @billing_config
end

#contains_eu_political_ads ⇒ String

Optional. Whether this advertiser contains line items that serve European Union political ads. If this field is set to DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING, then the following will happen: * Any new line items created under this advertiser will be assigned DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING if not otherwise specified. * Any existing line items under this advertiser that do not have a set value be updated to DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING within a day. Corresponds to the JSON property containsEuPoliticalAds

Returns:

  • (String) 


1123
1124
1125
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1123

def contains_eu_political_ads
  @contains_eu_political_ads
end

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

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

Returns:



1128
1129
1130
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1128

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:



1133
1134
1135
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1133

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) 


1139
1140
1141
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1139

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) 


1149
1150
1151
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1149

def entity_status
  @entity_status
end

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

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

Returns:



1154
1155
1156
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1154

def general_config
  @general_config
end

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

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

Returns:



1159
1160
1161
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1159

def integration_details
  @integration_details
end

#name ⇒ String

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

Returns:

  • (String) 


1164
1165
1166
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1164

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) 


1170
1171
1172
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1170

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) 


1179
1180
1181
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1179

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:



1185
1186
1187
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1185

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) 


1191
1192
1193
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1191

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 1198

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)
  @contains_eu_political_ads = args[:contains_eu_political_ads] if args.key?(:contains_eu_political_ads)
  @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