Package com.google.ads.googleads.v18.services

Class GenerateRecommendationsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.services.GenerateRecommendationsRequest
All Implemented Interfaces:
GenerateRecommendationsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class GenerateRecommendationsRequest extends com.google.protobuf.GeneratedMessageV3 implements GenerateRecommendationsRequestOrBuilder
 Request message for
 [RecommendationService.GenerateRecommendations][google.ads.googleads.v18.services.RecommendationService.GenerateRecommendations].
Protobuf type google.ads.googleads.v18.services.GenerateRecommendationsRequest
See Also:

  • Field Details

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • RECOMMENDATION_TYPES_FIELD_NUMBER

      public static final int RECOMMENDATION_TYPES_FIELD_NUMBER
      See Also:

    • ADVERTISING_CHANNEL_TYPE_FIELD_NUMBER

      public static final int ADVERTISING_CHANNEL_TYPE_FIELD_NUMBER
      See Also:

    • CONVERSION_TRACKING_STATUS_FIELD_NUMBER

      public static final int CONVERSION_TRACKING_STATUS_FIELD_NUMBER
      See Also:

    • BIDDING_INFO_FIELD_NUMBER

      public static final int BIDDING_INFO_FIELD_NUMBER
      See Also:

    • AD_GROUP_INFO_FIELD_NUMBER

      public static final int AD_GROUP_INFO_FIELD_NUMBER
      See Also:

    • SEED_INFO_FIELD_NUMBER

      public static final int SEED_INFO_FIELD_NUMBER
      See Also:

    • BUDGET_INFO_FIELD_NUMBER

      public static final int BUDGET_INFO_FIELD_NUMBER
      See Also:

    • CAMPAIGN_IMAGE_ASSET_COUNT_FIELD_NUMBER

      public static final int CAMPAIGN_IMAGE_ASSET_COUNT_FIELD_NUMBER
      See Also:

    • CAMPAIGN_CALL_ASSET_COUNT_FIELD_NUMBER

      public static final int CAMPAIGN_CALL_ASSET_COUNT_FIELD_NUMBER
      See Also:

    • COUNTRY_CODES_FIELD_NUMBER

      public static final int COUNTRY_CODES_FIELD_NUMBER
      See Also:

    • LANGUAGE_CODES_FIELD_NUMBER

      public static final int LANGUAGE_CODES_FIELD_NUMBER
      See Also:

    • POSITIVE_LOCATIONS_IDS_FIELD_NUMBER

      public static final int POSITIVE_LOCATIONS_IDS_FIELD_NUMBER
      See Also:

    • NEGATIVE_LOCATIONS_IDS_FIELD_NUMBER

      public static final int NEGATIVE_LOCATIONS_IDS_FIELD_NUMBER
      See Also:

    • ASSET_GROUP_INFO_FIELD_NUMBER

      public static final int ASSET_GROUP_INFO_FIELD_NUMBER
      See Also:

    • TARGET_PARTNER_SEARCH_NETWORK_FIELD_NUMBER

      public static final int TARGET_PARTNER_SEARCH_NETWORK_FIELD_NUMBER
      See Also:

    • TARGET_CONTENT_NETWORK_FIELD_NUMBER

      public static final int TARGET_CONTENT_NETWORK_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected 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

    • getCustomerId

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

    • getCustomerIdBytes

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

    • getRecommendationTypesList

      public 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:
 CAMPAIGN_BUDGET, 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.v18.enums.RecommendationTypeEnum.RecommendationType recommendation_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRecommendationTypesList in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      A list containing the recommendationTypes.

    • getRecommendationTypesCount

      public 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:
 CAMPAIGN_BUDGET, 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.v18.enums.RecommendationTypeEnum.RecommendationType recommendation_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRecommendationTypesCount in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The count of recommendationTypes.

    • getRecommendationTypes

      public 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:
 CAMPAIGN_BUDGET, 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.v18.enums.RecommendationTypeEnum.RecommendationType recommendation_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRecommendationTypes in interface GenerateRecommendationsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The recommendationTypes at the given index.

    • getRecommendationTypesValueList

      public 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:
 CAMPAIGN_BUDGET, 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.v18.enums.RecommendationTypeEnum.RecommendationType recommendation_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRecommendationTypesValueList in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for recommendationTypes.

    • getRecommendationTypesValue

      public 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:
 CAMPAIGN_BUDGET, 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.v18.enums.RecommendationTypeEnum.RecommendationType recommendation_types = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRecommendationTypesValue in interface GenerateRecommendationsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of recommendationTypes at the given index.

    • getAdvertisingChannelTypeValue

      public 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.v18.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAdvertisingChannelTypeValue in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The enum numeric value on the wire for advertisingChannelType.

    • getAdvertisingChannelType

      public 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.v18.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAdvertisingChannelType in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The advertisingChannelType.

    • hasCampaignSitelinkCount

      public 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];
      Specified by:
      hasCampaignSitelinkCount in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      Whether the campaignSitelinkCount field is set.

    • getCampaignSitelinkCount

      public 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];
      Specified by:
      getCampaignSitelinkCount in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The campaignSitelinkCount.

    • hasConversionTrackingStatus

      public 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.v18.enums.ConversionTrackingStatusEnum.ConversionTrackingStatus conversion_tracking_status = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasConversionTrackingStatus in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      Whether the conversionTrackingStatus field is set.

    • getConversionTrackingStatusValue

      public 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.v18.enums.ConversionTrackingStatusEnum.ConversionTrackingStatus conversion_tracking_status = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getConversionTrackingStatusValue in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The enum numeric value on the wire for conversionTrackingStatus.

    • getConversionTrackingStatus

      public 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.v18.enums.ConversionTrackingStatusEnum.ConversionTrackingStatus conversion_tracking_status = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getConversionTrackingStatus in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The conversionTrackingStatus.

    • hasBiddingInfo

      public boolean hasBiddingInfo()
       Optional. Current bidding information of the campaign.
 This field is necessary for the following recommendation_types:
 CAMPAIGN_BUDGET, 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.v18.services.GenerateRecommendationsRequest.BiddingInfo bidding_info = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasBiddingInfo in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      Whether the biddingInfo field is set.

    • getBiddingInfo

      public GenerateRecommendationsRequest.BiddingInfo getBiddingInfo()
       Optional. Current bidding information of the campaign.
 This field is necessary for the following recommendation_types:
 CAMPAIGN_BUDGET, 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.v18.services.GenerateRecommendationsRequest.BiddingInfo bidding_info = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBiddingInfo in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The biddingInfo.

    • getBiddingInfoOrBuilder

      public GenerateRecommendationsRequest.BiddingInfoOrBuilder getBiddingInfoOrBuilder()
       Optional. Current bidding information of the campaign.
 This field is necessary for the following recommendation_types:
 CAMPAIGN_BUDGET, 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.v18.services.GenerateRecommendationsRequest.BiddingInfo bidding_info = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBiddingInfoOrBuilder in interface GenerateRecommendationsRequestOrBuilder

    • getAdGroupInfoList

      public List<GenerateRecommendationsRequest.AdGroupInfo> getAdGroupInfoList()
       Optional. Current AdGroup Information.
 Supports information from a single AdGroup.
 This field is optional for the following recommendation_types:
 KEYWORD
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated .google.ads.googleads.v18.services.GenerateRecommendationsRequest.AdGroupInfo ad_group_info = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdGroupInfoList in interface GenerateRecommendationsRequestOrBuilder

    • getAdGroupInfoOrBuilderList

      public 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
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated .google.ads.googleads.v18.services.GenerateRecommendationsRequest.AdGroupInfo ad_group_info = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdGroupInfoOrBuilderList in interface GenerateRecommendationsRequestOrBuilder

    • getAdGroupInfoCount

      public int getAdGroupInfoCount()
       Optional. Current AdGroup Information.
 Supports information from a single AdGroup.
 This field is optional for the following recommendation_types:
 KEYWORD
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated .google.ads.googleads.v18.services.GenerateRecommendationsRequest.AdGroupInfo ad_group_info = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdGroupInfoCount in interface GenerateRecommendationsRequestOrBuilder

    • getAdGroupInfo

      public 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
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated .google.ads.googleads.v18.services.GenerateRecommendationsRequest.AdGroupInfo ad_group_info = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdGroupInfo in interface GenerateRecommendationsRequestOrBuilder

    • getAdGroupInfoOrBuilder

      public 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
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated .google.ads.googleads.v18.services.GenerateRecommendationsRequest.AdGroupInfo ad_group_info = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdGroupInfoOrBuilder in interface GenerateRecommendationsRequestOrBuilder

    • hasSeedInfo

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

    • getSeedInfo

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

    • getSeedInfoOrBuilder

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

    • hasBudgetInfo

      public boolean hasBudgetInfo()
       Optional. Current budget information.
 This field is optional for the following recommendation_types:
 CAMPAIGN_BUDGET
      optional .google.ads.googleads.v18.services.GenerateRecommendationsRequest.BudgetInfo budget_info = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasBudgetInfo in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      Whether the budgetInfo field is set.

    • getBudgetInfo

      public GenerateRecommendationsRequest.BudgetInfo getBudgetInfo()
       Optional. Current budget information.
 This field is optional for the following recommendation_types:
 CAMPAIGN_BUDGET
      optional .google.ads.googleads.v18.services.GenerateRecommendationsRequest.BudgetInfo budget_info = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBudgetInfo in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The budgetInfo.

    • getBudgetInfoOrBuilder

      public GenerateRecommendationsRequest.BudgetInfoOrBuilder getBudgetInfoOrBuilder()
       Optional. Current budget information.
 This field is optional for the following recommendation_types:
 CAMPAIGN_BUDGET
      optional .google.ads.googleads.v18.services.GenerateRecommendationsRequest.BudgetInfo budget_info = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBudgetInfoOrBuilder in interface GenerateRecommendationsRequestOrBuilder

    • hasCampaignImageAssetCount

      public boolean hasCampaignImageAssetCount()
       Optional. Current campaign image asset count.
 This field is optional for the following recommendation_types:
 CAMPAIGN_BUDGET
      optional int32 campaign_image_asset_count = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCampaignImageAssetCount in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      Whether the campaignImageAssetCount field is set.

    • getCampaignImageAssetCount

      public int getCampaignImageAssetCount()
       Optional. Current campaign image asset count.
 This field is optional for the following recommendation_types:
 CAMPAIGN_BUDGET
      optional int32 campaign_image_asset_count = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCampaignImageAssetCount in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The campaignImageAssetCount.

    • hasCampaignCallAssetCount

      public boolean hasCampaignCallAssetCount()
       Optional. Current campaign call asset count.
 This field is optional for the following recommendation_types:
 CAMPAIGN_BUDGET
      optional int32 campaign_call_asset_count = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCampaignCallAssetCount in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      Whether the campaignCallAssetCount field is set.

    • getCampaignCallAssetCount

      public int getCampaignCallAssetCount()
       Optional. Current campaign call asset count.
 This field is optional for the following recommendation_types:
 CAMPAIGN_BUDGET
      optional int32 campaign_call_asset_count = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCampaignCallAssetCount in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The campaignCallAssetCount.

    • getCountryCodesList

      public com.google.protobuf.ProtocolStringList getCountryCodesList()
       Optional. Current campaign country codes.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated string country_codes = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCountryCodesList in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      A list containing the countryCodes.

    • getCountryCodesCount

      public int getCountryCodesCount()
       Optional. Current campaign country codes.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated string country_codes = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCountryCodesCount in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The count of countryCodes.

    • getCountryCodes

      public String getCountryCodes(int index)
       Optional. Current campaign country codes.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated string country_codes = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCountryCodes in interface GenerateRecommendationsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The countryCodes at the given index.

    • getCountryCodesBytes

      public com.google.protobuf.ByteString getCountryCodesBytes(int index)
       Optional. Current campaign country codes.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated string country_codes = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCountryCodesBytes in interface GenerateRecommendationsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the countryCodes at the given index.

    • getLanguageCodesList

      public com.google.protobuf.ProtocolStringList getLanguageCodesList()
       Optional. Current campaign language codes.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated string language_codes = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLanguageCodesList in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      A list containing the languageCodes.

    • getLanguageCodesCount

      public int getLanguageCodesCount()
       Optional. Current campaign language codes.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated string language_codes = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLanguageCodesCount in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The count of languageCodes.

    • getLanguageCodes

      public String getLanguageCodes(int index)
       Optional. Current campaign language codes.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated string language_codes = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLanguageCodes in interface GenerateRecommendationsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The languageCodes at the given index.

    • getLanguageCodesBytes

      public com.google.protobuf.ByteString getLanguageCodesBytes(int index)
       Optional. Current campaign language codes.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated string language_codes = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLanguageCodesBytes in interface GenerateRecommendationsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the languageCodes at the given index.

    • getPositiveLocationsIdsList

      public List<Long> getPositiveLocationsIdsList()
       Optional. Current campaign positive location ids.
 One of this field OR negative_location_ids is required for the following
 recommendation_types: CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated int64 positive_locations_ids = 15 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPositiveLocationsIdsList in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      A list containing the positiveLocationsIds.

    • getPositiveLocationsIdsCount

      public int getPositiveLocationsIdsCount()
       Optional. Current campaign positive location ids.
 One of this field OR negative_location_ids is required for the following
 recommendation_types: CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated int64 positive_locations_ids = 15 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPositiveLocationsIdsCount in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The count of positiveLocationsIds.

    • getPositiveLocationsIds

      public long getPositiveLocationsIds(int index)
       Optional. Current campaign positive location ids.
 One of this field OR negative_location_ids is required for the following
 recommendation_types: CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated int64 positive_locations_ids = 15 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPositiveLocationsIds in interface GenerateRecommendationsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The positiveLocationsIds at the given index.

    • getNegativeLocationsIdsList

      public List<Long> getNegativeLocationsIdsList()
       Optional. Current campaign negative location ids.
 One of this field OR positive_location_ids is required for the following
 recommendation_types: CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated int64 negative_locations_ids = 16 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNegativeLocationsIdsList in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      A list containing the negativeLocationsIds.

    • getNegativeLocationsIdsCount

      public int getNegativeLocationsIdsCount()
       Optional. Current campaign negative location ids.
 One of this field OR positive_location_ids is required for the following
 recommendation_types: CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated int64 negative_locations_ids = 16 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNegativeLocationsIdsCount in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The count of negativeLocationsIds.

    • getNegativeLocationsIds

      public long getNegativeLocationsIds(int index)
       Optional. Current campaign negative location ids.
 One of this field OR positive_location_ids is required for the following
 recommendation_types: CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH
      repeated int64 negative_locations_ids = 16 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNegativeLocationsIds in interface GenerateRecommendationsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The negativeLocationsIds at the given index.

    • getAssetGroupInfoList

      public List<GenerateRecommendationsRequest.AssetGroupInfo> getAssetGroupInfoList()
       Optional. Current AssetGroup Information.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET
      repeated .google.ads.googleads.v18.services.GenerateRecommendationsRequest.AssetGroupInfo asset_group_info = 17 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAssetGroupInfoList in interface GenerateRecommendationsRequestOrBuilder

    • getAssetGroupInfoOrBuilderList

      public List<? extends GenerateRecommendationsRequest.AssetGroupInfoOrBuilder> getAssetGroupInfoOrBuilderList()
       Optional. Current AssetGroup Information.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET
      repeated .google.ads.googleads.v18.services.GenerateRecommendationsRequest.AssetGroupInfo asset_group_info = 17 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAssetGroupInfoOrBuilderList in interface GenerateRecommendationsRequestOrBuilder

    • getAssetGroupInfoCount

      public int getAssetGroupInfoCount()
       Optional. Current AssetGroup Information.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET
      repeated .google.ads.googleads.v18.services.GenerateRecommendationsRequest.AssetGroupInfo asset_group_info = 17 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAssetGroupInfoCount in interface GenerateRecommendationsRequestOrBuilder

    • getAssetGroupInfo

      public GenerateRecommendationsRequest.AssetGroupInfo getAssetGroupInfo(int index)
       Optional. Current AssetGroup Information.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET
      repeated .google.ads.googleads.v18.services.GenerateRecommendationsRequest.AssetGroupInfo asset_group_info = 17 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAssetGroupInfo in interface GenerateRecommendationsRequestOrBuilder

    • getAssetGroupInfoOrBuilder

      public GenerateRecommendationsRequest.AssetGroupInfoOrBuilder getAssetGroupInfoOrBuilder(int index)
       Optional. Current AssetGroup Information.
 This field is required for the following recommendation_types:
 CAMPAIGN_BUDGET
      repeated .google.ads.googleads.v18.services.GenerateRecommendationsRequest.AssetGroupInfo asset_group_info = 17 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAssetGroupInfoOrBuilder in interface GenerateRecommendationsRequestOrBuilder

    • hasTargetPartnerSearchNetwork

      public boolean hasTargetPartnerSearchNetwork()
       Optional. If true, the campaign is opted into serving ads on the Google
 Partner Network. This field is optional for the following
 recommendation_types: CAMPAIGN_BUDGET
      optional bool target_partner_search_network = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasTargetPartnerSearchNetwork in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      Whether the targetPartnerSearchNetwork field is set.

    • getTargetPartnerSearchNetwork

      public boolean getTargetPartnerSearchNetwork()
       Optional. If true, the campaign is opted into serving ads on the Google
 Partner Network. This field is optional for the following
 recommendation_types: CAMPAIGN_BUDGET
      optional bool target_partner_search_network = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTargetPartnerSearchNetwork in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The targetPartnerSearchNetwork.

    • hasTargetContentNetwork

      public boolean hasTargetContentNetwork()
       Optional. If true, the campaign is opted into serving ads on specified
 placements in the Google Display Network. This field is optional for the
 following recommendation_types: CAMPAIGN_BUDGET
      optional bool target_content_network = 19 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasTargetContentNetwork in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      Whether the targetContentNetwork field is set.

    • getTargetContentNetwork

      public boolean getTargetContentNetwork()
       Optional. If true, the campaign is opted into serving ads on specified
 placements in the Google Display Network. This field is optional for the
 following recommendation_types: CAMPAIGN_BUDGET
      optional bool target_content_network = 19 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTargetContentNetwork in interface GenerateRecommendationsRequestOrBuilder
      Returns:
      The targetContentNetwork.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 GenerateRecommendationsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateRecommendationsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static GenerateRecommendationsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateRecommendationsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GenerateRecommendationsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GenerateRecommendationsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateRecommendationsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateRecommendationsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static GenerateRecommendationsRequest.Builder newBuilder()

    • newBuilder

      public static GenerateRecommendationsRequest.Builder newBuilder(GenerateRecommendationsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static GenerateRecommendationsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<GenerateRecommendationsRequest> parser()

    • getParserForType

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