- Docs>
- Kakao Moment>
- Pixel & SDK linkage management
Kakao Moment
Pixel & SDK linkage management
This document describes how to use the Pixel & SDK linkage management APIs.
View list of linked Pixel & SDKs
Basic information
| Method | URL | Authorization |
|---|---|---|
GET |
https://apis.moment.kakao.com/openapi/v4/trackers/rights |
Access token |
| Permission | Prerequisite | Kakao Login | User consent |
|---|---|---|---|
| Required | Register platforms Activate Kakao Login Switch to a Biz app |
Required | - |
This API enables you to retrieve the list of the Pixel & SDKs linked to the ad account. Target population passed in the response indicates the estimated number of reach by collecting data through the corresponding event for the last 120 days from midnight. The data is updated every 3 P.M.
Send a GET request with the issued access token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the list of ad groups in JSON format. If failed, refer to Error code to figure out its failure cause.
This API limits the number of calls you can make to every five seconds per user account.
Request
Header
| Name | Description | Required |
|---|---|---|
| Authorization | Authorization: Bearer ${ACCESS_TOKEN}Access token as a type of user authentication. |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}Ad account's ID. |
O |
Response
Body
| Name | Type | Description |
|---|---|---|
| - | TrackRights[] |
List of Pixel & SDK information. |
TrackRights
| Name | Type | Description |
|---|---|---|
| trackId | String |
Track ID. |
| trackName | String |
Name of the linked Pixel & SDK. |
| population | String |
Target population. Estimated reach calculated through the data from midnight to the last 180 days with the corresponding event. The data is updated every 3 P.M. |
| eventStatus | String |
Status. Either PRE_COLLECTION (Before collecting) or COLLECTION (Collecting). |
| createdDate | String |
Date and time when the event is created in yyyy-MM-dd'T'HH:mm:ss.SSS format. |
| lastEventDate | String |
Date and time when the event is lastly checked in yyyy-MM-dd'T'HH:mm:ss.SSSXXX format. |
| role | String |
Track permission. Either MASTER or MEMBER. |
Sample
Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/trackers/rights" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"trackRights": [
{
"trackId": "1234567890",
"trackName": "pixel",
"population": 0,
"eventStatus": "COLLECTION",
"createdDate": "2019-12-10T08:18:22.000+0000",
"lastEventDate": null,
"role": "MASTER"
},
{
"trackId": "1234567891",
"trackName": "Pixel",
"population": 0,
"eventStatus": "PRE_COLLECTION",
"createdDate": "2020-01-01T00:00:00.000+0000",
"lastEventDate": "2020-01-01 15:00:00",
"role": "MEMBER"
}
]
}
View list of linkable Pixel & SDKs
Basic information
| Method | URL | Authorization |
|---|---|---|
GET |
https://apis.moment.kakao.com/openapi/v4/trackers/rightAvailables |
Access token |
| Permission | Prerequisite | Kakao Login | User consent |
|---|---|---|---|
| Required | Register platforms Activate Kakao Login Switch to a Biz app |
Required | - |
This API enables you to retrieve the list of the Pixel & SDKs that usage permission can be added to. You can add up to 100 Pixel & SDKs per ad account.
Send a GET request with the issued access token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the list of the Pixel & SDKs that permission can be added to in JSON format. If failed, refer to Error code to figure out its failure cause.
Request
Header
| Name | Description | Required |
|---|---|---|
| Authorization | Authorization: Bearer ${ACCESS_TOKEN}Access token as a type of user authentication. |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}Ad account's ID. |
O |
Response
Body
| Name | Type | Description |
|---|---|---|
| - | PixelAndSdkInfo[] |
List of Pixel & SDK information. |
PixelAndSdkInfo
| Name | Type | Description |
|---|---|---|
| trackId | String |
Track ID. Pass this value for trackId when requesting the Linking Pixel & SDK API. |
| name | String |
Track name. |
| createdAt | String |
Date and time of creation. |
| updatedAt | String |
Date and time of modification. |
| role | String |
Track permission. One of MASTER, MEMBER or REQUEST. |
Sample
Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/trackers/rightAvailables" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
{
"trackId": "1234567890123456789",
"name": "Pixel&SDK_available_to_add_permission",
"createdAt": "2020-01-01T00:00:00.000+0000",
"updatedAt": "2020-01-01T00:00:00.000+0000",
"role": "MEMBER"
},
{
"trackId": "9876543210987654321",
"name": "Pixel&SDK_available_to_add_permission",
"createdAt": "2020-01-01T00:00:00.000+0000",
"updatedAt": "2020-01-01T00:00:00.000+0000",
"role": "REQUEST"
}
]
Link Pixel & SDK
Basic information
| Method | URL | Authorization |
|---|---|---|
POST |
https://apis.moment.kakao.com/openapi/v4/trackers |
Access token |
| Permission | Prerequisite | Kakao Login | User consent |
|---|---|---|---|
| Required | Register platforms Activate Kakao Login Switch to a Biz app |
Required | - |
This API enables you to link a specific Pixel & SDK to an ad account. You can link to up to 100 Pixel & SDKs per ad account.
Send a POST request with the issued access token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the HTTP status code 200 without the response body. If failed, refer to Error code to figure out its failure cause.
Request
Header
| Name | Description | Required |
|---|---|---|
| Authorization | Authorization: Bearer ${ACCESS_TOKEN}Access token as a type of user authentication. |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}Ad account's ID. |
O |
Body
| Name | Type | Description | Required |
|---|---|---|---|
| trackId | String |
Track ID. Use trackId obtained through the Viewing list of linkable Pixel & SDKs API. |
O |
| adAccountId | Long |
Ad account's ID. | O |
Sample
Request
curl -X POST "https://apis.moment.kakao.com/openapi/v4/trackers" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-d '{
"trackId": "5678901234",
"adAccountId": "12345"
}'
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Unlink Pixel & SDK
Basic information
| Method | URL | Authorization |
|---|---|---|
DELETE |
https://apis.moment.kakao.com/openapi/v4/trackers/${TRACK_ID} |
Access token |
| Permission | Prerequisite | Kakao Login | User consent |
|---|---|---|---|
| Required | Register platforms Activate Kakao Login Switch to a Biz app |
Required | - |
This API enables you to unlink a specific Pixel & SDK from an ad account.
Send a DELETE request with the issued access token and an ad account ID (adAccountId) in the request header. You must pass trackId of the Pixel & SDK with permission obtained when you request. If the request is successful, this API returns the HTTP status code 200 without the response body. If failed, refer to Error code to figure out its failure cause.
Request
Header
| Name | Description | Required |
|---|---|---|
| Authorization | Authorization: Bearer ${ACCESS_TOKEN}Access token as a type of user authentication. |
O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}Ad account's ID. |
O |
Path variable
| Name | Type | Description | Required |
|---|---|---|---|
| TRACK_ID | String |
Track ID. Use trackId obtained through the Viewing list of linked Pixel & SDKs API. |
O |
Sample
Request
curl -X DELETE "https:// apis.moment.kakao.com/openapi/v4/trackers/${TRACK_ID}" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8