Show / Hide Table of Contents

Class GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequest

Request message for RecommendationService.GenerateRecommendations.

Inheritance
object
GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequest
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.SA360.v23.Data
Assembly: Google.Apis.SA360.v23.dll
Syntax
public class GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequest : IDirectResponseSchema

Properties

AdGroupInfo

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

Declaration
[JsonProperty("adGroupInfo")]
public virtual IList<GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestAdGroupInfo> AdGroupInfo { get; set; }
Property Value
Type Description
IList<GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestAdGroupInfo>

AdvertisingChannelType

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

Declaration
[JsonProperty("advertisingChannelType")]
public virtual string AdvertisingChannelType { get; set; }
Property Value
Type Description
string

AssetGroupInfo

Optional. Current AssetGroup Information. This field is required for the following recommendation_types: CAMPAIGN_BUDGET

Declaration
[JsonProperty("assetGroupInfo")]
public virtual IList<GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestAssetGroupInfo> AssetGroupInfo { get; set; }
Property Value
Type Description
IList<GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestAssetGroupInfo>

BiddingInfo

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

Declaration
[JsonProperty("biddingInfo")]
public virtual GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestBiddingInfo BiddingInfo { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestBiddingInfo

BudgetInfo

Optional. Current budget information. This field is optional for the following recommendation_types: CAMPAIGN_BUDGET

Declaration
[JsonProperty("budgetInfo")]
public virtual GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestBudgetInfo BudgetInfo { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestBudgetInfo

CampaignCallAssetCount

Optional. Current campaign call asset count. This field is optional for the following recommendation_types: CAMPAIGN_BUDGET

Declaration
[JsonProperty("campaignCallAssetCount")]
public virtual int? CampaignCallAssetCount { get; set; }
Property Value
Type Description
int?

CampaignImageAssetCount

Optional. Current campaign image asset count. This field is optional for the following recommendation_types: CAMPAIGN_BUDGET

Declaration
[JsonProperty("campaignImageAssetCount")]
public virtual int? CampaignImageAssetCount { get; set; }
Property Value
Type Description
int?

CampaignSitelinkCount

Optional. Number of sitelinks on the campaign. This field is necessary for the following recommendation_types: SITELINK_ASSET

Declaration
[JsonProperty("campaignSitelinkCount")]
public virtual int? CampaignSitelinkCount { get; set; }
Property Value
Type Description
int?

ConversionTrackingStatus

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

Declaration
[JsonProperty("conversionTrackingStatus")]
public virtual string ConversionTrackingStatus { get; set; }
Property Value
Type Description
string

CountryCodes

Optional. Current campaign country codes. This field is required for the following recommendation_types: CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH

Declaration
[JsonProperty("countryCodes")]
public virtual IList<string> CountryCodes { get; set; }
Property Value
Type Description
IList<string>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

IsNewCustomer

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

Declaration
[JsonProperty("isNewCustomer")]
public virtual bool? IsNewCustomer { get; set; }
Property Value
Type Description
bool?

LanguageCodes

Optional. Current campaign language codes. This field is required for the following recommendation_types: CAMPAIGN_BUDGET if AdvertisingChannelType is SEARCH

Declaration
[JsonProperty("languageCodes")]
public virtual IList<string> LanguageCodes { get; set; }
Property Value
Type Description
IList<string>

MerchantCenterAccountId

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

Declaration
[JsonProperty("merchantCenterAccountId")]
public virtual long? MerchantCenterAccountId { get; set; }
Property Value
Type Description
long?

NegativeLocationsIds

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

Declaration
[JsonProperty("negativeLocationsIds")]
public virtual IList<long?> NegativeLocationsIds { get; set; }
Property Value
Type Description
IList<long?>

PositiveLocationsIds

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

Declaration
[JsonProperty("positiveLocationsIds")]
public virtual IList<long?> PositiveLocationsIds { get; set; }
Property Value
Type Description
IList<long?>

RecommendationTypes

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

Declaration
[JsonProperty("recommendationTypes")]
public virtual IList<string> RecommendationTypes { get; set; }
Property Value
Type Description
IList<string>

SeedInfo

Optional. Seed information for Keywords. This field is necessary for the following recommendation_types: KEYWORD

Declaration
[JsonProperty("seedInfo")]
public virtual GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestSeedInfo SeedInfo { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23ServicesGenerateRecommendationsRequestSeedInfo

TargetContentNetwork

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

Declaration
[JsonProperty("targetContentNetwork")]
public virtual bool? TargetContentNetwork { get; set; }
Property Value
Type Description
bool?

TargetPartnerSearchNetwork

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

Declaration
[JsonProperty("targetPartnerSearchNetwork")]
public virtual bool? TargetPartnerSearchNetwork { get; set; }
Property Value
Type Description
bool?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX