Android v4(従来)- スタートガイド

はじめに

Google タグ マネージャーを使用すると、デベロッパーは Google タグ マネージャーのインターフェースを使用してモバイルアプリの設定値を変更できます。アプリのバイナリを再ビルドしてアプリ マーケットプレイスに再送信する必要はありません。

これは、将来変更が必要になる可能性があるアプリケーションの構成値やフラグを管理するのに役立ちます。たとえば、次のようなものです。

  • さまざまな UI 設定と表示文字列
  • アプリで配信される広告のサイズ、場所、タイプ
  • さまざまなゲーム設定

構成値は、ルールを使用して実行時に評価することもできます。これにより、次のような動的な構成が可能になります。

  • 画面サイズを使用して広告バナーのサイズを決定する
  • 言語と地域を使用して UI 要素を構成する

Google タグ マネージャーを使用すると、アプリケーションにトラッキング タグとピクセルを動的に実装することもできます。また、重要なイベントをデータレイヤーにプッシュしておくことにより、どのトラッキング タグやピクセルを配信するかを後で決めることができます。

始める前に

このスタートガイドを始める前に、次の手順を完了してください。

これらの手順を完了したら、このガイドの残りの部分で、Android アプリ内で Google タグ マネージャーを設定して使用する方法を説明します。

スタートガイド

このスタートガイドを読み終えると、次の方法を理解できます。

このガイドでは、Google Play 開発者サービス SDK に含まれている Cute Animals サンプル アプリケーションのコード スニペットを使用します。このプロジェクトの完全なソースは <android-sdk-directory>/extras/google/google_play_services/tagmanager/cuteanimals で入手できます。

1. プロジェクトへの Google タグ マネージャーの追加

Google タグ マネージャーをプロジェクトに追加するには:

  1. Google Play 開発者サービス SDK をセットアップする
  2. Android Studio 以外の IDE を使用する場合は、AndroidManifest.xml ファイルに次の権限を追加します。
    <!-- For TagManager SDK -->
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  3. InstallReferrerReceiver が Google アナリティクス レシーバーを呼び出してキャンペーン データを設定できるようにするには、AndroidManifest.xml ファイルに以下を追加します。
    <!-- Used for install referrer tracking-->
    <service android:name="com.google.android.gms.tagmanager.InstallReferrerService" />
    <receiver
      android:name="com.google.android.gms.tagmanager.InstallReferrerReceiver"
      android:exported="true">
      <intent-filter>
        <action android:name="com.android.vending.INSTALL_REFERRER" />
      </intent-filter>
    </receiver>

2. プロジェクトにデフォルトのコンテナ ファイルを追加する

Google タグ マネージャーは、アプリケーションの初回実行時にデフォルトのコンテナを使用します。アプリがネットワーク経由で新しいコンテナを取得できるようになると、デフォルトのコンテナは使用されなくなります。

デフォルトのコンテナ バイナリをダウンロードしてアプリケーションに追加するには:

  1. Google タグ マネージャーのウェブ インターフェースにログインします。
  2. ダウンロードするコンテナのバージョンを選択します。
  3. [ダウンロード] ボタンをクリックして、コンテナ バイナリを取得します。
  4. ダウンロードしたコンテナ バイナリ ファイルを未加工リソースとしてプロジェクトに追加します。
    1. <project-root>/res/ の raw サブフォルダが存在しない場合は、作成します。
    2. 必要に応じて、コンテナ バイナリ ファイルの名前を変更します。使用できるのは、英小文字、数字、アンダースコアのみです。
    3. コンテナ バイナリ ファイルを <project-root>/res/raw フォルダにコピーします。

バイナリ ファイルの使用をおすすめしますが、コンテナにルールやタグが含まれていない場合は、代わりにシンプルな JSON ファイルを使用することもできます。

3. Google タグ マネージャーを初期化する

アプリケーションで Google タグ マネージャーを初期化するには:

  1. TagManager シングルトンを取得します。
    TagManager tagManager = TagManager.getInstance(this);
  2. TagManager シングルトンを使用して、コンテナを読み込むリクエストを作成します。このとき、Google タグ マネージャーのコンテナ ID とデフォルト コンテナ ファイルを指定します。コンテナ ID は大文字で、Google タグ マネージャーのウェブ インターフェースのコンテナ ID と完全に一致する必要があります。loadContainerPreferNonDefault() の呼び出しは非ブロッキングで、PendingResult を返します。
    PendingResult<ContainerHolder> pending =
            tagManager.loadContainerPreferNonDefault(CONTAINER_ID,
            R.raw.defaultcontainer_binary);
  3. ResultCallback を使用して、読み込みが完了するかタイムアウトしたら ContainerHolder を返します。
    // The onResult method will be called as soon as one of the following happens:
    //     1. a saved container is loaded
    //     2. if there is no saved container, a network container is loaded
    //     3. the 2-second timeout occurs
    pending.setResultCallback(new ResultCallback<ContainerHolder>() {
        @Override
        public void onResult(ContainerHolder containerHolder) {
            ContainerHolderSingleton.setContainerHolder(containerHolder);
            Container container = containerHolder.getContainer();
            if (!containerHolder.getStatus().isSuccess()) {
                Log.e("CuteAnimals", "failure loading container");
                displayErrorToUser(R.string.load_error);
                return;
            }
            ContainerLoadedCallback.registerCallbacksForContainer(container);
            containerHolder.setContainerAvailableListener(new ContainerLoadedCallback());
            startMainActivity();
        }
    }, TIMEOUT_FOR_CONTAINER_OPEN_MILLISECONDS, TimeUnit.MILLISECONDS);

    ContainerHolder シングルトンの作成

    アプリケーションの実行ごとに ContainerHolder のインスタンスを 1 つだけ維持する必要があります。そのため、上記の例では ContainerHolderSingleton ユーティリティ クラスを使用して ContainerHolder インスタンスへのアクセスを管理しています。ContainerHolderSingleton クラスは次のようになります。

    package com.google.android.tagmanager.examples.cuteanimals;
    
    import com.google.android.gms.tagmanager.ContainerHolder;
    
    /**
     * Singleton to hold the GTM Container (since it should be only created once
     * per run of the app).
     */
    public class ContainerHolderSingleton {
        private static ContainerHolder containerHolder;
    
        /**
         * Utility class; don't instantiate.
         */
        private ContainerHolderSingleton() {
        }
    
        public static ContainerHolder getContainerHolder() {
            return containerHolder;
        }
    
        public static void setContainerHolder(ContainerHolder c) {
            containerHolder = c;
        }
    }

4. コンテナから設定値を取得する

コンテナが読み込まれたら、Container.get<type>() メソッドを使用して構成値を取得できます。設定値は、Google タグ マネージャーの値コレクション変数を使用して定義されます。たとえば、次のメソッドは、UI 要素で使用するために決定した最新の色を取得し、整数として返します。

/**
 * Returns an integer representing a color.
 */
private int getColor(String key) {
    return colorFromColorName(containerHolder.getContainer().getString(key));
}

このコードは、コンテナから色の名前を取得するために次の 2 つの処理を行います。

  1. ContainerHolder.getContainer() を使用して ContainerHolder から Container を取得します。
  2. Container.getString(key) を使用して色の値を取得します。キーと値は、Google タグ マネージャーのウェブ インターフェースで定義します。

5. dataLayer にイベントと値をプッシュする

Google タグ マネージャーには、dataLayer も用意されています。このコンテナにアプリに関する情報をプッシュすると、アプリの他の部分で読み取ったり、Google タグ マネージャーのウェブ インターフェースで設定したタグを配信したりできます。

dataLayer に値をプッシュする

dataLayer は、アプリケーションの他の部分で使用したり、Google タグ マネージャーのタグへの入力として使用したりする Key-Value ペアを保存するために使用できる永続化レイヤを提供します。

dataLayer に値を push するには、次のパターンを使用します。

  1. DataLayer シングルトンを取得します。
    DataLayer dataLayer = TagManager.getInstance(context).getDataLayer();
  2. DataLayer.push() を使用してイベントを push します。
    // Put the image_name into the data layer for future use.
    TagManager.getInstance(this).getDataLayer().push(IMAGE_NAME_KEY, imageName);

dataLayer から値を取得するには、DataLayer.get(key) を使用します。

dataLayer にイベントをプッシュする

dataLayer にイベントをプッシュすると、アプリケーション コードを、イベントに応じて配信するタグから分離できます。

たとえば、Google アナリティクスのスクリーンビュー トラッキング呼び出しをアプリケーションにハードコードする代わりに、スクリーン イベントを dataLayer にプッシュし、Google タグ マネージャーのウェブ インターフェースでトラッキング タグを定義できます。これにより、アプリケーション コードを更新することなく、そのタグを変更したり、画面イベントに応答するタグを追加したりできます。

dataLayer にイベントを push するには、次のパターンを使用します。

  1. DataLayer シングルトンを取得します。
    DataLayer dataLayer = TagManager.getInstance(context).getDataLayer();
  2. DataLayer.pushEvent() を使用してイベントを push します。
    dataLayer.pushEvent("openScreen", DataLayer.mapOf("screenName", screenName));

    DataLayer.mapOf() は、イベントが push されると同時に dataLayer を更新する Key-Value ペアのマップを簡単に生成できるユーティリティ メソッドです。

6. プレビュー、デバッグ、公開

あるバージョンのコンテナを公開する前に、そのコンテナをプレビューして、意図したとおりに機能することを確認する必要があります。Google タグ マネージャーを使用すると、ウェブ インターフェースでリンクと QR コードを生成し、それらを使用してアプリを開いて、コンテナのプレビュー版をプレビューできます。詳細ログモードを有効にして、予期しない動作をデバッグすることもできます。

プレビューしています

コンテナのバージョンをプレビューする手順は次のとおりです。

  1. このプレビュー Activity を AndroidManifest ファイルに追加します。
    <!--  Add preview activity. -->
    <activity
        android:name="com.google.android.gms.tagmanager.PreviewActivity"
        android:label="@string/app_name"
        android:noHistory="true">  <!-- optional, removes the previewActivity from the activity stack. -->
        <intent-filter>
          <data android:scheme="tagmanager.c.com.google.android.tagmanager.examples.cuteanimals" />
          <action android:name="android.intent.action.VIEW" />
          <category android:name="android.intent.category.DEFAULT" />
          <category android:name="android.intent.category.BROWSABLE"/>
        </intent-filter>
    </activity>

    次の行を変更して、アプリのパッケージ名を含めます。

    <data android:scheme="tagmanager.c.com.google.android.tagmanager.examples.cuteanimals" />
  2. Google タグ マネージャーのウェブ インターフェースで、プレビュー リンクを生成します。
    1. Google タグ マネージャーにログインします。
    2. プレビューするコンテナのバージョンを選択します。
    3. プレビュー ボタンをクリックします
    4. アプリのパッケージ名を入力し、[開始プレビュー リンクを作成] をクリックします。
  3. 生成されたリンクまたは QR コードを使用してアプリを起動します。
  4. プレビュー モードを終了するには、ウェブ インターフェースの [終了プレビュー リンクを作成] オプションで生成されたリンクをクリックします。

デバッグ

コンテナの実装に関する問題をトラブルシューティングする必要がある場合は、TagManager.setVerboseLoggingEnabled(true) を呼び出して詳細ログを有効にします。

// Modify the log level of the logger to print out not only
// warning and error messages, but also verbose, debug, info messages.
tagManager.setVerboseLoggingEnabled(true);

公開

コンテナをプレビューし、意図したとおりに機能していることを確認したら、コンテナを公開できます。コンテナの設定値、タグ、イベントは、次回コンテナが更新されたときにユーザーに公開されます。コンテナの更新の詳細

詳細設定

以下の各セクションでは、Google タグ マネージャーの実装をさらにカスタマイズするために使用する高度な設定オプションについて説明します。

コンテナの更新

デフォルトでは、コンテナは 12 時間ごとに更新可能になります。コンテナを手動で更新するには、ContainerHolder.refresh() を使用します。

ContainerHolderSingleton.getContainerHolder().refresh();

これは非同期呼び出しであり、すぐに返されるわけではありません。ネットワーク トラフィックを削減するため、refresh() は 15 分に 1 回しか呼び出せません。それ以外の場合は、何も行われません。