דף זה תורגם על ידי Cloud Translation API.

בונים נפוצים עבור אובייקטים הניתנים לאינדקס

מדבקות

זוהי סקירה כללית של המאפיינים החשובים ביותר שיש לכלול בעת הוספת מדבקות או חבילות מדבקות לאינדקס לשילוב עם Gboard. עיין בדוגמה של יצירת אינדקס של אפליקציות ב-Github לדוגמא.

תכונה	תיאור	דוגמא
`name`	שם או מילת מפתח המשמשים לחיפוש - לא מוצגים.	"חבילת מדבקות סנופי"
`url`	כתובת URL המקשרת למדבקה או חבילת המדבקות באפליקציה.	"http://sticker/pack/canonical/url/snoopy"
`image`	הגרפיקה של המדבקה או חבילת המדבקות. לאיכות תמונה מיטבית, השתמש בתמונות מרובעות בגודל 320 פיקסלים או 500 פיקסלים.	"http://link/to/the/image/bye"
`description`	תווית נגישות עבור המדבקה או חבילת המדבקות שלך.	"חבילה של מדבקות סנופי"

דוגמה: חבילת מדבקות

// 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());

דוגמה: מדבקה בודדת

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);

הוֹדָעָה

זוהי סקירה כללית של המאפיינים החשובים ביותר שיש לציין על ידי אפליקציה בעת הוספת הודעה לאינדקס.

תכונה	תיאור	דוגמא
`url`	כתובת האתר המקשרת להודעה באפליקציה.	"myapp://messages/42"
`name`	שורת הנושא של ההודעה, או ישירות ההודעה עצמה, אם אין לה שורת נושא נפרדת.	"בעניין: ארוחת צהריים"
`text`	אופציונאלי. גוף ההודעה, אם רלוונטי. עבור הודעות מסוג הודעות מיידיות ללא שורת נושא נפרדת, השתמש ב"שם" (ראה למעלה).	"אתה פנוי לארוחת צהריים?"
`dateReceived`	זמן קבלת ההודעה, עבור הודעות נכנסות.	תאריך חדש (2016, 6, 2, 23, 43, 00)
`dateSent`	הזמן שבו נשלחה ההודעה, עבור הודעות יוצאות.	תאריך חדש (2016, 6, 2, 23, 43, 00)
`isPartOf.id`	מזהה לשיחה או לשרשור שההודעה היא חלק ממנו.	"42"
`sender`	שולח ההודעה.
`sender.name`	שם השולח.	"אליס"
`sender.url`	אופציונאלי. כתובת האתר המקשרת לאדם באפליקציה.	"http://example.net/profiles/alice"
`sender.image`	אופציונאלי. תמונה של השולח. ניתן להשתמש בכתובת אתר אינטרנט או ב-URI של תוכן.	"http://example.net/alice.jpg"
`sender.email`	אופציונאלי. כתובת המייל של השולח.	"alice@example.net"
`sender.telephone`	אופציונאלי. מספר הטלפון של השולח.	"+16502530000"
`sender.isSelf`	ציון האם המשתמש הוא השולח. ברירת המחדל היא שקר.	שֶׁקֶר
`recipient`	נמען אחד או יותר של ההודעה.
`recipient.name`	שם הנמען.	"בוב"
`recipient.url`	אופציונאלי. כתובת האתר המקשרת לאדם באפליקציה.	"http://example.net/profiles/bob"
`recipient.image`	אופציונאלי. תמונה של הנמען. ניתן להשתמש בכתובת אתר אינטרנט או ב-URI של תוכן.	"http://example.net/bob.jpg"
`recipient.email`	אופציונאלי. כתובת המייל של השולח.	"bob@example.net"
`recipient.telephone`	אופציונאלי. מספר הטלפון של השולח.	"+16502530000"
`recipient.isSelf`	ציון האם המשתמש הוא הנמען. ברירת המחדל היא שקר.	נָכוֹן
`messageAttachment`	אופציונאלי. קובץ מצורף אחד או מרובים להודעה.
`messageAttachment.name`	שם הקובץ המצורף להודעה.	"מַדבֵּקָה"
`messageAttachment.image`	תמונה המייצגת את הקובץ המצורף. ניתן להשתמש בכתובת אתר אינטרנט או ב-URI של תוכן.	"http://example.net/stickers/23.png"

דוגמה: הודעה נכנסת

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();

עבור הודעות דואר אלקטרוני, השתמש במקום זאת Indexables.emailMessageBuilder() . אין הבדל בשדות הנתמכים, אבל ממשק המשתמש של התוצאה יהיה שונה (למשל הדגשת שורת הנושא של המייל).

הערה

זוהי סקירה כללית של המאפיינים החשובים ביותר שיש לציין על ידי אפליקציה בעת הוספת הערה לאינדקס.

תכונה	תיאור	דוגמא
`url`	כתובת האתר המקשרת להערה באפליקציה.	"myapp://notes/42"
`name`	כותרת ההערה, או ישירות טקסט ההערה עצמו, אם אין לה כותרת נפרדת.	"רשימת קניות"
`text`	אופציונאלי. טקסט ההערה, אם רלוונטי. להערות ללא כותרת נפרדת, השתמש ב"שם" (ראה למעלה).	"סטייק, פסטה, יין"
`image`	תמונה המייצגת את הפתק. ניתן להשתמש בכתובת אתר אינטרנט או ב-URI של תוכן.	"http://example.net/shopping.jpg"
`dateCreated`	זמן יצירת הפתק.	תאריך חדש (2016, 6, 2, 23, 43, 00)
`author`	אופציונאלי. מחבר ההערה.
`author.name`	שם מחבר ההערה.	"בוב"

דוגמה: הערה

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();