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

Interface GenerateKeywordHistoricalMetricsRequestOrBuilder

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

      • getKeywordsList

        java.util.List<java.lang.String> getKeywordsList()
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Returns:
        A list containing the keywords.

      • getKeywordsCount

        int getKeywordsCount()
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Returns:
        The count of keywords.

      • getKeywords

        java.lang.String getKeywords​(int index)
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Parameters:
        index - The index of the element to return.
        Returns:
        The keywords at the given index.

      • getKeywordsBytes

        com.google.protobuf.ByteString getKeywordsBytes​(int index)
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the keywords at the given index.

      • hasLanguage

        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 = 4;
        Returns:
        Whether the language field is set.

      • getLanguage

        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 = 4;
        Returns:
        The language.

      • getLanguageBytes

        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 = 4;
        Returns:
        The bytes for language.

      • getIncludeAdultKeywords

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

      • getGeoTargetConstantsList

        java.util.List<java.lang.String> 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 = 6;
        Returns:
        A list containing the geoTargetConstants.

      • getGeoTargetConstantsCount

        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 = 6;
        Returns:
        The count of geoTargetConstants.

      • getGeoTargetConstants

        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 = 6;
        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. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the geoTargetConstants at the given index.

      • getKeywordPlanNetworkValue

        int getKeywordPlanNetworkValue()
         Targeting network.
 If not set, Google Search And Partners Network will be used.
        .google.ads.googleads.v15.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 7;
        Returns:
        The enum numeric value on the wire for keywordPlanNetwork.

      • getKeywordPlanNetwork

        KeywordPlanNetworkEnum.KeywordPlanNetwork getKeywordPlanNetwork()
         Targeting network.
 If not set, Google Search And Partners Network will be used.
        .google.ads.googleads.v15.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 7;
        Returns:
        The keywordPlanNetwork.

      • hasAggregateMetrics

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

      • getAggregateMetrics

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

      • getAggregateMetricsOrBuilder

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

      • hasHistoricalMetricsOptions

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

      • getHistoricalMetricsOptions

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

      • getHistoricalMetricsOptionsOrBuilder

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