Package com.google.ads.googleads.v17.services

Interface GenerateRecommendationsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateRecommendationsRequest, GenerateRecommendationsRequest.Builder
public interface GenerateRecommendationsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCustomerId

      String getCustomerId()
       Required. The ID of the customer generating recommendations.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The customerId.

    • getCustomerIdBytes

      com.google.protobuf.ByteString getCustomerIdBytes()
       Required. The ID of the customer generating recommendations.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for customerId.

    • getRecommendationTypesList

      List<RecommendationTypeEnum.RecommendationType> getRecommendationTypesList()
       Required. List of eligible recommendation_types to generate. If the
 uploaded criteria isn't sufficient to make a recommendation, or the
 campaign is already in the recommended state, no recommendation will be
 returned for that type. Generally, a recommendation is returned if all
 required fields for that recommendation_type are uploaded, but there are
 cases where this is still not sufficient.

 The following recommendation_types are supported for recommendation
 generation:
 KEYWORD, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
 MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
 SITELINK_ASSET, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
      repeated .google.ads.googleads.v17.enums.RecommendationTypeEnum.RecommendationType recommendation_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      A list containing the recommendationTypes.

    • getRecommendationTypesCount

      int getRecommendationTypesCount()
       Required. List of eligible recommendation_types to generate. If the
 uploaded criteria isn't sufficient to make a recommendation, or the
 campaign is already in the recommended state, no recommendation will be
 returned for that type. Generally, a recommendation is returned if all
 required fields for that recommendation_type are uploaded, but there are
 cases where this is still not sufficient.

 The following recommendation_types are supported for recommendation
 generation:
 KEYWORD, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
 MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
 SITELINK_ASSET, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
      repeated .google.ads.googleads.v17.enums.RecommendationTypeEnum.RecommendationType recommendation_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The count of recommendationTypes.

    • getRecommendationTypes

      RecommendationTypeEnum.RecommendationType getRecommendationTypes(int index)
       Required. List of eligible recommendation_types to generate. If the
 uploaded criteria isn't sufficient to make a recommendation, or the
 campaign is already in the recommended state, no recommendation will be
 returned for that type. Generally, a recommendation is returned if all
 required fields for that recommendation_type are uploaded, but there are
 cases where this is still not sufficient.

 The following recommendation_types are supported for recommendation
 generation:
 KEYWORD, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
 MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
 SITELINK_ASSET, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
      repeated .google.ads.googleads.v17.enums.RecommendationTypeEnum.RecommendationType recommendation_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the element to return.
      Returns:
      The recommendationTypes at the given index.

    • getRecommendationTypesValueList

      List<Integer> getRecommendationTypesValueList()
       Required. List of eligible recommendation_types to generate. If the
 uploaded criteria isn't sufficient to make a recommendation, or the
 campaign is already in the recommended state, no recommendation will be
 returned for that type. Generally, a recommendation is returned if all
 required fields for that recommendation_type are uploaded, but there are
 cases where this is still not sufficient.

 The following recommendation_types are supported for recommendation
 generation:
 KEYWORD, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
 MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
 SITELINK_ASSET, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
      repeated .google.ads.googleads.v17.enums.RecommendationTypeEnum.RecommendationType recommendation_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      A list containing the enum numeric values on the wire for recommendationTypes.

    • getRecommendationTypesValue

      int getRecommendationTypesValue(int index)
       Required. List of eligible recommendation_types to generate. If the
 uploaded criteria isn't sufficient to make a recommendation, or the
 campaign is already in the recommended state, no recommendation will be
 returned for that type. Generally, a recommendation is returned if all
 required fields for that recommendation_type are uploaded, but there are
 cases where this is still not sufficient.

 The following recommendation_types are supported for recommendation
 generation:
 KEYWORD, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
 MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
 SITELINK_ASSET, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
      repeated .google.ads.googleads.v17.enums.RecommendationTypeEnum.RecommendationType recommendation_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of recommendationTypes at the given index.

    • getAdvertisingChannelTypeValue

      int getAdvertisingChannelTypeValue()
       Required. Advertising channel type of the campaign.
 The following advertising_channel_types are supported for recommendation
 generation:
 PERFORMANCE_MAX and SEARCH
      .google.ads.googleads.v17.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for advertisingChannelType.

    • getAdvertisingChannelType

      AdvertisingChannelTypeEnum.AdvertisingChannelType getAdvertisingChannelType()
       Required. Advertising channel type of the campaign.
 The following advertising_channel_types are supported for recommendation
 generation:
 PERFORMANCE_MAX and SEARCH
      .google.ads.googleads.v17.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The advertisingChannelType.

    • hasCampaignSitelinkCount

      boolean hasCampaignSitelinkCount()
       Optional. Number of sitelinks on the campaign.
 This field is necessary for the following recommendation_types:
 SITELINK_ASSET
      optional int32 campaign_sitelink_count = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the campaignSitelinkCount field is set.

    • getCampaignSitelinkCount

      int getCampaignSitelinkCount()
       Optional. Number of sitelinks on the campaign.
 This field is necessary for the following recommendation_types:
 SITELINK_ASSET
      optional int32 campaign_sitelink_count = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The campaignSitelinkCount.

    • hasConversionTrackingStatus

      boolean hasConversionTrackingStatus()
       Optional. Current conversion tracking status.
 This field is necessary for the following recommendation_types:
 MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
 MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
 TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
      optional .google.ads.googleads.v17.enums.ConversionTrackingStatusEnum.ConversionTrackingStatus conversion_tracking_status = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the conversionTrackingStatus field is set.

    • getConversionTrackingStatusValue

      int getConversionTrackingStatusValue()
       Optional. Current conversion tracking status.
 This field is necessary for the following recommendation_types:
 MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
 MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
 TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
      optional .google.ads.googleads.v17.enums.ConversionTrackingStatusEnum.ConversionTrackingStatus conversion_tracking_status = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for conversionTrackingStatus.

    • getConversionTrackingStatus

      ConversionTrackingStatusEnum.ConversionTrackingStatus getConversionTrackingStatus()
       Optional. Current conversion tracking status.
 This field is necessary for the following recommendation_types:
 MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
 MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
 TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
      optional .google.ads.googleads.v17.enums.ConversionTrackingStatusEnum.ConversionTrackingStatus conversion_tracking_status = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The conversionTrackingStatus.

    • hasBiddingInfo

      boolean hasBiddingInfo()
       Optional. Current bidding information of the campaign.
 This field is necessary for the following recommendation_types:
 MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
 MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
 TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
      optional .google.ads.googleads.v17.services.GenerateRecommendationsRequest.BiddingInfo bidding_info = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the biddingInfo field is set.

    • getBiddingInfo

      GenerateRecommendationsRequest.BiddingInfo getBiddingInfo()
       Optional. Current bidding information of the campaign.
 This field is necessary for the following recommendation_types:
 MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
 MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
 TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
      optional .google.ads.googleads.v17.services.GenerateRecommendationsRequest.BiddingInfo bidding_info = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The biddingInfo.

    • getBiddingInfoOrBuilder

      GenerateRecommendationsRequest.BiddingInfoOrBuilder getBiddingInfoOrBuilder()
       Optional. Current bidding information of the campaign.
 This field is necessary for the following recommendation_types:
 MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN,
 MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS,
 TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
      optional .google.ads.googleads.v17.services.GenerateRecommendationsRequest.BiddingInfo bidding_info = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getAdGroupInfoList

      List<GenerateRecommendationsRequest.AdGroupInfo> getAdGroupInfoList()
       Optional. Current AdGroup Information.
 Supports information from a single AdGroup.
 This field is optional for the following recommendation_types:
 KEYWORD
      repeated .google.ads.googleads.v17.services.GenerateRecommendationsRequest.AdGroupInfo ad_group_info = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getAdGroupInfo

      GenerateRecommendationsRequest.AdGroupInfo getAdGroupInfo(int index)
       Optional. Current AdGroup Information.
 Supports information from a single AdGroup.
 This field is optional for the following recommendation_types:
 KEYWORD
      repeated .google.ads.googleads.v17.services.GenerateRecommendationsRequest.AdGroupInfo ad_group_info = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getAdGroupInfoCount

      int getAdGroupInfoCount()
       Optional. Current AdGroup Information.
 Supports information from a single AdGroup.
 This field is optional for the following recommendation_types:
 KEYWORD
      repeated .google.ads.googleads.v17.services.GenerateRecommendationsRequest.AdGroupInfo ad_group_info = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getAdGroupInfoOrBuilderList

      List<? extends GenerateRecommendationsRequest.AdGroupInfoOrBuilder> getAdGroupInfoOrBuilderList()
       Optional. Current AdGroup Information.
 Supports information from a single AdGroup.
 This field is optional for the following recommendation_types:
 KEYWORD
      repeated .google.ads.googleads.v17.services.GenerateRecommendationsRequest.AdGroupInfo ad_group_info = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getAdGroupInfoOrBuilder

      GenerateRecommendationsRequest.AdGroupInfoOrBuilder getAdGroupInfoOrBuilder(int index)
       Optional. Current AdGroup Information.
 Supports information from a single AdGroup.
 This field is optional for the following recommendation_types:
 KEYWORD
      repeated .google.ads.googleads.v17.services.GenerateRecommendationsRequest.AdGroupInfo ad_group_info = 7 [(.google.api.field_behavior) = OPTIONAL];

    • hasSeedInfo

      boolean hasSeedInfo()
       Optional. Seed information for Keywords.
 This field is necessary for the following recommendation_types:
 KEYWORD
      optional .google.ads.googleads.v17.services.GenerateRecommendationsRequest.SeedInfo seed_info = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the seedInfo field is set.

    • getSeedInfo

      GenerateRecommendationsRequest.SeedInfo getSeedInfo()
       Optional. Seed information for Keywords.
 This field is necessary for the following recommendation_types:
 KEYWORD
      optional .google.ads.googleads.v17.services.GenerateRecommendationsRequest.SeedInfo seed_info = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The seedInfo.

    • getSeedInfoOrBuilder

      GenerateRecommendationsRequest.SeedInfoOrBuilder getSeedInfoOrBuilder()
       Optional. Seed information for Keywords.
 This field is necessary for the following recommendation_types:
 KEYWORD
      optional .google.ads.googleads.v17.services.GenerateRecommendationsRequest.SeedInfo seed_info = 8 [(.google.api.field_behavior) = OPTIONAL];