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

Oveview
API developers use the Amazon Ad Server (AAS) new API to create and execute additional verification reports programmatically.

  • The new verification API uses a different endpoint - https://adapi.sizmek.com/avc/
  • The new verification API methods allow you to create a SQL query from the AAS data table and execute your query.
  • The new verification API is an asynchronous request; you receive a response message, but do not receive the actual report directly.
  • Unlike reporting APIs, the new verification API does not use SFTP or email, but rather uses an S3 buckets. URL for the S3 buckets can be accessed programatically.
  • 30 Days data is available through the verification APIs. It may 48 hours for the data to be made available.

Note: Traffic data for the campaign becomes available through these APIs 48 hours after the ad impression was served.

Verification API workflow

Step 1: Create a SQL Query for the data you would need to get. Available SQL data table is provided here.
Step 2: Create a API request. Code examples provided here
Step 2: Submit the report request.
Step 3: Check for the status of the submitted request programmatically. (Sample code available here)

Verification API data tables

Verification API provides access to two data tables

  1. AAS Traffic data table
  2. AAS Invalid data table


AAS Traffic data table
The data table adserver_traffic includes impressions, clicks and interactions (video and viewability) from integrations with Search advertising platforms measured by AAS in EU.

 

Field Category Name Data Type Metric / Dimension Description Aggregation Threshold
Ad setup ad_format STRING Dimension Ad Format (in-banner, in-stream video, rich media, etc.). LOW
Ad setup ad_id LONG Dimension Ad ID, ad that is attached to a placement. LOW
Advertiser setup ad STRING Dimension Amazon Ad Server brand name. A single Amazon Ad Server advertiser can have multiple brands. One campaign can be associated to a single brand. LOW
Advertiser setup advertiser STRING Dimension Amazon Ad Server advertiser name. LOW
Advertiser setup advertiser_id LONG Dimension Amazon Ad Server advertiser ID. LOW
Campaign setup campaign STRING Dimension Amazon Ad Server Campaign Name, as appears in Ad Server (for display and search). LOW
Campaign setup campaign_id LONG Dimension Amazon Ad Server Campaign ID (internal Amazon Ad Server IDs for display and search). LOW
Click delivery info clicks LONG Metric Total clicks served, excluding GIVT. Includes all billable clicks served and tracked by Amazon Ad Server, among them click_sivt, click_ssai and click_noscript. NONE
Event (impression, Click, Interaction, Conversion) Delivery Info event_date DATE Dimension Event Date (Amazon Ad Server account time zone). LOW
Event (impression, Click, Interaction, Conversion) Delivery Info event_date_utc DATE Dimension Event Date (UTC). LOW
Event (impression, Click, Interaction, Conversion) Delivery Info event_day INTEGER Dimension Event Day of Month (Amazon Ad Server account time zone). LOW
Event (impression, Click, Interaction, Conversion) Delivery Info event_day_utc INTEGER Dimension Event Day of Month (UTC). LOW
Event (impression, Click, Interaction, Conversion) Delivery Info event_dt TIMESTAMP Dimension Event Timestamp (Amazon Ad Server account time zone). MEDIUM
Event (impression, Click, Interaction, Conversion) Delivery Info event_dt_hour TIMESTAMP Dimension Event Timestamp (Amazon Ad Server account time zone) Truncated to Hour. LOW
Event (impression, Click, Interaction, Conversion) Delivery Info event_dt_hour_utc TIMESTAMP Dimension Event Timestamp (UTC) Truncated to Hour. LOW
Event (impression, Click, Interaction, Conversion) Delivery Info event_dt_utc TIMESTAMP Dimension Event Timestamp (UTC). Example: 2019-06-18T03:45:55.000 MEDIUM
Event (impression, Click, Interaction, Conversion) Delivery Info event_hour INTEGER Dimension Event Hour of Day (Amazon Ad Server account time zone). LOW
Event (impression, Click, Interaction, Conversion) Delivery Info event_hour_utc INTEGER Dimension Event Hour of Day (UTC). LOW
Impression delivery info impressions LONG Metric Total impressions served, excluding GIVT. Includes all billable impressions served and tracked by Amazon Ad Server, among them impressions_sivt, impressions_ssai and impressions_noscript. NONE
Impression delivery info measurable_impressions LONG Metric Number of impressions served in campaigns that were enabled for viewability measurement. Note that only campaigns with verification data collection mode are measured for viewability. This metric will be 0 if campaign is not enabled for verification data collection. NONE
Impression delivery info recordable_impressions LONG Metric Number of impressions (out of measurable_impressions) that were successfully recorded for viewability evaluation. For example, viewability signal can't be collected for impression served in unfriendly iframe and so such impression won't be recorded for viewability. Note that this metric will be 0 if campaign is not enabled for verification data collection. NONE
Interaction info video_percentage_complete LONG Metric Average % of the video viewed. e.g. on avg video viewed to 47% of its completion. NONE
Interaction info video_played_100pc LONG Metric Number of times when video played to its full completion. NONE
Interaction info video_played_100pc_viewable LONG Metric Number of times when video played to its full completion and impression was viewable. NONE
Interaction info video_played_25pc LONG Metric Number of times when video played only to 25% of its completion. NONE
Interaction info video_played_25pc_viewable LONG Metric Number of times when video played only to 25% of its completion and impression was viewable. NONE
Interaction info video_played_50pc LONG Metric Number of times when video played only to 50% of its completion. NONE
Interaction info video_played_50pc_viewable LONG Metric Number of times when video played only to 50% of its completion and impression was viewable. NONE
Interaction info video_played_75pc LONG Metric Number of times when video played only to 75% of its completion. NONE
Interaction info video_played_75pc_viewable LONG Metric Number of times when video played only to 75% of its completion and impression was viewable. NONE
Impression delivery info viewable_impressions LONG Metric Number of viewable impression (IAB standard). Note, viewability signals collected only for campaigns where verification data collection mode was enabled. This metric will be 0 if campaign is not enabled for verification data collection.

NONE

 

 

 

 

 

 

AAS Invalid data table

The data table adserver_invalid_traffic includes invalidimpressions, invalidclicks and invalidviews from integrations with Search advertising platforms measured by AAS.

 

Field Category Name Data Type Metric / Dimension Description Aggregation Threshold
Ad setup ad_format STRING Dimension Ad Format (in-banner, in-stream video, rich media, etc.). LOW
Ad setup ad_id LONG Dimension Ad ID, ad that is attached to a placement. LOW
Advertiser setup ad STRING Dimension Amazon Ad Server brand name. A single Amazon Ad Server advertiser can have multiple brands. One campaign can be associated to a single brand. LOW
Advertiser setup advertiser STRING Dimension Amazon Ad Server advertiser name. LOW
Advertiser setup advertiser_id LONG Dimension Amazon Ad Server advertiser ID. LOW
Campaign setup campaign STRING Dimension Amazon Ad Server Campaign Name, as appears in Ad Server (for display and search). LOW
Campaign setup campaign_id LONG Dimension Amazon Ad Server Campaign ID (internal Amazon Ad Server IDs for display and search). LOW
Event (impression, Click, Interaction, Conversion) Delivery Info event_date DATE Dimension Event Date (Amazon Ad Server account time zone). LOW
Event (impression, Click, Interaction, Conversion) Delivery Info event_date_utc DATE Dimension Event Date (UTC). LOW
Impression delivery info invalid_clicks LONG Metric Total clicks served, excluding GIVT. Includes all billable clicks served and tracked by Amazon Ad Server, among them clicks_sivt, clicks_ssai and clicks_noscript. NONE
Impression delivery info invalid_impressions LONG Metric Total impressions served, excluding GIVT. Includes all billable impressions served and tracked by Amazon Ad Server, among them impressions_sivt, impressions_ssai and impressions_noscript. NONE
Impression delivery info invalidmeasurable\impressions LONG Metric Number of impressions served in campaigns that were enabled for viewability measurement. Note that only campaigns with verification data collection mode are measured for viewability. This metric will be 0 if campaign is not enabled for verification data collection. NONE
Impression delivery info invalidrecordable\impressions LONG Metric Number of impressions (out of measurable_impressions) that were successfully recorded for viewability evaluation. For example, viewability signal can't be collected for impression served in unfriendly iframe and so such impression won't be recorded for viewability. Note that this metric will be 0 if campaign is not enabled for verification data collection. NONE
Interaction info invalidvideo\percentage_complete LONG Metric Average % of the video viewed. e.g. on avg video viewed to 47% of its completion. NONE
Interaction info invalidvideo\played_100pc LONG Metric Number of times when video played to its full completion. NONE
Interaction info invalidvideo\played_100pc_viewable LONG Metric Number of times when video played to its full completion and impression was viewable. NONE
Interaction info invalidvideo\played_25pc LONG Metric Number of times when video played only to 25% of its completion. NONE
Interaction info invalidvideo\played_25pc_viewable LONG Metric Number of times when video played only to 25% of its completion and impression was viewable. NONE
Interaction info invalidvideo\played_50pc LONG Metric Number of times when video played only to 50% of its completion. NONE
Interaction info invalidvideo\played_50pc_viewable LONG Metric Number of times when video played only to 50% of its completion and impression was viewable. NONE
Interaction info invalidvideo\played_75pc LONG Metric Number of times when video played only to 75% of its completion. NONE
Interaction info invalidvideo\played_75pc_viewable LONG Metric Number of times when video played only to 75% of its completion and impression was viewable. NONE
Impression delivery info invalidviewable\impressions LONG Metric Number of viewable impression (IAB standard). Note, viewability signals collected only for campaigns where verification data collection mode was enabled. This metric will be 0 if campaign is not enabled for verification data collection. NONE

 

 

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

Comments