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

直接共有ターゲットを使用すると、他のアプリのユーザーが URL や画像などのデータをアプリと簡単かつ迅速に共有できます。直接共有は、メッセージング アプリやソーシャル アプリの連絡先を Android Sharesheet に直接表示することで、アプリを選択して連絡先を検索する必要はありません。

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

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

Sharesheet ダイレクト シェア行には、Sharing Shortcuts 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 日間にユーザー アクティビティがない会話は古いとみなされます。

   Kotlin

   ShortcutManagerCompat.setDynamicShortcuts(myContext, listOf(shortcut1, shortcut2, ..))
   

   Java

   List<ShortcutInfoCompat> shortcuts = new ArrayList<>();
   shortcuts.add(shortcut1);
   shortcuts.add(shortcut2);
   ...
   ShortcutManagerCompat.setDynamicShortcuts(myContext, shortcuts);
   
   

3. 通信アプリを開発している場合は、ユーザーが連絡先との間でメッセージを送受信するたびに、すぐに pushDynamicShortcut を介してショートカットの使用状況を報告します。詳細については、このページの通信アプリのショートカットの使用状況を報告するをご覧ください。たとえば、ユーザーが送信したメッセージの使用状況を報告するには、actions.intent.SEND_MESSAGE ケーパビリティの ShortcutInfoCompat.Builder#addCapabilityBinding でショートカットのケーパビリティ バインディングを指定します。

   Kotlin

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

   Java

   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 を使用します。システム サービスによってキャッシュされているかどうかにかかわらず、ショートカットを削除する場合は、この方法をおすすめします。次のコード スニペットは、その方法の例を示しています。

   Kotlin

   val deleteShortcutId = "..."
   ShortcutManagerCompat.removeLongLivedShortcuts(myContext, listOf(deleteShortcutId))
   

   Java

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

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

Android Sharesheet には、一定数のダイレクト シェア ターゲットが表示されます。これらの提案はランク順に並べ替えられます。次の手順で、ショートカットのランキングを改善できる場合があります。

• すべての shortcutIds が一意であり、異なるターゲットで再利用されないようにします。
• setLongLived(true) を呼び出して、ショートカットが長く存続するようにします。
• 会話関連のショートカットの場合、ShortcutManagerCompat.pushDynamicShortcut で対応するショートカットを再公開して、送受信メッセージのショートカットの使用状況を報告します。詳細については、このページの通信アプリのショートカットの使用状況を報告するをご覧ください。
• 無関係なダイレクト共有ターゲットや最新でないダイレクト共有ターゲットは指定しないでください。たとえば、過去 30 日間にユーザーがメッセージを送信していない連絡先は指定しないでください。
• SMS アプリでは、スパムの可能性があると識別された短いコードや会話のショートカットを提供しないでください。ユーザーがそのような会話を共有する可能性はほとんどありません。
• setCategories() を呼び出して、ショートカットを適切な mimeType 属性に関連付けます。たとえば、SMS アプリの連絡先が RCS または MMS に対応していない場合、対応するショートカットを image/* や video/* などの非テキスト MIME タイプには関連付けません。
• 会話で動的ショートカットがプッシュされて使用状況が報告されたら、ショートカット ID を変更しないでください。これにより、ランキングに使用する使用状況データを確実に保持できます。

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

Sharing Shortcuts API

Android 10（API レベル 29）以降、ShortcutInfo.Builder により、共有ターゲットに関する追加情報を提供するメソッドと拡張機能が追加されました。

setCategories()

Android 10 以降では、共有インテントまたは共有アクションを処理できるショートカットのフィルタリングにもカテゴリが使用されます。詳細については、共有ターゲットを宣言するをご覧ください。このフィールドは、共有ターゲットとして使用するショートカットに必要です。

setLongLived()

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

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

setShortLabel()、setLongLabel()

ショートカットを個々のユーザーに公開する場合は、setLongLabel() にはフルネームを、setShortLabel() にはニックネームやファースト ネームなどの略称を含めます。

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

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

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

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

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

特定の形状にマスキングした画像を提供しないようにしてください。たとえば、Android 10（API レベル 29）より前では、円にマスクされたダイレクト シェア ChooserTarget のユーザー アバターを提供するのが一般的でした。Android 10 の Android Sharesheet やその他のシステム サーフェスで、ショートカット画像の形状とテーマを設定できるようになりました。共有ショートカットを提供するおすすめの方法は、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 Sharesheet 内のランキングを改善できます。これを行うには、ShortcutManagerCompat.pushDynamicShortcut で連絡先を表す会話のショートカットを再公開します。

ショートカットの使用と機能バインディングは、Android 5.0（API 21）との下位互換性があります。

送信メールのショートカットの使用状況を報告

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

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

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 パラメータ値も追加する必要があります。

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 を使用して、ショートカットにケーパビリティ バインディングをさらに指定する必要があります。

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 パラメータ値も追加する必要があります。

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 Share API が新しい Sharing Shortcuts API に置き換えられました。Sharing Shortcuts API を使用すると、事後的にオンデマンドで結果を取得するのではなく、事前にダイレクト シェア ターゲットを公開できます。これにより、ShareSheet の準備時に直接共有ターゲットを取得するプロセスが高速化されました。ChooserTargetService ダイレクト シェア メカニズムは引き続き機能しますが、この方法で提供されたターゲットは、Sharing Shortcuts API を使用するどのターゲットよりも低くランク付けされます。

Android 11（API レベル 30）では ChooserTargetService サービスが非推奨になり、Sharing Shortcuts API がダイレクト共有ターゲットを提供する唯一の方法です。

共有ターゲットの公開ショートカットは、ランチャーのショートカット（ランチャーのアプリアイコンを長押ししたときのショートカットの一般的な使用）とどのように異なりますか？

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

公開する必要がある共有ショートカットの数に関するガイダンスはどのようなものですか。

共有ショートカットの数は、getMaxShortcutCountPerActivity(android.content.Context) で利用可能な動的ショートカットと同じ上限に制限されます。この上限まで任意の数を公開できますが、共有ショートカットは、アプリ ランチャーの長押しと共有シートに表示される可能性があるので注意してください。長押し時のほとんどのアプリ ランチャーは、縦表示では最大 4 ～ 5 個、横表示では最大 8 個のショートカットを表示します。ショートカットの共有の詳細とガイダンスについては、よくある質問をご覧ください。