OneLinkUrlGenerator v1

概要

OneLinkUrlGenerator は、ブランドのWebサイト上のボタンやバナー向けのリンクを自動的に生成し埋め込みます。

パブリックコンストラクタ

OneLinkUrlGenerator

引数の入力

タイプ

パラメーター

詳細

文字列

oneLinkURL (必須)

  • スクリプトで生成されるすべてのリンクのベースとなります。
  • OneLinkテンプレートのドメイン+テンプレートIDです。

文字列の一覧

pidKeysList

  • 送信側URLのpidパラメーターとして配置される受信側URLのメディアソースパラメーターを列挙します。
  • 受信側リンクに複数のメディアソースパラメーターが存在する場合(af_pidやutm_sourceなど)、pidKeysListは パラメーターを最初から最後までスキャンし、最初にマッチしたものを使用します。

dictionary {string: string,
…}

pidOverrideList

入力されたURLに含まれるメディアソースの値と、それらをどのように置換するかを一覧表示します。

文字列

pidStaticValue

pidKeysList にpidが見つからない場合、pidStaticValue がpidとして使用されます。

文字列の一覧

campaignKeysList

送信側URLの c パラメーターとして配置される受信側URLのキャンペーンパラメーターの一覧。

文字列

campaignStaticValue

campaignKeysList にキャンペーンキーが見つからない場合は、c値として campaignStaticValue が使用されます。

文字列

gclIdParam

  • 送信側URLのどのパラメーターがGCLIDを含むかを定義します。
  • どのパラメーターも選択できます。注!AppsFlyerのローデータに表示するためには、パラメーターは、af_sub[1-5] のいずれかを使用する必要があります。

文字列

skipList

スキップリストの文字列がHTTPリファラに表示されると、スマートスクリプトは実行されず null を返します。

使用例:

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',
      });

パブリックメソッド

generateUrl

概要

この関数は、前述のパブリックコンストラクタと以下で説明するセッター関数をもとにURLを生成します。

引数の入力

None

戻り値

タイプ

詳細

文字列

次によって生成されたURL: OneLinkUrlGenerator

使用例:

const url = onelinkGenerator.generateUrl();

setDeepLinkValue

引数の入力

タイプ

パラメーター

詳細

必須

文字列

deepLinkValueParam

送信側URL deep_link_value の値を設定するためにスクリプトが取得する受信側URLのキー。

True

文字列

deepLinkValue

受信側URLに deepLinkValueParam が見つからない場合、送信側URL deep_link_value ではフォールバック値が設定されます。

False

戻り値

void

使用例:

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");
const url = onelinkGenerator.generateUrl();

setChannel

引数の入力

タイプ

パラメーター

詳細

必須

文字列

channelParam

送信側URL af_channel の値を設定するためにスクリプトが取得する受信側URLのキー。

True

文字列

channelValue

受信側URLに channelParam が見つからない場合、送信側URL af_channel ではフォールバック値が設定されます。

False

戻り値

void

使用例:

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

setAdset

引数の入力

タイプ

パラメーター

詳細

必須

文字列

adsetParam

送信側URL af_adset の値を設定するためにスクリプトが取得する受信側URLのキー。

True

文字列

adsetValue

受信側URLに adsetParam が見つからない場合、送信側URL af_adset ではフォールバック値が設定されます。

False

戻り値

void

使用例:

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

onelinkGenerator.setAdset("no_adset", "adset");
const url = onelinkGenerator.generateUrl();

setAd

引数の入力

タイプ

パラメーター

詳細

必須

文字列

adParam

送信側URL af_ad の値を設定するためにスクリプトが取得する受信側URLのキー。

True

文字列

adValue

受信側URLに adParam が見つからない場合、送信側URL af_ad ではフォールバック値が設定されます。

False

戻り値

void

使用例:

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

onelinkGenerator.setAd("original_url_ad", "new_ad");
const url = onelinkGenerator.generateUrl();

setAfSub1

引数の入力

タイプ

パラメーター

詳細

必須

文字列

afSub1Param

送信側URL af_sub1 の値を設定するためにスクリプトが取得する受信側URLのキー。

True

文字列

afSub1Value

受信側URLに afSub1Param が見つからない場合、送信側URL af_sub1 ではフォールバック値が設定されます。

False

戻り値

void

使用例:

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

onelinkGenerator.setAfSub1("original_url_sub1", "ram_afsub1");
const url = onelinkGenerator.generateUrl();

setAfSub2

引数の入力

タイプ

パラメーター

詳細

必須

文字列

afSub2Param

送信側URL af_sub2 の値を設定するためにスクリプトが取得する受信側URLのキー。

True

文字列

afSub2Value

受信側URLに afSub2Param が見つからない場合、送信側URL af_sub2 ではフォールバック値が設定されます。

False

戻り値

void

使用例:

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

onelinkGenerator.setAfSub2("original_url_sub2","fallback_sub2");
const url = onelinkGenerator.generateUrl();

setAfSub3

引数の入力

タイプ

パラメーター

詳細

必須

文字列

afSub3Param

送信側URL af_sub3 の値を設定するためにスクリプトが取得する受信側URLのキー。

True

文字列

afSub3Value

受信側URLに afSub3Param が見つからない場合、送信側URL af_sub3 ではフォールバック値が設定されます。

False

戻り値

void

使用例:

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

onelinkGenerator.setAfSub3("original_sub3", "new_afsub3");
const url = onelinkGenerator.generateUrl();

setAfSub4

引数の入力

タイプ

パラメーター

説明

必須

文字列

afSub4Param

送信側URL af_sub4 の値を設定するためにスクリプトが取得する受信側URLのキー。

True

文字列

afSub4Value

受信側URLに afSub4Param が見つからない場合、送信側URL af_sub4 ではフォールバック値が設定されます。

False

戻り値

void

使用例:

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

setAfSub5

引数の入力

タイプ

パラメーター

説明

必須

文字列

afSub5Param

送信側URL af_sub5 の値を設定するためにスクリプトが取得する受信側URLのキー。

True

文字列

afSub5Value

受信側URLに afSub5Param が見つからない場合、送信側URL af_sub5 ではフォールバック値が設定されます。

False

戻り値

void

使用例:

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

setCustomParameter

引数の入力

タイプ

パラメーター

説明

必須

文字列

searchKey

次のスクリプトが送信URLに設定する値の元となる受信URL内のキー: customKey

True

文字列

customKey

次の検索キーによって見つかった値を配置する送信OneLink URLのキー: searchKey

True

文字列

customValue

受信側URLに searchKey が見つからない場合、送信側URL customKey ではフォールバック値が設定されます。

False

戻り値

void

使用例:

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

このページは役に立ちましたか?