analyticsSettings Object – API Help Center

Related Entities

Endpoints Using the analyticsSettings Object

Parent Objects

analyticsSettings 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 entity.	String	Read-only	AnalyticsSettings
ignoreOverDelivery	Ignores additional impressions (over the ordered amount) for cost calculations in ROI reports.	Boolean	Required
verificationMode	Defines the mode of verification data collection.	String	Required	View values NO_COLLECTION BASIC_COLLECTION ADVANCED_COLLECTION
viewabilityThreshold	Object that describes the viewability threshold fields.	viewabilityThreshold Object	Optional
instreamViewabilityThreshold	Object that describes the viewability threshold fields.	viewabilityThreshold Object	Optional

Object JSON Example

...},
"analyticsSettings": {
            "type": "AnalyticsSettings",
            "ignoreOverDelivery": true,
            "verificationMode": "NO_COLLECTION",
            "viewabilityThreshold": {
                "type": "ViewabilityThreshold",
                "minimumSurface": 50,
                "minimumDuration": 1
            },
            "instreamViewabilityThreshold": {
                "type": "ViewabilityThreshold",
                "minimumSurface": 50,
                "minimumDuration": 2
          }
      },...

viewabilityThreshold Object

Related Entities

Endpoints Using the viewabilityThreshold Object

Ad Resource

Parent Objects

analyticsSettings Object

viewabilityThreshold Object Definition

Parameter	Description	Type	Required	Notes
type	Type of entity.	String	Read-only	ViewabilityThreshold
minimumSurface	Percentage of the ad area required for an impression to be counted as viewable.	Integer	Required
minimumDuration	Number of seconds that the minimum surface must appear for an impression to be counted as viewable.	Integer	Required

Object JSON Example

Related Entities

Endpoints Using the analyticsSettings Object

Parent Objects

analyticsSettings Object Definition

Note

Object JSON Example

viewabilityThreshold Object

Related Entities

Endpoints Using the viewabilityThreshold Object

Parent Objects

viewabilityThreshold Object Definition

Object JSON Example

Comments