{"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 devices the ad group will run on. By default, the ad group will run on all available devices.","title":"Ad Group Targeting - Devices","version":"3.0"},"paths": {"/dsp/adGroups/{adGroupId}/targetingTypes/device/targets/delete":{"post":{"requestBody":{"content":{"application/vnd.dspAdGroupDeviceTargets.v1+json":{"schema":{"$ref":"#/components/schemas/DspDeleteAdGroupDeviceTargetsRequestContentV1"}}},"required":true},"description":"Remove one or more device targets from an ad group.\n\n**Requires one of these permissions**:\n[]","operationId":"DspDeleteAdGroupDeviceTargets","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 - Devices"]}},"/dsp/adGroups/{adGroupId}/targetingTypes/device/targets":{"post":{"requestBody":{"content":{"application/vnd.dspAdGroupDeviceTargets.v1+json":{"schema":{"$ref":"#/components/schemas/DspCreateAdGroupDeviceTargetsRequestContentV1"}}},"required":true},"description":"Create one or more device targets.\n\n**Requires one of these permissions**:\n[]","operationId":"DspCreateAdGroupDeviceTargets","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 - Devices"]},"get":{"description":"Gets a list of device targets associated to an ad group.\n\n**Requires one of these permissions**:\n[]","operationId":"DspGetAdGroupDeviceTargets","responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspAdGroupDeviceTargets.v1+json":{"schema":{"$ref":"#/components/schemas/DspGetAdGroupDeviceTargetsResponseContent"}}}},"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 - Devices"]}}},"components": {"headers":{},"examples":{},"schemas":{"DspFunctionalPatchDefaultAdGroupDeviceTargetsOutputPayload":{},"DspFunctionalPatchDefaultAdGroupDeviceTargetsRequestContent":{"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"}}}},"DeviceTargetsV1":{"type":"object","properties":{"deviceType":{"$ref":"#/components/schemas/DspDeviceV1"},"mobileEnvironment":{"$ref":"#/components/schemas/DspMobileEnvironmentV1"},"mobileDevice":{"$ref":"#/components/schemas/DspMobileDeviceV1"},"deviceOrientation":{"$ref":"#/components/schemas/DspDeviceOrientationV1"},"mobileOS":{"$ref":"#/components/schemas/DspMobileOSV1"}},"required":["deviceType"]},"DspConflictExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspFunctionalPatchDefaultAdGroupDeviceTargetsV2RequestContent":{"type":"object","properties":{"resourceId":{"type":"string"},"create":{"type":"boolean"},"finalize":{"type":"boolean"},"flights":{"type":"array"},"validate":{"type":"boolean"}}},"DspMobileOSV1":{"description":"The mobile operating system targeting type. This field can only be used if mobileEnvironment is `WEB`. Defaults and allowed values when mobileEnvironment is `WEB` and inventoryType is:<ul><li>AMAZON_MOBILE_DISPLAY: IOS, ANDROID<\/li><li>AAP_MOBILE_APP: n/a<\/li><li>STANDARD_DISPLAY: IOS, ANDROID<\/li><li>VIDEO: n/a<\/li><\/ul>","type":"string","enum":["IOS","ANDROID"]},"DspCreateAdGroupDeviceTargetsRequestContentV1":{"description":"The create operation input.","type":"object","properties":{"deviceTargets":{"minItems":1,"maxItems":100,"description":"A list of targets.","type":"array","items":{"$ref":"#/components/schemas/DeviceTargetsV1"}}},"required":["deviceTargets"]},"DspFunctionalPatchDefaultAdGroupDeviceTargetsV2ResponseContent":{"description":"Result ","type":"object","properties":{"flights":{"type":"array"}}},"DspDeviceOrientationV1":{"description":"The mobile device orientation type. This field can only be used if mobileEnvironment is `APP`. Defaults and allowed values when mobileEnvironment is `APP` and inventoryType is:<ul><li>AMAZON_MOBILE_DISPLAY: n/a/<\/li><li>AAP_MOBILE_APP: PORTRAIT, LANDSCAPE<\/li><li>STANDARD_DISPLAY: n/a<\/li><li>VIDEO: n/a<\/li><\/ul>","type":"string","enum":["PORTRAIT","LANDSCAPE"]},"DspBadRequestExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspGetAdGroupDeviceTargetsResponseContent":{"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"},"deviceTargets":{"minItems":1,"maxItems":100,"description":"A list of targets.","type":"array","items":{"$ref":"#/components/schemas/DeviceTargetsV1"}}},"required":["deviceTargets"]},"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"}}}},"DspDeviceV1":{"description":"Required for all inventory types. Defaults and allowed values when inventoryType is:<ul><li>AMAZON_MOBILE_DISPLAY: MOBILE<\/li><li>AAP_MOBILE_APP: MOBILE<\/li><li>STANDARD_DISPLAY: DESKTOP, MOBILE<\/li><li>VIDEO: DESKTOP, MOBILE, CONNECTED_TV<\/li><\/ul>","type":"string","enum":["DESKTOP","MOBILE","CONNECTED_TV"]},"DspMobileEnvironmentV1":{"description":"The mobile environment targeting type. This field can only be used if deviceType is `MOBILE`. Defaults and allowed values when deviceType is `MOBILE` and inventoryType is:<ul><li>AMAZON_MOBILE_DISPLAY: WEB<\/li><li>AAP_MOBILE_APP: APP<\/li><li>STANDARD_DISPLAY: WEB<\/li><li>VIDEO: WEB, APP<\/li><\/ul>","type":"string","enum":["WEB","APP"]},"DspDeleteAdGroupDeviceTargetsRequestContentV1":{"description":"The delete operation input.","type":"object","properties":{"deviceTargets":{"minItems":1,"maxItems":100,"description":"A list of targets.","type":"array","items":{"$ref":"#/components/schemas/DeviceTargetsV1"}}},"required":["deviceTargets"]},"DspForbiddenExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspUnauthorizedExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspMobileDeviceV1":{"description":"The mobile device targeting type. This field can only be used if mobileEnvironment is `APP`. Defaults and allowed values when mobileEnvironment is `APP` and inventoryType is:<ul><li>AMAZON_MOBILE_DISPLAY: n/a<\/li><li>AAP_MOBILE_APP: IPHONE, IPAD, ANDROID, KINDLE_FIRE, KINDLE_FIRE_HD<\/li><li>STANDARD_DISPLAY: n/a<\/li><li>VIDEO: n/a<\/li><\/ul>","type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]},"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"}