API danych
Data-API umożliwia pobieranie surowych danych z systemu. Data-API można znaleźć w punkcie końcowym
https://www.consentmanager.net/api/data.phpPobierz dane
Aby pobrać dane swoich CMP, wyślij HTTP GET do Data-API z następującymi parametrami:
|
Parametr |
Opis |
Przykład |
|
klucz |
Klucz uwierzytelniania |
jf892rt |
|
od |
Data początkowa |
+ 1983-07-15-XNUMX |
|
do |
Data zakończenia |
+ 2018-08-02-XNUMX |
|
rodzaj |
Typ danych: · 1 = raport CMP · 2 = Raport dostawcy publikacji (nie jest już obsługiwany) · 3 = Raport robota · 4 = Dziennik zgód · 5 = Lista CMP · 6 = Lista projektów · 7 = Lista domen (pliki cookie) · 8 = Wersje tekstowe · 9 = Niestandardowa lista dostawców · 10 = Lista niestandardowych celów · 11 = Lista systemów operacyjnych · 12 = Lista przeglądarek · 13 = Lista urządzeń · 14 = Lista typów zgód · 15 = Identyfikatory ostatniego indeksowania · 16 = (dostawa CMP) Lista domen · 17 = Subkonta · 18 = Dziennik zmian · 19 = Dziennik zgód |
1 |
|
wydajność |
csv lub json |
json |
|
cała kolekcja |
0 lub 1. Dotyczy tylko typu=9 |
1 |
Wynik
API zwróci następujący obiekt:
{
"status":"created", //status, always “created”
"message": "Data report created", //status message
"data": "…" //data payload as csv or json format
}Ważne: Należy pamiętać, że format wyjściowy ładunku danych może się od czasu do czasu zmieniać (np. dodawać nowe kolumny, usuwać kolumny, zmieniać kolumny). Podczas projektowania oprogramowania prosimy o podjęcie niezbędnych kroków w celu wykrycia zmian w strukturze danych.
Przykłady
Raport CMP (typ=1)
{
"status":"created",
"message":"Data report created",
"data": [
{
"cmpID":"3",
"designID":"13",
"country":"DE",
"date":"2019-05-27",
"hour":"23",
"urlID":"123",
"osID":"2",
"uaID":"4",
"deviceID":"2",
"pageView":"3",
"consentView":"0",
"consentAccept":"0",
"consentReject":"0",
...
}, ...
]
} Raport dostawców publikacji (typ=2)
Nie jest już obsługiwany.
Raport robota (typ=3)
{
"status":"created",
"message":"Data report created",
"data":[
{"cmpID":"4",
"date":"2019-05-22",
"hour":"21",
"crawls":"8",
"cookiesFound":"564",
"cookiesNew":"10",
"domainsFound":"431",
"domainsNew":"1"
}, ...
]
}Dziennik zgód (typ=4)
Nie jest już obsługiwany. Zamiast tego użyj type=19.
Lista CMP (typ=5)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"3",
"name":"My CMP",
"status":"1"
}, ...
]
}Lista projektów (typ=6)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"1",
"name":"[Default]\/Bottom right",
"status":"1",
"defaultDesign":"1"
}, ...
]
} (Cookie) Lista domen (typ=7)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"1",
"domain":"example.com"
}, ...
]
} Wersje tekstowe (typ=8)
Uwaga: API poda domyślne teksty dla wszystkich języków jako id=0.
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":0,
"design":0,
"date":null,
"lang":"EN",
"jsonText":
{
"cc":"en",
"load":"Loading",
"hl":"We value your privacy!",
"txt":"...",...
}
}, ...
]
}Niestandardowa lista dostawców (typ=9)
Uwaga: jeśli ustawiony jest parametr &all=1, interfejs API będzie zgłaszać wszystkich tworzonych dostawców niestandardowych i systemów. Jeśli parametr nie jest ustawiony lub jest ustawiony na 0 (zero), interfejs API zgłosi tylko dostawców, którzy są obecnie używani dla dowolnego z Twoich CMP.
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"c24",
"cmp":"3",
"name":"Google Ads",
"link":"https:\/\/policies.google.com\/privacy?hl=en&gl=ZZ",
"logo":"\/delivery\/icons_c24.ico"
}, ...
]
}Lista niestandardowych celów (typ = 10)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"1",
"cmp":"3",
"name":"My Purpose",
"description":"..."
}, ...
]
}Lista systemów operacyjnych (typ=11)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":0,
"name":"unknown"
},
{
"id":2,
"name":"Windows"
}, ...
]
}Lista przeglądarek (typ=12)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":0,
"name":"unknown"
},
{
"id":16,
"name":"Google Chrome"
}, ...
]
}Lista urządzeń (typ=13)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":0,
"name":"unknown"
},
{
"id":2,
"name":"Desktop"
},...
]
}Lista typów zgód (typ=14)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":0,
"name":"unknown"
},
{
"id":1,
"name":"Button click: Accept all"
}, ...
]
}Identyfikatory ostatniego indeksowania (typ=15)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"23380",
"url":"https:\/\/www....",
"startDate":"2019-05-25 21:04:22",
"risk":"100"
}, ...
]
}(dostawa CMP) Lista domen (typ=16)
Użyj parametru &domainid=X, aby wysłać zapytanie o konkretny identyfikator domeny. W przeciwnym razie lista wyświetli identyfikatory, które były używane w tym zakresie dat (np. dzisiaj).
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"1",
"domain":"example.com"
}, ...
]
} Subkonta (typ=17)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"3",
"login":"...",
"mail":"...",
"rights":"cmp;designs;texts;...",
"restrictCMP":"0",
"allowedCMP":"3;4",
"status":"1",
"lastLogin":"2019-07-27 17:32:53"
}, ...
]
}Dziennik zmian (typ=18)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"820",
"datatype":"designs",
"changetype":"1",
"itemID":"11",
"userID":"1",
"subaccountID":"-1",
"accountID":"0",
"changedate":"2019-07-27 18:36:40",
"oldData":{...},
"newData":{...}
}, ...
]
}Dziennik zgód (typ=19)
Tego typu można użyć w celu pobrania dziennika zgody (protokołu) dla konta. Uwaga: Protokoły są wysyłane do archiwum po 7 dniach i nie można ich już pobrać przez API.
