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

Watch Face Format のセットアップ
コレクションでコンテンツを整理必要に応じて、コンテンツの保存と分類を行います。

注: このページでは、ウォッチフェイスの構成を手動で管理するプロセスのステップについて説明します。WYSIWYG（What You See Is What You Get）スタイルのツールを使用してウォッチフェイスをデザインする場合は、まずウォッチフェイススタジオガイドをご覧ください。

このガイドでは、Watch Face Format を使用してウォッチフェイスを構成するのに必要なツールの手順、プロジェクト構造に関する推奨事項、その構造を作成するツールを適用するための手順ガイドを示します。

前提条件

Watch Face Format の使用に対する開発環境を整えるには、次のセットアップ手順を完了してください。

Android 14（API レベル 34）以降に対応する SDK をインストールします。ウォッチフェイスがバージョン 2 に固有の機能や動作に依存していない場合は、代わりに Android 13（API レベル 33）の SDK をインストールできます。

この SDK には、aapt2 や android.jar など他の必要なツールが含まれています。
または、Android Studio をインストールします。これらのツールも提供されます。

プロジェクトの構造

Watch Face Format を使用するカスタムウォッチフェイスを作成する場合、カスタムウォッチフェイスファイルを含む Android App Bundle は、Wear OS アプリのロジックを含む Android App Bundle から完全に分離する必要があります。Google Play を含む一部のアプリストアでは、Wear OS ロジックとカスタムウォッチフェイスの両方が含まれる Android App Bundle はアップロードできません。

ウォッチフェイスバンドルを作成する

ウォッチフェイスファイルを備えた Android App Bundle を作成するには、以下のセクションに示す手順を完了してください。

Watch Face Format の使用を宣言する

新しいアプリのマニフェストファイル（AndroidManifest.xml）に、Watch Face Format の使用を示すアプリプロパティを追加します。Wear OS 5 以降を搭載したデバイスでウォッチフェイスへのアクセスを制限しない場合は、バージョン 2 をサポートするウォッチフェイス APK とバージョン 1 をサポートするウォッチフェイス APK を 2 つ作成します。詳しくは、アプリのバージョンを設定する方法をご覧ください。

<manifest ...>
    <!--
        Use SDK version 34 for version 2 of WFF, and SDK version 33 for version
        1 of WFF
    -->
    <uses-sdk
        android:minSdkVersion="34"
        android:targetSdkVersion="34" />

    <!--
        WFF is a resource-only format, so the hasCode attribute should be set to
        false to reflect this.
    -->
    <application
        android:label="@string/watch_face_name"
        android:hasCode="false"
        ...>
        <meta-data android:name="com.google.android.wearable.standalone"
            android:value="true" />
        <property
            android:name="com.google.wear.watchface.format.version"
            android:value="2" />
    </application>
</manifest>

ウォッチフェイスのメタデータを宣言する

アプリの res/xml リソースディレクトリに watch_face_info.xml という新しいファイルを作成します。ここでは、ウォッチフェイスのメタデータを定義します。

<?xml version="1.0" encoding="utf-8"?>
<WatchFaceInfo>

    <Preview value="@drawable/watch_face_preview" />
    <Category value="CATEGORY_EMPTY" />
    <AvailableInRetail value="true" />
    <MultipleInstancesAllowed value="true" />
    <Editable value="true" />
</WatchFaceInfo>

このファイルのフィールドは、次の詳細を表しています。

Preview

ウォッチフェイスのプレビュー画像を含むドローアブルを参照します。

Category

ウォッチフェイスのカテゴリを定義します。文字列か、@string/ref_name などの文字列への参照を指定する必要があります。各デバイスメーカーは、それぞれ独自のウォッチフェイスカテゴリのセットを定義できます。

デフォルト値: empty_category_meta。ウォッチフェイス選択ツールビューの一番下に、このウォッチフェイスを他の「空のカテゴリ」のウォッチフェイスと一緒にグループ化します。

AvailableInRetail

デバイスの販売店デモモードでウォッチフェイスを使用できるかどうか。ブール値、または @bool/watch_face_available_in_retail などのブール値への参照である必要があります。

デフォルト値: false

MultipleInstancesAllowed

ウォッチフェイスに複数のお気に入りを登録できるかどうか。ブール値、または @bool/watch_face_multiple_instances_allowed などのブール値への参照である必要があります。

デフォルト値: false

Editable

ウォッチフェイスが編集可能かどうか（つまり、ウォッチフェイスの設定や固定されていないウォッチフェイスの追加機能が 1 つ以上あるかどうか）。これは、お気に入りリストにあるウォッチフェイスの [編集] ボタンを表示または非表示にするために使用されます。

デフォルト値: false

ウォッチフェイス名を宣言する

アプリのマニフェストファイル（AndroidManifest.xml）では、android:label 属性をウォッチフェイスの名前に設定します。

<application android:label="@string/watch_face_name" >

ウォッチフェイスの詳細を宣言する

基本的な WFF ウォッチフェイスドキュメントの構造は次のとおりです。

<WatchFace width="450" height="450">
  <Scene>
    <!-- Content to be rendered -->
  </Scene>
</WatchFace>

単一のウォッチフェイスを使用している場合は、ウォッチフェイスを作成時にこの XML ファイルを res/raw/watchface.xml として作成します。さまざまな画面の形状とサイズをサポートするには、複数の形状とサイズのサポートを宣言します。

ルート要素は常に WatchFace です。height と width は、ウォッチフェイスで使用する座標空間の範囲を定義します。ウォッチフェイスは、使用しているデバイスに合わせてスケーリングされます。height と width は実際のピクセルを表すものではありません。

Watch Face Format は、ウォッチフェイスに関する以下の詳細情報を整理します。

メタデータ: ウォッチフェイスのプレビュー画像に表示される時刻や歩数など。
ユーザー設定: ウォッチフェイスのさまざまなカラーテーマ、ユーザーが切り替え可能な要素、複数の要素から選択できる要素など。Watch Face Format バージョン 2 では、ユーザー構成内に表示できるフレーバーが導入されています。各フレーバーは、ウォッチフェイスの時刻とともに表示される要素のタイプとスタイルを指定する、事前設定されたユーザー構成を指定します。これらのプリセットを使用すると、視覚的に魅力的な要素のグループを簡単に作成できます。Wear OS コンパニオンアプリでは、スクロール可能な行にウォッチフェイスのさまざまなバリエーションが表示されます。
ウォッチフェイスのビジュアル要素を含むシーン。シーンの終盤に表示される要素は他の要素の上に表示されるため、一般的な順序は次のようになります。
- アナログ時計の針、またはデジタル時計のテキスト
- 曜日やユーザーの歩数など、追加情報を表示するウォッチフェイスの追加機能
- キャンプ場の画像など、ウォッチフェイスに視覚的な興味や装飾を提供するその他のグラフィック
要素のグループ。複数の要素を同時に変更できます。シーン内でこれらのグループのバリエーションを作成すると、システムが省電力のアンビエントモードに入るときにコンテンツを選択的に非表示または変更できます。

属性は厳密に分類されており、頻度と有効な値に関するガイドラインが用意されているため、ウォッチフェイスを作成するときに起こりうるエラー要因をほぼ回避できます。

ウォッチフェイスの形状に関するサポートを宣言する（省略可）

この手順は、さまざまなサイズのウォッチフェイスで異なる動作をサポートする場合にのみ必要です。ウォッチフェイスがスマートウォッチのサイズに合わせて拡大縮小される場合は、この手順をスキップできます。

アプリの res/xml リソースディレクトリで、watch_face_shapes.xml でサポートするウォッチフェイスの形状のセットを宣言します。

<WatchFaces>

    <WatchFace shape="CIRCLE" width="300" height="300"
               file="@raw/watchface"/>
    <WatchFace shape="CIRCLE" width="450" height="450"
               file="@raw/watchface_large_circle"/>

    <!-- Remove any references to rectangular watch faces -->
    <WatchFace shape="RECTANGLE" width="380" height="400"
               file="@raw/watchface_rectangle"/>
</WatchFaces>

次に、ウォッチフェイスの形状ごとにウォッチフェイスの外観と動作を定義します。シェイプファイルを定義しなかった場合は、watchface.xml という 1 つのファイルのみを作成する必要があります。

このセクションの例を使用すると、未加工の XML ファイルは次のようになります。

res/raw/watchface.xml
res/raw/watchface_large_circle.xml
~~res/raw/watchface_rectangle.xml~~

ウォッチフェイスのパブリッシャーを特定する（省略可）

必要に応じて、アプリのマニフェストファイルで、ウォッチフェイスのパブリッシャーの特定に使用できる任意の文字列、または使用するツール名とバージョンを宣言します。

<application ...>
    ...
    <property
        android:name="com.google.wear.watchface.format.publisher"
        android:value="<var>{toolName}-{toolVersion}</var>" />
</application>

ウォッチフェイスの正確性とパフォーマンスを確認する

開発中および Google Play にアップロードする前に、検証ツールを使用して、ウォッチフェイスにエラーがないこと、メモリ使用量の推奨事項に準拠していることを確認します。

公開に向けて、メモリ使用量の最適化とメモリ使用量の確認について学びましょう。
開発サイクルの一環として XML 検証ツールを使用する方法について学習する。

ウォッチフェイスの App Bundle をビルドする

ウォッチフェイスを含む Android App Bundle をビルドするには、Gradle ビルドシステムを使用します。詳しくは、Gradle を使用してアプリをビルドするをご覧ください。

これは GitHub のサンプルで示されています。

あなたへのおすすめ

注: JavaScript がオフになっている場合はリンクテキストが表示されます
AAPT2
Jetpack Compose の基本
CameraX のスタートガイド