Package com.google.ads.googleads.v18.resources

Interface KeywordPlanOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    KeywordPlanForecastPeriod
    getForecastPeriod()
    The date period used for forecasting the plan.
    KeywordPlanForecastPeriodOrBuilder
    getForecastPeriodOrBuilder()
    The date period used for forecasting the plan.
    long
    getId()
    Output only.
    String
    getName()
    The name of the keyword plan.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the keyword plan.
    String
    getResourceName()
    Immutable.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    Immutable.
    boolean
    hasForecastPeriod()
    The date period used for forecasting the plan.
    boolean
    hasId()
    Output only.
    boolean
    hasName()
    The name of the keyword plan.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getResourceName

      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) = { ... }
      Returns:
      The resourceName.

    • getResourceNameBytes

      com.google.protobuf.ByteString getResourceNameBytes()
       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) = { ... }
      Returns:
      The bytes for resourceName.

    • hasId

      boolean hasId()
       Output only. The ID of the keyword plan.
      optional int64 id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the id field is set.

    • getId

      long getId()
       Output only. The ID of the keyword plan.
      optional int64 id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The id.

    • hasName

      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;
      Returns:
      Whether the name field is set.

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the keyword plan.

 This field is required and should not be empty when creating new keyword
 plans.
      optional string name = 6;
      Returns:
      The bytes for name.

    • hasForecastPeriod

      boolean hasForecastPeriod()
       The date period used for forecasting the plan.
      .google.ads.googleads.v18.resources.KeywordPlanForecastPeriod forecast_period = 4;
      Returns:
      Whether the forecastPeriod field is set.

    • getForecastPeriod

      KeywordPlanForecastPeriod getForecastPeriod()
       The date period used for forecasting the plan.
      .google.ads.googleads.v18.resources.KeywordPlanForecastPeriod forecast_period = 4;
      Returns:
      The forecastPeriod.

    • getForecastPeriodOrBuilder

      KeywordPlanForecastPeriodOrBuilder getForecastPeriodOrBuilder()
       The date period used for forecasting the plan.
      .google.ads.googleads.v18.resources.KeywordPlanForecastPeriod forecast_period = 4;