com.google.ads.googleads.v17.resources.KeywordPlanOrBuilder 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/resources/keyword_plan.proto

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

public interface KeywordPlanOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.KeywordPlan)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Immutable. The resource name of the Keyword Planner plan.
   * KeywordPlan resource names have the form:
   *
   * `customers/{customer_id}/keywordPlans/{kp_plan_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The resourceName.
   */
  java.lang.String getResourceName();
  /**
   *    * Immutable. The resource name of the Keyword Planner plan.
   * KeywordPlan resource names have the form:
   *
   * `customers/{customer_id}/keywordPlans/{kp_plan_id}`
   * 
   *
   * string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

  /**
   *    * Output only. The ID of the keyword plan.
   * 
   *
   * optional int64 id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Output only. The ID of the keyword plan.
   * 
   *
   * optional int64 id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * The name of the keyword plan.
   *
   * This field is required and should not be empty when creating new keyword
   * plans.
   * 
   *
   * optional string name = 6;
   * @return Whether the name field is set.
   */
  boolean hasName();
  /**
   *    * The name of the keyword plan.
   *
   * This field is required and should not be empty when creating new keyword
   * plans.
   * 
   *
   * optional string name = 6;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * The name of the keyword plan.
   *
   * This field is required and should not be empty when creating new keyword
   * plans.
   * 
   *
   * optional string name = 6;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * The date period used for forecasting the plan.
   * 
   *
   * .google.ads.googleads.v17.resources.KeywordPlanForecastPeriod forecast_period = 4;
   * @return Whether the forecastPeriod field is set.
   */
  boolean hasForecastPeriod();
  /**
   *    * The date period used for forecasting the plan.
   * 
   *
   * .google.ads.googleads.v17.resources.KeywordPlanForecastPeriod forecast_period = 4;
   * @return The forecastPeriod.
   */
  com.google.ads.googleads.v17.resources.KeywordPlanForecastPeriod getForecastPeriod();
  /**
   *    * The date period used for forecasting the plan.
   * 
   *
   * .google.ads.googleads.v17.resources.KeywordPlanForecastPeriod forecast_period = 4;
   */
  com.google.ads.googleads.v17.resources.KeywordPlanForecastPeriodOrBuilder getForecastPeriodOrBuilder();
}