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

クエリパラメータを使用して信頼できるウェブアクティビティに情報を渡す

André Cipriani Bandarra

アプリで Trusted Web Activity を使用する場合、デベロッパーはアプリのネイティブ部分からプログレッシブウェブアプリ（PWA）に情報を渡す必要がある場合があります。

一般的なユースケースは、カスタム分析セグメントを実装して、信頼できるウェブアクティビティから開始されたインストールとセッションを測定することです。これを実装するには、起動 URL にクエリパラメータを追加します。

開始 URL の変更

PWA に渡されるパラメータがユーザーや起動間で同じままである場合は、パラメータを起動 URL に直接追加できます。たとえば、デベロッパーが、信頼できるウェブアクティビティから作成されたナビゲーションセッションの数を測定する場合などです。

Bubblewrap を使用する

Bubblewrap は、信頼できるウェブアクティビティを使用して既存の PWA を起動する Android アプリのプロジェクトを作成するためにデベロッパーを支援するために作成されたツールです。これには、ライブラリとコマンドラインインターフェース（CLI）の両方が含まれています。

新しいプロジェクトを作成する

Bubblewrap CLI を使用する場合、プロジェクトは init コマンドで初期化され、パラメータとして指定されたウェブマニフェストからデフォルト値が作成されます。

bubblewrap init --manifest https://material.money/manifest.json

ウィザードでは、ウェブマニフェストの start_url がデフォルトとして使用され、その値を確認するようユーザーに求めるメッセージが表示されます。これにより、デベロッパーは、プログレッシブウェブアプリの起動に使用する URL に追加のパラメータを追加できます。

Bubblewrap CLI の出力

既存のプロジェクトの変更

Bubblewrap がプロジェクトを生成すると、その特定のプロジェクトの情報は、プロジェクトフォルダ内の twa-manifest.json というファイルに保存されます。既存のプロジェクトの開始 URL を変更するには、次のファイルを変更する必要があります。

{
  ...
  "startUrl": "/?utm_source=trusted-web-activity",
  ...
}

次に、プロジェクトファイルを再生成して、新しい開始 URL を適用します。

bubblewrap update

Android Studio の使用

Android Studio とデフォルトの LauncherActivity を使用している場合、startUrl は AndroidManifest.xml 内のメタタグとして定義されます。このタグを変更することで、信頼できるウェブアクティビティの起動に使用する URL を変更できます。

<activity android:name="com.google.androidbrowserhelper.trusted.LauncherActivity"
    android:label="@string/app_name">
    ...
    <meta-data android:name="android.support.customtabs.trusted.DEFAULT_URL"
        android:value="https://svgomg.firebaseapp.com/?utm_source=trusted-web-activity" />
    ...
</activity>

開始 URL の動的な変更

一方、ユーザーやセッションごとに変わるパラメータを作成したい場合もあります。ほとんどの場合、アプリの Android 側から詳細を収集して Progressive Web App に渡す必要があります。

ステップ 1: カスタム LauncherActivity を作成する

public class CustomQueryStringLauncherActivity extends LauncherActivity {
    private String getDynamicParameterValue() {
        return String.valueOf((int)(Math.random() * 1000));
    }

    @Override
    protected Uri getLaunchingUrl() {
        // Get the original launch Url.
        Uri uri = super.getLaunchingUrl();

        // Get the value we want to use for the parameter value
        String customParameterValue = getDynamicParameterValue();

        // Append the extra parameter to the launch Url
        return uri
                .buildUpon()
                .appendQueryParameter("my_parameter", customParameterValue)
                .build();
    }
}

ステップ 2: カスタムの LauncherActivity を使用するように `AndroidManifest.xml` を変更する

<activity android:name="com.myapp.CustomQueryStringLauncherActivity"
    android:label="@string/app_name">
    ...
    <meta-data android:name="android.support.customtabs.trusted.DEFAULT_URL"
        android:value="https://squoosh.app/?utm_source=trusted-web-activity" />
    ...
</activity>

まとめ

ネイティブパートからアプリケーションのウェブパートに情報を渡すには、クエリパラメータを使用します。クエリ文字列にパラメータを追加すると、ページで実行されているスクリプトからアクセスできるようになります。また、ユーザーが別のページに移動したときや、デベロッパーが共有アクションを実装したときに、参照の一部になることもあります。

デベロッパーは、これらの影響を認識し、link rel=noreferrer を使用するか、page location API を使用して URL をクリーンアップすることで、影響を軽減できます。

現時点では、信頼できるウェブアクティビティプロトコルには、ウェブ部分が呼び出された後にアプリケーションのネイティブ部分とメッセージを交換するメカニズムはありません。

既存または今後リリースされる Web Platform API により、デベロッパーが必要とするほとんどのユースケースに対応できると考えています。新規または今後のウェブ API をお探しの場合は、新機能のステータスページをご覧ください。