このページは Cloud Translation API によって翻訳されました。

Android v4 - スタートガイド

はじめに

Google タグマネージャーを使用すると、デベロッパーは、アプリケーションバイナリを再構築してアプリマーケットプレイスに再送信しなくても、Google タグマネージャーのインターフェースを使用してモバイルアプリの設定値を変更できます。

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

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

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

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

また、アプリにトラッキングタグとピクセルを動的に実装することも可能です。デベロッパーは重要なイベントをデータレイヤーにプッシュし、後でどのトラッキングタグやピクセルを配信するかを決めることができます。

始める前に

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

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

はじめに

このスタートガイドを修了すると、以下の方法を理解できます。

Google タグマネージャーをプロジェクトに追加する
アプリケーションでタグマネージャーを初期化する
タグマネージャーコンテナから設定値を取得する
値とイベントを dataLayer に push します
コンテナをプレビュー、デバッグし、公開する

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

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

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

Google Play 開発者サービス SDK をセットアップします。

Android Studio 以外の IDE を使用する場合は、AndroidManifest.xml ファイルに

<!-- For TagManager SDK -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

権限を追加します。

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 タグマネージャーは、アプリケーションの初回実行時にデフォルトのコンテナを使用します。アプリがネットワーク経由で新しいコンテナを取得できるようになると、デフォルトコンテナの使用はすぐに停止します。

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

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

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

3. Google タグマネージャーの初期化

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

TagManager シングルトンを取得します。

TagManager tagManager = TagManager.getInstance(this);

TagManager シングルトンを使用して、Google タグマネージャーのコンテナ ID とデフォルトのコンテナファイルを指定して、コンテナの読み込みをリクエストします。コンテナ ID は大文字で、Google タグマネージャー管理画面のコンテナ ID と完全に一致している必要があります。loadContainerPreferNonDefault() の呼び出しは非ブロッキングであり、 PendingResult を返します。
```
PendingResult<ContainerHolder> pending =
        tagManager.loadContainerPreferNonDefault(CONTAINER_ID,
        R.raw.defaultcontainer_binary);
```

読み込みが完了またはタイムアウトしたら、 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;
    }
}

サンプルアプリのコードスニペット

次のスニペットは、サンプル Activity の onCreate() メソッドに実装された完全なパターンを示しています。

package com.google.android.tagmanager.examples.cuteanimals;

import java.util.concurrent.TimeUnit;
import java.util.Map;

import android.app.Activity;
import android.app.AlertDialog;
import android.content.DialogInterface;
import android.content.Intent;
import android.os.Bundle;
import android.util.Log;

import com.google.android.gms.common.api.PendingResult;
import com.google.android.gms.common.api.ResultCallback;
import com.google.android.gms.tagmanager.Container;
import com.google.android.gms.tagmanager.Container.FunctionCallMacroCallback;
import com.google.android.gms.tagmanager.Container.FunctionCallTagCallback;
import com.google.android.gms.tagmanager.ContainerHolder;
import com.google.android.gms.tagmanager.TagManager;

/**
 * Displays simple splash screen while GTM container is loading. Once the container is loaded,
 * launches the {@link MainActivity}.
 */
public class SplashScreenActivity extends Activity {
    private static final long TIMEOUT_FOR_CONTAINER_OPEN_MILLISECONDS = 2000;
    private static final String CONTAINER_ID = "GTM-XXXX";

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_splashscreen);

        TagManager tagManager = TagManager.getInstance(this);

        // 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);

        PendingResult<ContainerHolder> pending =
                tagManager.loadContainerPreferNonDefault(CONTAINER_ID,
                R.raw.defaultcontainer_binary);

        // 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);
  // Rest of the Activity definition.
}

4. コンテナからの設定値の取得

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

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

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

ContainerHolder.getContainer() を使用して、ContainerHolder から Container を取得します。
Google タグマネージャーの管理画面でキーと値を定義した Container.getString(key) を使用して、色の値を取得します。

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

Google タグマネージャーには dataLayer も用意されています。これを使用して、アプリの他の部分で読み取ったアプリや、Google タグマネージャーの管理画面で設定したタグの配信にアプリに関する情報をプッシュできます。

dataLayer に値を push する

dataLayer が提供する永続性レイヤを使用すると、アプリの他の部分で使用する、または Google タグマネージャータグへの入力として使用する Key-Value ペアを格納できます。

dataLayer に値をプッシュするには、次のパターンを使用します。

DataLayer シングルトンを取得します。

DataLayer dataLayer = TagManager.getInstance(context).getDataLayer();

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 にイベントを push する

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

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

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

DataLayer シングルトンを取得します。

DataLayer dataLayer = TagManager.getInstance(context).getDataLayer();

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

サンプルアプリのコードスニペット

次のユーティリティクラスは、dataLayer で、アプリで開閉する画面に関する情報などのイベントをプッシュする方法を示しています。

package com.google.android.tagmanager.examples.cuteanimals;

import android.content.Context;

import com.google.android.gms.tagmanager.DataLayer;
import com.google.android.gms.tagmanager.TagManager;

/**
 * Utility class.
 */
public class Utils {
    private Utils() {
        // private constructor.
    }

    /**
     * Push an "openScreen" event with the given screen name. Tags that match that event will fire.
     */
    public static void pushOpenScreenEvent(Context context, String screenName) {
        DataLayer dataLayer = TagManager.getInstance(context).getDataLayer();
        dataLayer.pushEvent("openScreen", DataLayer.mapOf("screenName", screenName));
    }

    /**
     * Push a "closeScreen" event with the given screen name. Tags that match that event will fire.
     */
    public static void pushCloseScreenEvent(Context context, String screenName) {
        DataLayer dataLayer = TagManager.getInstance(context).getDataLayer();
        dataLayer.pushEvent("closeScreen", DataLayer.mapOf("screenName", screenName));
    }
}

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

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

プレビューしています

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

このプレビュー 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" />

Google タグマネージャーの管理画面でプレビューリンクを生成します。
1. Google タグマネージャーにログインします。
2. プレビューするコンテナのバージョンを選択します。
3. プレビュー ボタンをクリックします
4. アプリのパッケージ名を入力し、[開始プレビューリンクを生成] をクリックします。
生成されたリンクまたは QR コードを使用してアプリを起動します
プレビューモードを終了するには、管理画面の [終了プレビューリンクを作成] で生成されたリンクを使用します。

デバッグ

コンテナの実装についてトラブルシューティングする必要がある場合は、 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 回だけ呼び出すことができます。そうしないと、何も呼び出されません。

サンプルアプリのコードスニペット

public void refreshButtonClicked(@SuppressWarnings("unused") View view) {
    Log.i(TAG, "refreshButtonClicked");
    ContainerHolderSingleton.getContainerHolder().refresh();

    // Push the "refresh" event to trigger firing an analytics tag.
    TagManager.getInstance(this).getDataLayer().push("event", "refresh");
    // Push the "custom tag" event to trigger firing a custom function call tag.
    TagManager.getInstance(this).getDataLayer().push("event", "custom_tag");
    updateCategories();
}

Android v4 - スタートガイド

はじめに

始める前に

はじめに

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

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

3. Google タグ マネージャーの初期化

ContainerHolder シングルトンの作成

サンプルアプリのコード スニペット

4. コンテナからの設定値の取得

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

dataLayer に値を push する

dataLayer にイベントを push する

サンプルアプリのコード スニペット

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

プレビューしています

デバッグ

公開中

詳細構成

コンテナの更新

サンプルアプリのコード スニペット

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

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

3. Google タグマネージャーの初期化

サンプルアプリのコードスニペット

サンプルアプリのコードスニペット

サンプルアプリのコードスニペット