Class: Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience
- Inherits:
-
Object
- Object
- Google::Apis::DisplayvideoV3::FirstAndThirdPartyAudience
- 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
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
-
#active_display_audience_size ⇒ Fixnum
Output only.
-
#app_id ⇒ String
The app_id matches with the type of the mobile_device_ids being uploaded.
-
#audience_source ⇒ String
Output only.
-
#audience_type ⇒ String
The type of the audience.
-
#contact_info_list ⇒ Google::Apis::DisplayvideoV3::ContactInfoList
Wrapper message for a list of contact information defining Customer Match audience members.
-
#description ⇒ String
The user-provided description of the audience.
-
#display_audience_size ⇒ Fixnum
Output only.
-
#display_desktop_audience_size ⇒ Fixnum
Output only.
-
#display_mobile_app_audience_size ⇒ Fixnum
Output only.
-
#display_mobile_web_audience_size ⇒ Fixnum
Output only.
-
#display_name ⇒ String
The display name of the first and third party audience.
-
#first_and_third_party_audience_id ⇒ Fixnum
Output only.
-
#first_and_third_party_audience_type ⇒ String
Whether the audience is a first or third party audience.
-
#gmail_audience_size ⇒ Fixnum
Output only.
-
#membership_duration_days ⇒ Fixnum
The duration in days that an entry remains in the audience after the qualifying event.
-
#mobile_device_id_list ⇒ Google::Apis::DisplayvideoV3::MobileDeviceIdList
Wrapper message for a list of mobile device IDs defining Customer Match audience members.
-
#name ⇒ String
Output only.
-
#youtube_audience_size ⇒ Fixnum
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ FirstAndThirdPartyAudience
constructor
A new instance of FirstAndThirdPartyAudience.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ FirstAndThirdPartyAudience
Returns a new instance of FirstAndThirdPartyAudience.
6160 6161 6162 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6160 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
6042 6043 6044 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6042 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
6048 6049 6050 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6048 def app_id @app_id end |
#audience_source ⇒ String
Output only. The source of the audience.
Corresponds to the JSON property audienceSource
6053 6054 6055 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6053 def audience_source @audience_source end |
#audience_type ⇒ String
The type of the audience.
Corresponds to the JSON property audienceType
6058 6059 6060 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6058 def audience_type @audience_type end |
#contact_info_list ⇒ Google::Apis::DisplayvideoV3::ContactInfoList
Wrapper message for a list of contact information defining Customer Match
audience members.
Corresponds to the JSON property contactInfoList
6064 6065 6066 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6064 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
6070 6071 6072 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6070 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
6078 6079 6080 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6078 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
6087 6088 6089 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6087 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
6096 6097 6098 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6096 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
6105 6106 6107 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6105 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
6110 6111 6112 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6110 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
6116 6117 6118 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6116 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
6121 6122 6123 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6121 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
6129 6130 6131 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6129 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
6139 6140 6141 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6139 def membership_duration_days @membership_duration_days end |
#mobile_device_id_list ⇒ Google::Apis::DisplayvideoV3::MobileDeviceIdList
Wrapper message for a list of mobile device IDs defining Customer Match
audience members.
Corresponds to the JSON property mobileDeviceIdList
6145 6146 6147 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6145 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
6150 6151 6152 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6150 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
6158 6159 6160 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6158 def youtube_audience_size @youtube_audience_size end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6165 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 |