com.google.ads.googleads.v18.common.AudienceInsightsAttributeMetadataOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v18 Show documentation
Stubs for GAAPI version google-ads-stubs-v18
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v18/common/audience_insights_attribute.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v18.common;

public interface AudienceInsightsAttributeMetadataOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v18.common.AudienceInsightsAttributeMetadata)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The type of the attribute.
   * 
   *
   * .google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimension = 1;
   * @return The enum numeric value on the wire for dimension.
   */
  int getDimensionValue();
  /**
   *    * The type of the attribute.
   * 
   *
   * .google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimension = 1;
   * @return The dimension.
   */
  com.google.ads.googleads.v18.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension getDimension();

  /**
   *    * The attribute itself.
   * 
   *
   * .google.ads.googleads.v18.common.AudienceInsightsAttribute attribute = 2;
   * @return Whether the attribute field is set.
   */
  boolean hasAttribute();
  /**
   *    * The attribute itself.
   * 
   *
   * .google.ads.googleads.v18.common.AudienceInsightsAttribute attribute = 2;
   * @return The attribute.
   */
  com.google.ads.googleads.v18.common.AudienceInsightsAttribute getAttribute();
  /**
   *    * The attribute itself.
   * 
   *
   * .google.ads.googleads.v18.common.AudienceInsightsAttribute attribute = 2;
   */
  com.google.ads.googleads.v18.common.AudienceInsightsAttributeOrBuilder getAttributeOrBuilder();

  /**
   *    * The human-readable name of the attribute.
   * 
   *
   * string display_name = 3;
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *    * The human-readable name of the attribute.
   * 
   *
   * string display_name = 3;
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString
      getDisplayNameBytes();

  /**
   *    * 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;
   * @return The displayInfo.
   */
  java.lang.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;
   * @return The bytes for displayInfo.
   */
  com.google.protobuf.ByteString
      getDisplayInfoBytes();

  /**
   *    * 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;
   * @return The potentialYoutubeReach.
   */
  long getPotentialYoutubeReach();

  /**
   *    * 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;
   * @return The subscriberShare.
   */
  double getSubscriberShare();

  /**
   *    * Special metadata for a YouTube channel.
   * 
   *
   * .google.ads.googleads.v18.common.YouTubeChannelAttributeMetadata youtube_channel_metadata = 5;
   * @return Whether the youtubeChannelMetadata field is set.
   */
  boolean hasYoutubeChannelMetadata();
  /**
   *    * Special metadata for a YouTube channel.
   * 
   *
   * .google.ads.googleads.v18.common.YouTubeChannelAttributeMetadata youtube_channel_metadata = 5;
   * @return The youtubeChannelMetadata.
   */
  com.google.ads.googleads.v18.common.YouTubeChannelAttributeMetadata getYoutubeChannelMetadata();
  /**
   *    * Special metadata for a YouTube channel.
   * 
   *
   * .google.ads.googleads.v18.common.YouTubeChannelAttributeMetadata youtube_channel_metadata = 5;
   */
  com.google.ads.googleads.v18.common.YouTubeChannelAttributeMetadataOrBuilder getYoutubeChannelMetadataOrBuilder();

  /**
   *    * Special metadata for a YouTube Dynamic Lineup.
   * 
   *
   * .google.ads.googleads.v18.common.DynamicLineupAttributeMetadata dynamic_attribute_metadata = 6;
   * @return Whether the dynamicAttributeMetadata field is set.
   */
  boolean hasDynamicAttributeMetadata();
  /**
   *    * Special metadata for a YouTube Dynamic Lineup.
   * 
   *
   * .google.ads.googleads.v18.common.DynamicLineupAttributeMetadata dynamic_attribute_metadata = 6;
   * @return The dynamicAttributeMetadata.
   */
  com.google.ads.googleads.v18.common.DynamicLineupAttributeMetadata getDynamicAttributeMetadata();
  /**
   *    * Special metadata for a YouTube Dynamic Lineup.
   * 
   *
   * .google.ads.googleads.v18.common.DynamicLineupAttributeMetadata dynamic_attribute_metadata = 6;
   */
  com.google.ads.googleads.v18.common.DynamicLineupAttributeMetadataOrBuilder getDynamicAttributeMetadataOrBuilder();

  /**
   *    * Special metadata for a Location.
   * 
   *
   * .google.ads.googleads.v18.common.LocationAttributeMetadata location_attribute_metadata = 7;
   * @return Whether the locationAttributeMetadata field is set.
   */
  boolean hasLocationAttributeMetadata();
  /**
   *    * Special metadata for a Location.
   * 
   *
   * .google.ads.googleads.v18.common.LocationAttributeMetadata location_attribute_metadata = 7;
   * @return The locationAttributeMetadata.
   */
  com.google.ads.googleads.v18.common.LocationAttributeMetadata getLocationAttributeMetadata();
  /**
   *    * Special metadata for a Location.
   * 
   *
   * .google.ads.googleads.v18.common.LocationAttributeMetadata location_attribute_metadata = 7;
   */
  com.google.ads.googleads.v18.common.LocationAttributeMetadataOrBuilder getLocationAttributeMetadataOrBuilder();

  com.google.ads.googleads.v18.common.AudienceInsightsAttributeMetadata.DimensionMetadataCase getDimensionMetadataCase();
}