캠페인 API

캠페인 API를 사용하면 링크, 하위 링크 및 파트너 정보를 얻을 수 있습니다. 새 링크를 생성하고 기존 링크를 새 파트너 정보로 업데이트하시기 바랍니다.

인증

캠페인 API는 인증을 위해 베어러 토큰 을 사용합니다. 반드시 캠페인 API에 대한 각 요청과 함께 Authorization 헤더에 Adjust API 토큰을 포함해야 합니다.

Single Sign-On (SSO)를 활성화한 경우, Adjust 담당자에게 연락하거나 support@adjust.com 으로 이메일을 보내 API를 찾는 데 도움을 받으시기 바랍니다.

비 SSO 계정의 경우, API는 사용자의 프로필 에서 확인하실 수 있습니다. Adjust API 토큰을 확인하려면 다음 단계를 따르시기 바랍니다.

계정(사용자) 아이콘을 선택합니다.
계정 설정 을 선택합니다.
내 프로필 탭을 선택합니다.
API 토큰 은 사용자 세부 사항 과 함께 표시됩니다. 시스템 클립보드에 토큰을 복사하기 위해 복사를 선택합니다.

Adjust API 토큰 재설정

Adjust API 토큰은 언제든지 재설정할 수 있습니다. 토큰을 재설정하면 이전의 토큰은 무효화됩니다. Adjust API 토큰을 재설정한 경우 기존 토큰이 사용되는 모든 곳에서 교체해야 합니다. 무효화된 토큰에 대한 요청은 Adjust에 의해 거부됩니다.

Adjust API 토큰 재설정

계정(사용자) 아이콘을 선택합니다.
계정 설정 을 선택합니다.
내 프로필 탭을 선택합니다.
API 토큰 은 사용자 세부 사항 과 함께 표시됩니다.
API 토큰 재설정 을 선택합니다.
모달에 계정 비밀번호를 입력한 후 API 토큰 재설정을 위해 재설정 을 선택합니다. 화면 우측 상단에 확인 메시지가 나타납니다.
시스템 클립보드에 API 토큰 을 복사하기 위해 복사를 선택합니다.

파트너 불러오기

GET https://api.adjust.com/public/v1/partners

본 엔드포인트를 사용하여 파트너 및 관련 데이터 목록을 불러오시기 바랍니다. 데이터는 파트너 객체의 순서대로 반환됩니다.

파라미터

다음의 파라미터를 쿼리 파라미터 로 전달할 수 있습니다.

after (String): 요청을 시작할 커서 위치 .
before (String): 요청을 종료할 커서 위치 .
limit (Integer): 응답에 포함된 결과의 최대 갯수. 이 값은 반드시 양의 정수 값이어야 합니다. 기본: 50.

페이지 번호

이 엔드포인트로부터의 결과는 커서를 사용하여 페이징됩니다. 각 페이지는 previous 및 next 페이지의 위치를 반환합니다. 이를 콜에 포함하여 특정 페이지를 반환할 수 있습니다.

각 결과 페이지는 커서 위치가 포함된 paging 객체를 포함합니다. 이 커서 위치를 사용하여 페이지를 이동할 수 있습니다. 예를 들어, 첫 페이지는 다음의 paging 객체를 포함할 수 있습니다.

"paging": {
   "page_size": "50",
   "collection_size": "49",
   "total": "199",
   "cursors": {
      "after": "g2wAAAACYhW1_gxkAANuaWxq",
      "before": null
   },
   "next": "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "previous": null
}

두 번째 페이지로 이동하려면 after 파라미터의 다음 요청에 after 값을 추가합니다. 예시:

$ curl "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq"

응답 형식

1
{
2
   "data": {
3
      "api_version": "string",
4
      "request_id": "string",
5
      "timestamp": "datetime",
6
      "paging": {
7
         "page_size": "string",
8
         "collection_size": "string",
9
         "total": "string",
10
         "next": "string",
11
         "previous": "string",
12
         "cursors": {
13
            "after": "string",
14
            "before": "string"
15
         }
16
      },
17
      "items": [
18
         {
19
            "id": 100,
20
            "display_name": "string",
21
            "supports_cost_data": true
22
         }
23
      ]
24
   }
25
}

예:

$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
-L -X GET 'https://api.adjust.com/public/v1/partners?limit=1'

{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "paging": {
         "page_size": "1",
         "collection_size": "1",
         "total": "199",
         "next": "https://api.adjust.com/public/v1/partners?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
         "previous": null,
         "cursors": {
            "after": "g2wAAAACYhW1_gxkAANuaWxq",
            "before": null
         }
      },
      "items": [
         {
            "id": 174,
            "display_name": "Adcolony",
            "supports_cost_data": true
         }
      ]
   }
}

링크 가져오기

GET https://api.adjust.com/public/v2/apps/{app_token}/trackers

GET https://api.adjust.com/public/v1/apps/{app_token}/trackers

이 엔드포인트를 사용하여 앱과 관련된 네트워크 레벨 링크를 가져옵니다.

파라미터

요청 경로(path) 에서 반드시 다음의 파라미터를 전달해야 합니다.

app_token (String): 앱을 식별하는 영숫자 토큰. 반드시 12자여야 합니다.

다음의 파라미터를 쿼리 파라미터 로 전달할 수 있습니다.

cursor (String): 커서 위치.
limit (Integer): 응답에 포함된 결과의 최대 갯수. 이 값은 반드시 양의 정수 값이어야 합니다. 기본: 50.

요청 경로(path) 에서 반드시 다음의 파라미터를 전달해야 합니다.

app_token (String): 앱을 식별하는 영숫자 토큰. 반드시 12자여야 합니다.

다음의 파라미터를 쿼리 파라미터 로 전달할 수 있습니다.

after (String): 요청을 시작할 커서 위치 .
before (String): 요청을 종료할 커서 위치 .
limit (Integer): 응답에 포함된 결과의 최대 갯수. 이 값은 반드시 양의 정수 값이어야 합니다. 기본: 50.

페이지 번호

이 엔드포인트로부터의 결과는 커서를 사용하여 페이징됩니다. 각 결과 페이지는 커서 위치를 포함하는 paging 객체를 포함합니다. 이 커서 위치를 사용하여 페이지를 이동할 수 있습니다. 예를 들어, 첫 페이지에는 다음과 같은 결과가 포함됩니다.

"paging": {
   "next": "https://api.adjust.com/public/v2/apps/yxs12pfewq/trackers?cursor=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "cursor": "g2wAAAACYhW1_gxkAANuaWxq"
}

두 번째 페이지로 이동하려면 next 링크를 따라 다음의 지정된 cursor 위치에서 결과를 반환합니다.

$ curl "https://api.adjust.com/public/v2/apps/yxs12pfewq/trackers?cursor=g2wAAAACYhW1_gxkAANuaWxq&limit=50"

결과에서 특정 위치로 돌아가려면 요청 query params 에서 cursor 값을 전달합니다.

"paging": {
   "page_size": "50",
   "collection_size": "49",
   "total": "199",
   "cursors": {
      "after": "g2wAAAACYhW1_gxkAANuaWxq",
      "before": null
   },
   "next": "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "previous": null
}

두 번째 페이지로 이동하려면 next 링크를 따라 다음의 지정된 cursor 위치에서 결과를 반환합니다.

$ curl "https://api.adjust.com/public/v1/apps/yxs12pfewq/trackers?after=g2wAAAACYhW1_gxkAANuaWxq"

응답 형식

모든 링크는 다음 형식의 아이템으로 반환됩니다.

{
   "name": "String",
   "token": "String",
   "label": "String",
   "level": 1,
   "archived": false,
   "has_subtrackers": false,
   "partner_id": 3,
   "cost_data_enabled": false,
   "url": "String",
   "click_url": "String",
   "impression_url": "String"
}

예:

$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
-L -X GET 'https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers?limit=1'

{
   "data": {
      "paging": {
         "cursor": "g2wAAAACYhW1_gxkAANuaWxq",
         "next": "https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1"
      },
      "items": [
         {
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 3,
            "cost_data_enabled": false,
            "label": "Adroll",
            "level": 1,
            "name": "Adroll",
            "token": "abc123",
            "url": "https://app.adjust.com/abc123",
            "click_url": "https://app.adjust.com/abc123?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/abc123?campaign={campaign_name}&idfa={idfa}&s2s=1"
         }
      ]
   }
}

$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
-L -X GET 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers?limit=1'

{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "paging": {
         "page_size": "1",
         "collection_size": "1",
         "total": "199",
         "next": "https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
         "previous": null,
         "cursors": {
            "after": "g2wAAAACYhW1_gxkAANuaWxq",
            "before": null
         }
      },
      "items": [
         {
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 3,
            "cost_data_enabled": false,
            "label": "Adroll",
            "level": 1,
            "name": "Adroll",
            "token": "abc123",
            "url": "https://app.adjust.com/abc123",
            "click_url": "https://app.adjust.com/abc123?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/abc123?campaign={campaign_name}&idfa={idfa}&s2s=1"
         }
      ]
   }
}

하위 링크 불러오기

GET https://api.adjust.com/public/v2/apps/{app_token}/trackers/{link_token}/children

GET https://api.adjust.com/public/v1/apps/{app_token}/trackers/{link_token}/children

본 엔드포인트를 사용하여 지정된 앱에 대한 하위 링크를 불러오시기 바랍니다.

파라미터

요청 경로(path) 에서 반드시 다음의 파라미터를 전달해야 합니다.

app_token (String): 앱을 식별하는 영숫자 토큰. 반드시 12자여야 합니다.
tracker_token (String): 하위 링크가 중첩된 상위 링크 의 링크 토큰.

요청의 쿼리 파라미터 에서 다음의 파라미터를 전달할 수 있습니다.

cursor (String): 커서 위치.
limit (Integer): 응답에 포함된 결과의 최대 갯수. 이 값은 반드시 양의 정수 값이어야 합니다. 기본: 50.

요청 경로(path) 에서 반드시 다음의 파라미터를 전달해야 합니다.

app_token (String): 앱을 식별하는 영숫자 토큰. 반드시 12자여야 합니다.
tracker_token (String): 하위 링크가 중첩된 상위 링크 의 링크 토큰.

요청의 쿼리 파라미터 에서 다음의 파라미터를 전달할 수 있습니다.

after (String): 요청을 시작할 커서 위치 .
before (String): 요청을 종료할 커서 위치 .
limit (Integer): 응답에 포함된 결과의 최대 갯수. 이 값은 반드시 양의 정수 값이어야 합니다. 기본: 50.

페이지 번호

"paging": {
   "next": "https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers/abc123/children?cursor=g2wAAAACYhW1_gxkAANuaWxq",
   "cursor": "g2wAAAACYhW1_gxkAANuaWxq"
}

두 번째 페이지로 이동하려면 next 링크를 따라 다음의 지정된 cursor 위치에서 결과를 반환합니다.

$ curl "https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers/abc123/children?cursor=g2wAAAACYhW1_gxkAANuaWxq"

결과에서 특정 위치로 돌아가려면 요청 query params 에서 cursor 값을 전달합니다.

"paging": {
   "page_size": "50",
   "collection_size": "49",
   "total": "199",
   "cursors": {
      "after": "g2wAAAACYhW1_gxkAANuaWxq",
      "before": null
   },
   "next": "https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/abc123/children?after=g2wAAAACYhW1_gxkAANuaWxq&limit=50",
   "previous": null
}

두 번째 페이지로 이동하려면 next 링크를 따라 다음의 지정된 cursor 위치에서 결과를 반환합니다.

$ curl "https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/abc123/children?after=g2wAAAACYhW1_gxkAANuaWxq"

응답 형식

1
{
2
   "name": "String",
3
   "token": "String",
4
   "label": "String",
5
   "level": 2,
6
   "archived": false,
7
   "has_subtrackers": false,
8
   "partner_id": null,
9
   "cost_data_enabled": false,
10
   "url": "String",
11
   "click_url": "String",
12
   "impression_url": "String"
13
}

예:

$ curl \
--header 'Authorization: Token token={API_TOKEN}'
-L -X GET 'https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers/abc123/children?limit=1' \

{
   "data": {
      "paging": {
         "next": "https://api.adjust.com/public/v2/apps/gwzpeepw8uf8/trackers/abc123/children?cursor=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
         "cursor": "g2wAAAACYhW1_gxkAANuaWxq"
      },
      "items": [
         {
            "name": "Adroll::SpringCampaign",
            "token": "xyz456",
            "label": "SpringCampaign",
            "level": 2,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": null,
            "cost_data_enabled": false,
            "url": "https://app.adjust.com/xyz456",
            "click_url": "https://app.adjust.com/xyz456?idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/xyz456?idfa={idfa}&s2s=1"
         }
      ]
   }
}

$ curl \
--header 'Authorization: Token token={API_TOKEN}'
-L -X GET 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/abc123/children?limit=1' \

{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "paging": {
         "page_size": "1",
         "collection_size": "1",
         "total": "199",
         "next": "https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/abc123/children?after=g2wAAAACYhW1_gxkAANuaWxq&limit=1",
         "previous": null,
         "cursors": {
            "after": "g2wAAAACYhW1_gxkAANuaWxq",
            "before": null
         }
      },
      "items": [
         {
            "name": "Adroll::SpringCampaign",
            "token": "xyz456",
            "label": "SpringCampaign",
            "level": 2,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": null,
            "cost_data_enabled": false,
            "url": "https://app.adjust.com/xyz456",
            "click_url": "https://app.adjust.com/xyz456?idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/xyz456?idfa={idfa}&s2s=1"
         }
      ]
   }
}

링크 생성

POST https://api.adjust.com/public/v1/apps/{app_token}/trackers

이 엔드포인트를 사용하여 앱에 대한 새로운 링크와 하위 링크를 생성합니다.

파라미터

요청 경로(path) 에서 반드시 다음의 파라미터를 전달해야 합니다.

app_token (String): 앱을 식별하는 영숫자 토큰. 반드시 12자여야 합니다.

요청 데이터 에서 다음의 파라미터를 반드시 전달해야 합니다.

name (String): 새 링크의 이름.

요청 데이터 에서 다음의 파라미터를 전달할 수 있습니다.

parent_token (String): 하위 링크가 중첩된 상위 링크 의 링크 토큰. 하위 링크를 생성하는 경우에만 필요.

응답 형식

1
{
2
   "name": "String",
3
   "token": "String",
4
   "label": "String",
5
   "level": 1,
6
   "archived": false,
7
   "has_subtrackers": false,
8
   "partner_id": 3,
9
   "cost_data_enabled": false,
10
   "url": "String",
11
   "click_url": "String",
12
   "impression_url": "String"
13
}

다음의 level 값을 사용할 수 있습니다.

1: 네트워크 수준
2: 캠페인 수준
3: 광고그룹 수준
4: 크리에이티브 수준

예:

다음의 예시는 링크 와 하위 링크를 생성하는 방법을 보여줍니다.

링크 생성

$ curl --location --request POST 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers' \
--header 'Authorization: Token token={API_TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{"name": "Adroll"}'

{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "items": [
         {
            "name": "Adroll",
            "token": "abc123",
            "label": "Adroll",
            "level": 1,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 3,
            "cost_data_enabled": false,
            "url": "https://app.adjust.com/abc123",
            "click_url": "https://app.adjust.com/abc123?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/abc123?campaign={campaign_name}&idfa={idfa}&s2s=1"
         }
      ]
   }
}

하위 링크 생성

$ curl --location --request POST 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers' \
--header 'Authorization: Token token={API_TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{"parent_token": "abc123", "name": "SpringCampaign"}'

{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "items": [
         {
            "name": "Adroll::SpringCampaign",
            "token": "xyz456",
            "label": "SpringCampaign",
            "level": 2,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 3,
            "cost_data_enabled": false,
            "url": "https://app.adjust.com/xyz456",
            "click_url": "https://app.adjust.com/xyz456?campaign={campaign_name}&idfa={idfa}&deeplink=http%3A%2F%2Fa.b%2Fc%3Fd%3D1%26e%3D%%MACROS%%",
            "impression_url": "https://s2s.adjust.com/impression/xyz456?campaign={campaign_name}&idfa={idfa}&s2s=1"
         }
      ]
   }
}

링크 업데이트

PATCH https://api.adjust.com/public/v1/apps/{app_token}/trackers/{link_token}

이 엔드포인트를 사용하여 앱에 대한 기존 링크와 하위 링크를 업데이트합니다. 링크에 새 파트너를 추가하거나 비용 데이터의 활성화 여부를 지정할 수 있습니다.

파라미터

요청 경로(path) 에서 반드시 다음의 파라미터를 전달해야 합니다.

app_token (String): 앱을 식별하는 영숫자 토큰. 반드시 12자여야 합니다.
tracker_token (String): 업데이트 하려는 링크의 토큰

요청 데이터 에서 다음의 파라미터를 전달할 수 있습니다(MAY).

partner_id (Integer): 링크에 첨부하려는 파트너의 ID. 파트너 및 ID 목록을 가져오려면 위의 파트너 가져오기를 참조하시기 바랍니다.
cost_data_enabled (Boolean): 링크의 광고 비용 데이터 활성화 여부

응답 파라미터

1
{
2
   "name": "String",
3
   "token": "String",
4
   "label": "String",
5
   "level": 1,
6
   "archived": false,
7
   "has_subtrackers": false,
8
   "partner_id": 3,
9
   "cost_data_enabled": false,
10
   "url": "String",
11
   "click_url": "String",
12
   "impression_url": "String"
13
}

다음의 level 값을 사용할 수 있습니다.

1: 네트워크 수준
2: 캠페인 수준
3: 광고그룹 수준
4: 크리에이티브 수준

예:

$ curl \
--header 'Authorization: Token token={API_TOKEN}' \
--header 'Content-Type: application/json' \
--location --request PATCH 'https://api.adjust.com/public/v1/apps/gwzpeepw8uf8/trackers/klm789' \
--data-raw '{"partner_id": 174, "cost_data_enabled": false}'

{
   "data": {
      "api_version": "1",
      "request_id": "FcK55-tdJUDOWQIAABsB",
      "timestamp": "2019-09-09T09:07:06Z",
      "items": [
         {
            "name": "Adcolony",
            "token": "klm789",
            "label": "Adcolony",
            "level": 1,
            "archived": false,
            "has_subtrackers": false,
            "partner_id": 174,
            "cost_data_enabled": true,
            "url": "https://app.adjust.com/klm789",
            "impression_url": "https://s2s.adjust.com/impression/klm789?s2s=1&idfa=[IDFA]&gps_adid=[GOOGLE_AD_ID]&ip_address=  [IP_ADDRESS]&adcolony_click_id=[CLICK_ID]&android_id_upper_sha1=[SHA1_ANDROID_ID]&cost_id=[CLICK_ID]&cost_type=[BID_TYPE]&cost_amount=[BID]&cost_currency=USD",
            "click_url": "https://s2s.app.adjust.com/klm789?s2s=1&idfa=[IDFA]&gps_adid=[GOOGLE_AD_ID]&ip_address=[IP_ADDRESS]&adcolony_click_id=[CLICK_ID]&android_id_upper_sha1=[SHA1_ANDROID_ID]&cost_id=[CLICK_ID]&cost_type=[BID_TYPE]&cost_amount=[BID]&cost_currency=USD"
         }
      ]
   }
}