Tactical recommendations beta
- class ad_api.api.Recommendations(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, proxies=None, verify=True, timeout=None, debug=False, access_token=None)
- apply_recommendations(**kwargs)
Applies one or more recommendations.
- Request Body (required)
- ApplyRecommendationsRequest {recommendationIds* (array) minItems: 1 maxItems: 100 [(string) Recommendation identifier.]}
- Returns
ApiResponse
- list_recommendations(**kwargs)
Retrieves a list of recommendations.
- Request Body (required)
- ListRecommendationsRequest {maxResults (integer) default: 500 minimum: 1 maximum: 500nextToken (string) Token to retrieve the next page of results.filters* (array) minItems: 1 maxItems: 10 [ListRecommendationsFilter {include (boolean): Flag to specify if the filter should be included or excluded. default: truefield* FilterField (string): Field to filter by. Enum: [‘RECOMMENDATION_ID’, ‘AD_PRODUCT’, ‘RECOMMENDATION_TYPE’, ‘STATUS’, ‘GROUPING_TYPE’, ‘CAMPAIGN_ID’]values* (array) minItems: 1 maxItems: 500 [string]operator FilterOperator (string): Operator to filter field by. Enum: [‘EXACT’]}]}
- Returns
ApiResponse
- update_recommendation(**kwargs)
Updates a recommendation.
path recommendationId:string | Required. The identifier of the recommendation.
- Request Body (required)
- UpdateRecommendationRequest {ruleBasedBidding UpdateRuleBasedBidding {Can only be updated for recommendations with recommendationType NEW_CAMPAIGN_BIDDING_RULE or CAMPAIGN_BIDDING_RULE.recommendedRuleRoas* (number)}recommendedValue (string) Recommended value of the recommendation. Type of data expected for each recommendation type:budgetRule UpdateBudgetRule {ruleDetails* UpdateBudgetRuleDetails {duration UpdateBudgetRuleDuration {dateRangeTypeDuration UpdateBudgetRuleDurationDateRange {endDate (string): End date of the budget rule in YYYY-MM-DD format. The end date is inclusive.}budgetIncreaseBy BudgetRuleIncreaseBy {value*(number): Budget of the rule.}ruleName* (string): Name of the budget rule. Required to be unique within a campaign. minLength: 1 maxLength: 355performanceMeasureCondition BudgetRulePerformanceMeasureCondition {threshold*(number): Threshold of the performance metric.}}}}
- Returns
ApiResponse