OneLink API

요약: 원링크(OneLink) API는 SMS 문자메시지와 다른 경로를 통해 대규모 캠페인에서 개인화된 링크를 생성하여 최종 사용자를 인게이지하고 온드 미디어를 활용하는 데 도움을 줍니다. 광고주와 개발사가 같이 구현해야 합니다.

OneLink API

원링크 API는 다음과 같이 사용됩니다.

  • 자동으로 사용자정의된 파라미터를 사용해 원링크 단축 URL을 생성시작업데이트삭제합니다
    파라미터는 다음 중 하나일 수 있습니다:
    • 미디어소스, 캠페인, 광고 세트 같은 마케팅 노력의 측정 및 모니터링에 사용되는 어트리뷰션 관련 파라미터. 일러두기: 미디어 소스(pid) 파라미터는 필수입니다. 
    • 관련 링크에서 앱을 여는 경우 사용자정의 사용자 경험을 설정할 수 있도록 개인화된 파라미터. 파라미터로 사용자정의 인앱 콘텐츠를 사용자에게 보낼 수 있습니다(예: 특정 제품 페이지, 쿠폰 코드, 프로모션).
  • 모바일 사용자에게 웹사이트 및 앱 콘텐츠를 직접 공유할 수 있습니다(이를 통해 모바일 인게이지먼트 및 인스톨이 증가함).
  • 많은 수의 원링크 어트리뷰션 사용자정의 링크를 즉시 생성합니다.
    일러두기: 추천 링크는 사용자 초대 어트리뷰션 문서를 참조하십시오.

 

식품 배달 기업, Feed Me에서 기존 회원 고객에게 SMS 문자메시지로 개인화된 링크를 전송하여 Feed Me 앱을 다운로드해 바나나를 구매하도록 마케팅하려고 합니다. Feed Me는 원링크 REST API를 사용해 고객의 국가에 관련된 특정 콘텐츠와 유저 ID, 바나나 세일 정보를 포함한 커스텀 원링크 URL을 생성할 수 있습니다.

사용자의 원링크 API 쿼리 수는 계정 유형에 따라 제한됩니다. 원링크 API 대시보드에서 수행한 쿼리 수와 남아 있는 쿼리 수를 확인할 수 있습니다. 

CSM에 문의하여 API 쿼리 제한을 늘릴 수 있습니다.  

설정

원링크 API 설정:

  1. 원링크 템플릿 생성.
  2. 원링크 ID 기록. 

  3. 원링크 API 키를 기록합니다. 어드민 사용자는 API 키를 검색해야 하며 계정 사용자는 접근 권한이 없습니다. 
    • 앱스플라이어 대시보드에서 경험 및 딥링킹 > 원링크 API > 원링크 API 키 보기로 이동합니다.
    • 원링크 API 키가 관리자 사용자용이 아니라면 필요한 패키지를 가지고 있지 않다는 의미이며, CMS로 문의해야 합니다.
  4. 원링크 ID와 원링크 API 키를 개발사에 제공합니다.
  5. 개발사가 개발 허브 지침을 따르도록 하세요.

대시보드

원링크 API 대시보드에는 다음 사항이 표시됩니다.

  • 일별, 월별 및 3개월 API 사용. 
  • 원링크 API 키.

원링크 API 대시보드를 보는 방법

앱스플라이어에서 경험 및 딥링킹 > 원링크 API로 이동합니다.

특성과 제한 사항

항목

참고

API 횟수

  • API를 통해 원링크 어트리뷰션 링크를 생성하는 횟수 제한은 월별(UTC 시간대), 계정별로 7,500,000회입니다.
  • 7,500,000회를 초과한 에 이루어진 모든 요청은 처리되지 않고 링크가 생성되지 않으며, API 호출 시 "제한된 한계를 초과하였습니다" 메시지와 에러 상태 코드 429를 받게 됩니다.
  • 비율 제한의 사용량/남은 정도에 대한 정보는 OneLink API 대시보드에 표시됩니다. 

링크 가시성

  • 이 API를 통해 작성된 링크는 앱스플라이어 대시보드의 원링크 커스텀 링크 목록에 나타나지 않습니다.
  • 모범 사례: 로컬 표에서 API 생성 링크를 저장하면 향후 목적에 따라 링크에 액세스할 수 있습니다. 

TTL 

  • 원링크 API를 통해 작성된 원링크 숏 URL에 대한 기본 TTL(Time to Live)은 31일입니다. 링크를 클릭할 때마다 31일씩 확장됩니다. TTL이 만료된 링크를 클릭해도 여전히 원링크 기본 설정에서 정의된 동작이 기본값으로 설정되지만, 어트리뷰션이 작동하지는 않습니다.
  • 최대 TTL은 31일 입니다. 31일을 초과하는 모든 TTL은 기본 TTL인 31일로 대체됩니다.
  • 파라미터 ttl={value}을(를) 추가하고 일, 시간 또는 분 수를 지정하여 기본 TTL을 변경할 수 있습니다. 예: ttl=7d, ttl=12h또는 ttl=10m.
  • 업데이트 요청을 보내서 TTL을 특정할 수 있습니다. 모든 업데이트 요청은 TTL(기존 링크의 경우)을 요청 본문에 있는 특정한 TTL로 리셋합니다.
    • 이것은 TTL이 대체된다는 것을 의미합니다. 예를 들어 현재 TTL 29d인 링크의 경우 TTL 2d 요청을 업데이트하면 TTL = 2d(TTL = 31d가 아님)로 변경됩니다.
    • 요청 업데이트에 의해 잠재적으로 어트리뷰션 링크의 수명을 연장할 수 있습니다. 예를 들어, 현재 TTL 20d가 있지만 5일이 경과한 링크에 대해 TTL 31d를 사용하여 업데이트를 호출하는 경우, TTL은 업데이트 시간으로부터 31d일 것입니다.
  • 링크 TTL이 자동으로 확장되지 않도록 하려면 renew_ttl=false 파라미터를 링크에 추가하십시오. 이 파라미터의 값은 부울(참 (기본값) 또는 거짓)입니다.
  • renew_ttl 파라미터는 실제 URL에 표시되지 않습니다.

특수 문자

API 작성 링크에 사용할 경우 ;, *, !, @, #, ?, $, ^, :, &, ~, `, =, +, ’, >, <, / 문자를 인코딩해야 합니다.
이러한 문자를 인코딩하지 않으면 공백으로 대체됩니다.

페이로드

페이로드의 쿼리 문자열은 2,048자를 초과할 수 없습니다.

URL ID

URL ID(또는 숏링크 ID)를 편집하여 캠페인 오퍼링을 강조할 수 있습니다. 예: https://myapp.onelink.me/abc123/apples. URL ID는 50자를 초과할 수 없으며 문자와 숫자를 조합할 수 있습니다. 기본적으로 8자입니다.

일러두기:

  • 현재 ID가 이미 사용되고 있지 않은 경우에만 URL ID를 편집할 수 있습니다.
  • URL ID가 이미 사용 중이면 링크 작성이 실패하고 오류 응답(400)을 반환합니다. 사용자와 개발자가 이러한 이벤트에서 발생하는 상황을 결정하고 설정해야 합니다.
  • 실패한 호출은 여전히 월간 API 할당량에 반영됩니다.
도움이 되었습니까?