Batch operations

replaceAll

When replaceAll action is used, the data sent to ADventori for several users replace all existing data.

ALL the user data will be replaced, not only the key present in the new data. If some existing key does not exist in the new data, it will be lost.

The URL to use is :

https://eu-usersync.adventori.com/ADVERTISER_CODE/data/replaceAll?provider=PROVIDER_CODE&key=PROVIDER_AUTH_KEY
  • The ADVERTISER_CODE parameter must be specified in the service call. It represents the unique code of the advertiser on behalf of whom the data are posted
  • The PROVIDER_CODE parameter must be specified in the service call. It represents the data provider unique code and match the PROVIDER_CODE used for cookie sync
  • The PROVIDER_AUTH_KEY represents the authentication key of the data provider. It must be specified in the service call. It is provided by ADventori.

The JSON message sent must be in the following form if the UID matching is kept by ADventori:

{
  "uids": [
    "UID_PROVIDER_1",
    "UID_PROVIDER_2",
    ...
  ],
  "data": {
    "key1": "value1",
    "key2": "value2"
  }
}

and if the UID matching is kept by the data provider:

{
  "adv_uids": [
    "UID_ADVENTORI_1",
    "UID_ADVENTORI_2",
    ...
  ],
  "data": {
    "key1": "value1",
    "key2": "value2"
  }
}

Curl usage:

curl -X POST -H "Content-Type: application/json" -d '{"uids": ["UID_PROVIDER_1", "UID_PROVIDER_2"], "data": {"key1": "value1", "key2": "value2"}}' 'http://eu-usersync.adventori.com/ADVERTISER_CODE/data/replaceAll?provider=PROVIDER_CODE&key=PROVIDER_AUTH_KEY'

upsertAll

When upsertAll action is used, only keys present in the JSON message are modified (inserted if they don’t exist yet, updated if they exist or deleted if the new value is null) for the specified users.

The URL to use is :

https://eu-usersync.adventori.com/ADVERTISER_CODE/data/upsertAll?provider=PROVIDER_CODE&key=PROVIDER_AUTH_KEY
  • The ADVERTISER_CODE parameter must be specified in the service call. It represents the unique code of the advertiser on behalf of whom the data are posted
  • The PROVIDER_CODE parameter must be specified in the service call. It represents the data provider unique code and match the PROVIDER_CODE used for cookie sync
  • The PROVIDER_AUTH_KEY parameter represents the authentication key of the data provider. It must be specified in the service call. It is provided by ADventori.

The JSON message sent must be in the following form if the UID matching is kept by ADventori:

{
  "uids": [
    "UID_PROVIDER_1",
    "UID_PROVIDER_2",
    ...
  ],
  "data": {
    "key1": "value1",
    "key2": "value2"
  }
}

and if the UID matching is kept by the data provider:

{
  "adv_uids": [
    "UID_ADVENTORI_1",
    "UID_ADVENTORI_2",
    ...
  ],
  "data": {
    "key1": "value1",
    "key2": "value2"
  }
}

Curl usage:

curl -X POST -H "Content-Type: application/json" -d '{"uids": ["UID_PROVIDER_1", "UID_PROVIDER_2"], "data": {"key1": "value1", "key2": "value2"}}' 'http://eu-usersync.adventori.com/ADVERTISER_CODE/data/upsertAll?provider=PROVIDER_CODE&key=PROVIDER_AUTH_KEY'

deleteAll

When deleteAll action is used, all data for the specified users are deleted. This action cannot be undone.

The URL to use is:

https://eu-usersync.adventori.com/ADVERTISER_CODE/data/deleteAll?provider=PROVIDER_CODE&key=PROVIDER_AUTH_KEY
  • The ADVERTISER_CODE parameter must be specified in the service call. It represents the unique code of the advertiser on behalf of whom the data are posted
  • The PROVIDER_CODE parameter must be specified in the service call. It represents the data provider unique code and match the PROVIDER_CODE used for cookie sync
  • The PROVIDER_AUTH_KEY represents the authentication key of the data provider. It must be specified in the service call. It is provided by ADventori.

The JSON message sent must be in the following form if the UID matching is kept by ADventori:

{
  "uids": [
    "UID_PROVIDER_1",
    "UID_PROVIDER_2",
    ...
  ]
}

and if the UID matching is kept by the data provider:

{
  "adv_uids": [
    "UID_ADVENTORI_1",
    "UID_ADVENTORI_2",
    ...
  ]
}

Curl usage:

curl -X POST -H "Content-Type: application/json" -d '{"uids": ["UID_PROVIDER_1", "UID_PROVIDER_2"]}' 'http://eu-usersync.adventori.com/ADVERTISER_CODE/data/deleteAll?provider=PROVIDER_CODE&key=PROVIDER_AUTH_KEY'

batch

The batch operation is a generic batch operation that takes several atomic operations (replace, upsert and delete) and execute them sequentially

The URL to use is:

https://eu-usersync.adventori.com/ADVERTISER_CODE/data/batch?provider=PROVIDER_CODE&key=PROVIDER_AUTH_KEY
  • The ADVERTISER_CODE parameter must be specified in the service call. It represents the unique code of the advertiser on behalf of whom the data are posted
  • The PROVIDER_CODE parameter must be specified in the service call. It represents the data provider unique code and match the PROVIDER_CODE used for cookie sync
  • The PROVIDER_AUTH_KEY represents the authentication key of the data provider. It must be specified in the service call. It is provided by ADventori.

The JSON message sent must be in the following form if the UID matching is kept by ADventori:

                  [
  {
    "uid": "UID_PROVIDER_1",
    "operation": "upsert",
    "data": {
      "key1": "value1.1",
      "key2": "value2.1"
    }
  },
  {
    "uid": "UID_PROVIDER_2",
    "operation": "replace",
    "data": {
      "key1": null,
      "key2": "value2.2"
    }
  },
  {
    "uid": "UID_PROVIDER_3",
    "operation": "delete"
  }
]

and if the UID matching is kept by the data provider:

[
  {
    "adv_uid": "UID_ADVENTORI_1",
    "operation": "upsert",
    "data": {
      "key1": "value1.1",
      "key2": "value2.1"
    }
  },
  {
    "adv_uid": "UID_ADVENTORI_2",
    "operation": "replace",
    "data": {
      "key1": null,
      "key2": "value2.2"
    }
  },
  {
    "adv_uid": "UID_ADVENTORI_3",
    "operation": "delete"
  }
]

Curl usage:

curl -X POST -H "Content-Type: application/json" -d '[{"uid": "UID_PROVIDER_1", "operation": "upsert", "data": {"key1": "value1.1", "key2": "value2.1"}},{"uid": "UID_PROVIDER_2", "operation": "replace", "data": {"key1": null,"key2": "value2.2"}},{"uid": "UID_PROVIDER_3","operation": "delete"}]' 'http://eu-usersync.adventori.com/ADVERTISER_CODE/data/batch?provider=PROVIDER_CODE&key=PROVIDER_AUTH_KEY'