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

公開と登録

Nearby Messages は、近くのデバイスが小さなペイロードのデータを交換できるようにするパブリッシュ / サブスクライブ API です。デバイスがメッセージを公開すると、近くのデバイスがそのメッセージを受信できます。このガイドでは、Nearby Messages API を使用してメッセージを公開し、メッセージをサブスクライブするためにアプリで実装する必要があるすべての機能について説明します。

近くにあるデバイスのセットは、Bluetooth を介した小さなトークンの交換によって決まります。デバイスが近くのデバイスのトークンを検出すると、そのトークンを Nearby Messages サーバーに送信して検証し、アプリケーションの現在のサブスクリプションセットに配信するメッセージがあるかどうかを確認します。

アプリは、デバイス検出に使用されるメディアのセットと、トークンのブロードキャストやトークンのスキャンにメディアを使用するかどうかを制御できます。デフォルトでは、ブロードキャストとスキャンはすべてのメディアで実行されます。サブセットまたはメディアで検出を行うこと、ブロードキャストまたはスキャンのどちらを行うかを制御するには、パブリケーションとサブスクリプションを作成するときに追加のパラメータを渡す必要があります。

積極的に公開と登録が行われている場合、「Nearby が使用中です」という通知が表示され、Nearby がアクティブであることをユーザーに知らせます。この通知は、1 つ以上のアプリが Nearby をアクティブに使用している場合にのみ表示されるため、Nearby が不要な場合はバッテリーを節約できます。ユーザーには次のオプションが提供されます。

アプリに移動して Nearby を無効にします。
アプリが Nearby の使用を強制的に停止する。
[Nearby Settings] 画面に移動します。

PublishCallback() と SubscribeCallback() を使用して、ユーザーがアプリで Nearby の使用を強制的に停止したケースをリッスンできます。この場合、onExpired() メソッドがトリガーされます。

Nearby Messages API はバッテリー駆動時間に影響する可能性があるため、（BLE バックグラウンドサブスクリプションを除き）フォアグラウンドアクティビティからのみ使用する必要があります。

publish() または subscribe() を呼び出して Nearby Messages API を使用します。アプリは常に onStop() で unpublish() と unsubscribe() を対称的に配置する必要があります。

@Override
public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    ...
    mMessageListener = new MessageListener() {
        @Override
        public void onFound(Message message) {
            Log.d(TAG, "Found message: " + new String(message.getContent()));
        }

        @Override
        public void onLost(Message message) {
            Log.d(TAG, "Lost sight of message: " + new String(message.getContent()));
        }
    }

    mMessage = new Message("Hello World".getBytes());
}

@Override
public void onStart() {
    super.onStart();
    ...
    Nearby.getMessagesClient(this).publish(mMessage);
    Nearby.getMessagesClient(this).subscribe(mMessageListener);
}

@Override
public void onStop() {
    Nearby.getMessagesClient(this).unpublish(mMessage);
    Nearby.getMessagesClient(this).unsubscribe(mMessageListener);
    ...
    super.onStop();
}

メッセージの公開

メッセージをパブリッシュするには、メッセージのバイト配列を渡して Nearby.getMessagesClient(Activity).publish() を呼び出します。メッセージを 3 KB 未満に抑えることをおすすめします（これらのメッセージはより速く配信できます）。ただし、必要に応じてアプリで最大 100 KB までサポートできます。このサービスは、写真や動画などの大きなオブジェクトの交換を目的としたものではありません。

必要に応じて、PublishOptions.setStrategy() を呼び出して、使用する戦略を設定できます。

次の例は、publish() を呼び出して短いテキストメッセージを送信する方法を示しています。

private void publish(String message) {
    Log.i(TAG, "Publishing message: " + message);
    mActiveMessage = new Message(message.getBytes());
    Nearby.getMessagesClient(this).publish(mActiveMessage);
}

メッセージの公開を停止する

メッセージを公開停止するには、unpublish() を呼び出します。アプリでは、少なくとも onStop() メソッドで公開停止を呼び出す必要があります。公開に使用したものと同じ Message オブジェクト（この例では mActiveMessage）を渡します。

次のコードサンプルは、unpublish() の呼び出しを示しています。

private void unpublish() {
    Log.i(TAG, "Unpublishing.");
    if (mActiveMessage != null) {
        Nearby.getMessagesClient(this).unpublish(mActiveMessage);
        mActiveMessage = null;
    }
}

メッセージをサブスクライブする

他のデバイスからのメッセージを定期購読するには、Nearby.getMessagesClient(Activity).subscribe() を呼び出します。サブスクライブされたメッセージを受信するには、MessageListener を渡す必要があります。

必要に応じて、SubscribeOptions.setStrategy() を呼び出して、使用する戦略を設定できます。

次の例は、メッセージの定期購入を示しています。

public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    ...
    mMessageListener = new MessageListener() {
        @Override
        public void onFound(Message message) {
            Log.d(TAG, "Found message: " + new String(message.getContent()));
        }

        @Override
        public void onLost(Message message) {
            Log.d(TAG, "Lost sight of message: " + new String(message.getContent()));
        }
    }
}

// Subscribe to receive messages.
private void subscribe() {
    Log.i(TAG, "Subscribing.");
    Nearby.getMessagesClient(this).subscribe(mMessageListener, options);
}

配信停止

登録を解除してデバイスメッセージの受信を停止するには、Nearby.getMessagesClient(Activity).unsubscribe() を呼び出します。サブスクリプションに使用したものと同じ MessageListener オブジェクトを渡します（この例では mMessageListener）。

次のコードサンプルは、登録解除を示しています。

private void unsubscribe() {
    Log.i(TAG, "Unsubscribing.");
    Nearby.getMessagesClient(this).unsubscribe(mMessageListener);
}