Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"accountId":{"description":"Account Identifier you use to access the DSP. This is your DSP Advertiser ID. DSP Entity ID is not supported.","in":"path","name":"accountId","required":true,"schema":{"type":"string"}},"clientHeader":{"description":"The identifier of a client associated with a `Login with Amazon` account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},"dspAccountId":{"description":"Account Identifier you use to access the DSP. This is your DSP Advertiser ID. This header is required for access to any DSP data when you have been directly invited to the advertiser.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},"managerAccountId":{"description":"The identifier of an Amazon Ads Manager Account. This ID can be retrieved by making a GET request to the /managerAccounts endpoint.","in":"header","name":"Amazon-Ads-Manager-Account-ID","required":false,"schema":{"type":"string"}},"profileHeader":{"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 and choose profile id profileId from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":false,"schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"AmazonAdTagEventAssociationStatusV1":{"description":"The conversion definition association status of the event. If the event is associated to an existing conversion definition, it will be marked as IN_USE. If the event has no existing association, it will be marked as AVAILABLE for conversion definition purposes.","enum":["AVAILABLE","IN_USE"],"type":"string"},"AmazonAdTagEventV1":{"properties":{"eventName":{"description":"The name of the event.","type":"string"},"lastActivityDateTime":{"description":"The last time this event was triggered within the dates supplied by the startDateTime and endDateTime fields.","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/AmazonAdTagEventAssociationStatusV1"}},"type":"object"},"AmazonAdTagV1":{"description":"An Amazon ad tag for a given advertiser.","properties":{"createDateTime":{"description":"The reported timestamp of when the ad tag was created in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","type":"string"},"tagId":{"description":"A string depicting the ID of the ad tag.","type":"string"}},"type":"object"},"AssociatedMobileMeasurementPartnerAppRegistrationV1":{"properties":{"associatedMobileApp":{"$ref":"#/components/schemas/MobileMeasurementPartnerAppRegistrationV1"},"eventName":{"description":"Mobile measurement partner event associated with this conversion definition","type":"string"}},"type":"object"},"BatchAssociateConversionDefinitionsRequestV1":{"items":{"properties":{"conversionDefinitionId":{"type":"string"},"operation":{"enum":["ADD","REMOVE"],"type":"string"}},"required":["conversionDefinitionId","operation"]},"maxItems":100,"minItems":1,"type":"array"},"BatchAssociateConversionDefinitionsRequestV2":{"items":{"properties":{"conversionDefinitionId":{"type":"string"},"isOptimized":{"description":"Denotes the association should be considered as optimized.","type":"boolean"},"operation":{"enum":["ADD","REMOVE"],"type":"string"}},"required":["conversionDefinitionId","isOptimized","operation"]},"maxItems":100,"minItems":1,"type":"array"},"BatchAssociateConversionDefinitionsResponseV1":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ConversionDefinitionErrorResponseV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/ConversionDefinitionSuccessResponseV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"BatchCreateConversionDefinitionsRequestV1":{"items":{"$ref":"#/components/schemas/ConversionDefinitionInputV1"},"maxItems":10,"minItems":1,"type":"array"},"BatchCreateConversionDefinitionsRequestV2":{"items":{"$ref":"#/components/schemas/ConversionDefinitionInputV2"},"maxItems":10,"minItems":1,"type":"array"},"BatchCreateMobileMeasurementPartnerAppRegistrationRequestV1":{"items":{"$ref":"#/components/schemas/MobileMeasurementPartnerAppRegistrationV1"},"maxItems":10,"minItems":1,"type":"array"},"BatchDeleteMobileMeasurementPartnerAppRegistrationRequestV1":{"items":{"$ref":"#/components/schemas/DeleteMobileMeasurementPartnerAppRegistrationV1"},"maxItems":1,"minItems":1,"type":"array"},"BatchDeleteUserEventsRequestV1":{"properties":{"deletionRequests":{"items":{"$ref":"#/components/schemas/EventDeletionRequestV1"},"maxItems":500,"minItems":1,"type":"array"}},"required":["deletionRequests"],"type":"object"},"BatchDeleteUserEventsResponseV1":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ConversionDeletionRequestErrorResponseV1","properties":{}},"maxItems":500,"minItems":1,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/ConversionDeletionRequestSuccessResponseV1","properties":{}},"maxItems":500,"minItems":1,"type":"array"}},"type":"object"},"BatchGetConversionDefinitionsAssociatedForOrdersRequestV1":{"properties":{"maxResults":{"default":"10","description":"Sets the maximum number of conversions in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"},"orderIds":{"items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"BatchGetConversionDefinitionsForOrdersResponseV1":{"properties":{"conversionDefinitions":{"description":"List of associated ConversionDefinitions.","items":{"$ref":"#/components/schemas/BatchOrdersAssociatedConversionDefinitionsV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"maxResults":{"type":"string"},"nextToken":{"type":"string"}},"type":"object"},"BatchImportConversionEventDataRequestV1":{"properties":{"eventData":{"items":{"$ref":"#/components/schemas/ConversionEventDataV1"},"maxItems":100,"minItems":1,"type":"array"},"source":{"$ref":"#/components/schemas/ConversionDefinitionSourceV1"}},"required":["eventData","source"],"type":"object"},"BatchImportConversionEventDataResponseV1":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ConversionEventDataErrorResponseV1","properties":{}},"maxItems":100,"minItems":1,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/ConversionEventDataSuccessResponseV1","properties":{}},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"BatchOrdersAssociatedConversionDefinitionsV1":{"properties":{"campaignId":{"description":"Order identifier for this conversion definition.","type":"string"},"conversionDefinitionId":{"description":"Associated conversion definition identifier for the order.","type":"string"}},"type":"object"},"BatchUpdateConversionDefinitionsRequestV1":{"items":{"$ref":"#/components/schemas/UpdateConversionDefinitionV1"},"maxItems":10,"minItems":1,"type":"array"},"BatchUpdateConversionDefinitionsRequestV2":{"items":{"$ref":"#/components/schemas/UpdateConversionDefinitionV2"},"maxItems":10,"minItems":1,"type":"array"},"BatchUpdateMobileMeasurementPartnerAppRegistrationRequestV1":{"items":{"$ref":"#/components/schemas/UpdateMobileMeasurementPartnerAppRegistrationV1"},"maxItems":1,"minItems":1,"type":"array"},"ConversionDefinitionAdTagEventAssociationRequestV1":{"description":"The combination of adTagId and adTagEventName identifies an unique adTag event.","properties":{"adTagEventName":{"type":"string"},"adTagId":{"type":"string"},"operation":{"enum":["ADD","REMOVE"],"type":"string"}},"required":["adTagEventName","adTagId","operation"],"type":"object"},"ConversionDefinitionAssociatedAdTagEventV1":{"properties":{"adTagEventName":{"type":"string"},"adTagId":{"type":"string"}},"type":"object"},"ConversionDefinitionCountingMethodV1":{"description":"Method used to determine whether all or only the first conversion event per user, per conversion definition are ingested within a 24 hour window.","enum":["EVERY","FIRST"],"type":"string"},"ConversionDefinitionCreatedByV1":{"properties":{"accountId":{"description":"ID of the account which created the conversion definition. The value could be either DSP Advertiser ID or manager Account ID.","type":"string"},"name":{"description":"Name of the account which created the conversion definition.","type":"string"}},"type":"object"},"ConversionDefinitionCreatedSourceV1":{"enum":["AMAZON_AD_TAG","MMP","SERVER_TO_SERVER"],"type":"string"},"ConversionDefinitionCurrencyCodeV1":{"description":"The currencyCode associated with the 'value' of the event in ISO-4217 format. Only applicable for OFF_AMAZON_PURCHASES conversion type. If not provided, the currencyCode setting on the conversion definition will be used.","enum":["AED","AUD","BRL","CAD","CNY","DKK","EUR","GBP","INR","JPY","MXN","NOK","NZD","SAR","SEK","SGD","TRY","USD"],"type":"string"},"ConversionDefinitionErrorResponseV1":{"properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"The index of the object in the request, starting from 1.","format":"int32","type":"integer"},"message":{"description":"A human-readable message of the code.","type":"string"}},"type":"object"},"ConversionDefinitionFilterV1":{"properties":{"field":{"enum":["CONVERSION_DEFINITION_ID"],"type":"string"},"values":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["field","values"],"type":"object"},"ConversionDefinitionInputV1":{"description":"The conversion definition object.","properties":{"conversionDefinitionId":{"description":"The id of the ConversionDefinition.","readOnly":true,"type":"string"},"conversionType":{"$ref":"#/components/schemas/ConversionDefinitionTypeV1"},"countingMethod":{"$ref":"#/components/schemas/ConversionDefinitionCountingMethodV1"},"createTime":{"description":"The timestamp of when the ConversionDefinition was created in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"lastActivityTime":{"description":"The latest timestamp of when a conversion event for the ConversionDefinition was imported in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"lastUpdatedTime":{"description":"Date and time last edit was made to conversion settings in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"The name of the ConversionDefinition.","maxLength":256,"minLength":1,"type":"string"},"source":{"$ref":"#/components/schemas/ConversionDefinitionSourceV1"},"sourceType":{"$ref":"#/components/schemas/ConversionDefinitionSourceTypeV1"},"value":{"description":"The value of the event.<br>\nWhen the conversionType of the associated Conversion Definition is OFF_AMAZON_PURCHASES, this represents a monetary value.","format":"double","maximum":9999999999999,"multipleOf":0.01,"type":"number"}},"required":["conversionType","countingMethod","name","source","sourceType","value"],"type":"object"},"ConversionDefinitionInputV2":{"description":"The conversion definition object.","properties":{"conversionDefinitionId":{"description":"The id of the ConversionDefinition.","readOnly":true,"type":"string"},"conversionType":{"$ref":"#/components/schemas/ConversionDefinitionTypeV2"},"countingMethod":{"$ref":"#/components/schemas/ConversionDefinitionCountingMethodV1"},"createTime":{"description":"The timestamp of when the ConversionDefinition was created in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"lastActivityTime":{"description":"The latest timestamp of when a conversion event for the ConversionDefinition was imported in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"lastUpdatedTime":{"description":"Date and time last edit was made to conversion settings in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"The name of the ConversionDefinition.","maxLength":256,"minLength":1,"type":"string"},"partner":{"description":"The name of the third-party service used to deliver the conversions (if applicable).","maxLength":256,"minLength":1,"type":"string"},"source":{"$ref":"#/components/schemas/ConversionDefinitionSourceV1"},"sourceType":{"$ref":"#/components/schemas/ConversionDefinitionSourceTypeV1"},"value":{"description":"The value of the event.<br>\nWhen the conversionType of the associated Conversion Definition is OFF_AMAZON_PURCHASES, this represents a monetary value.","format":"double","maximum":9999999999999,"multipleOf":0.01,"type":"number"}},"required":["conversionType","countingMethod","name","source","sourceType","value"],"type":"object"},"ConversionDefinitionSourceTypeV1":{"description":"The type of source for the conversion definition. The sourceType must be compatible with the specified source value according to the following mapping:\n* `ANDROID`: Compatible with `SERVER_TO_SERVER`...","enum":["ANDROID","FIRE_TABLET","FIRE_TV","IOS","OFFLINE","WEBSITE"],"type":"string"},"ConversionDefinitionSourceV1":{"description":"The source of the conversion definition. The source must be compatible with the specified sourceType value according to the following mapping:\n* `AMAZON_AD_TAG`: Compatible with `WEBSITE`\n* `SERVER_TO_SERVER`: Compatible with `ANDROID`, `FIRE_TV`, `FIRE_TABLET`, `OFFLINE`, `WEBSITE`, and `IOS`","enum":["AMAZON_AD_TAG","SERVER_TO_SERVER"],"type":"string"},"ConversionDefinitionSuccessResponseV1":{"properties":{"conversionDefinitionId":{"type":"string"},"index":{"description":"The index of the object in the request, starting from 1.","format":"int32","type":"integer"}},"type":"object"},"ConversionDefinitionTypeV1":{"description":"Conversion Types:\n* `ADD_TO_SHOPPING_CART` - When customers add a product to their shopping cart\t\n* `APPLICATION` - When customers submit an application\t\n* `CHECKOUT` - When customers submit an applic...","enum":["ADD_TO_SHOPPING_CART","APPLICATION","CHECKOUT","CONTACT","LEAD","OFF_AMAZON_PURCHASES","OTHER","PAGE_VIEW","SEARCH","SIGN_UP","SUBSCRIBE"],"type":"string"},"ConversionDefinitionTypeV2":{"description":"Conversion Types:\n* `ADD_TO_SHOPPING_CART` - When customers add a product to their shopping cart\t\n* `APPLICATION` - When customers submit an application\t\n* `CHECKOUT` - When customers submit an applic...","enum":["ADD_TO_SHOPPING_CART","APPLICATION","CHECKOUT","CONTACT","LEAD","MOBILE_APP_FIRST_START","OFF_AMAZON_PURCHASES","OTHER","PAGE_VIEW","SEARCH","SIGN_UP","SUBSCRIBE"],"type":"string"},"ConversionDefinitionV1":{"description":"The conversion definition object.","properties":{"conversionDefinitionId":{"description":"The id of the ConversionDefinition.","readOnly":true,"type":"string"},"conversionType":{"$ref":"#/components/schemas/ConversionDefinitionTypeV1"},"countingMethod":{"$ref":"#/components/schemas/ConversionDefinitionCountingMethodV1"},"createTime":{"description":"The timestamp of when the ConversionDefinition was created in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"createdBy":{"$ref":"#/components/schemas/ConversionDefinitionCreatedByV1"},"lastActivityTime":{"description":"The latest timestamp of when a conversion event for the ConversionDefinition was imported in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"lastUpdatedTime":{"description":"Date and time last edit was made to conversion settings in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"The name of the ConversionDefinition.","maxLength":256,"minLength":1,"type":"string"},"source":{"$ref":"#/components/schemas/ConversionDefinitionSourceV1"},"sourceType":{"$ref":"#/components/schemas/ConversionDefinitionSourceTypeV1"},"value":{"description":"The value of the event.<br>\nWhen the conversionType of the associated Conversion Definition is OFF_AMAZON_PURCHASES, this represents a monetary value.","format":"double","maximum":9999999999999,"multipleOf":0.01,"type":"number"}},"required":["conversionType","countingMethod","name","source","sourceType","value"],"type":"object"},"ConversionDefinitionV2":{"description":"The conversion definition object.","properties":{"conversionDefinitionId":{"description":"The id of the ConversionDefinition.","readOnly":true,"type":"string"},"conversionType":{"$ref":"#/components/schemas/ConversionDefinitionTypeV2"},"countingMethod":{"$ref":"#/components/schemas/ConversionDefinitionCountingMethodV1"},"createTime":{"description":"The timestamp of when the ConversionDefinition was created in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"createdBy":{"$ref":"#/components/schemas/ConversionDefinitionCreatedByV1"},"lastActivityTime":{"description":"The latest timestamp of when a conversion event for the ConversionDefinition was imported in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"lastUpdatedTime":{"description":"Date and time last edit was made to conversion settings in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"The name of the ConversionDefinition.","maxLength":256,"minLength":1,"type":"string"},"partner":{"description":"The name of the third-party service used to deliver the conversions (if applicable).","maxLength":256,"minLength":1,"type":"string"},"source":{"$ref":"#/components/schemas/ConversionDefinitionCreatedSourceV1"},"sourceType":{"$ref":"#/components/schemas/ConversionDefinitionSourceTypeV1"},"value":{"description":"The value of the event.<br>\nWhen the conversionType of the associated Conversion Definition is OFF_AMAZON_PURCHASES, this represents a monetary value.","format":"double","maximum":9999999999999,"multipleOf":0.01,"type":"number"}},"required":["conversionType","countingMethod","name","source","sourceType","value"],"type":"object"},"ConversionDefinitionsBatchResponseV1":{"properties":{"error":{"items":{"$ref":"#/components/schemas/ConversionDefinitionErrorResponseV1","properties":{}},"maxItems":10,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/ConversionDefinitionSuccessResponseV1","properties":{}},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"ConversionDeletionRequestErrorResponseV1":{"properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"The index of the object in the request, starting from 1.","format":"int32","type":"integer"},"message":{"description":"A human-readable message of the code.","type":"string"}},"type":"object"},"ConversionDeletionRequestSuccessResponseV1":{"properties":{"index":{"description":"The index of the object in the request, starting from 1.","format":"int32","type":"integer"}},"type":"object"},"ConversionEventDataErrorResponseV1":{"properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"The index of the object in the request, starting from 1.","format":"int32","type":"integer"},"message":{"description":"A human-readable message of the code.","type":"string"}},"type":"object"},"ConversionEventDataSuccessResponseV1":{"properties":{"index":{"description":"The index of the object in the request, starting from 1.","format":"int32","type":"integer"},"message":{"description":"A human-readable message containing further details.","type":"string"}},"type":"object"},"ConversionEventDataV1":{"properties":{"clientDedupeId":{"description":"An identifier chosen by the advertiser to represent a user event. This parameter is used for deduplication across all conversion definitions (events) and all sources (Amazon Ad tag, Conversions API, M...","type":"string"},"conversionDefinitionId":{"description":"The id of the associated ConversionDefinition.","type":"string"},"countryCode":{"description":"The country where the event originates from. e.g. US<br>\nThis value is based on [ISO 3166-1 alpha-2](https://en.wikipedia.","maxLength":2,"minLength":2,"type":"string"},"currencyCode":{"$ref":"#/components/schemas/ConversionDefinitionCurrencyCodeV1"},"dataProcessingOptions":{"description":"A flag for signaling how an event shall be processed. Events marked for limited data use will not be processed.","enum":["LIMITED_DATA_USE"],"type":"string"},"matchKeys":{"description":"Array representing the user and device identifier types/values to be used for attribution to traffic events. Match key value must be normalized and hashed, except for MAID which should not be hashed.","items":{"$ref":"#/components/schemas/ConversionMatchKeyV1"},"maxItems":9,"minItems":1,"type":"array"},"name":{"description":"The name of the imported event.","type":"string"},"timestamp":{"description":"The timestamp when the event occurred in ISO format (YYYY-MM-DDThh:mm:ssTZD). The event's timestamp must be no more than 7 days old at the time of import.","format":"date-time","type":"string"},"unitsSold":{"description":"The number of items purchased. Only applicable for OFF_AMAZON_PURCHASES conversion type. If not provided on the conversion event, a default of 1 will be applied.","format":"int64","maximum":9999999999999,"minimum":1,"type":"integer"},"value":{"description":"The value of the event.<br>\nWhen the conversionType of the associated Conversion Definition is OFF_AMAZON_PURCHASES, this represents a monetary value.","format":"double","maximum":9999999999999.99,"minimum":-9999999999999.99,"multipleOf":0.01,"type":"number"}},"required":["conversionDefinitionId","countryCode","matchKeys","name","timestamp"],"type":"object"},"ConversionMatchKeyTypeV1":{"enum":["ADDRESS","CITY","EMAIL","FIRST_NAME","LAST_NAME","MAID","PHONE","POSTAL","RAMP_ID","STATE"],"type":"string"},"ConversionMatchKeyV1":{"description":"The identifier used to match people for attribution. Match key value must be normalized and hashed, except for MAID which should not be hashed.","properties":{"type":{"$ref":"#/components/schemas/ConversionMatchKeyTypeV1"},"values":{"description":"List of SHA-256 hashed identifier values of the customer who performed the event.","items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"required":["type","values"],"type":"object"},"DeleteMobileMeasurementPartnerAppRegistrationV1":{"properties":{"mmpAppId":{"type":"string"}},"required":["mmpAppId"],"type":"object"},"DspErrorV1":{"description":"The error response object.","properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"A human-readable description of the response.","type":"string"},"requestId":{"description":"A value created by Amazon API Gateway that uniquely identifies your request.","type":"string"}},"type":"object"},"DspSubErrorV1":{"description":"The sub error object.","properties":{"errorType":{"type":"string"},"fieldName":{"type":"string"},"message":{"type":"string"}},"required":["errorType","message"],"type":"object"},"EventDeletionRequestV1":{"description":"All ConversionMatchKey objects for a single user should be grouped into a single EventDeletionRequest list.","properties":{"matchKeys":{"items":{"$ref":"#/components/schemas/ConversionMatchKeyV1"},"maxItems":9,"minItems":1,"type":"array"}},"type":"object"},"GetAdTagResponseV1":{"properties":{"adTag":{"$ref":"#/components/schemas/AmazonAdTagV1"}},"type":"object"},"ListAdTagEventsResponseV1":{"properties":{"amazonAdTagEvents":{"description":"Array of Amazon ad tag events given filters.","items":{"$ref":"#/components/schemas/AmazonAdTagEventV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"maxResults":{"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListConversionDefinitionsRequestV1":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/ConversionDefinitionFilterV1"},"maxItems":10,"minItems":0,"type":"array"},"maxResults":{"default":"10","description":"Sets the maximum number of conversions in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListConversionDefinitionsResponseV1":{"properties":{"conversionDefinitions":{"description":"Array of conversion definitions given filters.","items":{"$ref":"#/components/schemas/ConversionDefinitionV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"maxResults":{"type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"ListConversionDefinitionsResponseV2":{"properties":{"conversionDefinitions":{"description":"Array of conversion definitions given filters.","items":{"$ref":"#/components/schemas/ConversionDefinitionV2","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"maxResults":{"type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"ListMobileMeasurementPartnerAppRegistrationsRequestV1":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/MobileMeasurementPartnerAppRegistrationFilterV1"},"maxItems":10,"minItems":0,"type":"array"},"maxResults":{"default":"10","description":"Sets the maximum number of conversions in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","maximum":100,"minimum":1,"type":"integer"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","type":"string"}},"type":"object"},"ListMobileMeasurementPartnerAppRegistrationsResponseV1":{"properties":{"appRegistrations":{"description":"Array of Mobile Measurement Partner app registrations given filters.","items":{"$ref":"#/components/schemas/MobileMeasurementPartnerAppRegistrationV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"maxResults":{"type":"integer"},"nextToken":{"type":"string"}},"type":"object"},"MobileMeasurementPartnerAppBatchResponseV1":{"properties":{"error":{"items":{"$ref":"#/components/schemas/MobileMeasurementPartnerErrorResponseV1","properties":{}},"maxItems":1,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/MobileMeasurementPartnerSuccessResponseV1","properties":{}},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"MobileMeasurementPartnerAppRegistrationFilterV1":{"properties":{"field":{"enum":["APP_NAME","APP_STORE_ID","MMP_NAME","PLATFORM"],"type":"string"},"values":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["field","values"],"type":"object"},"MobileMeasurementPartnerAppRegistrationV1":{"properties":{"appName":{"description":"The name of the application.","type":"string"},"bundleId":{"description":"The ID of the application with the app store it is registered with. The bundleId + platform + mmpName must be unique within your advertiser account.","type":"string"},"conversionsCreated":{"description":"The number of conversions associated with this mobile application.","readOnly":true,"type":"number"},"lastEventReceived":{"description":"The latest timestamp of when a conversion event for the mobile application was imported in ISO format (YYYY-MM-DDThh:mm:ssTZD).","format":"date-time","readOnly":true,"type":"string"},"mmpAppId":{"description":"The id of the mobile measurement partner app registration.","readOnly":true,"type":"string"},"mmpName":{"$ref":"#/components/schemas/MobileMeasurementPartnerNameV1"},"platform":{"$ref":"#/components/schemas/MobileMeasurementPartnerPlatformV1"}},"required":["appName","bundleId","mmpName","platform"],"type":"object"},"MobileMeasurementPartnerErrorResponseV1":{"properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"errors":{"items":{"$ref":"#/components/schemas/DspSubErrorV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"The index of the object in the request, starting from 1.","format":"int32","type":"integer"},"message":{"description":"A human-readable message of the code.","type":"string"}},"type":"object"},"MobileMeasurementPartnerNameV1":{"enum":["ADJUST","AIRBRIDGE","APPSFLYER","BRANCH","KOCHAVA","SINGULAR","TENJIN"],"type":"string"},"MobileMeasurementPartnerPlatformV1":{"enum":["ANDROID","FIRE_TV"],"type":"string"},"MobileMeasurementPartnerSuccessResponseV1":{"properties":{"index":{"description":"The index of the object in the request, starting from 1.","format":"int32","type":"integer"},"mmpAppId":{"description":"ID of the create mobile measurement partner application registration.","type":"string"}},"type":"object"},"OrderAssociatedConversionDefinitionV1":{"properties":{"id":{"description":"Associated conversion definition identifier for the order.","type":"string"},"isOptimized":{"description":"Denotes whether this conversion definition is optimized for this order.","type":"boolean"}},"type":"object"},"OrderAssociatedConversionDefinitionsResponseV1":{"properties":{"conversionDefinitionIds":{"description":"List of associated ConversionDefinition identifiers for the order.","items":{"properties":{},"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"maxResults":{"type":"string"},"nextToken":{"type":"string"}},"type":"object"},"OrderAssociatedConversionDefinitionsResponseV2":{"properties":{"conversionDefinitions":{"description":"List of associated ConversionDefinitions for the order.","items":{"$ref":"#/components/schemas/OrderAssociatedConversionDefinitionV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"maxResults":{"type":"string"},"nextToken":{"type":"string"}},"type":"object"},"UpdateConversionDefinitionV1":{"properties":{"conversionDefinitionId":{"description":"The identifier of the ConversionDefinition.","type":"string"},"conversionType":{"$ref":"#/components/schemas/ConversionDefinitionTypeV1"},"countingMethod":{"$ref":"#/components/schemas/ConversionDefinitionCountingMethodV1"},"name":{"description":"The name of the ConversionDefinition.","type":"string"},"source":{"$ref":"#/components/schemas/ConversionDefinitionSourceV1"},"sourceType":{"$ref":"#/components/schemas/ConversionDefinitionSourceTypeV1"},"value":{"description":"The default value of each conversion event. Monetary value for OFF_AMAZON_PURCHASES ConversionDefinition type and non-monetary value for all other ConversionDefinition types.","format":"double","type":"number"}},"required":["conversionDefinitionId"],"type":"object"},"UpdateConversionDefinitionV2":{"properties":{"conversionDefinitionId":{"description":"The identifier of the ConversionDefinition.","type":"string"},"conversionType":{"$ref":"#/components/schemas/ConversionDefinitionTypeV2"},"countingMethod":{"$ref":"#/components/schemas/ConversionDefinitionCountingMethodV1"},"name":{"description":"The name of the ConversionDefinition.","type":"string"},"partner":{"description":"The name of the third-party service used to deliver the conversions (if applicable).","type":"string"},"source":{"$ref":"#/components/schemas/ConversionDefinitionSourceV1"},"sourceType":{"$ref":"#/components/schemas/ConversionDefinitionSourceTypeV1"},"value":{"description":"The default value of each conversion event. Monetary value for OFF_AMAZON_PURCHASES ConversionDefinition type and non-monetary value for all other ConversionDefinition types.","format":"double","type":"number"}},"required":["conversionDefinitionId"],"type":"object"},"UpdateMobileMeasurementPartnerAppRegistrationV1":{"properties":{"appName":{"description":"The name of the application.","type":"string"},"bundleId":{"description":"The ID of the application with the app store it is registered with.","type":"string"},"mmpAppId":{"description":"The identifier of the app registration.","type":"string"}},"required":["mmpAppId"],"type":"object"}},"securitySchemes":{}},"info":{"title":"Conversions API","version":"3.0"},"openapi":"3.0.1","paths":{"/accounts/{accountId}/dsp/adTagEvents/{adTagId}/list":{"get":{"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[\"event_manag...","operationId":"dspAmazonAdTagGetEventsByAdTagId","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"},{"$ref":"#/components/parameters/managerAccountId"},{"description":"The identifier of the ad tag.","in":"path","name":"adTagId","required":true,"schema":{"type":"string"}},{"description":"A string used to fuzzy search for event metadata by event name.","in":"query","name":"searchTerm","required":false,"schema":{"type":"string"}},{"description":"A date string to create a time window for events that have seen activity. If not set, a start date 30 days before the request was sent will be chosen. The oldest start date is 1 year before the request was sent to this api.","example":"2022-02-20T23:49:00Z","in":"query","name":"startDateTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Token from a previous request. Use to control pagination of the returned array.","in":"query","name":"nextToken","schema":{"type":"string"}},{"description":"Sets the maximum number of associated conversions in the returned array. Use in conjunction with the `nextToken` parameter to control pagination.","in":"query","name":"maxResults","required":false,"schema":{"default":"10","maximum":100,"minimum":1,"type":"integer"}},{"description":"A date string to create a time window for events that have seen activity. If not set, the day and time the request was sent will be chosen as the end date. The maximum end date is the day the request to this api was sent.","example":"2022-02-25T23:49:00Z","in":"query","name":"endDateTime","required":false,"schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/vnd.dspamazonadtagevents.v1+json":{"schema":{"$ref":"#/components/schemas/ListAdTagEventsResponseV1"}}},"description":"Success."},"400":{"content":{"application/vnd.dspamazonadtagevents.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.dspamazonadtagevents.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspamazonadtagevents.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspamazonadtagevents.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.dspamazonadtagevents.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Gets a list of available event metadata for the given ad tag.","tags":["Amazon Ad Tag"]}},"/accounts/{accountId}/dsp/amazonAdTag":{"get":{"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[\"event_manag...","operationId":"dspAmazonAdTagGetAdTagByAdvertiserId","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"},{"$ref":"#/components/parameters/managerAccountId"}],"responses":{"200":{"content":{"application/vnd.dspamazonadtags.v1+json":{"schema":{"$ref":"#/components/schemas/GetAdTagResponseV1"}}},"description":"Success."},"400":{"content":{"application/vnd.dspamazonadtags.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.dspamazonadtags.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"429":{"content":{"application/vnd.dspamazonadtags.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.dspamazonadtags.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Gets an Amazon Ad Tag for a given advertiser","tags":["Amazon Ad Tag"]}},"/accounts/{accountId}/dsp/batchOrders/conversionDefinitionAssociations":{"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":"dspAmazonBatchGetConversionDefinitionsForOrders","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"}],"requestBody":{"content":{"application/vnd.dspbatchgetconversiondefinitions.v1+json":{"schema":{"$ref":"#/components/schemas/BatchGetConversionDefinitionsAssociatedForOrdersRequestV1"}}},"description":"A list of orderIds to retrieve the associated conversion definitions.","required":true},"responses":{"200":{"content":{"application/vnd.dspbatchgetconversiondefinitions.v1+json":{"schema":{"$ref":"#/components/schemas/BatchGetConversionDefinitionsForOrdersResponseV1"}}},"description":"Success."},"400":{"content":{"application/vnd.dspbatchgetconversiondefinitions.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.dspbatchgetconversiondefinitions.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspbatchgetconversiondefinitions.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspbatchgetconversiondefinitions.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.dspbatchgetconversiondefinitions.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Retrieve associated conversion definitions for orders.","tags":["Conversion Order Association"]}},"/accounts/{accountId}/dsp/conversionDefinitions":{"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[\"event_manager_edit\"]","operationId":"dspAmazonCreateConversionDefinitions","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"}],"requestBody":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/BatchCreateConversionDefinitionsRequestV1"}},"application/vnd.dspconversiondefinition.v2+json":{"schema":{"$ref":"#/components/schemas/BatchCreateConversionDefinitionsRequestV2"}}}},"responses":{"207":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/ConversionDefinitionsBatchResponseV1"}}},"description":"Multi-status."},"401":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."}},"summary":"Batch create conversion definitions.","tags":["Amazon Conversion Definitions"]},"put":{"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[\"event_manager_edit\"]","operationId":"dspAmazonUpdateConversionDefinitions","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"}],"requestBody":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/BatchUpdateConversionDefinitionsRequestV1"}},"application/vnd.dspconversiondefinition.v2+json":{"schema":{"$ref":"#/components/schemas/BatchUpdateConversionDefinitionsRequestV2"}}}},"responses":{"207":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/ConversionDefinitionsBatchResponseV1"}}},"description":"Multi-status."},"401":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."}},"summary":"Batch update conversion definitions.","tags":["Amazon Conversion Definitions"]}},"/accounts/{accountId}/dsp/conversionDefinitions/delete":{"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[\"event_manager_edit\"]","operationId":"dspAmazonDeletionRequest","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"}],"requestBody":{"content":{"application/vnd.dspuserdeletionrequest.v1+json":{"schema":{"$ref":"#/components/schemas/BatchDeleteUserEventsRequestV1"}}},"required":true},"responses":{"207":{"content":{"application/vnd.dspuserdeletionrequest.v1+json":{"schema":{"$ref":"#/components/schemas/BatchDeleteUserEventsResponseV1"}}},"description":"Accepted."},"401":{"content":{"application/vnd.dspuserdeletionrequest.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspuserdeletionrequest.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspuserdeletionrequest.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."}},"summary":"Deletes existing event data associated with user(s). Supply all match keys associated with the user. Events processed before the deletion request will be deleted from our advertising systems. However, any events for these users sent after the deletion request will not be deleted. Therefore you must stop sending events for opted-out users after the deletion request is made in order to effectuate the opt-out.","tags":["Data Deletion Requests"]}},"/accounts/{accountId}/dsp/conversionDefinitions/eventData":{"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[\"event_manager_edit\"]","operationId":"dspAmazonIngestConversionData","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"}],"requestBody":{"content":{"application/vnd.dspconversioneventimport.v1+json":{"schema":{"$ref":"#/components/schemas/BatchImportConversionEventDataRequestV1"}}},"required":true},"responses":{"207":{"content":{"application/vnd.dspconversioneventimport.v1+json":{"schema":{"$ref":"#/components/schemas/BatchImportConversionEventDataResponseV1"}}},"description":"Multi-status."},"401":{"content":{"application/vnd.dspconversioneventimport.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspconversioneventimport.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspconversioneventimport.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."}},"summary":"Import conversion event data. This API expects one source per request across all conversion event data and supports partial import. Only conversion event data with matching conversion source will be imported, the rest will be rejected.","tags":["Conversion Event Data"]}},"/accounts/{accountId}/dsp/conversionDefinitions/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[\"event_manager_view\"]","operationId":"dspAmazonListConversionDefinitions","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"}],"requestBody":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/ListConversionDefinitionsRequestV1"}}},"description":"Filters to apply when retrieving conversion definitions.","required":true},"responses":{"200":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/ListConversionDefinitionsResponseV1"}},"application/vnd.dspconversiondefinition.v2+json":{"schema":{"$ref":"#/components/schemas/ListConversionDefinitionsResponseV2"}}},"description":"Success."},"400":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.dspconversiondefinition.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Retrieve a list of conversion definitions based on filters.","tags":["Amazon Conversion Definitions"]}},"/accounts/{accountId}/dsp/conversionDefinitions/{conversionDefinitionId}/adTagEventAssociations":{"get":{"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[\"event_manager_view\"]","operationId":"dspAmazonGetAdTagAssociatedEvent","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"},{"description":"The identifier of the ConversionDefinition.","in":"path","name":"conversionDefinitionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/ConversionDefinitionAssociatedAdTagEventV1"}}},"description":"Success."},"400":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Retrieve associated Amazon adTag event for a ConversionDefinition.","tags":["Conversion Ad Tag Association"]},"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[\"event_manager_edit\"]","operationId":"dspAmazonUpdateAdTagAssociatedEvent","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"},{"description":"The identifier of the ConversionDefinition.","in":"path","name":"conversionDefinitionId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/ConversionDefinitionAdTagEventAssociationRequestV1"}}}},"responses":{"200":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/ConversionDefinitionAssociatedAdTagEventV1"}}},"description":"Success."},"400":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Associate/Dissociate an Amazon adTag event to a ConversionDefinition.","tags":["Conversion Ad Tag Association"]}},"/accounts/{accountId}/dsp/conversionDefinitions/{conversionDefinitionId}/mobileMeasurementPartnerAppRegistration":{"get":{"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[\"event_manager_view\"]","operationId":"dspAmazonGetAssociatedMobileAppForConversionDefinition","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"},{"description":"The identifier of the ConversionDefinition.","in":"path","name":"conversionDefinitionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.dspassociatedmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/AssociatedMobileMeasurementPartnerAppRegistrationV1"}}},"description":"Success."},"400":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.dspconversionadtageventassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Retrieve associated Mobile Measurement Partner App for a ConversionDefinition.","tags":["Apps"]}},"/accounts/{accountId}/dsp/mobileMeasurementPartners":{"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[\"event_manager_edit\"]","operationId":"dspAmazonBatchCreateMobileMeasurementPartnerAppRegistration","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"}],"requestBody":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/BatchCreateMobileMeasurementPartnerAppRegistrationRequestV1"}}},"required":true},"responses":{"207":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/MobileMeasurementPartnerAppBatchResponseV1"}}},"description":"Multi-status."},"401":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."}},"summary":"Create a new Mobile Measurement Partner app registration.","tags":["Apps"]},"put":{"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[\"event_manager_edit\"]","operationId":"dspAmazonBatchUpdateMobileMeasurementPartnerAppRegistration","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"}],"requestBody":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/BatchUpdateMobileMeasurementPartnerAppRegistrationRequestV1"}}},"required":true},"responses":{"207":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/MobileMeasurementPartnerAppBatchResponseV1"}}},"description":"Multi-status."},"401":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."}},"summary":"Update a Mobile Measurement Partner app registration. Updates may sever the data connection between the Mobile Measurement Partner and Amazon.","tags":["Apps"]}},"/accounts/{accountId}/dsp/mobileMeasurementPartners/delete":{"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[\"event_manager_edit\"]","operationId":"dspAmazonDeleteMeasurementPartnerAppRegistrations","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"}],"requestBody":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/BatchDeleteMobileMeasurementPartnerAppRegistrationRequestV1"}}},"required":true},"responses":{"200":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/MobileMeasurementPartnerAppBatchResponseV1"}}},"description":"Success."},"401":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."}},"summary":"Marks a Mobile Measurement Partner app registration as deleted. Deleted Mobile Measurement Partner app registrations will sever the data connection between the Mobile Measurement Partner and Amazon.","tags":["Apps"]}},"/accounts/{accountId}/dsp/mobileMeasurementPartners/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[\"event_manager_view\"]","operationId":"dspAmazonListMobileMeasurementPartnerAppRegistrations","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"}],"requestBody":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/ListMobileMeasurementPartnerAppRegistrationsRequestV1"}}},"required":true},"responses":{"200":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/ListMobileMeasurementPartnerAppRegistrationsResponseV1"}}},"description":"Success."},"401":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dspmobilemeasurementpartnerappregistration.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."}},"summary":"List Mobile Measurement Partner App Registrations","tags":["Apps"]}},"/accounts/{accountId}/dsp/orders/{orderId}/conversionDefinitionAssociations":{"get":{"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":"dspAmazonGetAssociatedConversionDefinitionsForOrder","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"},{"description":"The identifier of the order.","in":"path","name":"orderId","required":true,"schema":{"type":"string"}},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of associated conversions in the returned array. Use in conjunction with the `nextToken` parameter to control pagination.","in":"query","name":"maxResults","required":false,"schema":{"default":"10","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.dsporderconversionassociation.v1+json":{"schema":{"$ref":"#/components/schemas/OrderAssociatedConversionDefinitionsResponseV1"}},"application/vnd.dsporderconversionassociation.v2+json":{"schema":{"$ref":"#/components/schemas/OrderAssociatedConversionDefinitionsResponseV2"}}},"description":"Success."},"400":{"content":{"application/vnd.dsporderconversionassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Bad Request."},"401":{"content":{"application/vnd.dsporderconversionassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dsporderconversionassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dsporderconversionassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"500":{"content":{"application/vnd.dsporderconversionassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Retrieve associated conversion definitions for an order.","tags":["Conversion Order Association"]},"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_edit\"]","operationId":"dspAmazonUpdateAssociatedConversionDefinitionsForOrder","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/accountId"},{"$ref":"#/components/parameters/dspAccountId"},{"description":"The identifier of the order.","in":"path","name":"orderId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.dsporderconversionassociation.v1+json":{"schema":{"$ref":"#/components/schemas/BatchAssociateConversionDefinitionsRequestV1"}},"application/vnd.dsporderconversionassociation.v2+json":{"schema":{"$ref":"#/components/schemas/BatchAssociateConversionDefinitionsRequestV2"}}}},"responses":{"207":{"content":{"application/vnd.dsporderconversionassociation.v1+json":{"schema":{"$ref":"#/components/schemas/BatchAssociateConversionDefinitionsResponseV1"}}},"description":"Success."},"401":{"content":{"application/vnd.dsporderconversionassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.dsporderconversionassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"429":{"content":{"application/vnd.dsporderconversionassociation.v1+json":{"schema":{"$ref":"#/components/schemas/DspErrorV1"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."}},"summary":"Associate/Dissociate conversion definitions to an order.","tags":["Conversion Order Association"]}}}}