เมื่อคุณติดตามการเดินทาง แอปสำหรับผู้บริโภคจะแสดงตำแหน่งของยานพาหนะที่เหมาะกับผู้บริโภค ซึ่งแอปของคุณต้องเริ่มติดตามการเดินทาง อัปเดตความคืบหน้าของการเดินทาง และหยุดติดตามการเดินทางเมื่อการเดินทางเสร็จสมบูรณ์
เอกสารนี้จะอธิบายกระบวนการดังกล่าว
ก่อนเริ่มต้น
ตรวจสอบว่าคุณได้ตั้งค่าสิ่งต่อไปนี้แล้ว
บริการแบ็กเอนด์สําหรับแอปผู้บริโภคพร้อมใช้งานแล้ว และบริการของคุณสําหรับการจับคู่ผู้บริโภคกับยานพาหนะทํางานได้
คุณได้ตั้งค่าแผนที่สําหรับแอปแล้ว
เริ่มติดตามการเดินทาง
เมื่อเซิร์ฟเวอร์แบ็กเอนด์จับคู่ผู้บริโภคกับยานพาหนะแล้ว ให้ใช้ JourneySharingSession
เพื่อเริ่มติดตามการเดินทาง
โค้ดตัวอย่างต่อไปนี้แสดงวิธีเริ่มติดตามการเดินทางหลังจากที่โหลดมุมมองแล้ว
Java
public class MainActivity extends AppCompatActivity
implements ConsumerViewModel.JourneySharingListener {
// Class implementation
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// Create a TripModel instance to listen for updates to the trip specified by this trip name.
String tripName = ...;
TripModelManager tripModelManager = consumerApi.getTripModelManager();
TripModel tripModel = tripModelManager.getTripModel(tripName);
// Create a JourneySharingSession instance based on the TripModel.
JourneySharingSession session = JourneySharingSession.createInstance(tripModel);
// Add the JourneySharingSession instance on the map for updating the UI.
consumerController.showSession(session);
// Register for trip update events.
tripModel.registerTripCallback(new TripModelCallback() {
@Override
public void onTripETAToNextWaypointUpdated(
TripInfo tripInfo, @Nullable Long timestampMillis) {
// ...
}
@Override
public void onTripActiveRouteRemainingDistanceUpdated(
TripInfo tripInfo, @Nullable Integer distanceMeters) {
// ...
}
// ...
});
}
@Override
protected void onDestroy() {
super.onDestroy();
if (journeySharingSession != null) {
journeySharingSession.stop();
}
}
}
Kotlin
class SampleAppActivity : AppCompatActivity(), ConsumerViewModel.JourneySharingListener {
// Class implementation
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Create a TripModel instance to listen for updates to the trip specified by this trip name.
val tripName = "tripName"
val tripModelManager = consumerApi.getTripModelManager()
val tripModel = tripModelManager.getTripModel(tripName)
// Create a JourneySharingSession instance based on the TripModel.
val session = JourneySharingSession.createInstance(tripModel)
// Add the JourneySharingSession instance on the map for updating the UI.
consumerController.showSession(session)
// Register for trip update events.
tripModel.registerTripCallback(
object : TripModelCallback() {
override fun onTripETAToNextWaypointUpdated(
tripInfo: TripInfo,
timestampMillis: Long?,
) {
// ...
}
override fun onTripActiveRouteRemainingDistanceUpdated(
tripInfo: TripInfo,
distanceMeters: Int?,
) {
// ...
}
// ...
})
}
override fun onDestroy() {
super.onDestroy()
journeySharingSession?.stop()
}
}
อัปเดตความคืบหน้าของการเดินทาง
หากต้องการอัปเดตรายละเอียดความคืบหน้าของการเดินทาง เช่น ระยะทางที่ยานพาหนะต้องเดินทางก่อนถึงจุดหมายและเวลาถึงโดยประมาณ แอปของคุณจะต้องลงทะเบียนและกำหนดค่า Listener ตามที่แสดงในตัวอย่างต่อไปนี้
ลงทะเบียน Listener บนออบเจ็กต์
TripModel
Java
// Create a TripModel instance for listening to updates to the trip specified by this trip name. String tripName = ...; TripModelManager tripModelManager = consumerApi.getTripModelManager(); TripModel tripModel = tripModelManager.getTripModel(tripName); // Create a JourneySharingSession instance based on the TripModel. JourneySharingSession session = JourneySharingSession.createInstance(tripModel); // Add the JourneySharingSession instance on the map for updating the UI. consumerController.showSession(session); // Register for trip update events. tripModel.registerTripCallback(new TripModelCallback() { @Override public void onTripETAToNextWaypointUpdated( TripInfo tripInfo, @Nullable Long timestampMillis) { // ... } @Override public void onTripActiveRouteRemainingDistanceUpdated( TripInfo tripInfo, @Nullable Integer distanceMeters) { // ... } // ... });
Kotlin
// Create a TripModel instance for listening to updates to the trip specified by this trip name. val tripName = "tripName" val tripModelManager = consumerApi.getTripModelManager() val tripModel = tripModelManager.getTripModel(tripName) // Create a JourneySharingSession instance based on the TripModel. val session = JourneySharingSession.createInstance(tripModel) // Add the JourneySharingSession instance on the map for updating the UI. consumerController.showSession(session) // Register for trip update events. tripModel.registerTripCallback( object : TripModelCallback() { override fun onTripETAToNextWaypointUpdated( tripInfo: TripInfo, timestampMillis: Long?, ) { // ... } override fun onTripActiveRouteRemainingDistanceUpdated( tripInfo: TripInfo, distanceMeters: Int?, ) { // ... } // ... })
กำหนดค่าโปรแกรมฟังเสียงสำหรับการเดินทางโดยใช้
TripModelOptions
Java
// Set refresh interval to 2 seconds. TripModelOptions tripOptions = TripModelOptions.builder().setRefreshIntervalMillis(2000).build(); tripModel.setTripModelOptions(tripOptions);
Kotlin
// Set refresh interval to 2 seconds. val tripOptions = TripModelOptions.builder().setRefreshIntervalMillis(2000).build() tripModel.setTripModelOptions(tripOptions)
หยุดติดตามการเดินทาง
ตรวจสอบว่าแอปของคุณหยุดติดตามการเดินทางเมื่อไม่จําเป็นต้องใช้อีกต่อไป เช่น เมื่อคนขับทําเครื่องหมายการเดินทางว่า "เสร็จสมบูรณ์" ในแบ็กเอนด์ การหยุดแชร์เส้นทางจะช่วยหลีกเลี่ยงคำขอเครือข่ายที่ไม่จำเป็นไปยัง Fleet Engine และป้องกันการรั่วไหลของหน่วยความจำ
ใช้ JourneySharingSession
เพื่อหยุดติดตามการเดินทางตามที่แสดงในตัวอย่างโค้ดต่อไปนี้
Java
public class MainActivity extends AppCompatActivity
implements ConsumerViewModel.JourneySharingListener {
// Class implementation
@Override
protected void onDestroy() {
super.onDestroy();
if (journeySharingSession != null) {
journeySharingSession.stop();
}
}
}
Kotlin
class SampleAppActivity : AppCompatActivity(), ConsumerViewModel.JourneySharingListener {
// Class implementation
override fun onDestroy() {
super.onDestroy()
journeySharingSession?.stop()
}
}
จัดการข้อผิดพลาดเกี่ยวกับการเดินทาง
เมธอด onTripRefreshError
จะแสดงข้อผิดพลาดที่เกิดขึ้นระหว่างการตรวจสอบการเดินทาง ข้อความแสดงข้อผิดพลาดเป็นไปตามมาตรฐานข้อผิดพลาดของ Google Cloud ดูคำจำกัดความของข้อความแสดงข้อผิดพลาดและรหัสข้อผิดพลาดทั้งหมดอย่างละเอียดได้ที่เอกสารประกอบเกี่ยวกับข้อผิดพลาดของ Google Cloud
ข้อผิดพลาดที่พบบ่อยซึ่งอาจเกิดขึ้นระหว่างการตรวจสอบการเดินทางมีดังนี้
HTTP | RPC | คำอธิบาย |
---|---|---|
400 | INVALID_ARGUMENT | ไคลเอ็นต์ระบุชื่อการเดินทางไม่ถูกต้อง ชื่อการเดินทางต้องเป็นไปตามรูปแบบ providers/{provider_id}/trips/{trip_id} provider_id ต้องเป็นรหัสของโปรเจ็กต์ที่อยู่ในระบบคลาวด์ซึ่งผู้ให้บริการเป็นเจ้าของ |
401 | UNAUTHENTICATED | คุณจะได้รับข้อผิดพลาดนี้หากไม่มีข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์ที่ถูกต้อง เช่น หากมีการลงนามในโทเค็น JWT โดยไม่มีรหัสการเดินทางหรือโทเค็น JWT หมดอายุ |
403 | PERMISSION_DENIED | คุณจะได้รับข้อผิดพลาดนี้หากไคลเอ็นต์ไม่มีสิทธิ์เพียงพอ (เช่น ผู้ใช้ที่มีบทบาทผู้บริโภคพยายามเรียกใช้ updateTrip) หากโทเค็น JWT ไม่ถูกต้อง หรือไม่ได้เปิดใช้ API สําหรับโปรเจ็กต์ไคลเอ็นต์ โทเค็น JWT อาจหายไปหรือมีการลงนามในโทเค็นด้วยรหัสการเดินทางที่ไม่ตรงกับรหัสการเดินทางที่ขอ |
429 | RESOURCE_EXHAUSTED | โควต้าทรัพยากรเป็น 0 หรืออัตราการเข้าชมเกินขีดจํากัด |
503 | UNAVAILABLE | ไม่พร้อมให้บริการ โดยทั่วไปแล้ว เซิร์ฟเวอร์จะหยุดทำงาน |
504 | DEADLINE_EXCEEDED | เกินกำหนดเวลาในการส่งคำขอแล้ว ข้อผิดพลาดนี้จะเกิดขึ้นก็ต่อเมื่อผู้เรียกใช้กำหนดเวลาให้สั้นกว่ากำหนดเวลาเริ่มต้นของเทมเพลต (กล่าวคือ กำหนดเวลาที่ขอไม่เพียงพอสำหรับให้เซิร์ฟเวอร์ประมวลผลคำขอ) และคำขอไม่เสร็จสิ้นภายในกำหนดเวลา |
จัดการข้อผิดพลาดของ Consumer SDK
Consumer SDK จะส่งข้อผิดพลาดในการอัปเดตการเดินทางไปยังแอปของผู้บริโภคโดยใช้กลไกการเรียกกลับ พารามิเตอร์การเรียกกลับคือประเภทผลลัพธ์เฉพาะแพลตฟอร์ม (
TripUpdateError
ใน Android และ
NSError
ใน iOS)
ดึงรหัสสถานะ
โดยปกติแล้ว ข้อผิดพลาดที่ส่งไปยังการเรียกกลับจะเป็นข้อผิดพลาด gRPC และคุณยังดึงข้อมูลเพิ่มเติมจากข้อผิดพลาดเหล่านั้นในรูปแบบรหัสสถานะได้ด้วย ดูรายการรหัสสถานะทั้งหมดได้ที่รหัสสถานะและการใช้งานใน gRPC
Java
คุณสามารถดึงรหัสสถานะ gRPC ที่แสดงรายละเอียดเกี่ยวกับข้อผิดพลาดจาก TripUpdateError
ที่แสดงผลจาก onTripUpdateError()
// Called when there is a trip update error.
@Override
public void onTripUpdateError(TripInfo tripInfo, TripUpdateError error) {
Status.Code code = error.getStatusCode();
}
Kotlin
คุณสามารถดึงรหัสสถานะ gRPC ที่แสดงรายละเอียดเกี่ยวกับข้อผิดพลาดจาก TripUpdateError
ที่แสดงผลจาก onTripUpdateError()
// Called when there is a trip update error.
override fun onTripUpdateError(tripInfo: TripInfo, error: TripUpdateError) {
val code = error.getStatusCode()
}
ตีความรหัสสถานะ
รหัสสถานะครอบคลุมข้อผิดพลาด 2 ประเภท ได้แก่ ข้อผิดพลาดเกี่ยวกับเซิร์ฟเวอร์และเครือข่าย รวมถึงข้อผิดพลาดฝั่งไคลเอ็นต์
ข้อผิดพลาดเกี่ยวกับเซิร์ฟเวอร์และเครือข่าย
รหัสสถานะต่อไปนี้แสดงข้อผิดพลาดเกี่ยวกับเครือข่ายหรือเซิร์ฟเวอร์ และคุณไม่จำเป็นต้องดำเนินการใดๆ เพื่อแก้ไข Consumer SDK จะกู้คืนจากข้อผิดพลาดเหล่านี้โดยอัตโนมัติ
รหัสสถานะ | คำอธิบาย |
---|---|
ยกเลิก | เซิร์ฟเวอร์หยุดส่งการตอบกลับ ซึ่งมักเกิดจากปัญหาเซิร์ฟเวอร์ |
ยกเลิกแล้ว | เซิร์ฟเวอร์สิ้นสุดการตอบกลับขาออก ซึ่งมักเกิดขึ้นเมื่อระบบส่งแอปไปทำงานเบื้องหลัง หรือเมื่อมีการเปลี่ยนแปลงสถานะในแอปสำหรับผู้บริโภค |
ขัดจังหวะ | |
DEADLINE_EXCEEDED | เซิร์ฟเวอร์ใช้เวลาตอบสนองนานเกินไป |
UNAVAILABLE | เซิร์ฟเวอร์ไม่พร้อมใช้งาน ซึ่งมักเกิดจากปัญหาเกี่ยวกับเครือข่าย |
ข้อผิดพลาดของไคลเอ็นต์
รหัสสถานะต่อไปนี้เป็นรหัสข้อผิดพลาดของไคลเอ็นต์ และคุณต้องดำเนินการเพื่อแก้ไข Consumer SDK จะพยายามรีเฟรชการเดินทางต่อไปจนกว่าคุณจะสิ้นสุดการแชร์การเดินทาง แต่การเดินทางจะไม่กู้คืนจนกว่าคุณจะดำเนินการ
รหัสสถานะ | คำอธิบาย |
---|---|
INVALID_ARGUMENT | แอปสำหรับผู้บริโภคระบุชื่อการเดินทางที่ไม่ถูกต้อง ชื่อการเดินทางต้องเป็นไปตามรูปแบบ providers/{provider_id}/trips/{trip_id}
|
NOT_FOUND | ไม่มีการสร้างขึ้น |
PERMISSION_DENIED | แอปสำหรับผู้บริโภคมีสิทธิ์ไม่เพียงพอ ข้อผิดพลาดนี้จะเกิดขึ้นเมื่อ
|
RESOURCE_EXHAUSTED | โควต้าทรัพยากรเป็น 0 หรืออัตราการเข้าชมเกินขีดจำกัดความเร็ว |
UNAUTHENTICATED | คำขอตรวจสอบสิทธิ์ไม่สำเร็จเนื่องจากโทเค็น JWT ไม่ถูกต้อง ข้อผิดพลาดนี้เกิดขึ้นเมื่อมีการเซ็นชื่อโทเค็น JWT โดยไม่ระบุรหัสการเดินทาง หรือเมื่อโทเค็น JWT หมดอายุ |