com.google.ads.googleads.v17.services.CampaignToForecastOrBuilder 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/services/keyword_plan_idea_service.proto

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

public interface CampaignToForecastOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.services.CampaignToForecast)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The list of resource names of languages to be targeted. The resource name
   * is of the format "languageConstants/{criterion_id}". See
   * https://developers.google.com/google-ads/api/data/codes-formats#languages
   * for the list of language criterion codes.
   * 
   *
   * repeated string language_constants = 1;
   * @return A list containing the languageConstants.
   */
  java.util.List
      getLanguageConstantsList();
  /**
   *    * The list of resource names of languages to be targeted. The resource name
   * is of the format "languageConstants/{criterion_id}". See
   * https://developers.google.com/google-ads/api/data/codes-formats#languages
   * for the list of language criterion codes.
   * 
   *
   * repeated string language_constants = 1;
   * @return The count of languageConstants.
   */
  int getLanguageConstantsCount();
  /**
   *    * The list of resource names of languages to be targeted. The resource name
   * is of the format "languageConstants/{criterion_id}". See
   * https://developers.google.com/google-ads/api/data/codes-formats#languages
   * for the list of language criterion codes.
   * 
   *
   * repeated string language_constants = 1;
   * @param index The index of the element to return.
   * @return The languageConstants at the given index.
   */
  java.lang.String getLanguageConstants(int index);
  /**
   *    * The list of resource names of languages to be targeted. The resource name
   * is of the format "languageConstants/{criterion_id}". See
   * https://developers.google.com/google-ads/api/data/codes-formats#languages
   * for the list of language criterion codes.
   * 
   *
   * repeated string language_constants = 1;
   * @param index The index of the value to return.
   * @return The bytes of the languageConstants at the given index.
   */
  com.google.protobuf.ByteString
      getLanguageConstantsBytes(int index);

  /**
   *    * Locations to be targeted. Locations must be unique.
   * 
   *
   * repeated .google.ads.googleads.v17.services.CriterionBidModifier geo_modifiers = 2;
   */
  java.util.List 
      getGeoModifiersList();
  /**
   *    * Locations to be targeted. Locations must be unique.
   * 
   *
   * repeated .google.ads.googleads.v17.services.CriterionBidModifier geo_modifiers = 2;
   */
  com.google.ads.googleads.v17.services.CriterionBidModifier getGeoModifiers(int index);
  /**
   *    * Locations to be targeted. Locations must be unique.
   * 
   *
   * repeated .google.ads.googleads.v17.services.CriterionBidModifier geo_modifiers = 2;
   */
  int getGeoModifiersCount();
  /**
   *    * Locations to be targeted. Locations must be unique.
   * 
   *
   * repeated .google.ads.googleads.v17.services.CriterionBidModifier geo_modifiers = 2;
   */
  java.util.List 
      getGeoModifiersOrBuilderList();
  /**
   *    * Locations to be targeted. Locations must be unique.
   * 
   *
   * repeated .google.ads.googleads.v17.services.CriterionBidModifier geo_modifiers = 2;
   */
  com.google.ads.googleads.v17.services.CriterionBidModifierOrBuilder getGeoModifiersOrBuilder(
      int index);

  /**
   *    * Required. The network used for targeting.
   * 
   *
   * .google.ads.googleads.v17.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 3 [(.google.api.field_behavior) = REQUIRED];
   * @return The enum numeric value on the wire for keywordPlanNetwork.
   */
  int getKeywordPlanNetworkValue();
  /**
   *    * Required. The network used for targeting.
   * 
   *
   * .google.ads.googleads.v17.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 3 [(.google.api.field_behavior) = REQUIRED];
   * @return The keywordPlanNetwork.
   */
  com.google.ads.googleads.v17.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork getKeywordPlanNetwork();

  /**
   *    * The list of negative keywords to be used in the campaign when doing the
   * forecast.
   * 
   *
   * repeated .google.ads.googleads.v17.common.KeywordInfo negative_keywords = 4;
   */
  java.util.List 
      getNegativeKeywordsList();
  /**
   *    * The list of negative keywords to be used in the campaign when doing the
   * forecast.
   * 
   *
   * repeated .google.ads.googleads.v17.common.KeywordInfo negative_keywords = 4;
   */
  com.google.ads.googleads.v17.common.KeywordInfo getNegativeKeywords(int index);
  /**
   *    * The list of negative keywords to be used in the campaign when doing the
   * forecast.
   * 
   *
   * repeated .google.ads.googleads.v17.common.KeywordInfo negative_keywords = 4;
   */
  int getNegativeKeywordsCount();
  /**
   *    * The list of negative keywords to be used in the campaign when doing the
   * forecast.
   * 
   *
   * repeated .google.ads.googleads.v17.common.KeywordInfo negative_keywords = 4;
   */
  java.util.List 
      getNegativeKeywordsOrBuilderList();
  /**
   *    * The list of negative keywords to be used in the campaign when doing the
   * forecast.
   * 
   *
   * repeated .google.ads.googleads.v17.common.KeywordInfo negative_keywords = 4;
   */
  com.google.ads.googleads.v17.common.KeywordInfoOrBuilder getNegativeKeywordsOrBuilder(
      int index);

  /**
   *    * Required. The bidding strategy for the campaign.
   * 
   *
   * .google.ads.googleads.v17.services.CampaignToForecast.CampaignBiddingStrategy bidding_strategy = 5 [(.google.api.field_behavior) = REQUIRED];
   * @return Whether the biddingStrategy field is set.
   */
  boolean hasBiddingStrategy();
  /**
   *    * Required. The bidding strategy for the campaign.
   * 
   *
   * .google.ads.googleads.v17.services.CampaignToForecast.CampaignBiddingStrategy bidding_strategy = 5 [(.google.api.field_behavior) = REQUIRED];
   * @return The biddingStrategy.
   */
  com.google.ads.googleads.v17.services.CampaignToForecast.CampaignBiddingStrategy getBiddingStrategy();
  /**
   *    * Required. The bidding strategy for the campaign.
   * 
   *
   * .google.ads.googleads.v17.services.CampaignToForecast.CampaignBiddingStrategy bidding_strategy = 5 [(.google.api.field_behavior) = REQUIRED];
   */
  com.google.ads.googleads.v17.services.CampaignToForecast.CampaignBiddingStrategyOrBuilder getBiddingStrategyOrBuilder();

  /**
   *    * The expected conversion rate (number of conversions divided by number of
   * total clicks) as defined by the user. This value is expressed as a decimal
   * value, so an expected conversion rate of 2% should be entered as 0.02. If
   * left empty, an estimated conversion rate will be used.
   * 
   *
   * optional double conversion_rate = 6;
   * @return Whether the conversionRate field is set.
   */
  boolean hasConversionRate();
  /**
   *    * The expected conversion rate (number of conversions divided by number of
   * total clicks) as defined by the user. This value is expressed as a decimal
   * value, so an expected conversion rate of 2% should be entered as 0.02. If
   * left empty, an estimated conversion rate will be used.
   * 
   *
   * optional double conversion_rate = 6;
   * @return The conversionRate.
   */
  double getConversionRate();

  /**
   *    * The ad groups in the new campaign to forecast.
   * 
   *
   * repeated .google.ads.googleads.v17.services.ForecastAdGroup ad_groups = 7;
   */
  java.util.List 
      getAdGroupsList();
  /**
   *    * The ad groups in the new campaign to forecast.
   * 
   *
   * repeated .google.ads.googleads.v17.services.ForecastAdGroup ad_groups = 7;
   */
  com.google.ads.googleads.v17.services.ForecastAdGroup getAdGroups(int index);
  /**
   *    * The ad groups in the new campaign to forecast.
   * 
   *
   * repeated .google.ads.googleads.v17.services.ForecastAdGroup ad_groups = 7;
   */
  int getAdGroupsCount();
  /**
   *    * The ad groups in the new campaign to forecast.
   * 
   *
   * repeated .google.ads.googleads.v17.services.ForecastAdGroup ad_groups = 7;
   */
  java.util.List 
      getAdGroupsOrBuilderList();
  /**
   *    * The ad groups in the new campaign to forecast.
   * 
   *
   * repeated .google.ads.googleads.v17.services.ForecastAdGroup ad_groups = 7;
   */
  com.google.ads.googleads.v17.services.ForecastAdGroupOrBuilder getAdGroupsOrBuilder(
      int index);
}