Pembuat umum untuk objek yang dapat diindeks

Stiker

Ini adalah ikhtisar properti terpenting yang harus disertakan saat mengindeks stiker atau paket stiker untuk integrasi dengan Gboard. Lihat contoh Pengindeksan Aplikasi di Github sebagai contoh.

Properti Keterangan Contoh
name Nama atau kata kunci yang digunakan untuk pencarian — tidak ditampilkan. "Paket Stiker Snoopy"
url Tautan URL ke stiker atau paket stiker di aplikasi. "http://sticker/pack/canonical/url/snoopy"
image Gambar stiker atau paket stiker. Untuk kualitas gambar optimal, gunakan gambar persegi berukuran 320 piksel atau 500 piksel. "http://link/to/the/image/bye"
description Label aksesibilitas untuk stiker atau paket stiker Anda. "Satu pak stiker Snoopy"

Contoh: Paket stiker

// Build and index the sticker objects on first run after update or install
// to minimize lag between sticker install and stickers surfacing in Gboard.

FirebaseAppIndex.update(new Indexable.Builder("StickerPack")
   .setName("Snoopy Pack")
   .setImage("content://sticker/pack/canonical/image")
   // see: Support links to your app content section
   .setUrl("http://sticker/pack/canonical/url/snoopy")
   // Set the accessibility label for the sticker pack.
   .setDescription("A sticker pack of Snoopy")
   .put("hasSticker",
        new Indexable.Builder("Sticker")
          .setName("Hey")
          .setImage("http://link/to/the/image/hey")
          .setDescription("A Snoopy hey sticker.")
          .build(),
       new Indexable.Builder("Sticker")
          .setName("Bye")
          .setImage("http://link/to/the/image/bye")
          .setDescription("A Snoopy bye sticker.")
          .build())
   .build());

Contoh: Stiker individu

Indexable[] stickers = new Indexable[]{
      new Indexable.Builder("Sticker")
   .setName("Hey")
   .setImage("http://www.snoopysticker.com?id=1234")
   // see: Support links to your app content section
   .setUrl("http://sticker/canonical/image/hey")
   // Set the accessibility label for the sticker.
   .setDescription("A sticker for hi")
   // Add search keywords.
   .put("keywords", "hey", "snoopy", "hi", "hello")
   .put("isPartOf",
        new Indexable.Builder("StickerPack")
          .setName("Snoopy Pack"))
          .build())
   .build()),
new Indexable.Builder("Sticker")
   .setName("Bye")
   .setImage("http://www.snoopysticker.com?id=4567")
   // see: Support links to your app content section
   .setUrl("http://sticker/canonical/image/bye")
   // Set the accessibility label for the sticker.
   .setDescription("A sticker for Bye")
   // Add search keywords.
   .put("keywords", "bye", "snoopy", "see ya", "good bye")
   .put("isPartOf",
        new Indexable.Builder("StickerPack")
          .setName("Snoopy Pack")
          .build())
   .build())};
// Make sure we update stickers in batch
FirebaseAppIndex.update(stickers);

Pesan

Ini adalah ikhtisar properti terpenting yang harus ditentukan oleh aplikasi saat mengindeks pesan.

Properti Keterangan Contoh
url URL yang tertaut ke pesan di aplikasi. "aplikasi saya://pesan/42"
name Baris subjek pesan, atau pesan itu sendiri, jika tidak memiliki baris subjek terpisah. "Re: makan siang"
text Opsional. Isi pesan, jika ada. Untuk jenis pesan pesan instan tanpa baris subjek terpisah, gunakan "nama" (lihat di atas). “Apakah kamu ada waktu luang untuk makan siang?”
dateReceived Waktu pesan diterima, untuk pesan masuk. Tanggal baru (2016, 6, 2, 23, 43, 00)
dateSent Waktu pesan dikirim, untuk pesan keluar. Tanggal baru (2016, 6, 2, 23, 43, 00)
isPartOf.id ID untuk percakapan atau rangkaian pesan yang berisi pesan tersebut. "42"
sender Pengirim pesan.
sender.name Nama pengirimnya. "Alice"
sender.url Opsional. URL yang tertaut ke orang di aplikasi. "http://example.net/profiles/alice"
sender.image Opsional. Gambar pengirimnya. URL web atau URI Konten dapat digunakan. "http://example.net/alice.jpg"
sender.email Opsional. Alamat email pengirim. "alice@example.net"
sender.telephone Opsional. Nomor telepon pengirim. "+16502530000"
sender.isSelf Indikasi apakah pengguna adalah pengirim. Nilai defaultnya salah. PALSU
recipient Satu atau beberapa penerima pesan.
recipient.name Nama penerima. "Bob"
recipient.url Opsional. URL yang tertaut ke orang di aplikasi. "http://example.net/profiles/bob"
recipient.image Opsional. Gambar penerima. URL web atau URI Konten dapat digunakan. "http://example.net/bob.jpg"
recipient.email Opsional. Alamat email pengirim. "bob@example.net"
recipient.telephone Opsional. Nomor telepon pengirim. "+16502530000"
recipient.isSelf Indikasi apakah pengguna adalah penerima. Nilai defaultnya salah. BENAR
messageAttachment Opsional. Satu atau beberapa lampiran pada pesan.
messageAttachment.name Nama lampiran pada pesan. "Stiker"
messageAttachment.image Gambar yang mewakili lampiran. URL web atau URI Konten dapat digunakan. "http://example.net/stickers/23.png"

Contoh: Pesan masuk

Indexable message = Indexables.messageBuilder()
    .setUrl("myapp://messages/42")
    .setText("Are you free for lunch?")
    .setDateReceived(new Date(2016, 6, 2, 23, 44, 00))
    .setIsPartOf(Indexables.conversationBuilder().setId("42")
    .setSender(Indexables.personBuilder()
        .setName("Alice")
        .setImage("http://example.net/alice.jpg")
        .setEmail("alice@example.net")
        .setTelephone("+16502530000"))
    .setRecipient(Indexables.personBuilder()
        .setName("Bob")
        .setImage("http://example.net/bob.jpg")
        .setEmail("bob@people.net")
        .setTelephone("+16502530000")
        .setIsSelf(true))
    .build();
 

Untuk pesan email, gunakan Indexables.emailMessageBuilder() sebagai gantinya. Tidak ada perbedaan pada kolom yang didukung, namun UI hasilnya akan berbeda (misalnya menyorot baris subjek email).

Catatan

Ini adalah ikhtisar properti terpenting yang harus ditentukan oleh aplikasi saat mengindeks catatan.

Properti Keterangan Contoh
url URL yang tertaut ke catatan di aplikasi. "aplikasi saya://catatan/42"
name Judul catatan, atau langsung teks catatan itu sendiri, jika tidak mempunyai judul tersendiri. "Daftar belanja"
text Opsional. Teks catatan, jika ada. Untuk catatan tanpa judul tersendiri, gunakan "nama" (lihat di atas). "steak, pasta, anggur"
image Gambar yang mewakili catatan itu. URL web atau URI Konten dapat digunakan. "http://example.net/shopping.jpg"
dateCreated Waktu pembuatan catatan. Tanggal baru (2016, 6, 2, 23, 43, 00)
author Opsional. Penulis catatan itu.
author.name Nama penulis catatan itu. "Bob"

Contoh: Catatan

Indexable note = Indexables.noteDigitalDocumentBuilder()
    .setUrl("myapp://notes/42")
    .setName("Shopping list")
    .setText("steak, pasta, wine")
    .setImage("http://example.net/shopping.jpg")
    .setDateCreated(new Date(2016, 6, 2, 23, 43, 00))
    .build();