{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"BidAdjustmentsServiceAccessDeniedExceptionResponseContent":{"description":"Indicates the user does not have access to this API.","properties":{"message":{"description":"Error message indicating why the request may have failed.","minLength":1,"type":"string"}},"required":["message"],"type":"object"},"BidAdjustmentsServiceAllBidAdjustmentRuleAssociations":{"description":"Returns active, inactive and audience-violating associations for a bid adjustment rule.","properties":{"activeAssociations":{"$ref":"#/components/schemas/BidAdjustmentsServiceBidAdjustmentRuleAssociations"},"audienceViolations":{"$ref":"#/components/schemas/BidAdjustmentsServiceBidAdjustmentRuleAssociations"},"inactiveAssociations":{"$ref":"#/components/schemas/BidAdjustmentsServiceBidAdjustmentRuleAssociations"}},"required":["activeAssociations"],"type":"object"},"BidAdjustmentsServiceBidAdjustmentRuleAssociations":{"properties":{"adGroupIds":{"items":{"description":"The ad group id.","maxLength":1024,"minLength":1,"pattern":"^(?!\\s*$).+","type":"string"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"BidAdjustmentsServiceBidAdjustmentRuleDetails":{"description":"Expected output for reading details of a bid adjustment rule.","properties":{"active":{"description":"Whether the current bid adjustment rule is considered active/inactive.","type":"boolean"},"adjustmentRuleId":{"description":"The unique identifier for the bid adjustment rule.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"adjustmentType":{"$ref":"#/components/schemas/BidAdjustmentsServiceRuleAdjustmentType"},"associations":{"$ref":"#/components/schemas/BidAdjustmentsServiceAllBidAdjustmentRuleAssociations"},"dateCreated":{"description":"The ISO 8601 date time (in UTC) when the bid adjustment rule was created.","format":"date-time","type":"string"},"ruleDescription":{"description":"The name of the bid adjustment. No uniqueness requirements.","maxLength":1024,"minLength":1,"pattern":"^(?!\\s*$).+","type":"string"},"ruleExpression":{"$ref":"#/components/schemas/BidAdjustmentsServiceRuleExpression"},"termCount":{"description":"Number of terms present in the bid adjustment rule.","maximum":1000,"minimum":1,"type":"number"},"versionDateCreated":{"description":"The ISO 8601 date time (in UTC) when the bid adjustment rule version was created.","format":"date-time","type":"string"},"versionId":{"description":"A unique identifier representing the version of a bid adjustment rule. When a rule is first created, its version is by default set to 0.\nWhen the rule is updated, a new version is created starting from 1. Each subsequent update increments the version (2, 3, etc.)","pattern":"^[1-9][0-9]*$","type":"string"}},"required":["active","adjustmentRuleId","associations","dateCreated","ruleDescription","termCount","versionDateCreated","versionId"],"type":"object"},"BidAdjustmentsServiceBidModifierRuleExpression":{"properties":{"onMultipleMatches":{"$ref":"#/components/schemas/BidAdjustmentsServiceOnMultipleMatches"},"terms":{"items":{"$ref":"#/components/schemas/BidAdjustmentsServiceBidModifierTerm"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["terms"],"type":"object"},"BidAdjustmentsServiceBidModifierTerm":{"description":"A bid modifier term is composed of 1 or more of the below dimensions, and a bid adjustment.\n A minimum of 1 dimension must be set, and there is no maximum on the number of dimensions. The same\n dimension (e.g., appId) cannot be used twice. If you have multiple dimension values, please provide\n them in the list, separated by commas.\n\n A bid modifier term is evaluated by attempting to match dimension\n values with impression data. The bid adjustment is only applied if all dimensions in the bid modifier term match,\n where matching is defined as: the dimension contains a dimension value in common with the impression data. However, if\n the \"negative\" field is set to true, then the bid adjustment will only be applied if no dimensions in the bid modifier\n match. If one or more dimensions have a value in common with the impression data and the \"negative\" field is true,\n then the bid adjustment will not be applied.\n\n Please note that all the dimension values provided for dimensions are case-insensitive for matching purposes,\n except dimensions which use numeric values/IDs.\n These numeric value/ID related dimensions are:\n [behavioralSegment, creativeId, dayOfWeekUserTimezone, dayOfWeekUtc, hourOfWeekUserTimezone, hourOfWeekUtc].","properties":{"adFormat":{"description":"Valid values: \"DISPLAY\", \"AUDIO\", \"VIDEO\". Values are case insensitive.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"appId":{"description":"Application identifiers unique to the app and independent of the exchange. On Android, this should be a bundle or package name (e.g.,com.foo.mygame). On iOS, it is typically a numeric ID. Values are case sensitive.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"appName":{"description":"The name of the application from the App Store. Examples include: \"Wordscapes\", \"Pinterest\", \"Yahoo Weather\".","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"behavioralSegment":{"description":"Unique identifier for Amazon audiences. Selection of segments in Audience for the adgroup is required in order to use them in bid modifiers. Example: 407259404244917362.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"bidAdjustment":{"description":"The value used to upscale/downscale the Amazon DSP computed bid amount. This will be multiplied with the bid amount\n computed by Amazon DSP to derive the final bid amount. Please note that values will be truncated to 2 decimal places.\n If there are multiple term objects in a bid adjustment rule,\n then each bid adjustment will be multipled together to determine the total bid adjustment amount, which will\n be multiplied with the Amazon DSP computed bid amount.","format":"double","maximum":10,"minimum":0,"type":"number"},"browser":{"description":"The browser family of the user viewing the page. Example: \"Chrome\", \"Mozilla\", \"Safari\", \"Firefox\". Values are case insensitive.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"city":{"description":"Full name of the city. Values are case insensitive. Only listed values are allowed.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"country":{"description":"The ISO 3166-1 alpha-2 country code, based on the IP address of the user. Example: \"JP\". Values are case insensitive.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"dealId":{"description":"The Amazon assigned Deal ID. Example: \"346361066859317070\",\"296560903047013107\".","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"deviceMake":{"description":"The make of the device. Example: \"APPLE\", \"GOOGLE\", \"SAMSUNG\", \"AMAZON\". Values are case insensitive.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"deviceType":{"description":"The device type of the user viewing the ad. Valid Values: \"Phone\", \"Tablet\", \"PC\", \"TV\", \"ConnectedDevice\", \"SetTopBox\". Values are case insensitive.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"dma":{"description":"Designated market area. Example: \"DMA501\" would be used for Nielsen DMA corresponding to New York, NY. Values are case insensitive.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"domain":{"description":"Domain of a site. Example: \"msn.com\" Values are case insensitive.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"negative":{"description":"Determines when the bidAdjustment is applied. Defaults to false. If specified as true, then it defines a\n     matched term as the scenario when the impression data has no matches with the specified dimensions (exactly zero) and will\n     only apply the bidAdjustment in this case.","type":"boolean"},"operatingSystem":{"description":"The operating system of the user viewing the page. Example: \"MacOS\", \"Windows\", \"iOS\", \"Android\", \"Fire OS\". Values are case insensitive.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"postalCode":{"description":"The postal code with 2-letter country code prefix, based on the IP address of the user. Use \u0027-\u0027 as a separator between country code and postal code. Example: US-90210, MX-16900, BR-03012, JP-100-0004. Values are case insensitive.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"region":{"description":"The geographical state, based on the IP address of the user. Values are case insensitive.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"slotPosition":{"description":"Whether the slot is above, or below the fold. Valid Values: \"ABOVE\", \"BELOW\", \"UNKNOWN\". Values are case insensitive.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"slotSize":{"description":"The slot\u0027s pixel size for the ad. This functions the same as the creative size with our slot-creative matching process. Example: 300x50.","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"supplySource":{"description":"The inventory supply source to be applied. Example: \"Amazon Publisher Direct\",\"Alexa\",\"MediaGrid\".","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"supplySourceType":{"description":"The inventory supply source type to be applied. Example: \"AMAZON_PUBLISHER_DIRECT\",\"AMAZON\",\"THIRD_PARTY_EXCHANGE\".","items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"termId":{"description":"A system generated identifier for the term starting from 1.","type":"number"}},"required":["bidAdjustment"],"type":"object"},"BidAdjustmentsServiceConcurrentModificationExceptionResponseContent":{"description":"Indicates that the request could not be completed because of a concurrent modification to the same resource. The request is safe to retry.","properties":{"message":{"description":"Error message indicating why the request may have failed.","minLength":1,"type":"string"}},"required":["message"],"type":"object"},"BidAdjustmentsServiceConflictExceptionResponseContent":{"description":"Indicates that updating or deleting a resource can cause an inconsistent state.","properties":{"message":{"description":"Error message indicating why the request may have failed.","minLength":1,"type":"string"}},"required":["message"],"type":"object"},"BidAdjustmentsServiceCreateBidAdjustmentRuleRequestContent":{"description":"Expected input for the CreateBidAdjustmentRuleInput operation. The maximum size\n for the bid adjustment rule is 1mb. Please reach out to ADSP if you require an exception to the 1mb size\n limit.","properties":{"adjustmentType":{"$ref":"#/components/schemas/BidAdjustmentsServiceRuleAdjustmentType"},"ruleDescription":{"description":"A meaningful description which captures the intent of the bid adjustment rule.","maxLength":1024,"minLength":1,"pattern":"^(?!\\s*$).+","type":"string"},"ruleExpression":{"$ref":"#/components/schemas/BidAdjustmentsServiceRuleExpression"}},"required":["ruleDescription","ruleExpression"],"type":"object"},"BidAdjustmentsServiceCreateBidAdjustmentRuleResponseContent":{"description":"Expected output for the CreateBidAdjustmentRuleOutput operation.","properties":{"adjustmentRuleId":{"description":"The newly created unique ID for the bid adjustment rule.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"required":["adjustmentRuleId"],"type":"object"},"BidAdjustmentsServiceGetBidAdjustmentRuleAssociationsRequestContent":{"description":"Expected input for reading details of a bid adjustment rule.","properties":{"maxResults":{"description":"The maximum number of results the caller wishes to receive. Min 5 / Max 1000. Default to 100.","maximum":1000,"minimum":5,"type":"number"},"nextToken":{"description":"A token that can be passed back to the same operation to get the next page of results.\n    If this field is missing, it means that there are no more results.","type":"string"},"showInactiveAssociations":{"description":"Set to true to see inactive associations. Default is false.","type":"boolean"}},"type":"object"},"BidAdjustmentsServiceGetBidAdjustmentRuleAssociationsResponseContent":{"description":"Expected input for reading details of a bid adjustment rule.","properties":{"associations":{"$ref":"#/components/schemas/BidAdjustmentsServiceAllBidAdjustmentRuleAssociations"},"nextToken":{"description":"A token that can be passed back to the same operation to get the next page of results,\n    missing indicates no more results.","type":"string"}},"required":["associations"],"type":"object"},"BidAdjustmentsServiceGetBidAdjustmentRuleResponseContent":{"description":"Expected output for reading details of a bid adjustment rule.","properties":{"active":{"description":"Bid adjustment rule is active/inactive.","type":"boolean"},"adjustmentRuleId":{"description":"The unique identifier for the bid adjustment rule.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"adjustmentType":{"$ref":"#/components/schemas/BidAdjustmentsServiceRuleAdjustmentType"},"dateCreated":{"description":"Date when bid adjustment rule was created. Time zone is UTC.","format":"date-time","type":"string"},"ruleDescription":{"description":"The name of the bid adjustment. No uniqueness requirements.","maxLength":1024,"minLength":1,"pattern":"^(?!\\s*$).+","type":"string"},"ruleExpression":{"$ref":"#/components/schemas/BidAdjustmentsServiceRuleExpression"},"versionActive":{"description":"Bid adjustment rule version is active/inactive.","type":"boolean"},"versionDateCreated":{"description":"Date when bid adjustment rule version was created. Time zone is UTC.","format":"date-time","type":"string"},"versionId":{"description":"A unique identifier representing the version of a bid adjustment rule.","pattern":"^[1-9][0-9]*$","type":"string"}},"required":["active","adjustmentRuleId","dateCreated","ruleDescription","ruleExpression","versionActive","versionDateCreated","versionId"],"type":"object"},"BidAdjustmentsServiceInternalServerExceptionResponseContent":{"description":"Indicates that the server encountered an unexpected error.","properties":{"message":{"description":"Error message indicating why the request may have failed.","minLength":1,"type":"string"}},"required":["message"],"type":"object"},"BidAdjustmentsServiceInvalidBidAdjustmentRuleExceptionResponseContent":{"description":"Indicates that the bid adjustment rule did not pass validations against the expected schema.","properties":{"message":{"description":"Error message indicating why the request may have failed.","minLength":1,"type":"string"}},"required":["message"],"type":"object"},"BidAdjustmentsServiceListBidAdjustmentRulesRequestContent":{"description":"Expected input for reading details of a bid adjustment rule associated with one or more adgroups.","properties":{"adGroupId":{"description":"List all bid adjustment rules associated with this adgroup. Mutually exclusive with adGroupIds.","maxLength":1024,"minLength":1,"pattern":"^(?!\\s*$).+","type":"string"},"adGroupIds":{"description":"List all bid adjustment rules associated with these adgroups. Mutually exclusive with adGroupId.","items":{"description":"The ad group id.","maxLength":1024,"minLength":1,"pattern":"^(?!\\s*$).+","type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"maxResults":{"description":"The maximum number of results the caller wishes to receive. Min 5 / Max 1000. Default to 100.","maximum":1000,"minimum":5,"type":"number"},"nextToken":{"description":"A token that can be passed back to the same operation to get the next page of results.\n    If this field is missing, it means that there are no more results.","type":"string"}},"type":"object"},"BidAdjustmentsServiceListBidAdjustmentRulesResponseContent":{"description":"Expected output for reading details of a bid adjustment rule associated with one or more adgroups.","properties":{"adjustmentRules":{"description":"List of bid adjustment rules","items":{"$ref":"#/components/schemas/BidAdjustmentsServiceBidAdjustmentRuleDetails"},"maxItems":1000,"minItems":0,"type":"array"},"nextToken":{"description":"A token that can be passed back to the same operation to get the next page of results,\n    missing indicates no more results.","type":"string"}},"type":"object"},"BidAdjustmentsServiceOnMultipleMatches":{"description":"The resolution method to determine the final bid adjustment amount when multiple bid adjustments match.","enum":["APPLY_PRODUCT"],"type":"string"},"BidAdjustmentsServiceResourceNotFoundExceptionResponseContent":{"description":"Indicates that the bid adjustment rule or associated metadata could not be found.","properties":{"message":{"description":"Error message indicating why the request may have failed.","minLength":1,"type":"string"}},"required":["message"],"type":"object"},"BidAdjustmentsServiceRetryRequestExceptionResponseContent":{"description":"Indicates that the request failed but may succeed if retried after the\n specified time in seconds.","properties":{"message":{"description":"Error message indicating why the request may have failed.","minLength":1,"type":"string"}},"required":["message"],"type":"object"},"BidAdjustmentsServiceRuleAdjustmentType":{"description":"The rule type of the bid adjustment, can be BID. Default is BID","enum":["BID"],"type":"string"},"BidAdjustmentsServiceRuleExpression":{"oneOf":[{"$ref":"#/components/schemas/BidAdjustmentsServiceBidModifierRuleExpression"}],"type":"object"},"BidAdjustmentsServiceSurpassedQuotaExceptionResponseContent":{"description":"Indicates the user has surpassed their quota for creating bid modifiers","properties":{"message":{"description":"Error message indicating why the request may have failed.","minLength":1,"type":"string"}},"required":["message"],"type":"object"},"BidAdjustmentsServiceThrottlingExceptionResponseContent":{"description":"Indicates that the request was denied due to too many requests from the same user. The\n request may be retried after the specified time in seconds.","properties":{"message":{"description":"Error message indicating why the request may have failed.","minLength":1,"type":"string"}},"required":["message"],"type":"object"},"BidAdjustmentsServiceUnauthorizedExceptionResponseContent":{"description":"Indicates the user is unauthorized to invoke this API.","properties":{"message":{"description":"Error message indicating why the request may have failed.","minLength":1,"type":"string"}},"required":["message"],"type":"object"},"BidAdjustmentsServiceUpdateBidAdjustmentRuleRequestContent":{"description":"Expected input for updating a bid adjustment rule","properties":{"adjustmentType":{"$ref":"#/components/schemas/BidAdjustmentsServiceRuleAdjustmentType"},"ruleDescription":{"description":"A meaningful description which captures the intent of the bid adjustment rule.","maxLength":1024,"minLength":1,"pattern":"^(?!\\s*$).+","type":"string"},"ruleExpression":{"$ref":"#/components/schemas/BidAdjustmentsServiceRuleExpression"}},"required":["ruleExpression"],"type":"object"},"BidAdjustmentsServiceUpdateBidAdjustmentRuleResponseContent":{"description":"Expected output for updating a bid adjustment rule.","properties":{"associations":{"$ref":"#/components/schemas/BidAdjustmentsServiceAllBidAdjustmentRuleAssociations"},"versionId":{"description":"Version ID of the updated bid adjustment rule. Starts with 1","pattern":"^[1-9][0-9]*$","type":"string"}},"required":["versionId"],"type":"object"},"BidAdjustmentsServiceValidationExceptionResponseContent":{"description":"Indicates that the caller has provided invalid inputs for request fields, or was missing required fields.","properties":{"message":{"description":"Error message indicating why the request may have failed.","minLength":1,"type":"string"}},"required":["message"],"type":"object"},"BidAdjustmentsServiceadjustmentType":{"description":"The type of rules to return. Possible values: ALL, BID. Default: BID","enum":["ALL","BID"],"type":"string"}},"securitySchemes":{}},"info":{"description":"\u003cp\u003eThis service enables advertisers to create/read/delete bid adjustments and assign them to ad groups.\u003c/p\u003e \u003cp\u003eThe bid adjustments API replaces the \u003ca href\u003d\\\"https://advertising.amazon.com/API/docs/en-us/dsp-bid-modifiers-open-beta\\\"\u003ebid modifiers API\u003c/a\u003e, which is now on a deprecation path.\u003c/p\u003e \u003cul\u003e     \u003cli\u003e\u003ca href\u003d\\\"https://advertising.amazon.com/API/docs/en-us/guides/dsp/bid-adjustments/overview\\\"\u003eBid Adjustments Overview\u003c/a\u003e\u003c/li\u003e     \u003cli\u003e\u003ca href\u003d\\\"https://advertising.amazon.com/API/docs/en-us/guides/dsp/bid-adjustments/getting-started\\\"\u003eGet Started with Bid Adjustments API\u003c/a\u003e\u003c/li\u003e     \u003cli\u003e\u003ca href\u003d\\\"https://advertising.amazon.com/API/docs/en-us/guides/dsp/bid-adjustments/guide\\\"\u003eHow Does the Bid Adjustments API Work?\u003c/a\u003e\u003c/li\u003e     \u003cli\u003e\u003ca href\u003d\\\"https://advertising.amazon.com/API/docs/en-us/guides/dsp/bid-adjustments/dimensions\\\"\u003eBid Adjustments Dimensions\u003c/a\u003e\u003c/li\u003e     \u003cli\u003e\u003ca href\u003d\\\"https://advertising.amazon.com/API/docs/en-us/guides/dsp/bid-adjustments/best-practices\\\"\u003eTips and Best Practices\u003c/a\u003e\u003c/li\u003e     \u003cli\u003e\u003ca href\u003d\\\"https://advertising.amazon.com/API/docs/en-us/guides/dsp/bid-adjustments/frequently-asked-questions\\\"\u003eFAQs\u003c/a\u003e\u003c/li\u003e \u003c/ul\u003e","title":"Bid Adjustments","version":"3.0"},"openapi":"3.0.1","paths":{"/dsp/rules/adjustments":{"post":{"description":"Creates a bid adjustment rule and returns a unique ID which can be used to associate the bid adjustment rule with adgroups.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"CreateBidAdjustmentRule","parameters":[{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","examples":{"CreateBidAdjustmentRule_example1":{"description":"This example shows how you can create a bid adjustment rule with deviceType and browser dimensions.","summary":"Example of creating a new bid adjustment rule.","value":"2131241234"},"CreateBidAdjustmentRule_example2":{"description":"This example shows the expected error when invalid dimensions are used to create a bid adjustment rule.","summary":"Error example for creating a bid adjustment rule with invalid dimension","value":"123456789110"}},"in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","minLength":1,"type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"CreateBidAdjustmentRule_example1":{"description":"This example shows how you can create a bid adjustment rule with deviceType and browser dimensions.","summary":"Example of creating a new bid adjustment rule.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"CreateBidAdjustmentRule_example2":{"description":"This example shows the expected error when invalid dimensions are used to create a bid adjustment rule.","summary":"Error example for creating a bid adjustment rule with invalid dimension","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"}},"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","minLength":1,"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","examples":{"CreateBidAdjustmentRule_example1":{"description":"This example shows how you can create a bid adjustment rule with deviceType and browser dimensions.","summary":"Example of creating a new bid adjustment rule.","value":"1123344556677889"},"CreateBidAdjustmentRule_example2":{"description":"This example shows the expected error when invalid dimensions are used to create a bid adjustment rule.","summary":"Error example for creating a bid adjustment rule with invalid dimension","value":"1123344556677889"}},"in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","minLength":1,"type":"string"}}],"requestBody":{"content":{"application/vnd.dspbidadjuster.v1+json":{"examples":{"CreateBidAdjustmentRule_example1":{"description":"This example shows how you can create a bid adjustment rule with deviceType and browser dimensions.","summary":"Example of creating a new bid adjustment rule.","value":{"adjustmentType":"BID","ruleDescription":"Device and browser based bid adjustment rule","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","deviceType":["TABLET"],"negative":"true"},{"bidAdjustment":"1.2","browser":["Chrome","Safari"]}]}}},"CreateBidAdjustmentRule_example2":{"description":"This example shows the expected error when invalid dimensions are used to create a bid adjustment rule.","summary":"Error example for creating a bid adjustment rule with invalid dimension","value":{"adjustmentType":"BID","ruleDescription":"Time window based bid adjustment rule","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","negative":"true","timeWindow":["InvalidValue"]}]}}}},"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceCreateBidAdjustmentRuleRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.dspbidadjuster.v1+json":{"examples":{"CreateBidAdjustmentRule_example1":{"description":"This example shows how you can create a bid adjustment rule with deviceType and browser dimensions.","summary":"Example of creating a new bid adjustment rule.","value":{"adjustmentRuleId":"76e39e87-1932-4627-addb-4fe37496239e"}}},"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceCreateBidAdjustmentRuleResponseContent"}}},"description":"CreateBidAdjustmentRule 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceSurpassedQuotaExceptionResponseContent"}}},"description":"SurpassedQuotaException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"422":{"content":{"application/json":{"examples":{"CreateBidAdjustmentRule_example2":{"description":"This example shows the expected error when invalid dimensions are used to create a bid adjustment rule.","summary":"Error example for creating a bid adjustment rule with invalid dimension","value":{"message":"timeWindow is not a supported dimension. Please refer to the documentation for the supported dimensions."}}},"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceInvalidBidAdjustmentRuleExceptionResponseContent"}}},"description":"InvalidBidAdjustmentRuleException 422 response"},"423":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceConcurrentModificationExceptionResponseContent"}}},"description":"ConcurrentModificationException 423 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceRetryRequestExceptionResponseContent"}}},"description":"RetryRequestException 503 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","required":true,"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}}},"tags":["BidAdjustmentRules"]}},"/dsp/rules/adjustments/list":{"post":{"description":"Returns a list of active bid adjustment rule(s) belonging to the Ads AccountId specified. You may use\nadGroupId or adGroupIds (mutually exclusive) in request body to return a list of active bid adjustment rule(s) filtered by an associated,\ndisassociated, audienceViolating adgroup(s). If you would like to see all past bid adjustment associations set active flag to false.\nUse includeRuleExpression to control whether rule expressions are included in the response.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"ListBidAdjustmentRules","parameters":[{"description":"Set to false to see previously associated bid adjustment rules. Default is true.","in":"query","name":"active","schema":{"description":"Set to false to see previously associated bid adjustment rules. Default is true.","type":"boolean"}},{"description":"The type of rules to return. Possible values: ALL, BID. Default: BID","in":"query","name":"adjustmentType","schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceadjustmentType"}},{"description":"Controls whether bid adjustment rule expressions are included in the response. Set to false to omit bid adjustment rule expressions in response. Default is true.","examples":{"ListBidAdjustmentRules_example2":{"description":"This example demonstrates how to retrieve bid adjustment rules without including their rule expressions.","summary":"Example of listing bid adjustment rules without rule expressions","value":"false"},"ListBidAdjustmentRules_example3":{"description":"This example demonstrates retrieving bid adjustment rules associated with multiple ad groups.","summary":"Example of listing bid adjustment rules for multiple ad groups","value":"false"},"ListBidAdjustmentRules_example4":{"description":"This example demonstrates a bid adjustment rule that has no active, inactive, or audience-violating associations","summary":"Example of a bid adjustment rule with no associated ad groups","value":"true"}},"in":"query","name":"includeRuleExpression","schema":{"description":"Controls whether bid adjustment rule expressions are included in the response. Set to false to omit bid adjustment rule expressions in response. Default is true.","type":"boolean"}},{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","examples":{"ListBidAdjustmentRules_example1":{"description":"This example shows the expected output when retrieving bid adjustment rules using the adGroupId\n      filter.","summary":"Example of listing bid adjustment rules using specific filters.","value":"2131241234"},"ListBidAdjustmentRules_example2":{"description":"This example demonstrates how to retrieve bid adjustment rules without including their rule expressions.","summary":"Example of listing bid adjustment rules without rule expressions","value":"2131241234"},"ListBidAdjustmentRules_example3":{"description":"This example demonstrates retrieving bid adjustment rules associated with multiple ad groups.","summary":"Example of listing bid adjustment rules for multiple ad groups","value":"2131241234"},"ListBidAdjustmentRules_example4":{"description":"This example demonstrates a bid adjustment rule that has no active, inactive, or audience-violating associations","summary":"Example of a bid adjustment rule with no associated ad groups","value":"2131241234"}},"in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","minLength":1,"type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"ListBidAdjustmentRules_example1":{"description":"This example shows the expected output when retrieving bid adjustment rules using the adGroupId\n      filter.","summary":"Example of listing bid adjustment rules using specific filters.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"ListBidAdjustmentRules_example2":{"description":"This example demonstrates how to retrieve bid adjustment rules without including their rule expressions.","summary":"Example of listing bid adjustment rules without rule expressions","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"ListBidAdjustmentRules_example3":{"description":"This example demonstrates retrieving bid adjustment rules associated with multiple ad groups.","summary":"Example of listing bid adjustment rules for multiple ad groups","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"ListBidAdjustmentRules_example4":{"description":"This example demonstrates a bid adjustment rule that has no active, inactive, or audience-violating associations","summary":"Example of a bid adjustment rule with no associated ad groups","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"}},"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","minLength":1,"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","examples":{"ListBidAdjustmentRules_example1":{"description":"This example shows the expected output when retrieving bid adjustment rules using the adGroupId\n      filter.","summary":"Example of listing bid adjustment rules using specific filters.","value":"1123344556677889"},"ListBidAdjustmentRules_example2":{"description":"This example demonstrates how to retrieve bid adjustment rules without including their rule expressions.","summary":"Example of listing bid adjustment rules without rule expressions","value":"1123344556677889"},"ListBidAdjustmentRules_example3":{"description":"This example demonstrates retrieving bid adjustment rules associated with multiple ad groups.","summary":"Example of listing bid adjustment rules for multiple ad groups","value":"1123344556677889"},"ListBidAdjustmentRules_example4":{"description":"This example demonstrates a bid adjustment rule that has no active, inactive, or audience-violating associations","summary":"Example of a bid adjustment rule with no associated ad groups","value":"1123344556677889"}},"in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","minLength":1,"type":"string"}}],"requestBody":{"content":{"application/vnd.dspbidadjuster.v1+json":{"examples":{"ListBidAdjustmentRules_example1":{"description":"This example shows the expected output when retrieving bid adjustment rules using the adGroupId\n      filter.","summary":"Example of listing bid adjustment rules using specific filters.","value":{"adGroupId":543123123123121}},"ListBidAdjustmentRules_example2":{"description":"This example demonstrates how to retrieve bid adjustment rules without including their rule expressions.","summary":"Example of listing bid adjustment rules without rule expressions","value":{"adGroupId":543123123123121}},"ListBidAdjustmentRules_example3":{"description":"This example demonstrates retrieving bid adjustment rules associated with multiple ad groups.","summary":"Example of listing bid adjustment rules for multiple ad groups","value":{"adGroupIds":["543123123123121","543123123123122","543123123123123"]}},"ListBidAdjustmentRules_example4":{"description":"This example demonstrates a bid adjustment rule that has no active, inactive, or audience-violating associations","summary":"Example of a bid adjustment rule with no associated ad groups"}},"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceListBidAdjustmentRulesRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.dspbidadjuster.v1+json":{"examples":{"ListBidAdjustmentRules_example1":{"description":"This example shows the expected output when retrieving bid adjustment rules using the adGroupId\n      filter.","summary":"Example of listing bid adjustment rules using specific filters.","value":{"adjustmentRules":[{"active":"true","adjustmentRuleId":"76e39e87-1932-4627-addb-4fe37496239e","adjustmentType":"BID","associations":{"activeAssociations":{"adGroupIds":["543123123123121"]}},"dateCreated":"2023-10-10T18:08:04.140Z","ruleDescription":"Bid adjustment rule for cities and ad formats.","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","city":["New York"],"termId":"1"},{"adFormat":["DISPLAY","VIDEO"],"bidAdjustment":"1.2","termId":"2"}]},"termCount":"2","versionDateCreated":"2023-10-10T18:08:04.140Z","versionId":"1"}]}},"ListBidAdjustmentRules_example2":{"description":"This example demonstrates how to retrieve bid adjustment rules without including their rule expressions.","summary":"Example of listing bid adjustment rules without rule expressions","value":{"adjustmentRules":[{"active":"true","adjustmentRuleId":"11223344-5566-7788-99aa-bbccddeeff00","associations":{"activeAssociations":{"adGroupIds":["543123123123121"]}},"dateCreated":"2023-12-01T09:00:00.000Z","ruleDescription":"Bid adjustment rule without expression","termCount":"4","versionDateCreated":"2023-12-01T09:00:00.000Z","versionId":"1"}]}},"ListBidAdjustmentRules_example3":{"description":"This example demonstrates retrieving bid adjustment rules associated with multiple ad groups.","summary":"Example of listing bid adjustment rules for multiple ad groups","value":{"adjustmentRules":[{"active":"true","adjustmentRuleId":"11223344-5566-7788-99aa-bbccddeeff01","associations":{"activeAssociations":{"adGroupIds":["543123123123121"]},"audienceViolations":{"adGroupIds":["543123123123123"]},"inactiveAssociations":{"adGroupIds":["543123123123122"]}},"dateCreated":"2023-11-15T10:30:00.000Z","ruleDescription":"Bid adjustment rule for multiple ad groups","termCount":"3","versionDateCreated":"2023-11-15T10:30:00.000Z","versionId":"1"}]}},"ListBidAdjustmentRules_example4":{"description":"This example demonstrates a bid adjustment rule that has no active, inactive, or audience-violating associations","summary":"Example of a bid adjustment rule with no associated ad groups","value":{"adjustmentRules":[{"active":"true","adjustmentRuleId":"11223344-5566-7788-99aa-bbccddeeff05","adjustmentType":"BID","associations":{"activeAssociations":{"adGroupIds":[]}},"dateCreated":"2023-11-15T10:30:00.000Z","ruleDescription":"Bid adjustment rule for multiple ad groups","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","deviceType":["TABLET"],"negative":"true","termId":"1"},{"bidAdjustment":"1.2","browser":["Chrome","Safari"],"termId":"2"},{"bidAdjustment":"1.2","postalCode":["US-10001"],"termId":"3"}]},"termCount":"3","versionDateCreated":"2023-11-15T10:30:00.000Z","versionId":"1"}]}}},"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceListBidAdjustmentRulesResponseContent"}}},"description":"ListBidAdjustmentRules 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceRetryRequestExceptionResponseContent"}}},"description":"RetryRequestException 503 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","required":true,"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}}},"tags":["BidAdjustmentRules"]}},"/dsp/rules/adjustments/{adjustmentRuleId}":{"delete":{"description":"Deletes a bid adjustment rule if it is not currently associated with adgroups. After deletion, the bid\n adjustment rule can no longer be associated with any adgroups. If the bid adjustment rule is currently assigned to adgroups,\n  the API will return a ConflictException, and the rule must first be dissociated from all adgroups prior to deletion.\n  Use DeleteBidAdjustmentRuleAssociation API request to remove a bid adjustment rule from an adgroup. \n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"DeleteBidAdjustmentRule","parameters":[{"description":"The unique identifier for the bid adjustment rule.","examples":{"DeleteBidAdjustmentRule_example1":{"description":"This example shows how to delete an active bid adjustment rule using the ID.","summary":"Example of deleting an active bid adjustment rule.","value":"76e39e87-1932-4627-addb-4fe37496239e"}},"in":"path","name":"adjustmentRuleId","required":true,"schema":{"description":"The unique identifier for the bid adjustment rule.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","examples":{"DeleteBidAdjustmentRule_example1":{"description":"This example shows how to delete an active bid adjustment rule using the ID.","summary":"Example of deleting an active bid adjustment rule.","value":"2131241234"}},"in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","minLength":1,"type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"DeleteBidAdjustmentRule_example1":{"description":"This example shows how to delete an active bid adjustment rule using the ID.","summary":"Example of deleting an active bid adjustment rule.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"}},"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","minLength":1,"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","examples":{"DeleteBidAdjustmentRule_example1":{"description":"This example shows how to delete an active bid adjustment rule using the ID.","summary":"Example of deleting an active bid adjustment rule.","value":"1123344556677889"}},"in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","minLength":1,"type":"string"}}],"responses":{"200":{"description":"DeleteBidAdjustmentRule 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceConflictExceptionResponseContent"}}},"description":"ConflictException 409 response"},"423":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceConcurrentModificationExceptionResponseContent"}}},"description":"ConcurrentModificationException 423 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceRetryRequestExceptionResponseContent"}}},"description":"RetryRequestException 503 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","required":true,"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}}},"tags":["BidAdjustmentRules"]},"get":{"description":"Returns all data about a bid adjustment rule using its unique ID. The unique ID (UUID) is returned by\nCreateBidAdjustmentRule API request. This endpoint should be used to retrieve specific details about an active bid\nadjustment rule, such as description, dimensions and bid adjustments.By default, returns latest rule version if no version ID is provided.\nIf both rule ID and version ID are provided, returns the specific version requested\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"GetBidAdjustmentRule","parameters":[{"description":"The unique identifier for the bid adjustment rule.","examples":{"GetBidAdjustmentRule_example1":{"description":"This example shows the expected output when retrieving the most recent version of bid adjustment rule","summary":"Example of retrieving a bid adjustment rule version by a bid adjustment rule Id.","value":"76e39e87-1932-4627-addb-4fe37496239e"},"GetBidAdjustmentRule_example2":{"description":"This example shows the expected output when retrieving the most recent version of bid adjustment rule is version 1","summary":"Example of retrieving a bid adjustment rule version details by a bid adjustment rule Id","value":"76e39e87-1932-4627-addb-4fe37496239e"},"GetBidAdjustmentRule_example3":{"description":"This example shows the expected output when retrieving a specific version of bid adjustment rule","summary":"Example of retrieving a specific version of bid adjustment rule by a bid adjustment rule Id and version ID","value":"76e39e87-1932-4627-addb-4fe37496239e"},"GetBidAdjustmentRule_example4":{"description":"This example shows the expected error when retrieving a bid adjustment rule where the ID is incorrect.","summary":"Error example for retrieving a bid adjustment rule that does not exist.","value":"87e56e87-1932-4627-addb-4fe37496239e"}},"in":"path","name":"adjustmentRuleId","required":true,"schema":{"description":"The unique identifier for the bid adjustment rule.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},{"description":"Optional. Retrieves specific version of the bid adjustment rule. If not provided, returns the latest version.","examples":{"GetBidAdjustmentRule_example3":{"description":"This example shows the expected output when retrieving a specific version of bid adjustment rule","summary":"Example of retrieving a specific version of bid adjustment rule by a bid adjustment rule Id and version ID","value":"4"}},"in":"query","name":"versionId","schema":{"description":"Optional. Retrieves specific version of the bid adjustment rule. If not provided, returns the latest version.","pattern":"^[1-9][0-9]*$","type":"string"}},{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","examples":{"GetBidAdjustmentRule_example1":{"description":"This example shows the expected output when retrieving the most recent version of bid adjustment rule","summary":"Example of retrieving a bid adjustment rule version by a bid adjustment rule Id.","value":"2131241234"},"GetBidAdjustmentRule_example2":{"description":"This example shows the expected output when retrieving the most recent version of bid adjustment rule is version 1","summary":"Example of retrieving a bid adjustment rule version details by a bid adjustment rule Id","value":"2131241234"},"GetBidAdjustmentRule_example3":{"description":"This example shows the expected output when retrieving a specific version of bid adjustment rule","summary":"Example of retrieving a specific version of bid adjustment rule by a bid adjustment rule Id and version ID","value":"2131241234"},"GetBidAdjustmentRule_example4":{"description":"This example shows the expected error when retrieving a bid adjustment rule where the ID is incorrect.","summary":"Error example for retrieving a bid adjustment rule that does not exist.","value":"123456789110"}},"in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","minLength":1,"type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"GetBidAdjustmentRule_example1":{"description":"This example shows the expected output when retrieving the most recent version of bid adjustment rule","summary":"Example of retrieving a bid adjustment rule version by a bid adjustment rule Id.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"GetBidAdjustmentRule_example2":{"description":"This example shows the expected output when retrieving the most recent version of bid adjustment rule is version 1","summary":"Example of retrieving a bid adjustment rule version details by a bid adjustment rule Id","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"GetBidAdjustmentRule_example3":{"description":"This example shows the expected output when retrieving a specific version of bid adjustment rule","summary":"Example of retrieving a specific version of bid adjustment rule by a bid adjustment rule Id and version ID","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"GetBidAdjustmentRule_example4":{"description":"This example shows the expected error when retrieving a bid adjustment rule where the ID is incorrect.","summary":"Error example for retrieving a bid adjustment rule that does not exist.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"}},"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","minLength":1,"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","examples":{"GetBidAdjustmentRule_example1":{"description":"This example shows the expected output when retrieving the most recent version of bid adjustment rule","summary":"Example of retrieving a bid adjustment rule version by a bid adjustment rule Id.","value":"1123344556677889"},"GetBidAdjustmentRule_example2":{"description":"This example shows the expected output when retrieving the most recent version of bid adjustment rule is version 1","summary":"Example of retrieving a bid adjustment rule version details by a bid adjustment rule Id","value":"1123344556677889"},"GetBidAdjustmentRule_example3":{"description":"This example shows the expected output when retrieving a specific version of bid adjustment rule","summary":"Example of retrieving a specific version of bid adjustment rule by a bid adjustment rule Id and version ID","value":"1123344556677889"},"GetBidAdjustmentRule_example4":{"description":"This example shows the expected error when retrieving a bid adjustment rule where the ID is incorrect.","summary":"Error example for retrieving a bid adjustment rule that does not exist.","value":"1123344556677889"}},"in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/vnd.dspbidadjuster.v1+json":{"examples":{"GetBidAdjustmentRule_example1":{"description":"This example shows the expected output when retrieving the most recent version of bid adjustment rule","summary":"Example of retrieving a bid adjustment rule version by a bid adjustment rule Id.","value":{"active":true,"adjustmentRuleId":"76e39e87-1932-4627-addb-4fe37496239e","adjustmentType":"BID","dateCreated":"2023-10-10T18:08:04.140Z","ruleDescription":"Device Based bid adjustment rule","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","deviceType":["TABLET"],"negative":"true","termId":"1"}]},"versionActive":true,"versionDateCreated":"2023-10-11T18:08:04.140Z","versionId":2}},"GetBidAdjustmentRule_example2":{"description":"This example shows the expected output when retrieving the most recent version of bid adjustment rule is version 1","summary":"Example of retrieving a bid adjustment rule version details by a bid adjustment rule Id","value":{"active":true,"adjustmentRuleId":"76e39e87-1932-4627-addb-4fe37496239e","adjustmentType":"BID","dateCreated":"2023-10-10T18:08:04.140Z","ruleDescription":"Device Based bid adjustment rule","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","deviceType":["TABLET"],"negative":"true","termId":"1"}]},"versionActive":true,"versionDateCreated":"2023-10-10T18:08:04.140Z","versionId":1}},"GetBidAdjustmentRule_example3":{"description":"This example shows the expected output when retrieving a specific version of bid adjustment rule","summary":"Example of retrieving a specific version of bid adjustment rule by a bid adjustment rule Id and version ID","value":{"active":true,"adjustmentRuleId":"76e39e87-1932-4627-addb-4fe37496239e","adjustmentType":"BID","dateCreated":"2023-10-10T18:08:04.140Z","ruleDescription":"Device Based bid adjustment rule - version 4","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","deviceType":["TABLET"],"negative":"true","termId":"1"}]},"versionActive":false,"versionDateCreated":"2023-10-19T18:08:04.140Z","versionId":4}}},"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceGetBidAdjustmentRuleResponseContent"}}},"description":"GetBidAdjustmentRule 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"examples":{"GetBidAdjustmentRule_example4":{"description":"This example shows the expected error when retrieving a bid adjustment rule where the ID is incorrect.","summary":"Error example for retrieving a bid adjustment rule that does not exist.","value":{"message":"No bid adjustment rule with id: \u002787e56e87-1932-4627-addb-4fe37496239e\u0027 found."}}},"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceRetryRequestExceptionResponseContent"}}},"description":"RetryRequestException 503 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","required":true,"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}}},"tags":["BidAdjustmentRules"]},"patch":{"description":"Updates the bid adjustment rule and return rule version ID. All adGroups currently associated with\nthe rule will associate to the new version. The previous version of the rule becomes inactive. Rule expression must be provided to update\na rule\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"UpdateBidAdjustmentRule","parameters":[{"description":"The unique ID for the bid adjustment rule.","examples":{"UpdateBidAdjustmentRule_example1":{"description":"This example shows how to update a bid adjustment rule expression and rule description with active associations\n        and the response has rule version ID and the migrated associations","summary":"Example of updating both rule description and rule expression of an existing bid adjustment rule.","value":"6100981c-5f9f-489e-82ac-37661ca35747"},"UpdateBidAdjustmentRule_example2":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        the association status for some adGroups is pending evaluation","summary":"Example of updating an existing bid adjustment rule","value":"6100981c-5f9f-489e-82ac-37661ca35747"},"UpdateBidAdjustmentRule_example3":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        the association status for some adGroups is pending evaluation","summary":"Update only rule expression","value":"6100981c-5f9f-489e-82ac-37661ca35747"},"UpdateBidAdjustmentRule_example4":{"description":"This example shows how you can update a bid adjustment rule. The rule is updated but\n        the association status for all adGroups is in pending evaluation","summary":"Example of updating an existing bid adjustment rule","value":"6100981c-5f9f-489e-82ac-37661ca35747"},"UpdateBidAdjustmentRule_example5":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        their are no adGroup associations","summary":"Example of updating an existing bid adjustment rule","value":"6100981c-5f9f-489e-82ac-37661ca35747"}},"in":"path","name":"adjustmentRuleId","required":true,"schema":{"description":"The unique ID for the bid adjustment rule.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","examples":{"UpdateBidAdjustmentRule_example1":{"description":"This example shows how to update a bid adjustment rule expression and rule description with active associations\n        and the response has rule version ID and the migrated associations","summary":"Example of updating both rule description and rule expression of an existing bid adjustment rule.","value":"2131241234"},"UpdateBidAdjustmentRule_example2":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        the association status for some adGroups is pending evaluation","summary":"Example of updating an existing bid adjustment rule","value":"2131241234"},"UpdateBidAdjustmentRule_example3":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        the association status for some adGroups is pending evaluation","summary":"Update only rule expression","value":"2131241234"},"UpdateBidAdjustmentRule_example4":{"description":"This example shows how you can update a bid adjustment rule. The rule is updated but\n        the association status for all adGroups is in pending evaluation","summary":"Example of updating an existing bid adjustment rule","value":"2131241234"},"UpdateBidAdjustmentRule_example5":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        their are no adGroup associations","summary":"Example of updating an existing bid adjustment rule","value":"2131241234"}},"in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","minLength":1,"type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"UpdateBidAdjustmentRule_example1":{"description":"This example shows how to update a bid adjustment rule expression and rule description with active associations\n        and the response has rule version ID and the migrated associations","summary":"Example of updating both rule description and rule expression of an existing bid adjustment rule.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"UpdateBidAdjustmentRule_example2":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        the association status for some adGroups is pending evaluation","summary":"Example of updating an existing bid adjustment rule","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"UpdateBidAdjustmentRule_example3":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        the association status for some adGroups is pending evaluation","summary":"Update only rule expression","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"UpdateBidAdjustmentRule_example4":{"description":"This example shows how you can update a bid adjustment rule. The rule is updated but\n        the association status for all adGroups is in pending evaluation","summary":"Example of updating an existing bid adjustment rule","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"UpdateBidAdjustmentRule_example5":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        their are no adGroup associations","summary":"Example of updating an existing bid adjustment rule","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"}},"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","minLength":1,"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","examples":{"UpdateBidAdjustmentRule_example1":{"description":"This example shows how to update a bid adjustment rule expression and rule description with active associations\n        and the response has rule version ID and the migrated associations","summary":"Example of updating both rule description and rule expression of an existing bid adjustment rule.","value":"1123344556677889"},"UpdateBidAdjustmentRule_example2":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        the association status for some adGroups is pending evaluation","summary":"Example of updating an existing bid adjustment rule","value":"1123344556677889"},"UpdateBidAdjustmentRule_example3":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        the association status for some adGroups is pending evaluation","summary":"Update only rule expression","value":"1123344556677889"},"UpdateBidAdjustmentRule_example4":{"description":"This example shows how you can update a bid adjustment rule. The rule is updated but\n        the association status for all adGroups is in pending evaluation","summary":"Example of updating an existing bid adjustment rule","value":"1123344556677889"},"UpdateBidAdjustmentRule_example5":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        their are no adGroup associations","summary":"Example of updating an existing bid adjustment rule","value":"1123344556677889"}},"in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","minLength":1,"type":"string"}}],"requestBody":{"content":{"application/vnd.dspbidadjuster.v1+json":{"examples":{"UpdateBidAdjustmentRule_example1":{"description":"This example shows how to update a bid adjustment rule expression and rule description with active associations\n        and the response has rule version ID and the migrated associations","summary":"Example of updating both rule description and rule expression of an existing bid adjustment rule.","value":{"adjustmentType":"BID","ruleDescription":"Device and browser based bid adjustment rule - v2","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","deviceType":["TABLET"],"negative":"true"},{"bidAdjustment":"1.2","browser":["Chrome","Safari"]}]}}},"UpdateBidAdjustmentRule_example2":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        the association status for some adGroups is pending evaluation","summary":"Example of updating an existing bid adjustment rule","value":{"ruleDescription":"version 2: Device and browser based bid adjustment rule","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","deviceType":["TABLET"],"negative":"true"},{"behavioralSegment":["12345","6789"],"bidAdjustment":"1.2"}]}}},"UpdateBidAdjustmentRule_example3":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        the association status for some adGroups is pending evaluation","summary":"Update only rule expression","value":{"adjustmentType":"BID","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"behavioralSegment":["12345","6789"],"bidAdjustment":"1.5"}]}}},"UpdateBidAdjustmentRule_example4":{"description":"This example shows how you can update a bid adjustment rule. The rule is updated but\n        the association status for all adGroups is in pending evaluation","summary":"Example of updating an existing bid adjustment rule","value":{"adjustmentType":"BID","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"behavioralSegment":["12345","6789"],"bidAdjustment":"1.5"}]}}},"UpdateBidAdjustmentRule_example5":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        their are no adGroup associations","summary":"Example of updating an existing bid adjustment rule","value":{"adjustmentType":"BID","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"behavioralSegment":["12345","6789"],"bidAdjustment":"1.5"}]}}}},"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceUpdateBidAdjustmentRuleRequestContent"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"UpdateBidAdjustmentRule_example1":{"description":"This example shows how to update a bid adjustment rule expression and rule description with active associations\n        and the response has rule version ID and the migrated associations","summary":"Example of updating both rule description and rule expression of an existing bid adjustment rule.","value":{"associations":{"activeAssociations":{"adGroupIds":["543123123123121","543123123123122"]}},"versionId":1}},"UpdateBidAdjustmentRule_example2":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        the association status for some adGroups is pending evaluation","summary":"Example of updating an existing bid adjustment rule","value":{"associations":{"activeAssociations":{"adGroupIds":["543123123123122"]},"pendingAssociations":{"adGroupIds":["543123123123121"]}},"versionId":1}},"UpdateBidAdjustmentRule_example3":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        the association status for some adGroups is pending evaluation","summary":"Update only rule expression","value":{"associations":{"activeAssociations":{"adGroupIds":["543123123123122"]},"pendingAssociations":{"adGroupIds":["543123123123121"]}},"versionId":4}},"UpdateBidAdjustmentRule_example4":{"description":"This example shows how you can update a bid adjustment rule. The rule is updated but\n        the association status for all adGroups is in pending evaluation","summary":"Example of updating an existing bid adjustment rule","value":{"associations":{"activeAssociations":{"adGroupIds":[]},"pendingAssociations":{"adGroupIds":["543123123123121","543123123123122"]}},"versionId":4}},"UpdateBidAdjustmentRule_example5":{"description":"This example shows how you can update a bid adjustment rule expression. The rule is updated but\n        their are no adGroup associations","summary":"Example of updating an existing bid adjustment rule","value":{"associations":{"activeAssociations":{"adGroupIds":[]}},"versionId":4}}},"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceUpdateBidAdjustmentRuleResponseContent"}}},"description":"UpdateBidAdjustmentRule 202 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceInvalidBidAdjustmentRuleExceptionResponseContent"}}},"description":"InvalidBidAdjustmentRuleException 422 response"},"423":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceConcurrentModificationExceptionResponseContent"}}},"description":"ConcurrentModificationException 423 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceRetryRequestExceptionResponseContent"}}},"description":"RetryRequestException 503 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","required":true,"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}}},"tags":["BidAdjustmentRules"]}},"/dsp/rules/adjustments/{adjustmentRuleId}/associations":{"delete":{"description":"Removes the association between bid adjustment rule and an adgroup, but does not delete the bid adjustment\nrule. The rule can still be associated with other adgroups. The API will remove the association immediately, but please\nnote that it can take ~1 hour for the removal to take place in the ADSP bidding system. The API throws a\nValidationException if an invalid adgroupId is provided.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"DeleteBidAdjustmentRuleAssociation","parameters":[{"description":"The unique identifier for the bid adjustment rule.","examples":{"DeleteBidAdjustmentRuleAssociation_example1":{"description":"This example shows deleting an active bid adjustment rule association from an adgroup.","summary":"Example of deleting an active bid adjustment rule association from an adgroup.","value":"6100981c-5f9f-489e-82ac-37661ca35747"}},"in":"path","name":"adjustmentRuleId","required":true,"schema":{"description":"The unique identifier for the bid adjustment rule.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},{"description":"The ad group id.","examples":{"DeleteBidAdjustmentRuleAssociation_example1":{"description":"This example shows deleting an active bid adjustment rule association from an adgroup.","summary":"Example of deleting an active bid adjustment rule association from an adgroup.","value":"5455344556677889"}},"in":"query","name":"adGroupId","schema":{"description":"The ad group id.","maxLength":1024,"minLength":1,"pattern":"^(?!\\s*$).+","type":"string"}},{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","examples":{"DeleteBidAdjustmentRuleAssociation_example1":{"description":"This example shows deleting an active bid adjustment rule association from an adgroup.","summary":"Example of deleting an active bid adjustment rule association from an adgroup.","value":"2131241234"}},"in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","minLength":1,"type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"DeleteBidAdjustmentRuleAssociation_example1":{"description":"This example shows deleting an active bid adjustment rule association from an adgroup.","summary":"Example of deleting an active bid adjustment rule association from an adgroup.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"}},"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","minLength":1,"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","examples":{"DeleteBidAdjustmentRuleAssociation_example1":{"description":"This example shows deleting an active bid adjustment rule association from an adgroup.","summary":"Example of deleting an active bid adjustment rule association from an adgroup.","value":"1123344556677889"}},"in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","minLength":1,"type":"string"}}],"responses":{"202":{"description":"DeleteBidAdjustmentRuleAssociation 202 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceConflictExceptionResponseContent"}}},"description":"ConflictException 409 response"},"423":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceConcurrentModificationExceptionResponseContent"}}},"description":"ConcurrentModificationException 423 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceRetryRequestExceptionResponseContent"}}},"description":"RetryRequestException 503 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","required":true,"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}}},"tags":["BidAdjustmentRules"]},"put":{"description":"Associates a bid adjustment rule with an adgroup. Association requests are fulfilled immediately,\nhowever it can take ~1 hour for the association to take place in the ADSP bidding system. If a prior association for\nthe adGroup exists, it will be overridden with a new association. You can use the ListBidAdjustmentRules that returns a\nlist of bid adjustment rule(s) filtered by associated adgroups to check if the adGroup already has a bid adjustment associated with.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"CreateBidAdjustmentRuleAssociation","parameters":[{"description":"The unique identifier for the bid adjustment rule.","examples":{"CreateBidAdjustmentRuleAssociation_example1":{"description":"This example shows how we can associate a bid adjustment rule with an adgroup","summary":"Example of associating a bid adjustment rule with an adgroup.","value":"6100981c-5f9f-489e-82ac-37661ca35747"}},"in":"path","name":"adjustmentRuleId","required":true,"schema":{"description":"The unique identifier for the bid adjustment rule.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},{"description":"The ad group id.","examples":{"CreateBidAdjustmentRuleAssociation_example1":{"description":"This example shows how we can associate a bid adjustment rule with an adgroup","summary":"Example of associating a bid adjustment rule with an adgroup.","value":"5455344556677889"}},"in":"query","name":"adGroupId","schema":{"description":"The ad group id.","maxLength":1024,"minLength":1,"pattern":"^(?!\\s*$).+","type":"string"}},{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","examples":{"CreateBidAdjustmentRuleAssociation_example1":{"description":"This example shows how we can associate a bid adjustment rule with an adgroup","summary":"Example of associating a bid adjustment rule with an adgroup.","value":"2131241234"}},"in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","minLength":1,"type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"CreateBidAdjustmentRuleAssociation_example1":{"description":"This example shows how we can associate a bid adjustment rule with an adgroup","summary":"Example of associating a bid adjustment rule with an adgroup.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"}},"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","minLength":1,"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","examples":{"CreateBidAdjustmentRuleAssociation_example1":{"description":"This example shows how we can associate a bid adjustment rule with an adgroup","summary":"Example of associating a bid adjustment rule with an adgroup.","value":"1123344556677889"}},"in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","minLength":1,"type":"string"}}],"responses":{"202":{"description":"CreateBidAdjustmentRuleAssociation 202 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceConflictExceptionResponseContent"}}},"description":"ConflictException 409 response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceInvalidBidAdjustmentRuleExceptionResponseContent"}}},"description":"InvalidBidAdjustmentRuleException 422 response"},"423":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceConcurrentModificationExceptionResponseContent"}}},"description":"ConcurrentModificationException 423 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceRetryRequestExceptionResponseContent"}}},"description":"RetryRequestException 503 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","required":true,"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}}},"tags":["BidAdjustmentRules"]}},"/dsp/rules/adjustments/{adjustmentRuleId}/associations/list":{"post":{"description":"Lists all active associations for a given bid adjustment Rule using its unique ID. You can use the\n showInactiveAssociations flag to see previous associations.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"GetBidAdjustmentRuleAssociations","parameters":[{"description":"The unique identifier for the bid adjustment rule.","examples":{"GetBidAdjustmentRuleAssociations_example1":{"description":"This example shows how to retrieve active bid adjustment rule associations when there are audience-violating associations.","summary":"Example of retrieving active bid adjustment rule associations.","value":"6100981c-5f9f-489e-82ac-37661ca35747"},"GetBidAdjustmentRuleAssociations_example2":{"description":"This example shows how to retrieve active bid adjustment rule associations when there are no audience-violating associations.","summary":"Example of retrieving active bid adjustment rule associations.","value":"6100981c-5f9f-489e-82ac-37661ca35747"},"GetBidAdjustmentRuleAssociations_example3":{"description":"This example shows how to retrieve inactive bid adjustment rule associations when there are audience-violating associations.","summary":"Example of retrieving inactive bid adjustment rule associations.","value":"6100981c-5f9f-489e-82ac-37661ca35747"}},"in":"path","name":"adjustmentRuleId","required":true,"schema":{"description":"The unique identifier for the bid adjustment rule.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","examples":{"GetBidAdjustmentRuleAssociations_example1":{"description":"This example shows how to retrieve active bid adjustment rule associations when there are audience-violating associations.","summary":"Example of retrieving active bid adjustment rule associations.","value":"2131241234"},"GetBidAdjustmentRuleAssociations_example2":{"description":"This example shows how to retrieve active bid adjustment rule associations when there are no audience-violating associations.","summary":"Example of retrieving active bid adjustment rule associations.","value":"2131241234"},"GetBidAdjustmentRuleAssociations_example3":{"description":"This example shows how to retrieve inactive bid adjustment rule associations when there are audience-violating associations.","summary":"Example of retrieving inactive bid adjustment rule associations.","value":"2131241234"}},"in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","minLength":1,"type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"GetBidAdjustmentRuleAssociations_example1":{"description":"This example shows how to retrieve active bid adjustment rule associations when there are audience-violating associations.","summary":"Example of retrieving active bid adjustment rule associations.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"GetBidAdjustmentRuleAssociations_example2":{"description":"This example shows how to retrieve active bid adjustment rule associations when there are no audience-violating associations.","summary":"Example of retrieving active bid adjustment rule associations.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"GetBidAdjustmentRuleAssociations_example3":{"description":"This example shows how to retrieve inactive bid adjustment rule associations when there are audience-violating associations.","summary":"Example of retrieving inactive bid adjustment rule associations.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"}},"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","minLength":1,"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","examples":{"GetBidAdjustmentRuleAssociations_example1":{"description":"This example shows how to retrieve active bid adjustment rule associations when there are audience-violating associations.","summary":"Example of retrieving active bid adjustment rule associations.","value":"1123344556677889"},"GetBidAdjustmentRuleAssociations_example2":{"description":"This example shows how to retrieve active bid adjustment rule associations when there are no audience-violating associations.","summary":"Example of retrieving active bid adjustment rule associations.","value":"1123344556677889"},"GetBidAdjustmentRuleAssociations_example3":{"description":"This example shows how to retrieve inactive bid adjustment rule associations when there are audience-violating associations.","summary":"Example of retrieving inactive bid adjustment rule associations.","value":"1123344556677889"}},"in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","minLength":1,"type":"string"}}],"requestBody":{"content":{"application/vnd.dspbidadjuster.v1+json":{"examples":{"GetBidAdjustmentRuleAssociations_example1":{"description":"This example shows how to retrieve active bid adjustment rule associations when there are audience-violating associations.","summary":"Example of retrieving active bid adjustment rule associations."},"GetBidAdjustmentRuleAssociations_example2":{"description":"This example shows how to retrieve active bid adjustment rule associations when there are no audience-violating associations.","summary":"Example of retrieving active bid adjustment rule associations."},"GetBidAdjustmentRuleAssociations_example3":{"description":"This example shows how to retrieve inactive bid adjustment rule associations when there are audience-violating associations.","summary":"Example of retrieving inactive bid adjustment rule associations.","value":{"showInactiveAssociations":true}}},"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceGetBidAdjustmentRuleAssociationsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.dspbidadjuster.v1+json":{"examples":{"GetBidAdjustmentRuleAssociations_example1":{"description":"This example shows how to retrieve active bid adjustment rule associations when there are audience-violating associations.","summary":"Example of retrieving active bid adjustment rule associations.","value":{"associations":{"activeAssociations":{"adGroupIds":["52325234234234","5425234234234"]},"audienceViolations":{"adGroupIds":["5425234234235"]}}}},"GetBidAdjustmentRuleAssociations_example2":{"description":"This example shows how to retrieve active bid adjustment rule associations when there are no audience-violating associations.","summary":"Example of retrieving active bid adjustment rule associations.","value":{"associations":{"activeAssociations":{"adGroupIds":["5425234234234"]}}}},"GetBidAdjustmentRuleAssociations_example3":{"description":"This example shows how to retrieve inactive bid adjustment rule associations when there are audience-violating associations.","summary":"Example of retrieving inactive bid adjustment rule associations.","value":{"associations":{"activeAssociations":{"adGroupIds":[]},"audienceViolations":{"adGroupIds":["5425234234234"]},"inactiveAssociations":{"adGroupIds":["5425234234235"]}}}}},"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceGetBidAdjustmentRuleAssociationsResponseContent"}}},"description":"GetBidAdjustmentRuleAssociations 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceThrottlingExceptionResponseContent"}}},"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidAdjustmentsServiceRetryRequestExceptionResponseContent"}}},"description":"RetryRequestException 503 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","required":true,"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}}},"tags":["BidAdjustmentRules"]}}}}