Cartes statiques

Vous pouvez insérer, mettre à jour, lire et supprimer des cartes statiques à l'aide d'API REST simples. En outre, vous pouvez associer des objets à une carte statique, par exemple un emplacement ou un support.

Fonctionnement

Les cartes statiques se trouvent à droite de l'horloge Glass et affichent des informations pertinentes pour l'utilisateur au moment de la livraison. Cependant, ils ne nécessitent pas une attention immédiate, comme les fiches en direct. Les utilisateurs peuvent choisir de les lire ou d'agir à leur guise.

Lorsque Glassware insère des cartes statiques dans la chronologie, Glass peut émettre un son de notification pour alerter les utilisateurs. Toutes les cartes statiques précédentes se déplacent également vers la droite et disparaissent de la chronologie au bout de sept jours ou lorsque 200 cartes sont plus récentes.

Quand les utiliser

Les cartes statiques sont idéales pour envoyer des notifications périodiques aux utilisateurs en cas d'événements importants. Par exemple, un service de diffusion d'actualités qui envoie les articles à la une en temps réel. Les cartes statiques de l'API Mirror peuvent également démarrer des fiches actives ou des immersions via l'élément de menu OPEN_URI. Cela vous permet de créer des interactions hybrides qui utilisent des cartes statiques en tant que notifications, et une carte en direct ou une immersion pour une expérience plus interactive.

Remarque : Les fiches de chronologie étant au cœur de l'expérience utilisateur, vous devez connaître les bonnes pratiques avant de créer des éléments de chronologie.

Pour obtenir la liste complète des opérations possibles pour les éléments de chronologie, consultez la documentation de référence.

Insérer des cartes statiques

Pour insérer des cartes statiques (éléments de chronologie), publiez une représentation JSON d'un élément de chronologie sur le point de terminaison REST.

Remarque:Les éléments de votre chronologie sont conservés pendant sept jours sur les lunettes Glass d'un utilisateur et sont supprimés des serveurs de Google s'ils ne sont pas mis à jour pendant 10 jours.

La plupart des champs d'un élément de la timeline sont facultatifs. Dans sa forme la plus simple, un élément de chronologie ne contient qu'un court SMS, comme dans cet exemple:

HTTP brut

POST /mirror/v1/timeline HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer {auth token}
Content-Type: application/json
Content-Length: 26

{ "text": "Hello world" }

Java

TimelineItem timelineItem = new TimelineItem();
timelineItem.setText("Hello world");
service.timeline().insert(timelineItem).execute();

Python

timeline_item = {'text': 'Hello world'}
service.timeline().insert(body=timeline_item).execute()

En cas de réussite, vous recevez un code de réponse 201 Created avec une copie complète de l'élément créé. Pour l'exemple précédent, une réponse réussie pourrait ressembler à ceci:

HTTP brut

HTTP/1.1 201 Created
Date: Tue, 25 Sep 2012 23:30:11 GMT
Content-Type: application/json
Content-Length: 303

{
 "kind": "glass#timelineItem",
 "id": "1234567890",
 "selfLink": "https://www.googleapis.com/mirror/v1/timeline/1234567890",
 "created": "2012-09-25T23:28:43.192Z",
 "updated": "2012-09-25T23:28:43.192Z",
 "etag": "\"G5BI0RWvj-0jWdBrdWrPZV7xPKw/t25selcGS3uDEVT6FB09hAG-QQ\"",
 "text": "Hello world"
}

L'élément inséré qui figurerait dans la chronologie de l'utilisateur ressemblerait à ceci:

Insérer un élément de chronologie avec une pièce jointe

Une image vaut mieux qu'un long discours, ce qui est beaucoup plus qu'un élément de chronologie. Vous pouvez également y joindre des images et des vidéos. Voici un exemple d'insertion d'un élément de chronologie avec une photo en pièce jointe:

HTTP brut

POST /upload/mirror/v1/timeline HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer {auth token}
Content-Type: multipart/related; boundary="mymultipartboundary"
Content-Length: {length}

--mymultipartboundary
Content-Type: application/json; charset=UTF-8

{ "text": "A solar eclipse of Saturn. Earth is also in this photo. Can you find it?" }
--mymultipartboundary
Content-Type: image/jpeg
Content-Transfer-Encoding: binary

[binary image data]
--mymultipartboundary--

Java

TimelineItem timelineItem = new TimelineItem();
timelineItem.setText("Hello world");
InputStreamContent mediaContent = new InputStreamContent(contentType, attachment);
service.timeline().insert(timelineItem, mediaContent).execute();

Python

timeline_item = {'text': 'Hello world'}
media_body = MediaIoBaseUpload(
    io.BytesIO(attachment), mimetype=content_type, resumable=True)
service.timeline().insert(body=timeline_item, media_body=media_body).execute()

Voici à quoi ressemble un élément de chronologie associé à une image:

Remarque : À un niveau inférieur, les pièces jointes sont importées à l'aide de HTTP Multipart. Les bibliothèques clientes des API Google facilitent cette tâche grâce à l'importation multimédia.

Ajout de la vidéo en pièce jointe...

Si vous joignez des fichiers vidéo à vos éléments de chronologie, nous vous recommandons de lire la vidéo en streaming plutôt que d'importer l'intégralité de la charge utile en même temps. L'API Google Mirror est compatible avec la diffusion en direct HTTP, le téléchargement progressif et le protocole de streaming en temps réel (RTSP). Les pare-feu étant souvent bloqués par les pare-feu, utilisez les autres options si possible.

Pour diffuser une vidéo en streaming, utilisez l'élément de menu intégré PLAY_VIDEO et spécifiez l'URL de la vidéo comme étant payload. Pour en savoir plus, consultez Ajouter des éléments de menu intégrés et les formats multimédias compatibles.

Remarque : L'association d'une URL de vidéo en streaming avec un content-type de video/vnd.google-glass.stream-url est obsolète. Utilisez plutôt l'élément de menu intégré PLAY_VIDEO.

Pagination

Vous pouvez paginer les éléments de chronologie qui ne peuvent pas figurer sur une seule fiche, mais qui doivent être associés à la même carte. Les éléments paginés partagent tous le même timeline.id et ont donc le même ensemble d'éléments de menu. Lorsqu'un utilisateur appuie sur un élément de chronologie paginé, un élément de menu Lire la suite s'affiche.

Glass pagine automatiquement les éléments de chronologie qui affichent text. Pour que Glass pagine automatiquement html, utilisez le tag article avec sa propriété de classe définie sur auto-paginate, comme dans l'exemple suivant:

<article class="auto-paginate">
 <h3>Very long list</h3>
 <ul>
   <li>First item</li>
   <li>Second item</li>
   <li>Third item</li>
   <li>Fourth item</li>
   <li>Fifth item</li>
   <li>Sixth item</li>
   <li>...</li>
 </ul>
<article>

Remarque:Le tag section n'est actuellement pas compatible avec la classe auto-paginate.

Pour la pagination manuelle, utilisez le tag article du contenu que vous souhaitez afficher sur chaque fiche. Glass affiche le contenu de chaque balise article sur une fiche de sous-timeline distincte. Par exemple, vous pouvez créer un élément de pagination avec le code HTML suivant:

<article>
 <section>
   <p>First page</p>
 </section>
</article>

<article>
 <section>
   <p>Second page</p>
 </section>
</article>

<article>
 <section>
   <p>Third page</p>
 </section>
</article>

Par défaut, la première carte de l'élément de chronologie paginé apparaît en tant que carte de couverture, puis s'affiche à nouveau lorsque l'utilisateur sélectionne l'élément de menu Lire la suite. Pour empêcher la première carte de s'afficher à nouveau après avoir appuyé sur Lire la suite, vous pouvez spécifier la classe CSS cover-only pour la première balise <article>:

<article class="cover-only">
...

La classe cover-only est également compatible avec les éléments de chronologie à pagination automatique:

<article class="auto-paginate cover-only">
...

Offres groupées

Les offres groupées vous permettent de regrouper des éléments connexes, mais distincts, comme des messages individuels dans un fil de discussion. Les groupes comportent une fiche de couverture principale sur laquelle l'utilisateur appuie pour afficher une sous-chronologie contenant les autres cartes du lot. Les lots se distinguent des cartes chronologiques normales par un pli d'angle dans l'angle supérieur droit de la carte de couverture du bundle.

Pour regrouper des éléments de chronologie, créez-les avec la même valeur pour bundleId. Le dernier élément ajouté est la carte de couverture du lot.

Remarque : Pour définir un élément de chronologie spécifique en tant que fiche de couverture du lot, définissez sa propriété isBundleCover sur true.

Les images suivantes montrent une carte de couverture d'un lot avec le pli d'angle dans l'angle supérieur droit et deux fiches groupées en dessous.

Lecture des éléments de la chronologie

Votre service peut accéder à tous les éléments de chronologie qu'il a créés et à tous ceux qui ont été partagés avec lui. Voici comment répertorier les éléments de chronologie visibles par votre service.

HTTP brut

GET /mirror/v1/timeline HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer {auth token}

Java

TimelineItem timelineItem = new TimelineItem();
service.timeline().list().execute();

Python

service.timeline().list().execute()

Vous pouvez utiliser d'autres opérations REST pour obtenir, mettre à jour et supprimer des éléments de la chronologie.

Accéder aux pièces jointes

Vous pouvez accéder aux pièces jointes à un élément de chronologie via une propriété de tableau nommée attachments. Vous pouvez ensuite obtenir les données binaires d'un rattachement via la propriété contentUrl du rattachement ou avec le point de terminaison des rattachements.

Remarque : Le contenu de la pièce jointe est protégé par OAuth 2.0, comme les autres appels aux points de terminaison de l'API. Les bibliothèques clientes des API Google permettent d'accéder au contenu binaire des pièces jointes à l'aide de la fonctionnalité de téléchargement multimédia.

HTTP brut

GET /mirror/v1/timeline/{itemId}/attachments/{attachmentId} HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer {auth token}

Java

TimelineItem item = service.timeline().get(itemId).execute();
String attachmentId = item.getAttachments().get(0).getId();
service.attachments().get(itemId, attachmentId).executeAsInputStream();

Créer des éléments de menu

Les éléments de menu permettent aux utilisateurs de demander des actions liées à la fiche de la timeline. Il existe deux types d'éléments de menu intégrés et personnalisés.

Les éléments de menu intégrés permettent d'accéder à des fonctionnalités spéciales fournies par Glass, comme lire une carte de chronologie, accéder à un lieu, partager une image ou répondre à un message:

Les éléments de menu personnalisés permettent à votre application d'exposer un comportement spécifique à votre Glassware. Vous pouvez également fournir une icône d'élément de menu correspondant à votre branding.

Ajouter des éléments de menu intégrés

Vous pouvez ajouter des éléments de menu intégrés à vos éléments de chronologie en insérant la valeur menuItems array lorsque vous les insérez. Pour utiliser un élément de menu intégré, il vous suffit de renseigner le action de chaque menuItem.

Remarque:Lorsque vous utilisez l'élément de menu intégré REPLY ou REPLY_ALL, n'imposez pas aux utilisateurs de parler un ensemble limité d'options, comme les mouvements possibles dans un jeu ou les commandes d'un service. Ces éléments de menu sont destinés à capturer la saisie vocale à forme libre.

HTTP brut

HTTP/1.1 201 Created
Date: Tue, 25 Sep 2012 23:30:11 GMT
Content-Type: application/json
Content-Length: 303

{
  "text": "Hello world",
  "menuItems": [
    {
      "action": "REPLY"
    }
  ]
}

Remarque:La documentation de référence contient une description détaillée des actions intégrées disponibles.

Définir des éléments de menu personnalisés

Si les éléments de menu intégrés ne vous conviennent pas, vous pouvez créer des éléments de menu personnalisés avec vos propres actions. Pour ce faire, procédez comme suit lorsque vous insérez ou mettez à jour un élément de chronologie:

• Spécifiez CUSTOM pour menuItem.action.
• Spécifiez un menuItem.id. Lorsque les utilisateurs appuient sur l'élément de menu personnalisé, votre Glassware reçoit une notification contenant menuItem.id. Cela vous permet de déterminer la source de la notification.
• Spécifiez menuItem.values pour ajouter un iconUrl et un displayName qui apparaissent dans Glass. Pointez sur une image PNG de 50 x 50 de couleur blanche avec un arrière-plan transparent pour iconUrl.

• Spécifiez un displayTime. Si vous ne spécifiez pas d'élément displayTime, l'élément de la chronologie est placé au début de la chronologie chaque fois que les utilisateurs appuient sur l'élément de menu personnalisé.

HTTP brut

HTTP/1.1 201 Created
Date: Tue, 25 Sep 2012 23:30:11 GMT
Content-Type: application/json
Content-Length: 303

{
  "text": "Hello world",
  "displayTime": "2013-08-08T22:47:31-07:00",
  "menuItems": [
    {
      "action": "CUSTOM",
      "id": "complete"
      "values": [{
        "displayName": "Complete",
        "iconUrl": "http://example.com/icons/complete.png"
      }]
    }
  ]
}

Autoriser les utilisateurs à épingler votre fiche chronologique

Vous pouvez créer un élément de menu qui permet aux utilisateurs d'épingler la carte de la chronologie, qui affiche de manière permanente la carte de la chronologie à gauche de la carte principale. Les utilisateurs peuvent également retirer la fiche en utilisant le même élément de menu.

L'élément de menu épinglé est un élément de menu intégré. Il vous suffit donc de fournir le TOGGLE_PINNED action pour un menuItem.

HTTP brut

HTTP/1.1 201 Created
Date: Tue, 25 Sep 2012 23:30:11 GMT
Content-Type: application/json
Content-Length: 303

{
  "text": "You can pin or unpin this card.",
 "menuItems": [
    {
      "action": "TOGGLE_PINNED"
    }
  ...
 ]
}

Abonnements

L'API Mirror vous permet de vous abonner aux notifications envoyées lorsque l'utilisateur effectue des actions spécifiques sur un élément de la chronologie ou lorsque sa position est mise à jour. Lorsque vous vous abonnez à une notification, vous fournissez une URL de rappel qui la traite.

Remarque : En production, votre URL de rappel doit être compatible avec SSL. À des fins de développement, nous fournissons un serveur proxy d'abonnement capable de transférer les notifications à votre serveur de développement non-SSL.

Recevoir des notifications

Une notification de l'API Mirror est envoyée sous la forme d'une requête POST au point de terminaison Abonné contenant un corps de requête JSON.

HTTP brut

{
  "collection": "timeline",
  "itemId": "3hidvm0xez6r8_dacdb3103b8b604_h8rpllg",
  "operation": "UPDATE",
  "userToken": "harold_penguin",
  "verifyToken": "random_hash_to_verify_referer",
  "userActions": [
    {
      "type": "<TYPE>",
      "payload": "<PAYLOAD>"
    }
  ]
}

Java

import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.jackson.JacksonFactory;
import com.google.api.services.mirror.model.Notification;

import java.io.IOException;
import java.io.InputStream;
// ...

public class MyClass {
  // ...

  /**
    * Parse a request body into a Notification object.
    *
    * @param requestBody The notification payload sent by the Mirror API.
    * @return Parsed notification payload if successful, {@code null} otherwise.
    */
  static Notification parseNotification(InputStream requestBody) {
    try {
      JsonFactory jsonFactory = new JacksonFactory();

      return jsonFactory.fromInputStream(requetBody, Notification.class);
    } catch (IOException e) {
      System.out.println("An error occurred: " + e);
      return null;
    }
  }

  // ...
}

Python

import json

def parse_notification(request_body):
  """Parse a request body into a notification dict.

  Params:
    request_body: The notification payload sent by the Mirror API as a string.
  Returns:
    Dict representing the notification payload.
  """
  return json.load(request_body)

Votre service doit répondre à l'API avec un code d'état HTTP 200 OK si aucune erreur ne s'est produite. Si votre service répond par un code d'erreur, l'API Mirror peut tenter de renvoyer la notification à votre service.

Remarque : La connexion expire après 10 secondes. Si un processus long est requis, répondez immédiatement et effectuez le processus dans un autre fil de discussion.

Types de notifications

L'API Mirror envoie une charge utile de notification différente pour différents événements.

Répondre

L'utilisateur a répondu à votre élément de chronologie à l'aide de l'élément de menu REPLY intégré:

{
  "collection": "timeline",
  "itemId": "3hidvm0xez6r8_dacdb3103b8b604_h8rpllg",
  "operation": "INSERT",
  "userToken": "harold_penguin",
  "verifyToken": "random_hash_to_verify_referer",
  "userActions": [
    {
      "type": "REPLY"
    }
  ]
}

L'attribut itemId est défini sur le ID de l'élément contenant:

• Attribut inReplyTo défini sur le ID de l'élément de chronologie auquel il répond.
• Attribut text défini sur la transcription de texte.
• Attribut recipients défini sur le creator de l'élément de chronologie auquel il s'agit d'une réponse, s'il existe.

Exemple :

{
  "kind": "glass#timelineItem",
  "id": "3hidvm0xez6r8_dacdb3103b8b604_h8rpllg",
  "inReplyTo": "3236e5b0-b282-4e00-9d7b-6b80e2f47f3d",
  "text": "This is a text reply",
  "recipients": [
    {
      "id": "CREATOR_ID",
      "displayName": "CREATOR_DISPLAY_NAME",
      "imageUrls": [
        "CREATOR_IMAGE_URL"
      ]
    }
  ]
}

Supprimer

L'utilisateur a supprimé un élément de chronologie:

{
  "collection": "timeline",
  "itemId": "3hidvm0xez6r8_dacdb3103b8b604_h8rpllg",
  "operation": "DELETE",
  "userToken": "harold_penguin",
  "verifyToken": "random_hash_to_verify_referer",
  "userActions": [
    {
      "type": "DELETE"
    }
  ]
}

L'attribut itemId est défini sur l'ID de l'élément supprimé. L'élément ne contient plus de métadonnées autres que son ID et la propriété isDeleted.

Remarque:Si l'utilisateur supprime un élément de son historique, il est également recommandé de supprimer ce contenu de vos systèmes.

Élément de menu personnalisé sélectionné

L'utilisateur a sélectionné un élément de menu personnalisé défini par votre service:

{
  "collection": "timeline",
  "itemId": "3hidvm0xez6r8_dacdb3103b8b604_h8rpllg",
  "operation": "UPDATE",
  "userToken": "harold_penguin",
  "userActions": [
    {
      "type": "CUSTOM",
      "payload": "PING"
    }
  ]
}

L'attribut itemId est défini sur l'ID de l'élément de menu sélectionné par l'utilisateur.

Le tableau userActions contient la liste des actions personnalisées que l'utilisateur a effectuées sur cet élément. Votre service doit gérer ces actions en conséquence.

Mise à jour de la position

Un nouvel emplacement est disponible pour l'utilisateur actuel:

{
  "collection": "locations",
  "itemId": "latest",
  "operation": "UPDATE",
  "userToken": "harold_penguin",
  "verifyToken": "random_hash_to_verify_referer"
}

Lorsque votre Glassware reçoit une mise à jour de sa position, envoyez une requête au point de terminaison glass.locations.get pour récupérer la dernière position connue. Votre appareil Glassware reçoit des mises à jour de votre position toutes les dix minutes.

Remarque:La récupération des informations de localisation nécessite le champ d'application https://www.googleapis.com/auth/glass.location.

Une commande vocale

Votre utilisateur a activé une commande vocale. Exemple : "OK Glass, prends une note, Chat Stream, Anniversaire de Chipotle est demain." La notification suivante est envoyée à votre Glass:

{
  "collection": "timeline",
  "operation": "INSERT",
  "userToken": "chipotle's_owner",
  "verifyToken": "mew mew mew",
  "itemId": "<ITEM_ID>",
  "userActions": [
    {“type”: "LAUNCH"}
  ]
}

Cette notification se distingue des autres notifications par la valeur LAUNCH de la propriété userActions.

Vous pouvez ensuite utiliser la valeur dans itemId pour récupérer l'élément de chronologie:

{
  "id": "<ITEM_ID>",
  "text": "Chipotle's birthday is tomorrow",
  "recipients": [
    {"id": "CAT_STREAM"}
  ]
}

La propriété recipients contient le id du contact qui représente la commande vocale utilisée.