サムネイルを有効にする

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

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

  1. まだ作成していない場合は、アプリのプロジェクトを作成または選択して API を有効にします。これらの 2 つの手順については、Google Cloud Search API へのアクセスを構成するのステップ 1 と 2 をご覧ください。
  2. API キーを作成する:
    1. Google Cloud コンソールで、[認証情報を作成] プルダウン リストをクリックし、[API キー] を選択します。[API キーを作成しました] ページが表示されます。
    2. API キーをメモします。
    3. [閉じる] をクリックします。新しく作成された認証情報が [API キー] の下に表示されます。
  3. ウェブ アプリケーションの認証情報を作成します。リダイレクト URI として https://developers.google.com/oauthplayground を使用します。。これらの認証情報を作成する手順については、ウェブ アプリケーションの認証情報の作成(クライアントサイド JavaScript)をご覧ください。
  4. OAuth 2.0 Playground で、[OAuth 2.0 の構成] をクリックします。
  5. [Use your own credentials] をオンにします。
  6. 手順 3 で生成したクライアント ID とクライアント シークレットを入力します。
  7. [scopes] フィールドに https://www.googleapis.com/auth/cloud_search.settings と入力し、[Authorize APIs] をクリックします。
  8. (省略可)ログイン画面が表示されたら、使用するアカウントを選択します。
  9. (省略可)承認画面が表示されたら、[承認] をクリックします。
  10. [Exchange authorization code for tokens] をクリックします。トークンが返されます。
  11. サムネイル コントロールを有効にするデータソースを特定します。
  12. 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
         }
       ]
     }
    }
    
  13. returnThumbnailUrlstrue に設定して 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 を有効にする

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

  1. まだ作成していない場合は、アプリのプロジェクトを作成または選択して API を有効にします。これらの 2 つの手順については、Google Cloud Search API へのアクセスを構成するのステップ 1 と 2 をご覧ください。
  2. API キーを作成する:
    1. Cloud コンソールで、[認証情報を作成] プルダウン リストをクリックし、[API キー] を選択します。[API キーを作成しました] ページが表示されます。
    2. API キーをメモします。
    3. [閉じる] をクリックします。新しく作成された認証情報が [API キー] の下に表示されます。
  3. ウェブ アプリケーションの認証情報を作成します。リダイレクト URI として https://developers.google.com/oauthplayground を使用します。。これらの認証情報を作成する手順については、ウェブ アプリケーションの認証情報の作成(クライアントサイド JavaScript)をご覧ください。
  4. OAuth 2.0 Playground で、[OAuth 2.0 の構成] をクリックします。
  5. [Use your own credentials] をオンにします。
  6. 手順 3 で生成したクライアント ID とクライアント シークレットを入力します。
  7. [scopes] フィールドに https://www.googleapis.com/auth/cloud_search.settings と入力し、[Authorize APIs] をクリックします。
  8. (省略可)ログイン画面が表示されたら、使用するアカウントを選択します。
  9. (省略可)承認画面が表示されたら、[承認] をクリックします。
  10. [Exchange authorization code for tokens] をクリックします。トークンが返されます。
  11. サムネイル コントロールを有効にする検索アプリを特定します。
  12. 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"
         }
       }
     ]
    }
    
  13. returnResultThumbnailUrlstrue に設定して 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 ドライブ内のアイテムにアクセスする際に使用するアカウント認証情報を渡す必要があります。