com.google.ads.googleads.v17.common.KeywordPlanHistoricalMetricsOrBuilder Maven / Gradle / Ivy

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

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

public interface KeywordPlanHistoricalMetricsOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.common.KeywordPlanHistoricalMetrics)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Approximate number of monthly searches on this query, averaged
   * for the past 12 months.
   * 
   *
   * optional int64 avg_monthly_searches = 7;
   * @return Whether the avgMonthlySearches field is set.
   */
  boolean hasAvgMonthlySearches();
  /**
   *    * Approximate number of monthly searches on this query, averaged
   * for the past 12 months.
   * 
   *
   * optional int64 avg_monthly_searches = 7;
   * @return The avgMonthlySearches.
   */
  long getAvgMonthlySearches();

  /**
   *    * Approximate number of searches on this query for the past twelve months.
   * 
   *
   * repeated .google.ads.googleads.v17.common.MonthlySearchVolume monthly_search_volumes = 6;
   */
  java.util.List 
      getMonthlySearchVolumesList();
  /**
   *    * Approximate number of searches on this query for the past twelve months.
   * 
   *
   * repeated .google.ads.googleads.v17.common.MonthlySearchVolume monthly_search_volumes = 6;
   */
  com.google.ads.googleads.v17.common.MonthlySearchVolume getMonthlySearchVolumes(int index);
  /**
   *    * Approximate number of searches on this query for the past twelve months.
   * 
   *
   * repeated .google.ads.googleads.v17.common.MonthlySearchVolume monthly_search_volumes = 6;
   */
  int getMonthlySearchVolumesCount();
  /**
   *    * Approximate number of searches on this query for the past twelve months.
   * 
   *
   * repeated .google.ads.googleads.v17.common.MonthlySearchVolume monthly_search_volumes = 6;
   */
  java.util.List 
      getMonthlySearchVolumesOrBuilderList();
  /**
   *    * Approximate number of searches on this query for the past twelve months.
   * 
   *
   * repeated .google.ads.googleads.v17.common.MonthlySearchVolume monthly_search_volumes = 6;
   */
  com.google.ads.googleads.v17.common.MonthlySearchVolumeOrBuilder getMonthlySearchVolumesOrBuilder(
      int index);

  /**
   *    * The competition level for the query.
   * 
   *
   * .google.ads.googleads.v17.enums.KeywordPlanCompetitionLevelEnum.KeywordPlanCompetitionLevel competition = 2;
   * @return The enum numeric value on the wire for competition.
   */
  int getCompetitionValue();
  /**
   *    * The competition level for the query.
   * 
   *
   * .google.ads.googleads.v17.enums.KeywordPlanCompetitionLevelEnum.KeywordPlanCompetitionLevel competition = 2;
   * @return The competition.
   */
  com.google.ads.googleads.v17.enums.KeywordPlanCompetitionLevelEnum.KeywordPlanCompetitionLevel getCompetition();

  /**
   *    * The competition index for the query in the range [0, 100].
   * Shows how competitive ad placement is for a keyword.
   * The level of competition from 0-100 is determined by the number of ad slots
   * filled divided by the total number of ad slots available. If not enough
   * data is available, null is returned.
   * 
   *
   * optional int64 competition_index = 8;
   * @return Whether the competitionIndex field is set.
   */
  boolean hasCompetitionIndex();
  /**
   *    * The competition index for the query in the range [0, 100].
   * Shows how competitive ad placement is for a keyword.
   * The level of competition from 0-100 is determined by the number of ad slots
   * filled divided by the total number of ad slots available. If not enough
   * data is available, null is returned.
   * 
   *
   * optional int64 competition_index = 8;
   * @return The competitionIndex.
   */
  long getCompetitionIndex();

  /**
   *    * Top of page bid low range (20th percentile) in micros for the keyword.
   * 
   *
   * optional int64 low_top_of_page_bid_micros = 9;
   * @return Whether the lowTopOfPageBidMicros field is set.
   */
  boolean hasLowTopOfPageBidMicros();
  /**
   *    * Top of page bid low range (20th percentile) in micros for the keyword.
   * 
   *
   * optional int64 low_top_of_page_bid_micros = 9;
   * @return The lowTopOfPageBidMicros.
   */
  long getLowTopOfPageBidMicros();

  /**
   *    * Top of page bid high range (80th percentile) in micros for the keyword.
   * 
   *
   * optional int64 high_top_of_page_bid_micros = 10;
   * @return Whether the highTopOfPageBidMicros field is set.
   */
  boolean hasHighTopOfPageBidMicros();
  /**
   *    * Top of page bid high range (80th percentile) in micros for the keyword.
   * 
   *
   * optional int64 high_top_of_page_bid_micros = 10;
   * @return The highTopOfPageBidMicros.
   */
  long getHighTopOfPageBidMicros();

  /**
   *    * Average Cost Per Click in micros for the keyword.
   * 
   *
   * optional int64 average_cpc_micros = 11;
   * @return Whether the averageCpcMicros field is set.
   */
  boolean hasAverageCpcMicros();
  /**
   *    * Average Cost Per Click in micros for the keyword.
   * 
   *
   * optional int64 average_cpc_micros = 11;
   * @return The averageCpcMicros.
   */
  long getAverageCpcMicros();
}