Aktifkan thumbnail

Thumbnail ditampilkan untuk dokumen yang ditampilkan oleh hasil penelusuran. Thumbnail memungkinkan pengguna mengidentifikasi relevansi dokumen yang ditampilkan dengan lebih baik. Thumbnail memiliki karakteristik berikut:

  • Lebar 1024 px.
  • URL untuk thumbnail file Google Workspace dilindungi ACL. URL untuk jenis file lain tidak dilindungi ACL
  • Masa berlaku URL akan berakhir setelah 5 menit.
  • Thumbnail tidak dibuat untuk file yang berukuran lebih dari 50 MB.
  • Jika thumbnail tidak dapat dibuat, ikon placeholder akan digunakan. Jika thumbnail untuk item Google Workspace tidak dapat dibuat, URL thumbnail akan menampilkan "404 Not Found". Aplikasi Anda harus menangani perilaku ini.

Thumbnail dibuat secara otomatis untuk file Google Drive yang secara alami mendukung thumbnail, seperti jenis dokumen Google Workspace (Dokumen, Spreadsheet, Slide, dan sebagainya). Selain itu, Cloud Search secara otomatis membuat thumbnail untuk jenis file berikut:

  • Microsoft Word (DOC)
  • Microsoft Word (DOCX)
  • Microsoft Excel (XLS)
  • Microsoft Excel (XLSX)
  • Microsoft Powerpoint (PPT)
  • Microsoft Powerpoint (PPTX)
  • Adobe Portable Document Format (PDF)
  • Rich Text Format (RTF)
  • Format Teks (TXT)
  • Hypertext Markup Language (HTML)
  • Extensible Markup Language (XML)

Thumbnail hanya ditampilkan untuk item yang sumber data dan aplikasi penelusurannya telah mengaktifkannya.

Mengaktifkan URL thumbnail untuk sumber data

Project Cloud Search Platform Anda berisi kredensial akun layanan. Namun, untuk mengaktifkan URL thumbnail, Anda harus membuat kunci API dan kredensial aplikasi web, serta menggunakan kredensial aplikasi web untuk mendapatkan token akses. Terakhir, Anda menggunakan kredensial ini untuk mendapatkan dan memperbarui sumber data.

  1. Jika belum melakukannya, buat atau pilih project untuk aplikasi Anda dan aktifkan API. Untuk mengetahui informasi tentang dua langkah ini, lihat langkah 1 dan 2 dari Mengonfigurasi akses ke Google Cloud Search API.
  2. Buat kunci API:
    1. Di konsol Google Cloud, klik menu drop-down Create Credentials, lalu pilih API Key. Halaman "API Key created" akan muncul.
    2. Catat kunci API.
    3. Klik Tutup. Kredensial yang baru dibuat akan muncul di bagian "API Keys".
  3. Membuat kredensial aplikasi Web. Gunakan https://developers.google.com/oauthplayground sebagai URI pengalihan. . Untuk mengetahui langkah-langkah membuat kredensial ini, lihat Membuat kredensial aplikasi Web (JavaScript sisi klien).
  4. Di OAuth 2.0 Playground, klik OAuth 2.0 Configuration .
  5. Centang Gunakan kredensial Anda sendiri.
  6. Masukkan client ID dan rahasia klien yang dibuat pada langkah 3.
  7. Di kolom cakupan, ketik https://www.googleapis.com/auth/cloud_search.settings dan klik Authorize APIs.
  8. (opsional) Jika layar Login ditampilkan, pilih akun yang akan digunakan.
  9. (opsional) Jika muncul layar otorisasi, klik Terima.
  10. Klik Exchange authorization code for tokens. Token akan ditampilkan.
  11. Identifikasi sumber data yang ingin Anda aktifkan kontrol thumbnail-nya.

  12. Panggil settings.datasources.get untuk mendapatkan ID sumber data:

    curl
'https://cloudsearch.googleapis.com/v1/settings/datasource_id?key=[YOUR_API_KEY]' \
--header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]'\
--header 'Accept: application/json'  \
--compressed

    Dengan keterangan:

    • datasource_id adalah nama sumber data yang akan diambil.
    • YOUR_API_KEY adalah kunci API untuk project Anda (diperoleh dari langkah 2).
    • YOUR_ACCESS_TOKEN adalah token akses OAuth 2.0 untuk project Anda (diperoleh dari langkah 10).

    Hasil yang berhasil dari perintah ini mirip dengan:

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

  13. Panggil setting.datasource.update dengan returnThumbnailUrls ditetapkan ke true untuk mengaktifkan URL thumbnail bagi sumber data:

    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

    Dengan keterangan:

    • datasource_id adalah ID sumber data yang akan diambil.
    • YOUR_API_KEY adalah kunci API untuk project Anda (diperoleh dari langkah 2).
    • YOUR_ACCESS_TOKEN adalah token akses OAuth 2.0 untuk project Anda (diperoleh dari langkah 10).
    • DataSource_DisplayName adalah nama tampilan yang ditampilkan dari perintah cURL sebelumnya.
    • "returnThumbnailsUrls":true mengaktifkan thumbnail.

    Hasil yang berhasil dari perintah ini mirip dengan:

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

Mengaktifkan URL thumbnail untuk aplikasi penelusuran

Project Cloud Search Platform Anda berisi kredensial akun layanan. Namun, untuk mengaktifkan URL thumbnail, Anda harus membuat kunci API dan kredensial aplikasi web, serta menggunakan kredensial aplikasi web untuk mendapatkan token akses. Terakhir, Anda menggunakan kredensial ini untuk mendapatkan dan mengupdate aplikasi penelusuran.

  1. Jika belum melakukannya, buat atau pilih project untuk aplikasi Anda dan aktifkan API. Untuk mengetahui informasi tentang dua langkah ini, lihat langkah 1 dan 2 dari Mengonfigurasi akses ke Google Cloud Search API.
  2. Buat kunci API:
    1. Di konsol cloud, klik menu drop-down Create Credentials, lalu pilih API Key. Halaman "API Key created" akan muncul.
    2. Catat kunci API.
    3. Klik Tutup. Kredensial yang baru dibuat akan muncul di bagian "API Keys".
  3. Membuat kredensial aplikasi Web. Gunakan https://developers.google.com/oauthplayground sebagai URI pengalihan. . Untuk mengetahui langkah-langkah membuat kredensial ini, lihat Membuat kredensial aplikasi Web (JavaScript sisi klien).
  4. Di OAuth 2.0 Playground, klik OAuth 2.0 Configuration .
  5. Centang Gunakan kredensial Anda sendiri.
  6. Masukkan client ID dan rahasia klien yang dibuat pada langkah 3.
  7. Di kolom cakupan, ketik https://www.googleapis.com/auth/cloud_search.settings dan klik Authorize APIs.
  8. (opsional) Jika layar Login ditampilkan, pilih akun yang akan digunakan.
  9. (opsional) Jika muncul layar otorisasi, klik Terima.
  10. Klik Exchange authorization code for tokens. Token akan ditampilkan.
  11. Identifikasi aplikasi penelusuran yang ingin Anda aktifkan kontrol thumbnail-nya.

  12. Panggil settings.searchapplications.get untuk mendapatkan ID aplikasi penelusuran:

    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

    Dengan keterangan:

    • adalah ID aplikasi penelusuran yang akan diambil.
    • YOUR_API_KEY adalah kunci API untuk project Anda (diperoleh dari langkah 2).
    • YOUR_ACCESS_TOKEN adalah token akses OAuth 2.0 untuk project Anda (diperoleh dari langkah 10).

    Hasil yang berhasil dari perintah ini mirip dengan:

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

  13. Panggil setting.searchapplications.update dengan returnResultThumbnailUrls ditetapkan ke true untuk mengaktifkan URL thumbnail untuk aplikasi penelusuran:

    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

    Dengan keterangan:

    • adalah ID aplikasi penelusuran yang akan diambil.
    • YOUR_API_KEY adalah kunci API untuk project Anda (diperoleh dari langkah 2).
    • YOUR_ACCESS_TOKEN adalah token akses OAuth 2.0 untuk project Anda (diperoleh dari langkah 10).
    • SearchApp_DisplayName adalah nama tampilan yang ditampilkan dari perintah cURL sebelumnya.
    • "returnResultThumbnailUrls":true mengaktifkan thumbnail.

    Hasil yang berhasil dari perintah ini mirip dengan:

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

Mengakses thumbnail

Untuk mengakses thumbnail file Google Workspace di Drive, pengguna atau aplikasi harus meneruskan kredensial akun yang sama dengan yang mereka gunakan untuk mengakses item di Google Drive.