直接共有ターゲットを提供する

図 1: Sharesheet の直接共有行(1 を参照)

ダイレクト シェア ターゲットを使用すると、他のアプリのユーザーが URL、画像、その他のデータをアプリと簡単にすばやく共有できるようになります。ダイレクト シェアは、ユーザーがアプリを選択して連絡先を検索することなく、メッセージ アプリやソーシャル アプリの連絡先を Android 共有シートに直接表示します。

ShortcutManagerCompat は、非推奨の ChooserTargetService API との下位互換性を備えた共有ショートカットを提供する AndroidX API です。この方法は、 共有ショートカットと ChooserTargets の両方を公開する方法です。手順については、 AndroidX を使用して共有ショートカットと ChooserTargets の両方を提供するをご覧ください。 ご覧ください

ダイレクト シェア ターゲットを公開する

Sharesheet ダイレクト シェアの行には、Google Chat によって提供される動的ショートカットのみが表示されます。 ショートカット共有 API。ダイレクト共有を公開するには、次の手順を完了してください できます。

  1. アプリの XML リソース ファイルで、share-target 要素を宣言します。

    <shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
    <share-target android:targetClass="com.example.android.sharingshortcuts.SendMessageActivity">
        <data android:mimeType="text/plain" />
        <category android:name="com.example.android.sharingshortcuts.category.TEXT_SHARE_TARGET" />
    </share-target>
    </shortcuts>
    
  2. アプリの初期化時に、setDynamicShortcuts を使用して動的ショートカットを重要度順に並べ替えます。

    インデックスが低いほど重要度が高くなります。個人または少人数のグループに 上位の会話を新しい順に並べて表示できます。 説明します。使われていないショートカットを公開しない会話を 過去 30 日間のユーザー アクションは、古いものとみなされます。

    KotlinJava
    ShortcutManagerCompat.setDynamicShortcuts(myContext, listOf(shortcut1, shortcut2, ..))
    List<ShortcutInfoCompat> shortcuts = new ArrayList<>();
    shortcuts.add(shortcut1);
    shortcuts.add(shortcut2);
    ...
    ShortcutManagerCompat.setDynamicShortcuts(myContext, shortcuts);
  3. 通信アプリを開発している場合は、 ユーザーがアクセスするたびに直ちに pushDynamicShortcut 連絡先との間でメッセージを送受信します。詳しくは、このページのコミュニケーション アプリのショートカットの使用状況を報告するをご覧ください。たとえば、ユーザーが送信したメッセージの使用状況を ショートカットの ShortcutInfoCompat.Builder#addCapabilityBindingactions.intent.SEND_MESSAGE 機能を含む)。

    KotlinJava
    val shortcutInfo = ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
      ...
      .setShortLabel(firstName)
      .setLongLabel(fullName)
      .setCategories(matchedCategories)
      .setLongLived(true)
    .addCapabilityBinding("actions.intent.SEND_MESSAGE").build()
    ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo)
    ShortcutInfoCompat shortcutInfo = new ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
      ...
      .setShortLabel(firstName)
      .setLongLabel(fullName)
      .setCategories(matchedCategories)
      .setLongLived(true)
      .addCapabilityBinding("actions.intent.SEND_MESSAGE")
      .build();
    
    ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo);
  4. ユーザーが連絡先を削除した場合は、 removeLongLivedShortcut。これは、ショートカットがシステム サービスによってキャッシュに保存されているかどうかに関係なく、ショートカットを削除する方法として推奨されます。次のコード スニペットは、その方法の例を示しています。

    KotlinJava
    val deleteShortcutId = "..."
    ShortcutManagerCompat.removeLongLivedShortcuts(myContext, listOf(deleteShortcutId))
    String deleteShortcutId = "...";
    ShortcutManagerCompat.removeLongLivedShortcuts(
        myContext, Arrays.asList(deleteShortcutId));

直接共有ターゲットのランキングを改善する

Android Sharesheet には、一定数のダイレクト シェア ターゲットが表示されます。これらの 提案はランク順に並べられます。サイトの掲載順位を上げるには、 ショートカットを作成します。

  • すべての shortcutIds が一意であり、異なるターゲットで再利用されないようにします。
  • 次の呼び出しによってショートカットが長く存続するようにする setLongLived(true)
  • 会話に関連するショートカットについて、ショートカットの使用状況を報告します 対応するショートカットを再公開して、メッセージの送受信を ShortcutManagerCompat.pushDynamicShortcut を使用します。 詳しくは、このページのコミュニケーション アプリのショートカットの使用状況を報告するをご覧ください。
  • 関連性のない、または古いダイレクト シェア ターゲット(過去 30 日以内にユーザーがメッセージを送信していない連絡先など)は指定しないでください。
  • SMS アプリの場合は、スパムと見なされるショートコードや会話のショートカットを指定しないでください。ユーザーがこの脆弱性を共有する可能性は 会話に集中できます。
  • setCategories() を呼び出して、ショートカットを適切な mimeType 属性に関連付けます。たとえば 連絡先が RCS または MMS に対応していない場合、 対応するショートカットを、次のような非テキスト MIME タイプに関連付けます。 image/*video/*
  • 特定の会話で、動的ショートカットがプッシュされて使用されると、 ショートカット ID は変更しないでください。これにより、使用状況データが確実に おすすめします

ユーザーがダイレクト共有ターゲットをタップした場合、アプリはユーザーを ターゲットのサブジェクトに対して直接アクションを実行できます。ユーザーに確認ダイアログを表示したり、タップされたターゲットとは関係のない UI にユーザーを誘導したりしないでください。たとえば、メッセージ アプリでダイレクト シェアの target は、選択したユーザーとの会話ビューにユーザーを誘導します。キーボードが表示され、メッセージには共有データが事前に入力されています。

Sharing Shortcuts API

Android 10(API レベル 29)以降では、 ShortcutInfo.Builder がメソッドと機能強化を追加しました には、共有ターゲットに関する追加情報を提供します。

setCategories()
Android 10 以降では、カテゴリを使用して、特定のスレッドでの 共有インテントまたはアクションを処理できます。共有の宣言をご覧ください。 target をご覧ください。共有ターゲットとして使用することを目的としたショートカットの場合、このフィールドは必須です。
setLongLived()

公開停止になったショートカットを有効にするかどうかを指定する (動的ショートカットまたは固定ショートカットとして)アプリが表示できない状態になっている必要があります。ショートカットの有効性が継続する場合、動的ショートカットとしては非公開になった後も、さまざまなシステム サービスによってキャッシュされる可能性があります。

ショートカットを長期にわたって維持すると、ランキングが向上します。詳細については、最高のランキングを取得するをご覧ください。

setShortLabel()setLongLabel()

個人を対象とするショートカットを公開する場合は、setLongLabel() にフルネームを格納し、setShortLabel() にニックネームやファースト ネームなどの短縮名を格納します。

GitHub で共有ショートカットを公開する例をご覧ください。

ショートカット画像を提供する

共有ショートカットを作成するには、setIcon() を通じて画像を追加する必要があります。

共有ショートカットは、システム サーフェス全体で表示される可能性があり、形状が変更されることもあります。また、Android バージョン 7、8、9(API レベル 25、 (26、27、28)を使用すると、背景のないビットマップのみのアイコンが表示される可能性があります。 大幅に低下させます意図どおりにショートカットを表示するには、IconCompat.createWithAdaptiveBitmap() を使用してアダプティブ ビットマップを提供します。

アダプティブ ビットマップがアダプティブ アイコンに適用されるガイドラインとサイズと同じになるようにしてください。 遵守するために最も一般的に行われているのは、目的の正方形ビットマップを 72×72 dp にスケーリングして、108×108 dp の透明なキャンバス内の中央に配置する方法です。アイコンに透明な領域が含まれている場合は、背景色を含める必要があります。背景色がないと、透明な領域は黒く表示されます。

特定の形状にマスキングした画像を提供しないようにしてください。たとえば、Android 10(API レベル 29)より前の時代では、円形にマスキングしたダイレクト シェア ChooserTarget のユーザー アバターを提供するのが一般的でした。Android Sharesheet やその他のアプリ Android 10 のシステム サーフェスでは、シェイプとテーマのショートカット画像が表示されるようになりました。 共有ショートカットを提供する場合は、ShortcutManagerCompat を通じて、後方互換ダイレクト シェア ChooserTarget オブジェクトの形状を自動的に円形に変更することをおすすめします。

共有ターゲットを宣言する

共有ターゲットは、静的ショートカットの定義と同様に、アプリのリソース ファイル内で宣言する必要があります。共有を追加 リソース ファイル内の <shortcuts> ルート要素内のターゲット定義 静的ショートカット定義と併用できます各 <share-targets> 要素 には、共有されたデータ型、一致するカテゴリ、および 共有インテントを処理するターゲット クラスを指定します。XML コードは次のようになります。

<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
  <share-target android:targetClass="com.example.android.sharingshortcuts.SendMessageActivity">
    <data android:mimeType="text/plain" />
    <category android:name="com.example.android.sharingshortcuts.category.TEXT_SHARE_TARGET" />
  </share-target>
</shortcuts>

共有ターゲットのデータ要素は、インテント フィルタのデータ指定と似ています。各共有ターゲットには 複数のカテゴリ(アプリの公開済みショートカットとのマッチングにのみ使用される) その共有ターゲットの定義が含まれます。カテゴリには、任意のアプリが定義した任意の 使用できます。

Android Sharesheet 内で上記の <share-target> 例と合致する共有ショートカットをユーザーが選択した場合、アプリは次の共有インテントを取得します。

Action: Intent.ACTION_SEND
ComponentName: {com.example.android.sharingshortcuts /
                com.example.android.sharingshortcuts.SendMessageActivity}
Data: Uri to the shared content
EXTRA_SHORTCUT_ID: <ID of the selected shortcut>

ユーザーがランチャーのショートカットから共有ターゲットを開くと、アプリは共有ショートカットを ShortcutManagerCompat に追加したときに作成されたインテントを取得します。別のインテントであるため、Intent.EXTRA_SHORTCUT_ID は利用できず、必要な場合は手動で ID を渡す必要があります。

コミュニケーション アプリでのショートカットの使用状況を報告する

コミュニケーション アプリを開発している場合は、送信メッセージと受信メッセージの両方の使用状況を報告することで、Android 共有シートでのランキングを改善できます。その連絡先を表す会話のショートカットを再公開するには、 ShortcutManagerCompat.pushDynamicShortcut

ショートカットの使用と機能バインディングに Android 5.0 との下位互換性がある (API 21)。

送信メッセージのショートカットの使用状況を報告する

ユーザーが送信したメッセージの使用状況を報告する機能は、メッセージを作成した後に [送信] ボタンをクリックする機能に似ています。

使用状況レポートをトリガーするには、actions.intent.SEND_MESSAGE 機能を使用して ShortcutInfoCompat.Builder#addCapabilityBinding でショートカットにケーパビリティ バインディングを指定します。

KotlinJava
val shortcutInfo = ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(firstName)
  .setLongLabel(fullName)
  .setCategories(matchedCategories)
  .setLongLived(true)
.addCapabilityBinding("actions.intent.SEND_MESSAGE").build()
ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo)
ShortcutInfoCompat shortcutInfo = new ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(firstName)
  .setLongLabel(fullName)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.SEND_MESSAGE")
  .build();

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo);

送信メッセージがグループ チャットの場合は、recipient タイプがケーパビリティに関連付けられているため、Audience パラメータ値も追加する必要があります。

KotlinJava
val shortcutInfo = ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(groupShortTitle)
  .setLongLabel(groupLongTitle)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.SEND_MESSAGE", "message.recipient.@type", listOf("Audience")).build()

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo)
ShortcutInfoCompat shortcutInfo = new ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(groupShortTitle)
  .setLongLabel(groupLongTitle)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.SEND_MESSAGE", "message.recipient.@type", Arrays.asList("Audience"))
  .build();

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo);

受信したメッセージのショートカットの使用状況を報告する

ユーザーが SMS、チャット メッセージ、メール、通知などのメッセージを受信したときに使用状況レポートをトリガーするには、actions.intent.RECEIVE_MESSAGE 機能を使用して ShortcutInfoCompat.Builder#addCapabilityBinding を介してショートカットで機能のバインディングを追加で指定する必要があります。

KotlinJava
val shortcutInfo = ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(firstName)
  .setLongLabel(fullName)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.RECEIVE_MESSAGE").build()

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo)
ShortcutInfoCompat shortcutInfo = new ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(firstName)
  .setLongLabel(fullName)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.RECEIVE_MESSAGE")
  .build();

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo);

受信メッセージがグループ チャットからのものである場合は、sender 型が機能に関連付けられているため、Audience パラメータ値も追加する必要があります。

KotlinJava
val shortcutInfo = ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(groupShortTitle)
  .setLongLabel(groupLongTitle)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.RECEIVE_MESSAGE", "message.sender.@type", listOf("Audience")).build()

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo)
ShortcutInfoCompat shortcutInfo = new ShortcutInfoCompat.Builder(myContext, staticConversationIdentifier)
  ...
  .setShortLabel(groupShortTitle)
  .setLongLabel(groupLongTitle)
  .setCategories(matchedCategories)
  .setLongLived(true)
  .addCapabilityBinding("actions.intent.RECEIVE_MESSAGE", "message.sender.@type", Arrays.asList("Audience"))
  .build();

ShortcutManagerCompat.pushDynamicShortcut(myContext, shortcutInfo);

AndroidX を使用して共有ショートカットと ChooserTarget の両方を提供する

AndroidX 互換性ライブラリを使用できるようにするには、アプリのマニフェスト内に meta-data の chooser-target-service と intent-filter のセットが含まれている必要があります。詳しくは、 現在の ChooserTargetService Direct Share API

このサービスは、すでに互換性ライブラリ内で宣言されているため、アプリのマニフェスト内でユーザーがサービスを宣言する必要はありません。ただし、共有アクティビティからサービスへのリンクを、チューザ ターゲット プロバイダに含める必要があります。

次の例の場合、ChooserTargetService の実装は androidx.core.content.pm.ChooserTargetServiceCompat です。これは AndroidX 内ですでに定義されています。

<activity
    android:name=".SendMessageActivity"
    android:label="@string/app_name"
    android:theme="@style/SharingShortcutsDialogTheme">
    <!-- This activity can respond to Intents of type SEND -->
    <intent-filter>
        <action android:name="android.intent.action.SEND" />
        <category android:name="android.intent.category.DEFAULT" />
        <data android:mimeType="text/plain" />
    </intent-filter>
    <!-- Only needed if you import the sharetarget AndroidX library that
         provides backwards compatibility with the old DirectShare API.
         The activity that receives the Sharing Shortcut intent needs to be
         taken into account with this chooser target provider. -->
    <meta-data
        android:name="android.service.chooser.chooser_target_service"
        android:value="androidx.sharetarget.ChooserTargetServiceCompat" />
</activity>

共有ショートカットに関するよくある質問

ショートカットの使用状況データはどのように保存され、デバイス外に保持されますか?

ショートカットは、暗号化されたディスク パーティションのシステムデータ ディレクトリに完全にデバイス上に保存されます。アイコン、インテント、連絡先やリソースの名前などのショートカット情報には、システム サービスと、ショートカットを公開したアプリでのみアクセスできます。

ダイレクト シェアリングはどのように進化してきましたか?

Android 6.0(API レベル 23)でダイレクト シェアが導入され、アプリは ChooserTargetService を通じて ChooserTarget オブジェクトを提供できるようになりました。結果: 事後対応的にオンデマンドで取得できるため、ターゲットの読み込みに時間がかかります。

Android 10(API レベル 29)では、ChooserTargetService Direct は 新しい Sharing Shortcuts API で API を共有します。結果を取得する代わりに Sharing Shortcuts API を使用すると、アプリでのダイレクト シェアの公開は 事前にターゲットを絞ることも できますこれにより、ShareSheet の準備時にダイレクト シェア ターゲットを取得するプロセスが大幅に高速化されました。ChooserTargetService ダイレクト シェア メカニズムは引き続き機能しますが、この方法で提供されたターゲットは、Sharing Shortcuts API を使用しているどのターゲットよりも下位にランク付けされます。

Android 11(API レベル 30)では ChooserTargetService サービスが非推奨になりました。ダイレクト シェア ターゲットを提供する唯一の方法は、Sharing Shortcuts API です。

共有ターゲットの公開ショートカットとランチャーの違い ショートカット(Google Chat 内でアプリアイコンを長押ししたときの一般的なショートカットの使い方)

「共有ターゲット」の目的で公開されているショートカットは、すべてランチャーのショートカットでもあり、アプリアイコンを長押しするとメニュー内に表示されます。アクティビティごとの最大ショートカット数の制限は、アプリが公開しているショートカットの総数(共有ターゲットと旧式のランチャー ショートカットの合計)にも適用されます。

公開する共有ショートカットの数に関するガイダンスはありますか。

共有ショートカットの数は、動的な ショートカットを getMaxShortcutCountPerActivity(android.content.Context)。上限までの任意の数を公開できますが、共有ショートカットはアプリ ランチャーの長押しと共有シートに表示されることを考慮する必要があります。ほとんどのアプリ ランチャーがオン 縦表示で最大 4 つまたは 5 つのショートカットを長押し表示する 横表示では 8 文字こちらを参照 よくある質問 をご覧ください。