GET /ad/mapping/externalids¶
GET /ad/mapping/externalids v2
GET /ad/mapping/externalids v1
Warning
GET /ad/mapping/externalids v2 and GET /ad/mapping/externalids v1 are now officially deprecated and scheduled for removal on May, 1st 2023. Please move to use vendorId instead.
GET /ad/mapping/externalids v2¶
Scope |
|
Accept |
|
This URL returns a map of adIds for the current user to the externalId the ad has. This utility call is intended for uncommon usecases, such as when a client on-boards an already existing admarkt user and needs to do a one-time sync of adIds vs externalIds, or other cases where data got lost at the client.
Warning
Ads without externalId will not be present in the resulting map.
The number of ads returned can be limited with the limit
parameter.
The offset
parameter allows to skip some ads and together with limit
allows for pagination. The status
parameter acts as a filter for ads in Ad Status and
has default value ACTIVE
.
Parameters¶
Name |
Type |
Description |
---|---|---|
status |
string |
One of Ad Status. Default |
limit |
int |
Limits the number of records returned. Default is 1000 and maximum is 10000. |
offset |
int |
Skips the first N records. |
Example¶
GET /api/sellside/ad/mapping/externalids?offset=0&limit=10&status=ACTIVE
Accept: application/sellside.ad.external.id.mapping-v2+json; application/json
200 OK HTTP/1.1
Content-Type: application/sellside.ad.external.id.mapping-v2+json; charset=UTF-8
{
"1000212125": "82800ef2-0c0c-4b12-a2f3-c5d4b860a00c",
"1100885981": "123123-123123-123123",
"1102986711": "82800ef2-0c0c-4b12-a2f3-c5d4b860a00c",
"1104051271": "aaef367c-0206-440a-8acf-b0b4194b3558",
"1001831750": "a797e372-498e-449b-9fd9-088e3ccfdb08",
"1100886309": "123123-123123-123123",
"1100886818": "123123-123123-123123",
"1100887074": "123123-123123-123123",
"1100885731": "123123-123123-123123"
}
GET /ad/mapping/externalids v1¶
Warning
V1 is considered deprecated due bad scaling. Please use V2 instead. Keep in mind that
V1 returned ads in statuses ACTIVE
, PAUSED
, BUDGET_REACHED
and DAILY_BUDGET_REACHED
. To get
the same results with V2 as V1 the caller will have to combine results from multiple calls.
We do not have a date yet for actual removal of V1.
Scope |
|
Accept |
|
This URL returns a map of adIds for the current user to the externalId the ad has. This utility call is intended for uncommon usecases, such as when a client on-boards an already existing admarkt user and needs to do a one-time sync of adIds vs externalIds, or other cases where data got lost at the client.
Warning
This call will only return mappings for non-deleted ads. Ads without externalId will also not be present in the resulting map.
The number of ads returned can be limited with the limit
parameter.
The offset
parameter allows to skip some ads and together with limit
allows for pagination.
Parameters¶
Name |
Type |
Description |
---|---|---|
limit |
int |
Limits the number of records returned. Default is 1000 and maximum is 10000. |
offset |
int |
Skips the first N records. |
Example¶
GET /api/sellside/ad/mapping/externalids?offset=0&limit=10
Accept: application/sellside.ad.external.id.mapping-v1+json; application/json
200 OK HTTP/1.1
Content-Type: application/sellside.ad.external.id.mapping-v1+json; charset=UTF-8
{
"1000212125": "82800ef2-0c0c-4b12-a2f3-c5d4b860a00c",
"1100885981": "123123-123123-123123",
"1102986711": "82800ef2-0c0c-4b12-a2f3-c5d4b860a00c",
"1104051271": "aaef367c-0206-440a-8acf-b0b4194b3558",
"1001831750": "a797e372-498e-449b-9fd9-088e3ccfdb08",
"1100886309": "123123-123123-123123",
"1100886818": "123123-123123-123123",
"1100887074": "123123-123123-123123",
"1100885731": "123123-123123-123123"
}