Package com.google.ads.googleads.v14.services

Class GenerateKeywordIdeasRequest

  • All Implemented Interfaces:
    GenerateKeywordIdeasRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class GenerateKeywordIdeasRequest
extends com.google.protobuf.GeneratedMessageV3
implements GenerateKeywordIdeasRequestOrBuilder
     Request message for
 [KeywordPlanIdeaService.GenerateKeywordIdeas][google.ads.googleads.v14.services.KeywordPlanIdeaService.GenerateKeywordIdeas].
    Protobuf type google.ads.googleads.v14.services.GenerateKeywordIdeasRequest
    See Also:
    Serialized Form

    • Field Detail

      • CUSTOMER_ID_FIELD_NUMBER

        public static final int CUSTOMER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GEO_TARGET_CONSTANTS_FIELD_NUMBER

        public static final int GEO_TARGET_CONSTANTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDE_ADULT_KEYWORDS_FIELD_NUMBER

        public static final int INCLUDE_ADULT_KEYWORDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PAGE_TOKEN_FIELD_NUMBER

        public static final int PAGE_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KEYWORD_PLAN_NETWORK_FIELD_NUMBER

        public static final int KEYWORD_PLAN_NETWORK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KEYWORD_ANNOTATION_FIELD_NUMBER

        public static final int KEYWORD_ANNOTATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AGGREGATE_METRICS_FIELD_NUMBER

        public static final int AGGREGATE_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HISTORICAL_METRICS_OPTIONS_FIELD_NUMBER

        public static final int HISTORICAL_METRICS_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KEYWORD_AND_URL_SEED_FIELD_NUMBER

        public static final int KEYWORD_AND_URL_SEED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KEYWORD_SEED_FIELD_NUMBER

        public static final int KEYWORD_SEED_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.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

      • getCustomerIdBytes

        public com.google.protobuf.ByteString getCustomerIdBytes()
         The ID of the customer with the recommendation.
        string customer_id = 1;
        Specified by:
        getCustomerIdBytes in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        The bytes for customerId.

      • hasLanguage

        public boolean hasLanguage()
         The resource name of the language to target.
 Each keyword belongs to some set of languages; a keyword is included if
 language is one of its languages.
 If not set, all keywords will be included.
        optional string language = 14;
        Specified by:
        hasLanguage in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        Whether the language field is set.

      • getLanguage

        public java.lang.String getLanguage()
         The resource name of the language to target.
 Each keyword belongs to some set of languages; a keyword is included if
 language is one of its languages.
 If not set, all keywords will be included.
        optional string language = 14;
        Specified by:
        getLanguage in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        The language.

      • getLanguageBytes

        public com.google.protobuf.ByteString getLanguageBytes()
         The resource name of the language to target.
 Each keyword belongs to some set of languages; a keyword is included if
 language is one of its languages.
 If not set, all keywords will be included.
        optional string language = 14;
        Specified by:
        getLanguageBytes in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        The bytes for language.

      • getGeoTargetConstantsList

        public com.google.protobuf.ProtocolStringList getGeoTargetConstantsList()
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 15;
        Specified by:
        getGeoTargetConstantsList in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        A list containing the geoTargetConstants.

      • getGeoTargetConstantsCount

        public int getGeoTargetConstantsCount()
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 15;
        Specified by:
        getGeoTargetConstantsCount in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        The count of geoTargetConstants.

      • getGeoTargetConstants

        public java.lang.String getGeoTargetConstants​(int index)
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 15;
        Specified by:
        getGeoTargetConstants in interface GenerateKeywordIdeasRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The geoTargetConstants at the given index.

      • getGeoTargetConstantsBytes

        public com.google.protobuf.ByteString getGeoTargetConstantsBytes​(int index)
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 15;
        Specified by:
        getGeoTargetConstantsBytes in interface GenerateKeywordIdeasRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the geoTargetConstants at the given index.

      • getIncludeAdultKeywords

        public boolean getIncludeAdultKeywords()
         If true, adult keywords will be included in response.
 The default value is false.
        bool include_adult_keywords = 10;
        Specified by:
        getIncludeAdultKeywords in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        The includeAdultKeywords.

      • getPageToken

        public java.lang.String getPageToken()
         Token of the page to retrieve. If not specified, the first
 page of results will be returned. To request next page of results use the
 value obtained from `next_page_token` in the previous response.
 The request fields must match across pages.
        string page_token = 12;
        Specified by:
        getPageToken in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Token of the page to retrieve. If not specified, the first
 page of results will be returned. To request next page of results use the
 value obtained from `next_page_token` in the previous response.
 The request fields must match across pages.
        string page_token = 12;
        Specified by:
        getPageTokenBytes in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getPageSize

        public int getPageSize()
         Number of results to retrieve in a single page.
 A maximum of 10,000 results may be returned, if the page_size
 exceeds this, it is ignored.
 If unspecified, at most 10,000 results will be returned.
 The server may decide to further limit the number of returned resources.
 If the response contains fewer than 10,000 results it may not be assumed
 as last page of results.
        int32 page_size = 13;
        Specified by:
        getPageSize in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        The pageSize.

      • getKeywordPlanNetworkValue

        public int getKeywordPlanNetworkValue()
         Targeting network.
 If not set, Google Search And Partners Network will be used.
        .google.ads.googleads.v14.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 9;
        Specified by:
        getKeywordPlanNetworkValue in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        The enum numeric value on the wire for keywordPlanNetwork.

      • getKeywordAnnotationCount

        public int getKeywordAnnotationCount()
         The keyword annotations to include in response.
        repeated .google.ads.googleads.v14.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
        Specified by:
        getKeywordAnnotationCount in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        The count of keywordAnnotation.

      • getKeywordAnnotationValueList

        public java.util.List<java.lang.Integer> getKeywordAnnotationValueList()
         The keyword annotations to include in response.
        repeated .google.ads.googleads.v14.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
        Specified by:
        getKeywordAnnotationValueList in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for keywordAnnotation.

      • getKeywordAnnotationValue

        public int getKeywordAnnotationValue​(int index)
         The keyword annotations to include in response.
        repeated .google.ads.googleads.v14.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
        Specified by:
        getKeywordAnnotationValue in interface GenerateKeywordIdeasRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of keywordAnnotation at the given index.

      • hasAggregateMetrics

        public boolean hasAggregateMetrics()
         The aggregate fields to include in response.
        .google.ads.googleads.v14.common.KeywordPlanAggregateMetrics aggregate_metrics = 16;
        Specified by:
        hasAggregateMetrics in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        Whether the aggregateMetrics field is set.

      • hasHistoricalMetricsOptions

        public boolean hasHistoricalMetricsOptions()
         The options for historical metrics data.
        .google.ads.googleads.v14.common.HistoricalMetricsOptions historical_metrics_options = 18;
        Specified by:
        hasHistoricalMetricsOptions in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        Whether the historicalMetricsOptions field is set.

      • hasKeywordAndUrlSeed

        public boolean hasKeywordAndUrlSeed()
         A Keyword and a specific Url to generate ideas from
 for example, cars, www.example.com/cars.
        .google.ads.googleads.v14.services.KeywordAndUrlSeed keyword_and_url_seed = 2;
        Specified by:
        hasKeywordAndUrlSeed in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        Whether the keywordAndUrlSeed field is set.

      • hasKeywordSeed

        public boolean hasKeywordSeed()
         A Keyword or phrase to generate ideas from, for example, cars.
        .google.ads.googleads.v14.services.KeywordSeed keyword_seed = 3;
        Specified by:
        hasKeywordSeed in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        Whether the keywordSeed field is set.

      • hasUrlSeed

        public boolean hasUrlSeed()
         A specific url to generate ideas from, for example, www.example.com/cars.
        .google.ads.googleads.v14.services.UrlSeed url_seed = 5;
        Specified by:
        hasUrlSeed in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        Whether the urlSeed field is set.

      • getUrlSeed

        public UrlSeed getUrlSeed()
         A specific url to generate ideas from, for example, www.example.com/cars.
        .google.ads.googleads.v14.services.UrlSeed url_seed = 5;
        Specified by:
        getUrlSeed in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        The urlSeed.

      • hasSiteSeed

        public boolean hasSiteSeed()
         The site to generate ideas from, for example, www.example.com.
        .google.ads.googleads.v14.services.SiteSeed site_seed = 11;
        Specified by:
        hasSiteSeed in interface GenerateKeywordIdeasRequestOrBuilder
        Returns:
        Whether the siteSeed field is set.

      • 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 GenerateKeywordIdeasRequest parseFrom​(java.nio.ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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