{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"adGroupId":{"description":"An identifier for an ad group.","maxLength":19,"minLength":1,"type":"string"},"advertiserId":{"description":"An identifier for an advertiser.","maxLength":19,"minLength":1,"type":"string"},"budgetRecoverableVisualisation":{"description":"Visualisation showing the amount of at-risk budget that can be recovered through recommendations.","properties":{"atRisk":{"description":"Amount of budget projected to be unspent by end of flight.","format":"double","type":"number"},"atRiskLabel":{"description":"Translated label for the at-risk amount (e.g. \"At Risk\").","type":"string"},"currency":{"description":"Currency code of the budget values, e.g. USD.","type":"string"},"recoverable":{"description":"Amount of at-risk budget that can be recovered with recommendations.","format":"double","type":"number"},"recoverableLabel":{"description":"Translated label for the recoverable amount (e.g. \"Recoverable\").","type":"string"},"recoverablePercentLabel":{"description":"Translated label for the recovery percentage (e.g. \"92% recoverable\").","type":"string"},"visualisationType":{"enum":["BUDGET_RECOVERABLE"],"type":"string"}},"required":["atRisk","currency","recoverable","visualisationType"],"type":"object"},"campaignId":{"description":"An identifier for a campaign.","maxLength":19,"minLength":1,"type":"string"},"canonicalId":{"description":"An identifier for DSP advertising objects such as line item, order or advertiser Id.","maxLength":19,"minLength":1,"type":"string"},"category":{"description":"Category for the recommendation. Used for type-based grouping in the guidance panel:\n * `AUDIENCES` - Recommendations to add recommended audiences\n * `BIDDING` - Deprecated\n * `BUDGET` - Deprecated\n * `DEALS` - Recommendations to add deals\n * `DELIVERY` - Deprecated\n * `FREQUENCY_CAP` - Recommendations to increase frequency cap\n * `INVENTORY_SOURCES` - Recommendations to add inventory sources to expand delivery reach\n * `MAX_BID` - Recommendations to increase maximum average CPM\n * `MISSING_CREATIVE` - Recommendations to add missing creative sizes\n * `OTHER` - Recommendations that do not fall into a specific category above\n * `PERFORMANCE` - Deprecated\n * `REPAIR` - Deprecated\n * `RETAIL` - Deprecated\n * `SIMILAR_AUDIENCES` - Recommendations to enable similar audiences\n * `TARGETING` - Deprecated\n * `VIEWABILITY` - Recommendations to lower viewability threshold\n","enum":["AUDIENCES","BIDDING","BUDGET","DEALS","DELIVERY","FREQUENCY_CAP","INVENTORY_SOURCES","MAX_BID","MISSING_CREATIVE","OTHER","PERFORMANCE","REPAIR","RETAIL","SIMILAR_AUDIENCES","TARGETING","VIEWABILITY"],"type":"string"},"dateTime":{"description":"A string representation of this instant formatted as ISO-8601.","example":"2021-11-18 08:58:01 UTC","type":"string"},"dateTimeInstant":{"description":"A string representation of this instant formatted as ISO-8601 cast to an Instant datatype.","format":"date-time","type":"string"},"dspObject":{"description":"The DSP object to which the recommendation is related.","properties":{"id":{"$ref":"#/components/schemas/canonicalId"},"name":{"description":"Name of the DSP object that is set by user during initialisation step.","type":"string"}},"type":"object"},"entityId":{"description":"An identifier for an entity.","type":"string"},"execution":{"description":"The execution done by QuickActions on the recommendation.","properties":{"actionId":{"$ref":"#/components/schemas/canonicalId"},"creationDate":{"$ref":"#/components/schemas/dateTime"},"executionId":{"$ref":"#/components/schemas/canonicalId"},"executionStatus":{"description":"Status of the execution.","enum":["COMPLETED","CREATED","EXPECTED_FAILURE","FAILED","IN_PROGRESS"],"type":"string"},"lastUpdateDate":{"$ref":"#/components/schemas/dateTime"},"message":{"description":"Generic message to be used for errors or omissions.","type":"string"},"messageType":{"description":"Type of message to be used for errors or omissions, which will be mapped to localised strings at the client side.","enum":["COMPLETED","FAILED_GENERIC_MESSAGE","IN_PROGRESS","MOVE_BUDGET_WORLD_STATE_CHANGED_EXCEPTION","PREVIEW","WORLD_STATE_CHANGED_EXCEPTION"],"type":"string"}},"type":"object"},"explainabilityEvidencePackDescriptor":{"description":"Evidence pack containing SHAP-based explainability data for under-delivery guidance.","properties":{"descriptorType":{"enum":["EXPLAINABILITY_EVIDENCE_PACK"],"type":"string"},"shapValues":{"description":"SHAP feature contributions explaining the under-delivery prediction.","items":{"$ref":"#/components/schemas/shapValue"},"maxItems":100,"minItems":0,"type":"array"},"underDeliveryEvidencePack":{"$ref":"#/components/schemas/underDeliveryEvidencePack"}},"required":["descriptorType","shapValues","underDeliveryEvidencePack"],"type":"object"},"guidance":{"description":"An object describing dynamically created guidance derived by the rule-based aggregation of individual recommendations.","properties":{"callToAction":{"$ref":"#/components/schemas/guidanceCallToAction"},"cardTitle":{"description":"Title text for the guidance card.","type":"string"},"description":{"description":"Description text of the guidance.","type":"string"},"descriptors":{"description":"Structured metadata associated with this guidance. Discriminated by descriptorType. May be empty or absent for guidance without structured metadata.","items":{"oneOf":[{"$ref":"#/components/schemas/explainabilityEvidencePackDescriptor"}]},"maxItems":50,"minItems":0,"type":"array"},"explainabilityStatus":{"description":"Indicates whether explainability can be requested for this guidance.\n- SUPPORTED: explainability can be generated by calling GenerateGuidanceExplainability\n- NOT_SUPPORTED: this guidance type does not support explainability generation\n","enum":["NOT_SUPPORTED","SUPPORTED"],"type":"string"},"explanation":{"description":"Explanation text of the guidance.","type":"string"},"generatedDate":{"$ref":"#/components/schemas/dateTimeInstant"},"groupRecommendationsBy":{"description":"Group recommendations according to this target in the UI","enum":["MARKETPLACE_ID","RECOMMENDATION_TYPE","RODEO_ADVERTISER","RODEO_CREATIVE","RODEO_ENTITY","RODEO_LINEITEM","RODEO_ORDER"],"type":"string"},"guidanceId":{"description":"A unique identifier for guidance object.","type":"string"},"guidanceName":{"$ref":"#/components/schemas/guidanceName"},"guidanceType":{"$ref":"#/components/schemas/guidanceType"},"lastUpdatedDate":{"$ref":"#/components/schemas/dateTimeInstant"},"marketplaceId":{"$ref":"#/components/schemas/marketplaceId"},"parentGuidanceId":{"description":"Identifier of a higher level guidance object.","type":"string"},"prioritisationScore":{"deprecated":true,"description":"Deprecated and no longer populated. This was an internal ranking score that is not\nmeaningful to API consumers. It is retained in the schema as optional only for backwards\ncompatibility and will be removed in a future revision.\n","format":"double","type":"number"},"recommendations":{"description":"List of dynamically aggregated recommendations used to generate this guidance.","items":{"$ref":"#/components/schemas/recommendation"},"maxItems":100,"minItems":0,"type":"array"},"tags":{"description":"List of structured tags objects annotating the guidance.","items":{"$ref":"#/components/schemas/guidanceTag"},"maxItems":100,"minItems":0,"type":"array"},"targets":{"description":"Objects targeted by this guidance depending on the aggregation level, including `ENTITY`, `ADVERTISER` and `ORDER`.","items":{"oneOf":[{"$ref":"#/components/schemas/guidanceMarketplaceTarget"},{"$ref":"#/components/schemas/guidanceEntityTarget"},{"$ref":"#/components/schemas/guidanceAdvertiserTarget"},{"$ref":"#/components/schemas/guidanceOrderTarget"},{"$ref":"#/components/schemas/guidanceOrderFlightTarget"},{"$ref":"#/components/schemas/guidanceLineItemTarget"}]},"maxItems":10,"minItems":0,"type":"array"},"title":{"description":"Title text of the guidance.","type":"string"},"totalRecommendationCount":{"description":"Total count of recommendations used to generate this guidance.","type":"integer"},"visualisation":{"description":"Optional visual data to render alongside the guidance card.","oneOf":[{"$ref":"#/components/schemas/budgetRecoverableVisualisation"}]}},"required":["description","generatedDate","guidanceName","guidanceType","lastUpdatedDate","marketplaceId","targets","title","totalRecommendationCount"],"type":"object"},"guidanceAdvertiserTarget":{"allOf":[{"$ref":"#/components/schemas/guidanceTarget"},{"properties":{"advertiserId":{"$ref":"#/components/schemas/canonicalId"}},"type":"object"}],"description":"An advertiser targeted by guidance."},"guidanceCallToAction":{"properties":{"label":{"description":"Button or link label for call-to-action.","type":"string"},"link":{"description":"Optional link for call-to-action.","type":"string"}},"type":"object"},"guidanceEntityTarget":{"allOf":[{"$ref":"#/components/schemas/guidanceTarget"},{"properties":{"entityId":{"$ref":"#/components/schemas/entityId"}},"type":"object"}],"description":"An entity targeted by guidance."},"guidanceLineItemTarget":{"allOf":[{"$ref":"#/components/schemas/guidanceTarget"},{"properties":{"lineItemId":{"$ref":"#/components/schemas/canonicalId"}},"type":"object"}],"description":"A line item targeted by guidance."},"guidanceMarketplaceTarget":{"allOf":[{"$ref":"#/components/schemas/guidanceTarget"},{"properties":{"marketplaceId":{"$ref":"#/components/schemas/marketplaceId"}},"type":"object"}],"description":"A marketplace targeted by guidance."},"guidanceName":{"description":"Identifier for a piece of guidance.","enum":["AGGREGATED_PRE_FLIGHT_DEALS_GUIDANCE","AGGREGATED_PRE_FLIGHT_OPTIMIZATIONS_GUIDANCE","AGGREGATED_UNDERPACING_ORDER_GUIDANCE","AMAZON_RECOMMENDED_DEALS_GUIDANCE","AMAZON_RECOMMENDED_TACTICS_GUIDANCE","AQUABOT_CREATIVE_INACTIVE_GUIDANCE","AQUABOT_DOMAIN_EXCLUSION_GUIDANCE","AQUABOT_NO_CREATIVES_GUIDANCE","BID_ADJUSTMENTS_NOT_RUNNING_GUIDANCE","BUDGET_CAP_CONSTRAINT_GUIDANCE","CARD_ISSUES_GUIDANCE","CARD_PRE_FLIGHT_GUIDANCE","CARD_UNDERPACING_GUIDANCE","CREATIVE_ISSUES_ORDER_GUIDANCE","CREATIVE_REJECTED_ORDER_GUIDANCE","INTERNAL_DEFECT_GUIDANCE","LINE_ITEM_DEFAULT_GUIDANCE","NO_SPEND_ORDER_GUIDANCE","NO_TRAFFIC_DEAL_GUIDANCE","OUT_OF_STOCK_GUIDANCE","OVERDELIVERING_ORDER_GUIDANCE","PERFORMANCE_AT_RISK_GUIDANCE","PG_DEALS_ALL_DEALS_INACTIVE_GUIDANCE","PG_DEALS_CREATIVE_INACTIVE","PG_DEALS_CREATIVE_MISSING_AMZN_APPROVAL","PG_DEALS_CREATIVE_MISSING_SSP_APPROVAL","PG_DEALS_CREATIVE_NOT_PRESENT","PG_DEALS_DEAL_TARGETED_BY_MULTIPLE_LINE_ITEMS","PG_DEALS_DEAL_TERMINATION_RISK_ESCALATION","PG_DEALS_DEAL_TERMINATION_RISK_WARNING","PG_DEALS_DEAL_TERMS_UPDATED","PG_DEALS_DEAL_ZERO_DELIVERY","PG_DEALS_LINE_ITEM_BUDGET_LESS_THAN_DEAL_BUDGET","PG_DEALS_LINE_ITEM_CREATIVE_MISSING_AMZN_APPROVAL","PG_DEALS_LINE_ITEM_DEACTIVATED","PG_DEALS_LINE_ITEM_ENDS_BEFORE_DEAL","PG_DEALS_LINE_ITEM_INACTIVE","PG_DEALS_LINE_ITEM_NOT_PRESENT","PG_DEALS_LINE_ITEM_STARTS_AFTER_DEAL","PG_DEALS_ORDER_DEACTIVATED","PG_DEALS_ORDER_INACTIVE","PG_DEALS_REVIEW_DEAL_TERMS","PRE_FLIGHT_LINE_ITEM_GUIDANCE_V2","PRE_FLIGHT_OPTIMIZATIONS_LINE_ITEM_GUIDANCE","PRE_FLIGHT_OPTIMIZATIONS_ORDER_GUIDANCE","PRE_FLIGHT_ORDER_GUIDANCE_V2","UNDERPACING_LINE_ITEM_GUIDANCE","UNDERPACING_ORDER_GUIDANCE","ZERO_KPI_GUIDANCE"],"type":"string"},"guidanceOrderFlightTarget":{"allOf":[{"$ref":"#/components/schemas/guidanceTarget"},{"properties":{"orderFlightId":{"$ref":"#/components/schemas/canonicalId"}},"type":"object"}],"description":"An order flight targeted by guidance."},"guidanceOrderTarget":{"allOf":[{"$ref":"#/components/schemas/guidanceTarget"},{"properties":{"orderId":{"$ref":"#/components/schemas/canonicalId"}},"type":"object"}],"description":"An order targeted by guidance."},"guidanceTag":{"description":"A structured type used to store additional metadata.","type":"object"},"guidanceTarget":{"description":"An object targeted by guidance.","properties":{"name":{"description":"Optional display name of the guidance target.","type":"string"}},"type":"object"},"guidanceType":{"description":"Guidance type for the recommendation whether it is an Alert or Opportunity:\n * `ALERT` - Guidance type for recommendations which are Alerts\n * `OPPORTUNITY` - Guidance type for recommendations which are Opportunities\n","enum":["ALERT","OPPORTUNITY"],"type":"string"},"language":{"default":"en-US","description":"Indicates a language and locale. If omitted, defaults to en-US.","enum":["ar-AE","de-DE","en-AE","en-AU","en-CA","en-GB","en-IN","en-SG","en-US","es-CO","es-ES","es-MX","fr-CA","fr-FR","hi-IN","it-IT","ja-JP","ko-KR","nl-NL","pl-PL","pt-BR","sv-SE","ta-IN","th-TH","tr-TR","vi-VN","zh-CN","zh-TW"],"type":"string"},"listAdGroupGuidanceV1Request":{"allOf":[{"$ref":"#/components/schemas/listGuidanceV1RequestBase"},{"properties":{"adGroupIds":{"description":"A list of ad group IDs.","items":{"$ref":"#/components/schemas/adGroupId"},"maxItems":50,"minItems":1,"type":"array"}},"required":["adGroupIds"],"type":"object"}],"description":"Request body for ListAdGroupGuidanceV1 call."},"listAdvertiserGuidanceV1Request":{"allOf":[{"$ref":"#/components/schemas/listGuidanceV1RequestBase"},{"properties":{"advertiserIds":{"description":"A list of advertiser IDs.","items":{"$ref":"#/components/schemas/advertiserId"},"maxItems":50,"minItems":1,"type":"array"}},"required":["advertiserIds"],"type":"object"}],"description":"Request body for ListAdvertiserGuidanceV1 call."},"listCampaignGuidanceV1Request":{"allOf":[{"$ref":"#/components/schemas/listGuidanceV1RequestBase"},{"properties":{"campaignIds":{"description":"A list of campaign IDs.","items":{"$ref":"#/components/schemas/campaignId"},"maxItems":50,"minItems":1,"type":"array"}},"required":["campaignIds"],"type":"object"}],"description":"Request body for ListCampaignGuidanceV1 call."},"listGuidanceRequestFilters":{"description":"Optional filters to apply to generated guidance.","properties":{"guidanceNames":{"description":"Limit guidance to the specified guidance names. If unset, defaults to returning all guidance.","items":{"$ref":"#/components/schemas/guidanceName"},"maxItems":50,"minItems":0,"type":"array"},"includeRecommendations":{"default":"true","description":"Specify if individual recommendations should be included in the guidance response.\nUseful to reduce response payload size. Does not affect `totalRecommendationCount`.","type":"boolean"}},"type":"object"},"listGuidanceResponseSuccess":{"properties":{"guidance":{"description":"An array of objects describing dynamically created guidance derived by the rule-based aggregation of individual recommendations.","items":{"$ref":"#/components/schemas/guidance"},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"Array index referencing the target object in the request array.","type":"integer"},"totalGuidanceCount":{"description":"Total count of guidance available for this target.","type":"integer"}},"type":"object"},"listGuidanceV1RequestBase":{"properties":{"filters":{"$ref":"#/components/schemas/listGuidanceRequestFilters"},"nextToken":{"$ref":"#/components/schemas/nextToken"}},"type":"object"},"listGuidanceV1Response":{"properties":{"error":{"description":"Error response containing error code and description associated with the target object, referenced by array index.","items":{"$ref":"#/components/schemas/listGuidanceV1ResponseError"},"maxItems":50,"minItems":0,"type":"array"},"nextToken":{"$ref":"#/components/schemas/nextToken"},"success":{"description":"Success response containing guidance associated with the target object, referenced by array index.","items":{"$ref":"#/components/schemas/listGuidanceResponseSuccess"},"maxItems":50,"minItems":0,"type":"array"}},"type":"object"},"listGuidanceV1ResponseError":{"properties":{"code":{"description":"Enum representing error code.","enum":["FAILED_GENERATION","INVALID_TARGET_TYPE"],"type":"string"},"description":{"description":"Textual description of the error.","type":"string"},"index":{"description":"Array index referencing the target object in the request array.","type":"integer"}},"type":"object"},"marketplaceId":{"description":"The identifier of the marketplace to which the recommendation is associated with.","type":"string"},"nextToken":{"description":"Opaque pagination token returned in the query response to be provided in subsequent calls to retrieve paginated recommendations.","type":"string"},"quickAction":{"description":"An object describing the action associated with this recommendation.","properties":{"actionId":{"$ref":"#/components/schemas/canonicalId"},"actionType":{"description":"String identifying the type of suggested action.","enum":["AssociateCreatives","AudienceExpansion","AudienceRemoval","AudienceReplacement","AudienceTargetingMatchTypeUpdate","BaseBidUpdate","CampaignFrequencyCapUpdate","FrequencyCapUpdate","HibouEnrollment","MaxBidUpdate","MoveBudget","MoveBudgetBeta","OrderBaseBidUpdate","OrderMaxBidUpdate","OrderViewabilityUpdate","TacticsEnrolment","TargetsUpdate","ViewabilityUpdate"],"type":"string"},"currentValue":{"description":"Current setting value that triggered the recommendation.","type":"string"},"description":{"description":"Description for the recommendation action.","type":"string"},"recommendedValue":{"description":"Recommended setting value to be applied by the Quick Action.","type":"string"}},"required":["actionId","actionType","description"],"type":"object"},"quickactionsData":{"description":"The automated QuickAction object associated with the recommendation.","properties":{"currentActions":{"description":"Current active recommended actions.","items":{"$ref":"#/components/schemas/quickAction"},"maxItems":5,"minItems":0,"type":"array"},"executionHistory":{"description":"The history of existing QuickAction executions on this recommendation.","items":{"$ref":"#/components/schemas/execution"},"maxItems":5,"minItems":0,"type":"array"}},"readOnly":true,"type":"object"},"recommendation":{"description":"An object describing the DSP recommendation generated to improve the campaign performance for display advertising.","properties":{"advertiser":{"$ref":"#/components/schemas/dspObject"},"category":{"$ref":"#/components/schemas/category"},"deferredUntil":{"$ref":"#/components/schemas/dateTime"},"description":{"$ref":"#/components/schemas/recommendationText"},"entityId":{"$ref":"#/components/schemas/entityId"},"expectedChanges":{"description":"Expected changes are represented as a json array of arrays and are interpreted to be in a Disjunctive normal form (DNF).","example":"[[{\"field\":\"maxBid\",\"rhs\": 5.0,\"comparator\":\"\u003d\",\"target\":{\"type\":\"DSP_LINEITEM\",\"id\":\"12345\",\"displayName\":null},\"changeType\":\"single\"}]]","type":"string"},"explanation":{"$ref":"#/components/schemas/recommendationText"},"guidanceType":{"$ref":"#/components/schemas/guidanceType"},"lastUpdateDate":{"$ref":"#/components/schemas/dateTime"},"lineItem":{"$ref":"#/components/schemas/dspObject"},"marketplaceId":{"$ref":"#/components/schemas/marketplaceId"},"order":{"$ref":"#/components/schemas/dspObject"},"quickactionsData":{"$ref":"#/components/schemas/quickactionsData"},"recommendationId":{"$ref":"#/components/schemas/recommendationId"},"recommendationType":{"example":"DefaultGuidance-MaxBidLineSpot","type":"string"},"table":{"description":"List of columns to display","items":{"$ref":"#/components/schemas/tableColumn"},"maxItems":10,"minItems":0,"type":"array"},"targets":{"description":"Nested list of lists used to group related objects targeted by this recommendation.","items":{"items":{"$ref":"#/components/schemas/target"},"maxItems":50,"minItems":0,"type":"array"},"maxItems":10,"minItems":0,"type":"array"},"title":{"$ref":"#/components/schemas/recommendationText"},"type":{"$ref":"#/components/schemas/type"},"userStatus":{"$ref":"#/components/schemas/userStatus"}},"type":"object"},"recommendationId":{"description":"A unique identifier for recommendation.","maxLength":500,"minLength":50,"type":"string"},"recommendationText":{"description":"Description text for the recommendation.","type":"string"},"recommendationsError":{"description":"Error returned from the server.","properties":{"errorMessage":{"description":"Detailed information about the error that occurred.","type":"string"},"requestId":{"description":"A unique value generated by the server to identify the request.","type":"string"}},"required":["errorMessage","requestId"],"type":"object"},"shapValue":{"description":"A single SHAP feature contribution to the under-delivery prediction.","properties":{"featureName":{"description":"Name of the feature contributing to the prediction.","type":"string"},"impactDirection":{"description":"Direction of this feature\u0027s influence on the predicted outcome.","enum":["NEGATIVE","POSITIVE"],"type":"string"},"magnitude":{"description":"Magnitude of the feature\u0027s contribution. Sign indicates direction.","format":"double","type":"number"},"numberOfLineItemsImpacted":{"description":"Number of line items affected by this feature.","type":"integer"}},"required":["featureName","impactDirection","magnitude"],"type":"object"},"tableColumn":{"description":"A single column to be rendered in the front-end.","properties":{"header":{"description":"Column header","type":"string"},"width":{"description":"Column width ratio expressed as whole integer - does not necessarily add up to 100.\nRatio must be positive.\n\nE.g. four columns with widths [20, 15, 50, 15] to be rendered as [20/100, 15/100, 50/100, 15/100] width\nrespectively or [2, 5, 2, 3] to be rendered as [2/12, 5/12, 2/12, 3/12].","minimum":1,"type":"integer"}},"required":["header","width"],"type":"object"},"target":{"description":"An object targeted by a recommendation, e.g a Rodeo order.","properties":{"displayName":{"description":"Optional target display name, e.g. the Rodeo order name.","type":"string"},"id":{"description":"Target identifier, e.g. Rodeo orderCfid.","type":"string"},"type":{"description":"Type of the target, e.g. RODEO_ORDER.","enum":["AMH_PARENT_VENDOR","AMH_SELLER_MCID","AMH_VENDOR_CLAIM_ID","AMH_VENDOR_CODE","ASIN_ID","AXIOM_ADGROUP_EXTERNAL_ID","AXIOM_ADGROUP_INTERNAL_ID","AXIOM_CAMPAIGN_EXTERNAL_ID","AXIOM_CAMPAIGN_INERNAL_ID","AXIOM_CAMPAIGN_INTERNAL_ID","AXIOM_KEYWORD_EXTERNAL_ID","AXIOM_KEYWORD_INTERNAL_ID","BRAND_ADVERTISER","BRAND_AID","COUNTRY_CODE","CUSTOM_BRAND","DSM_LINE_ITEM","ENTITY_ID","GROUP_ID","MARKETPLACE_ID","OMS_PROPOSAL","OPPORTUNITY_ID","REALM_ID","RODEO_ADVERTISER","RODEO_CREATIVE","RODEO_DEAL","RODEO_DRAFT_CAMPAIGN_OBJECT","RODEO_ENTITY","RODEO_LINEITEM","RODEO_LINEITEM_OBJECT","RODEO_ORDER","RODEO_ORDER_FLIGHT","RODEO_PROPOSAL","SALESFORCE_ACCOUNT_ID","SALESFORCE_OPPORTUNITY","SELLER_CENTRAL_ID","SESSION_ID","SPOT_ID","VAM_BRAND"],"type":"string"}},"type":"object"},"type":{"description":"Describes the purpose for the recommendation, for example DEPRECATED_AUDIENCE_REMOVAL","type":"string"},"underDeliveryEvidencePack":{"description":"Summary statistics about the under-delivery prediction.","properties":{"description":{"description":"Human-readable description of the under-delivery recommendation.","type":"string"},"flightBudgetAtRisk":{"description":"The amount of budget projected to be unspent by end of flight.","format":"double","type":"number"},"flightRealBudget":{"description":"The real budget for the flight in impressions or local currency.","format":"double","type":"number"},"projectedDeliveryGapProportion":{"description":"The gap between target and projected delivery as a proportion.","format":"double","type":"number"},"projectedDeliveryRate":{"description":"The projected delivery rate as a proportion (0.0 to 1.0).","format":"double","type":"number"}},"type":"object"},"userStatus":{"description":"Status for the recommendation set by user.","enum":["DEFERRED","DISMISSED"],"type":"string"}},"securitySchemes":{}},"info":{"description":"Provides guidance to improve performance and delivery of display advertising campaigns.","title":"DSP Guidance","version":"3.0"},"openapi":"3.0.1","paths":{"/dsp/v1/guidance/adGroups/list":{"post":{"description":"\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"listAdGroupGuidanceV1","parameters":[{"description":"Optionally specify the content locale, such as DSP Language of Preference. If omitted, defaults to `en-US`.","explode":false,"in":"header","name":"Accept-Language","required":false,"schema":{"$ref":"#/components/schemas/language"},"style":"simple"},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","explode":false,"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","explode":false,"in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","explode":false,"in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/vnd.dspRecommendationsListAdGroupGuidanceV1Request.v1.0+json":{"schema":{"$ref":"#/components/schemas/listAdGroupGuidanceV1Request"}}},"description":"Targets are ad groups to list guidance for.\nThe request can include optional filters to exclude individual recommendations from the guidance response when not needed to reduce the response payload size."},"responses":{"200":{"content":{"application/vnd.dspRecommendationsListGuidanceV1Response.v1.0+json":{"schema":{"$ref":"#/components/schemas/listGuidanceV1Response"}}},"description":"List of guidance for the specified ad groups."},"400":{"content":{"application/vnd.dsprecommendationserror.v1.0+json":{"schema":{"$ref":"#/components/schemas/recommendationsError"}}},"description":"Failed to perform the request."},"401":{"content":{"application/vnd.dsprecommendationserror.v1.0+json":{"schema":{"$ref":"#/components/schemas/recommendationsError"}}},"description":"Unauthorised access to the requested DSP entity identifier."}},"summary":"Retrieves a list of dynamically generated guidance based on recommendations present for a list of ad groups specified in the request body.\nThis can include guidance to correct campaign setup errors, address underdelivery or underperformance issues or adopt Amazon-recommended best practices.","tags":["Guidance"]}},"/dsp/v1/guidance/advertisers/list":{"post":{"description":"\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"listAdvertiserGuidanceV1","parameters":[{"description":"Optionally specify the content locale, such as DSP Language of Preference. If omitted, defaults to `en-US`.","explode":false,"in":"header","name":"Accept-Language","required":false,"schema":{"$ref":"#/components/schemas/language"},"style":"simple"},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","explode":false,"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","explode":false,"in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","explode":false,"in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/vnd.dspRecommendationsListAdvertiserGuidanceV1Request.v1.0+json":{"schema":{"$ref":"#/components/schemas/listAdvertiserGuidanceV1Request"}}},"description":"Targets are advertisers to list guidance for.\nThe request can include optional filters to exclude individual recommendations from the guidance response when not needed to reduce the response payload size."},"responses":{"200":{"content":{"application/vnd.dspRecommendationsListGuidanceV1Response.v1.0+json":{"schema":{"$ref":"#/components/schemas/listGuidanceV1Response"}}},"description":"List of guidance for the specified advertisers."},"400":{"content":{"application/vnd.dsprecommendationserror.v1.0+json":{"schema":{"$ref":"#/components/schemas/recommendationsError"}}},"description":"Failed to perform the request."},"401":{"content":{"application/vnd.dsprecommendationserror.v1.0+json":{"schema":{"$ref":"#/components/schemas/recommendationsError"}}},"description":"Unauthorised access to the requested DSP entity identifier."}},"summary":"Retrieves a list of dynamically generated guidance based on recommendations present for a list of advertisers specified in the request body.\nThis can include guidance to correct campaign setup errors, address underdelivery or underperformance issues or adopt Amazon-recommended best practices.","tags":["Guidance"]}},"/dsp/v1/guidance/campaigns/list":{"post":{"description":"\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"listCampaignGuidanceV1","parameters":[{"description":"Optionally specify the content locale, such as DSP Language of Preference. If omitted, defaults to `en-US`.","explode":false,"in":"header","name":"Accept-Language","required":false,"schema":{"$ref":"#/components/schemas/language"},"style":"simple"},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","explode":false,"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","explode":false,"in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","explode":false,"in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/vnd.dspRecommendationsListCampaignGuidanceV1Request.v1.0+json":{"schema":{"$ref":"#/components/schemas/listCampaignGuidanceV1Request"}}},"description":"Targets are campaigns to list guidance for.\nThe request can include optional filters to exclude individual recommendations from the guidance response when not needed to reduce the response payload size."},"responses":{"200":{"content":{"application/vnd.dspRecommendationsListGuidanceV1Response.v1.0+json":{"schema":{"$ref":"#/components/schemas/listGuidanceV1Response"}}},"description":"List of guidance for the specified campaigns."},"400":{"content":{"application/vnd.dsprecommendationserror.v1.0+json":{"schema":{"$ref":"#/components/schemas/recommendationsError"}}},"description":"Failed to perform the request."},"401":{"content":{"application/vnd.dsprecommendationserror.v1.0+json":{"schema":{"$ref":"#/components/schemas/recommendationsError"}}},"description":"Unauthorised access to the requested DSP entity identifier."}},"summary":"Retrieves a list of dynamically generated guidance based on recommendations present for a list of campaigns specified in the request body.\nThis can include guidance to correct campaign setup errors, address underdelivery or underperformance issues or adopt Amazon-recommended best practices.","tags":["Guidance"]}}}}