Collecting data from Amazon Ad Server

This guide explains how to collect data from Amazon Ad Server. To learn how to collect data from a different data source, go back to the Available data sources in Adverity overview.

Introduction

For a list of the fields that you can collect from Amazon Ad Server, see Amazon Ad Server.

The Amazon Ad Server connector was previously known as Sizmek SAS.

  • Amazon Ad Server can collect a maximum of 1 million rows per single report. To fetch more data than this, split your fetch into smaller date ranges in the Initial Fetch step of creating a datastream.

Prerequisites

Before you start collecting data from Amazon Ad Server, perform all of the following actions:

  • Contact Amazon Ad Server support to acquire the following credentials:

    • Username

    • Password

    • API Key

For more information on the Amazon Ad Sever API, see the Amazon Ad Server documentation.

Creating a datastream to collect data from Amazon Ad Server

The basics of creating a datastream to collect data from any data source are explained in our guide to Creating a datastream. This guide contains information about the specific steps to create a datastream to fetch data from Amazon Ad Server.

Authorization: Allow Adverity to access Amazon Ad Server

  1. If you choose Access using your credentials or Access using someone else's credentials, in Set up or edit Advertisers, you or the person granting access must choose one of the following options:

    • Choose Grant access to all Advertisers, including those created in the future to allow Adverity to access all existing Advertisers and all Advertisers created in the future.

    • Choose Select specific Advertisers to which you want to grant access to determine the specific Advertisers that you want Adverity to access. Adverity will not automatically have access to Advertisers created in the future. You will need to grant Adverity access to any Advertisers created in the future.

    If you use your credentials to grant Adverity access to Amazon Ad Server, all the Advertisers available to you using your credentials will be visible in the Authorizations page to all Adverity users with permission to edit this authorization.

    If someone else uses their credentials to grant Adverity access to Amazon Ad Server, the same applies to the Advertisers available using their credentials.

    This is important to consider if you do not want all Adverity users with permission to edit the authorization to be able to see the details of the Advertisers. For more information about user permissions, see Managing user permissions.

Configuration: Choose the data you want to collect from Amazon Ad Server

To choose what data to collect and customize the Amazon Ad Server datastream configuration, follow these steps:

  1. (Optional) Rename your datastream.

  1. In Report type, select the type of data to collect from Amazon Ad Server. Select Adverity to build Amazon Ad Server reports within Adverity. Alternatively, select Custom to display the Report settings section. In this section, enter the API from the Amazon Ad Server user interface. For more information, see Advanced Amazon Ad Server tips.

  1. In Accounts, Advertisers, and Campaigns, select the accounts, advertisers, and campaigns for which to collect data. If you do not select any items in a drop-down list, Adverity collects data for all items in the drop-down list.

  1. In Campaign Type, select the type of campaign to collect from Amazon Ad Server. The list of available metrics and dimensions differs depending on the selected Campaign type.

  2. In Period Breakdown, select the time frame in which the data is returned.

  1. In Dimensions and Metrics, change the list of fields that you want to see in your data extract.

  1. (Optional) In Currency, select the currency of the cost-related metrics.

  1. (Optional) In Time Zone, select the timezone of the time-related metrics. This field is only displayed if Display is selected as a Campaign Type.

What's next?

Advanced Amazon Ad Server tips

Configuring the Custom report settings

To configure the Custom report settings for an Amazon Ad Server datastream, follow these steps:

  1. Select the workspace you work with in Adverity and then, in the platform navigation menu, click Datastreams.

  2. Open the Amazon Ad Server datastream by clicking on its name.

  3. In the top navigation panel, click Settings.

  4. In Report Type, ensure the value Custom is selected.

  5. In Report pattern, copy and paste the API object from the Amazon Ad Server user interface. You can enter a {start} placeholder into the dataStartTimestamp object to substitute the YYYY-MM-DD date. For example, the following dataStartTimestamp objects are applicable in the Custom report API:

    • "dataStartTimestamp": "2021-04-27T04:00:00.000Z"

    • "dataStartTimestamp": "{start}T04:00:00.000Z"

    • "dataStartTimestamp": "{start}"

    The {end} placeholder is available for the dataEndTimestamp object.

  6. Click Save.

Example of a Amazon Ad Server API report

Below is an example of an API query.

{
    "type": "AnalyticsReport",
    "reportName": "Example report",
    "reportScope": {
        "timeRange": {
            "timeZone": "Greenwich",
            "dataStartTimestamp": "2021-04-27T04:00:00.000Z",
            "dataEndTimestamp": "2021-04-30T03:59:59.999Z",
            "type": "Custom"
        },
        "entitiesHierarchy": {
            "entitiesHierarchyLevelType": "ADVERTISER",
            "accountContext": 12345,
            "accounts": [
                12345
            ],
            "advertisers": [
                100001
            ],
            "displayCampaignsIds": [],
            "searchCampaignsIds": [],
            "sites": [],
            "campaignsType": [
                "Display"
            ]
        },
        "attributionModelID": -1,
        "impressionCookieWindow": 0,
        "clickCookieWindow": 0,
        "filters": {
            "conversionTagIDs": [
                1234567,
                1345678,
                1456789,     
         ]
        },
        "currencyOptions": {
            "type": "Custom",
            "defaultCurrency": 1,
            "targetCurrency": 1,
            "currencyExchangeDate": "2021-04-30"
        },
        "presetId": null
    },
    "reportStructure": {
        "attributeIDs": [
            "Conversion Tag ID",
            "Conversion Tag Name",
            "Account ID",
            "Account Name",
            "Ad ID",
            "Ad Name",
            "Advertiser ID",
            "Advertiser Name",
            "Campaign Name",
            "Campaign ID",
            "Placement ID",
            "Placement Name",
            "Conversion Activity Type",
            "Global Conversion ID",
            "Is Global Conversion"
        ],
        "metricIDs": [
            "Total Conversions",
            "Post Click Conversions",
            "Post Impression Conversions",
            "Conversion Revenue"
        ],
        "attributeIDsOnColumns": [],
        "timeBreakdown": "Day"
    },
    "reportExecution": {
        "type": "Ad_Hoc"
    },
    "reportDeliveryMethods": [
        {
            "type": "URL",
            "exportFileType": "CSV",
            "compressionType": "NONE",
            "emailRecipients": [
                "Name@email.com"
            ],
            "exportFileNamePrefix": "Test",
            "appendTimestampToReportName": false
        }
    ],
    "reportAuthorization": {
        "type": "mm3",
        "userID": 0123456789,
        "ownerAccountId": 98765
    }
}
{
    "data": {
        "labels": [
            "foo",
            "bar"
        ],
        "series": [
            [ 0, 1, 2, 3 ],
            [ 0, -4, -8, -12 ]
        ]
    },
    // we even support comments
    "error": null,
    "status": "Ok"
}