アドビプラグイン:getQueryParam

重要

このプラグインはアドビコンサルティングによって提供されており、Adobe Analytics からより多くの価値を引き出すのに役立ちます。アドビカスタマーケアは、インストールやトラブルシューティングを含め、このプラグインに対するサポートをおこないません。このプラグインに関するヘルプが必要な場合は、貴社のアカウントマネージャーにお問い合わせになって、担当コンサルタントとのミーティングを手配してもらってください。

getQueryParam プラグインを使用すると、URL に含まれるクエリー文字列パラメーターの値を抽出できます。これは、ランディングページの URL から内部および外部の両方のキャンペーンコードを抽出する場合に役立ちます。また、検索用語や他のクエリー文字列パラメーターを抽出する場合にも役立ちます。

このプラグインは、複数のクエリー文字列パラメーターを含むハッシュや URL を含む複雑な URL を解析する際に堅牢な機能を提供します。単純なクエリー文字列パラメーターのみが必要な場合は、Adobe Experience PlatformのタグまたはAppMeasurementに含まれるUtil.getQueryParam()メソッドを使用して、URLパラメーター機能を使用することをAdobeにお勧めします。

Adobe Experience Platformのタグを使用したプラグインのインストール

アドビでは、最も一般的に使用されるプラグインを使用できる拡張機能を提供しています。

  1. Adobe IDの資格情報を使用して、データ収集UIにログインします。
  2. 目的のプロパティをクリックします。
  3. 「拡張機能」タブに移動し、「カタログ」ボタンをクリックします。
  4. Common Analytics Plugins 拡張機能をインストールして公開します。
  5. まだ「Initialize Plug-ins」というルールを作成していない場合は、次の設定を使用してルールを作成します。
    • Condition:なし
    • Events:Core – 読み込まれたライブラリ(ページ上部)
  6. 次の設定を使用して、上記のルールにアクションを追加します。
    • Extension:Common Analytics Plugins
    • Action Type:Initialize getQueryParam
  7. ルールに対する変更を保存して発行します。

カスタムコードエディターを使用したプラグインのインストール

プラグイン拡張機能を使用しない場合は、カスタムコードエディターを使用できます。

  1. Adobe IDの資格情報を使用して、データ収集UIにログインします。
  2. 目的のプロパティをクリックします。
  3. 「拡張機能」タブに移動し、Adobe Analytics 拡張機能の下にある「設定」ボタンをクリックします。
  4. 「カスタムコードを使用してトラッキングを設定」アコーディオンを展開すると、「エディターを開く」ボタンが表示されます。
  5. カスタムコードエディターを開き、下に示すプラグインコードを編集ウィンドウに貼り付けます。
  6. 変更を保存し、Analytics 拡張機能に公開します。
/******************************************* BEGIN CODE TO DEPLOY *******************************************/
/* Adobe Consulting Plugin: getQueryParam v4.0.1  */
function getQueryParam(a,d,f){function n(g,c){c=c.split("?").join("&");c=c.split("#").join("&");var e=c.indexOf("&");if(g&&(-1<e||c.indexOf("=")>e)){e=c.substring(e+1);e=e.split("&");for(var h=0,p=e.length;h<p;h++){var l=e[h].split("="),q=l[1];if(l[0].toLowerCase()===g.toLowerCase())return decodeURIComponent(q||!0)}}return""}if("-v"===a)return{plugin:"getQueryParam",version:"4.0.1"};var b=function(){if("undefined"!==typeof window.s_c_il)for(var g=0,c;g<window.s_c_il.length;g++)if(c=window.s_c_il[g],c._c&&"s_c"===c._c)return c}();"undefined"!==typeof b&&(b.contextData.getQueryParam="4.0");if(a){d=d||"";f=(f||"undefined"!==typeof b&&b.pageURL||location.href)+"";(4<d.length||-1<d.indexOf("="))&&f&&4>f.length&&(b=d,d=f,f=b);b="";for(var m=a.split(","),r=m.length,k=0;k<r;k++)a=n(m[k],f),"string"===typeof a?(a=-1<a.indexOf("#")?a.substring(0,a.indexOf("#")):a,b+=b?d+a:a):b=""===b?a:b+(d+a);return b}};
/******************************************** END CODE TO DEPLOY ********************************************/

プラグインの使用

getQueryParam メソッドでは、次の引数を使用します。

  • qsp(必須):URL 内で検索するクエリー文字列パラメーターのコンマ区切りリストです。大文字と小文字は区別されません。
  • de(オプション):複数のクエリー文字列パラメーターが一致する場合に使用する区切り文字です。デフォルトでは空の文字列です。
  • url(オプション):クエリー文字列パラメーターの値を抽出するカスタム URL、文字列、または変数です。デフォルト値は window.location です。

このメソッドを呼び出すと、上記の引数と URL に応じた値が返されます。

  • 一致するクエリー文字列パラメーターが見つからない場合は、空の文字列を返します。
  • 一致するクエリー文字列パラメーターが見つかった場合、このメソッドはクエリー文字列パラメーター値を返します。
  • 一致するクエリー文字列パラメーターが見つかったが値が空の場合、このメソッドは true を返します。
  • 一致するクエリー文字列パラメーターが複数見つかった場合、このメソッドは de 引数内の文字列で区切られた各パラメーター値を持つ文字列を返します。

呼び出しの例

例 1

現在の URL が次の場合:

http://www.abc123.com/?cid=trackingcode1

次のコードは、s.campaign を「trackingcode1」に設定します。

s.campaign=s.getQueryParam('cid');

例 2

現在の URL が次の場合:

http://www.abc123.com/?cid=trackingcode1&ecid=123456

次のコードは、s.campaign を「trackingcode1:123456」に設定します。

s.campaign=s.getQueryParam('cid,ecid',':');

例 3

現在の URL が次の場合:

http://www.abc123.com/?cid=trackingcode1&ecid=123456

次のコードは、s.campaign を「trackingcode1123456」に設定します。

s.campaign=s.getQueryParam('cid,ecid');

例 4

現在の URL が次の場合:

http://www.abc123.com/?cid=trackingcode1&ecid=123456#location

次のコードでは、s.campaign を「123456」に設定します。

s.campaign=s.getQueryParam('ecid');

例 5

現在の URL が次の場合:

http://www.abc123.com/#location&cid=trackingcode1&ecid=123456

次のコードでは、s.campaign を「123456」に設定します。

s.campaign=s.getQueryParam('ecid');

注意:​疑問符が存在しない場合、プラグインは、Check のハッシュ文字の URL を疑問符に置き換えます。URL にハッシュ文字の前に疑問符が含まれている場合、プラグインは Check のハッシュ文字の URL をアンパサンドに置き換えます。

例 6

現在の URL が次で、

http://www.abc123.com/

変数 s.testURL が次のように設定されている場合、

s.testURL="http://www.abc123.com/?cid=trackingcode1&ecid=123456#location&pos=300";

次のコードは、s.campaign をまったく設定しません。

s.campaign=s.getQueryParam('cid');

ただし、次のコードでは、s.campaign を「trackingcode1」に設定します。

s.campaign=s.getQueryParam('cid','',s.testURL);

注意: 3 つ目のパラメーターは、コードでクエリー文字列パラメーターを検索するために使用する任意の文字列/変数を指定できます。

次のコードは、s.eVar2 を「123456|trackingcode1|true|300」に設定します。

s.eVar2=s.getQueryParam('ecid,cid,location,pos','|',s.testURL);
  • 123456 の値は、s.testURL 変数の ecid パラメーターから取得されます。
  • trackingcode1 の値は、s.testURL 変数の cid パラメーターから取得されます。
  • true の値は、s.testURL 変数内のハッシュ文字の後の場所パラメーターの存在(値以外)から取得されます。

300 の値は、s.testURL 変数の pos パラメーターの値から取得されます。

バージョン履歴

4.0.1(2021 年 3 月 26 日(PT))

  • クエリーパラメーターがクエリー文字列に存在しない場合、「」の代わりに undefined が返される問題を更新しました。

4.0(2021 年 3 月 19 日(PT))

  • コンテキストデータとしてバージョン番号を追加しました。
  • pt プラグインへの依存関係を削除しました 。

3.3(2019 年 9 月 24 日(PT))

  • 不要なロジックを迂回してコードサイズを縮小しました。

3.2(2018 年 5 月 15 日(PT))

  • findParameterValue 関数および getParameterValue 関数を getQueryParam 関数内に移動しました。

3.1(2018 年 5 月 10 日(PT))

  • 値のないクエリー文字列パラメーターの取得に関する問題を修正しました。

3.0(2018 年 4 月 16 日(PT))

  • ポイントリリース(再コンパイル、コードサイズの縮小)。
  • ヘルパー関数の名前を読みやすくするために、findParameterValue および getParameterValue に変更しました。
  • URL ハッシュに含まれるパラメーターを見つけるための引数を追加する必要がなくなりました。

2.5(2016 年 1 月 8 日(PT))

  • H コードと AppMeasurement の両方と互換性があります(AppMeasurement と s.pt が必要です)。

2.4

  • h パラメーターを追加し、ハッシュ文字(#)の後に見つかったクエリー文字列パラメーターをコードで検索できるようになりました。

2.3

  • トラッキングコードの後にハッシュが存在する場合にのみプラグインが機能するという回帰問題を修正しました。

2.2

  • 戻り値からハッシュ文字(およびその後のすべて)を削除するようになりました。

2.1

  • H.10 コードと互換

このページ