[레거시] 원링크 Smart Script V1

요약: 자동으로 생성되고 브랜드 웹 사이트의 단추 또는 배너 뒤에 임베드되는 원링크를 사용자 정의합니다. 일러두기: 필수 사항은 아니지만 원링크 스마트 스크립트 V2로 마이그레이션하는 것을 고려해 보십시오.

원링크 스마트 스크립트 소개

사용자는 앱 스토어 페이지에 도달하기 전 또는 광고 캠페인을 통해 모바일 웹 사이트에 도착합니다. 그러나 두 번의 클릭이 있기 때문에 (첫 번째는 웹사이트에 디렉션하고 두 번째는 웹 페이지에서 앱스토어로 디렉션) 클릭 전환 메트릭과 딥링킹을 수집하는 것은 문제가 됩니다.

원링크 스마트 스크립트는 이러한 문제를 해결합니다. 스크립트는 다음을 수행합니다.

웹 페이지로 연결되는 수신 URL을 사용하여 앱 스토어로 연결되는 고유한 발신 원링크 URL을 자동으로 생성합니다.
모든 미디어소스에 대해 정확한 웹-투-애플리케이션 메트릭 모음을 제공합니다.
딥러닝에 사용할 수 있습니다.
웹 페이지 또는 랜딩 페이지에서 원활하게 실행됩니다.

절차

스마트 스크립트를 설정하려면, 다음 동작 체크리스트의 동작을 완료해야 합니다.

절차 체크리스트
1. 스크립트를 웹사이트에 가져옵니다.
2. 파라미터와 값을 사용하여 스마트 스크립트 개체 OneLinkUrlGenerator를 초기화합니다.
3. [선택사항] 추가 파라미터와 값을 사용하여 세터를 실행합니다.
4. URL을 생성합니다.

Import the script

스크립트를 웹 사이트로 가져오는 방법:

스크립트를 다운로드합니다.
실행할 모바일 사이트/페이지로 불러옵니다.

Initialize the script

스크립트를 초기화하는 방법:

발신되는 원링크 URL이 포함해야 하는 파라미터/값(수신 URL에 포함된 내용을 기반으로 함)을 마케터로부터 가져옵니다. 더 자세한 내용은 아래의 표를 참조합니다.
인수(파라미터)를 사용하여 OneLinkUrlGenerator 스마트 스크립트를 초기화합니다.

파라미터	유형	기능	예
neLinkURL[필수]	string	- 스크립트가 생성한 모든 링크의 기초 역할을 합니다. - 원링크 템플릿 도메인 + 템플릿 ID입니다.	yourbrand.onelink.me/A1b2 유명 도메인 예: click.yourbrand.com/A1b2
pidKeysList	문자열 목록	- 발신 URL에서 pid 파라미터로 배치될 수신 URL의 미디어 소스 파라미터를 나열합니다. - 수신 링크에 여러 미디어 소스 파라미터가 있는 경우(예: af_pid 및 utm_source), pidKeysList는 파라미터를 처음부터 끝까지 스캔하고 발견된 첫 번째 일치 항목을 사용합니다.	['af_pid', 'utm_source']
pidOverrideList	dictionary {string: string, …}	대체하려는 미디어소스 값과 함께 미디어소스 값을 수신 URL에 나열합니다.	{ 'twitter': 'twitter_int', 'snapchat': 'snapchat_int', 'some_social_net': 'some_social_net_int' }
pidStaticValue	string	pidKeysList에서 pid 키를 찾을 수 없는 경우 pidStaticValue가 pid 값으로 사용됩니다.	- 'website' - 'landing_page'
campaignKeysList	문자열 목록	발신 URL에서 c 파라미터로 배치될 수신 URL의 캠페인 파라미터를 나열합니다.	['af_campaign', 'utm_campaign']
campaignStaticValue	string	campaignKeysList에서 캠페인 키를 찾을 수 없는 경우 campaignStaticValue가 c 값으로 사용됩니다.	- 'website' - 'landing_page'
gclIdParam	string	- 발신 URL의 어떤 파라미터가 GCLID를 전달하는지 정의합니다. - 임의의 파라미터를 선택할 수 있습니다. 일러두기! 앱스플라이어 로데이터 리포트를 표시하려면 파라미터가 af_sub[1-5] 중 하나여야 합니다.	'af_sub5'
skipList	string	건너뛰기 목록의 문자열이 HTTP 리퍼러에 나타나면 스마트 스크립트는 다음을 반환합니다 `null`.	- '[‘facebook’, ‘twitter’]' - Facebook is in the skipList by default.

Run setters

세터를 실행하는 방법:

발신되는 원링크 URL이 포함해야 하는 다른 모든 파라미터와 값(수신 URL에 포함된 내용을 기반으로 함)을 마케터로부터 가져옵니다.
다음을 수행하는 템플릿을 사용하여 세터를 실행합니다.

onelinkGenerator.set[parameter]("parameter value", "optional static value");

예시:

onelinkGenerator.setAfSub1("original_url_sub1", "ram_afsub1");

Generate URLs

발신되는 원링크 URL을 생성하는 방법:

스크립트를 호출하는 웹/랜딩 페이지 HTML에서 메서드 generateURL을 실행합니다.
가능한 반환 값은 다음을 포함합니다.
- 발신 원링크 URL
- null. 스크립트가 null을 반환하면 웹/랜딩 페이지의 기존 URL은 변경되지 않습니다.

예시

Basic attribution

수신 URL:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/basic_url.html?af_c=gogo&af_pid=email

스크립트는 다음과 같습니다.

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });
      const url = onelinkGenerator.generateUrl();

발신 URL:
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true

UTM parameters

수신 URL:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/utm_params.html?utm_source=email&utm_campaign=summer_sale

스크립트는 다음과 같습니다.

onst onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source', 'utm_source'],
         campaignKeysList: ['incoming_campaign', 'utm_campaign']
      });
      const url = onelinkGenerator.generateUrl();

발신 URL:
https://engmntqa.onelink.me/LtRd/?pid=email&c=summer_sale&af_js_web=true

PID and campaign static values

수신 URL:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/static_val.html?af_not_c=gogo&af_not_pid=email

스크립트는 다음과 같습니다.

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         pidStaticValue: 'my_static_pid',
         campaignKeysList: ['incoming_campaign'],
         campaignStaticValue: 'my_static_cmpn',
      });
      const url = onelinkGenerator.generateUrl();

발신 URL:
https://engmntqa.onelink.me/LtRd/?pid=my_static_pid&c=my_static_cmpn&af_js_web=true

Override PIDs

수신 URL:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/override_pid.html?af_pid=twitter&af_c=big_social

스크립트는 다음과 같습니다.

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign'],
         pidOverrideList: { twitter: 'twitter_out',
                            snapchat: 'snapchat_out'
                          }
      });
      const url = onelinkGenerator.generateUrl();

발신 URL:
https://engmntqa.onelink.me/LtRd/?pid=twitter_out&c=big_social&af_js_web=true

Google Click ID passthrough to af_sub

수신 URL:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/gclid.html?af_pid=sms&af_c=candles&gclid=1a2b3c

스크립트는 다음과 같습니다.

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign'],
         gclIdParam: 'af_sub4'
      });
      const url = onelinkGenerator.generateUrl();

발신 URL:
https://engmntqa.onelink.me/LtRd/?pid=google_lp&c=candles&af_js_web=true&af_sub4=1a2b3c

Set OneLink parameters

딥링킹에 사용할 긴 링크를 작성하려면 사용자정의 파라미터와 사전 정의된 파라미터를 모두 전달합니다. 다음의 샘플 스크립트에서 파라미터 전달에 사용하는 함수를 참조하세요.

사용자정의 파라미터를 전달하는 방법:

함수를 호출합니다 setCustomParameter.
setCustomParameter 세 개의 인수를 허용합니다.
1. [필수] 스크립트가 발신 URL에서 설정할 값을 받는 수신 URL의 키입니다.
2. [필수] 발신 URL에 지정할 키입니다.
3. [선택] 첫 번째 인수의 키가 URL에 없는 경우 사용하는 정적 폴백 값입니다.

첫 번째 인수의 키를 찾을 수 없으며 정적 폴백이 정의되지 않은 경우, 파라미터를 건너뛰게 됩니다.

사전 정의된 파라미터 전달하기

다음의 샘플 스크립트에서 함수를 호출합니다(제외 setCustomParameter).
각 함수는 두 개의 인수를 허용합니다.
1. [필수] 스크립트가 발신 URL에서 설정할 값을 받는 수신 URL의 키입니다.
2. [필수] 발신 URL에 지정할 키입니다.

첫 번째 인수의 키를 찾을 수 없으며 정적 폴백이 정의되지 않은 경우, 파라미터를 건너뛰게 됩니다.

수신 URL:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/setters.html?af_c=gogo&af_pid=email

스크립트는 다음과 같습니다.

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
        {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
         pidKeysList: ['incoming_media_source'],
         campaignKeysList: ['incoming_campaign']
      });
      onelinkGenerator.setDeepLinkValue("original_url_deeplinkvalue", "yessss");
      onelinkGenerator.setChannel("original_url_channel", "new_channel");
      onelinkGenerator.setAdset("no_adset", "adset");
      onelinkGenerator.setAd("original_url_ad", "new_ad");
      onelinkGenerator.setAfSub1("original_url_sub1", "ram_afsub1");
      onelinkGenerator.setAfSub2("original_url_sub2");
      onelinkGenerator.setAfSub3("no_sub3", "new_afsub3");
      onelinkGenerator.setAfSub4("original_url_sub4");
      onelinkGenerator.setAfSub5("neverfind_sub5", "new_afsub5");
      onelinkGenerator.setCustomParameter("original_url_fruit_name", "onelink_my_custom_param", "apples");
      const url = onelinkGenerator.generateUrl();

발신 URL:
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true&deep_link_value=yessss&af_channel=new_channel&af_adset=adset&af_ad=new_ad&af_sub1=ram_afsub1&af_sub3=new_afsub3&af_sub5=new_afsub5&onelink_my_custom_param=apples

Set additional attribution parameters

추가 어트리뷰션 파라미터를 사용하여 긴 링크를 작성할 수 있습니다. 다음의 샘플 스크립트에서 파라미터 전달에 사용하는 함수를 참조하세요.

어트리뷰션 파라미터를 추가하는 방법:

함수를 호출합니다 setCustomParameter.
setCustomParameter 세 개의 인수를 허용합니다.
1. [필수] 스크립트가 발신 URL에서 설정할 값을 받는 수신 URL의 어트리뷰션 파라미터의 키입니다.
2. [필수] 발신 URL에 지정할 어트리뷰션 파라미터의 키입니다.
3. [선택] 첫 번째 인수의 키가 URL에 없는 경우 사용하는 정적 폴백 값입니다.

첫 번째 인수의 키를 찾을 수 없으며 정적 폴백이 정의되지 않은 경우, 파라미터를 건너뛰게 됩니다.

수신 URL:
https://appsflyersdk.github.io/appsflyer-onelink-smart-script/v1/examples/set_af_params.html?af_c=gogo&af_pid=email&partner_name=bigagency

스크립트는 다음과 같습니다.

onelinkGenerator.setCustomParameter("partner_name", "af_prt", "defaultPartner");
onelinkGenerator.setCustomParameter("incoming_site_id", "af_siteid", "defaultSiteID");

발신 URL:
https://engmntqa.onelink.me/LtRd/?pid=email&c=gogo&af_js_web=true&af_prt=bigagency&af_siteid=defaultSiteID

Skip clicks from Twitter or Facebook

건너뛰기 목록을 만들어 특정 클릭(예: Twitter 또는 Facebook)에 대한 스마트 스크립트를 비활성화할 수 있습니다. 건너뛰기 목록의 문자열이 클릭의 HTTP 리퍼러에 나타나면 스마트 스크립트는 다음을 반환합니다. null.

스크립트는 다음과 같습니다.

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
      {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
        pidKeysList: ['original_pid'],
        campaignKeysList: ['original_campaign'],
        skipList: ['twitter', 'facebook']
    });
const url = onelinkGenerator.generateUrl();

Don't skip any clicks

빈 건너뛰기 목록을 전달하여 원링크 스마트 스크립트가 모든 클릭에 대해 작동하고 어떤 클릭도 건너뛰지 않도록 할 수 있습니다.

스크립트는 다음과 같습니다.

const onelinkGenerator =  new window.AF.OneLinkUrlGenerator(
      {oneLinkURL: "https://engmntqa.onelink.me/LtRd/",
        pidKeysList: ['original_pid'],
        campaignKeysList: ['original_campaign'],
        skipList: []
    });
const url = onelinkGenerator.generateUrl();