Package com.google.ads.googleads.v14.resources

Class KeywordPlan.Builder

  • All Implemented Interfaces:
    KeywordPlanOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    KeywordPlan
    public static final class KeywordPlan.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlan.Builder>
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.v14.resources.KeywordPlan

    • Method Detail

      • 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.Builder<KeywordPlan.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlan.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

        public KeywordPlan.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlan.Builder>

      • clearField

        public KeywordPlan.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlan.Builder>

      • clearOneof

        public KeywordPlan.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlan.Builder>

      • setRepeatedField

        public KeywordPlan.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlan.Builder>

      • addRepeatedField

        public KeywordPlan.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlan.Builder>

      • mergeFrom

        public KeywordPlan.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KeywordPlan.Builder>

      • isInitialized

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

      • mergeFrom

        public KeywordPlan.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KeywordPlan.Builder>
        Throws:
        java.io.IOException

      • getResourceName

        public 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) = { ... }
        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.

      • setResourceName

        public KeywordPlan.Builder setResourceName​(java.lang.String value)
         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) = { ... }
        Parameters:
        value - The resourceName to set.
        Returns:
        This builder for chaining.

      • clearResourceName

        public KeywordPlan.Builder clearResourceName()
         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:
        This builder for chaining.

      • setResourceNameBytes

        public KeywordPlan.Builder setResourceNameBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for resourceName to set.
        Returns:
        This builder for chaining.

      • 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.

      • setId

        public KeywordPlan.Builder setId​(long value)
         Output only. The ID of the keyword plan.
        optional int64 id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.

      • clearId

        public KeywordPlan.Builder clearId()
         Output only. The ID of the keyword plan.
        optional int64 id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • 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 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;
        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.

      • setName

        public KeywordPlan.Builder setName​(java.lang.String value)
         The name of the keyword plan.

 This field is required and should not be empty when creating new keyword
 plans.
        optional string name = 6;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public KeywordPlan.Builder clearName()
         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:
        This builder for chaining.

      • setNameBytes

        public KeywordPlan.Builder setNameBytes​(com.google.protobuf.ByteString value)
         The name of the keyword plan.

 This field is required and should not be empty when creating new keyword
 plans.
        optional string name = 6;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • hasForecastPeriod

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

      • setForecastPeriod

        public KeywordPlan.Builder setForecastPeriod​(KeywordPlanForecastPeriod value)
         The date period used for forecasting the plan.
        .google.ads.googleads.v14.resources.KeywordPlanForecastPeriod forecast_period = 4;

      • mergeForecastPeriod

        public KeywordPlan.Builder mergeForecastPeriod​(KeywordPlanForecastPeriod value)
         The date period used for forecasting the plan.
        .google.ads.googleads.v14.resources.KeywordPlanForecastPeriod forecast_period = 4;

      • clearForecastPeriod

        public KeywordPlan.Builder clearForecastPeriod()
         The date period used for forecasting the plan.
        .google.ads.googleads.v14.resources.KeywordPlanForecastPeriod forecast_period = 4;

      • getForecastPeriodBuilder

        public KeywordPlanForecastPeriod.Builder getForecastPeriodBuilder()
         The date period used for forecasting the plan.
        .google.ads.googleads.v14.resources.KeywordPlanForecastPeriod forecast_period = 4;

      • setUnknownFields

        public final KeywordPlan.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlan.Builder>

      • mergeUnknownFields

        public final KeywordPlan.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlan.Builder>