{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"Action":{"enum":["CREATE","DELETE"],"type":"string"},"AdsCdxBadRequestExceptionResponseContent":{"description":"Bad Request.","properties":{"code":{"description":"HTTP status code of the error encountered.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"},"errors":{"description":"List of detailed errors, if any.","items":{"$ref":"#/components/schemas/DetailedError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Error message.","type":"string"}},"type":"object"},"AdsCdxForbiddenRequestExceptionResponseContent":{"description":"Forbidden. The request failed because the user does not have access to the specified resource.","properties":{"code":{"description":"HTTP status code of the error encountered.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"},"errors":{"description":"List of detailed errors, if any.","items":{"$ref":"#/components/schemas/DetailedError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Error message.","type":"string"}},"type":"object"},"AdsCdxResourceNotFoundExceptionResponseContent":{"description":"Not Found. The requested resource does not exist or is not visible for the user.","properties":{"code":{"description":"HTTP status code of the error encountered.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"},"errors":{"description":"List of detailed errors, if any.","items":{"$ref":"#/components/schemas/DetailedError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Error message.","type":"string"}},"type":"object"},"AdsCdxServerExceptionResponseContent":{"description":"Internal server error. Retry later. Contact support if this response persists.","properties":{"code":{"description":"HTTP status code of the error encountered.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"},"errors":{"description":"List of detailed errors, if any.","items":{"$ref":"#/components/schemas/DetailedError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"type":"string"}},"type":"object"},"AdsCdxServerUnavailableExceptionResponseContent":{"description":"Error information.","properties":{"code":{"description":"HTTP status code of the error encountered.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"},"errors":{"description":"List of detailed errors, if any.","items":{"$ref":"#/components/schemas/DetailedError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"type":"string"}},"type":"object"},"AdsCdxSolCreateAudienceRequestContent":{"description":"Create Audience DataSet Request.","properties":{"countryCode":{"$ref":"#/components/schemas/CountryCode"},"description":{"description":"A description of the DataSet.","maxLength":1000,"minLength":1,"type":"string"},"idRetention":{"description":"Determines retention of hashed data for 90 days and refresh of UID tokens.","type":"boolean"},"name":{"description":"The name of the DataSet.","maxLength":100,"minLength":5,"pattern":"^[A-Za-z][A-Za-z0-9_-]{0,99}$","type":"string"}},"required":["countryCode","name"],"type":"object"},"AdsCdxSolCreateAudienceResponseContent":{"description":"Create Audience DataSet Response.","properties":{"clientName":{"description":"Identification of the source that created the DataSet.","type":"string"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"createdBy":{"description":"Identifier of the user who created the DataSet.","type":"string"},"dataSetId":{"type":"string"},"dataSetType":{"$ref":"#/components/schemas/SchemaType"},"dateCreated":{"description":"The Date Time that the DataSet was created.","format":"date-time","type":"string"},"description":{"description":"A description of the DataSet.","maxLength":1000,"minLength":1,"type":"string"},"idRetention":{"description":"Determines retention of hashed data for 90 days and refresh of UID tokens.","type":"boolean"},"lastModified":{"description":"The Date time the DataSet was last modified","format":"date-time","type":"string"},"lastModifiedBy":{"description":"Identifier of the user who most recently modified the DataSet.","type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata"},"name":{"description":"The name of the DataSet.","maxLength":100,"minLength":5,"pattern":"^[A-Za-z][A-Za-z0-9_-]{0,99}$","type":"string"},"partitionedBy":{"$ref":"#/components/schemas/PartitionedByEnum"},"schema":{"description":"The list of columns that make up the DataSet Schema.","items":{"$ref":"#/components/schemas/DataSetColumn"},"maxItems":100,"minItems":0,"type":"array"}},"required":["clientName","countryCode","createdBy","dataSetType","dateCreated","lastModified","lastModifiedBy","name","schema"],"type":"object"},"AdsCdxSolDuplicateDatasetNameExceptionResponseContent":{"description":"Dataset with this name already exists.","properties":{"code":{"description":"HTTP status code of the error encountered.","type":"string"},"datasetId":{"type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"},"errors":{"description":"List of detailed errors, if any.","items":{"$ref":"#/components/schemas/DetailedError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"type":"string"}},"type":"object"},"AdsCdxSolGetAudienceResponseContent":{"description":"Get Audience DataSet Response.","properties":{"clientName":{"description":"Identification of the source that created the DataSet.","type":"string"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"createdBy":{"description":"Identifier of the user who created the DataSet.","type":"string"},"dataSetId":{"type":"string"},"dataSetType":{"$ref":"#/components/schemas/SchemaType"},"dateCreated":{"description":"The Date Time that the DataSet was created.","format":"date-time","type":"string"},"description":{"description":"A description of the DataSet.","maxLength":1000,"minLength":1,"type":"string"},"idRetention":{"description":"Determines retention of hashed data for 90 days and refresh of UID tokens.","type":"boolean"},"lastModified":{"description":"The Date time the DataSet was last modified","format":"date-time","type":"string"},"lastModifiedBy":{"description":"Identifier of the user who most recently modified the DataSet.","type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata"},"name":{"description":"The name of the DataSet.","maxLength":100,"minLength":5,"pattern":"^[A-Za-z][A-Za-z0-9_-]{0,99}$","type":"string"},"partitionedBy":{"$ref":"#/components/schemas/PartitionedByEnum"},"schema":{"description":"The list of columns that make up the DataSet Schema.","items":{"$ref":"#/components/schemas/DataSetColumn"},"maxItems":100,"minItems":0,"type":"array"}},"required":["clientName","countryCode","createdBy","dataSetType","dateCreated","lastModified","lastModifiedBy","name","schema"],"type":"object"},"AdsCdxSolGetTermsResponseContent":{"description":"Get Terms Response","properties":{"agreementContent":{"description":"The Terms and Conditions agreement content.","type":"string"},"agreementToken":{"description":"The terms and conditions agreement token. Required to accept an agreement.","type":"string"},"hasAccepted":{"description":"Flag indicating whether the customer has accepted the Ads Data Manager Terms and Conditions.","type":"boolean"}},"required":["hasAccepted"],"type":"object"},"AdsCdxSolListAudienceResponseContent":{"description":"List Audience DataSet Response.","properties":{"dataSets":{"items":{"$ref":"#/components/schemas/CdxDataSetWithoutSchema"},"type":"array"},"nextToken":{"description":"Token to receive next page of results.","type":"string"}},"type":"object"},"AdsCdxSolSetTermsAcceptanceRequestContent":{"description":"Set Terms request.","properties":{"agreementToken":{"description":"The terms and conditions agreement token.","type":"string"},"hasAccepted":{"description":"Flag indicating whether the Customer has accepted the Ads Data Manager Terms and conditions.","type":"boolean"}},"required":["agreementToken","hasAccepted"],"type":"object"},"AdsCdxTooManyRequestsExceptionResponseContent":{"description":"Too Many Requests. The request was rate-limited. Retry later.","properties":{"code":{"description":"HTTP status code of the error encountered.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"},"errors":{"description":"List of detailed errors, if any.","items":{"$ref":"#/components/schemas/DetailedError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Error message.","type":"string"}},"type":"object"},"AdsCdxUnauthorizedRequestExceptionResponseContent":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","properties":{"code":{"description":"HTTP status code of the error encountered.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"},"errors":{"description":"List of detailed errors, if any.","items":{"$ref":"#/components/schemas/DetailedError"},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"Error message.","type":"string"}},"type":"object"},"AmcMetadata":{"properties":{"amcInstanceId":{"type":"string"},"amcInstanceName":{"type":"string"}},"required":["amcInstanceId"],"type":"object"},"AmznConsent":{"properties":{"amznAdStorage":{"$ref":"#/components/schemas/ConsentEnums"},"amznUserData":{"$ref":"#/components/schemas/ConsentEnums"}},"type":"object"},"ApplicationId":{"description":"Unique identifier for applications integrating with Ads Data Manager.","enum":["AMAZON_MARKETING_CLOUD","AUDIENCE_HUB","DSP_AUDIENCES","EVENTS_MANAGER","GEO_LOCATIONS","PG_DEALS"],"type":"string"},"AudienceFees":{"description":"Audience fee — CPM in cents plus ISO 4217 currency code.\nSent to DP under the `audienceFees` metadata field for `AUDIENCE_DATA_STORE`.\n\nNote: `currency` is typed as the shared [CurrencyCode] enum from `AdsCdxCommonModel`\n(all ISO 4217 codes), even though DP\u0027s `AUDIENCE_DATA_STORE` today only accepts a\n13-currency subset. Runtime validation against the DP-supported set happens when we\ncall the DP client (`DpAudienceMetadataAudienceFeesItems.CurrencyEnum.fromValue(...)`);\ninvalid values surface as a 400 with the offending code in the message.","properties":{"cpmCents":{"description":"CPM in cents.","type":"number"},"currency":{"$ref":"#/components/schemas/CurrencyCode"}},"required":["cpmCents","currency"],"type":"object"},"AudienceHubMetadata":{"description":"A structure to represent the metadata required to create an Audience Hub audience.\n\nAudience Hub audiences are syndicated to Amazon DSP via the DP API using\n`type\u003dAUDIENCE_DATA_STORE`. All fields align with the DP API\u0027s contract for the\nADS (Audience Data Store) framework, per the ADS External Onboarding Guide:\nhttps://w.amazon.com/bin/view/Advertising/Data-Onboarding/AudienceDatastore/ExternalOnboardingGuide\n\n`dataProviderId`, `dataProviderName`, and `taxonomy` are provided by the DMP once\nthey complete DP-side ADS onboarding. They must be sent on every sharing rule\ncreation and must remain consistent across all audiences under the same\ndata-provider identity for DP-side permission-group accounting.","properties":{"audienceFees":{"$ref":"#/components/schemas/AudienceFees"},"audienceName":{"description":"The name of the audience.","maxLength":127,"minLength":10,"type":"string"},"dataProviderId":{"description":"Unique identifier for the data provider that owns this audience.\nThe DMP receives this value from Amazon during their ADS onboarding process.\nMust be consistent across all audiences under the same data-provider identity.\nPer DP guide regex: [-_0-9a-zA-Z]{5,50}","type":"string"},"dataProviderName":{"description":"The name of the data provider that owns this audience (e.g., \"Attain\", \"Comscore\").\nSet by the DMP during ADS onboarding, must be consistent across all their ADS audiences.\nPer DP guide regex: [-_0-9a-zA-Z]{5,50}","type":"string"},"description":{"description":"Optional description of the audience.","type":"string"},"externalAudienceId":{"description":"External audience ID assigned by the DMP.\nPer DP guide regex: [-_0-9a-zA-Z]{5,50}","type":"string"},"taxonomy":{"description":"Taxonomy path(s) for the audience.\nEach entry uses \"\u003e\" as separator (e.g., \"IRI \u003e IRI ProScores CPG Audiences\").\nAn audience can have multiple taxonomy paths.","items":{"type":"string"},"type":"array"}},"required":["audienceFees","audienceName","dataProviderId","dataProviderName","externalAudienceId","taxonomy"],"type":"object"},"AudienceHubResponseMetadata":{"description":"Response metadata for an Audience Hub audience, returned by `GetSharingRule`\nand `ListSharingRules`.","properties":{"audienceId":{"type":"string"},"audienceName":{"type":"string"},"dataProviderId":{"type":"string"},"dataProviderName":{"type":"string"},"externalAudienceId":{"type":"string"},"taxonomy":{"items":{"type":"string"},"type":"array"}},"required":["audienceId","audienceName","dataProviderId","dataProviderName","externalAudienceId","taxonomy"],"type":"object"},"AudienceMember":{"properties":{"action":{"$ref":"#/components/schemas/Action"},"externalUserId":{"description":"This is an external user identifier defined by the data owner. Each unique user should have a unique external user identifier.","type":"string"},"userConsent":{"$ref":"#/components/schemas/UserConsent"},"userIdentity":{"$ref":"#/components/schemas/Identity"}},"required":["action","externalUserId","userIdentity"],"type":"object"},"AudienceMetadata":{"description":"A structure to represent the metadata required to create a DSP Audience.","properties":{"audienceName":{"maxLength":127,"minLength":10,"type":"string"},"description":{"type":"string"},"externalAudienceId":{"type":"string"}},"required":["audienceName"],"type":"object"},"AudienceResponseMetadata":{"description":"A structure that represents the audience-specific metadata provided to API consumers.","properties":{"audienceId":{"type":"string"},"audienceIdV2":{"type":"string"},"audienceName":{"type":"string"}},"required":["audienceId","audienceIdV2","audienceName"],"type":"object"},"AwsRegion":{"description":"Available AWS regions","enum":["eu-west-1","us-east-1","us-west-2"],"type":"string"},"CdxDataSetWithoutSchema":{"properties":{"clientName":{"description":"Identification of the source that created the DataSet.","type":"string"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"createdBy":{"description":"Identifier of the user who created the DataSet.","type":"string"},"dataSetId":{"description":"Unique identifier that represent the DataSet.","type":"string"},"dataSetType":{"$ref":"#/components/schemas/SchemaType"},"dateCreated":{"description":"The Date Time that the DataSet was created.","format":"date-time","type":"string"},"description":{"description":"A description of the DataSet.","maxLength":1000,"minLength":1,"type":"string"},"idRetention":{"description":"Determines retention of hashed data for 90 days and refresh of UID tokens.","type":"boolean"},"lastModified":{"description":"The Date time the DataSet was last modified","format":"date-time","type":"string"},"lastModifiedBy":{"description":"Identifier of the user who most recently modified the DataSet.","type":"string"},"name":{"description":"The name of the DataSet.","maxLength":100,"minLength":5,"pattern":"^[A-Za-z][A-Za-z0-9_-]{0,99}$","type":"string"}},"required":["clientName","countryCode","createdBy","dataSetId","dataSetType","dateCreated","lastModified","lastModifiedBy","name"],"type":"object"},"ColumnType":{"enum":["DIMENSION","METRIC"],"type":"string"},"Consent":{"properties":{"amzn":{"$ref":"#/components/schemas/AmznConsent"},"gpp":{"description":"A field to hold a \u0027Global Privacy Platform (GPP)\u0027 string. Optional.","type":"string"},"tcf":{"description":"A field to hold the \u0027Transparency and Consent Framework (TCF)\u0027 string. Optional.","type":"string"}},"type":"object"},"ConsentEnums":{"enum":["DENIED","GRANTED","NOT_APPLICABLE","UNKNOWN"],"type":"string"},"ConversionDefinitionCountingMethodV1":{"enum":["EVERY","FIRST"],"type":"string"},"ConversionDefinitionMetadata":{"description":"Base metadata related to a Conversion Definition, typically used in CD creation requests.","properties":{"conversionType":{"$ref":"#/components/schemas/ConversionDefinitionTypeV1"},"countingMethod":{"$ref":"#/components/schemas/ConversionDefinitionCountingMethodV1"},"name":{"type":"string"},"partner":{"type":"string"},"source":{"$ref":"#/components/schemas/ConversionDefinitionSourceV1"},"sourceType":{"$ref":"#/components/schemas/ConversionDefinitionSourceTypeV1"},"value":{"format":"double","type":"number"}},"required":["conversionType","countingMethod","name","source","sourceType","value"],"type":"object"},"ConversionDefinitionResponseMetadata":{"description":"Metadata for an Conversion Definition response i.e., including a CD id and fields.","properties":{"conversionDefinitionId":{"type":"string"},"conversionDefinitionName":{"type":"string"},"conversionType":{"$ref":"#/components/schemas/ConversionDefinitionTypeV1"},"countingMethod":{"$ref":"#/components/schemas/ConversionDefinitionCountingMethodV1"},"name":{"type":"string"},"partner":{"type":"string"},"source":{"$ref":"#/components/schemas/ConversionDefinitionSourceV1"},"sourceType":{"$ref":"#/components/schemas/ConversionDefinitionSourceTypeV1"},"value":{"format":"double","type":"number"}},"required":["conversionDefinitionId","conversionDefinitionName","conversionType","countingMethod","name","source","sourceType","value"],"type":"object"},"ConversionDefinitionSourceTypeV1":{"enum":["ANDROID","FIRE_TABLET","FIRE_TV","IOS","OFFLINE","WEBSITE"],"type":"string"},"ConversionDefinitionSourceV1":{"enum":["AMAZON_AD_TAG","MMP","SERVER_TO_SERVER"],"type":"string"},"ConversionDefinitionTypeV1":{"enum":["ADD_TO_SHOPPING_CART","APPLICATION","CHECKOUT","CONTACT","LEAD","OFF_AMAZON_PURCHASES","OTHER","PAGE_VIEW","SEARCH","SIGN_UP","SUBSCRIBE"],"type":"string"},"CountryCode":{"description":"Country Code. Two letter ISO 3166-1 alpha-2","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","UNKNOWN","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW","ZZ"],"type":"string"},"CreateDataroomResponseContent":{"properties":{"accountId":{"description":"The owner of this Data room","type":"string"},"assignedToAccountId":{"description":"The Ads AccountId to which this dataroom is assigned to","type":"string"},"creationDateTime":{"description":"An ISO UTC Timestamp value representing the time the dataroom was created","format":"date-time","type":"string"},"region":{"$ref":"#/components/schemas/AwsRegion"}},"required":["accountId","creationDateTime"],"type":"object"},"CreateSharingRuleRequestContent":{"description":"The input parameters to create a Sharing Rule.","properties":{"accountEntityId":{"description":"The account (e.g., DSP Advertiser Account) entityId. This is different from \u0027destinationEntityId\u0027.\nThis is also known as \"parent entity id\".","type":"string"},"application":{"$ref":"#/components/schemas/ApplicationId"},"dataSetId":{"description":"Data set which is being shared via the sharing rule.\nThe minimum length of the datasetId is 1 to ensure that it\u0027s not an empty string","minLength":1,"type":"string"},"destinationAccountId":{"description":"Account to which data is shared.","type":"string"},"marketplaceId":{"description":"Marketplace to which data is shared.","type":"string"},"metadata":{"$ref":"#/components/schemas/SharingRuleMetadata"}},"required":["application","dataSetId","destinationAccountId","marketplaceId","metadata"],"type":"object"},"CreateSharingRuleResponseContent":{"description":"Output of a create sharing rule request, decoupled from sharing rule model.","properties":{"accountEntityId":{"description":"The account (e.g., DSP Advertiser Account) entityId. This is different from \u0027destinationEntityId\u0027.\nThis is also known as \"parent entity id\".","type":"string"},"activationTime":{"description":"The timestamp when the sharing rule was activated.","format":"date-time","type":"string"},"application":{"$ref":"#/components/schemas/ApplicationId"},"creationTime":{"description":"Timestamp for time of creation in UTC.","format":"date-time","type":"string"},"dataSetId":{"description":"Data set which is being shared via the sharing rule.\nThe minimum length of the datasetId is 1 to ensure that it\u0027s not an empty string","minLength":1,"type":"string"},"dataSetName":{"description":"The name of the DataSet part of this sharing rule.","type":"string"},"destinationAccountId":{"description":"Account to which data is shared.","type":"string"},"destinationEntityName":{"description":"The display name of the destination entity.","type":"string"},"marketplaceId":{"description":"Marketplace to which data is shared.","type":"string"},"metadata":{"$ref":"#/components/schemas/SharingRuleResponseMetadata"},"revokedBy":{"description":"The reason a rule was revoked, or NONE if rule is not revoked.","type":"string"},"revokedTime":{"description":"The timestamp when the sharing rule was revoked.","format":"date-time","type":"string"},"sharingRuleId":{"description":"Unique ID for a sharing rule.","maxLength":100,"minLength":1,"pattern":"^[0-9A-Za-z_-]{1,100}$","type":"string"},"status":{"$ref":"#/components/schemas/SharingRuleStatus"}},"required":["application","creationTime","dataSetId","destinationAccountId","marketplaceId","sharingRuleId","status"],"type":"object"},"Currency":{"description":"ISO 4217 currency codes. Mirrors PubTech\u0027s TaxonomyFeeCurrency.","enum":["AED","AFN","ALL","AMD","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UYW","UZS","VED","VES","VND","VUV","WST","YER","ZAR","ZMW","ZWG"],"type":"string"},"CurrencyCode":{"description":"The currency code. Three letter ISO-4217 code.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"DataSetColumn":{"properties":{"columnType":{"$ref":"#/components/schemas/ColumnType"},"dataType":{"$ref":"#/components/schemas/DataTypeEnum"},"description":{"description":"The description of the column.","maxLength":255,"minLength":1,"type":"string"},"isRequired":{"description":"Boolean to determine if the column is required or not.","type":"boolean"},"name":{"description":"The name of the column.","maxLength":255,"minLength":1,"type":"string"},"requiresOneWayHashing":{"description":"Indicates whether the data in the column should be one-way hashed.","type":"boolean"}},"required":["dataType","name"],"type":"object"},"DataSetType":{"description":"Type of a DataSet.","enum":["AUDIENCE","CUSTOM","EVENT","GEO_LOCATIONS"],"type":"string"},"DataTypeEnum":{"description":"enum used to verify the different datatypes supported in ADM","enum":["ACTION","AMZN_AD_STORAGE","AMZN_USER_DATA","ARRAY","CONVERSION_TYPE","COUNTING_METHOD","COUNTRY_CODE","CURRENCY_CODE","DATE","DECIMAL","DEDUPE_ID","EVENT_COUNT","EVENT_NAME","EVENT_SOURCE","EVENT_VALUE","EXPERIAN_ID","EXTERNAL_ID","GPP","HASHED_ADDRESS","HASHED_CITY","HASHED_COUNTRY_CODE","HASHED_EMAIL_ADDRESS","HASHED_FIRST_NAME","HASHED_LAST_NAME","HASHED_PHONE_NUMBER","HASHED_STATE","HASHED_ZIP_CODE","INTEGER","IP_ADDRESS","KANTAR_ID","LAST_ACTIVITY","LONG","MAID","MAIN_EVENT_TIME","MERKLE_ID","MERKURY_ID","NEUSTAR_ID","RAMP_ID","REAL_ID","SAMBA_TV_ID","STRING","TCF","TIMESTAMP","TRANSUNION_ID","UNITS_SOLD"],"type":"string"},"DatasetMetadata":{"properties":{"actions":{"description":"The list of actions available for the dataset","items":{"description":"An action available for the dataset","type":"string"},"maxItems":10,"minItems":0,"type":"array"},"activeDestinations":{"description":"The active destinations for the dataset","type":"number"},"countryCode":{"description":"Default Country Code to fall back to for the records in this Dataset. Country Code should be represented in ISO 3166-1 alpha-2 format.","type":"string"},"createdAt":{"description":"The timestamp when the dataset was created","format":"date-time","type":"string"},"datasetId":{"description":"Id of a DataSet.","type":"string"},"description":{"description":"Description of the dataset","type":"string"},"externalReferenceId":{"description":"An internal Id generated from external source","type":"string"},"externalReferenceType":{"$ref":"#/components/schemas/ExternalReferenceType"},"idRetention":{"description":"Determines retention of hashed data for 90 days and refresh of UID tokens.","type":"boolean"},"lastModified":{"description":"The Date time the DataSet was last modified","format":"date-time","type":"string"},"lastModifiedBy":{"description":"Identifier of the user who most recently modified the DataSet.","type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata"},"name":{"description":"The name of the dataset","type":"string"},"records":{"description":"The number of records in the dataset","type":"number"},"schema":{"description":"The schema of the dataset","type":"string"},"source":{"$ref":"#/components/schemas/DatasetUploadSourceType"},"ttl":{"description":"Time-to-live in seconds. The amount of time the record is associated with the DataSet. Max is 12.5 months.","maximum":32850000,"minimum":0,"type":"number"},"updatedAt":{"description":"The timestamp when the dataset was last updated","format":"date-time","type":"string"}},"required":["actions","activeDestinations","countryCode","createdAt","datasetId","lastModified","lastModifiedBy","name","records","schema","source","updatedAt"],"type":"object"},"DatasetMetric":{"description":"The types of metrics that can be aggregated for a dataset","enum":["CONSENTED","RECEIVED","RESOLVED","VALID"],"type":"string"},"DatasetMetricsValues":{"additionalProperties":{"format":"float","type":"number"},"type":"object"},"DatasetTimeSeries":{"additionalProperties":{"$ref":"#/components/schemas/DatasetMetricsValues"},"description":"A time series of dataset metrics, keyed by timestamp","type":"object"},"DatasetUploadSourceType":{"description":"The possible sources from which a dataset can be uploaded.","enum":["API","S3","UI"],"type":"string"},"DeleteIdentityRequestContent":{"description":"The DeleteIdentityRequest represents a request to delete one or more user identities.\nIt includes a list of target identities to be deleted, along with common headers.","properties":{"targetIdentities":{"description":"A list of identities to be deleted from manager account id.\nEach identity is either a single supported ExternalUserId or a collection of externalIdentities , maid or Hashed PII values representing a single user.","items":{"$ref":"#/components/schemas/TargetIdentity"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["targetIdentities"],"type":"object"},"DetailedError":{"description":"Detailed individual error information.","properties":{"errorCode":{"type":"number"},"errorMessage":{"type":"string"},"errorType":{"type":"string"}},"type":"object"},"ExternalIdentity":{"description":"Support for externalIdentity is planned for the future.","format":"password","properties":{"experianId":{"description":"User identifier provided by Experian","format":"password","type":"string"},"kantarId":{"description":"User identifier provided by Kantar","format":"password","type":"string"},"liveRampId":{"description":"User identifier provided by LiveRamp","format":"password","type":"string"},"maId":{"description":"Mobile advertising identifier (IDFA for iOS or GAID for Android)","format":"password","type":"string"},"merkleId":{"description":"User identifier provided by Merkle","format":"password","type":"string"},"merkuryId":{"description":"User identifier provided by Merkle Merkury","format":"password","type":"string"},"neustarId":{"description":"User identifier provided by Neustar","format":"password","type":"string"},"realId":{"description":"User identifier provided by RealId","format":"password","type":"string"},"sambaTvId":{"description":"User identifier provided by Samba TV","format":"password","type":"string"},"transunionId":{"description":"User identifier provided by TransUnion","format":"password","type":"string"}},"type":"object"},"ExternalReferenceType":{"description":"Type of dataset external reference ID","enum":["AMAZON_AD_TAG","CUSTOMER_PROVIDED","MMP"],"type":"string"},"FeeMetadata":{"description":"Fee metadata for an audience, modeled on the ADSP fee representation.\nADM does not store or interpret this fee; it is passed through opaquely to the\ndestination (e.g. PubTech) on audience creation. Fees are keyed by supply type and,\nwithin each supply type, by internal marketplace id.","properties":{"supplyTypes":{"$ref":"#/components/schemas/SupplyTypeFees"}},"type":"object"},"Geo":{"properties":{"countryCode":{"$ref":"#/components/schemas/CountryCode"},"ipAddress":{"description":"A String value holding an ipAddress used to determine country for members in this audience. Optional.","type":"string"}},"type":"object"},"GetDataSetMetricsResponseContent":{"properties":{"acceptedCount":{"description":"The number of accepted records in the dataset","type":"number"},"accountId":{"description":"Identifier for the MA or AA that owns this DataSet.","type":"string"},"clientName":{"description":"Identifier of the user who created the DataSet.","type":"string"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"createdBy":{"description":"Identifier of the user who created the DataSet.","type":"string"},"dataSetId":{"description":"The ID of the dataset","type":"string"},"dataSetSource":{"description":"The source of the dataset","type":"string"},"dataSetType":{"$ref":"#/components/schemas/DataSetType"},"dateCreated":{"description":"The timestamp when the dataset was created","format":"date-time","type":"string"},"description":{"description":"The description of the dataset","type":"string"},"externalReferenceId":{"description":"An internal Id generated from external source","type":"string"},"externalReferenceType":{"$ref":"#/components/schemas/ExternalReferenceType"},"idRetention":{"description":"Determines retention of hashed data for 90 days and refresh of UID tokens.","type":"boolean"},"invalidRecordCount":{"description":"The number of invalid records in the dataset","type":"number"},"lastModified":{"description":"The timestamp when the dataset was last modified","format":"date-time","type":"string"},"lastModifiedBy":{"description":"Identifier of the user who most recently modified the DataSet.","type":"string"},"matchRecordPercentage":{"description":"The percentage of records successfully matched in the dataset","format":"float","type":"number"},"metadata":{"$ref":"#/components/schemas/Metadata"},"name":{"description":"The name of the dataset","type":"string"},"recordsResolved":{"description":"The number of records successfully resolved in the dataset","type":"number"},"recordsWithIdentity":{"description":"The number of records with identity information in the dataset","type":"number"},"ttl":{"description":"Time-to-live in seconds. The amount of time the record is associated with the DataSet. Max is 12.5 months.","maximum":32850000,"minimum":0,"type":"number"},"uploadCount":{"description":"The total number of uploads for the dataset","type":"number"}},"required":["acceptedCount","dataSetId","dataSetSource","dataSetType","dateCreated","description","invalidRecordCount","lastModified","matchRecordPercentage","name","recordsResolved","recordsWithIdentity","uploadCount"],"type":"object"},"GetDataroomMetadataResponseContent":{"properties":{"activeDestinations":{"description":"The number of active destinations for the datasets","type":"number"},"dataSetsInUse":{"description":"The number of datasets currently in use","type":"number"},"linkedAccounts":{"description":"The number of linked accounts associated with the datasets","type":"number"},"totalDataSets":{"description":"The total number of datasets","type":"number"}},"required":["activeDestinations","dataSetsInUse","linkedAccounts","totalDataSets"],"type":"object"},"GetDataroomResponseContent":{"properties":{"accountId":{"description":"The owner of this Data room","type":"string"},"assignedToAccountId":{"description":"The Ads AccountId to which this dataroom is assigned to","type":"string"},"creationDateTime":{"description":"An ISO UTC Timestamp value representing the time the dataroom was created","format":"date-time","type":"string"},"region":{"$ref":"#/components/schemas/AwsRegion"}},"required":["accountId","creationDateTime"],"type":"object"},"GetDatasetAggregatesRequestContent":{"description":"List of Common Headers that could be added to any api with optional customerId and AdvertiserId","properties":{"endDate":{"description":"The end date for the metrics aggregation window, in UTC","format":"date-time","type":"string"},"metrics":{"description":"The list of metrics to retrieve for the dataset","items":{"$ref":"#/components/schemas/DatasetMetric"},"type":"array"},"startDate":{"description":"The start date for the metrics aggregation window, in UTC","format":"date-time","type":"string"}},"type":"object"},"GetDatasetAggregatesResponseContent":{"properties":{"metrics":{"$ref":"#/components/schemas/DatasetTimeSeries"}},"type":"object"},"HashedPii":{"description":"Structure representing hashed personally identifiable information (PII).","format":"password","properties":{"ad":{"description":"Normalized and SHA-256 hashed street address","type":"string"},"cty":{"description":"Normalized and SHA-256 hashed city name","type":"string"},"em":{"description":"Normalized and SHA-256 hashed email address","type":"string"},"fn":{"description":"Normalized and SHA-256 hashed first name","type":"string"},"ln":{"description":"Normalized and SHA-256 hashed last name","type":"string"},"ph":{"description":"Normalized and SHA-256 hashed phone number","type":"string"},"st":{"description":"Normalized and SHA-256 hashed state or region code","type":"string"},"zip":{"description":"Normalized and SHA-256 hashed postal or zip code","type":"string"}},"type":"object"},"Identity":{"description":"Either one hashedPII object or external identity object is required","format":"password","properties":{"externalIdentities":{"items":{"$ref":"#/components/schemas/ExternalIdentity"},"maxItems":10,"minItems":0,"type":"array"},"hashedPiis":{"description":"List of hashed personally-identifiable information records to be matched with Amazon identities for future use. All inputs must be properly normalized and SHA-256 hashed.","items":{"$ref":"#/components/schemas/HashedPii"},"maxItems":10,"minItems":0,"type":"array"}},"type":"object"},"IngestAudiencesRequestContent":{"description":"List of Common Headers that could be added to any api in Bifrost service","properties":{"members":{"items":{"$ref":"#/components/schemas/AudienceMember"},"maxItems":10000,"minItems":1,"type":"array"}},"required":["members"],"type":"object"},"IngestAudiencesResponseContent":{"properties":{"errors":{"description":"List of Validation Errors in the AudienceMembers, which are rejected from the request.","items":{"$ref":"#/components/schemas/ValidationError"},"maxItems":10000,"minItems":1,"type":"array"},"ingressId":{"description":"Unique identifier for data ingestion flow generated at the server side when an events data are uploaded . When `POST` method is invoked to upload event data, a unique identifier is returned.","type":"string"}},"type":"object"},"ListDatasetDetailsRequestContent":{"description":"List of Common Headers that could be added to any api with optional customerId and AdvertiserId","properties":{"datasetIds":{"description":"A set of datasetIds to retrieve data for","items":{"description":"A dataset id","type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"ListDatasetDetailsResponseContent":{"properties":{"datasets":{"description":"The list of dataset metadata objects","items":{"$ref":"#/components/schemas/DatasetMetadata"},"maxItems":100,"type":"array"},"nextToken":{"description":"A token to retrieve the next page of results, if applicable","type":"string"}},"required":["datasets"],"type":"object"},"ListSharingRulesRequestContent":{"description":"Fields for external ListSharingRules call, including filter expressions and common headers.","properties":{"activatedAfter":{"description":"The UTC date-time on or after which the sharing rule was activated.","format":"date-time","type":"string"},"activatedBefore":{"description":"The UTC date-time on or before which the sharing rule was activated.","format":"date-time","type":"string"},"application":{"$ref":"#/components/schemas/ApplicationId"},"datasetIds":{"description":"The list of dataset ids to filter sharing rules by.","items":{"description":"Id of a DataSet.","type":"string"},"minItems":1,"type":"array"},"destinationAccountId":{"description":"The account id to filter receiver of the sharing rule.","type":"string"},"maxResults":{"description":"The maximum number of sharing rule results to return within one response.","maximum":100,"minimum":1,"type":"number"},"nextToken":{"description":"nextToken is used for pagination.","type":"string"},"statuses":{"description":"The list of statuses to filter sharing rules by. Exclusive filter if included,\nif not provided, all rules with any status are returned.","items":{"$ref":"#/components/schemas/SharingRuleStatus"},"minItems":1,"type":"array"}},"type":"object"},"ListSharingRulesResponseContent":{"description":"The response consisting of a list of sharing rules.","properties":{"nextToken":{"description":"Token to get next page in a paginated response.","type":"string"},"sharingRules":{"description":"The list of sharing rules matching the input request.","items":{"$ref":"#/components/schemas/SharingRuleListItem"},"type":"array"}},"type":"object"},"MMPMetadata":{"description":"A structure to represent the metadata required for Mobile Measurement Partner (MMP) entities.","properties":{"mmpAppId":{"type":"string"},"name":{"type":"string"}},"required":["mmpAppId"],"type":"object"},"MarketplaceFee":{"description":"The fee charged for a supply type in a specific marketplace.","properties":{"currency":{"$ref":"#/components/schemas/Currency"},"value":{"description":"The fee amount as a decimal in the given currency. For example, a $0.50 CPM is 0.5.","format":"double","type":"number"}},"required":["currency","value"],"type":"object"},"MarketplaceFees":{"additionalProperties":{"$ref":"#/components/schemas/MarketplaceFee"},"description":"Map of internal marketplace id to the fee charged in that marketplace.","type":"object"},"Metadata":{"description":"Container for dataset metadata","properties":{"mmpMetadata":{"$ref":"#/components/schemas/MmpMetadata"}},"type":"object"},"MmpMetadata":{"description":"MMP (Mobile Measurement Partner) metadata for dataset tracking","properties":{"appName":{"description":"User-defined application name for MMP Registration","maxLength":100,"type":"string"},"bundleId":{"description":"Bundle ID parsed from app store URL","maxLength":255,"type":"string"},"isExistingApp":{"description":"Whether the app was already registered prior to migration","type":"boolean"},"mmpAppId":{"description":"Unique app registration ID generated by Amazon","type":"string"},"mmpName":{"$ref":"#/components/schemas/MmpName"},"platform":{"$ref":"#/components/schemas/MmpPlatform"},"skAdNetworkReference":{"description":"SKAdNetwork enablement reference","type":"boolean"},"sourceAdvertiserAccountId":{"description":"Advertiser account ID of the source system prior to migration","type":"string"}},"required":["appName","bundleId","mmpName","platform"],"type":"object"},"MmpName":{"description":"Supported Mobile Measurement Partner names","enum":["ADJUST","AIRBRIDGE","APPSFLYER","BRANCH","KOCHAVA","SINGULAR","TENJIN"],"type":"string"},"MmpPlatform":{"description":"Supported mobile platforms for MMP tracking","enum":["ANDROID","FIRE_TABLET","FIRE_TV","IOS"],"type":"string"},"PartitionedByEnum":{"enum":["DAY","HOUR","MONTH","YEAR"],"type":"string"},"PubTechMetadata":{"description":"Metadata specific to PubTech, including audience information.\nData provider ID and name are stored on the ADM Sharing Grant. The data provider reporting ID is\nsupplied per audience in this structure.","properties":{"allowedCountries":{"description":"The countries in which the audience may be used. Required when creating a new audience.","items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":10,"minItems":1,"type":"array"},"audienceName":{"description":"The name of the audience. Required when creating a new audience.","type":"string"},"dataProviderReportingId":{"description":"An external ID supplied by the data provider for the audience, used in usage reports sent to the data provider.\nRequired when creating a new audience. Must not be passed on reshare.","type":"string"},"description":{"type":"string"},"existingAudienceTargetingValue":{"description":"The targeting value for an existing PubTech audience. This maps to the `customExecutionId` of a TaxonomyNode.\nThis is the value that is put on the ad request and used in deal targeting. Required for reshare.","type":"string"},"fee":{"$ref":"#/components/schemas/FeeMetadata"}},"type":"object"},"PubTechResponseMetadata":{"description":"Response metadata returned by PubTech after processing a sharing rule event.","properties":{"audienceName":{"type":"string"},"audienceTargetingValue":{"type":"string"}},"required":["audienceName","audienceTargetingValue"],"type":"object"},"SchemaType":{"enum":["AUDIENCE","CUSTOM","EVENT"],"type":"string"},"SharingRuleListItem":{"description":"Intermediate structure to allow use of SharingRule in SharingRuleList","properties":{"accountEntityId":{"description":"The account (e.g., DSP Advertiser Account) entityId. This is different from \u0027destinationEntityId\u0027.\nThis is also known as \"parent entity id\".","type":"string"},"activationTime":{"description":"The timestamp when the sharing rule was activated.","format":"date-time","type":"string"},"application":{"$ref":"#/components/schemas/ApplicationId"},"creationTime":{"description":"Timestamp for time of creation in UTC.","format":"date-time","type":"string"},"dataSetId":{"description":"Data set which is being shared via the sharing rule.\nThe minimum length of the datasetId is 1 to ensure that it\u0027s not an empty string","minLength":1,"type":"string"},"dataSetName":{"description":"The name of the DataSet part of this sharing rule.","type":"string"},"destinationAccountId":{"description":"Account to which data is shared.","type":"string"},"destinationEntityName":{"description":"The display name of the destination entity.","type":"string"},"marketplaceId":{"description":"Marketplace to which data is shared.","type":"string"},"metadata":{"$ref":"#/components/schemas/SharingRuleResponseMetadata"},"revokedBy":{"description":"The reason a rule was revoked, or NONE if rule is not revoked.","type":"string"},"revokedTime":{"description":"The timestamp when the sharing rule was revoked.","format":"date-time","type":"string"},"sharingRuleId":{"description":"Unique ID for a sharing rule.","maxLength":100,"minLength":1,"pattern":"^[0-9A-Za-z_-]{1,100}$","type":"string"},"status":{"$ref":"#/components/schemas/SharingRuleStatus"}},"required":["application","creationTime","dataSetId","destinationAccountId","marketplaceId","sharingRuleId","status"],"type":"object"},"SharingRuleMetadata":{"description":"A union to capture application specific metadata.\nGoing forward, this will include Events Manager metadata, AMC metadata etc..","oneOf":[{"properties":{"audienceMetadata":{"$ref":"#/components/schemas/AudienceMetadata"}},"required":["audienceMetadata"],"title":"audienceMetadata","type":"object"},{"properties":{"conversionDefinitionMetadata":{"$ref":"#/components/schemas/ConversionDefinitionMetadata"}},"required":["conversionDefinitionMetadata"],"title":"conversionDefinitionMetadata","type":"object"},{"properties":{"conversionDefinitionId":{"description":"conversionDefinitionId used for reshare","type":"string"}},"required":["conversionDefinitionId"],"title":"conversionDefinitionId","type":"object"},{"properties":{"amcMetadata":{"$ref":"#/components/schemas/AmcMetadata"}},"required":["amcMetadata"],"title":"amcMetadata","type":"object"},{"properties":{"mmpMetadata":{"$ref":"#/components/schemas/MMPMetadata"}},"required":["mmpMetadata"],"title":"mmpMetadata","type":"object"},{"properties":{"pubTechMetadata":{"$ref":"#/components/schemas/PubTechMetadata"}},"required":["pubTechMetadata"],"title":"pubTechMetadata","type":"object"},{"properties":{"audienceHubMetadata":{"$ref":"#/components/schemas/AudienceHubMetadata"}},"required":["audienceHubMetadata"],"title":"audienceHubMetadata","type":"object"}]},"SharingRuleResponseMetadata":{"description":"A union to capture application specific metadata that is exposed to API consumers.\nEventually, this will involve other applications\u0027 metadata.","oneOf":[{"properties":{"audienceMetadata":{"$ref":"#/components/schemas/AudienceResponseMetadata"}},"required":["audienceMetadata"],"title":"audienceMetadata","type":"object"},{"properties":{"conversionDefinitionMetadata":{"$ref":"#/components/schemas/ConversionDefinitionResponseMetadata"}},"required":["conversionDefinitionMetadata"],"title":"conversionDefinitionMetadata","type":"object"},{"properties":{"amcMetadata":{"$ref":"#/components/schemas/AmcMetadata"}},"required":["amcMetadata"],"title":"amcMetadata","type":"object"},{"properties":{"mmpMetadata":{"$ref":"#/components/schemas/MMPMetadata"}},"required":["mmpMetadata"],"title":"mmpMetadata","type":"object"},{"properties":{"pubTechMetadata":{"$ref":"#/components/schemas/PubTechResponseMetadata"}},"required":["pubTechMetadata"],"title":"pubTechMetadata","type":"object"},{"properties":{"audienceHubMetadata":{"$ref":"#/components/schemas/AudienceHubResponseMetadata"}},"required":["audienceHubMetadata"],"title":"audienceHubMetadata","type":"object"},{"properties":{"noMetadata":{"$ref":"#/components/schemas/Unit"}},"required":["noMetadata"],"title":"noMetadata","type":"object"}]},"SharingRuleStatus":{"description":"Customer facing enum for SharingRule status.","enum":["ACTIVE","PENDING","REVOKED_BY_DATASET","REVOKED_BY_SHARING_GRANT","REVOKED_BY_USER","SHADOW"],"type":"string"},"SupplyTypeFee":{"description":"Fees for a single supply type, keyed by marketplace.","properties":{"marketplaceFees":{"$ref":"#/components/schemas/MarketplaceFees"}},"type":"object"},"SupplyTypeFees":{"additionalProperties":{"$ref":"#/components/schemas/SupplyTypeFee"},"description":"Map of supply type to the fees that apply to it.","type":"object"},"TargetIdentity":{"description":"The user identity to be deleted. Either an ExternalUserId or a collection of externalIdentities , maid or Hashed PII values representing a single user.","oneOf":[{"properties":{"externalUserId":{"type":"string"}},"required":["externalUserId"],"title":"externalUserId","type":"object"},{"properties":{"identity":{"$ref":"#/components/schemas/Identity"}},"required":["identity"],"title":"identity","type":"object"}]},"Unit":{"type":"object"},"UserConsent":{"properties":{"consent":{"$ref":"#/components/schemas/Consent"},"geo":{"$ref":"#/components/schemas/Geo"}},"type":"object"},"ValidationError":{"description":"Error Details for Each Member in the Ingest Request Payload.","properties":{"code":{"description":"HTTP status code of the error encountered.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"},"errors":{"description":"List of detailed errors, if any.","items":{"$ref":"#/components/schemas/DetailedError"},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"Index of the Member in the Request Payload List.","type":"number"}},"type":"object"}},"securitySchemes":{}},"info":{"description":"Ads data manager (ADM) simplifies and streamlines the process of first-party data management across Amazon Ads. ADM\u0027s APIs let advertisers and their partners onboard their data once and securely reuse it across our ad products ( e.g. ADSP or AMC) for measuring conversions, engaging relevant audiences, and optimizing campaigns.","title":"Ads Data Manager","version":"3.0"},"openapi":"3.0.1","paths":{"/adm/audiences":{"get":{"description":"Lists all Audience DataSets.\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"ManagerAccount_Dev\",\"ads_data_manager_view\",\"ads_data_manager_edit\",\"MasterAccount_Viewer\"]\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[\"audiences_edit\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"event_manager_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]","operationId":"ListAudienceDatasets","parameters":[{"description":"Optional. Token to receive next page of results.","in":"query","name":"nextToken","schema":{"description":"Optional. Token to receive next page of results.","type":"string"}},{"description":"Optional. Number of results to limit. Default is 100.","in":"query","name":"limit","schema":{"description":"Optional. Number of results to limit. Default is 100.","type":"number"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolListAudienceResponseContent"}}},"description":"ListAudience 200 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolDuplicateDatasetNameExceptionResponseContent"}}},"description":"400 DuplicateDatasetName Error","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"404 ResourceNotFound","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"429 TooManyRequests","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Audiences"]},"post":{"description":"Creates an Audience DataSet.\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"ManagerAccount_Dev\",\"ads_data_manager_edit\"]\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[\"audiences_edit\",\"ads_data_manager_edit\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"ads_data_manager_edit\"]","operationId":"CreateAudienceDataset","parameters":[{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolCreateAudienceRequestContent"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolCreateAudienceResponseContent"}}},"description":"CreateAudience 201 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolDuplicateDatasetNameExceptionResponseContent"}}},"description":"400 DuplicateDatasetName Error","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"404 ResourceNotFound","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"429 TooManyRequests","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Audiences"]}},"/adm/audiences/{dataSetId}":{"get":{"description":"Gets an Audience DataSet.\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"ManagerAccount_Dev\",\"ads_data_manager_view\",\"ads_data_manager_edit\",\"MasterAccount_Viewer\"]\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[\"audiences_edit\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"event_manager_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]","operationId":"GetAudienceDataset","parameters":[{"description":"Unique identifier that is created to represent the Dataset.","in":"path","name":"dataSetId","required":true,"schema":{"description":"Unique identifier that is created to represent the Dataset.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolGetAudienceResponseContent"}}},"description":"GetAudience 200 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolDuplicateDatasetNameExceptionResponseContent"}}},"description":"400 DuplicateDatasetName Error","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"404 ResourceNotFound","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"429 TooManyRequests","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Audiences"]}},"/adm/audiences/{dataSetId}/members":{"post":{"description":"Posts audience members to an audience dataset.\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"ads_data_manager_edit\"]\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[\"account_edit\",\"advertiser_campaign_edit\",\"audiences_edit\",\"ads_data_manager_edit\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"ads_data_manager_edit\"]","operationId":"IngestAudiences","parameters":[{"description":"An Amazon common Identifier format of type String. This is the identifier that is returned during audience dataset creation.","in":"path","name":"dataSetId","required":true,"schema":{"description":"An Amazon common Identifier format of type String. This is the identifier that is returned during audience dataset creation.","type":"string"}},{"description":"Advertiser Account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Advertiser Account ID.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"requestBody":{"content":{"application/vnd.admAudiences.v1+json":{"schema":{"$ref":"#/components/schemas/IngestAudiencesRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.admAudiences.v1+json":{"schema":{"$ref":"#/components/schemas/IngestAudiencesResponseContent"}}},"description":"IngestAudiences 200 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxBadRequestExceptionResponseContent"}}},"description":"400 BadRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"404 ResourceNotFound","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"429 TooManyRequests","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Audiences"]}},"/adm/datarooms":{"get":{"description":"Get a data room\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"ManagerAccount_Dev\",\"ads_data_manager_view\",\"ads_data_manager_edit\",\"MasterAccount_Viewer\"]\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[\"audiences_edit\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"event_manager_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]","operationId":"GetDataroom","parameters":[{"description":"Advertiser Account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Advertiser Account ID.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDataroomResponseContent"}}},"description":"GetDataroom 200 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolDuplicateDatasetNameExceptionResponseContent"}}},"description":"400 DuplicateDatasetName Error","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"404 ResourceNotFound","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"429 TooManyRequests","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Data rooms"]},"post":{"description":"Create a dataroom\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"ads_data_manager_view\",\"ads_data_manager_edit\",\"MasterAccount_Manager\",\"ManagerAccount_Dev\",\"MasterAccount_Viewer\"]\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[\"audiences_edit\",\"ads_data_manager_edit\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"ads_data_manager_edit\"]","operationId":"CreateDataroom","parameters":[{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDataroomResponseContent"}}},"description":"CreateDataroom 201 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolDuplicateDatasetNameExceptionResponseContent"}}},"description":"400 DuplicateDatasetName Error","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"404 ResourceNotFound","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"429 TooManyRequests","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Data rooms"]}},"/adm/datarooms/metadata":{"get":{"description":"Gets dataset metadata including linked datasets, active dest., etc\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"ads_data_manager_edit\",\"ads_data_manager_view\",\"MasterAccount_Manager\",\"MasterAccount_Viewer\"]\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[\"audiences_edit\",\"audiences_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"event_manager_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]","operationId":"GetDataroomMetadata","parameters":[{"description":"Advertiser Account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Advertiser Account ID.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/GetDataroomMetadataResponseContent"}}},"description":"GetDataroomMetadata 200 response"},"400":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxBadRequestExceptionResponseContent"}}},"description":"400 BadRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Data rooms"]}},"/adm/datasets/list":{"post":{"description":"Lists details of datasets in a given account.\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"ads_data_manager_edit\",\"ads_data_manager_view\",\"MasterAccount_Manager\",\"MasterAccount_Viewer\"]\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[\"audiences_edit\",\"audiences_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"event_manager_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]","operationId":"ListDatasetDetails","parameters":[{"description":"The search query string.","in":"query","name":"search","schema":{"description":"The search query string.","type":"string"}},{"description":"The order or sorting criteria for the search results.","in":"query","name":"order","schema":{"description":"The order or sorting criteria for the search results.","type":"string"}},{"description":"A token to specify where to start retrieving results","in":"query","name":"nextToken","schema":{"description":"A token to specify where to start retrieving results","type":"string"}},{"description":"The maximum number of results to return per page. This value defaults to 100","in":"query","name":"maxResults","schema":{"description":"The maximum number of results to return per page. This value defaults to 100","maximum":100,"minimum":1,"type":"number"}},{"description":"Advertiser Account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Advertiser Account ID.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"requestBody":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/ListDatasetDetailsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/ListDatasetDetailsResponseContent"}}},"description":"ListDatasetDetails 200 response"},"400":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxBadRequestExceptionResponseContent"}}},"description":"400 BadRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Datasets"]}},"/adm/datasets/{dataSetId}":{"delete":{"description":"Delete a Dataset.\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[\"account_edit\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"ManagerAccount_Dev\",\"ads_data_manager_edit\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"ads_data_manager_edit\"]","operationId":"DeleteDataset","parameters":[{"description":"Unique identifier that is created to represent the Dataset.","in":"path","name":"dataSetId","required":true,"schema":{"description":"Unique identifier that is created to represent the Dataset.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"responses":{"204":{"description":"DeleteDataSet 204 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolDuplicateDatasetNameExceptionResponseContent"}}},"description":"400 DuplicateDatasetName Error","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"404 ResourceNotFound","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"429 TooManyRequests","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerUnavailableExceptionResponseContent"}}},"description":"AdsCdxServerUnavailableException 503 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Datasets"]}},"/adm/datasets/{dataSetId}/metrics":{"get":{"description":"Gets the metrics associated to dataset across all uploads\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"ads_data_manager_edit\",\"ads_data_manager_view\",\"MasterAccount_Manager\",\"MasterAccount_Viewer\"]\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[\"audiences_edit\",\"audiences_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"event_manager_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]","operationId":"GetDataSetMetrics","parameters":[{"description":"The ID of the dataset for which to retrieve metrics","in":"path","name":"dataSetId","required":true,"schema":{"description":"The ID of the dataset for which to retrieve metrics","type":"string"}},{"description":"Advertiser Account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Advertiser Account ID.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"responses":{"200":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/GetDataSetMetricsResponseContent"}}},"description":"GetDataSetMetrics 200 response"},"400":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxBadRequestExceptionResponseContent"}}},"description":"400 BadRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Datasets"]}},"/adm/datasets/{dataSetId}/metrics/aggregates":{"post":{"description":"Gets aggregated metrics for a dataset within a specified time range\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"ads_data_manager_edit\",\"ads_data_manager_view\",\"MasterAccount_Manager\",\"MasterAccount_Viewer\"]\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[\"audiences_edit\",\"audiences_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"event_manager_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]","operationId":"GetDatasetAggregates","parameters":[{"description":"The ID of the dataset for which to retrieve metrics","in":"path","name":"dataSetId","required":true,"schema":{"description":"The ID of the dataset for which to retrieve metrics","type":"string"}},{"description":"Advertiser Account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Advertiser Account ID.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"requestBody":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/GetDatasetAggregatesRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/GetDatasetAggregatesResponseContent"}}},"description":"GetDatasetAggregates 200 response"},"400":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxBadRequestExceptionResponseContent"}}},"description":"400 BadRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/vnd.admmetrics.v1+json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Datasets"]}},"/adm/identities/delete":{"post":{"description":"Deletes matched list of users from your data room within 30 days.\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"ads_data_manager_edit\"]\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[\"account_edit\",\"advertiser_campaign_edit\",\"audiences_edit\",\"ads_data_manager_edit\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"ads_data_manager_edit\"]","operationId":"DeleteIdentity","parameters":[{"description":"Advertiser Account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Advertiser Account ID.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"requestBody":{"content":{"application/vnd.admDataDeletion.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteIdentityRequestContent"}}},"required":true},"responses":{"200":{"description":"DeleteIdentity 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxBadRequestExceptionResponseContent"}}},"description":"400 BadRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"404 ResourceNotFound","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"429 TooManyRequests","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Identity Deletion"]}},"/adm/sharingRules":{"post":{"description":"Create a new Sharing Rule in ADM.\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"ManagerAccount_Dev\",\"ads_data_manager_edit\",\"MasterAccount_Viewer\"]\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[\"audiences_edit\",\"ads_data_manager_edit\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"ads_data_manager_edit\"]","operationId":"CreateSharingRule","parameters":[{"description":"Advertiser Account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Advertiser Account ID.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSharingRuleRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSharingRuleResponseContent"}}},"description":"CreateSharingRule 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxBadRequestExceptionResponseContent"}}},"description":"AdsCdxBadRequestException 400 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"AdsCdxUnauthorizedRequestException 401 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"AdsCdxForbiddenRequestException 403 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"AdsCdxResourceNotFoundException 404 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"AdsCdxTooManyRequestsException 429 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"AdsCdxServerException 500 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Sharing Rules"]}},"/adm/sharingRules/list":{"post":{"description":"List a set of sharing rules belonging to an account.\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"ManagerAccount_Dev\",\"ads_data_manager_view\",\"ads_data_manager_edit\",\"MasterAccount_Viewer\"]\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[\"audiences_edit\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"event_manager_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]","operationId":"ListSharingRules","parameters":[{"description":"Advertiser Account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Advertiser Account ID.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSharingRulesRequestContent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSharingRulesResponseContent"}}},"description":"ListSharingRules 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxBadRequestExceptionResponseContent"}}},"description":"AdsCdxBadRequestException 400 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"AdsCdxUnauthorizedRequestException 401 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"AdsCdxForbiddenRequestException 403 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"AdsCdxResourceNotFoundException 404 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"AdsCdxTooManyRequestsException 429 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"AdsCdxServerException 500 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Sharing Rules"]}},"/adm/sharingRules/{sharingRuleId}/revoke":{"patch":{"description":"Revoke an existing Sharing Rule in ADM.\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"ManagerAccount_Dev\",\"ads_data_manager_edit\"]\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[\"audiences_edit\",\"ads_data_manager_edit\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"ads_data_manager_edit\"]","operationId":"RevokeSharingRule","parameters":[{"description":"The unique identifier for a sharing rule.","in":"path","name":"sharingRuleId","required":true,"schema":{"description":"The unique identifier for a sharing rule.","type":"string"}},{"description":"Advertiser Account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Advertiser Account ID.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"responses":{"204":{"description":"RevokeSharingRule 204 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxBadRequestExceptionResponseContent"}}},"description":"AdsCdxBadRequestException 400 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"AdsCdxUnauthorizedRequestException 401 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"AdsCdxForbiddenRequestException 403 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"AdsCdxResourceNotFoundException 404 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"AdsCdxTooManyRequestsException 429 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"AdsCdxServerException 500 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Sharing Rules"]}},"/adm/terms":{"get":{"description":"Get the Customer\u0027s Ads Data Manager Terms and Conditions\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"ManagerAccount_Dev\",\"ads_data_manager_edit\",\"ads_data_manager_view\",\"MasterAccount_Viewer\"]\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[\"audiences_edit\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"event_manager_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]","operationId":"GetTerms","parameters":[{"description":"Advertiser Account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Advertiser Account ID.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolGetTermsResponseContent"}}},"description":"AdsCdxSolGetTerms 200 response","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolDuplicateDatasetNameExceptionResponseContent"}}},"description":"400 DuplicateDatasetName Error","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"404 ResourceNotFound","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"429 TooManyRequests","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Terms"]},"patch":{"description":"Set the Customer\u0027s Ads Data Manager Terms and Conditions acceptance\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-Account-ID\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"ManagerAccount_Dev\",\"MasterAccount_Viewer\",\"ads_data_manager_view\",\"ads_data_manager_edit\"]\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[\"audiences_edit\",\"ads_data_manager_edit\"]\n\n**Authorized resource type**:\nGlobal Ad 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\",\"event_manager_view\",\"ads_data_manager_edit\",\"ads_data_manager_view\"]","operationId":"SetTermsAcceptance","parameters":[{"description":"Advertiser Account ID.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Advertiser Account ID.","type":"string"}},{"description":"Manager Account ID.","in":"header","name":"Amazon-Ads-Manager-Account-ID","schema":{"description":"Manager Account ID.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolSetTermsAcceptanceRequestContent"}}},"required":true},"responses":{"204":{"description":"SetTermsAcceptance 204 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxSolDuplicateDatasetNameExceptionResponseContent"}}},"description":"400 DuplicateDatasetName Error","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxUnauthorizedRequestExceptionResponseContent"}}},"description":"401 UnauthorizedRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxForbiddenRequestExceptionResponseContent"}}},"description":"403 ForbiddenRequest","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxResourceNotFoundExceptionResponseContent"}}},"description":"404 ResourceNotFound","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxTooManyRequestsExceptionResponseContent"}}},"description":"429 TooManyRequests","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsCdxServerExceptionResponseContent"}}},"description":"500 ServerError","headers":{"Amazon-Advertising-API-RequestId":{"description":"Request identifier.","schema":{"description":"Request identifier.","type":"string"}}}}},"tags":["Terms"]}}}}