PRODUCT

Amazon Ad Server will be sunset in Q4 2024, please visit this page (AAS offboarding information) for offboarding support resources and sunset FAQs. Details shared on that page represent the most up to date information in the Help Center, if you find disparate information in other resources please default to the information in the AAS offboarding information page accordingly.

Follow

Related Entities

Endpoints Using the servingSetting Object

Parent Objects

servingSetting Object Definition

Note

Note: The Required column includes the following values:

  • Required: The field must be included in the POST call.

  • Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.

  • Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.

  • Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

Name

Description

Type

Required

Notes

type

Type of object.

String

Read-only

APIServingSetting

impressionsPerUser

Limits the number of ads seen by a user.

Integer

Required

No limit, value = -1

impressionsPerDay

Limits the number of ads seen by a user on the same day.

Integer

Required

No limit, value = -1

timeBetweenAds

Minimum amount of time between viewing two ads from a placement.

Integer

Required

No limit, value = -1

frequencyCappingLevel

Applies serving limits for each placement separately, or for an entire delivery group.

Boolean

Required

serveDefaultImage

Serves a default ad or image if there is no ad that AAS can serve, based on the rotation methods applied.

Boolean

Required

Object JSON Example

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments