Package com.google.ads.googleads.v15.services

Class ForecastAdGroup.Builder

  • All Implemented Interfaces:
    ForecastAdGroupOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    ForecastAdGroup
    public static final class ForecastAdGroup.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ForecastAdGroup.Builder>
implements ForecastAdGroupOrBuilder
     An ad group that is part of a campaign to be forecasted.
    Protobuf type google.ads.googleads.v15.services.ForecastAdGroup

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • isInitialized

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

      • mergeFrom

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

      • hasMaxCpcBidMicros

        public boolean hasMaxCpcBidMicros()
         The max cpc to use for the ad group when generating forecasted traffic.
 This value will override the max cpc value set in the bidding strategy.
 Only specify this field for bidding strategies that max cpc values.
        optional int64 max_cpc_bid_micros = 1;
        Specified by:
        hasMaxCpcBidMicros in interface ForecastAdGroupOrBuilder
        Returns:
        Whether the maxCpcBidMicros field is set.

      • getMaxCpcBidMicros

        public long getMaxCpcBidMicros()
         The max cpc to use for the ad group when generating forecasted traffic.
 This value will override the max cpc value set in the bidding strategy.
 Only specify this field for bidding strategies that max cpc values.
        optional int64 max_cpc_bid_micros = 1;
        Specified by:
        getMaxCpcBidMicros in interface ForecastAdGroupOrBuilder
        Returns:
        The maxCpcBidMicros.

      • setMaxCpcBidMicros

        public ForecastAdGroup.Builder setMaxCpcBidMicros​(long value)
         The max cpc to use for the ad group when generating forecasted traffic.
 This value will override the max cpc value set in the bidding strategy.
 Only specify this field for bidding strategies that max cpc values.
        optional int64 max_cpc_bid_micros = 1;
        Parameters:
        value - The maxCpcBidMicros to set.
        Returns:
        This builder for chaining.

      • clearMaxCpcBidMicros

        public ForecastAdGroup.Builder clearMaxCpcBidMicros()
         The max cpc to use for the ad group when generating forecasted traffic.
 This value will override the max cpc value set in the bidding strategy.
 Only specify this field for bidding strategies that max cpc values.
        optional int64 max_cpc_bid_micros = 1;
        Returns:
        This builder for chaining.

      • getBiddableKeywordsList

        public java.util.List<BiddableKeyword> getBiddableKeywordsList()
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBiddableKeywordsList in interface ForecastAdGroupOrBuilder

      • getBiddableKeywordsCount

        public int getBiddableKeywordsCount()
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBiddableKeywordsCount in interface ForecastAdGroupOrBuilder

      • getBiddableKeywords

        public BiddableKeyword getBiddableKeywords​(int index)
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBiddableKeywords in interface ForecastAdGroupOrBuilder

      • setBiddableKeywords

        public ForecastAdGroup.Builder setBiddableKeywords​(int index,
                                                   BiddableKeyword value)
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • setBiddableKeywords

        public ForecastAdGroup.Builder setBiddableKeywords​(int index,
                                                   BiddableKeyword.Builder builderForValue)
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • addBiddableKeywords

        public ForecastAdGroup.Builder addBiddableKeywords​(BiddableKeyword value)
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • addBiddableKeywords

        public ForecastAdGroup.Builder addBiddableKeywords​(int index,
                                                   BiddableKeyword value)
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • addBiddableKeywords

        public ForecastAdGroup.Builder addBiddableKeywords​(BiddableKeyword.Builder builderForValue)
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • addBiddableKeywords

        public ForecastAdGroup.Builder addBiddableKeywords​(int index,
                                                   BiddableKeyword.Builder builderForValue)
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • addAllBiddableKeywords

        public ForecastAdGroup.Builder addAllBiddableKeywords​(java.lang.Iterable<? extends BiddableKeyword> values)
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • clearBiddableKeywords

        public ForecastAdGroup.Builder clearBiddableKeywords()
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • removeBiddableKeywords

        public ForecastAdGroup.Builder removeBiddableKeywords​(int index)
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • getBiddableKeywordsBuilder

        public BiddableKeyword.Builder getBiddableKeywordsBuilder​(int index)
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • getBiddableKeywordsOrBuilder

        public BiddableKeywordOrBuilder getBiddableKeywordsOrBuilder​(int index)
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBiddableKeywordsOrBuilder in interface ForecastAdGroupOrBuilder

      • getBiddableKeywordsOrBuilderList

        public java.util.List<? extends BiddableKeywordOrBuilder> getBiddableKeywordsOrBuilderList()
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBiddableKeywordsOrBuilderList in interface ForecastAdGroupOrBuilder

      • addBiddableKeywordsBuilder

        public BiddableKeyword.Builder addBiddableKeywordsBuilder()
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • addBiddableKeywordsBuilder

        public BiddableKeyword.Builder addBiddableKeywordsBuilder​(int index)
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • getBiddableKeywordsBuilderList

        public java.util.List<BiddableKeyword.Builder> getBiddableKeywordsBuilderList()
         Required. The list of biddable keywords to be used in the ad group when
 doing the forecast. Requires at least one keyword.
        repeated .google.ads.googleads.v15.services.BiddableKeyword biddable_keywords = 2 [(.google.api.field_behavior) = REQUIRED];

      • getNegativeKeywordsList

        public java.util.List<KeywordInfo> getNegativeKeywordsList()
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;
        Specified by:
        getNegativeKeywordsList in interface ForecastAdGroupOrBuilder

      • getNegativeKeywordsCount

        public int getNegativeKeywordsCount()
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;
        Specified by:
        getNegativeKeywordsCount in interface ForecastAdGroupOrBuilder

      • getNegativeKeywords

        public KeywordInfo getNegativeKeywords​(int index)
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;
        Specified by:
        getNegativeKeywords in interface ForecastAdGroupOrBuilder

      • setNegativeKeywords

        public ForecastAdGroup.Builder setNegativeKeywords​(int index,
                                                   KeywordInfo value)
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • setNegativeKeywords

        public ForecastAdGroup.Builder setNegativeKeywords​(int index,
                                                   KeywordInfo.Builder builderForValue)
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • addNegativeKeywords

        public ForecastAdGroup.Builder addNegativeKeywords​(KeywordInfo value)
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • addNegativeKeywords

        public ForecastAdGroup.Builder addNegativeKeywords​(int index,
                                                   KeywordInfo value)
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • addNegativeKeywords

        public ForecastAdGroup.Builder addNegativeKeywords​(KeywordInfo.Builder builderForValue)
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • addNegativeKeywords

        public ForecastAdGroup.Builder addNegativeKeywords​(int index,
                                                   KeywordInfo.Builder builderForValue)
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • addAllNegativeKeywords

        public ForecastAdGroup.Builder addAllNegativeKeywords​(java.lang.Iterable<? extends KeywordInfo> values)
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • clearNegativeKeywords

        public ForecastAdGroup.Builder clearNegativeKeywords()
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • removeNegativeKeywords

        public ForecastAdGroup.Builder removeNegativeKeywords​(int index)
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • getNegativeKeywordsBuilder

        public KeywordInfo.Builder getNegativeKeywordsBuilder​(int index)
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • addNegativeKeywordsBuilder

        public KeywordInfo.Builder addNegativeKeywordsBuilder()
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • addNegativeKeywordsBuilder

        public KeywordInfo.Builder addNegativeKeywordsBuilder​(int index)
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • getNegativeKeywordsBuilderList

        public java.util.List<KeywordInfo.Builder> getNegativeKeywordsBuilderList()
         The details of the keyword. You should specify both the keyword text and
 match type.
        repeated .google.ads.googleads.v15.common.KeywordInfo negative_keywords = 3;

      • setUnknownFields

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

      • mergeUnknownFields

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