Package com.google.ads.googleads.v21.common

Interface AudienceInsightsAttributeMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AudienceInsightsAttributeMetadata, AudienceInsightsAttributeMetadata.Builder
public interface AudienceInsightsAttributeMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getDimensionValue

      int getDimensionValue()
       The type of the attribute.
      .google.ads.googleads.v21.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimension = 1;
      Returns:
      The enum numeric value on the wire for dimension.

    • getDimension

      AudienceInsightsDimensionEnum.AudienceInsightsDimension getDimension()
       The type of the attribute.
      .google.ads.googleads.v21.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimension = 1;
      Returns:
      The dimension.

    • hasAttribute

      boolean hasAttribute()
       The attribute itself.
      .google.ads.googleads.v21.common.AudienceInsightsAttribute attribute = 2;
      Returns:
      Whether the attribute field is set.

    • getAttribute

      AudienceInsightsAttribute getAttribute()
       The attribute itself.
      .google.ads.googleads.v21.common.AudienceInsightsAttribute attribute = 2;
      Returns:
      The attribute.

    • getAttributeOrBuilder

      AudienceInsightsAttributeOrBuilder getAttributeOrBuilder()
       The attribute itself.
      .google.ads.googleads.v21.common.AudienceInsightsAttribute attribute = 2;

    • getDisplayName

      String getDisplayName()
       The human-readable name of the attribute.
      string display_name = 3;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       The human-readable name of the attribute.
      string display_name = 3;
      Returns:
      The bytes for displayName.

    • getDisplayInfo

      String getDisplayInfo()
       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".
      string display_info = 4;
      Returns:
      The displayInfo.

    • getDisplayInfoBytes

      com.google.protobuf.ByteString getDisplayInfoBytes()
       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".
      string display_info = 4;
      Returns:
      The bytes for displayInfo.

    • getPotentialYoutubeReach

      long getPotentialYoutubeReach()
       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.
      int64 potential_youtube_reach = 8;
      Returns:
      The potentialYoutubeReach.

    • getSubscriberShare

      double getSubscriberShare()
       The share of subscribers within this attribute, between and including 0 and
 1. This field is not populated in every response.
      double subscriber_share = 9;
      Returns:
      The subscriberShare.

    • getViewerShare

      double getViewerShare()
       The share of viewers within this attribute, between and including 0 and
 1. This field is not populated in every response.
      double viewer_share = 13;
      Returns:
      The viewerShare.

    • hasYoutubeChannelMetadata

      boolean hasYoutubeChannelMetadata()
       Special metadata for a YouTube channel.
      .google.ads.googleads.v21.common.YouTubeChannelAttributeMetadata youtube_channel_metadata = 5;
      Returns:
      Whether the youtubeChannelMetadata field is set.

    • getYoutubeChannelMetadata

      YouTubeChannelAttributeMetadata getYoutubeChannelMetadata()
       Special metadata for a YouTube channel.
      .google.ads.googleads.v21.common.YouTubeChannelAttributeMetadata youtube_channel_metadata = 5;
      Returns:
      The youtubeChannelMetadata.

    • getYoutubeChannelMetadataOrBuilder

      YouTubeChannelAttributeMetadataOrBuilder getYoutubeChannelMetadataOrBuilder()
       Special metadata for a YouTube channel.
      .google.ads.googleads.v21.common.YouTubeChannelAttributeMetadata youtube_channel_metadata = 5;

    • hasYoutubeVideoMetadata

      boolean hasYoutubeVideoMetadata()
       Special metadata for a YouTube video.
      .google.ads.googleads.v21.common.YouTubeVideoAttributeMetadata youtube_video_metadata = 10;
      Returns:
      Whether the youtubeVideoMetadata field is set.

    • getYoutubeVideoMetadata

      YouTubeVideoAttributeMetadata getYoutubeVideoMetadata()
       Special metadata for a YouTube video.
      .google.ads.googleads.v21.common.YouTubeVideoAttributeMetadata youtube_video_metadata = 10;
      Returns:
      The youtubeVideoMetadata.

    • getYoutubeVideoMetadataOrBuilder

      YouTubeVideoAttributeMetadataOrBuilder getYoutubeVideoMetadataOrBuilder()
       Special metadata for a YouTube video.
      .google.ads.googleads.v21.common.YouTubeVideoAttributeMetadata youtube_video_metadata = 10;

    • hasLineupAttributeMetadata

      boolean hasLineupAttributeMetadata()
       Special metadata for a YouTube Lineup.
      .google.ads.googleads.v21.common.LineupAttributeMetadata lineup_attribute_metadata = 14;
      Returns:
      Whether the lineupAttributeMetadata field is set.

    • getLineupAttributeMetadata

      LineupAttributeMetadata getLineupAttributeMetadata()
       Special metadata for a YouTube Lineup.
      .google.ads.googleads.v21.common.LineupAttributeMetadata lineup_attribute_metadata = 14;
      Returns:
      The lineupAttributeMetadata.

    • getLineupAttributeMetadataOrBuilder

      LineupAttributeMetadataOrBuilder getLineupAttributeMetadataOrBuilder()
       Special metadata for a YouTube Lineup.
      .google.ads.googleads.v21.common.LineupAttributeMetadata lineup_attribute_metadata = 14;

    • hasLocationAttributeMetadata

      boolean hasLocationAttributeMetadata()
       Special metadata for a Location.
      .google.ads.googleads.v21.common.LocationAttributeMetadata location_attribute_metadata = 7;
      Returns:
      Whether the locationAttributeMetadata field is set.

    • getLocationAttributeMetadata

      LocationAttributeMetadata getLocationAttributeMetadata()
       Special metadata for a Location.
      .google.ads.googleads.v21.common.LocationAttributeMetadata location_attribute_metadata = 7;
      Returns:
      The locationAttributeMetadata.

    • getLocationAttributeMetadataOrBuilder

      LocationAttributeMetadataOrBuilder getLocationAttributeMetadataOrBuilder()
       Special metadata for a Location.
      .google.ads.googleads.v21.common.LocationAttributeMetadata location_attribute_metadata = 7;

    • hasUserInterestAttributeMetadata

      boolean hasUserInterestAttributeMetadata()
       Special metadata for a User Interest.
      .google.ads.googleads.v21.common.UserInterestAttributeMetadata user_interest_attribute_metadata = 11;
      Returns:
      Whether the userInterestAttributeMetadata field is set.

    • getUserInterestAttributeMetadata

      UserInterestAttributeMetadata getUserInterestAttributeMetadata()
       Special metadata for a User Interest.
      .google.ads.googleads.v21.common.UserInterestAttributeMetadata user_interest_attribute_metadata = 11;
      Returns:
      The userInterestAttributeMetadata.

    • getUserInterestAttributeMetadataOrBuilder

      UserInterestAttributeMetadataOrBuilder getUserInterestAttributeMetadataOrBuilder()
       Special metadata for a User Interest.
      .google.ads.googleads.v21.common.UserInterestAttributeMetadata user_interest_attribute_metadata = 11;

    • hasKnowledgeGraphAttributeMetadata

      boolean hasKnowledgeGraphAttributeMetadata()
       Special metadata for a Knowledge Graph Entity.
      .google.ads.googleads.v21.common.KnowledgeGraphAttributeMetadata knowledge_graph_attribute_metadata = 12;
      Returns:
      Whether the knowledgeGraphAttributeMetadata field is set.

    • getKnowledgeGraphAttributeMetadata

      KnowledgeGraphAttributeMetadata getKnowledgeGraphAttributeMetadata()
       Special metadata for a Knowledge Graph Entity.
      .google.ads.googleads.v21.common.KnowledgeGraphAttributeMetadata knowledge_graph_attribute_metadata = 12;
      Returns:
      The knowledgeGraphAttributeMetadata.

    • getKnowledgeGraphAttributeMetadataOrBuilder

      KnowledgeGraphAttributeMetadataOrBuilder getKnowledgeGraphAttributeMetadataOrBuilder()
       Special metadata for a Knowledge Graph Entity.
      .google.ads.googleads.v21.common.KnowledgeGraphAttributeMetadata knowledge_graph_attribute_metadata = 12;

    • hasUserListAttributeMetadata

      boolean hasUserListAttributeMetadata()
       Special metadata for a User List.
      .google.ads.googleads.v21.common.UserListAttributeMetadata user_list_attribute_metadata = 15;
      Returns:
      Whether the userListAttributeMetadata field is set.

    • getUserListAttributeMetadata

      UserListAttributeMetadata getUserListAttributeMetadata()
       Special metadata for a User List.
      .google.ads.googleads.v21.common.UserListAttributeMetadata user_list_attribute_metadata = 15;
      Returns:
      The userListAttributeMetadata.

    • getUserListAttributeMetadataOrBuilder

      UserListAttributeMetadataOrBuilder getUserListAttributeMetadataOrBuilder()
       Special metadata for a User List.
      .google.ads.googleads.v21.common.UserListAttributeMetadata user_list_attribute_metadata = 15;

    • getDimensionMetadataCase

      AudienceInsightsAttributeMetadata.DimensionMetadataCase getDimensionMetadataCase()