REST Resource: customers.recommendations

{
  "resourceName": string,
  "type": enum (RecommendationType),
  "impact": {
    object (RecommendationImpact)
  },
  "campaignBudget": string,
  "campaign": string,
  "adGroup": string,
  "dismissed": boolean,

  // Union field recommendation can be only one of the following:
  "campaignBudgetRecommendation": {
    object (CampaignBudgetRecommendation)
  },
  "forecastingCampaignBudgetRecommendation": {
    object (CampaignBudgetRecommendation)
  },
  "keywordRecommendation": {
    object (KeywordRecommendation)
  },
  "textAdRecommendation": {
    object (TextAdRecommendation)
  },
  "targetCpaOptInRecommendation": {
    object (TargetCpaOptInRecommendation)
  },
  "maximizeConversionsOptInRecommendation": {
    object (MaximizeConversionsOptInRecommendation)
  },
  "enhancedCpcOptInRecommendation": {
    object (EnhancedCpcOptInRecommendation)
  },
  "searchPartnersOptInRecommendation": {
    object (SearchPartnersOptInRecommendation)
  },
  "maximizeClicksOptInRecommendation": {
    object (MaximizeClicksOptInRecommendation)
  },
  "optimizeAdRotationRecommendation": {
    object (OptimizeAdRotationRecommendation)
  },
  "calloutExtensionRecommendation": {
    object (CalloutExtensionRecommendation)
  },
  "sitelinkExtensionRecommendation": {
    object (SitelinkExtensionRecommendation)
  },
  "callExtensionRecommendation": {
    object (CallExtensionRecommendation)
  },
  "keywordMatchTypeRecommendation": {
    object (KeywordMatchTypeRecommendation)
  },
  "moveUnusedBudgetRecommendation": {
    object (MoveUnusedBudgetRecommendation)
  },
  "targetRoasOptInRecommendation": {
    object (TargetRoasOptInRecommendation)
  },
  "responsiveSearchAdRecommendation": {
    object (ResponsiveSearchAdRecommendation)
  },
  "marginalRoiCampaignBudgetRecommendation": {
    object (CampaignBudgetRecommendation)
  }
  // End of list of possible types for union field recommendation.
}

string

Immutable. The resource name of the recommendation.

customers/{customerId}/recommendations/{recommendation_id}

enum (RecommendationType)

Output only. The type of recommendation.

object (RecommendationImpact)

Output only. The impact on account performance as a result of applying the recommendation.

string

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

string

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

string

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

boolean

Output only. Whether the recommendation is dismissed or not.

object (CampaignBudgetRecommendation)

Output only. The campaign budget recommendation.

object (CampaignBudgetRecommendation)

Output only. The forecasting campaign budget recommendation.

object (KeywordRecommendation)

Output only. The keyword recommendation.

object (TextAdRecommendation)

Output only. Add expanded text ad recommendation.

object (TargetCpaOptInRecommendation)

Output only. The TargetCPA opt-in recommendation.

object (MaximizeConversionsOptInRecommendation)

Output only. The MaximizeConversions Opt-In recommendation.

object (EnhancedCpcOptInRecommendation)

Output only. The Enhanced Cost-Per-Click Opt-In recommendation.

object (SearchPartnersOptInRecommendation)

Output only. The googleAds.search Partners Opt-In recommendation.

object (MaximizeClicksOptInRecommendation)

Output only. The MaximizeClicks Opt-In recommendation.

object (OptimizeAdRotationRecommendation)

Output only. The Optimize Ad Rotation recommendation.

object (CalloutExtensionRecommendation)

Output only. The Callout extension recommendation.

object (SitelinkExtensionRecommendation)

Output only. The Sitelink extension recommendation.

object (CallExtensionRecommendation)

Output only. The Call extension recommendation.

object (KeywordMatchTypeRecommendation)

Output only. The keyword match type recommendation.

object (MoveUnusedBudgetRecommendation)

Output only. The move unused budget recommendation.

object (TargetRoasOptInRecommendation)

Output only. The Target ROAS opt-in recommendation.

object (ResponsiveSearchAdRecommendation)

Output only. The add responsive search ad recommendation.

object (CampaignBudgetRecommendation)

Output only. The marginal ROI campaign budget recommendation.

{
  "baseMetrics": {
    object (RecommendationMetrics)
  },
  "potentialMetrics": {
    object (RecommendationMetrics)
  }
}

object (RecommendationMetrics)

Output only. Base metrics at the time the recommendation was generated.

object (RecommendationMetrics)

Output only. Estimated metrics if the recommendation is applied.

{
  "impressions": number,
  "clicks": number,
  "costMicros": string,
  "conversions": number,
  "videoViews": number
}

number

Output only. Number of ad impressions.

number

Output only. Number of ad clicks.

string (int64 format)

Output only. Cost (in micros) for advertising, in the local currency for the account.

number

Output only. Number of conversions.

number

Output only. Number of video views for a video ad campaign.

{
  "budgetOptions": [
    {
      object (CampaignBudgetRecommendationOption)
    }
  ],
  "currentBudgetAmountMicros": string,
  "recommendedBudgetAmountMicros": string
}

object (CampaignBudgetRecommendationOption)

Output only. The budget amounts and associated impact estimates for some values of possible budget amounts.

string (int64 format)

Output only. The current budget amount in micros.

string (int64 format)

Output only. The recommended budget amount in micros.

{
  "impact": {
    object (RecommendationImpact)
  },
  "budgetAmountMicros": string
}

object (RecommendationImpact)

Output only. The impact estimate if budget is changed to amount specified in this option.

string (int64 format)

Output only. The budget amount for this option.

{
  "keyword": {
    object (KeywordInfo)
  },
  "recommendedCpcBidMicros": string
}

object (KeywordInfo)

Output only. The recommended keyword.

string (int64 format)

Output only. The recommended CPC (cost-per-click) bid.

{
  "ad": {
    object (Ad)
  },
  "creationDate": string,
  "autoApplyDate": string
}

object (Ad)

Output only. Recommended ad.

string

Output only. Creation date of the recommended ad. YYYY-MM-DD format, e.g., 2018-04-17.

string

Output only. Date, if present, is the earliest when the recommendation will be auto applied. YYYY-MM-DD format, e.g., 2018-04-17.

{
  "options": [
    {
      object (TargetCpaOptInRecommendationOption)
    }
  ],
  "recommendedTargetCpaMicros": string
}

object (TargetCpaOptInRecommendationOption)

Output only. The available goals and corresponding options for Target CPA strategy.

string (int64 format)

Output only. The recommended average CPA target. See required budget amount and impact of using this recommendation in options list.

{
  "goal": enum (TargetCpaOptInRecommendationGoal),
  "impact": {
    object (RecommendationImpact)
  },
  "targetCpaMicros": string,
  "requiredCampaignBudgetAmountMicros": string
}

enum (TargetCpaOptInRecommendationGoal)

Output only. The goal achieved by this option.

object (RecommendationImpact)

Output only. The impact estimate if this option is selected.

string (int64 format)

Output only. Average CPA target.

string (int64 format)

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.

{
  "recommendedBudgetAmountMicros": string
}

string (int64 format)

Output only. The recommended new budget amount.

{
  "recommendedBudgetAmountMicros": string
}

string (int64 format)

Output only. The recommended new budget amount. Only set if the current budget is too high.

{
  "recommendedExtensions": [
    {
      object (CalloutFeedItem)
    }
  ]
}

object (CalloutFeedItem)

Output only. Callout extensions recommended to be added.

{
  "recommendedExtensions": [
    {
      object (SitelinkFeedItem)
    }
  ]
}

object (SitelinkFeedItem)

Output only. Sitelink extensions recommended to be added.

{
  "recommendedExtensions": [
    {
      object (CallFeedItem)
    }
  ]
}

object (CallFeedItem)

Output only. Call extensions recommended to be added.

{
  "keyword": {
    object (KeywordInfo)
  },
  "recommendedMatchType": enum (KeywordMatchType)
}

object (KeywordInfo)

Output only. The existing keyword where the match type should be more broad.

enum (KeywordMatchType)

Output only. The recommended new match type.

{
  "budgetRecommendation": {
    object (CampaignBudgetRecommendation)
  },
  "excessCampaignBudget": string
}

object (CampaignBudgetRecommendation)

Output only. The recommendation for the constrained budget to increase.

string

Output only. The excess budget's resourceName.

{
  "recommendedTargetRoas": number,
  "requiredCampaignBudgetAmountMicros": string
}

number

Output only. The recommended target ROAS (revenue per unit of spend). The value is between 0.01 and 1000.0, inclusive.

string (int64 format)

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.

{
  "ad": {
    object (Ad)
  }
}

object (Ad)

Output only. Recommended ad.