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

Class KeywordPlanCampaign

  • All Implemented Interfaces:
    KeywordPlanCampaignOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class KeywordPlanCampaign
extends com.google.protobuf.GeneratedMessageV3
implements KeywordPlanCampaignOrBuilder
     A Keyword Plan campaign.
 Max number of keyword plan campaigns per plan allowed: 1.
    Protobuf type google.ads.googleads.v10.resources.KeywordPlanCampaign
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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 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.

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

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

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

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

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

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

      • 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

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 KeywordPlanCampaign parseFrom​(java.nio.ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeywordPlanCampaign parseFrom​(java.nio.ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static KeywordPlanCampaign parseFrom​(java.io.InputStream input)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static KeywordPlanCampaign parseFrom​(java.io.InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static KeywordPlanCampaign parseDelimitedFrom​(java.io.InputStream input)
                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static KeywordPlanCampaign parseDelimitedFrom​(java.io.InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static KeywordPlanCampaign parseFrom​(com.google.protobuf.CodedInputStream input)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static KeywordPlanCampaign parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<KeywordPlanCampaign> 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 KeywordPlanCampaign getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder