REST Resource: projects.trips

แหล่งข้อมูล: การเดินทาง

การเดินทาง

การแสดง JSON 
{
  "name": string,
  "config": {
    object (TripConfig)
  },
  "androidAppId": string,
  "iosAppId": string,
  "authToken": {
    object (AuthToken)
  },
  "state": enum (State),
  "execution": {
    object (TripExecution)
  },
  "createTime": string,
  "updateTime": string
}
ช่อง
name

string

เอาต์พุตเท่านั้น ตัวระบุ ชื่อทรัพยากรของการเดินทาง รูปแบบ: projects/{project_number}/trips/{tripId}
config

object (TripConfig)

เปลี่ยนแปลงไม่ได้ การกำหนดค่าสำหรับการเดินทาง
androidAppId

string

อินพุตเท่านั้น เปลี่ยนแปลงไม่ได้ รหัสแอปพลิเคชัน Android ของแอปพลิเคชันบนอุปกรณ์เคลื่อนที่จะใช้การเดินทาง ต้องตั้งค่า androidAppId หรือ iosAppId อย่างน้อย 1 รายการ
iosAppId

string

อินพุตเท่านั้น เปลี่ยนแปลงไม่ได้ รหัสชุด iOS ของแอปพลิเคชันบนอุปกรณ์เคลื่อนที่จะใช้การเดินทาง ต้องตั้งค่า androidAppId หรือ iosAppId อย่างน้อย 1 รายการ
authToken

object (AuthToken)

เอาต์พุตเท่านั้น โทเค็นแบบทึบแสงที่ให้สิทธิ์เข้าถึงเพื่อเริ่มการเดินทาง NavConnect ใน Google Maps หรือ Waze และให้สิทธิ์แอปพลิเคชันเหล่านี้ในการอัปเดตการเดินทาง trips.create เท่านั้นที่ส่งคืน
state

enum (State)

เอาต์พุตเท่านั้น สถานะการเดินทาง
execution

object (TripExecution)

เอาต์พุตเท่านั้น ข้อมูลล่าสุดเกี่ยวกับการเดินทาง ระบบอาจไม่ได้ตั้งค่านี้หากการเดินทางอยู่ในสถานะข้อผิดพลาด
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาตามเซิร์ฟเวอร์เมื่อสร้างการเดินทาง

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่เซิร์ฟเวอร์ได้รับการอัปเดตการเดินทางล่าสุด

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

TripConfig

การกำหนดค่าสำหรับการเดินทาง

การแสดง JSON 
{
  "enableHighFrequencyUpdates": boolean,
  "enablePubsub": boolean,
  "pubsubFieldMask": string
}
ฟิลด์
enableHighFrequencyUpdates

boolean

ไม่บังคับ จะเปิดใช้การอัปเดตการเดินทางที่มีความถี่สูงหรือไม่

หมายเหตุ: การเปิดใช้ฟีเจอร์นี้จะบันทึกการเดินทางภายใต้การใช้งานระดับองค์กร และมีอัตราค่าบริการระดับองค์กร
enablePubsub

boolean

ไม่บังคับ จะเปิดใช้การแจ้งเตือน Pub/Sub สำหรับการเดินทางหรือไม่
pubsubFieldMask

string (FieldMask format)

ไม่บังคับ หากตั้งค่าไว้ ระบบจะรวมเฉพาะฟิลด์การเดินทางที่ระบุไว้ในชุดย่อยในการแจ้งเตือน Pub/Sub

หากไม่ได้ตั้งค่า ระบบจะรวมช่องการเดินทางทั้งหมดไว้ในการแจ้งเตือน Pub/Sub (ลักษณะการทำงานเริ่มต้น)

ระบบไม่รองรับฟิลด์ต่อไปนี้

  • androidAppId
  • iosAppId
  • authToken
  • config

หมายเหตุ: ระบบจะไม่สนใจฟิลด์นี้หาก enablePubsub เป็นเท็จ

นี่คือรายการชื่อฟิลด์แบบสมบูรณ์ที่คั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"

AuthToken

โทเค็นการตรวจสอบสิทธิ์

การแสดง JSON 
{
  "token": string,
  "expireTime": string
}
ช่อง
token

string

เอาต์พุตเท่านั้น โทเค็นการตรวจสอบสิทธิ์ที่ควรส่งไปยังแอปพลิเคชันบนอุปกรณ์เคลื่อนที่
expireTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่โทเค็นการตรวจสอบสิทธิ์จะหมดอายุ

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

รัฐ

สถานะการเดินทางที่เป็นไปได้ทั้งหมด

Enum
STATE_UNSPECIFIED ไม่ได้ระบุสถานะการเดินทาง
NEW ระบบสร้างการเดินทางแล้ว แต่ยังไม่ได้เริ่ม
ENROUTE ผู้ขนส่งกำลังเดินทางไปยังจุดหมาย
ARRIVED ผู้ขนส่งมาถึงจุดหมายแล้ว
SUSPENDED การเดินทางถูกระงับ
FAILED การเดินทางไม่สำเร็จ
CLIENT_ERROR การเดินทางล้มเหลวเนื่องจากข้อผิดพลาดเกี่ยวกับไคลเอ็นต์

TripExecution

ข้อมูลเกี่ยวกับการเดินทาง

การแสดง JSON 
{
  "origin": {
    object (Location)
  },
  "destination": {
    object (Stop)
  },
  "location": {
    object (Location)
  },
  "traveledDuration": string,
  "remainingDuration": string,
  "traveledDistanceMeters": integer,
  "remainingDistanceMeters": integer,
  "stopAddedInRoute": boolean
}
ช่อง
origin

object (Location)

เอาต์พุตเท่านั้น ต้นทางการเดินทาง ซึ่งโดยทั่วไปคือตำแหน่งของผู้ให้บริการขนส่งเมื่อเริ่มการเดินทางของ NavConnect
destination

object (Stop)

เอาต์พุตเท่านั้น จุดหมายของการเดินทางตามที่แอปพลิเคชันบนอุปกรณ์เคลื่อนที่รายงาน
location

object (Location)

เอาต์พุตเท่านั้น สัญญาณตำแหน่งที่แสดงตำแหน่งสุดท้ายที่ทราบของผู้ให้บริการขนส่ง ซึ่งจะเป็นตำแหน่งที่สแนปถนนหากมี
traveledDuration

string (Duration format)

เอาต์พุตเท่านั้น เวลาที่เดินทางจนถึงตอนนี้

ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย "s" เช่น "3.5s"
remainingDuration

string (Duration format)

เอาต์พุตเท่านั้น เวลาที่เหลือในการเดินทางนี้ตามที่ Google ประมาณ

ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย "s" เช่น "3.5s"
traveledDistanceMeters

integer

เอาต์พุตเท่านั้น ระยะทางที่เดินทางจากต้นทางเป็นเมตร
remainingDistanceMeters

integer

เอาต์พุตเท่านั้น ระยะทางที่เหลือไปยังจุดหมายเป็นเมตร
stopAddedInRoute

boolean

เอาต์พุตเท่านั้น ระบุว่ามีการเพิ่มจุดแวะระหว่างเส้นทางหรือไม่

ตำแหน่ง

ตำแหน่งตามที่แอปพลิเคชันบนอุปกรณ์เคลื่อนที่รายงาน

การแสดง JSON 
{
  "point": {
    object (LatLng)
  },
  "sourceTime": string,
  "serverTime": string
}
ช่อง
point

object (LatLng)

เอาต์พุตเท่านั้น ละติจูด/ลองจิจูดของสถานที่
sourceTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่ได้แหล่งที่มาของสถานที่ตามที่ไคลเอ็นต์ระบุ

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
serverTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่เซิร์ฟเวอร์ได้รับการอัปเดตตำแหน่งนี้

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

LatLng

ออบเจ็กต์ที่แสดงคู่ละติจูด/ลองจิจูด โดยจะแสดงเป็นคู่ของ Double เพื่อแสดงองศาละติจูดและองศาลองจิจูด ออบเจ็กต์นี้ต้องเป็นไปตาม มาตรฐาน WGS84 เว้นแต่จะระบุไว้เป็นอย่างอื่น ค่าต้องอยู่ในช่วงที่ทำให้เป็นปกติ

การแสดง JSON 
{
  "latitude": number,
  "longitude": number
}
ช่อง
latitude

number

ละติจูดเป็นองศา ต้องอยู่ในช่วง [-90.0, +90.0]
longitude

number

ลองจิจูดเป็นองศา ต้องอยู่ในช่วง [-180.0, +180.0]

หยุด

จุดแวะพักในการเดินทางซึ่งต้องดำเนินงานบางอย่าง

การแสดง JSON 
{
  "point": {
    object (LatLng)
  }
}
ช่อง
point

object (LatLng)

ต้องระบุ ตำแหน่งของป้ายจอดรถเป็นละติจูด/ลองจิจูด

เมธอด

create

 สร้างการเดินทาง

get

 รับการเดินทาง