本頁面由 Cloud Translation API 翻譯而成。

讓 TV 應用程式可供搜尋

Android TV 會使用 Android 搜尋介面從已安裝的應用程式擷取內容資料，然後向使用者提供搜尋結果。您可以在這些結果中納入應用程式的內容資料，讓使用者立即存取應用程式中的內容。

您的應用程式必須提供資料欄位，方便 Android TV 在使用者搜尋對話方塊中輸入字元時產生建議搜尋結果。為此，您的應用程式必須實作提供建議的內容供應器，並附上 searchable.xml 設定檔，用於說明內容供應器和 Android TV 的其他重要資訊。此外，您需要一個活動，用來處理使用者選取建議搜尋結果時觸發的意圖。詳情請參閱「新增自訂搜尋建議」。本指南將說明 Android TV 應用程式專屬的重點。

閱讀本指南之前，請先熟悉 Search API 指南中說明的概念。此外，也請參閱「新增搜尋功能」一文。

本指南中的程式碼範例來自 Leanback 範例應用程式。

識別資料欄

SearchManager 會說明預期需要的資料欄位，並將這些欄位顯示為本機資料庫的資料欄。無論資料格式為何，您必須將資料欄位對應至這些資料欄，通常位於存取內容資料的類別中。如要瞭解如何建立將現有資料對應至必要欄位的類別，請參閱建構建議資料表。

SearchManager 類別包含 Android TV 的數個資料欄。下表將說明一些更重要的資料欄。

值	說明
`SUGGEST_COLUMN_TEXT_1`	您的內容名稱 (必填)
`SUGGEST_COLUMN_TEXT_2`	內容的文字說明
`SUGGEST_COLUMN_RESULT_CARD_IMAGE`	內容的圖片、海報或封面
`SUGGEST_COLUMN_CONTENT_TYPE`	媒體的 MIME 類型
`SUGGEST_COLUMN_VIDEO_WIDTH`	媒體的解析度寬度
`SUGGEST_COLUMN_VIDEO_HEIGHT`	媒體的解析度高度
`SUGGEST_COLUMN_PRODUCTION_YEAR`	內容製作年份 (必填)
`SUGGEST_COLUMN_DURATION`	媒體的時間長度 (以毫秒為單位) (必填)

搜尋架構需要下列資料欄：

如果這些資料欄的值與 Google 伺服器找到的相同內容值相符，系統就會在內容的詳細資料檢視畫面中，提供應用程式的深層連結，以及其他供應器的應用程式連結。詳情請參閱「在詳細資料畫面中指向應用程式的深層連結」一節。

應用程式的資料庫類別可能會將資料欄定義如下：

Kotlin

class VideoDatabase {
    companion object {
        // The columns we'll include in the video database table
        val KEY_NAME = SearchManager.SUGGEST_COLUMN_TEXT_1
        val KEY_DESCRIPTION = SearchManager.SUGGEST_COLUMN_TEXT_2
        val KEY_ICON = SearchManager.SUGGEST_COLUMN_RESULT_CARD_IMAGE
        val KEY_DATA_TYPE = SearchManager.SUGGEST_COLUMN_CONTENT_TYPE
        val KEY_IS_LIVE = SearchManager.SUGGEST_COLUMN_IS_LIVE
        val KEY_VIDEO_WIDTH = SearchManager.SUGGEST_COLUMN_VIDEO_WIDTH
        val KEY_VIDEO_HEIGHT = SearchManager.SUGGEST_COLUMN_VIDEO_HEIGHT
        val KEY_AUDIO_CHANNEL_CONFIG = SearchManager.SUGGEST_COLUMN_AUDIO_CHANNEL_CONFIG
        val KEY_PURCHASE_PRICE = SearchManager.SUGGEST_COLUMN_PURCHASE_PRICE
        val KEY_RENTAL_PRICE = SearchManager.SUGGEST_COLUMN_RENTAL_PRICE
        val KEY_RATING_STYLE = SearchManager.SUGGEST_COLUMN_RATING_STYLE
        val KEY_RATING_SCORE = SearchManager.SUGGEST_COLUMN_RATING_SCORE
        val KEY_PRODUCTION_YEAR = SearchManager.SUGGEST_COLUMN_PRODUCTION_YEAR
        val KEY_COLUMN_DURATION = SearchManager.SUGGEST_COLUMN_DURATION
        val KEY_ACTION = SearchManager.SUGGEST_COLUMN_INTENT_ACTION
        ...
    }
    ...
}

Java

public class VideoDatabase {
    // The columns we'll include in the video database table
    public static final String KEY_NAME = SearchManager.SUGGEST_COLUMN_TEXT_1;
    public static final String KEY_DESCRIPTION = SearchManager.SUGGEST_COLUMN_TEXT_2;
    public static final String KEY_ICON = SearchManager.SUGGEST_COLUMN_RESULT_CARD_IMAGE;
    public static final String KEY_DATA_TYPE = SearchManager.SUGGEST_COLUMN_CONTENT_TYPE;
    public static final String KEY_IS_LIVE = SearchManager.SUGGEST_COLUMN_IS_LIVE;
    public static final String KEY_VIDEO_WIDTH = SearchManager.SUGGEST_COLUMN_VIDEO_WIDTH;
    public static final String KEY_VIDEO_HEIGHT = SearchManager.SUGGEST_COLUMN_VIDEO_HEIGHT;
    public static final String KEY_AUDIO_CHANNEL_CONFIG =
            SearchManager.SUGGEST_COLUMN_AUDIO_CHANNEL_CONFIG;
    public static final String KEY_PURCHASE_PRICE = SearchManager.SUGGEST_COLUMN_PURCHASE_PRICE;
    public static final String KEY_RENTAL_PRICE = SearchManager.SUGGEST_COLUMN_RENTAL_PRICE;
    public static final String KEY_RATING_STYLE = SearchManager.SUGGEST_COLUMN_RATING_STYLE;
    public static final String KEY_RATING_SCORE = SearchManager.SUGGEST_COLUMN_RATING_SCORE;
    public static final String KEY_PRODUCTION_YEAR = SearchManager.SUGGEST_COLUMN_PRODUCTION_YEAR;
    public static final String KEY_COLUMN_DURATION = SearchManager.SUGGEST_COLUMN_DURATION;
    public static final String KEY_ACTION = SearchManager.SUGGEST_COLUMN_INTENT_ACTION;
...

從 SearchManager 資料欄建立對應關係到資料欄位時，您必須一併指定 _ID，為每個資料列提供專屬 ID。

Kotlin


companion object {
    ....
    private fun buildColumnMap(): Map<String, String> {
        return mapOf(
          KEY_NAME to KEY_NAME,
          KEY_DESCRIPTION to KEY_DESCRIPTION,
          KEY_ICON to KEY_ICON,
          KEY_DATA_TYPE to KEY_DATA_TYPE,
          KEY_IS_LIVE to KEY_IS_LIVE,
          KEY_VIDEO_WIDTH to KEY_VIDEO_WIDTH,
          KEY_VIDEO_HEIGHT to KEY_VIDEO_HEIGHT,
          KEY_AUDIO_CHANNEL_CONFIG to KEY_AUDIO_CHANNEL_CONFIG,
          KEY_PURCHASE_PRICE to KEY_PURCHASE_PRICE,
          KEY_RENTAL_PRICE to KEY_RENTAL_PRICE,
          KEY_RATING_STYLE to KEY_RATING_STYLE,
          KEY_RATING_SCORE to KEY_RATING_SCORE,
          KEY_PRODUCTION_YEAR to KEY_PRODUCTION_YEAR,
          KEY_COLUMN_DURATION to KEY_COLUMN_DURATION,
          KEY_ACTION to KEY_ACTION,
          BaseColumns._ID to ("rowid AS " + BaseColumns._ID),
          SearchManager.SUGGEST_COLUMN_INTENT_DATA_ID to ("rowid AS " + SearchManager.SUGGEST_COLUMN_INTENT_DATA_ID),
          SearchManager.SUGGEST_COLUMN_SHORTCUT_ID to ("rowid AS " + SearchManager.SUGGEST_COLUMN_SHORTCUT_ID)
        )
    }
}

Java

...
  private static HashMap<String, String> buildColumnMap() {
    HashMap<String, String> map = new HashMap<String, String>();
    map.put(KEY_NAME, KEY_NAME);
    map.put(KEY_DESCRIPTION, KEY_DESCRIPTION);
    map.put(KEY_ICON, KEY_ICON);
    map.put(KEY_DATA_TYPE, KEY_DATA_TYPE);
    map.put(KEY_IS_LIVE, KEY_IS_LIVE);
    map.put(KEY_VIDEO_WIDTH, KEY_VIDEO_WIDTH);
    map.put(KEY_VIDEO_HEIGHT, KEY_VIDEO_HEIGHT);
    map.put(KEY_AUDIO_CHANNEL_CONFIG, KEY_AUDIO_CHANNEL_CONFIG);
    map.put(KEY_PURCHASE_PRICE, KEY_PURCHASE_PRICE);
    map.put(KEY_RENTAL_PRICE, KEY_RENTAL_PRICE);
    map.put(KEY_RATING_STYLE, KEY_RATING_STYLE);
    map.put(KEY_RATING_SCORE, KEY_RATING_SCORE);
    map.put(KEY_PRODUCTION_YEAR, KEY_PRODUCTION_YEAR);
    map.put(KEY_COLUMN_DURATION, KEY_COLUMN_DURATION);
    map.put(KEY_ACTION, KEY_ACTION);
    map.put(BaseColumns._ID, "rowid AS " +
            BaseColumns._ID);
    map.put(SearchManager.SUGGEST_COLUMN_INTENT_DATA_ID, "rowid AS " +
            SearchManager.SUGGEST_COLUMN_INTENT_DATA_ID);
    map.put(SearchManager.SUGGEST_COLUMN_SHORTCUT_ID, "rowid AS " +
            SearchManager.SUGGEST_COLUMN_SHORTCUT_ID);
    return map;
  }
...

在上述範例中，請留意 SUGGEST_COLUMN_INTENT_DATA_ID 欄位的對應情形。這是 URI 的一部分，會指向這個列中資料專屬的內容，URI 的最後部分會說明內容的儲存位置。URI 的第一部分 (表格中所有資料列都通用) 會在 searchable.xml 檔案中設為 android:searchSuggestIntentData 屬性，如「處理搜尋建議」一節所述。

如果資料表中每列的 URI 第一部分都不同，請使用 SUGGEST_COLUMN_INTENT_DATA 欄位對應該值。使用者選取此內容時，啟動的意圖會從 SUGGEST_COLUMN_INTENT_DATA_ID 的組合以及 android:searchSuggestIntentData 屬性或 SUGGEST_COLUMN_INTENT_DATA 欄位值提供意圖資料。

提供搜尋建議資料

實作內容供應器，將搜尋字詞建議傳回 Android TV 搜尋對話方塊。每當您輸入字母時，系統都會呼叫 query() 方法，向內容供應器查詢建議。實作 query() 時，內容供應器會搜尋您的建議資料，並傳回 Cursor，指向您為建議指定的資料列。

Kotlin

fun query(uri: Uri, projection: Array<String>, selection: String, selectionArgs: Array<String>,
        sortOrder: String): Cursor {
    // Use the UriMatcher to see what kind of query we have and format the db query accordingly
    when (URI_MATCHER.match(uri)) {
        SEARCH_SUGGEST -> {
            Log.d(TAG, "search suggest: ${selectionArgs[0]} URI: $uri")
            if (selectionArgs == null) {
                throw IllegalArgumentException(
                        "selectionArgs must be provided for the Uri: $uri")
            }
            return getSuggestions(selectionArgs[0])
        }
        else -> throw IllegalArgumentException("Unknown Uri: $uri")
    }
}

private fun getSuggestions(query: String): Cursor {
    val columns = arrayOf<String>(
            BaseColumns._ID,
            VideoDatabase.KEY_NAME,
            VideoDatabase.KEY_DESCRIPTION,
            VideoDatabase.KEY_ICON,
            VideoDatabase.KEY_DATA_TYPE,
            VideoDatabase.KEY_IS_LIVE,
            VideoDatabase.KEY_VIDEO_WIDTH,
            VideoDatabase.KEY_VIDEO_HEIGHT,
            VideoDatabase.KEY_AUDIO_CHANNEL_CONFIG,
            VideoDatabase.KEY_PURCHASE_PRICE,
            VideoDatabase.KEY_RENTAL_PRICE,
            VideoDatabase.KEY_RATING_STYLE,
            VideoDatabase.KEY_RATING_SCORE,
            VideoDatabase.KEY_PRODUCTION_YEAR,
            VideoDatabase.KEY_COLUMN_DURATION,
            VideoDatabase.KEY_ACTION,
            SearchManager.SUGGEST_COLUMN_INTENT_DATA_ID
    )
    return videoDatabase.getWordMatch(query.toLowerCase(), columns)
}

Java

@Override
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
        String sortOrder) {
    // Use the UriMatcher to see what kind of query we have and format the db query accordingly
    switch (URI_MATCHER.match(uri)) {
        case SEARCH_SUGGEST:
            Log.d(TAG, "search suggest: " + selectionArgs[0] + " URI: " + uri);
            if (selectionArgs == null) {
                throw new IllegalArgumentException(
                        "selectionArgs must be provided for the Uri: " + uri);
            }
            return getSuggestions(selectionArgs[0]);
        default:
            throw new IllegalArgumentException("Unknown Uri: " + uri);
    }
}

private Cursor getSuggestions(String query) {
    query = query.toLowerCase();
    String[] columns = new String[]{
        BaseColumns._ID,
        VideoDatabase.KEY_NAME,
        VideoDatabase.KEY_DESCRIPTION,
        VideoDatabase.KEY_ICON,
        VideoDatabase.KEY_DATA_TYPE,
        VideoDatabase.KEY_IS_LIVE,
        VideoDatabase.KEY_VIDEO_WIDTH,
        VideoDatabase.KEY_VIDEO_HEIGHT,
        VideoDatabase.KEY_AUDIO_CHANNEL_CONFIG,
        VideoDatabase.KEY_PURCHASE_PRICE,
        VideoDatabase.KEY_RENTAL_PRICE,
        VideoDatabase.KEY_RATING_STYLE,
        VideoDatabase.KEY_RATING_SCORE,
        VideoDatabase.KEY_PRODUCTION_YEAR,
        VideoDatabase.KEY_COLUMN_DURATION,
        VideoDatabase.KEY_ACTION,
        SearchManager.SUGGEST_COLUMN_INTENT_DATA_ID
    };
    return videoDatabase.getWordMatch(query, columns);
}
...

在您的資訊清單檔案中，內容供應器會獲得特殊處理方式。描述為 <provider>，而非標記為活動。提供者包含 android:authorities 屬性，可告知系統內容供應器的命名空間。此外，您也必須將其 android:exported 屬性設為 "true"，Android 全域搜尋才能使用從該屬性傳回的結果。

<provider android:name="com.example.android.tvleanback.VideoContentProvider"
    android:authorities="com.example.android.tvleanback"
    android:exported="true" />

處理搜尋建議

您的應用程式必須包含 res/xml/searchable.xml 檔案才能調整搜尋建議設定。

在 res/xml/searchable.xml 檔案中加入 android:searchSuggestAuthority 屬性，將內容供應器的命名空間告知系統。此字串必須與您在 AndroidManifest.xml 檔案中 <provider> 元素的 android:authorities 屬性中指定的字串值相符。

另外也請加入應用程式名稱標籤。系統搜尋設定在列舉可搜尋的應用程式時會使用這個標籤。

searchable.xml 檔案也必須包含值為 "android.intent.action.VIEW" 的 android:searchSuggestIntentAction，以便定義提供自訂建議的意圖動作。這與提供搜尋字詞的意圖動作不同，詳情請參閱下一節。如需其他為建議宣告意圖動作的方式，請參閱「宣告意圖動作」。

除了意圖動作外，應用程式也必須提供意圖資料，您可以使用 android:searchSuggestIntentData 屬性指定這些資料。這是指向內容的 URI 第一個部分，這會說明在對應資料表中所有資料列通用的 URI 部分。各列專屬的 URI 部分會以 SUGGEST_COLUMN_INTENT_DATA_ID 欄位建立，如「識別資料欄」一節所述。如需其他為建議宣告意圖資料的方式，請參閱「宣告意圖資料」。

android:searchSuggestSelection=" ?" 屬性會指定以 query() 方法 selection 參數的形式傳遞的值。問號 (?) 值會替換為查詢文字。

最後，您也必須加入含有 "true" 值的 android:includeInGlobalSearch 屬性。以下是 searchable.xml 的範例檔案：

<searchable xmlns:android="http://schemas.android.com/apk/res/android"
    android:label="@string/search_label"
    android:hint="@string/search_hint"
    android:searchSettingsDescription="@string/settings_description"
    android:searchSuggestAuthority="com.example.android.tvleanback"
    android:searchSuggestIntentAction="android.intent.action.VIEW"
    android:searchSuggestIntentData="content://com.example.android.tvleanback/video_database_leanback"
    android:searchSuggestSelection=" ?"
    android:searchSuggestThreshold="1"
    android:includeInGlobalSearch="true">
</searchable>

處理搜尋字詞

如「識別資料欄」一節所述，搜尋對話方塊的字詞與任一資料欄的值相符，系統就會觸發 ACTION_SEARCH 意圖。處理該意圖的應用程式活動會在存放區中搜尋含有特定字詞的資料欄，並傳回含有這些資料欄的內容項目清單。在 AndroidManifest.xml 檔案中，請指定處理 ACTION_SEARCH 意圖的活動，如以下範例所示：

...
  <activity
      android:name="com.example.android.tvleanback.DetailsActivity"
      android:exported="true">

      <!-- Receives the search request. -->
      <intent-filter>
          <action android:name="android.intent.action.SEARCH" />
          <!-- No category needed, because the Intent will specify this class component -->
      </intent-filter>

      <!-- Points to searchable meta data. -->
      <meta-data android:name="android.app.searchable"
          android:resource="@xml/searchable" />
  </activity>
...
  <!-- Provides search suggestions for keywords against video meta data. -->
  <provider android:name="com.example.android.tvleanback.VideoContentProvider"
      android:authorities="com.example.android.tvleanback"
      android:exported="true" />
...

該活動也必須以 searchable.xml 檔案的參照來描述可供搜尋的設定。如要使用全域搜尋對話方塊，資訊清單必須說明應接收搜尋查詢的活動。資訊清單也必須描述 <provider> 元素，與 searchable.xml 檔案的說明完全相同。

詳細資料畫面中應用程式的深層連結

如果您已按照「處理搜尋建議」一節的說明調整搜尋設定，並按照「識別資料欄」一節所述方式對應 SUGGEST_COLUMN_TEXT_1、SUGGEST_COLUMN_PRODUCTION_YEAR 和 SUGGEST_COLUMN_DURATION 欄位，則當使用者選取搜尋結果時，系統會在啟動的詳細資料畫面中，顯示內容觀看動作的深層連結：

當使用者選取應用程式的連結 (在詳細資料畫面中顯示「Available On」按鈕) 時，系統會啟動處理 ACTION_VIEW 的活動，其設為 android:searchSuggestIntentAction，且在 searchable.xml 檔案中含有值為 "android.intent.action.VIEW"。

您也可以設定自訂意圖來啟動活動。您可以透過 Leanback 範例應用程式瞭解這一點。請注意，範例應用程式會啟動自身的 LeanbackDetailsFragment，以顯示所選媒體的詳細資料；在應用程式中啟動可立即播放媒體的活動，讓使用者另按一兩下滑鼠。

搜尋行為

您可以透過主畫面和應用程式內的 Android TV 使用搜尋功能。上述兩種情況的搜尋結果有所不同。

在主畫面上使用搜尋功能

當使用者從主畫面搜尋時，第一筆結果會出現在實體資訊卡中。如果有應用程式可以播放內容，資訊卡底部會顯示每個應用程式的連結：

您無法透過程式輔助方式將應用程式放入實體資訊卡。應用程式搜尋結果必須與搜尋內容的標題、年份和長度相符，才能納入播放選項。

資訊卡下方可能會顯示更多搜尋結果。如要查看這些內容，使用者必須按下遙控器並向下捲動。每個應用程式的結果會自成一列。您無法控制資料列排序。支援觀看動作的應用程式會先列出。

搜尋應用程式中的內容

使用者也可以利用遙控器或遊戲手把控制器啟動麥克風，直接在應用程式中執行搜尋。搜尋結果會顯示在應用程式內容上方的單一資料列中。您的應用程式使用自家的全球搜尋引擎產生搜尋結果。

瞭解詳情

如要進一步瞭解如何搜尋 TV 應用程式，請參閱「將 Android 搜尋功能整合至您的應用程式」和「新增搜尋功能」。

如要進一步瞭解如何使用 SearchFragment 自訂應用程式內搜尋體驗，請參閱「在 TV 應用程式中搜尋」。