{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"BidModifiersServiceAccessDeniedExceptionResponseContent":{"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"},"BidModifiersServiceAllBidModifierRuleAssociations":{"description":"Returns active, inactive and audienceViolation associations for a bid adjustment rule:\n* activeAssociations: Ad groups currently associated with the rule\n* inactiveAssociations: Ad groups previously associated but now disassociated from the rule\n* audienceViolations: Ad groups automatically disassociated from the rule due to mismatch between the rule\u0027s audience criteria and ad group targeting setting","properties":{"activeAssociations":{"$ref":"#/components/schemas/BidModifiersServiceBidModifierRuleAssociations"},"audienceViolations":{"$ref":"#/components/schemas/BidModifiersServiceBidModifierRuleAssociations"},"inactiveAssociations":{"$ref":"#/components/schemas/BidModifiersServiceBidModifierRuleAssociations"}},"required":["activeAssociations"],"type":"object"},"BidModifiersServiceBidModifierRuleAssociations":{"properties":{"adGroupIds":{"items":{"description":"The ad group id.","maxLength":1024,"minLength":1,"pattern":"^(?!\\s*$).+","type":"string"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"BidModifiersServiceBidModifierRuleDetails":{"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"},"associations":{"$ref":"#/components/schemas/BidModifiersServiceAllBidModifierRuleAssociations"},"bidModifierRuleId":{"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"},"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/BidModifiersServiceBidModifierRuleExpression"},"termCount":{"description":"Number of terms present in the bid modifier rule.","maximum":1000,"minimum":1,"type":"number"}},"required":["active","associations","bidModifierRuleId","dateCreated","ruleDescription","termCount"],"type":"object"},"BidModifiersServiceBidModifierRuleExpression":{"properties":{"onMultipleMatches":{"$ref":"#/components/schemas/BidModifiersServiceOnMultipleMatches"},"terms":{"items":{"$ref":"#/components/schemas/BidModifiersServiceBidModifierTerm"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["terms"],"type":"object"},"BidModifiersServiceBidModifierTerm":{"description":"A bid adjustment 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 adjustment 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 adjustment 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 adjustment\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 adjustments. 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 mulitplied 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"},"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: BR-03012, US-90210, MX-16900, 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"},"termId":{"description":"A system generated identifier for the term starting from 1.","type":"number"}},"required":["bidAdjustment"],"type":"object"},"BidModifiersServiceConflictExceptionResponseContent":{"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"},"BidModifiersServiceCreateBidModifierRuleAssociationResponseContent":{"description":"Expected output for associating a bid adjustment rule with an adgroup.","properties":{"details":{"description":"Description of the API result.","type":"string"}},"required":["details"],"type":"object"},"BidModifiersServiceCreateBidModifierRuleRequestContent":{"description":"Expected input for the CreateBidModifierRuleInput 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":{"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/BidModifiersServiceBidModifierRuleExpression"}},"required":["ruleDescription","ruleExpression"],"type":"object"},"BidModifiersServiceCreateBidModifierRuleResponseContent":{"description":"Expected output for the CreateBidModifierRuleOutput operation.","properties":{"bidModifierRuleId":{"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":["bidModifierRuleId"],"type":"object"},"BidModifiersServiceDeleteBidModifierRuleAssociationResponseContent":{"description":"Expected output for dissociating a bid adjustment rule from an adgroup.","properties":{"details":{"description":"Description of the API result.","type":"string"}},"required":["details"],"type":"object"},"BidModifiersServiceDeleteBidModifierRuleResponseContent":{"description":"Expected output for DeleteBidModifierRule operation.","properties":{"details":{"description":"Description of the API result.","type":"string"}},"required":["details"],"type":"object"},"BidModifiersServiceGetBidModifierRuleAssociationsRequestContent":{"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"},"BidModifiersServiceGetBidModifierRuleAssociationsResponseContent":{"description":"Expected output for reading details of a bid adjustment rule.","properties":{"associations":{"$ref":"#/components/schemas/BidModifiersServiceAllBidModifierRuleAssociations"},"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"},"BidModifiersServiceGetBidModifierRuleResponseContent":{"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"},"bidModifierRuleId":{"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"},"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/BidModifiersServiceBidModifierRuleExpression"}},"required":["active","bidModifierRuleId","dateCreated","ruleDescription","ruleExpression"],"type":"object"},"BidModifiersServiceInternalServerExceptionResponseContent":{"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"},"BidModifiersServiceInvalidBidModifierRuleExceptionResponseContent":{"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"},"BidModifiersServiceListBidModifierRulesRequestContent":{"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 the single adGroupId passed. You can pass one of: single adGroupId or a list of adGroupIds.","maxLength":1024,"minLength":1,"pattern":"^(?!\\s*$).+","type":"string"},"adGroupIds":{"description":"List all bid adjustment rules associated with the list of adGroupIds passed. You can pass one of: single adGroupId or a list of adGroupIds.","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"},"BidModifiersServiceListBidModifierRulesResponseContent":{"description":"Expected output for reading details of a bid adjustment rule associated with one or more adgroups.","properties":{"bidModifierRules":{"description":"List of bid adjustment rules","items":{"$ref":"#/components/schemas/BidModifiersServiceBidModifierRuleDetails"},"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"},"BidModifiersServiceOnMultipleMatches":{"description":"The resolution method to determine the final bid adjustment amount when multiple bid adjustments match.","enum":["APPLY_PRODUCT"],"type":"string"},"BidModifiersServiceResourceNotFoundExceptionResponseContent":{"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"},"BidModifiersServiceRetryRequestExceptionResponseContent":{"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"},"BidModifiersServiceSurpassedQuotaExceptionResponseContent":{"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"},"BidModifiersServiceThrottlingExceptionResponseContent":{"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"},"BidModifiersServiceUnauthorizedExceptionResponseContent":{"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"},"BidModifiersServiceValidationExceptionResponseContent":{"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"}},"securitySchemes":{}},"info":{"description":"The ADSP bid modifiers API has been replaced by the new [bid adjustments API](https://advertising.amazon.com/API/docs/en-us/dsp-bid-adjustments).\u003cbr\u003eThe bid modifiers API is on a deprecation path, with a planned shut-off date of October 31, 2025.","title":"Bid Modifiers","version":"3.0"},"openapi":"3.0.1","paths":{"/dsp/rules/bidmodifier":{"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":"CreateBidModifierRule","parameters":[{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","examples":{"CreateBidModifierRule_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"},"CreateBidModifierRule_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":{"CreateBidModifierRule_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"},"CreateBidModifierRule_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":{"CreateBidModifierRule_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"},"CreateBidModifierRule_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.dspbidmodifier.v1+json":{"examples":{"CreateBidModifierRule_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":{"ruleDescription":"Device and browser based bid adjustment","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","deviceType":["TABLET"],"negative":"true"},{"bidAdjustment":"1.2","browser":["Chrome","Safari"]}]}}},"CreateBidModifierRule_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":{"ruleDescription":"Time window based bid adjustment","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","negative":"true","timeWindow":["InvalidValue"]}]}}}},"schema":{"$ref":"#/components/schemas/BidModifiersServiceCreateBidModifierRuleRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.dspbidmodifier.v1+json":{"examples":{"CreateBidModifierRule_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":{"bidModifierRuleId":"76e39e87-1932-4627-addb-4fe37496239e"}}},"schema":{"$ref":"#/components/schemas/BidModifiersServiceCreateBidModifierRuleResponseContent"}}},"description":"CreateBidModifierRule 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceSurpassedQuotaExceptionResponseContent"}}},"description":"SurpassedQuotaException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"422":{"content":{"application/json":{"examples":{"CreateBidModifierRule_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/BidModifiersServiceInvalidBidModifierRuleExceptionResponseContent"}}},"description":"InvalidBidModifierRuleException 422 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceThrottlingExceptionResponseContent"}}},"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/BidModifiersServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceRetryRequestExceptionResponseContent"}}},"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":["BidModifierRules"]}},"/dsp/rules/bidmodifier/list":{"post":{"description":"Returns a list of active bid adjustment rule(s) belonging to the specified Ads AccountId. You can use a single adGroupId in request body to return a list of active bid adjustment rule(s) filtered by an associated adgroup. Alternatively, you can use a list of adGroupIds in request body to return a list of active bid adjustment rule(s) filtered by the list of adGroups. The response will return association status of the adGroupIds to the bid adjustment rule(s).To view all past bid adjustment associations,set active flag to false. Use 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":"ListBidModifierRules","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":"Controls whether bid adjustment rule expressions are included in the response. Default is true. Set to false to omit bid adjustment rule expressions in response. ","examples":{"ListBidModifierRules_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"},"ListBidModifierRules_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"},"ListBidModifierRules_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. Default is true. Set to false to omit bid adjustment rule expressions in response.","type":"boolean"}},{"description":"The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","examples":{"ListBidModifierRules_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"},"ListBidModifierRules_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"},"ListBidModifierRules_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"},"ListBidModifierRules_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":{"ListBidModifierRules_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"},"ListBidModifierRules_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"},"ListBidModifierRules_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"},"ListBidModifierRules_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":{"ListBidModifierRules_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"},"ListBidModifierRules_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"},"ListBidModifierRules_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"},"ListBidModifierRules_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.dspbidmodifier.v1+json":{"examples":{"ListBidModifierRules_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}},"ListBidModifierRules_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}},"ListBidModifierRules_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"]}},"ListBidModifierRules_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/BidModifiersServiceListBidModifierRulesRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.dspbidmodifier.v1+json":{"examples":{"ListBidModifierRules_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":{"bidModifierRules":[{"active":"true","associations":{"activeAssociations":{"adGroupIds":["543123123123121"]}},"bidModifierRuleId":"76e39e87-1932-4627-addb-4fe37496239e","dateCreated":"2023-10-10T18:08:04.140Z","ruleDescription":"Bid adjustment rule for cities and ad formats.","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","deviceType":["TABLET"],"negative":"true","termId":"1"},{"bidAdjustment":"1.2","browser":["Chrome","Safari"],"termId":"2"}]},"termCount":"2"},{"active":"false","associations":{"activeAssociations":{"adGroupIds":[]},"inactiveAssociations":{"adGroupIds":["543123123123121"]}},"bidModifierRuleId":"20cad36c-4c5e-4352-befe-a50a9e5aabfe","dateCreated":"2023-09-05T18:08:04.140Z","ruleDescription":"Bid adjustment rule for devices and slot positions.","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"1.5","deviceType":["PHONE","TABLET"],"termId":"1"},{"bidAdjustment":"1.1","slotPosition":["ABOVE"],"termId":"2"}]},"termCount":"2"}]}},"ListBidModifierRules_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":{"bidModifierRules":[{"active":"true","associations":{"activeAssociations":{"adGroupIds":["543123123123121"]}},"bidModifierRuleId":"11223344-5566-7788-99aa-bbccddeeff00","dateCreated":"2023-12-01T09:00:00.000Z","ruleDescription":"Bid modifier rule without expression","termCount":"4"}]}},"ListBidModifierRules_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":{"bidModifierRules":[{"active":"true","associations":{"activeAssociations":{"adGroupIds":["543123123123121"]},"audienceViolations":{"adGroupIds":["543123123123123"]},"inactiveAssociations":{"adGroupIds":["543123123123122"]}},"bidModifierRuleId":"11223344-5566-7788-99aa-bbccddeeff01","dateCreated":"2023-11-15T10:30:00.000Z","ruleDescription":"Bid modifier rule for multiple ad groups","termCount":"3"}]}},"ListBidModifierRules_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":{"bidModifierRules":[{"active":"true","associations":{"activeAssociations":{"adGroupIds":[]}},"bidModifierRuleId":"11223344-5566-7788-99aa-bbccddeeff05","dateCreated":"2023-11-15T10:30:00.000Z","ruleDescription":"Bid modifier 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"}]}}},"schema":{"$ref":"#/components/schemas/BidModifiersServiceListBidModifierRulesResponseContent"}}},"description":"ListBidModifierRules 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceThrottlingExceptionResponseContent"}}},"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/BidModifiersServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceRetryRequestExceptionResponseContent"}}},"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":["BidModifierRules"]}},"/dsp/rules/bidmodifier/{bidModifierRuleId}":{"delete":{"description":"Deletes a bid adjustment rule if it is not currently associated with adgroups. After deletion, the bid\n modifier 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 DeleteBidModifierRuleAssociation 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":"DeleteBidModifierRule","parameters":[{"description":"The unique identifier for the bid adjustment rule.","examples":{"DeleteBidModifierRule_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":"bidModifierRuleId","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":{"DeleteBidModifierRule_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":{"DeleteBidModifierRule_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":{"DeleteBidModifierRule_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":{"content":{"application/vnd.dspbidmodifier.v1+json":{"examples":{"DeleteBidModifierRule_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":{"details":"Bid adjustment rule 2c7d792a-9fc5-467e-939e-b88f3efe8a72 successfully deleted."}}},"schema":{"$ref":"#/components/schemas/BidModifiersServiceDeleteBidModifierRuleResponseContent"}}},"description":"DeleteBidModifierRule 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceConflictExceptionResponseContent"}}},"description":"ConflictException 409 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceThrottlingExceptionResponseContent"}}},"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/BidModifiersServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceRetryRequestExceptionResponseContent"}}},"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":["BidModifierRules"]},"get":{"description":"Returns all data about a bid adjustment rule using its unique ID. The unique ID (UUID) is returned by\nCreateBidModifierRule API request. This endpoint should be used to retrieve specific details about an active bid\nmodifier rule, such as description, dimensions and bid adjustments. \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":"GetBidModifierRule","parameters":[{"description":"The unique identifier for the bid adjustment rule.","examples":{"GetBidModifierRule_example1":{"description":"This example shows the expected output when retrieving a bid adjustment rule by ID.","summary":"Example of creating a new bid adjustment rule.","value":"76e39e87-1932-4627-addb-4fe37496239e"},"GetBidModifierRule_example2":{"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":"bidModifierRuleId","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":{"GetBidModifierRule_example1":{"description":"This example shows the expected output when retrieving a bid adjustment rule by ID.","summary":"Example of creating a new bid adjustment rule.","value":"2131241234"},"GetBidModifierRule_example2":{"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":{"GetBidModifierRule_example1":{"description":"This example shows the expected output when retrieving a bid adjustment rule by ID.","summary":"Example of creating a new bid adjustment rule.","value":"amzn1.application-oa2-client.d23523d24fad2a0a2d16241f57183a7"},"GetBidModifierRule_example2":{"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":{"GetBidModifierRule_example1":{"description":"This example shows the expected output when retrieving a bid adjustment rule by ID.","summary":"Example of creating a new bid adjustment rule.","value":"1123344556677889"},"GetBidModifierRule_example2":{"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.dspbidmodifier.v1+json":{"examples":{"GetBidModifierRule_example1":{"description":"This example shows the expected output when retrieving a bid adjustment rule by ID.","summary":"Example of creating a new bid adjustment rule.","value":{"active":true,"bidModifierRuleId":"76e39e87-1932-4627-addb-4fe37496239e","dateCreated":"2023-10-10T18:08:04.140Z","ruleDescription":"Example bid adjustment rule","ruleExpression":{"onMultipleMatches":"APPLY_PRODUCT","terms":[{"bidAdjustment":"2","deviceType":["TABLET"],"negative":"true","termId":"1"},{"bidAdjustment":"1.2","browser":["Chrome","Safari"],"termId":"2"}]}}}},"schema":{"$ref":"#/components/schemas/BidModifiersServiceGetBidModifierRuleResponseContent"}}},"description":"GetBidModifierRule 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"examples":{"GetBidModifierRule_example2":{"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/BidModifiersServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceThrottlingExceptionResponseContent"}}},"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/BidModifiersServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceRetryRequestExceptionResponseContent"}}},"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":["BidModifierRules"]}},"/dsp/rules/bidmodifier/{bidModifierRuleId}/associations":{"delete":{"description":"Removes the association between bid adjustment rule and an adgroup, but does not delete the bid modifier\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":"DeleteBidModifierRuleAssociation","parameters":[{"description":"The unique identifier for the bid adjustment rule.","examples":{"DeleteBidModifierRuleAssociation_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":"bidModifierRuleId","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":{"DeleteBidModifierRuleAssociation_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":{"DeleteBidModifierRuleAssociation_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":{"DeleteBidModifierRuleAssociation_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":{"DeleteBidModifierRuleAssociation_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":{"content":{"application/json":{"examples":{"DeleteBidModifierRuleAssociation_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":{"details":"Bid adjustment rule 2c7d792a-9fc5-467e-939e-b88f3efe8a72 successfully disassociated from adGroupId 588935937256643223."}}},"schema":{"$ref":"#/components/schemas/BidModifiersServiceDeleteBidModifierRuleAssociationResponseContent"}}},"description":"DeleteBidModifierRuleAssociation 202 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceConflictExceptionResponseContent"}}},"description":"ConflictException 409 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceThrottlingExceptionResponseContent"}}},"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/BidModifiersServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceRetryRequestExceptionResponseContent"}}},"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":["BidModifierRules"]},"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 ListBidModifierRules that returns a\nlist of bid adjustment rule(s) filtered by associated adgroups to check if the adGroup already has a bid modifier 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_edit\"]","operationId":"CreateBidModifierRuleAssociation","parameters":[{"description":"The unique identifier for the bid adjustment rule.","examples":{"CreateBidModifierRuleAssociation_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":"bidModifierRuleId","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":{"CreateBidModifierRuleAssociation_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":{"CreateBidModifierRuleAssociation_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":{"CreateBidModifierRuleAssociation_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":{"CreateBidModifierRuleAssociation_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":{"content":{"application/json":{"examples":{"CreateBidModifierRuleAssociation_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":{"details":"Bid adjustment rule 2c7d792a-9fc5-467e-939e-b88f3efe8a72 successfully associated to adGroupId 588935937256643223"}}},"schema":{"$ref":"#/components/schemas/BidModifiersServiceCreateBidModifierRuleAssociationResponseContent"}}},"description":"CreateBidModifierRuleAssociation 202 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceConflictExceptionResponseContent"}}},"description":"ConflictException 409 response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceInvalidBidModifierRuleExceptionResponseContent"}}},"description":"InvalidBidModifierRuleException 422 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceThrottlingExceptionResponseContent"}}},"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/BidModifiersServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceRetryRequestExceptionResponseContent"}}},"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":["BidModifierRules"]}},"/dsp/rules/bidmodifier/{bidModifierRuleId}/associations/list":{"post":{"description":"Returns a list of adgroup associations (active, inactive and audienceViolation) for a given bid adjustment rule using its unique ID. To see previous associations that are disassociated, use the showInactiveAssociations\u003dTrue filter.\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":"GetBidModifierRuleAssociations","parameters":[{"description":"The unique identifier for the bid adjustment rule.","examples":{"GetBidModifierRuleAssociations_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"},"GetBidModifierRuleAssociations_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"},"GetBidModifierRuleAssociations_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":"bidModifierRuleId","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":{"GetBidModifierRuleAssociations_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"},"GetBidModifierRuleAssociations_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"},"GetBidModifierRuleAssociations_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":{"GetBidModifierRuleAssociations_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"},"GetBidModifierRuleAssociations_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"},"GetBidModifierRuleAssociations_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":{"GetBidModifierRuleAssociations_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"},"GetBidModifierRuleAssociations_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"},"GetBidModifierRuleAssociations_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.dspbidmodifier.v1+json":{"examples":{"GetBidModifierRuleAssociations_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."},"GetBidModifierRuleAssociations_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."},"GetBidModifierRuleAssociations_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/BidModifiersServiceGetBidModifierRuleAssociationsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.dspbidmodifier.v1+json":{"examples":{"GetBidModifierRuleAssociations_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"]}}}},"GetBidModifierRuleAssociations_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"]}}}},"GetBidModifierRuleAssociations_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/BidModifiersServiceGetBidModifierRuleAssociationsResponseContent"}}},"description":"GetBidModifierRuleAssociations 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceUnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceAccessDeniedExceptionResponseContent"}}},"description":"AccessDeniedException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceThrottlingExceptionResponseContent"}}},"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/BidModifiersServiceInternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifiersServiceRetryRequestExceptionResponseContent"}}},"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":["BidModifierRules"]}}}}