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.



4973
4974
4975
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4973

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) 


4855
4856
4857
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4855

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) 


4861
4862
4863
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4861

def app_id
  @app_id
end

#audience_source ⇒ String

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

Returns:

  • (String) 


4866
4867
4868
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4866

def audience_source
  @audience_source
end

#audience_type ⇒ String

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

Returns:

  • (String) 


4871
4872
4873
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4871

def audience_type
  @audience_type
end

#contact_info_list ⇒ Google::Apis::DisplayvideoV1::ContactInfoList

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

Returns:



4877
4878
4879
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4877

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) 


4883
4884
4885
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4883

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) 


4891
4892
4893
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4891

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) 


4900
4901
4902
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4900

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) 


4909
4910
4911
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4909

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) 


4918
4919
4920
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4918

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) 


4923
4924
4925
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4923

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) 


4929
4930
4931
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4929

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) 


4934
4935
4936
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4934

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) 


4942
4943
4944
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4942

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) 


4952
4953
4954
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4952

def membership_duration_days
  @membership_duration_days
end

#mobile_device_id_list ⇒ Google::Apis::DisplayvideoV1::MobileDeviceIdList

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

Returns:



4958
4959
4960
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4958

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) 


4963
4964
4965
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4963

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) 


4971
4972
4973
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4971

def youtube_audience_size
  @youtube_audience_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 4978

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