connectors.amazon_ads_v1

Preview the data

Beta connector for Amazon's new Unified Ads API (/adsApi/v1/...), restricted to Dataddo and L'Oréal accounts until the "Unified API — Beta" Reports resource it depends on is confirmed stable. See src/Connector/AmazonAds/ for the production connector against Amazon's classic (v2 profiles / v3 reporting) API.

post/connectors/amazon_ads_v1/preview

Request

  • Base URL: https://headless.dataddo.com/customer-api/v1
  • URL: https://headless.dataddo.com/customer-api/v1/connectors/amazon_ads_v1/preview
  • Auth: none declared

Request body

o_auth_idstring
authorizer_idstring
nullable_fieldsboolean

Setting this parameter to true allows the use of null values. If set to false, default values for each data type will be used instead.

ensure_data_typesobject

Overrides the default data types of the produced Source schema, ensuring that each field is typed as specified.

data_typesobject

Overrides the default data types of the produced Source schema, ensuring that each field is typed as specified.

connector_idstring
template_idstring
labelstring
allow_emptyboolean

Setting this parameter to true allows extraction operations to proceed even if they produce 0 rows. If set to false, the operation will result in an error if no rows are extracted.

date_rangestring nullable
advertiserAccountIdsstring[]

Array of strings.

reportTypesstring[]

Array of strings.

attributesstring[]

Array of strings.

currency'default' | 'AED' | 'ARS' | 'AUD' | 'AZN' | 'BBD' | 'BGN' | 'BMD' | 'BND' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GHS' | 'GTQ' | 'HKD' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'JMD' | 'JPY' | 'KES' | 'KRW' | 'KYD' | 'KZT' | 'LBP' | 'LKR' | 'MAD' | 'MUR' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NOK' | 'NZD' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'USD' | 'UYU' | 'VND' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR'

Currencies accepted by Amazon's currencyOfView report field (adsApi/v1, Beta) - all monetary metrics in the report get converted to this currency.

granularity'date' | 'week' | 'day' | 'month' | 'year' | 'day_of_week' | 'hour' | 'date_range'

Time breakdown of the report (adsApi/v1, Beta).

use_extraction_timestampboolean
use_hashboolean
use_date_startboolean
use_date_stopboolean
use_masked_columnsboolean
hash_columnsstring[]

Array of strings.

masked_columnsstring[]

Array of strings.

Example request

{
  "authorizer_id": "P6T8tazCWdf3pkVzIAlnZa10gh",
  "ensure_data_types": {
    "field1": "float",
    "field2": "string",
    "field3": "integer",
    "field4": "date"
  },
  "data_types": {
    "field1": "float",
    "field2": "string",
    "field3": "integer",
    "field4": "date"
  },
  "date_range": "1d1",
  "advertiserAccountIds": [
    "np1NErz7B4",
    "rPMOx7EOp9"
  ],
  "reportTypes": [
    "np1NErz7B4",
    "rPMOx7EOp9"
  ],
  "attributes": [
    "np1NErz7B4",
    "rPMOx7EOp9"
  ],
  "hash_columns": [
    "id",
    "date_start"
  ],
  "masked_columns": [
    "name",
    "email"
  ]
}

Response

Data preview

codestring
blobstring
messagestring
headerstring[]

Array of strings.

keystring[]

Array of strings.

typestring[]
row_countinteger
dataobject[]

Row-oriented data: a list of rows, each row a map keyed by column name.

Example response

{
  "header": [
    "np1NErz7B4",
    "rPMOx7EOp9"
  ],
  "log": [
    {
      "request_header": {
        "key": "value"
      },
      "response_header": {
        "key": "value"
      }
    }
  ],
  "key": [
    "np1NErz7B4",
    "rPMOx7EOp9"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.