이 기능은 엔터프라이즈 고객에게 제공됩니다.

새로운 싱귤러 링크 API를 사용하여 새 싱귤러 링크를 만들고 기존 싱귤러 링크를 볼수 있습니다.

주요 흐름

API를 사용하여 파트너 링크 만들기

Screen_Shot_2023-01-31_at_13.23.43.png

API를 사용하여 파트너 링크를 만들려면 다음과 같이 하세요:

1	호출 Get Apps 을 호출하여 단일 링크를 만들려는 앱의 app_id 및 app_site_id 을 검색합니다.
2	호출 Get Configured Partners 을 호출하여 싱귤래러 링크를 만들려는 애드 네트워크 파트너의 partner_id 을 가져옵니다. 팁: 필터링되지 않은 경우, 이 쿼리는 조직에서 각 앱_사이트_아이디에 대해 구성한 모든 파트너를 반환합니다. 이전 단계에서 검색한 앱_사이트_아이디를 사용하여 쿼리를 필터링할 수 있습니다.
3	Call Get Link Domains 을 호출하여 링크에 사용할 수 있는 subdomains 및 dns_zones 을 검색합니다.
4	원하는 경우 Get All Partners 을 호출하여 링크를 만들려는 파트너에 대한 자세한 정보(예: 여러 OS에서 동일한 링크 사용을 지원하는지 여부, 리인게이지먼트 링크를 지원하는지 여부, CTV를 지원하는지 여부 등)를 확인할 수 있습니다. partner_id 으로 쿼리를 필터링할 수 있습니다.
5	Call Create Link 을 사용하여 app_id, app_site_id, partner_id, subdomain 및 이전 단계에서 검색한 dns_zone 을 호출합니다. 참고: 파트너가 여러 OS에서 동일한 링크 사용을 지원하는 경우, 동일한 단일 링크에 Android용 링크 대상과 iOS용 링크 대상을 입력할 수 있습니다. 그렇지 않으면 각 OS에 대해 별도의 링크를 만들어야 합니다. 파트너가 리인게이지먼트 및/또는 CTV를 지원하는 경우 단일 링크에 대해 이러한 옵션을 true로 설정할 수 있습니다.

API를 사용하여 사용자 지정 링크 만들기

API를 사용하여 사용자 지정 링크를 만들려면 다음과 같이 하세요:

1	호출 Get Apps 을 호출하여 단일 링크를 만들려는 앱의 app_id 및 app_site_id 을 검색합니다.
2	호출 Get Link Domains 을 호출하여 링크에 사용할 subdomains 및 dns_zones 을 검색합니다.
3	Call Create Link 을 호출하여 이전 단계에서 검색한 app_id, app_site_id, subdomain 및 dns_zone 을 사용합니다. 참고: 응답에는 링크의 단축 버전도 포함됩니다.

단일 링크 API 개요

엔드포인트

다음 API 엔드포인트를 사용할 수 있습니다:

기본 엔드포인트
Create Link	POST	https://api.singular.net/api/v1/singular_links/links
View Links	GET	https://api.singular.net/api/v1/singular_links/links
도우미 엔드포인트
Get Apps	GET	https://api.singular.net/api/v1/singular_links/apps	Create Link 또는 View Links 을 호출하기 전에 필요한 정보를 얻는 데 사용합니다.
Get Configured Partners	GET	https://api.singular.net/api/v1/singular_links/configured_partners
Get Link Domains	GET	https://api.singular.net/api/v1/singular_links/domains	Create Link 으로 전화하기 전에 필요한 정보를 얻기 위해 사용합니다.
Get All Partners	GET	https://api.singular.net/api/v1/singular_links/all_partners	각 파트너가 어떤 옵션을 지원하는지 알아볼 때 사용합니다.

인증

모든 단수 API 호출에는 단수 API 키가 필요합니다. 키를 검색하려면 Singular 플랫폼에 로그인하고 개발자 도구 > API 키 보고로 이동합니다.

인증 HTTP 헤더에 API 키를 입력합니다(코드 예시 참조).

제한 사항

이러한 API 엔드포인트에 대한 가져오기 요청의 URL은 최대 8000자까지 가능합니다. URL이 길면 오류 메시지가 표시됩니다.

링크 엔드포인트 만들기

POST

https://api.singular.net/api/v1/singular_links/links

사용법

이 엔드포인트를 사용하여 파트너 네트워크 중 하나 또는 사용자 정의 소스에 대한 새 단일 링크를 만듭니다. 링크를 생성한 후에는 해당 네트워크 또는 사용자 지정 소스를 사용하여 캠페인에서 추적 링크로 사용할 수 있습니다.

자세한 내용은 Creating Singular Links 및 나머지 단일 링크 FAQ를 참조하세요.

참고:

싱귤러 플랫폼에서 싱귤러 링크를 볼 때 API로 생성한 링크는 기본적으로 표시되지 않습니다. 표시하려면 Show API links 옵션을 토글하세요.
이 옵션은 기존 링크를 볼 때 사용하는 것과 동일한 엔드포인트 URL이지만 여기서는 GET 요청 대신 POST 요청을 사용하며 필수 파라미터가 더 많습니다.

샘플 쿼리(파트너 링크 만들기)

import requests
  import json
  
  url = "https://api.singular.net/api/v1/singular_links/links"
  
  api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys
  
  params = json.dumps({
    "app_id": <APP_ID>, # From Get Apps call
    "partner_id": <PARTNER_ID>, # From Get Configured Partners call
    "link_type": "partner",
    "tracking_link_name": "my tracking link",
    "link_subdomain": "<SUBDOMAIN>", # From Get Link Domains call
    "link_dns_zone": "sng.link",
    "destination_fallback_url": "https://www.example.com/",
    "android_redirection": {
      "app_site_id": <APP_SITE_ID>, # From Get Apps call
      "destination_url": "https://play.google.com/store/apps/details?id=com.my.app",
      "destination_deeplink_url": "https://www.example.com/",
      "destination_deferred_deeplink_url": "https://www.example.com/"
    }
  })
  
  response = requests.post(url, data=params, headers={'Authorization':api_key})

curl --location --request POST 'https://api.singular.net/api/v1/singular_links/links' \
  --header 'authorization: <API KEY>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "app_id": ,
      "partner_id": ,
      "link_type": "partner",
      "tracking_link_name": "",
      "link_subdomain": "prod_test",
      "link_dns_zone": "sng.link",
      "destination_fallback_url": "https://google.co.il",
      "ios_redirection": {
          "app_site_id": ,
          "destination_url": "",
          "destination_deeplink_url": "",
          "destination_deferred_deeplink_url": ""
      }
  }'

샘플 쿼리(사용자 지정 링크 만들기)

import requests
  import json
  
  url = "https://api.singular.net/api/v1/singular_links/links"
  
  payload = json.dumps({
    "app_id": <...>,
    "partner_id": <...>,
    "link_type": "custom",
    "source_name": "social",
    "enable_reengagement": "false",
    "tracking_link_name": "test-link-custom",
    "link_subdomain": "mydomain",
    "link_dns_zone": "sng.link",
    "destination_fallback_url": "https://fallback.com",
    "click_deterministic_window": 8,
    "click_probabilistic_window": 9,
    "enable_ctv": "false",
    "link_parameter": {
      "this": "is",
      "a": "test"
    },
    "android_redirection": {
      "app_site_id": 609747,
      "destination_url": "https://play.google.com/store/apps/details?id=com.my.app",
      "destination_deeplink_url": "https://example.com",
      "destination_deferred_deeplink_url": "https://example.com"
    }
  })
  headers = {
    'Authorization': '<...>',
    'Content-Type': 'application/json'
  }
  
  response = requests.request("POST", url, headers=headers, data=payload)
  
  print(response.text)

curl --location --request POST 'https://api.singular.net/api/v1/singular_links/links' \
  --header 'Authorization: <...>' \ --header 'Content-Type: application/json' \ --data-raw '{ "app_id": <...>, "partner_id": <...>, "link_type": "custom", "source_name":"social", "enable_reengagement":"false", "tracking_link_name": "test-link-custom", "link_subdomain": "mydomain", "link_dns_zone": "sng.link", "destination_fallback_url": "https://fallback.com", "click_deterministic_window":8, "click_probabilistic_window":9, "enable_ctv":"false", "link_parameter":{ "this":"is", "a":"test" }, "android_redirection": { "app_site_id": 609747, "destination_url": "https://play.google.com/store/apps/details?id=com.my.app", "destination_deeplink_url":"https://example.com", "destination_deferred_deeplink_url": "https://example.com" } }'

쿼리 매개변수

파라미터	설명	파트너 링크에 대한 참고사항	사용자 지정 링크에 대한 참고사항
app_id	링크를 만들려는 앱의 ID입니다. 앱 목록을 보려면 Get Apps 엔드포인트를 사용하세요.	필수	필수
link_type	"partner" 또는 "custom"( 파트너 링크와 사용자 지정 링크에 대해 자세히 알아보기).	필수	필수
partner_id	링크를 만들려는 파트너 네트워크의 ID입니다. 이 특정 앱에 대해 구성된 파트너 목록을 보려면 Get Configured Partners 엔드포인트를 사용하세요.	필수
source_name	"crosspromo", "email", "sms", "social", "affiliates", or "influencers".		필수
tracking_link_name	나중에 싱글 링크 보고서에서 식별할 수 있도록 싱글 링크에 부여하는 이름입니다. 대부분의 조직은 캠페인 이름 또는 캠페인 이름의 변형을 사용합니다. 추적_링크_이름은 싱글 보고서에 "추적자 이름"으로 표시됩니다.	필수	필수
link_dns_zone	단일 추적 링크의 구조는 다음과 같습니다: https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] DNS 영역은 "sng.link"입니다.	필수	필수
link_subdomain	단수 추적 링크의 구조는 다음과 같으며, 여기서 [SUBDOMAIN]은 조직에서 선택합니다: https://[SUBDOMAIN].[DNS_ZONE]/[PARAMETERS] 조직에 대해 구성된 하위 도메인 목록을 보려면 Get Link Domains 으로 문의하세요.	필수	필수
destination_fallback_url	딥링크가 실패할 경우 사용자를 연결할 목적지입니다. 일반적으로 사용자가 앱 광고를 클릭하면 딥링크를 통해 앱 내부의 특정 화면으로 이동하기를 원합니다. 하지만 사용자가 아직 앱을 설치하지 않은 경우 앱을 다운로드할 수 있도록 앱 스토어로 리디렉션하고 싶을 수 있습니다.	필수	필수
android_redirection	Android 기기에서 링크를 연결할 위치를 지정하는 매개 변수가 포함된 객체입니다: app_site_id destination_url destination_deeplink_url (선택 사항, 기본값은 null) destination_deferred_deeplink_url (선택 사항, 기본값은 null) 참고: android_redirection 또는 ios_redirection 중 하나를 지정해야 합니다. 네트워크 파트너가 하나의 단일 링크에서 여러 OS를 허용하는 경우에만 두 가지를 모두 지정할 수 있습니다.	필수	필수
ios_redirection	iOS 기기에서 링크를 연결할 위치를 지정하는 매개변수가 포함된 객체입니다: app_site_id destination_url destination_deeplink_url (선택 사항, 기본값은 null) destination_deferred_deeplink_url (선택 사항, 기본값은 null) 참고: android_redirection 또는 ios_redirection 중 하나를 지정해야 합니다. 네트워크 파트너가 하나의 단일 링크에서 여러 OS를 허용하는 경우에만 두 가지를 모두 지정할 수 있습니다.	필수	필수
enable_reengagement	이 링크를 리인게이지먼트 캠페인에 속하는 것으로 표시하려면 true로 설정합니다( 리인게이지먼트 FAQ 참조).	선택 사항. 모든 파트너가 이 옵션을 지원하는 것은 아닙니다. 모든 파트너 가져오기 쿼리를 사용하여 파트너 ID를 지정하면 특정 파트너가 무엇을 지원하는지 확인할 수 있습니다.	선택 사항입니다. 리인게이지먼트는 클릭에 대해 지원되며 딥링킹 리디렉션을 구성해야 합니다.
click_deterministic_window	결정적 어트리뷰션을 사용하는 클릭에 대한 어트리뷰션 창입니다. 0~30일을 지정할 수 있습니다.	선택 사항입니다. 파트너 링크의 경우, 기본값은 파트너 구성 페이지에서 각 앱 사이트 및 파트너에 대해 설정됩니다.	선택 사항입니다. 사용자 지정 링크의 경우 기본값은 7일입니다.
click_probabilistic_window	확률적 어트리뷰션을 사용하는 클릭-스루의 어트리뷰션 기간입니다. 0-24시간을 지정할 수 있습니다.	선택 사항입니다. 파트너 링크의 경우 기본값은 파트너 구성 페이지에서 각 앱 사이트 및 파트너에 대해 설정됩니다.	선택 사항입니다. 사용자 지정 링크의 경우 기본값은 24시간입니다.
view_deterministic_window	결정론적 어트리뷰션을 사용하는 뷰스루(노출)에 대한 어트리뷰션 기간입니다. 0-24시간을 지정할 수 있습니다.	선택 사항입니다. 파트너 링크의 경우 기본값은 파트너 구성 페이지에서 각 앱 사이트 및 파트너에 대해 설정됩니다.	선택 사항. 사용자 지정 링크의 경우 기본값은 24시간입니다.
view_probabilistic_window	확률적 어트리뷰션을 사용하는 뷰스루(노출)에 대한 어트리뷰션 윈도우입니다. 기본값은 8시간입니다. 0-24시간을 지정할 수 있습니다.	선택 사항	선택사항
click_reengagement_window	리인게이지먼트 캠페인에서 클릭-스루에 대한 어트리뷰션 기간입니다. 이는 enable_reengagement가 true로 설정된 경우에만 해당됩니다. 0~30일을 지정할 수 있습니다.	선택 사항입니다. 파트너 링크의 경우 파트너별로 기본값이 설정되어 있지만 다른 값을 지정할 수 있습니다.	선택 사항입니다. 사용자 지정 링크의 경우 기본값은 7일입니다.
enable_ctv	CTV 캠페인을 지원하려면 true로 설정합니다. 네트워크 파트너가 CTV 캠페인을 지원하는 경우에만 해당됩니다. 파트너에 따라 enable_ctv의 값이 기본적으로 true일 수 있습니다.	선택사항	선택 사항

샘플 출력

{
    "tracking_link_id": "<...>",
    "tracking_link_name": "jr us and ca spring 2022",
    "click_tracking_link": "https://mysubdomain.sng.link/<...>/<...>?idfa=$IDA&and5=$UDID&aifa=$GPID&s=$SITE_APP_ID&psid=$SITE_APP_ID&psn=$SITE_NAME&cl=impId&pcrn=$CREATIVE_NAME&pcrid=$CREATIVE_ID&pcid=$CAMPAIGN_ID&pc=$CAMPAIGN_ID&pcn=$CAMPAIGN_NAME&pscid=$ADGROUP_ID&cr=$CREATIVE_ID&andi1=$O1&pscn=$ADGROUP_NAME&impid=$IMP_ID&pshid=$BLINDED_SITE_ID",
    "impression_tracking_link": "https://i.sng.link/<...>/<...>?idfa=$IDA&and5=$UDID&aifa=$GPID&s=$SITE_APP_ID&psid=$SITE_APP_ID&psn=$SITE_NAME&cl=impId&pcrn=$CREATIVE_NAME&pcrid=$CREATIVE_ID&pcid=$CAMPAIGN_ID&pc=$CAMPAIGN_ID&pcn=$CAMPAIGN_NAME&pscid=$ADGROUP_ID&cr=$CREATIVE_ID&andi1=$O1&pscn=$ADGROUP_NAME&impid=$IMP_ID&pshid=$BLINDED_SITE_ID",
  "short_link": "https://prod_test.sng.link/D75p1/mbm7/961w"
    "extra_info": [
      "partner's default value was used, instead of given argument enable_ctv",
      "partner's default value was used, instead of given argument enable_reengagement"
    ]
  }

출력 파라미터

싱귤러 링크가 성공적으로 생성된 경우 응답에 다음 매개변수가 포함됩니다:

파라미터	설명
tracking_link_id	추적 링크의 내부 ID입니다. 추적 링크 URL에도 포함되어 있습니다.
tracking_link_name	추적 링크에 부여한 이름입니다.
click_tracking_link	클릭 연결 캠페인의 추적 링크 URL입니다. 이 URL에는 링크가 제공될 때 파트너 네트워크에서 실제 값으로 대체되는 매크로가 포함됩니다.
impression_tracking_link	뷰스루 캠페인의 추적 링크 URL(지원되는 경우)입니다.
short_link	링크의 단축 URL 버전(사용자 지정 링크에만 해당). 참고: 이 링크는 추천 트래킹서비스가 아닌 짧은 링크 서비스를 사용하여 생성됩니다. 이러한 짧은 링크는 만료되지 않습니다. 위의 예에서 쇼트 링크는 "https://prod_test.sng.link/D75p1/mbm7/961w"이며, 여기서 "961w"는 쇼트 링크 ID입니다.
extra_info	링크가 성공적으로 생성되었더라도 싱귤러에 경고 및 설명이 표시될 수 있습니다. 이러한 정보는 extra_info 아래에 수집됩니다.

오류 메시지

구성 문제로 인해 링크가 성공적으로 생성되지 않은 경우 문제를 설명하는 메시지가 표시됩니다. 문제를 해결하고 링크 만들기를 다시 호출해 보세요.

오류 메시지	참고
app_site_id 존재하지 않음
파트너 x가 앱 y에 대해 구성되지 않았습니다.
link_domain 정의되지 않음
<attribution_window> 지원되지 않는 값	어트리뷰션 창 중 하나에 지원되지 않는 값을 설정했습니다.
파트너가 링크당 여러 OS를 지원하지 않음	여러 OS에 대한 단일 추적 링크 사용을 지원하지 않는 네트워크 파트너에 대해 Android 리디렉션 값과 iOS 리디렉션 값을 모두 설정하려고 했습니다.
파트너 X가 추적 링크를 허용하지 않음	Facebook 및 Google과 같은 SAN(자체 어트리뷰션 네트워크)은 추적 링크를 지원하지 않으므로 싱귤러에서는 이러한 파트너에 대한 싱귤러 링크를 만들 수 없습니다.

링크 엔드포인트 보기

GET

https://api.singular.net/api/v1/singular_links/links

사용법

이 엔드포인트를 사용하여 기존 싱귤러 링크의 세부 정보를 볼 수 있습니다.

앱_ID, 앱_사이트_ID, 파트너_ID, 소스_이름, 트래킹_링크_ID 중 하나 이상의 필드를 기준으로 요청을 필터링할 수 있습니다. 이러한 ID를 가져오려면 Get Apps 및 Get Configured Partners 엔드포인트를 호출하세요.

참고: 이 엔드포인트는 새 링크를 만드는 데 사용하는 것과 동일한 엔드포인트(URL)이지만, POST 요청 대신 GET 요청을 사용합니다.

샘플 쿼리

import requests
  
  url = "https://api.singular.net/api/v1/singular_links/links"
  api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys
          
  # All the parameters are optional. They are used to filter the list of links
  params = {
      "link_type": "partner",
      "partner_id": "<...>",
      "app_id": "<...>",
      "app_site_id": "<...>",
      "tracking_link_id": "abcde"
  }
  
  response = requests.get(url=url, params=params, headers={'Authorization':api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/links' \
  --header 'authorization: <API KEY>'

쿼리 매개변수

파라미터	설명
link_type	[선택 사항] 하나의 링크 유형만 보려면 "custom", "partner" 또는 "mobile_web_to_app"를 입력합니다.
partner_id	[선택 사항] 특정 파트너에 대해 구성된 파트너 링크만 보려면 해당 파트너의 단수 내부 ID를 입력합니다.
source_name	[선택 사항] 특정 소스에 대해 구성된 사용자 지정 링크만 보려는 경우.
app_id	[선택 사항] 특정 앱에 대해 구성된 링크만 보려면 해당 앱의 단일 내부 ID를 입력합니다.
app_site_id	[선택 사항] 특정 앱 사이트에 대해 구성된 링크만 표시하려면 앱 사이트의 단일 내부 ID를 입력합니다.
tracking_link_id	[선택 사항] 특정 단일 링크에 대한 세부 정보만 보려면 링크의 ID를 입력합니다. ID는 추적 링크 URL에서 찾을 수 있습니다: https://myapp.sng.link/sdfsdf/abcde?...

샘플 출력

출력에는 필터링 매개변수와 일치하는 모든 싱귤러 링크의 배열이 포함됩니다(필터링 매개변수를 입력하지 않은 경우, 기존의 모든 싱귤러 링크가 표시됩니다).

[
  {
    'tracking_link_id': '<...>',
    'tracking_link_name': 'My App Android Summer 22',
    'click_tracking_link': 'https://myapp.sng.link/<...>/<...>?idfa={IDFA}&aifa={IDFA}&did={DID}&ip={IP}&pcrn={AD_NAME}&pcid={CAMPAIGN_ID}&pcn={CAMPAIGN_NAME}&pcrid={AD_ID}&pshid={APP_ID}',
    'impression_tracking_link':'https://myapp.sng.link/<...>/<...>?idfa={IDFA}&aifa={IDFA}&did={DID}&ip={IP}&pcrn={AD_NAME}&pcid={CAMPAIGN_ID}&pcn={CAMPAIGN_NAME}&pcrid={AD_ID}&pshid={APP_ID}',
    'created_utc': 'Tue, 23 Aug 2022 12:22:58 GMT',
    'modified_utc': 'Thu, 24 Nov 2022 11:13:41 GMT',
    'link_type': 'partner',
    'partner_id': <...>,
    'app_id': <...>,,
    'android_redirection': {
      'app_site_id': <...>,
      'destination_url': 'https://play.google.com/store/apps/details?id=...',
      'destination_deeplink_url': None,
      'destination_deferred_deeplink': None
    },
    'destination_fallback_url': 'https://www.mywebsite.com',
    'click_deterministic_window': '7 Days',
    'view_deterministic_window': '24 Hours',
    'enable_reengagement': False,
    'enabled_ctv': False,
  },
  ...
]

출력 매개변수

링크당 다음 매개변수의 배열입니다:

매개변수	설명
일반 매개변수
tracking_link_id	추적 링크의 고유 식별자입니다.
tracking_link_name	링크가 생성될 때 링크에 부여된 이름입니다.
click_tracking_link	클릭을 위한 추적 링크의 URL입니다.
impression_tracking_link	보기를 위한 추적 링크의 URL입니다.
created_utc	링크가 생성된 시점의 UTC 타임스탬프입니다.
modified_utc	링크가 마지막으로 수정된 시점의 UTC 타임스탬프입니다.
link_type	"partner" 또는 "custom"
partner_id	파트너의 고유한 단일 내부 ID.
app_id	앱에 대한 내부 단일 ID입니다.
링크 대상
android_redirection	다음 매개 변수가 포함된 객체입니다: app_site_id destination_url destination_deeplink_url (선택 사항, 기본값은 null) destination_deferred_deeplink_url (선택 사항, 기본값은 null)
ios_redirection	다음 매개 변수를 포함하는 객체: app_site_id destination_url destination_deeplink_url (선택 사항, 기본값은 null) destination_deferred_deeplink_url (선택 사항, 기본값은 null)
destination_fallback_url	딥링크가 실패할 경우 사용자를 이동시킬 목적지입니다. 일반적으로 사용자가 앱의 광고를 클릭하면 딥링크를 통해 앱 내부의 특정 화면으로 이동하기를 원합니다. 하지만 사용자가 아직 앱을 설치하지 않은 경우, 앱을 다운로드할 수 있도록 앱 스토어로 리디렉션하고 싶을 수 있습니다.
선택적 기능
enable_reengagement	링크가 리인게이지먼트/리타겟팅 캠페인에 사용되는 링크로 표시된 경우 true입니다.
enabled_ctv	링크가 CTV 캠페인에 지원되는 경우 참입니다.
어트리뷰션 창 설정
click_deterministic_window	결정적 방법(예: 클릭에 사용된 디바이스 ID와 앱 설치에 사용된 디바이스 ID 일치)을 통해 어트리뷰션되는 경우 클릭-스루 캠페인에서 이 링크에 대한 어트리뷰션 창입니다.
click_probabilistic_window	확률적 방법(예: 디바이스 위치, 운영 체제 등)을 통해 어트리뷰션된 경우 클릭-스루 캠페인에서 이 링크에 대한 어트리뷰션 창입니다.
view_deterministic_window	확정적 방법(예: 클릭에 사용된 기기 ID와 앱 설치에 사용된 기기 ID 일치)을 통해 어트리뷰션된 경우, 뷰스루 캠페인에서 이 링크에 대한 어트리뷰션 창입니다.
view_probabilistic_window	확률적 방법(예: 디바이스 위치, 운영 체제 등)을 통해 어트리뷰션된 경우, 뷰쓰루 캠페인에서 이 링크에 대한 어트리뷰션 창입니다.
click_reengagement_window	클릭-스루 리인게이지먼트 캠페인에서 이 링크에 대한 어트리뷰션 창입니다. 이 파라미터는 이 단일 링크에 대해 리인게이지먼트가 활성화된 경우에만 포함됩니다.

앱 가져오기 엔드포인트

GET

https://api.singular.net/api/v1/singular_links/apps

사용법

이 엔드포인트를 사용하여 싱귤러에 구성된 모든 앱 사이트의 목록을 가져옵니다( 앱과 앱 사이트의 차이점은 무엇인가요? 참조).

샘플 쿼리

import requests

url = "https://api.singular.net/api/v1/singular_links/apps"
api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys

response = requests.get(url=url, headers={'Authorization': api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/apps?api_key=<API KEY>'

샘플 출력

{
  'available_apps': [
    {
      'app_site_id': <...>,
      'app_platform': 'ios',
      'app_store_url': 'https://itunes.apple.com/us/app/…',
      'site_public_id': '<...>',
      'app_id': <...>,
      'app': 'My App'
    },
    {
      'app_site_id': <...>,
      'app_platform': 'android',
      'app_store_url': 'https://play.google.com/store/apps/details?id=...',
      'site_public_id': 'com.rovio.baba',
      'app_id': <...>,
      'app': 'My App'
    }
  ]
}

출력 매개변수

응답은 각 앱 사이트에 대해 다음과 같은 매개 변수가 포함된 앱 사이트 배열입니다:

매개 변수	설명
app_site_id	앱 사이트의 내부 ID(앱 + OS + 번들 ID)입니다( 앱과 앱 사이트의 차이점은 무엇인가요? 참조).
app_platform	앱 사이트에 대해 정의된 플랫폼(예: iOS).
app_store_url	구글 플레이 또는 애플 앱스토어에 있는 앱의 URL입니다.
site_public_id	Apple 앱 스토어 또는 Google Play에서 앱의 ID입니다( 앱과 앱 사이트의 차이점은 무엇인가요? 참조). 웹사이트의 경우 웹사이트 URL입니다.
app_bundle_id	앱의 내부 식별자(예: "com.myapp").
app_id	싱귤러에서 앱에 대한 싱귤러의 내부 ID입니다.
app	앱 페이지에 구성된 앱 이름입니다.

구성된 파트너 엔드포인트 가져오기

GET	https://api.singular.net/api/v1/singular_links/configured_partners

사용 방법

각 앱 사이트에 대해 구성한 파트너(애드 네트워크) 목록을 검색합니다. 특정 앱 사이트 및 파트너에 대한 요청을 필터링할 수 있습니다.

참고: 이 목록에는 단일 링크를 지원하지 않는 페이스북, 구글 애즈 또는 기타 자체 어트리뷰션 네트워크(SAN)와 같은 파트너는 포함되지 않습니다.

샘플 쿼리

import requests        
        
url = "https://api.singular.net/api/v1/singular_links/configured_partners"
api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys
        
params = {
  # The app sites for which you want to see which partners are configured
  "app_site_id": "<APP_SITE_ID1>,<APP_SITE_ID2>",

  # Optional filtering parameter
  "partner_id": "<PARTNER_ID1>,<PARTNER_ID2>" 
}

response = requests.get(url=url, params=params, headers={'Authorization': api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/configured_partners?api_key=<api_key>&app_site_id=<app_site_id>'

쿼리 매개변수

파라미터	설명
app_site_id	[선택 사항] 목록을 필터링할 앱 사이트 ID 또는 쉼표로 구분된 앱 사이트 ID 목록입니다.
partner_id	[선택 사항] 목록을 필터링할 파트너 ID 또는 쉼표로 구분된 파트너 ID 목록입니다.

샘플 출력

다음은 app_site_id = "22334"로 필터링된 요청의 샘플 출력입니다. 이 앱 사이트에 대해 구성된 파트너가 두 개 있습니다.

{
  'available_partners': [
    {
      'app_site_id': <...>,
      'app_id': <...>,
      'singular_partner_display_name':'AdWords',
      'singular_partner_id':<...>
    },
    {
      'app_site_id': <...>,
      'app_id': <...>,
      'singular_partner_display_name':'SplitMetrics',
      'singular_partner_id':<...>,

    }
  ] 
}

출력 매개 변수

앱 사이트별로 다음과 같은 매개 변수가 있는 앱 사이트의 배열입니다:

파라미터	설명
app_site_id	앱 사이트에 대한 Singular의 내부 ID입니다.
app_id	앱에 대한 싱귤러의 내부 ID입니다.
singular_partner_display_name	Singular에서 파트너의 이름(예: "IronSource")입니다.
singular_partner_id	파트너에 대한 Singular의 내부 ID입니다.

모든 파트너 엔드포인트 가져오기

GET

https://api.singular.net/api/v1/singular_links/all_partners

사용

조직에 대해 구성된 파트너에 대한 세부 정보를 검색합니다.

파트너 ID 또는 여러 파트너 ID로 요청을 필터링하여 특정 파트너에 대한 세부 정보만 가져올 수 있습니다.

참고: 이 목록에는 단일 링크를 지원하지 않는 Facebook, Google Ads 또는 기타 자체 어트리뷰션 네트워크(SAN)와 같은 파트너는 포함되지 않습니다.

샘플 쿼리

import requests        

url = "https://api.singular.net/api/v1/singular_links/all_partners"
api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys

params = {
  #Optional: filter to see specific partner(s)
  "partner_id": "<PARTNER_ID1>,<PARTNER_ID2>" 
}

response = requests.get(url=url, params=params, headers={'Authorization':api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/all_partners' \
--header 'authorization: <API KEY>'

쿼리 매개변수

파라미터	설명
singular_partner_id	[선택 사항] 세부 정보를 표시할 파트너 ID의 쉼표로 구분된 목록입니다.

샘플 출력

{
  'partners': [
    {
      'singular_partner_id': <...>,
      'singular_partner_display_name': 'One Network',
      'support_multiple_os': True,
      'support_reengagement': True,
      'support_ctv': False,
    },
    {
      'singular_partner_id': <...>,
      'singular_partner_display_name': 'Other Network',
      'support_multiple_os': False,
      'support_reengagement': True,
      'support_ctv': True,
    },

    ...
         
  ]
}

출력 매개변수

파트너당 다음 매개 변수가 있는 파트너 배열입니다:

파라미터	설명
singular_partner_id	파트너에 대한 Singular의 내부 ID입니다.
singular_partner_display_name	파트너의 단수형 이름(예: "IronSource").
support_multiple_os	파트너가 동일한 추적 링크에서 iOS 대상과 Android 대상을 정의하는 것을 지원하는 경우 참입니다. 파트너가 지원하는 경우, 두 OS의 캠페인에 사용할 하나의 단일 링크를 생성할 수 있습니다.
support_reengagement	파트너가 리인게이지먼트 링크를 지원하는 경우 사실입니다. 파트너가 지원하는 경우 리인게이지먼트 링크로 표시된 단일 링크를 생성하여 리타겟팅 캠페인에 사용할 수 있습니다.
support_ctv	파트너가 CTV를 지원하면 true입니다. 파트너가 지원하는 경우 CTV가 활성화된 링크를 만들 수 있습니다.

링크 도메인 엔드포인트 가져오기

GET

https://api.singular.net/api/v1/singular_links/domains

사용 방법

싱귤러 링크 도메인 목록을 검색합니다. 단일 추적 링크의 구조는 다음과 같으며, 여기서 [SUBDOMAIN]은 사용자가 선택하고 DNS 영역은 "sng.link"입니다:

https://[SUBDOMAIN].sng.link/[PARAMETERS]

단일 링크를 만들 때 링크 URL에 사용할 하위 도메인과 DNS 영역을 지정해야 합니다.

팁: 링크 도메인은 어트리뷰션 > 링크 관리에서 싱귤러 플랫폼에 생성됩니다. 싱귤러 링크를 생성하려면 먼저 도메인을 하나 이상 정의해야 합니다.

샘플 쿼리

import requests        

url = "https://api.singular.net/api/v1/singular_links/domains"
api_key = <...> # Retrieve API Key from Singular platform at Developer Tools > Reporting API Keys

response = requests.get(url=url, headers={'Authorization': api_key})

curl --location --request GET 'https://api.singular.net/api/v1/singular_links/domains?api_key=<api_key>'

샘플 출력

이 요청은 조직에 대해 생성된 싱귤러 링크 도메인 목록을 반환합니다.

{
  'available_domains': [
    {
      'subdomain': 'myorg',
      'dns_zone': 'sng.link'
    }, 
    {
      'subdomain': 'awesomeapp',
      'dns_zone': 'sng.link'
      }
  ]
}

출력 매개변수

파라미터	설명
하위 도메인	하위 도메인에 지정한 이름(예: 회사 이름)입니다. dns_zone과 함께 단일 링크에 사용할 도메인을 생성합니다.
dns_zone	"sng.link"

싱귤러 링크(트래킹 링크) API

주요 흐름

API를 사용하여 파트너 링크 만들기

API를 사용하여 사용자 지정 링크 만들기

단일 링크 API 개요

엔드포인트

인증

제한 사항

링크 엔드포인트 만들기

사용법

샘플 쿼리(파트너 링크 만들기)

샘플 쿼리(사용자 지정 링크 만들기)

쿼리 매개변수

샘플 출력

출력 파라미터

오류 메시지

링크 엔드포인트 보기

사용법

샘플 쿼리

쿼리 매개변수

샘플 출력

출력 매개변수

앱 가져오기 엔드포인트

사용법

샘플 쿼리

샘플 출력

출력 매개변수

구성된 파트너 엔드포인트 가져오기

사용 방법

샘플 쿼리

쿼리 매개변수

샘플 출력

출력 매개 변수

모든 파트너 엔드포인트 가져오기

사용

샘플 쿼리

쿼리 매개변수

샘플 출력

출력 매개변수

링크 도메인 엔드포인트 가져오기

사용 방법

샘플 쿼리

샘플 출력

출력 매개변수