ติดตามการเดินทางใน Android

เลือกแพลตฟอร์ม Android iOS JavaScript

เมื่อคุณติดตามการเดินทาง แอปสำหรับผู้บริโภคจะแสดงตำแหน่งของ ยานพาหนะที่เหมาะสมให้กับผู้บริโภค โดยแอปของคุณต้องเริ่มต้น ติดตามการเดินทาง อัปเดตความคืบหน้าการเดินทาง และหยุดติดตามการเดินทางเมื่อการเดินทาง เสร็จสมบูรณ์

เอกสารนี้กล่าวถึงวิธีการทำงานของกระบวนการดังกล่าว

ก่อนเริ่มต้น

ตรวจสอบว่าคุณได้ตั้งค่าสิ่งต่อไปนี้แล้ว

• บริการแบ็กเอนด์สำหรับแอปผู้บริโภคพร้อมใช้งานแล้ว และบริการของคุณ ในการจับคู่ผู้บริโภคกับยานพาหนะก็ใช้ได้

• คุณตั้งค่าแผนที่สำหรับแอปแล้ว

เริ่มติดตามการเดินทาง

เมื่อเซิร์ฟเวอร์แบ็กเอนด์ของคุณจับคู่ผู้บริโภคที่มียานพาหนะ ให้ใช้ 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()
  }
}

อัปเดตความคืบหน้าของการเดินทาง

หากต้องการอัปเดตรายละเอียดความคืบหน้าของการเดินทาง เช่น ระยะทางที่ยานพาหนะต้องเดินทางก่อนถึงจุดหมายและเวลาถึงโดยประมาณ แอปของคุณจะต้องลงทะเบียนและกําหนดค่าโปรแกรมฟังตามที่แสดงในตัวอย่างต่อไปนี้

1. ลงทะเบียน 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?,
       ) {
         // ...
       }
   
     // ...
   })
   

2. กำหนดค่าโปรแกรมฟังเสียงสำหรับการเดินทางโดยใช้ 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)
   

หยุดติดตามการเดินทาง

ตรวจสอบว่าแอปของคุณหยุดติดตามการเดินทางเมื่อไม่จำเป็นต้องใช้อีกต่อไป เมื่อคนขับทำเครื่องหมายการเดินทางเป็น COMPLETE ที่แบ็กเอนด์ การหยุดแชร์เส้นทางจะช่วยหลีกเลี่ยงคำขอเครือข่ายที่ไม่จำเป็นไปยัง 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	ไม่มีการตรวจสอบสิทธิ์	คุณจะได้รับข้อผิดพลาดนี้หากไม่มีข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์ที่ถูกต้อง เช่น หากมีการลงนามในโทเค็น JWT โดยไม่มีรหัสการเดินทางหรือโทเค็น JWT หมดอายุ
403	PERMISSION_DENIED	คุณจะได้รับข้อผิดพลาดนี้หากไคลเอ็นต์มีสิทธิ์ไม่เพียงพอ (ตัวอย่างเช่น ผู้ใช้ที่มีบทบาทผู้บริโภคจะพยายามเรียกใช้ updateTrip) หาก โทเค็น JWT ไม่ถูกต้อง หรือ API ไม่ได้เปิดใช้สำหรับโปรเจ็กต์ไคลเอ็นต์ โทเค็น JWT อาจหายไปหรือโทเค็นลงนามด้วยรหัสการเดินทางที่ไม่ตรงกับรหัสการเดินทางที่ขอ
429	RESOURCE_EXHAUSTED	โควต้าทรัพยากรอยู่ที่ 0 หรือปริมาณการเข้าชมเกินขีดจำกัด
503	UNAVAILABLE	ไม่พร้อมให้บริการ โดยทั่วไปแล้ว เซิร์ฟเวอร์ขัดข้อง
504	DEADLINE_EXCEEDED	เกินกำหนดเวลาในการส่งคำขอแล้ว ข้อผิดพลาดนี้จะเกิดขึ้นก็ต่อเมื่อผู้เรียกใช้กำหนดเวลาให้สั้นกว่ากำหนดเวลาเริ่มต้นของเทมเพลต (กล่าวคือ กำหนดเวลาที่ขอไม่เพียงพอสำหรับให้เซิร์ฟเวอร์ประมวลผลคำขอ) และคำขอไม่เสร็จสิ้นภายในกำหนดเวลา

จัดการข้อผิดพลาดของ Consumer SDK

Consumer SDK จะส่งข้อผิดพลาดในการอัปเดตการเดินทางไปยังแอปสำหรับผู้บริโภคโดยใช้ Callback Google Analytics พารามิเตอร์ Callback เป็นประเภทการแสดงผลเฉพาะแพลตฟอร์ม ( 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	แอป Consumer ระบุชื่อการเดินทางไม่ถูกต้อง ชื่อการเดินทางต้อง ใช้รูปแบบ providers/{provider_id}/trips/{trip_id}
NOT_FOUND	ไม่เคยสร้างการเดินทางนี้
PERMISSION_DENIED	แอปสำหรับผู้บริโภคมีสิทธิ์ไม่เพียงพอ ข้อผิดพลาดนี้จะเกิดขึ้นเมื่อ แอป Consumer ไม่มีสิทธิ์ ไม่ได้เปิดใช้ SDK ของผู้บริโภคสำหรับโปรเจ็กต์ใน Google Cloud คอนโซล โทเค็น JWT ขาดหายไปหรือไม่ถูกต้อง โทเค็น JWT ลงชื่อด้วยรหัสการเดินทางที่ไม่ตรงกับการเดินทางที่ขอ
RESOURCE_EXHAUSTED	โควต้าทรัพยากรเป็น 0 หรืออัตราการเข้าชมเกินขีดจำกัดความเร็ว
ไม่มีการตรวจสอบสิทธิ์	คำขอตรวจสอบสิทธิ์ไม่สำเร็จเนื่องจากโทเค็น JWT ไม่ถูกต้อง ช่วงเวลานี้ จะเกิดขึ้นเมื่อโทเค็น JWT ลงนามโดยไม่มีรหัสการเดินทาง หรือ เมื่อโทเค็น JWT หมดอายุ