{"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.","title":"Ad Group Targeting - Video Ad Initiation Type","version":"3.0"},"paths": {"/dsp/adGroups/{adGroupId}/targetingTypes/adInitiationType/targets":{"post":{"requestBody":{"content":{"application/vnd.dspAdGroupTargetingAdInitiationType.v1+json":{"schema":{"$ref":"#/components/schemas/DspCreateAdGroupTargetingAdInitiationTypeRequestContentV1"}}},"required":true},"description":"Creates and associates one or more ad initiation type targets to an ad group.\n\n**Requires one of these permissions**:\n[]","operationId":"DspCreateAdGroupAdInitiationTypeTargets","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspCreateAdGroupTargetingAdInitiationTypeResponseContentV1"}}}},"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 - Video Ad Initiation Type"]},"get":{"description":"Gets a list of ad initiation type targets associated to an ad group.\n\n**Requires one of these permissions**:\n[]","operationId":"DspGetAdGroupAdInitiationTypeTargets","responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspAdGroupTargetingAdInitiationType.v1+json":{"schema":{"$ref":"#/components/schemas/DspGetAdGroupAdInitiationTypeTargetsResponseContent"}}}},"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":"Sets the maximum number of objects in the returned array. Use in conjunction with the nextToken parameter to control pagination. For example, supplying maxResults=20 with a previously returned token will fetch up to the next 20 items. In some cases, fewer items may be returned.","type":"integer"},"in":"query","name":"maxResults","description":"Sets the maximum number of objects in the returned array. Use in conjunction with the nextToken parameter to control pagination. For example, supplying maxResults=20 with a previously returned token will fetch up to the next 20 items. In some cases, fewer items may be returned."},{"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 - Video Ad Initiation Type"]}},"/dsp/adGroups/{adGroupId}/targetingTypes/adInitiationType/targets/delete":{"post":{"requestBody":{"content":{"application/vnd.dspAdGroupTargetingAdInitiationType.v1+json":{"schema":{"$ref":"#/components/schemas/DspDeleteAdGroupTargetingAdInitiationTypeRequestContentV1"}}},"required":true},"description":"Removes one or more ad initiation type targets from an ad group.\n\n**Requires one of these permissions**:\n[]","operationId":"DspDeleteAdGroupAdInitiationTypeTargets","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspDeleteAdGroupTargetingAdInitiationTypeResponseContentV1"}}}},"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 - Video Ad Initiation Type"]}}},"components": {"headers":{},"examples":{},"schemas":{"DspDeleteAdGroupTargetingAdInitiationTypeRequestContentV1":{"description":"The delete operation request.","type":"object","properties":{"adInitiationTypeTargets":{"minItems":1,"maxItems":3,"description":"A list of targets.","type":"array","items":{"$ref":"#/components/schemas/DspAdInitiationTypeTargetV1"}}},"required":["adInitiationTypeTargets"]},"DspSubErrorV1":{"type":"object","properties":{"fieldName":{"type":"string"},"errorType":{"type":"string"},"message":{"type":"string"}},"required":["errorType","message"]},"DspAdInitiationTypeV1":{"description":"Target video inventory by how the video will be started. To avoid delivery issues, note that Amazon Publisher Direct doesn\u2019t have any autoplay inventory. For maximum scale, we recommend targeting both autoplay and user-initiated when serving on out-stream inventory.","type":"string","enum":["USER_INITIATED","AUTOPLAY","UNKNOWN"]},"DspUnsupportedMediaTypeExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspConflictExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspAdInitiationTypeErrorV1":{"type":"object","properties":{"index":{"description":"The index of the object in the array from the request body.","type":"integer","minimum":0},"errors":{"minItems":0,"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}},"required":["errors","index"]},"DspAdInitiationTypeSuccessV1":{"type":"object","properties":{"index":{"description":"The index of the object in the array from the request body.","type":"integer","minimum":0}},"required":["index"]},"DspAdInitiationTypeTargetV1":{"type":"object","properties":{"videoInitiationType":{"$ref":"#/components/schemas/DspAdInitiationTypeV1"}},"required":["videoInitiationType"]},"DspBadRequestExceptionV1ResponseContent":{"type":"object","properties":{"requestId":{"type":"string"},"message":{"type":"string"},"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DspSubErrorV1"}}}},"DspCreateAdGroupTargetingAdInitiationTypeRequestContentV1":{"description":"The create operation request.","type":"object","properties":{"adInitiationTypeTargets":{"minItems":1,"maxItems":3,"description":"A list of targets.","type":"array","items":{"$ref":"#/components/schemas/DspAdInitiationTypeTargetV1"}}},"required":["adInitiationTypeTargets"]},"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"}}}},"DspGetAdGroupAdInitiationTypeTargetsResponseContent":{"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"},"adInitiationTypeTargets":{"minItems":1,"maxItems":3,"description":"A list of targets.","type":"array","items":{"$ref":"#/components/schemas/DspAdInitiationTypeTargetV1"}}},"required":["adInitiationTypeTargets"]},"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"}}}},"DspDeleteAdGroupTargetingAdInitiationTypeResponseContentV1":{"description":"The delete operation response.","type":"object","properties":{"success":{"description":"The list of successful deletions.","type":"array","items":{"$ref":"#/components/schemas/DspAdInitiationTypeSuccessV1"}},"error":{"description":"The list of unsuccessful deletions.","type":"array","items":{"$ref":"#/components/schemas/DspAdInitiationTypeErrorV1"}}}},"DspCreateAdGroupTargetingAdInitiationTypeResponseContentV1":{"description":"The create operation response.","type":"object","properties":{"success":{"description":"The list of successful targeting objects.","type":"array","items":{"$ref":"#/components/schemas/DspAdInitiationTypeSuccessV1"}},"error":{"description":"The list of unsuccessful targeting objects.","type":"array","items":{"$ref":"#/components/schemas/DspAdInitiationTypeErrorV1"}}}},"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"}