Class: Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudience

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

Overview

Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FirstAndThirdPartyAudience

Returns a new instance of FirstAndThirdPartyAudience.



4425
4426
4427
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4425

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

Instance Attribute Details

#active_display_audience_sizeFixnum

Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request. Corresponds to the JSON property activeDisplayAudienceSize

Returns:

  • (Fixnum)


4329
4330
4331
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4329

def active_display_audience_size
  @active_display_audience_size
end

#audience_sourceString

Output only. The source of the audience. Corresponds to the JSON property audienceSource

Returns:

  • (String)


4334
4335
4336
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4334

def audience_source
  @audience_source
end

#audience_typeString

Output only. The type of the audience. Corresponds to the JSON property audienceType

Returns:

  • (String)


4339
4340
4341
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4339

def audience_type
  @audience_type
end

#descriptionString

The user-provided description of the audience. Only applicable to first party audiences. Corresponds to the JSON property description

Returns:

  • (String)


4345
4346
4347
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4345

def description
  @description
end

#display_audience_sizeFixnum

Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request. Corresponds to the JSON property displayAudienceSize

Returns:

  • (Fixnum)


4353
4354
4355
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4353

def display_audience_size
  @display_audience_size
end

#display_desktop_audience_sizeFixnum

Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. Corresponds to the JSON property displayDesktopAudienceSize

Returns:

  • (Fixnum)


4362
4363
4364
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4362

def display_desktop_audience_size
  @display_desktop_audience_size
end

#display_mobile_app_audience_sizeFixnum

Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. Corresponds to the JSON property displayMobileAppAudienceSize

Returns:

  • (Fixnum)


4371
4372
4373
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4371

def display_mobile_app_audience_size
  @display_mobile_app_audience_size
end

#display_mobile_web_audience_sizeFixnum

Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. Corresponds to the JSON property displayMobileWebAudienceSize

Returns:

  • (Fixnum)


4380
4381
4382
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4380

def display_mobile_web_audience_size
  @display_mobile_web_audience_size
end

#display_nameString

The display name of the first and third party audience. Corresponds to the JSON property displayName

Returns:

  • (String)


4385
4386
4387
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4385

def display_name
  @display_name
end

#first_and_third_party_audience_idFixnum

Output only. The unique ID of the first and third party audience. Assigned by the system. Corresponds to the JSON property firstAndThirdPartyAudienceId

Returns:

  • (Fixnum)


4391
4392
4393
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4391

def first_and_third_party_audience_id
  @first_and_third_party_audience_id
end

#first_and_third_party_audience_typeString

Output only. Whether the audience is a first or third party audience. Corresponds to the JSON property firstAndThirdPartyAudienceType

Returns:

  • (String)


4396
4397
4398
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4396

def first_and_third_party_audience_type
  @first_and_third_party_audience_type
end

#gmail_audience_sizeFixnum

Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. Corresponds to the JSON property gmailAudienceSize

Returns:

  • (Fixnum)


4404
4405
4406
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4404

def gmail_audience_size
  @gmail_audience_size
end

#membership_duration_daysFixnum

The duration in days that an entry remains in the audience after the qualifying event. Only applicable to first party audiences. Corresponds to the JSON property membershipDurationDays

Returns:

  • (Fixnum)


4410
4411
4412
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4410

def membership_duration_days
  @membership_duration_days
end

#nameString

Output only. The resource name of the first and third party audience. Corresponds to the JSON property name

Returns:

  • (String)


4415
4416
4417
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4415

def name
  @name
end

#youtube_audience_sizeFixnum

Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request. Corresponds to the JSON property youtubeAudienceSize

Returns:

  • (Fixnum)


4423
4424
4425
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4423

def youtube_audience_size
  @youtube_audience_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4430

def update!(**args)
  @active_display_audience_size = args[:active_display_audience_size] if args.key?(:active_display_audience_size)
  @audience_source = args[:audience_source] if args.key?(:audience_source)
  @audience_type = args[:audience_type] if args.key?(:audience_type)
  @description = args[:description] if args.key?(:description)
  @display_audience_size = args[:display_audience_size] if args.key?(:display_audience_size)
  @display_desktop_audience_size = args[:display_desktop_audience_size] if args.key?(:display_desktop_audience_size)
  @display_mobile_app_audience_size = args[:display_mobile_app_audience_size] if args.key?(:display_mobile_app_audience_size)
  @display_mobile_web_audience_size = args[:display_mobile_web_audience_size] if args.key?(:display_mobile_web_audience_size)
  @display_name = args[:display_name] if args.key?(:display_name)
  @first_and_third_party_audience_id = args[:first_and_third_party_audience_id] if args.key?(:first_and_third_party_audience_id)
  @first_and_third_party_audience_type = args[:first_and_third_party_audience_type] if args.key?(:first_and_third_party_audience_type)
  @gmail_audience_size = args[:gmail_audience_size] if args.key?(:gmail_audience_size)
  @membership_duration_days = args[:membership_duration_days] if args.key?(:membership_duration_days)
  @name = args[:name] if args.key?(:name)
  @youtube_audience_size = args[:youtube_audience_size] if args.key?(:youtube_audience_size)
end