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

Class KeywordPlan

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.KeywordPlan
All Implemented Interfaces:
KeywordPlanOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class KeywordPlan extends com.google.protobuf.GeneratedMessageV3 implements KeywordPlanOrBuilder
 A Keyword Planner plan.
 Max number of saved keyword plans: 10000.
 It's possible to remove plans if limit is reached.
Protobuf type google.ads.googleads.v18.resources.KeywordPlan
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    KeywordPlan.Builder
    A Keyword Planner plan.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FORECAST_PERIOD_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    RESOURCE_NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static KeywordPlan
    getDefaultInstance()
     
    KeywordPlan
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<KeywordPlan>
    getParserForType()
     
    String
    getResourceName()
    Immutable.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    Immutable.
    int
    getSerializedSize()
     
    boolean
    hasForecastPeriod()
    The date period used for forecasting the plan.
    int
    hashCode()
     
    boolean
    hasId()
    Output only.
    boolean
    hasName()
    The name of the keyword plan.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static KeywordPlan.Builder
    newBuilder()
     
    static KeywordPlan.Builder
    newBuilder(KeywordPlan prototype)
     
    KeywordPlan.Builder
    newBuilderForType()
     
    protected KeywordPlan.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static KeywordPlan
    parseDelimitedFrom(InputStream input)
     
    static KeywordPlan
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeywordPlan
    parseFrom(byte[] data)
     
    static KeywordPlan
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeywordPlan
    parseFrom(com.google.protobuf.ByteString data)
     
    static KeywordPlan
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeywordPlan
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static KeywordPlan
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeywordPlan
    parseFrom(InputStream input)
     
    static KeywordPlan
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeywordPlan
    parseFrom(ByteBuffer data)
     
    static KeywordPlan
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<KeywordPlan>
    parser()
     
    KeywordPlan.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getResourceName

      public 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) = { ... }
      Specified by:
      getResourceName in interface KeywordPlanOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public 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) = { ... }
      Specified by:
      getResourceNameBytes in interface KeywordPlanOrBuilder
      Returns:
      The bytes for resourceName.

    • hasId

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

    • getId

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

    • hasName

      public 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;
      Specified by:
      hasName in interface KeywordPlanOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public 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;
      Specified by:
      getName in interface KeywordPlanOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface KeywordPlanOrBuilder
      Returns:
      The bytes for name.

    • hasForecastPeriod

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

    • getForecastPeriod

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

    • getForecastPeriodOrBuilder

      public KeywordPlanForecastPeriodOrBuilder getForecastPeriodOrBuilder()
       The date period used for forecasting the plan.
      .google.ads.googleads.v18.resources.KeywordPlanForecastPeriod forecast_period = 4;
      Specified by:
      getForecastPeriodOrBuilder in interface KeywordPlanOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static KeywordPlan parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeywordPlan parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeywordPlan parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeywordPlan parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeywordPlan parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeywordPlan parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeywordPlan parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KeywordPlan parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static KeywordPlan parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static KeywordPlan parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KeywordPlan parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KeywordPlan parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public KeywordPlan.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static KeywordPlan.Builder newBuilder()

    • newBuilder

      public static KeywordPlan.Builder newBuilder(KeywordPlan prototype)

    • toBuilder

      public KeywordPlan.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected KeywordPlan.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static KeywordPlan getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<KeywordPlan> parser()

    • getParserForType

      public com.google.protobuf.Parser<KeywordPlan> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public KeywordPlan getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder