ルート要素の<route_request>
には、複数の属性があります(そのほとんどはオプションです)。これらの属性は次のように定義されます。
vendor
はオプションの属性です。デフォルト値の場合は、Oracleがルーティング・プロバイダになります。
id
は必須属性で、リクエストに関連付けるID番号を指定します。
route_preference
はオプションの属性で、予想運転時間が最短のルート(FASTEST
)と、運転距離が最短のルート(SHORTEST
、デフォルト)のどちらを希望するのかを示します。
road_preference
はオプションの属性で、高速道路を優先するルーティング・プロセス(HIGHWAY
、デフォルト)と、地方道路(LOCAL
)を優先するルーティング・プロセスを可能にします。
return_driving_directions
はオプションの属性で、ルートの運転方向を戻すかどうかを指定します。TRUE
を指定すると運転方向が戻され、FALSE
(デフォルト)を指定すると運転方向は戻されません。
return_hierarchical_driving_directions
はオプションの属性で、開いたり閉じたりすることができる階層でルートの運転方向を戻すかどうかを指定します。TRUE
を指定すると運転方向が開いたり閉じたりすることができる階層で戻され、FALSE
(デフォルト)を指定すると運転方向が階層なしのリストで戻されます。
return_locations
はオプションの属性で、ルート内のすべての場所のジオコード情報を戻すかどうかを指定します。TRUE
はジオコード情報を戻し、FALSE
(デフォルト)は戻しません。
return_subroutes
はオプションの属性で、マルチアドレス・ルートのサブルートを戻すかどうかを指定します。TRUE
(マルチアドレス・ルートの場合はデフォルト)を指定するとサブルートが戻され、FALSE
を指定するとサブルートは戻されません。(単純ルートの場合、この属性は無視されます。)
return_route_geometry
はオプションの属性で、ルートを表す線ストリングの座標を戻すかどうかを示します。TRUE
を指定すると座標が戻され、FALSE
(デフォルト)を指定すると座標は戻されません。
return_subroute_geometry
はオプションの属性で、ルート内のサブルートを表す線ストリングの座標を戻すかどうかを示します。TRUE
を指定すると座標が戻され、FALSE
(マルチアドレス・ルートの場合はデフォルト)を指定すると座標は戻されません。(単純ルートの場合、この属性は無視されます。)
return_segment_geometry
はオプションの属性で、ルートのマヌーバを表す線ストリングの座標を戻すかどうかを示します。TRUE
を指定すると座標が戻され、FALSE
(デフォルト)を指定すると座標は戻されません。return_segment_geometry
がTRUE
の場合、return_driving_directions
属性の値に関係なく、ルートの運転方向が戻されます。
return_detailed_geometry
はオプションの属性で、戻されるジオメトリに含まれる詳細のレベルを示します。TRUE
(デフォルト)は詳細なジオメトリを戻し、FALSE
は総合的な(通常は座標の少ない)ジオメトリを戻します。
return_route_edge_ids
はオプションの属性で、ルートのエッジのエッジID値を戻すかどうかを指定します。TRUE
を指定するとエッジID値が戻され、FALSE
(デフォルト)を指定するとエッジID値は戻されません。
return_subroute_edge_ids
はオプションの属性で、サブルートのエッジのエッジID値を戻すかどうかを指定します。TRUE
を指定するとエッジID値が戻され、FALSE
(マルチアドレス・ルートの場合はデフォルト)を指定するとエッジID値は戻されません。(単純ルートの場合、この属性は無視されます。)
return_segment_edge_ids
はオプションの属性で、ルートのすべてのマヌーバのエッジについてエッジID値を戻すかどうかを指定します。TRUE
を指定するとエッジID値が戻され、FALSE
(デフォルト)を指定するとエッジID値は戻されません。return_segment_edge_ids
がTRUE
の場合、return_driving_directions
属性の値に関係なく、ルートの運転方向が戻されます。
language
はオプションの属性で、運転方向の生成に使用するデフォルトの言語を上書きします。デフォルトの言語はweb.xml
ファイルで設定されており、この属性を使用してリクエストごとにデフォルトを上書きできます。サポートされている属性値は、ENGLISH
、FRENCH
、GERMAN
、ITALIAN
およびSPANISH
です。
distance_unit
はオプションの属性で、戻される距離の値の測定単位を指定します。有効な値は、KILOMETER
またはKM
(キロメートル)、MILE
(マイル、デフォルト)およびMETER
(メートル)です。
length_unit
はオプションの属性で、長さ値の入力に使用する長さ測定法を指定します。有効な値は、US
(フィート、デフォルト)またはMETRIC
(メートル)です。この属性は、トラックの高さ、長さ、幅の指定に使用されます。
time_unit
はオプションの属性で、戻される時間値の単位を示します。有効な値は、HOUR
(時間)、MINUTE
(分、デフォルト)およびSECOND
(秒)です。
weight_unit
はオプションの属性で、重量値の入力に使用する重量測定法を指定します。有効な値は、US
(トン、デフォルト)またはMETRIC
(メートル・トン)です。この属性は、トラックの重量の指定に使用されます。
pre_geocoded_locations
はオプションの属性で、場所の指定方法を示します。TRUE
は、両方の場所が、<pre_geocoded_location>
要素を使用してジオコード済の場所として指定されることを示します。FALSE
(デフォルト)は、両方の場所が、<input_location>
要素を使用して住所または経度/緯度のペアとして指定されることを示します。
driving_directions_detail
はオプションの属性で、運転の案内における詳細レベルと個別のステップの数に影響を与えます。指定可能な値は、HIGH
(最も詳細でステップ数が最も多い)、MEDIUM
(デフォルト)およびLOW
(最も大まかでステップ数が最も少ない)です。たとえば、LOW
を指定すると、セグメントに右または左へのわずかなマヌーバが含まれている場合でも、1つのセグメントが1つのステップとして処理される場合があります。戻される運転方向の長さに対してこの属性の値が与える影響は、要素の正確な名前とマヌーバによって異なります。return_driving_directions
またはreturn_hierarchical_driving_directions
に対してTRUE
を指定しない場合、この属性は無視されます。
optimize_route
はオプションの属性で、マルチアドレス・ルート・リクエストがその非固定の場所を並べ替えて全体的なルートを最適化する必要があるかどうかを指定します。TRUE
は場所を並べ替えて全体的なルートを最適化し(巡回セールスマン)、FALSE
(デフォルト)は場所を並べ替えません(マルチアドレス)。マルチアドレス・リクエストは最適化されないため、すべての場所はリクエストで指定された順序で戻されます。マルチアドレスおよびTSPの開いた行程リクエストでは、START_LOCATIONおよびEND_LOCATIONはオプションです。これらが指定されている場合、これらは固定の場所であり、TSPリクエストで並替えの対象にはなりません。マルチアドレスおよびTSPリクエストでは、1つ以上の中間地(LOCATION)を指定する必要があり、これらは非固定の場所で、TSPリクエストで並替えの対象になります。
route_type
はオプションの属性で、マルチアドレス・ルートがOPEN
(デフォルト)行程とCLOSED
行程のどちらであるかを指定します。開いた行程は、START_LOCATIONまたは最初のLOCATIONからEND_LOCATIONまたは最後のLOCATIONまでのルートです。閉じた行程では、START_LOCATIONが必須で、出発地および目的地の両方として使用されます。閉じた行程に対してEND_LOCATIONが指定されている場合は、例外が発生します。
vehicle_type
はオプションの属性で、車両のタイプがAUTO
(デフォルト)とTRUCK
のどちらであるかを指定します。トラックの場合は説明サブ属性が使用され、車両タイプはTRUCK
に設定されている必要があります。車両タイプがAUTO
の場合、これらのサブ属性は無視されます。
truck_type
はオプションの属性で、TRUCK
に設定されたvehicle_type
のサブ属性です。この属性は、具体的なトラック・タイプを説明し、より一般的なトラック・ルールをオーバーライドできます。サポートされている属性値は、DELIVERY
、PUBLIC
、RESIDENT
およびTRAILER
です。DELIVERY
、PUBLIC
およびRESIDENT
トラック・タイプは、これらのタイプのトラックのトラック・ルールに例外を提供します。ごみ収集トラックおよび公共事業トラックはPUBLIC
トラックの例です。RESIDENT
トラック・タイプは、地元のトラックを説明します。TRAILER
トラック・タイプは、セミトレーラー・トラックが対象となり、他のトラックは対象とならない追加の制限を説明します。
truck_height
はオプションの属性で、TRUCK
に設定されたvehicle_type
のサブ属性です。この属性では、length_units
でのトラックの高さを浮動小数点数として指定します。この高さは、ルートの一部とみなされているエッジ上に存在する可能性のある高さ制限に対してチェックするために使用されます。
truck_length
はオプションの属性で、TRUCK
に設定されたvehicle_type
のサブ属性です。この属性では、length_units
でのトラックの長さを浮動小数点数として指定します。この長さは、ルートの一部とみなされているエッジ上に存在する可能性のある長さ制限に対してチェックするために使用されます。
truck_per_axle_weight
はオプションの属性で、TRUCK
に設定されたvehicle_type
のサブ属性です。この属性では、weight_units
でのトラックの車軸単位の重量を浮動小数点数として指定します。この重量は、ルートの一部とみなされているエッジ上に存在する可能性のある車軸当たりの重量制限に対してチェックするために使用されます。
truck_weight
はオプションの属性で、TRUCK
に設定されたvehicle_type
のサブ属性です。この属性では、weight_units
でのトラックの重量を浮動小数点数として指定します。この重量は、ルートの一部とみなされているエッジ上に存在する可能性のある重量制限に対してチェックするために使用されます。
truck_width
はオプションの属性で、TRUCK
に設定されたvehicle_type
のサブ属性です。この属性では、length_units
でのトラックの幅を浮動小数点数として指定します。この幅は、ルートの一部とみなされているエッジ上に存在する可能性のある幅制限に対してチェックするために使用されます。