Field Service モバイルアプリケーションのディープリンクスキーマ
Android サービスと iOS サービスの両方で、Field Service モバイルアプリケーションの事前定義された URI スキーマを使用します。
URI スキーマの形式
<com.salesforce.fieldservice>://v1/sObject/<id>/<action>
URI スキーマの形式の各パラメータを見ていきましょう。- com.salesforce.fieldservice — サポートされている Salesforce スキーマ名。
- v1 — ディープリンクの現在のバージョン。これは静的値です。
- sObject — Salesforce オブジェクトの単一インスタンスを示します。スキーマは、作業指示、サービス予定、資産といった、Field Service アプリケーションでサポートされているすべてのオブジェクト種別に対応します。
- id — Salesforce オブジェクトの一意の単一インスタンス。長さが 15 文字および 18 文字の id がサポートされています。
- action — サポートされている URI スキーマ操作。有効なアクションは、[サポートされている URI スキーマ] のセクションに表示されます。アクションが指定されていない場合、作業指示およびサービス予定の URI は [概要] タブに誘導されます。他のオブジェクト種別の URI は [詳細] タブに誘導されます。
- api_name — 一部のディープリンクには、その機能を実行するために API 名が必要です。たとえば、クイックアクションの URI にはクイックアクションの API 名が必要で、フローの URI にはフローの API 名が必要です。
サポートされている URI スキーマ
- com.salesforce.fieldservice://v1/sObject/<id>
- 作業指示およびサービス予定の [概要] タブにリンクします。他のすべてのオブジェクト種別の [詳細] タブにリンクします。複数のサービス予定を持つ作業指示にリンクする場合、作業指示の [概要] タブでは関連リストの最初のサービス予定が使用されます。
- 例: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA
- この例は、作業指示の [概要] タブにリンクします。
- com.salesforce.fieldservice://v1/sObject/<id>/details
- 他のすべてのオブジェクト種別の [詳細] タブにリンクします。
- 例: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/details
- この例は、作業指示の [詳細] タブにリンクします。
- com.salesforce.fieldservice://v1/sObject/<id>/related
- 他のすべてのオブジェクト種別の [関連] タブにリンクします。
- 例: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/related
- この例は、作業指示の [関連] タブにリンクします。
- com.salesforce.fieldservice://v1/sObject/<id>/products
- 他の該当するオブジェクト種別の [商品] タブにリンクします。オブジェクトに [商品] タブがない場合は、[詳細] タブにリンクします。
- 例: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/products
- この例は、作業指示の [商品] タブにリンクします。
- com.salesforce.fieldservice://v1/sObject/<id>/feed
- 該当するすべてのオブジェクト種別の [フィード] タブにリンクします。オブジェクトに [フィード] タブがない場合は、[詳細] タブにリンクします。
- 例: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/feed
- この例は、作業指示の [フィード] タブにリンクします。
- com.salesforce.fieldservice://v1/sObject/<id>/location
- 該当するすべてのオブジェクト種別の [ロケーション] タブにリンクします。オブジェクトに [ロケーション] タブがない場合は、[詳細] タブにリンクします。
- 例: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/location
- この例は、作業指示の [ロケーション] タブにリンクします。
- com.salesforce.fieldservice://v1/sObject/<id>/edit
- 指定した Salesforce レコードの編集ページへのリンク。
- 例: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/edit?Subject=Example%20Subject
- この例は、このレコードの編集ページにリンクし、「Subject」項目に「Example Subject」の値を入力します。
- com.salesforce.fieldservice://v1/sObject/<id>/createservicereport
- 特定の作業指示またはサービス予定についてのサービスレポートが作成されます。<id> 値には、作業指示またはサービス予定のレコードを指定する必要があります。
- 例: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/createservicereport
- この例は、作業指示またはサービス予定についてのサービスレポートを作成します。
- com.salesforce.fieldservice://v1/sObject/<id>/flow/<api_name>
- モバイルアプリケーション内から [Field Service Mobile フロー] を起動します。たとえば、この URL を使用して、カスタムサービスクローズフローを起動できます。この機能を使用するには、アプリケーション拡張からこのフローを参照する必要があります。アプリケーション拡張は、[設定] の [Field Service Mobile 設定] で確認できます。[アプリケーション拡張機能] セクションの拡張にこのフローが含まれていることを確認してください。詳細は、「Field Service モバイルアプリケーションへのフローの接続」を参照してください。URI 内の拡張では URL エンコード化された名前を使用します。
- 例: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/flow/service_response_flow?Subject=Example%20Subject
- この例は、「Subject」入力変数の値である「Example Subject」で渡された「service_response_flow」を起動します。
- com.salesforce.fieldservice://v1/sObject/<id>/quickaction/<api_name>
- モバイルアプリケーション内からクイックアクションを起動します。サポートされるクイックアクションは、レコードの作成、レコードの更新、および Field Service Mobile 拡張機能です。クイックアクションには、次の URL のパラメータを使用して入力を渡すことができます。
- 例: com.salesforce.fieldservice://v1/sObject/0WO5500000001UZGAA/quickaction/close_order
- この例は、「close_order」クイックアクションを起動します。
ディープリンクのパラメータの受け渡し
クイックアクションやフロー URL など、ディープリンクのスキーマでパラメ��タを渡す場合には、次のパラメータを使用できます。
- URL エンコードされたテキストパラメータ。例、Short%20text%20input。
- 数値または通貨。例、1 または 1.45。
- Boolean 値。例、true または false。この値では、大文字と小文字は区別されません。パラメータが渡されていない場合、デフォルトの false になります。
- URL エンコードされた日付および日時パラメータ。例、2019-12-11T17%3A01%3A00.000%2B0000。URL エンコードされたタイムゾーンを含みます (+0000 (GMT)、-0400 (AST) など)。
ディープリンク URI のスキーマでは、これら以外のパラメータはサポートされていません。
複数のパラメータを渡すには、パラメータの間にアンパサンド (&) を使用します (例、firstname=John&lastname=Doe)。
パラメータ数に制限はありません。さらに、各パラメータには最大 100,000 文字を含めることができます。ディープリンクは最大 1 MB のエンコードが可能ですが、これよりも少ないデータ量でエンコードすることをお勧めします。