Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/searchads360_v23/classes.rb,
lib/google/apis/searchads360_v23/representations.rb,
lib/google/apis/searchads360_v23/representations.rb

Overview

Request message for RecommendationService.GenerateRecommendations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequest

Returns a new instance of GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequest.



42132
42133
42134
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42132

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#ad_group_info ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestAdGroupInfo>

Optional. Current AdGroup Information. Supports information from a single AdGroup. This field is optional for the following recommendation_types: KEYWORD Corresponds to the JSON property adGroupInfo

Returns:



41997
41998
41999
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 41997

def ad_group_info
  @ad_group_info
end

#advertising_channel_type ⇒ String

Required. Advertising channel type of the campaign. The following advertising_channel_types are supported for recommendation generation: PERFORMANCE_MAX and SEARCH Corresponds to the JSON property advertisingChannelType

Returns:

  • (String) 


42004
42005
42006
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42004

def advertising_channel_type
  @advertising_channel_type
end

#asset_group_info ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestAssetGroupInfo>

Optional. Current AssetGroup Information. This field is required for the following recommendation_types: CAMPAIGN_BUDGET Corresponds to the JSON property assetGroupInfo

Returns:



42010
42011
42012
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42010

def asset_group_info
  @asset_group_info
end

#bidding_info ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestBiddingInfo

Current bidding information of the campaign. Provides a wrapper for bidding- related signals that inform recommendations. Corresponds to the JSON property biddingInfo

Returns:



42016
42017
42018
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42016

def bidding_info
  @bidding_info
end

#budget_info ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestBudgetInfo

Current budget information of the campaign. Corresponds to the JSON property budgetInfo

Returns:



42021
42022
42023
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42021

def budget_info
  @budget_info
end

#campaign_call_asset_count ⇒ Fixnum

Optional. Current campaign call asset count. This field is optional for the following recommendation_types: CAMPAIGN_BUDGET Corresponds to the JSON property campaignCallAssetCount

Returns:

  • (Fixnum) 


42027
42028
42029
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42027

def campaign_call_asset_count
  @campaign_call_asset_count
end

#campaign_image_asset_count ⇒ Fixnum

Optional. Current campaign image asset count. This field is optional for the following recommendation_types: CAMPAIGN_BUDGET Corresponds to the JSON property campaignImageAssetCount

Returns:

  • (Fixnum) 


42033
42034
42035
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42033

def campaign_image_asset_count
  @campaign_image_asset_count
end

#campaign_sitelink_count ⇒ Fixnum

Optional. Number of sitelinks on the campaign. This field is necessary for the following recommendation_types: SITELINK_ASSET Corresponds to the JSON property campaignSitelinkCount

Returns:

  • (Fixnum) 


42039
42040
42041
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42039

def campaign_sitelink_count
  @campaign_sitelink_count
end

#conversion_tracking_status ⇒ String

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 Corresponds to the JSON property conversionTrackingStatus

Returns:

  • (String) 


42047
42048
42049
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42047

def conversion_tracking_status
  @conversion_tracking_status
end

#country_codes ⇒ Array<String>

Optional. Current campaign country codes. This field is required for the following recommendation_types: CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH Corresponds to the JSON property countryCodes

Returns:

  • (Array<String>) 


42054
42055
42056
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42054

def country_codes
  @country_codes
end

#is_new_customer ⇒ Boolean Also known as: is_new_customer?

Optional. Whether or not this customer should be treated as a "new" customer ( that is, a customer who has not yet created a campaign). Setting this to true will cause the backend to generate recommendations using a dedicated recommendation model for onboarding new customers, as opposed to the default model for existing customers. This is only recommended for customers with 0 campaigns. This field is optional for the following recommendation_types: CAMPAIGN_BUDGET Corresponds to the JSON property isNewCustomer

Returns:

  • (Boolean) 


42065
42066
42067
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42065

def is_new_customer
  @is_new_customer
end

#language_codes ⇒ Array<String>

Optional. Current campaign language codes. This field is required for the following recommendation_types: CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH Corresponds to the JSON property languageCodes

Returns:

  • (Array<String>) 


42073
42074
42075
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42073

def language_codes
  @language_codes
end

#merchant_center_account_id ⇒ Fixnum

Optional. Merchant Center account ID. This field should only be set when advertising_channel_type is PERFORMANCE_MAX. Setting this field causes RecommendationService to generate recommendations for Performance Max for retail instead of standard Performance Max. This field is optional for the following recommendation_types: CAMPAIGN_BUDGET Corresponds to the JSON property merchantCenterAccountId

Returns:

  • (Fixnum) 


42082
42083
42084
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42082

def 
  @merchant_center_account_id
end

#negative_locations_ids ⇒ Array<Fixnum>

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 Corresponds to the JSON property negativeLocationsIds

Returns:

  • (Array<Fixnum>) 


42089
42090
42091
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42089

def negative_locations_ids
  @negative_locations_ids
end

#positive_locations_ids ⇒ Array<Fixnum>

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 Corresponds to the JSON property positiveLocationsIds

Returns:

  • (Array<Fixnum>) 


42096
42097
42098
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42096

def positive_locations_ids
  @positive_locations_ids
end

#recommendation_types ⇒ Array<String>

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 Corresponds to the JSON property recommendationTypes

Returns:

  • (Array<String>) 


42109
42110
42111
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42109

def recommendation_types
  @recommendation_types
end

#seed_info ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestSeedInfo

A keyword seed and a specific url to generate keywords from. Corresponds to the JSON property seedInfo

Returns:



42114
42115
42116
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42114

def seed_info
  @seed_info
end

#target_content_network ⇒ Boolean Also known as: target_content_network?

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 Corresponds to the JSON property targetContentNetwork

Returns:

  • (Boolean) 


42121
42122
42123
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42121

def target_content_network
  @target_content_network
end

#target_partner_search_network ⇒ Boolean Also known as: target_partner_search_network?

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 Corresponds to the JSON property targetPartnerSearchNetwork

Returns:

  • (Boolean) 


42129
42130
42131
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42129

def target_partner_search_network
  @target_partner_search_network
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



42137
42138
42139
42140
42141
42142
42143
42144
42145
42146
42147
42148
42149
42150
42151
42152
42153
42154
42155
42156
42157
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 42137

def update!(**args)
  @ad_group_info = args[:ad_group_info] if args.key?(:ad_group_info)
  @advertising_channel_type = args[:advertising_channel_type] if args.key?(:advertising_channel_type)
  @asset_group_info = args[:asset_group_info] if args.key?(:asset_group_info)
  @bidding_info = args[:bidding_info] if args.key?(:bidding_info)
  @budget_info = args[:budget_info] if args.key?(:budget_info)
  @campaign_call_asset_count = args[:campaign_call_asset_count] if args.key?(:campaign_call_asset_count)
  @campaign_image_asset_count = args[:campaign_image_asset_count] if args.key?(:campaign_image_asset_count)
  @campaign_sitelink_count = args[:campaign_sitelink_count] if args.key?(:campaign_sitelink_count)
  @conversion_tracking_status = args[:conversion_tracking_status] if args.key?(:conversion_tracking_status)
  @country_codes = args[:country_codes] if args.key?(:country_codes)
  @is_new_customer = args[:is_new_customer] if args.key?(:is_new_customer)
  @language_codes = args[:language_codes] if args.key?(:language_codes)
  @merchant_center_account_id = args[:merchant_center_account_id] if args.key?(:merchant_center_account_id)
  @negative_locations_ids = args[:negative_locations_ids] if args.key?(:negative_locations_ids)
  @positive_locations_ids = args[:positive_locations_ids] if args.key?(:positive_locations_ids)
  @recommendation_types = args[:recommendation_types] if args.key?(:recommendation_types)
  @seed_info = args[:seed_info] if args.key?(:seed_info)
  @target_content_network = args[:target_content_network] if args.key?(:target_content_network)
  @target_partner_search_network = args[:target_partner_search_network] if args.key?(:target_partner_search_network)
end