com.google.ads.googleads.v17.services.GenerateRecommendationsRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/services/recommendation_service.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.services;

public interface GenerateRecommendationsRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.services.GenerateRecommendationsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Required. The ID of the customer generating recommendations.
   * 
   *
   * string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
   * @return The customerId.
   */
  java.lang.String getCustomerId();
  /**
   *    * Required. The ID of the customer generating recommendations.
   * 
   *
   * string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
   * @return The bytes for customerId.
   */
  com.google.protobuf.ByteString
      getCustomerIdBytes();

  /**
   *    * 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];
   * @return A list containing the recommendationTypes.
   */
  java.util.List 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];
   * @return The count of recommendationTypes.
   */
  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];
   * @param index The index of the element to return.
   * @return The recommendationTypes at the given index.
   */
  com.google.ads.googleads.v17.enums.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];
   * @return A list containing the enum numeric values on the wire for recommendationTypes.
   */
  java.util.List
  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];
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of recommendationTypes at the given index.
   */
  int getRecommendationTypesValue(int index);

  /**
   *    * 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];
   * @return The enum numeric value on the wire for advertisingChannelType.
   */
  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];
   * @return The advertisingChannelType.
   */
  com.google.ads.googleads.v17.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType getAdvertisingChannelType();

  /**
   *    * 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];
   * @return Whether the campaignSitelinkCount field is set.
   */
  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];
   * @return The campaignSitelinkCount.
   */
  int getCampaignSitelinkCount();

  /**
   *    * 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];
   * @return Whether the conversionTrackingStatus field is set.
   */
  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];
   * @return The enum numeric value on the wire for conversionTrackingStatus.
   */
  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];
   * @return The conversionTrackingStatus.
   */
  com.google.ads.googleads.v17.enums.ConversionTrackingStatusEnum.ConversionTrackingStatus getConversionTrackingStatus();

  /**
   *    * 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];
   * @return Whether the biddingInfo field is set.
   */
  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];
   * @return The biddingInfo.
   */
  com.google.ads.googleads.v17.services.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];
   */
  com.google.ads.googleads.v17.services.GenerateRecommendationsRequest.BiddingInfoOrBuilder getBiddingInfoOrBuilder();

  /**
   *    * 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];
   */
  java.util.List 
      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];
   */
  com.google.ads.googleads.v17.services.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];
   */
  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];
   */
  java.util.List 
      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];
   */
  com.google.ads.googleads.v17.services.GenerateRecommendationsRequest.AdGroupInfoOrBuilder getAdGroupInfoOrBuilder(
      int index);

  /**
   *    * 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];
   * @return Whether the seedInfo field is set.
   */
  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];
   * @return The seedInfo.
   */
  com.google.ads.googleads.v17.services.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];
   */
  com.google.ads.googleads.v17.services.GenerateRecommendationsRequest.SeedInfoOrBuilder getSeedInfoOrBuilder();
}