Package com.google.ads.googleads.v10.resources

Class KeywordPlanCampaign.Builder

  • All Implemented Interfaces:
    KeywordPlanCampaignOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    KeywordPlanCampaign
    public static final class KeywordPlanCampaign.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlanCampaign.Builder>
implements KeywordPlanCampaignOrBuilder
     A Keyword Plan campaign.
 Max number of keyword plan campaigns per plan allowed: 1.
    Protobuf type google.ads.googleads.v10.resources.KeywordPlanCampaign

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

      • clear

        public KeywordPlanCampaign.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<KeywordPlanCampaign.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<KeywordPlanCampaign.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public KeywordPlanCampaign.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<KeywordPlanCampaign.Builder>

      • setField

        public KeywordPlanCampaign.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<KeywordPlanCampaign.Builder>

      • clearField

        public KeywordPlanCampaign.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<KeywordPlanCampaign.Builder>

      • clearOneof

        public KeywordPlanCampaign.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<KeywordPlanCampaign.Builder>

      • setRepeatedField

        public KeywordPlanCampaign.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<KeywordPlanCampaign.Builder>

      • addRepeatedField

        public KeywordPlanCampaign.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<KeywordPlanCampaign.Builder>

      • mergeFrom

        public KeywordPlanCampaign.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<KeywordPlanCampaign.Builder>

      • isInitialized

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

      • mergeFrom

        public KeywordPlanCampaign.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<KeywordPlanCampaign.Builder>
        Throws:
        java.io.IOException

      • getResourceName

        public java.lang.String getResourceName()
         Immutable. The resource name of the Keyword Plan campaign.
 KeywordPlanCampaign resource names have the form:
 `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface KeywordPlanCampaignOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the Keyword Plan campaign.
 KeywordPlanCampaign resource names have the form:
 `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface KeywordPlanCampaignOrBuilder
        Returns:
        The bytes for resourceName.

      • setResourceName

        public KeywordPlanCampaign.Builder setResourceName​(java.lang.String value)
         Immutable. The resource name of the Keyword Plan campaign.
 KeywordPlanCampaign resource names have the form:
 `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_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 KeywordPlanCampaign.Builder clearResourceName()
         Immutable. The resource name of the Keyword Plan campaign.
 KeywordPlanCampaign resource names have the form:
 `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setResourceNameBytes

        public KeywordPlanCampaign.Builder setResourceNameBytes​(com.google.protobuf.ByteString value)
         Immutable. The resource name of the Keyword Plan campaign.
 KeywordPlanCampaign resource names have the form:
 `customers/{customer_id}/keywordPlanCampaigns/{kp_campaign_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.

      • hasKeywordPlan

        public boolean hasKeywordPlan()
         The keyword plan this campaign belongs to.
        optional string keyword_plan = 9 [(.google.api.resource_reference) = { ... }
        Specified by:
        hasKeywordPlan in interface KeywordPlanCampaignOrBuilder
        Returns:
        Whether the keywordPlan field is set.

      • getKeywordPlan

        public java.lang.String getKeywordPlan()
         The keyword plan this campaign belongs to.
        optional string keyword_plan = 9 [(.google.api.resource_reference) = { ... }
        Specified by:
        getKeywordPlan in interface KeywordPlanCampaignOrBuilder
        Returns:
        The keywordPlan.

      • getKeywordPlanBytes

        public com.google.protobuf.ByteString getKeywordPlanBytes()
         The keyword plan this campaign belongs to.
        optional string keyword_plan = 9 [(.google.api.resource_reference) = { ... }
        Specified by:
        getKeywordPlanBytes in interface KeywordPlanCampaignOrBuilder
        Returns:
        The bytes for keywordPlan.

      • setKeywordPlan

        public KeywordPlanCampaign.Builder setKeywordPlan​(java.lang.String value)
         The keyword plan this campaign belongs to.
        optional string keyword_plan = 9 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The keywordPlan to set.
        Returns:
        This builder for chaining.

      • clearKeywordPlan

        public KeywordPlanCampaign.Builder clearKeywordPlan()
         The keyword plan this campaign belongs to.
        optional string keyword_plan = 9 [(.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setKeywordPlanBytes

        public KeywordPlanCampaign.Builder setKeywordPlanBytes​(com.google.protobuf.ByteString value)
         The keyword plan this campaign belongs to.
        optional string keyword_plan = 9 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for keywordPlan to set.
        Returns:
        This builder for chaining.

      • hasId

        public boolean hasId()
         Output only. The ID of the Keyword Plan campaign.
        optional int64 id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasId in interface KeywordPlanCampaignOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public long getId()
         Output only. The ID of the Keyword Plan campaign.
        optional int64 id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface KeywordPlanCampaignOrBuilder
        Returns:
        The id.

      • setId

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

      • clearId

        public KeywordPlanCampaign.Builder clearId()
         Output only. The ID of the Keyword Plan campaign.
        optional int64 id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • hasName

        public boolean hasName()
         The name of the Keyword Plan campaign.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        optional string name = 11;
        Specified by:
        hasName in interface KeywordPlanCampaignOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public java.lang.String getName()
         The name of the Keyword Plan campaign.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        optional string name = 11;
        Specified by:
        getName in interface KeywordPlanCampaignOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of the Keyword Plan campaign.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        optional string name = 11;
        Specified by:
        getNameBytes in interface KeywordPlanCampaignOrBuilder
        Returns:
        The bytes for name.

      • setName

        public KeywordPlanCampaign.Builder setName​(java.lang.String value)
         The name of the Keyword Plan campaign.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        optional string name = 11;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public KeywordPlanCampaign.Builder clearName()
         The name of the Keyword Plan campaign.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        optional string name = 11;
        Returns:
        This builder for chaining.

      • setNameBytes

        public KeywordPlanCampaign.Builder setNameBytes​(com.google.protobuf.ByteString value)
         The name of the Keyword Plan campaign.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        optional string name = 11;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • getLanguageConstantsList

        public com.google.protobuf.ProtocolStringList getLanguageConstantsList()
         The languages targeted for the Keyword Plan campaign.
 Max allowed: 1.
        repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
        Specified by:
        getLanguageConstantsList in interface KeywordPlanCampaignOrBuilder
        Returns:
        A list containing the languageConstants.

      • getLanguageConstantsCount

        public int getLanguageConstantsCount()
         The languages targeted for the Keyword Plan campaign.
 Max allowed: 1.
        repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
        Specified by:
        getLanguageConstantsCount in interface KeywordPlanCampaignOrBuilder
        Returns:
        The count of languageConstants.

      • getLanguageConstants

        public java.lang.String getLanguageConstants​(int index)
         The languages targeted for the Keyword Plan campaign.
 Max allowed: 1.
        repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
        Specified by:
        getLanguageConstants in interface KeywordPlanCampaignOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The languageConstants at the given index.

      • getLanguageConstantsBytes

        public com.google.protobuf.ByteString getLanguageConstantsBytes​(int index)
         The languages targeted for the Keyword Plan campaign.
 Max allowed: 1.
        repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
        Specified by:
        getLanguageConstantsBytes in interface KeywordPlanCampaignOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the languageConstants at the given index.

      • setLanguageConstants

        public KeywordPlanCampaign.Builder setLanguageConstants​(int index,
                                                        java.lang.String value)
         The languages targeted for the Keyword Plan campaign.
 Max allowed: 1.
        repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
        Parameters:
        index - The index to set the value at.
        value - The languageConstants to set.
        Returns:
        This builder for chaining.

      • addLanguageConstants

        public KeywordPlanCampaign.Builder addLanguageConstants​(java.lang.String value)
         The languages targeted for the Keyword Plan campaign.
 Max allowed: 1.
        repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The languageConstants to add.
        Returns:
        This builder for chaining.

      • addAllLanguageConstants

        public KeywordPlanCampaign.Builder addAllLanguageConstants​(java.lang.Iterable<java.lang.String> values)
         The languages targeted for the Keyword Plan campaign.
 Max allowed: 1.
        repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
        Parameters:
        values - The languageConstants to add.
        Returns:
        This builder for chaining.

      • clearLanguageConstants

        public KeywordPlanCampaign.Builder clearLanguageConstants()
         The languages targeted for the Keyword Plan campaign.
 Max allowed: 1.
        repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • addLanguageConstantsBytes

        public KeywordPlanCampaign.Builder addLanguageConstantsBytes​(com.google.protobuf.ByteString value)
         The languages targeted for the Keyword Plan campaign.
 Max allowed: 1.
        repeated string language_constants = 12 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes of the languageConstants to add.
        Returns:
        This builder for chaining.

      • getKeywordPlanNetworkValue

        public int getKeywordPlanNetworkValue()
         Targeting network.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        .google.ads.googleads.v10.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 6;
        Specified by:
        getKeywordPlanNetworkValue in interface KeywordPlanCampaignOrBuilder
        Returns:
        The enum numeric value on the wire for keywordPlanNetwork.

      • setKeywordPlanNetworkValue

        public KeywordPlanCampaign.Builder setKeywordPlanNetworkValue​(int value)
         Targeting network.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        .google.ads.googleads.v10.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 6;
        Parameters:
        value - The enum numeric value on the wire for keywordPlanNetwork to set.
        Returns:
        This builder for chaining.

      • setKeywordPlanNetwork

        public KeywordPlanCampaign.Builder setKeywordPlanNetwork​(KeywordPlanNetworkEnum.KeywordPlanNetwork value)
         Targeting network.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        .google.ads.googleads.v10.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 6;
        Parameters:
        value - The keywordPlanNetwork to set.
        Returns:
        This builder for chaining.

      • clearKeywordPlanNetwork

        public KeywordPlanCampaign.Builder clearKeywordPlanNetwork()
         Targeting network.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        .google.ads.googleads.v10.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 6;
        Returns:
        This builder for chaining.

      • hasCpcBidMicros

        public boolean hasCpcBidMicros()
         A default max cpc bid in micros, and in the account currency, for all ad
 groups under the campaign.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        optional int64 cpc_bid_micros = 13;
        Specified by:
        hasCpcBidMicros in interface KeywordPlanCampaignOrBuilder
        Returns:
        Whether the cpcBidMicros field is set.

      • getCpcBidMicros

        public long getCpcBidMicros()
         A default max cpc bid in micros, and in the account currency, for all ad
 groups under the campaign.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        optional int64 cpc_bid_micros = 13;
        Specified by:
        getCpcBidMicros in interface KeywordPlanCampaignOrBuilder
        Returns:
        The cpcBidMicros.

      • setCpcBidMicros

        public KeywordPlanCampaign.Builder setCpcBidMicros​(long value)
         A default max cpc bid in micros, and in the account currency, for all ad
 groups under the campaign.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        optional int64 cpc_bid_micros = 13;
        Parameters:
        value - The cpcBidMicros to set.
        Returns:
        This builder for chaining.

      • clearCpcBidMicros

        public KeywordPlanCampaign.Builder clearCpcBidMicros()
         A default max cpc bid in micros, and in the account currency, for all ad
 groups under the campaign.
 This field is required and should not be empty when creating Keyword Plan
 campaigns.
        optional int64 cpc_bid_micros = 13;
        Returns:
        This builder for chaining.

      • getGeoTargetsCount

        public int getGeoTargetsCount()
         The geo targets.
 Max number allowed: 20.
        repeated .google.ads.googleads.v10.resources.KeywordPlanGeoTarget geo_targets = 8;
        Specified by:
        getGeoTargetsCount in interface KeywordPlanCampaignOrBuilder

      • addAllGeoTargets

        public KeywordPlanCampaign.Builder addAllGeoTargets​(java.lang.Iterable<? extends KeywordPlanGeoTarget> values)
         The geo targets.
 Max number allowed: 20.
        repeated .google.ads.googleads.v10.resources.KeywordPlanGeoTarget geo_targets = 8;

      • clearGeoTargets

        public KeywordPlanCampaign.Builder clearGeoTargets()
         The geo targets.
 Max number allowed: 20.
        repeated .google.ads.googleads.v10.resources.KeywordPlanGeoTarget geo_targets = 8;

      • removeGeoTargets

        public KeywordPlanCampaign.Builder removeGeoTargets​(int index)
         The geo targets.
 Max number allowed: 20.
        repeated .google.ads.googleads.v10.resources.KeywordPlanGeoTarget geo_targets = 8;

      • getGeoTargetsBuilder

        public KeywordPlanGeoTarget.Builder getGeoTargetsBuilder​(int index)
         The geo targets.
 Max number allowed: 20.
        repeated .google.ads.googleads.v10.resources.KeywordPlanGeoTarget geo_targets = 8;

      • addGeoTargetsBuilder

        public KeywordPlanGeoTarget.Builder addGeoTargetsBuilder()
         The geo targets.
 Max number allowed: 20.
        repeated .google.ads.googleads.v10.resources.KeywordPlanGeoTarget geo_targets = 8;

      • addGeoTargetsBuilder

        public KeywordPlanGeoTarget.Builder addGeoTargetsBuilder​(int index)
         The geo targets.
 Max number allowed: 20.
        repeated .google.ads.googleads.v10.resources.KeywordPlanGeoTarget geo_targets = 8;

      • getGeoTargetsBuilderList

        public java.util.List<KeywordPlanGeoTarget.Builder> getGeoTargetsBuilderList()
         The geo targets.
 Max number allowed: 20.
        repeated .google.ads.googleads.v10.resources.KeywordPlanGeoTarget geo_targets = 8;

      • setUnknownFields

        public final KeywordPlanCampaign.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<KeywordPlanCampaign.Builder>

      • mergeUnknownFields

        public final KeywordPlanCampaign.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<KeywordPlanCampaign.Builder>