Package com.google.ads.googleads.v10.services

Interface GenerateKeywordIdeasRequestOrBuilder

    • Method Detail

      • getCustomerId

        java.lang.String getCustomerId()
         The ID of the customer with the recommendation.
        string customer_id = 1;
        Returns:
        The customerId.

      • getCustomerIdBytes

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

      • hasLanguage

        boolean hasLanguage()
         The resource name of the language to target.
 Required
        optional string language = 14;
        Returns:
        Whether the language field is set.

      • getLanguage

        java.lang.String getLanguage()
         The resource name of the language to target.
 Required
        optional string language = 14;
        Returns:
        The language.

      • getLanguageBytes

        com.google.protobuf.ByteString getLanguageBytes()
         The resource name of the language to target.
 Required
        optional string language = 14;
        Returns:
        The bytes for language.

      • getGeoTargetConstantsList

        java.util.List<java.lang.String> getGeoTargetConstantsList()
         The resource names of the location to target.
 Max 10
        repeated string geo_target_constants = 15;
        Returns:
        A list containing the geoTargetConstants.

      • getGeoTargetConstantsCount

        int getGeoTargetConstantsCount()
         The resource names of the location to target.
 Max 10
        repeated string geo_target_constants = 15;
        Returns:
        The count of geoTargetConstants.

      • getGeoTargetConstants

        java.lang.String getGeoTargetConstants​(int index)
         The resource names of the location to target.
 Max 10
        repeated string geo_target_constants = 15;
        Parameters:
        index - The index of the element to return.
        Returns:
        The geoTargetConstants at the given index.

      • getGeoTargetConstantsBytes

        com.google.protobuf.ByteString getGeoTargetConstantsBytes​(int index)
         The resource names of the location to target.
 Max 10
        repeated string geo_target_constants = 15;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the geoTargetConstants at the given index.

      • getIncludeAdultKeywords

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

      • getPageToken

        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;
        Returns:
        The pageToken.

      • getPageTokenBytes

        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;
        Returns:
        The bytes for pageToken.

      • getPageSize

        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;
        Returns:
        The pageSize.

      • getKeywordPlanNetworkValue

        int getKeywordPlanNetworkValue()
         Targeting network.
        .google.ads.googleads.v10.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 9;
        Returns:
        The enum numeric value on the wire for keywordPlanNetwork.

      • getKeywordPlanNetwork

        KeywordPlanNetworkEnum.KeywordPlanNetwork getKeywordPlanNetwork()
         Targeting network.
        .google.ads.googleads.v10.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 9;
        Returns:
        The keywordPlanNetwork.

      • getKeywordAnnotationList

        java.util.List<KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation> getKeywordAnnotationList()
         The keyword annotations to include in response.
        repeated .google.ads.googleads.v10.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
        Returns:
        A list containing the keywordAnnotation.

      • getKeywordAnnotationCount

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

      • getKeywordAnnotation

        KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation getKeywordAnnotation​(int index)
         The keyword annotations to include in response.
        repeated .google.ads.googleads.v10.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
        Parameters:
        index - The index of the element to return.
        Returns:
        The keywordAnnotation at the given index.

      • getKeywordAnnotationValueList

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

      • getKeywordAnnotationValue

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

      • hasAggregateMetrics

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

      • getAggregateMetrics

        KeywordPlanAggregateMetrics getAggregateMetrics()
         The aggregate fields to include in response.
        .google.ads.googleads.v10.common.KeywordPlanAggregateMetrics aggregate_metrics = 16;
        Returns:
        The aggregateMetrics.

      • getAggregateMetricsOrBuilder

        KeywordPlanAggregateMetricsOrBuilder getAggregateMetricsOrBuilder()
         The aggregate fields to include in response.
        .google.ads.googleads.v10.common.KeywordPlanAggregateMetrics aggregate_metrics = 16;

      • hasHistoricalMetricsOptions

        boolean hasHistoricalMetricsOptions()
         The options for historical metrics data.
        .google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 18;
        Returns:
        Whether the historicalMetricsOptions field is set.

      • getHistoricalMetricsOptions

        HistoricalMetricsOptions getHistoricalMetricsOptions()
         The options for historical metrics data.
        .google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 18;
        Returns:
        The historicalMetricsOptions.

      • getHistoricalMetricsOptionsOrBuilder

        HistoricalMetricsOptionsOrBuilder getHistoricalMetricsOptionsOrBuilder()
         The options for historical metrics data.
        .google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 18;

      • hasKeywordAndUrlSeed

        boolean hasKeywordAndUrlSeed()
         A Keyword and a specific Url to generate ideas from
 e.g. cars, www.example.com/cars.
        .google.ads.googleads.v10.services.KeywordAndUrlSeed keyword_and_url_seed = 2;
        Returns:
        Whether the keywordAndUrlSeed field is set.

      • getKeywordAndUrlSeed

        KeywordAndUrlSeed getKeywordAndUrlSeed()
         A Keyword and a specific Url to generate ideas from
 e.g. cars, www.example.com/cars.
        .google.ads.googleads.v10.services.KeywordAndUrlSeed keyword_and_url_seed = 2;
        Returns:
        The keywordAndUrlSeed.

      • getKeywordAndUrlSeedOrBuilder

        KeywordAndUrlSeedOrBuilder getKeywordAndUrlSeedOrBuilder()
         A Keyword and a specific Url to generate ideas from
 e.g. cars, www.example.com/cars.
        .google.ads.googleads.v10.services.KeywordAndUrlSeed keyword_and_url_seed = 2;

      • hasKeywordSeed

        boolean hasKeywordSeed()
         A Keyword or phrase to generate ideas from, e.g. cars.
        .google.ads.googleads.v10.services.KeywordSeed keyword_seed = 3;
        Returns:
        Whether the keywordSeed field is set.

      • getKeywordSeed

        KeywordSeed getKeywordSeed()
         A Keyword or phrase to generate ideas from, e.g. cars.
        .google.ads.googleads.v10.services.KeywordSeed keyword_seed = 3;
        Returns:
        The keywordSeed.

      • getKeywordSeedOrBuilder

        KeywordSeedOrBuilder getKeywordSeedOrBuilder()
         A Keyword or phrase to generate ideas from, e.g. cars.
        .google.ads.googleads.v10.services.KeywordSeed keyword_seed = 3;

      • hasUrlSeed

        boolean hasUrlSeed()
         A specific url to generate ideas from, e.g. www.example.com/cars.
        .google.ads.googleads.v10.services.UrlSeed url_seed = 5;
        Returns:
        Whether the urlSeed field is set.

      • getUrlSeed

        UrlSeed getUrlSeed()
         A specific url to generate ideas from, e.g. www.example.com/cars.
        .google.ads.googleads.v10.services.UrlSeed url_seed = 5;
        Returns:
        The urlSeed.

      • getUrlSeedOrBuilder

        UrlSeedOrBuilder getUrlSeedOrBuilder()
         A specific url to generate ideas from, e.g. www.example.com/cars.
        .google.ads.googleads.v10.services.UrlSeed url_seed = 5;

      • hasSiteSeed

        boolean hasSiteSeed()
         The site to generate ideas from, e.g. www.example.com.
        .google.ads.googleads.v10.services.SiteSeed site_seed = 11;
        Returns:
        Whether the siteSeed field is set.

      • getSiteSeed

        SiteSeed getSiteSeed()
         The site to generate ideas from, e.g. www.example.com.
        .google.ads.googleads.v10.services.SiteSeed site_seed = 11;
        Returns:
        The siteSeed.

      • getSiteSeedOrBuilder

        SiteSeedOrBuilder getSiteSeedOrBuilder()
         The site to generate ideas from, e.g. www.example.com.
        .google.ads.googleads.v10.services.SiteSeed site_seed = 11;