このページは Cloud Translation API によって翻訳されました。

静的カード

シンプルなコードを使って静的カードを挿入、更新、読み取り、削除 REST API。また、静的なカード（場所またはメディアを選択します

仕組み

静的カードは、デフォルトで Glass の時計の右側に表示され、情報が表示されますユーザーとの関連性が高いと判断できます。ただし、ライブカードのように即座に注意を引くユーザーはカードを読み取ったりできます。

Glassware によって静的カードがタイムラインに挿入されると、通知が再生されることがあります。音でユーザーに知らせることができます。以前の静的カードもすべて右に移動します 7 日後に、またはカードが 200 枚新しい時点でタイムラインに表示されなくなります。

アフィリエイト住所表示オプションの目的

静的なカードは定期的な通知重要なイベントが発生したときにユーザーに通知できますたとえばニュース配信サービスではトップニュースがリアルタイムで送信されますMirror API の静的カードライブカードや没入感を OPEN_URI 選択します。これにより、Google Chat と Gmail を利用した通知として使用する静的カードと、ライブカードまたはよりインタラクティブな体験を提供できます

タイムラインアイテムに対して実行可能な操作の一覧については、リファレンスドキュメントをご覧ください。

静的カードの挿入

静的カード（タイムラインアイテム）を挿入するには、タイムラインアイテムの JSON 表現アクセスすることもできます。

タイムラインアイテムのほとんどのフィールドはオプションです。最も単純な形式ではタイムラインアイテムには、次の例に示すように短いテキストメッセージのみが含まれます。

未加工の HTTP

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

成功すると、次の内容を含む 201 Created レスポンスコードが返されます。作成されたアイテムの完全なコピー。前の例で成功を示すレスポンスは、次のようになります。

未加工の HTTP

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"
}

挿入されたアイテムは、ユーザーのタイムラインに次のように表示されます。

添付ファイルを含むタイムラインアイテムを挿入する

百聞は一見にしかずと言うので、タイムラインのアイテム。そのために、画像と動画を添付することもできます。追加することもできますタイムラインアイテムを挿入する方法の例を次に示します。写真添付:

未加工の HTTP

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

画像が添付されたタイムラインアイテムは、Glass では次のように表示されます。

動画を添付しています

タイムラインアイテムに動画ファイルを追加する場合は、ペイロード全体を一度にアップロードするのではなく、 Google Mirror API は、HTTP Live Streaming を使用したストリーミングをサポートしています。プログレッシブダウンロード、リアルタイムストリーミングプロトコル（RTSP）の 3 つがあります。 RTSP はファイアウォールによって頻繁にブロックされるため、必要に応じて他のオプションを使用してください。考えています

動画をストリーミングするには、PLAY_VIDEO を使用します。動画の URL をメニュー項目の動画の URL として payload。詳しくは、組み込みメニューアイテムの追加サポートされているメディア形式をご覧ください。

ページ分割

1 つのタイムラインカードに収まらないタイムラインアイテムは、ページ分割が可能です。それ以外は同じカードに関連付けられている必要があります。ページ分けありすべての商品アイテムが同じ timeline.id を共有するため、同じメニュー項目のセットを削除します。ページ分けされたタイムラインアイテムをユーザーがタップすると、 [もっと見る] メニュー項目が表示されます。

Glass では、表示されるタイムラインアイテムが自動的にページ分けされます text。Glass を自動的に使用するにはページ分け: html、article この例のように、クラスプロパティを auto-paginate に設定しています。

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

手動でページ分けするには、コンテンツに article タグを使用します。各カードに表示する情報を選択できます各デバイスの中身が別のサブタイムラインカードに article タグを配置します。たとえば、次の HTML を含む、ページ分けされたタイムラインアイテム:

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

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

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

デフォルトでは、ページ分けされたタイムラインアイテムの最初のカードは、カバーカードが表示され、ユーザーが [もっと見る] を選択すると再び表示されます。選択します。タップして最初のカードが再表示されないようにするため詳細: 最初のオブジェクトには cover-only CSS クラスを指定できます。 <article> タグ:

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

cover-only クラスは、自動的にページ分けされるタイムラインアイテムもサポートしています。

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

分類

分類を使用すると、関連性はあるが個別の項目をグループ化できます。たとえば、メールスレッドの 1 件のメッセージに集中できます。バンドルのメイン表紙カードには、ユーザーがタップすると、バンドル内の他のカードを含むサブタイムラインが表示されます。バンドルは、上部の角を折りたたんだことで通常のタイムラインカードと区別されます。バンドルのカバーカードの右端にクリックします。

タイムラインアイテムをバンドルするには、 bundleId。最近追加されたセットのカバーカードです。

次の画像は 1 つのバンドルを示しています右上の角の折り目と 2 つのバンドルが入った表紙カードその下にカードが表示されます。

タイムラインアイテムの読み取り

サービスは、作成したすべてのタイムラインアイテムと、すべてのタイムラインにアクセスできます。共有されたアイテムが表示されます。以下の手順を踏みます。タイムラインアイテムを一覧表示するアクセスできます。

未加工の HTTP

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

他の REST オペレーションを使用して、get、 update とタイムラインアイテムを削除する。

添付ファイルへのアクセス

タイムラインアイテムの添付ファイルには、 attachments という名前の配列プロパティ。添付ファイルのバイナリデータは、 contentUrl プロパティを関連付けたり、添付ファイルエンドポイントです。

未加工の HTTP

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

メニュー項目の作成

メニュー項目を使用すると、タイムラインカードに関連するアクションをリクエストできます。組み込みメニュー項目とカスタムメニュー項目の 2 種類があります

組み込みのメニュー項目から、Google Cloud のタイムラインカードの読み上げ、画像の共有、メッセージへの返信。

カスタムメニューアイテムを使用すると、アプリケーションで特定の動作を公開できます。また、メニューアイテムアイコンを指定することで、ブランディング。

タイムラインアイテムに組み込みのメニュー項目を追加するには、 menuItems array。組み込みのメニュー項目を使用するには、各 menuItem の action。

未加工の HTTP

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"
    }
  ]
}

カスタムメニュー項目の定義

組み込みのメニュー項目が適さない場合は、タイムラインアイテムを挿入または更新するときに、次の操作を行うことができます。

menuItem.action には CUSTOM を指定します。
menuItem.id を指定します。ユーザーがカスタムメニュー項目をタップすると、通知を受け取る menuItem.id にデータが入力されました。これにより、広告が配信されている通知を受け取ります。
iconUrl を追加するには、menuItem.values を指定します。 Glass に表示される displayName。50 x 50 の PNG にカーソルを合わせます。 iconUrl の透明な背景を持つ白色の画像。
displayTime を指定します。displayTime を指定しない場合、タイムラインアイテムはユーザーがカスタムメニュー項目をタップすると、タイムラインの前に移動します。

未加工の HTTP

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"
      }]
    }
  ]
}

ユーザーがタイムラインカードを固定できるようにする

ユーザーがタイムラインカードを固定できるメニュー項目を作成できます。メインの画面の左側にタイムラインカードが常に表示されます。時計のカードです。同じメニューを使用して、カードの固定を解除することもできます。表示されます。

固定メニュー項目は組み込みのメニュー項目であるため、必要な作業は TOGGLE_PINNED を指定することだけです。 menuItem の action。

未加工の HTTP

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"
    }
  ...
 ]
}

定期購入

Mirror API を使用すると通知を受け取るスペースでユーザーが特定の操作を行ったときに送信されるタイムライン項目またはユーザーの位置情報がが更新されました。通知に登録すると、通知を処理するコールバック URL を提供します。

通知の受信

Mirror API からの通知は、POST リクエストとして JSON リクエスト本文を含むサブスクライブされたエンドポイント。

未加工の HTTP

{
  "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)

サービスが API に 200 OK HTTP ステータスを返すコードを返します。サービスからエラーコードが返された場合、Mirror API がサービスに通知を再送信してみてください。

通知の種類

Mirror API は、イベントごとに異なる通知ペイロードを送信します。

返信

ユーザーが組み込みの REPLY を使用してタイムラインアイテムに返信したメニュー項目:

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

itemId 属性は、以下を含むアイテムの ID に設定されます。

タイムラインアイテムの ID に設定された inReplyTo 属性クリックします。
テキストの音声文字変換に設定された text 属性。
タイムラインアイテムの creator に設定された recipients 属性返信です（存在する場合）。

例:

{
  "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"
      ]
    }
  ]
}

削除

ユーザーがタイムラインアイテムを削除しました。

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

itemId 属性は、削除されたサービスの ID に設定されます。表示されます。アイテムには、ID と isDeleted プロパティ。

カスタムメニュー項目が選択されました

ユーザーが選択したのはカスタムメニュー項目サービスによって設定されます。

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

itemId 属性は、次のメニュー項目の ID に設定されます。表示されます。

userActions 配列には、カスタムアクションのリストが含まれます。ユーザーがこのアイテムで取得したアイテムです。サービスでこれらの処理をそれに応じてアクションを実行できます

位置情報の更新

現在のユーザーは新しい場所を利用できます。

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

Glassware が位置情報の更新を受信したら、 glass.locations.get へのリクエスト最新の既知の位置情報を取得できます。自分の Glassware は 10 分ごとに位置情報の更新を受信します。

音声コマンド

ユーザーが次のような音声コマンドを起動しました。「OK Glass、メモして、猫ストリーム、チポトレの誕生日は tomorrow」と指定します。次の通知が Glassware:

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

この通知は、LAUNCH 値によって他の通知と区別されます。 userActions プロパティ。

次に、itemId の値を使用してタイムラインアイテムを取得できます。

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

recipients プロパティには、id を表す連絡先の使用した音声コマンド。

静的カード

仕組み

アフィリエイト住所表示オプションの目的

静的カードの挿入

未加工の HTTP

Java

Python

未加工の HTTP

添付ファイルを含むタイムライン アイテムを挿入する

未加工の HTTP

Java

Python

動画を添付しています

ページ分割

分類

タイムライン アイテムの読み取り

未加工の HTTP

Java

Python

添付ファイルへのアクセス

未加工の HTTP

Java

メニュー項目の作成

組み込みメニュー項目の追加

未加工の HTTP

カスタム メニュー項目の定義

未加工の HTTP

ユーザーがタイムライン カードを固定できるようにする

未加工の HTTP

定期購入

通知の受信

未加工の HTTP

Java

Python

通知の種類

返信

削除

カスタム メニュー項目が選択されました

位置情報の更新

音声コマンド

添付ファイルを含むタイムラインアイテムを挿入する

タイムラインアイテムの読み取り

カスタムメニュー項目の定義

ユーザーがタイムラインカードを固定できるようにする

カスタムメニュー項目が選択されました