Survey123 の Web アプリかフィールド アプリへのリンクを使用して、ArcGIS Survey123 を他のアプリと統合できます。Web アプリへのリンクは https://survey123.arcgis.com/share で始まります。 Survey123 リンクかカスタム URL スキーマ リンクをフィールド アプリへのリンクとして使用できます。
Survey123 のリンクは https://survey123.arcgis.app で始まり、iOS と Android でのみ動作します。 Survey123 のリンクは App Store と Google Play で定められている要件に準拠しているため、より多くのアプリにリンクでき、共有しやすい短縮リンクがサポートされています。
カスタム URL スキーマ リンクは arcgis-survey123:// から始まり、Windows、Android、および iOS 上の一部のアプリ グループで動作します。 カスタム URL スキーマ リンクは短縮できず、Android では開きにくい場合があります。 以下のように、ハイパーリンクの形式でカスタム URL スキーマ リンクを提示することを検討してください。
<a href="arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19">Open survey</a>
フィールド アプリで調査を開始するためのパラメーターを含むリンクを使用する前に、あらかじめアプリをデバイスにインストールしておくことをおすすめします。 詳細については、「Survey123 フィールド アプリのインストール」をご参照ください。
フィールド アプリのパラメーター
次のパラメーターを使用して、フィールド アプリの開き方をカスタマイズできます。
| パラメーター | 説明 | 例 | タイプ |
|---|---|---|---|
center | マップを既知の緯度、経度、および高度 (オプション) を中心に配置します。 | center=37.8199,-122.4783,20 | String |
field:fieldname | 調査の質問にフィールド値を入力します。 | field:surname=Klauser | String |
portalUrl | 調査アイテムがホストされているポータルの URL を指定します。 | portalUrl=https://myorg.arcgis.com | String |
itemID | 開くフォームを指定します。 | itemID=36ff9e8c13e042a58cfce4ad87f55d19 | UUID |
download | デバイスがオンラインになったときに調査を自動的にダウンロードします。 デフォルトは、true です。 | download=false | ブール型 |
action | 調査を開く方法を指定します。 サポートされている値は、collect (デフォルト)、edit、view、および copy です。 | action=edit | String |
folder | filter パラメーターを使用する際に、検索するフォルダーを指定します。 サポートされている値は、inbox、drafts、outbox、sent、* (すべてのフォルダー) です。 | folder=drafts | String |
callback | フォーム アクション (送信、ドラフトへの移動、キャンセル、終了など) を実行したときに戻る URL を指定します。 | callback=https://quickcapture.arcgis.app | URL |
callback:status | コールバックがアクティブな場合の調査のステータスを指定します。 ステータスでサポートされている値は、cancel、draft、submit、close です。 close ステータスは、action=view のときのみ使用できます。 | callback:draft=https://quickcapture.arcgis.app | String |
filter | デバイス上の既存の調査で、特定の文字列を検索します。 特定のフィールドの名前を指定すると、そのフィールドでのみ目的の文字列を検索します。 | filter=Klauser | String |
update | [受信トレイ] を更新し、[送信箱] に調査を送信しようとします。 デフォルトは、false です。 | update=false | ブール型 |
q:queryparameter | フィーチャ レイヤーで既存のレコードを検索します。 デバイス上に存在しないコンテンツの取得に使用できます。 | q:where=ws_stationnumber=5171 q:where=waterbodytype='Lake' q:globalId=1d392670-33e2-456d-8435-7fad3abd8bb9 | String |
Web アプリのパラメーター
次のパラメーターを使用して、Web アプリの開き方をカスタマイズできます。
| パラメーター | 説明 | 例 | タイプ |
|---|---|---|---|
center | マップを既知の緯度、経度、および高度 (オプション) を中心に配置します。 | center=37.8199,-122.4783,20 | String |
field:fieldname | 調査の質問にフィールド値を入力します。 | field:surname=Klauser | String |
portalUrl | 調査アイテムがホストされているポータルの URL を指定します。 | portalUrl=https://myorg.arcgis.com | String |
| open | 調査を開くために使用されるアプリを指定します。 有効な値は、Web アプリで調査を開く web (デフォルト)、フィールド アプリがインストールされている場合にフィールド アプリで調査を開く native、Web ページを開いて調査を開くアプリを決定する menu です。 | open=web | String |
| hide |
Web アプリ内の調査のエレメントを非表示にします。 パラメーターは、カンマで区切られた複数の値を受け取ることができます。 有効な値は、navbar (ログイン、ログアウト、言語の変更を行うためのオプションを含んでいる、調査の上部にあるバー)、header、description、footer、submit、theme、および leaveDialog (ページから離れるかページを閉じると表示される警告メッセージ) です。 field:fieldName パラメーターを使用して、fieldName の代わりに名前を指定することによって、特定の質問、グループ、ページ、または繰り返しを非表示にすることもできます。 注意:繰り返し内の質問を個別に非表示にすることはできません。 | hide=header,description,footer,theme | String |
| locale | 調査の言語を切り替えます。 このパラメーターは、調査に複数の言語が含まれている場合にのみ動作します。 | locale=zh-cn | String |
| mode | Web アプリのモードを設定します。有効な値は、エントリを作成するのではなく既存のエントリを編集するように調査を設定する edit、既存のエントリを読み取り専用モードで開く view、および指定したエントリのコンテンツが反映された調査を作成する copy です。 このパラメーターを使用する場合、globalId パラメーターも指定する必要があります。 | mode=edit&globalId=42db492cb06111ea... | String |
| globalId | フォームに読み込まれる調査レコードを指定します。 有効な値は、既存の調査レコードの Global ID です。 このパラメーターの名前では、大文字と小文字が区別されます。 | globalId=42db492cb06111ea... | String |
recalculate | mode=edit でのみ使用できます。 [再計算] ボタンを使用しなくても、調査を読み込むと、所定の質問を強制的に再計算します。 | recalculate=field:question1,field:question2 | String |
| version | 使用される Web アプリのバージョンを設定します。 有効な値は latest のみで、調査でバージョンがロックされている場合でも、最新バージョンの Web アプリを使用します。 | version=latest | String |
| token | 調査の有効なトークンを渡します。 このパラメーターを使用すると、アクセスするのに ArcGIS アカウントが必要な調査に、回答者がサイン インしなくても回答できるようになります。 | token= E60M4Gsc-h4Q8plqQ... | String |
autoReload | 送信後に調査を再読み込みします。 調査が再読み込みされるまでの遅延 (秒単位) を指定します。 以前の名称は autoRefresh でした。 autoRefresh パラメーターは後方互換性のためにサポートされています。 | autoReload=3 | Integer |
| encodeUrlParams | URL パラメーターを隠蔽します。 生成される URL には、エンコードされたすべてのパラメーターを表す code パラメーターが含まれます。この code パラメーター外に含まれるパラメーターは無視されます。 | encodeUrlParams=true | ブール型 |
width | 調査の幅をピクセル単位で設定します。 これは、調査内の他のコントロール (テキスト ボックスなど) にも影響します。 | width=1000 | Integer |
注意:
field:fieldname パラメーターは、Web アプリのジオポイント、ジオトレース、ジオシェープの質問をサポートしています。 ジオポイントの質問の場合、緯度、経度、高度 (任意) をスペース区切りで指定します。 ジオトレースとジオシェープの場合は、個々の頂点に対してスペース区切りで緯度と経度を指定します。座標値のペアはセミコロン区切りを使用します。 ジオシェープの質問の例を示します。
field:geoshape=-37.842156723211474 144.95942945338243;-37.83554486071995 144.9726235713864;-37.85681405373047 144.98240735651922;-37.85954045531896 144.97715349053766
デスクトップ Web ブラウザーから Survey123 へのリンク
フィールド アプリを開くためのリンクを作成し、それを別のアプリに埋め込むことができます。 同じリンクをテスト用の Web ブラウザーに入力することもできます。
注意:
リンクを作成したら、iOS または Android で使用する Survey123 のリンクとして arcgis-survey123:// を https://survey123.arcgis.app に置き換えることができます。
次の手順は、カスタム URL スキーマを作成する方法と、それをデスクトップ Web ブラウザーで使用する方法について説明しています。
- お使いのブラウザーで arcgis-survey123:// と入力します。Survey123 フィールド アプリが開きます (または開くかどうか確認されます)。
注意:
特定のポータルから調査を起動してダウンロードするには、ポータルの URL パラメーターを含めます。たとえば、「arcgis-survey123://?portalUrl=host.domain.com/webadaptor」とします (ここで、host、domain、webadaptor は実際のポータル情報で置き換えられます)。
- 構築する URL に調査を含めるには、?itemID= とフォームのアイテム ID を URL に追加します。URL は次のようになります。
arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19URL をテストすると、Survey123 フィールド アプリが開き、調査がすぐに開きます。
注意:
調査がデバイス上に存在しない場合は、デバイスにダウンロードされます。
- XLSForm で関連付けられた名前 (ラベルではない) を使用して、URL にフィールドへの参照を含めます。 たとえば、Surname フィールドを設定するには、「&field:Surname=」と入力し、値を入力します。
& はパラメーターの区切り文字として機能し、field: は設定する質問名を指します。
URL は次のようになります。arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauserこの URL を使用して調査を Survey123 フィールド アプリで開くことができるようになり、指定した質問に定義した回答が表示されます。 1 つの調査 URL に複数の質問を設定できます。 フィールド名では大文字と小文字が区別されます。
- 「¢er=」と入力して、座標を入力します。 緯度と経度の座標を 10 進角度で入力します (1 つのカンマで区切ります)。 必要に応じて、高度を 10 進メートルで 3 番目の値として追加します (1 つのカンマで区切ります)。
URL は次のようになります。
arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauser¢er=37.8199,-122.4783,20この URL では、Survey123 フィールド アプリと選択した調査が開き、テキストの質問が設定され、ジオポイントの質問に対する新しいデフォルトの場所が提供されます。
- Web マップ内の既存のレイヤーで [ポップアップの構成] を選択します。 表示ドロップダウン メニューで、[属性表示のカスタム設定] を選択し、[構成] をクリックして、調査にリンクを挿入します。
この URL では、設定値ではなく、選択したフィーチャの name 属性の内容を使用して、surname フィールドを設定しています。
arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname={name}この URL では、選択した給水栓のグローバル ID を使用して、hydrantGlobalID フィールドを設定しています。
arcgis-survey123://?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:hydrantGlobalID={globalid}
調査に対する一意の参照を追加し、それを URL に追加することもできます。 最初に、開く必要がある調査のアイテム ID を識別します。 これは ArcGIS Online が調査を一意に識別するための文字列で、ArcGIS Online のフォーム アイテムの URL 内にあります。 たとえば、調査の URL が https://exampleurl.maps.arcgis.com/home/item.html?id=36ff9e8c13e042a58cfce4ad87f55d19 の場合、フォームのアイテム ID は 36ff9e8c13e042a58cfce4ad87f55d19 になります。
注意:
デフォルトでは、対応する選択肢の名前とラベルが同じ場合にのみ、Web マップのポップアップから単一の選択肢の質問と複数の選択肢の質問に値を渡すことができます。 選択肢リストの名前とラベルが異なる場合は、ポップアップの ArcGIS Arcade 式で DomainCode 関数または UrlEncode 関数を使用して、目的の値を渡すことができます。
繰り返し内の質問は設定できません。
別のアプリから Survey123 へのリンク
ArcGIS アプリで使用するためのリンクを作成し、Survey123 を開いて、調査を取得できます。 次の手順は、Survey123 リンクを作成する方法と、それを Web マップのポップアップで使用する方法について説明しています。 このリンクは、ArcGIS 組織内で Web マップのポップアップに入力されます。 iOS または Android デバイス上で (上記のセクションと同じ手順を使用して) Web ブラウザーを使用して、リンクをテストすることもできます。
- デバイス上に表示される Web マップ内の既存のレイヤーで [ポップアップの構成] を選択します。
- 表示ドロップダウン メニューで、[属性表示のカスタム設定] を選択してから [構成] をクリックして、プロジェクトにリンクを挿入します。
- [URL] に「https://survey123.arcgis.app」、[リンク テキスト] に「Launch Survey123」と入力します。 [OK] をクリックします。
- モバイル デバイスでブラウザーまたは ArcGIS アプリから Web マップを開きます。
- フィーチャを選択し、ポップアップ内の [Launch Survey123] リンクをクリックして、Survey123 を開きます。
- 構築する URL に調査を含めるには、?itemID= とフォームのアイテム ID を URL に追加します。 URL は次のようになります。
https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19URL をテストすると、Survey123 フィールド アプリが開き、調査がすぐに開きます。
注意:
調査がデバイス上に存在しない場合は、デバイスにダウンロードされます。
- XLSForm で関連付けられた名前 (ラベルではない) を使用して、URL にフィールドへの参照を含めます。 たとえば、Surname フィールドを設定するには、「&field:Surname=」と入力し、値を入力します。
& はパラメーターの区切り文字として機能し、field: は設定する質問名を指します。
URL は次のようになります。https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauserこの URL を使用して、調査を Survey123 フィールド アプリで開き、指定した質問に定義した回答が表示されます。 1 つの調査 URL に複数の質問を設定できます。 フィールド名では大文字と小文字が区別されます。
- 「¢er=」と入力して、座標を入力します。 緯度と経度の座標を 10 進角度で入力します (1 つのカンマで区切ります)。 必要に応じて、高度を 10 進メートルで 3 番目の値として追加します (1 つのカンマで区切ります)。
最終的に、URL は次のようになります。
https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&field:surname=Klauser¢er=37.8199,-122.4783,20この完成した URL では、Survey123 フィールド アプリと選択した調査が開き、テキストの質問が設定され、ジオポイントの質問に対する新しいデフォルトの場所が提供されます。
Web アプリにパラメーターを渡す Survey123
Survey123 Web アプリは、フィールド アプリと同じ形式のパラメーターを使用できます。 唯一の違いは、調査のアイテム ID を最初のパラメーターと区切るために、アンパサンドではなく疑問符を使用する必要があることです (アンパサンドはパラメーターを区切るために引き続き使用されます)。 次の URL の例では、姓と座標のパラメーターを Survey123 Web アプリの調査に渡しています。
https://survey123.arcgis.com/share/36ff9e8c13e042a58cfce4ad87f55d19?field:surname=Klauser¢er=37.8199,-122.4783Survey123 Web アプリは、Survey123 フィールド アプリがサポートしていない複数のパラメーターもサポートします。 それらのパラメーターは、ブラウザー内の調査のプレゼンテーションに関連しています。
注意:
パラメーター値にスペース、プラス記号 (+) またはその他の特殊文字が含まれる場合は、これらの文字はパーセントでエンコードされる必要があります。 詳細については、「URL パラメーターのエンコード」をご参照ください。
Survey123 Connect にパラメーターを渡す
Survey123 Connect で使用されている URL スキーマは arcgis-survey123connect:// です。この URL スキーマを使用すると、ユーザーは調査を自動的にダウンロードして開き、編集の準備をすることができます。
この URL スキーマでは、フィールド アプリや Web アプリとは別のパラメーターを使用してもかまいません。フォームのアイテム ID とそのアイテムが保存されているポータルの URL を使用することもできます。 次のサンプル URL を使用すると、提供された ArcGIS Enterprise ポータルから特定の調査が Survey123 Connect で開きます。まだ存在しない場合は、その調査がダウンロードされます。arcgis-survey123connect://?portalUrl=https://exampleportal.esri.com/arcgis&itemID=36ff9e8c13e042a58cfce4ad87f55d19
調査が ArcGIS Online に保存されている場合は、次のように ArcGIS Online のポータル URL も指定する必要があります。
arcgis-survey123connect://?portalUrl=https://www.arcgis.com&itemID=36ff9e8c13e042a58cfce4ad87f55d19注意:
これらの URL パラメーターを使用すると、自分が所有するフォームを開くことしかできません。 これらの URL を使用しても、アクセス権はあるが自分で作成していない調査を開くことはできません。
Survey123 から他のアプリへのリンク
多くのアプリはリンクから開くことができます。 他のアプリを開く URL を作成して、自分の調査に挿入できます。 これらのアプリでは、Survey123 と同じ方法で URL にカスタム パラメーターも使えます。
最初に、URL を含むラベルとともに、メモの質問を調査に追加する必要があります。
注意:
iOS デバイスでは、HTTP および HTTPS 以外の URL スキーマをアプリ内のスキーマの承認済みリストに追加する必要があります。 Survey123 では、以下の URL スキームが承認されています。
- arcgis-appstudio-player
- arcgis-quickcapture
- Windows の arcgis-collector ArcGIS Collector のみ
- arcgis-trek2there
- arcgis-navigator
- arcgis-workforce Workforce for ArcGIS (Classic) のみ
- comgooglemaps
- foreflightmobile
- waze
- spike-partner
Field Maps と Workforce の最新バージョンにリンクするには、HTTP または HTTPS で始まるアプリ リンクを使用する必要があります。
Survey123 から開くことのできる一般的な Esri アプリの詳細については、以下をご参照ください。
URL パラメーターのエンコード
一部の環境ではエンコードされていない URL パラメーターでも動作しますが、URL パラメーターはエンコードすることをお勧めします。 エンコーディングでは、無効な文字が、パーセント記号 (%) およびそれらの文字の 16 進数表記に置き換えられます。
次の例は、コールバックを使用し、QuickCapture でエンコードされていないパラメーターを使用して特定のプロジェクトに戻る Survey123 リンクを示しています。
https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&callback=https://quickcapture.arcgis.app?itemID=867895a71a1840399476fc717e76bb43以下は、同じ URL のパラメーターをエンコードしたものです。
https://survey123.arcgis.app?itemID=36ff9e8c13e042a58cfce4ad87f55d19&callback=https%3A%2F%2Fquickcapture.arcgis.app%3FitemID=867895a71a1840399476fc717e76bb43キーとその値の間の区切りを指定する等号は、エンコードしてはなりません。
エンコードされたパラメーターを作成する方法の 1 つは、ArcGIS Arcade を使用することです。 UrlEncode 関数では、各パラメーターを表すキー値ペアのコレクションを定義して、適切なエンコードを行った URL を作成できます。
調査の作成者は、URL に機密データが表示されないよう URL パラメーターを隠蔽することもできます。 この場合、Web アプリで使用する URL を作成する際に、encodeUrlParams=true を含めるようにしてください。 詳細については、「Web アプリのパラメーター」をご参照ください。