- Resource: Recommendation
- RecommendationType
- RecommendationImpact
- RecommendationMetrics
- CampaignBudgetRecommendation
- CampaignBudgetRecommendationOption
- KeywordRecommendation
- TextAdRecommendation
- TargetCpaOptInRecommendation
- TargetCpaOptInRecommendationOption
- TargetCpaOptInRecommendationGoal
- MaximizeConversionsOptInRecommendation
- EnhancedCpcOptInRecommendation
- SearchPartnersOptInRecommendation
- MaximizeClicksOptInRecommendation
- OptimizeAdRotationRecommendation
- CalloutExtensionRecommendation
- SitelinkExtensionRecommendation
- CallExtensionRecommendation
- KeywordMatchTypeRecommendation
- MoveUnusedBudgetRecommendation
- TargetRoasOptInRecommendation
- ResponsiveSearchAdRecommendation
- Methods
Resource: Recommendation
A recommendation.
JSON representation | |
---|---|
{ "resourceName": string, "type": enum ( |
Fields | ||
---|---|---|
resourceName |
Immutable. The resource name of the recommendation.
|
|
type |
Output only. The type of recommendation. |
|
impact |
Output only. The impact on account performance as a result of applying the recommendation. |
|
campaignBudget |
Output only. The budget targeted by this recommendation. This will be set only when the recommendation affects a single campaign budget. This field will be set for the following recommendation types: CAMPAIGN_BUDGET, FORECASTING_CAMPAIGN_BUDGET, MARGINAL_ROI_CAMPAIGN_BUDGET, MOVE_UNUSED_BUDGET |
|
campaign |
Output only. The campaign targeted by this recommendation. This will be set only when the recommendation affects a single campaign. This field will be set for the following recommendation types: CALL_EXTENSION, CALLOUT_EXTENSION, ENHANCED_CPC_OPT_IN, KEYWORD, KEYWORD_MATCH_TYPE, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, OPTIMIZE_AD_ROTATION, RESPONSIVE_SEARCH_AD, SEARCH_PARTNERS_OPT_IN, SITELINK_EXTENSION, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN, TEXT_AD |
|
adGroup |
Output only. The ad group targeted by this recommendation. This will be set only when the recommendation affects a single ad group. This field will be set for the following recommendation types: KEYWORD, OPTIMIZE_AD_ROTATION, RESPONSIVE_SEARCH_AD, TEXT_AD |
|
dismissed |
Output only. Whether the recommendation is dismissed or not. |
|
Union field recommendation . The details of recommendation. recommendation can be only one of the following: |
||
campaignBudgetRecommendation |
Output only. The campaign budget recommendation. |
|
forecastingCampaignBudgetRecommendation |
Output only. The forecasting campaign budget recommendation. |
|
keywordRecommendation |
Output only. The keyword recommendation. |
|
textAdRecommendation |
Output only. Add expanded text ad recommendation. |
|
targetCpaOptInRecommendation |
Output only. The TargetCPA opt-in recommendation. |
|
maximizeConversionsOptInRecommendation |
Output only. The MaximizeConversions Opt-In recommendation. |
|
enhancedCpcOptInRecommendation |
Output only. The Enhanced Cost-Per-Click Opt-In recommendation. |
|
searchPartnersOptInRecommendation |
Output only. The googleAds.search Partners Opt-In recommendation. |
|
maximizeClicksOptInRecommendation |
Output only. The MaximizeClicks Opt-In recommendation. |
|
optimizeAdRotationRecommendation |
Output only. The Optimize Ad Rotation recommendation. |
|
calloutExtensionRecommendation |
Output only. The Callout extension recommendation. |
|
sitelinkExtensionRecommendation |
Output only. The Sitelink extension recommendation. |
|
callExtensionRecommendation |
Output only. The Call extension recommendation. |
|
keywordMatchTypeRecommendation |
Output only. The keyword match type recommendation. |
|
moveUnusedBudgetRecommendation |
Output only. The move unused budget recommendation. |
|
targetRoasOptInRecommendation |
Output only. The Target ROAS opt-in recommendation. |
|
responsiveSearchAdRecommendation |
Output only. The add responsive search ad recommendation. |
|
marginalRoiCampaignBudgetRecommendation |
Output only. The marginal ROI campaign budget recommendation. |
RecommendationType
Types of recommendations.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
CAMPAIGN_BUDGET |
Budget recommendation for campaigns that are currently budget-constrained (as opposed to the FORECASTING_CAMPAIGN_BUDGET recommendation, which applies to campaigns that are expected to become budget-constrained in the future). |
KEYWORD |
Keyword recommendation. |
TEXT_AD |
Recommendation to add a new text ad. |
TARGET_CPA_OPT_IN |
Recommendation to update a campaign to use a Target CPA bidding strategy. |
MAXIMIZE_CONVERSIONS_OPT_IN |
Recommendation to update a campaign to use the Maximize Conversions bidding strategy. |
ENHANCED_CPC_OPT_IN |
Recommendation to enable Enhanced Cost Per Click for a campaign. |
SEARCH_PARTNERS_OPT_IN |
Recommendation to start showing your campaign's ads on Google googleAds.search Partners Websites. |
MAXIMIZE_CLICKS_OPT_IN |
Recommendation to update a campaign to use a Maximize Clicks bidding strategy. |
OPTIMIZE_AD_ROTATION |
Recommendation to start using the "Optimize" ad rotation setting for the given ad group. |
CALLOUT_EXTENSION |
Recommendation to add callout extensions to a campaign. |
SITELINK_EXTENSION |
Recommendation to add sitelink extensions to a campaign. |
CALL_EXTENSION |
Recommendation to add call extensions to a campaign. |
KEYWORD_MATCH_TYPE |
Recommendation to change an existing keyword from one match type to a broader match type. |
MOVE_UNUSED_BUDGET |
Recommendation to move unused budget from one budget to a constrained budget. |
FORECASTING_CAMPAIGN_BUDGET |
Budget recommendation for campaigns that are expected to become budget-constrained in the future (as opposed to the CAMPAIGN_BUDGET recommendation, which applies to campaigns that are currently budget-constrained). |
TARGET_ROAS_OPT_IN |
Recommendation to update a campaign to use a Target ROAS bidding strategy. |
RESPONSIVE_SEARCH_AD |
Recommendation to add a new responsive search ad. |
MARGINAL_ROI_CAMPAIGN_BUDGET |
Budget recommendation for campaigns whose ROI is predicted to increase with a budget adjustment. |
RecommendationImpact
The impact of making the change as described in the recommendation. Some types of recommendations may not have impact information.
JSON representation | |
---|---|
{ "baseMetrics": { object ( |
Fields | |
---|---|
baseMetrics |
Output only. Base metrics at the time the recommendation was generated. |
potentialMetrics |
Output only. Estimated metrics if the recommendation is applied. |
RecommendationMetrics
Weekly account performance metrics. For some recommendation types, these are averaged over the past 90-day period and hence can be fractional.
JSON representation | |
---|---|
{ "impressions": number, "clicks": number, "costMicros": string, "conversions": number, "videoViews": number } |
Fields | |
---|---|
impressions |
Output only. Number of ad impressions. |
clicks |
Output only. Number of ad clicks. |
costMicros |
Output only. Cost (in micros) for advertising, in the local currency for the account. |
conversions |
Output only. Number of conversions. |
videoViews |
Output only. Number of video views for a video ad campaign. |
CampaignBudgetRecommendation
The budget recommendation for budget constrained campaigns.
JSON representation | |
---|---|
{
"budgetOptions": [
{
object ( |
Fields | |
---|---|
budgetOptions[] |
Output only. The budget amounts and associated impact estimates for some values of possible budget amounts. |
currentBudgetAmountMicros |
Output only. The current budget amount in micros. |
recommendedBudgetAmountMicros |
Output only. The recommended budget amount in micros. |
CampaignBudgetRecommendationOption
The impact estimates for a given budget amount.
JSON representation | |
---|---|
{
"impact": {
object ( |
Fields | |
---|---|
impact |
Output only. The impact estimate if budget is changed to amount specified in this option. |
budgetAmountMicros |
Output only. The budget amount for this option. |
KeywordRecommendation
The keyword recommendation.
JSON representation | |
---|---|
{
"keyword": {
object ( |
Fields | |
---|---|
keyword |
Output only. The recommended keyword. |
recommendedCpcBidMicros |
Output only. The recommended CPC (cost-per-click) bid. |
TextAdRecommendation
The text ad recommendation.
JSON representation | |
---|---|
{
"ad": {
object ( |
Fields | |
---|---|
ad |
Output only. Recommended ad. |
creationDate |
Output only. Creation date of the recommended ad. YYYY-MM-DD format, e.g., 2018-04-17. |
autoApplyDate |
Output only. Date, if present, is the earliest when the recommendation will be auto applied. YYYY-MM-DD format, e.g., 2018-04-17. |
TargetCpaOptInRecommendation
The Target CPA opt-in recommendation.
JSON representation | |
---|---|
{
"options": [
{
object ( |
Fields | |
---|---|
options[] |
Output only. The available goals and corresponding options for Target CPA strategy. |
recommendedTargetCpaMicros |
Output only. The recommended average CPA target. See required budget amount and impact of using this recommendation in options list. |
TargetCpaOptInRecommendationOption
The Target CPA opt-in option with impact estimate.
JSON representation | |
---|---|
{ "goal": enum ( |
Fields | |
---|---|
goal |
Output only. The goal achieved by this option. |
impact |
Output only. The impact estimate if this option is selected. |
targetCpaMicros |
Output only. Average CPA target. |
requiredCampaignBudgetAmountMicros |
Output only. The minimum campaign budget, in local currency for the account, required to achieve the target CPA. Amount is specified in micros, where one million is equivalent to one currency unit. |
TargetCpaOptInRecommendationGoal
Goal of TargetCpaOptIn recommendation.
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
SAME_COST |
Recommendation to set Target CPA to maintain the same cost. |
SAME_CONVERSIONS |
Recommendation to set Target CPA to maintain the same conversions. |
SAME_CPA |
Recommendation to set Target CPA to maintain the same CPA. |
CLOSEST_CPA |
Recommendation to set Target CPA to a value that is as close as possible to, yet lower than, the actual CPA (computed for past 28 days). |
MaximizeConversionsOptInRecommendation
The Maximize Conversions Opt-In recommendation.
JSON representation | |
---|---|
{ "recommendedBudgetAmountMicros": string } |
Fields | |
---|---|
recommendedBudgetAmountMicros |
Output only. The recommended new budget amount. |
EnhancedCpcOptInRecommendation
The Enhanced Cost-Per-Click Opt-In recommendation.
SearchPartnersOptInRecommendation
The googleAds.search Partners Opt-In recommendation.
MaximizeClicksOptInRecommendation
The Maximize Clicks opt-in recommendation.
JSON representation | |
---|---|
{ "recommendedBudgetAmountMicros": string } |
Fields | |
---|---|
recommendedBudgetAmountMicros |
Output only. The recommended new budget amount. Only set if the current budget is too high. |
OptimizeAdRotationRecommendation
The Optimize Ad Rotation recommendation.
CalloutExtensionRecommendation
The Callout extension recommendation.
JSON representation | |
---|---|
{
"recommendedExtensions": [
{
object ( |
Fields | |
---|---|
recommendedExtensions[] |
Output only. Callout extensions recommended to be added. |
SitelinkExtensionRecommendation
The Sitelink extension recommendation.
JSON representation | |
---|---|
{
"recommendedExtensions": [
{
object ( |
Fields | |
---|---|
recommendedExtensions[] |
Output only. Sitelink extensions recommended to be added. |
CallExtensionRecommendation
The Call extension recommendation.
JSON representation | |
---|---|
{
"recommendedExtensions": [
{
object ( |
Fields | |
---|---|
recommendedExtensions[] |
Output only. Call extensions recommended to be added. |
KeywordMatchTypeRecommendation
The keyword match type recommendation.
JSON representation | |
---|---|
{ "keyword": { object ( |
Fields | |
---|---|
keyword |
Output only. The existing keyword where the match type should be more broad. |
recommendedMatchType |
Output only. The recommended new match type. |
MoveUnusedBudgetRecommendation
The move unused budget recommendation.
JSON representation | |
---|---|
{
"budgetRecommendation": {
object ( |
Fields | |
---|---|
budgetRecommendation |
Output only. The recommendation for the constrained budget to increase. |
excessCampaignBudget |
Output only. The excess budget's resourceName. |
TargetRoasOptInRecommendation
The Target ROAS opt-in recommendation.
JSON representation | |
---|---|
{ "recommendedTargetRoas": number, "requiredCampaignBudgetAmountMicros": string } |
Fields | |
---|---|
recommendedTargetRoas |
Output only. The recommended target ROAS (revenue per unit of spend). The value is between 0.01 and 1000.0, inclusive. |
requiredCampaignBudgetAmountMicros |
Output only. The minimum campaign budget, in local currency for the account, required to achieve the target ROAS. Amount is specified in micros, where one million is equivalent to one currency unit. |
ResponsiveSearchAdRecommendation
The add responsive search ad recommendation.
JSON representation | |
---|---|
{
"ad": {
object ( |
Fields | |
---|---|
ad |
Output only. Recommended ad. |
Methods |
|
---|---|
|
Applies given recommendations with corresponding apply parameters. |
|
Dismisses given recommendations. |
|
Returns the requested recommendation in full detail. |