Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonAudienceInsightsAttributeMetadata

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

Overview

An audience attribute, with metadata about it, returned in response to a search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23CommonAudienceInsightsAttributeMetadata

Returns a new instance of GoogleAdsSearchads360V23CommonAudienceInsightsAttributeMetadata.



1740
1741
1742
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1740

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

Instance Attribute Details

#attribute ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonAudienceInsightsAttribute

An audience attribute that can be used to request insights about the audience. Corresponds to the JSON property attribute

Returns:



1665
1666
1667
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1665

def attribute
  @attribute
end

#dimension ⇒ String

The type of the attribute. Corresponds to the JSON property dimension

Returns:

  • (String) 


1670
1671
1672
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1670

def dimension
  @dimension
end

#display_info ⇒ String

A string that supplements the display_name to identify the attribute. If the dimension is TOPIC, this is a brief description of the Knowledge Graph entity, such as "American singer-songwriter". If the dimension is CATEGORY, this is the complete path to the category in The Product & Service taxonomy, for example "/Apparel/Clothing/Outerwear". Corresponds to the JSON property displayInfo

Returns:

  • (String) 


1679
1680
1681
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1679

def display_info
  @display_info
end

#display_name ⇒ String

The human-readable name of the attribute. Corresponds to the JSON property displayName

Returns:

  • (String) 


1684
1685
1686
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1684

def display_name
  @display_name
end

#knowledge_graph_attribute_metadata ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonKnowledgeGraphAttributeMetadata

Metadata associated with a Knowledge Graph Entity attribute. Corresponds to the JSON property knowledgeGraphAttributeMetadata

Returns:



1689
1690
1691
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1689

def knowledge_graph_attribute_metadata
  @knowledge_graph_attribute_metadata
end

#lineup_attribute_metadata ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonLineupAttributeMetadata

Metadata associated with a Lineup attribute. Corresponds to the JSON property lineupAttributeMetadata

Returns:



1694
1695
1696
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1694

def lineup_attribute_metadata
  @lineup_attribute_metadata
end

#location_attribute_metadata ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonLocationAttributeMetadata

Metadata associated with a Location attribute. Corresponds to the JSON property locationAttributeMetadata

Returns:



1699
1700
1701
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1699

def location_attribute_metadata
  @location_attribute_metadata
end

#potential_youtube_reach ⇒ Fixnum

An estimate of the number of reachable YouTube users matching this attribute in the requested location, or zero if that information is not available for this attribute. This field is not populated in every response. Corresponds to the JSON property potentialYoutubeReach

Returns:

  • (Fixnum) 


1706
1707
1708
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1706

def potential_youtube_reach
  @potential_youtube_reach
end

#subscriber_share ⇒ Float

The share of subscribers within this attribute, between and including 0 and 1. This field is not populated in every response. Corresponds to the JSON property subscriberShare

Returns:

  • (Float) 


1712
1713
1714
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1712

def subscriber_share
  @subscriber_share
end

#user_interest_attribute_metadata ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonUserInterestAttributeMetadata

Metadata associated with a User Interest attribute. Corresponds to the JSON property userInterestAttributeMetadata

Returns:



1717
1718
1719
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1717

def user_interest_attribute_metadata
  @user_interest_attribute_metadata
end

#user_list_attribute_metadata ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonUserListAttributeMetadata

Metadata associated with a User List attribute. Corresponds to the JSON property userListAttributeMetadata

Returns:



1722
1723
1724
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1722

def user_list_attribute_metadata
  @user_list_attribute_metadata
end

#viewer_share ⇒ Float

The share of viewers within this attribute, between and including 0 and 1. This field is not populated in every response. Corresponds to the JSON property viewerShare

Returns:

  • (Float) 


1728
1729
1730
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1728

def viewer_share
  @viewer_share
end

#youtube_channel_metadata ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonYouTubeChannelAttributeMetadata

Metadata associated with a YouTube channel attribute. Corresponds to the JSON property youtubeChannelMetadata

Returns:



1733
1734
1735
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1733

def youtube_channel_metadata
  @youtube_channel_metadata
end

#youtube_video_metadata ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonYouTubeVideoAttributeMetadata

Metadata for a YouTube video attribute. Corresponds to the JSON property youtubeVideoMetadata

Returns:



1738
1739
1740
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1738

def youtube_video_metadata
  @youtube_video_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 1745

def update!(**args)
  @attribute = args[:attribute] if args.key?(:attribute)
  @dimension = args[:dimension] if args.key?(:dimension)
  @display_info = args[:display_info] if args.key?(:display_info)
  @display_name = args[:display_name] if args.key?(:display_name)
  @knowledge_graph_attribute_metadata = args[:knowledge_graph_attribute_metadata] if args.key?(:knowledge_graph_attribute_metadata)
  @lineup_attribute_metadata = args[:lineup_attribute_metadata] if args.key?(:lineup_attribute_metadata)
  @location_attribute_metadata = args[:location_attribute_metadata] if args.key?(:location_attribute_metadata)
  @potential_youtube_reach = args[:potential_youtube_reach] if args.key?(:potential_youtube_reach)
  @subscriber_share = args[:subscriber_share] if args.key?(:subscriber_share)
  @user_interest_attribute_metadata = args[:user_interest_attribute_metadata] if args.key?(:user_interest_attribute_metadata)
  @user_list_attribute_metadata = args[:user_list_attribute_metadata] if args.key?(:user_list_attribute_metadata)
  @viewer_share = args[:viewer_share] if args.key?(:viewer_share)
  @youtube_channel_metadata = args[:youtube_channel_metadata] if args.key?(:youtube_channel_metadata)
  @youtube_video_metadata = args[:youtube_video_metadata] if args.key?(:youtube_video_metadata)
end