{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"CampaignInsight":{"properties":{"adGroupId":{"type":"string"},"insights":{"$ref":"#/components/schemas/InsightsUnion"}},"required":["insights"],"type":"object"},"DspBadRequestExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspConflictExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspForbiddenExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspInternalServerExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspNotFoundExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspSubErrorV1":{"properties":{"errorType":{"type":"string"},"fieldName":{"type":"string"},"message":{"type":"string"}},"required":["errorType","message"],"type":"object"},"DspTooManyRequestsExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspUnauthorizedExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"DspUnsupportedMediaTypeExceptionV1ResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1"},"maxItems":100,"minItems":1,"type":"array"},"message":{"type":"string"},"requestId":{"type":"string"}},"type":"object"},"ErrorResponse":{"properties":{"adGroupId":{"type":"string"},"campaignId":{"type":"string"},"errorCode":{"type":"integer"},"errorMessage":{"type":"string"},"index":{"type":"integer"}},"required":["campaignId","errorCode","errorMessage","index"],"type":"object"},"InsightRequest":{"properties":{"adGroupId":{"type":"string"},"campaignId":{"type":"string"},"insightType":{"$ref":"#/components/schemas/InsightType"}},"required":["campaignId","insightType"],"type":"object"},"InsightType":{"enum":["PERFORMANCE_PLUS_SHOPPER_TRAIT","PERSONA","TARGETING_PERFORMANCE"],"type":"string"},"InsightsUnion":{"oneOf":[{"properties":{"performancePlusShopperTraitInsight":{"$ref":"#/components/schemas/PerformancePlusShopperTraitInsight"}},"required":["performancePlusShopperTraitInsight"],"title":"performancePlusShopperTraitInsight","type":"object"},{"properties":{"targetingPerformanceInsight":{"$ref":"#/components/schemas/TargetingPerformanceInsight"}},"required":["targetingPerformanceInsight"],"title":"targetingPerformanceInsight","type":"object"},{"properties":{"personaInsight":{"$ref":"#/components/schemas/PersonaInsight"}},"required":["personaInsight"],"title":"personaInsight","type":"object"}]},"ListDspCampaignInsightsRequestContent":{"properties":{"requests":{"items":{"$ref":"#/components/schemas/InsightRequest"},"maxItems":25,"minItems":1,"type":"array"}},"required":["requests"],"type":"object"},"ListDspCampaignInsightsResponseContent":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array"},"success":{"items":{"$ref":"#/components/schemas/SuccessInsightsResponse"},"type":"array"}},"type":"object"},"MonetaryMetricValue":{"properties":{"baseline":{"$ref":"#/components/schemas/TargetingPerformanceBaseline"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["baseline","value"],"type":"object"},"MonetaryValue":{"properties":{"amount":{"type":"number"},"currencyCode":{"type":"string"}},"required":["amount","currencyCode"],"type":"object"},"NumericMetricValue":{"properties":{"baseline":{"$ref":"#/components/schemas/TargetingPerformanceBaseline"},"value":{"$ref":"#/components/schemas/NumericValue"}},"required":["baseline","value"],"type":"object"},"NumericValue":{"properties":{"amount":{"type":"number"}},"required":["amount"],"type":"object"},"PerformancePlusShopperTrait":{"properties":{"cost":{"format":"double","type":"number"},"impressionShare":{"format":"double","type":"number"},"impressions":{"type":"integer"},"medianTimeToConvertInHoursPerTrait":{"format":"double","type":"number"},"offAmazonConversions":{"type":"integer"},"shopperTraitDescription":{"type":"string"},"shopperTraitIndex":{"type":"integer"},"shopperTraitName":{"type":"string"},"totalPurchases":{"type":"integer"}},"required":["impressionShare","shopperTraitDescription","shopperTraitIndex","shopperTraitName"],"type":"object"},"PerformancePlusShopperTraitInsight":{"properties":{"medianTimeToConvertInHours":{"format":"double","type":"number"},"performancePlusShopperTraits":{"items":{"$ref":"#/components/schemas/PerformancePlusShopperTrait"},"type":"array"},"performancePlusTargetingTactic":{"$ref":"#/components/schemas/PerformancePlusTargetingTactic"},"timeToConvertBuckets":{"items":{"$ref":"#/components/schemas/TimeToConvertBucket"},"type":"array"}},"required":["medianTimeToConvertInHours","performancePlusShopperTraits","performancePlusTargetingTactic","timeToConvertBuckets"],"type":"object"},"PerformancePlusTargetingTactic":{"enum":["All","Customer Acquisition","Prospecting","Remarketing","Retention","Unified Consideration"],"type":"string"},"Persona":{"properties":{"clickThroughRate":{"$ref":"#/components/schemas/PersonaMetricValue"},"impressionShare":{"$ref":"#/components/schemas/PersonaMetricValue"},"offAmazonConversions":{"$ref":"#/components/schemas/PersonaMetricValue"},"personaDescription":{"type":"string"},"personaName":{"type":"string"},"personaTypes":{"items":{"$ref":"#/components/schemas/PersonaType"},"maxItems":3,"minItems":1,"type":"array"},"purchaseRate":{"$ref":"#/components/schemas/PersonaMetricValue"},"totalCost":{"$ref":"#/components/schemas/PersonaMonetaryMetricValue"},"totalPurchases":{"$ref":"#/components/schemas/PersonaMetricValue"}},"required":["impressionShare","personaDescription","personaName","personaTypes"],"type":"object"},"PersonaInsight":{"properties":{"performancePlusTargetingTactic":{"$ref":"#/components/schemas/PerformancePlusTargetingTactic"},"personas":{"items":{"$ref":"#/components/schemas/Persona"},"maxItems":30,"minItems":1,"type":"array"}},"required":["personas"],"type":"object"},"PersonaMetricValue":{"properties":{"value":{"type":"number"}},"required":["value"],"type":"object"},"PersonaMonetaryMetricValue":{"properties":{"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object"},"PersonaType":{"enum":["BEST_PERFORMING","HIGHEST_REACH","MOST_ENGAGING"],"type":"string"},"SuccessInsightsResponse":{"properties":{"campaignId":{"type":"string"},"campaignInsights":{"items":{"$ref":"#/components/schemas/CampaignInsight"},"type":"array"},"index":{"type":"integer"},"insightDate":{"type":"string"}},"required":["campaignId","campaignInsights","index"],"type":"object"},"TargetingPerformanceBaseline":{"properties":{"status":{"$ref":"#/components/schemas/TargetingPerformanceBaselineStatus"}},"required":["status"],"type":"object"},"TargetingPerformanceBaselineStatus":{"enum":["ABOVE","AT_BASELINE","BELOW"],"type":"string"},"TargetingPerformanceInsight":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/TargetingPerformanceTarget"},"maxItems":10,"minItems":0,"type":"array"}},"required":["targets"],"type":"object"},"TargetingPerformanceTarget":{"properties":{"adSpend":{"$ref":"#/components/schemas/MonetaryMetricValue"},"costPerAction":{"$ref":"#/components/schemas/MonetaryMetricValue"},"detailPageViewRate":{"$ref":"#/components/schemas/NumericMetricValue"},"id":{"type":"string"},"impressions":{"$ref":"#/components/schemas/NumericMetricValue"},"returnOnAdvertiserSpend":{"$ref":"#/components/schemas/NumericMetricValue"},"type":{"$ref":"#/components/schemas/TargetingPerformanceTargetType"},"videoCompletionRate":{"$ref":"#/components/schemas/NumericMetricValue"}},"required":["adSpend","id","impressions","type"],"type":"object"},"TargetingPerformanceTargetType":{"enum":["KEYWORD","PRODUCT","PRODUCT_CATEGORY","PRODUCT_COMPLEMENTS","PRODUCT_REMARKETING","PRODUCT_SIMILAR"],"type":"string"},"TimeToConvertBucket":{"properties":{"conversionShare":{"format":"double","type":"number"},"range":{"type":"string"}},"required":["conversionShare","range"],"type":"object"}},"securitySchemes":{}},"info":{"description":"The DSP Campaign Insights API provides campaign and ad group performance insights for given campaign or ad ad group ids.","title":"D16GDspApiCampaignInsightsV1","version":"3.0"},"openapi":"3.0.1","paths":{"/dsp/v1/campaign/insights":{"post":{"description":"Gets campaign and ad group performance insights given campaign ids or ad group ids.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Advertising-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"GetDspCampaignInsightsV1","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"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.","type":"string"}},{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Advertising-AccountId","required":true,"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"}}],"requestBody":{"content":{"application/vnd.dspDspCampaignInsights.v1+json":{"schema":{"$ref":"#/components/schemas/ListDspCampaignInsightsRequestContent"}}}},"responses":{"207":{"content":{"application/vnd.dspDspCampaignInsights.v1+json":{"schema":{"$ref":"#/components/schemas/ListDspCampaignInsightsResponseContent"}}},"description":"Multi-status."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionV1ResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionV1ResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionV1ResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionV1ResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionV1ResponseContent"}}},"description":"DspConflictExceptionV1 409 response"},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionV1ResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionV1ResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionV1ResponseContent"}}},"description":"Internal Server Error."}},"tags":["DspCampaignInsights"]}}}}