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

サムネイルを有効にする

検索結果から返されたドキュメントのサムネイルが表示されます。サムネイルがあると、ユーザーは返されたドキュメントの関連性をより正確に特定できます。サムネイルには次の特徴があります。

幅 1,024 ピクセル。
Google Workspace ファイルのサムネイルの URL は ACL で保護されます。他のファイル形式の URL は ACL で保護されません
URL の有効期限は 5 分です。
ファイルが 50 MB を超える場合、サムネイルは生成されません。
サムネイルを生成できない場合は、プレースホルダアイコンが使用されます。Google Workspace アイテムのサムネイルを生成できない場合、サムネイル URL は「404 Not Found」を返します。アプリケーションはこの動作を処理する必要があります。

Google Workspace のドキュメントタイプ（ドキュメント、スプレッドシート、スライドなど）など、サムネイルをサポートする Google ドライブのファイルでは、サムネイルが自動的に作成されます。また、Cloud Search では次のファイル形式のサムネイルが自動的に作成されます。

Microsoft Word（DOC）
Microsoft Word（DOCX）
Microsoft Excel（XLS）
Microsoft Excel（XLSX）
Microsoft PowerPoint（PPT）
Microsoft PowerPoint（PPTX）
Adobe Portable Document Format（PDF）
リッチテキスト形式（RTF）
テキスト形式（TXT）
ハイパーテキストマークアップ言語（HTML）
XML（拡張マークアップ言語）

サムネイルは、データソースと検索アプリケーションで有効になっているアイテムに対してのみ返されます。

データソースのサムネイル URL を有効にする

Cloud Search プラットフォームプロジェクトにサービスアカウントの認証情報が含まれています。ただし、サムネイル URL を有効にするには、API キーとウェブアプリケーション認証情報を作成し、ウェブアプリケーション認証情報を使用してアクセストークンを取得する必要があります。最後に、これらの認証情報を使用してデータソースを取得し、更新します。

まだ行っていない場合は、アプリのプロジェクトを作成または選択し、API を有効にします。この 2 つのステップについては、Google Cloud Search API へのアクセスを構成するのステップ 1 と 2 をご覧ください。
API キーを作成します。
1. Google Cloud コンソールで [認証情報を作成] プルダウンリストをクリックし、[API キー] を選択します。[API キーを作成しました] ページが表示されます。
2. API キーをメモします。
3. [閉じる] をクリックします。新しく作成された認証情報が [API キー] に表示されます。
ウェブアプリケーションの認証情報を作成します。リダイレクト URI として https://developers.google.com/oauthplayground を使用します。。これらの認証情報を作成する手順については、ウェブアプリケーションの認証情報を作成する（クライアントサイドの JavaScript）をご覧ください。
OAuth 2.0 Playground で [OAuth 2.0 Configuration ] をクリックします。
[ご自身の認証情報を使用する] をオンにします。
手順 3 で生成したクライアント ID とクライアントシークレットを入力します。
スコープフィールドに「https://www.googleapis.com/auth/cloud_search.settings」と入力し、[Authorize APIs] をクリックします。
（省略可）ログイン画面が表示された場合は、使用するアカウントを選択します。
（省略可）承認画面が表示された場合は、[Accept] をクリックします。
[Exchange authorization code for tokens] をクリックします。トークンが返されます。
サムネイルコントロールを有効にするデータソースを特定します。
settings.datasources.get を呼び出して、データソースの ID を取得します。
```
curl
'https://cloudsearch.googleapis.com/v1/settings/datasource_id?key=[YOUR_API_KEY]' \
--header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]'\
--header 'Accept: application/json'  \
--compressed
```
ここで
- datasource_id は、取得するデータソースの名前です。
- YOUR_API_KEY は、プロジェクトの API キーです（ステップ 2 で取得）。
- YOUR_ACCESS_TOKEN は、プロジェクトの OAuth 2.0 アクセストークン（ステップ 10 で取得）です。
このコマンドの成功結果は次のようになります。
```
{
 "source": {
   "name": "datasources/datasource_id",
   "displayName": "DataSource_Display_Name",
   "itemsVisibility": [
     {
       "gsuiteDomain": true
     }
   ]
 }
}
```

returnThumbnailUrls を true に設定して setting.datasource.update を呼び出して、データソースのサムネイル URL を有効にします。

curl --request PUT \  'https://cloudsearch.googleapis.com/v1/settings/datasources/datasource_id?key=[YOUR_API_KEY]' \
  --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"source":{"name":"datasources/datasource_id","displayName":"DataSource_Display_Name","itemsVisibility":
    [{"gsuiteDomain":true}],"returnThumbnailUrls":true}}' \
  --compressed

ここで

datasource_id は、取得するデータソースの ID です。
YOUR_API_KEY は、プロジェクトの API キーです（ステップ 2 で取得）。
YOUR_ACCESS_TOKEN は、プロジェクトの OAuth 2.0 アクセストークン（ステップ 10 で取得）です。
DataSource_DisplayName は、前の cURL コマンドから返された表示名です。
"returnThumbnailsUrls":true はサムネイルを有効にします。

このコマンドの成功結果は次のようになります。

{
  "source": {
    "name": "datasources/datasource_id",
    "displayName": "DataSource_Display_Name",
    "itemsVisibility": [
      {
        "gsuiteDomain": true
      }
    ],
    "returnThumbnailUrls": true
  }
}

検索アプリケーションに対してサムネイル URL を有効にする

まだ行っていない場合は、アプリのプロジェクトを作成または選択し、API を有効にします。この 2 つのステップについては、Google Cloud Search API へのアクセスを構成するのステップ 1 と 2 をご覧ください。
API キーを作成します。
1. Cloud コンソールで [認証情報を作成] プルダウンリストをクリックし、[API キー] を選択します。[API キーを作成しました] ページが表示されます。
2. API キーをメモします。
3. [閉じる] をクリックします。新しく作成された認証情報が [API キー] に表示されます。
ウェブアプリケーションの認証情報を作成します。リダイレクト URI として https://developers.google.com/oauthplayground を使用します。。これらの認証情報を作成する手順については、ウェブアプリケーションの認証情報を作成する（クライアントサイドの JavaScript）をご覧ください。
OAuth 2.0 Playground で [OAuth 2.0 Configuration ] をクリックします。
[ご自身の認証情報を使用する] をオンにします。
手順 3 で生成したクライアント ID とクライアントシークレットを入力します。
スコープフィールドに「https://www.googleapis.com/auth/cloud_search.settings」と入力し、[Authorize APIs] をクリックします。
（省略可）ログイン画面が表示された場合は、使用するアカウントを選択します。
（省略可）承認画面が表示された場合は、[Accept] をクリックします。
[Exchange authorization code for tokens] をクリックします。トークンが返されます。
サムネイルコントロールを有効にする検索アプリケーションを特定します。
settings.searchapplications.get を呼び出して、検索アプリケーションの ID を取得します。
```
curl \ 'https://cloudsearch.googleapis.com/v1/settings/searchapplications/search_application_id?key=[YOUR_API_KEY]' \
 --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
 --header 'Accept: application/json' \
 --compressed
```
ここで
- は取得する検索アプリケーションの ID です。
- YOUR_API_KEY は、プロジェクトの API キーです（ステップ 2 で取得）。
- YOUR_ACCESS_TOKEN は、プロジェクトの OAuth 2.0 アクセストークン（ステップ 10 で取得）です。
このコマンドの成功結果は次のようになります。
```
{
 "name": "searchapplications/search_application_id",
 "displayName": "SearchApp_Display_Name",
 "dataSourceRestrictions": [
   {
     "source": {
       "name": "datasources/datasource_id"
     }
   }
 ]
}
```

returnResultThumbnailUrls を true に設定して setting.searchapplications.update を呼び出し、検索アプリケーションのサムネイル URL を有効にします。

curl --request PUT \  'https://cloudsearch.googleapis.com/v1/settings/searchapplications/search_application_id?key=[YOUR_API_KEY]' \
  --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"searchapplications/search_application_id","displayName":"SearchApp_Display_Name","dataSourceRestrictions":[{"source":
    {"name":"datasources/datasource_id"}}],"returnResultThumbnailUrls":true}' \
  --compressed

ここで

は取得する検索アプリケーションの ID です。
YOUR_API_KEY は、プロジェクトの API キーです（ステップ 2 で取得）。
YOUR_ACCESS_TOKEN は、プロジェクトの OAuth 2.0 アクセストークン（ステップ 10 で取得）です。
SearchApp_DisplayName は、前の cURL コマンドから返された表示名です。
"returnResultThumbnailUrls":true はサムネイルを有効にします。

このコマンドの成功結果は次のようになります。

{
  "name": "searchapplications/search_application_id",
  "displayName": "SearchApp_Display_Name",
  "dataSourceRestrictions": [
    {
      "source": {
        "name": "datasources/datasource_id"
      }
    }
  ],
  "returnResultThumbnailUrls": true
}

サムネイルにアクセス

ドライブ内の Google Workspace ファイルのサムネイルにアクセスするには、ユーザーまたはアプリケーションが Google ドライブのアイテムへのアクセスに使用するのと同じアカウント認証情報を渡す必要があります。