{"info": {"description":"These APIs are part of the Amazon DSP Campaign Management API closed beta and only accessible to closed beta participants at this time. Because these APIs are in closed beta, they don’t follow our normal versioning standards and are subject to change. If you are interested in joining the closed beta, please [submit a support ticket](https://amzn-clicks.atlassian.net/servicedesk/customer/portal/2/group/2/create/5) and we’ll follow up with additional information. <br><br> Choose the inventory that an ad group will run on. By default, the ad group will run on all available third-party exchanges, Amazon-owned sites, and Amazon Publisher Direct inventory. The maximum number of deals (across both deals and inventory groups) that can be targeted on an ad group is 500.","title":"Ad Group Targeting - Inventory Sources","version":"3.0"},"paths": {"/dsp/adGroups/{adGroupId}/targetingTypes/inventorySource/targets/delete":{"post":{"requestBody":{"content":{"application/vnd.dspAdGroupTargetingInventorySource.v1+json":{"schema":{"$ref":"#/components/schemas/DspDeleteAdGroupInventorySourceTargetsRequestContentV1"}}},"required":true},"description":"Delete one or more inventory sources from an ad group. If all inventory sources on an ad group are deleted, then all eligible sources will be added to the ad group by default.\n\n**Requires one of these permissions**:\n[]","operationId":"DspDeleteAdGroupInventorySourceTargets","responses":{"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionV1ResponseContent"}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionV1ResponseContent"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionV1ResponseContent"}}}},"204":{"description":"Success with no body content."},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionV1ResponseContent"}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionV1ResponseContent"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionV1ResponseContent"}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionV1ResponseContent"}}}},"409":{"description":"DspConflictExceptionV1 409 response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionV1ResponseContent"}}}}},"parameters":[{"schema":{"description":"The ad group identifier.","type":"string"},"in":"path","name":"adGroupId","description":"The ad group identifier.","required":true},{"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","required":true},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","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"},"in":"header","name":"Amazon-Advertising-API-Scope","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.","required":true}],"tags":["Ad Group Targeting - Inventory Sources"]}},"/dsp/adGroups/{adGroupId}/targetingTypes/inventorySource/targets":{"post":{"requestBody":{"content":{"application/vnd.dspAdGroupTargetingInventorySource.v1+json":{"schema":{"$ref":"#/components/schemas/DspCreateAdGroupInventorySourceTargetsRequestContentV1"}}},"required":true},"description":"Creates and associates one or more inventory source targets to an ad group.\n\n**Requires one of these permissions**:\n[]","operationId":"DspCreateAdGroupInventorySourceTargets","responses":{"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionV1ResponseContent"}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionV1ResponseContent"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionV1ResponseContent"}}}},"204":{"description":"Success with no body content."},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionV1ResponseContent"}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionV1ResponseContent"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionV1ResponseContent"}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionV1ResponseContent"}}}},"409":{"description":"DspConflictExceptionV1 409 response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionV1ResponseContent"}}}}},"parameters":[{"schema":{"description":"The ad group identifier.","type":"string"},"in":"path","name":"adGroupId","description":"The ad group identifier.","required":true},{"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","required":true},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","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"},"in":"header","name":"Amazon-Advertising-API-Scope","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.","required":true}],"tags":["Ad Group Targeting - Inventory Sources"]},"get":{"description":"Gets a list of inventory source targets associated to an ad group.\n\n**Requires one of these permissions**:\n[]","operationId":"DspGetAdGroupInventorySourceTargets","responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspAdGroupTargetingInventorySource.v1+json":{"schema":{"$ref":"#/components/schemas/DspGetAdGroupInventorySourceTargetsResponseContent"}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionV1ResponseContent"}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionV1ResponseContent"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionV1ResponseContent"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionV1ResponseContent"}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionV1ResponseContent"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionV1ResponseContent"}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionV1ResponseContent"}}}},"409":{"description":"DspConflictExceptionV1 409 response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspConflictExceptionV1ResponseContent"}}}}},"parameters":[{"schema":{"description":"The ad group identifier.","type":"string"},"in":"path","name":"adGroupId","description":"The ad group identifier.","required":true},{"schema":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the nextToken field is empty, there are no further results.","type":"string"},"in":"query","name":"nextToken","description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the nextToken field is empty, there are no further results."},{"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","required":true},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","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"},"in":"header","name":"Amazon-Advertising-API-Scope","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.","required":true}],"tags":["Ad Group Targeting - Inventory Sources"]}}},"components": {"headers":{},"examples":{},"schemas":{"DspDeleteAdGroupInventorySourceTargetsRequestContentV1":{"type":"object","properties":{"inventorySourceTargets":{"minItems":1,"maxItems":1000,"description":"A list of targets.","type":"array","items":{"$ref":"#/components/schemas/DspDeleteAdGroupInventorySourceTargetV1"}}},"required":["inventorySourceTargets"]},"DspFunctionalPatchDefaultAdGroupInventorySourceTargetsRequestContent":{"type":"object","properties":{"resourceId":{"type":"string"},"create":{"type":"boolean"},"finalize":{"type":"boolean"},"flights":{"type":"array"},"validate":{"type":"boolean"}}},"DspSubErrorV1":{"type":"object","properties":{"fieldName":{"type":"string"},"errorType":{"type":"string"},"message":{"type":"string"}},"required":["errorType","message"]},"DspUnsupportedMediaTypeExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspCreateAdGroupInventorySourceTargetsRequestContentV1":{"type":"object","properties":{"inventorySourceTargets":{"minItems":1,"maxItems":1000,"description":"A list of targets.","type":"array","items":{"$ref":"#/components/schemas/DspCreateAdGroupInventorySourceTargetV1"}}},"required":["inventorySourceTargets"]},"DspConflictExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspBadRequestExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspInternalServerExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspTooManyRequestsExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspCreateAdGroupInventorySourceTargetV1":{"type":"object","properties":{"inventorySourceId":{"description":"The inventory source identifier can be retrieved from the <a href='https://advertising.amazon.com/API/docs/en-us/dsp-discovery-inventory-source-exchanges'>exchanges<\/a> or <a href='https://advertising.amazon.com/API/docs/en-us/dsp-deals-3p#tag/Discovery/operation/listCMInventoryDiscoveryDeals'>deals<\/a> discovery endpoints.","type":"string"},"inventorySourceType":{"$ref":"#/components/schemas/InventorySourceTypePostV1"}},"required":["inventorySourceId","inventorySourceType"]},"DspGetAdGroupInventorySourceTargetV1":{"type":"object","properties":{"inventorySourceId":{"description":"The inventory source identifier can be retrieved from the <a href='https://advertising.amazon.com/API/docs/en-us/dsp-discovery-inventory-source-exchanges'>exchanges<\/a> or <a href='https://advertising.amazon.com/API/docs/en-us/dsp-deals-3p#tag/Discovery/operation/listCMInventoryDiscoveryDeals'>deals<\/a> discovery endpoints.","type":"string"},"inventorySourceType":{"$ref":"#/components/schemas/InventorySourceTypeGetV1"}},"required":["inventorySourceId","inventorySourceType"]},"InventorySourceTypeGetV1":{"description":"The type of inventory source to be targeted.\n* AMAZON: Amazon owned and operated inventory.\n* APD: Amazon Publisher Direct inventory.\n* THIRD_PARTY_EXCHANGE: Third-party exchange inventory.\n* DEAL: Deal inventory.\n* INVENTORY_GROUP: A group of deals.","type":"string","enum":["AMAZON","APD","THIRD_PARTY_EXCHANGE","DEAL","INVENTORY_GROUP","OTHER"]},"DspForbiddenExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspFunctionalPatchDefaultAdGroupInventorySourceTargetsOutputPayload":{},"DspUnauthorizedExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspDeleteAdGroupInventorySourceTargetV1":{"type":"object","properties":{"inventorySourceId":{"description":"The inventory source identifier can be retrieved from the <a href='https://advertising.amazon.com/API/docs/en-us/dsp-discovery-inventory-source-exchanges'>exchanges<\/a> or <a href='https://advertising.amazon.com/API/docs/en-us/dsp-deals-3p#tag/Discovery/operation/listCMInventoryDiscoveryDeals'>deals<\/a> discovery endpoints.","type":"string"},"inventorySourceType":{"$ref":"#/components/schemas/InventorySourceTypePostV1"}},"required":["inventorySourceId","inventorySourceType"]},"DspGetAdGroupInventorySourceTargetsResponseContent":{"type":"object","properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the nextToken field is empty, there are no further results.","type":"string"},"inventorySourceTargets":{"minItems":0,"maxItems":1000,"description":"A list of targets.","type":"array","items":{"$ref":"#/components/schemas/DspGetAdGroupInventorySourceTargetV1"}}},"required":["inventorySourceTargets"]},"InventorySourceTypePostV1":{"description":"The type of inventory source to be targeted.\n* AMAZON: Amazon owned and operated inventory.\n* APD: Amazon Publisher Direct inventory.\n* THIRD_PARTY_EXCHANGE: Third-party exchange inventory.\n* DEAL: Deal inventory.\n* INVENTORY_GROUP: A group of deals.","type":"string","enum":["AMAZON","APD","THIRD_PARTY_EXCHANGE","DEAL","INVENTORY_GROUP"]},"DspNotFoundExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}}},"requestBodies":{},"responses":{},"callbacks":{},"links":{},"securitySchemes":{},"parameters":{}},"openapi": "3.0.1"}