Class: Google::Apis::DisplayvideoV2::FirstAndThirdPartyAudience

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

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.



5217
5218
5219
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5217

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

Instance Attribute Details

#active_display_audience_size ⇒ Fixnum

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) 


5099
5100
5101
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5099

def active_display_audience_size
  @active_display_audience_size
end

#app_id ⇒ String

The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type CUSTOMER_MATCH_DEVICE_ID Corresponds to the JSON property appId

Returns:

  • (String) 


5105
5106
5107
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5105

def app_id
  @app_id
end

#audience_source ⇒ String

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

Returns:

  • (String) 


5110
5111
5112
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5110

def audience_source
  @audience_source
end

#audience_type ⇒ String

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

Returns:

  • (String) 


5115
5116
5117
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5115

def audience_type
  @audience_type
end

#contact_info_list ⇒ Google::Apis::DisplayvideoV2::ContactInfoList

Wrapper message for a list of contact information defining Customer Match audience members. Corresponds to the JSON property contactInfoList

Returns:



5121
5122
5123
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5121

def contact_info_list
  @contact_info_list
end

#description ⇒ String

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

Returns:

  • (String) 


5127
5128
5129
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5127

def description
  @description
end

#display_audience_size ⇒ Fixnum

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) 


5135
5136
5137
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5135

def display_audience_size
  @display_audience_size
end

#display_desktop_audience_size ⇒ Fixnum

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) 


5144
5145
5146
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5144

def display_desktop_audience_size
  @display_desktop_audience_size
end

#display_mobile_app_audience_size ⇒ Fixnum

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) 


5153
5154
5155
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5153

def display_mobile_app_audience_size
  @display_mobile_app_audience_size
end

#display_mobile_web_audience_size ⇒ Fixnum

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) 


5162
5163
5164
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5162

def display_mobile_web_audience_size
  @display_mobile_web_audience_size
end

#display_name ⇒ String

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

Returns:

  • (String) 


5167
5168
5169
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5167

def display_name
  @display_name
end

#first_and_third_party_audience_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5173
5174
5175
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5173

def first_and_third_party_audience_id
  @first_and_third_party_audience_id
end

#first_and_third_party_audience_type ⇒ String

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

Returns:

  • (String) 


5178
5179
5180
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5178

def first_and_third_party_audience_type
  @first_and_third_party_audience_type
end

#gmail_audience_size ⇒ Fixnum

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) 


5186
5187
5188
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5186

def gmail_audience_size
  @gmail_audience_size
end

#membership_duration_days ⇒ Fixnum

The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID Corresponds to the JSON property membershipDurationDays

Returns:

  • (Fixnum) 


5196
5197
5198
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5196

def membership_duration_days
  @membership_duration_days
end

#mobile_device_id_list ⇒ Google::Apis::DisplayvideoV2::MobileDeviceIdList

Wrapper message for a list of mobile device IDs defining Customer Match audience members. Corresponds to the JSON property mobileDeviceIdList

Returns:



5202
5203
5204
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5202

def mobile_device_id_list
  @mobile_device_id_list
end

#name ⇒ String

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

Returns:

  • (String) 


5207
5208
5209
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5207

def name
  @name
end

#youtube_audience_size ⇒ Fixnum

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) 


5215
5216
5217
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5215

def youtube_audience_size
  @youtube_audience_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5222

def update!(**args)
  @active_display_audience_size = args[:active_display_audience_size] if args.key?(:active_display_audience_size)
  @app_id = args[:app_id] if args.key?(:app_id)
  @audience_source = args[:audience_source] if args.key?(:audience_source)
  @audience_type = args[:audience_type] if args.key?(:audience_type)
  @contact_info_list = args[:contact_info_list] if args.key?(:contact_info_list)
  @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)
  @mobile_device_id_list = args[:mobile_device_id_list] if args.key?(:mobile_device_id_list)
  @name = args[:name] if args.key?(:name)
  @youtube_audience_size = args[:youtube_audience_size] if args.key?(:youtube_audience_size)
end