Package google.maps.navconnect.v1

इंडेक्स

NavConnect क्लाइंट के लिए सेवा, ताकि वे यात्राएं बना सकें और उन्हें पा सकें.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

यात्रा बनाता है. मोबाइल ऐप्लिकेशन को यात्रा शुरू करने से पहले, इसे कॉल करना होगा. यात्रा की जानकारी में auth_token फ़ील्ड सेट होगा.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/cloud-platform
IAM अनुमतियां

parent रिसॉर्स पर, IAM से जुड़ी यह अनुमति ज़रूरी है:

  • navigationconnect.trips.create

ज़्यादा जानकारी के लिए, IAM का दस्तावेज़ देखें.

GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

किसी यात्रा की जानकारी मिलती है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/cloud-platform
IAM अनुमतियां

name रिसॉर्स पर, IAM से जुड़ी यह अनुमति ज़रूरी है:

  • navigationconnect.trips.get

ज़्यादा जानकारी के लिए, IAM का दस्तावेज़ देखें.

AuthToken

पुष्टि करने वाला टोकन.

फ़ील्ड
token

string

सिर्फ़ आउटपुट के लिए. पुष्टि करने वाला टोकन, जिसे मोबाइल ऐप्लिकेशन को पास किया जाना चाहिए.

expire_time

Timestamp

सिर्फ़ आउटपुट के लिए. वह समय जब पुष्टि करने वाले टोकन की समयसीमा खत्म हो जाएगी.

CreateTripRequest

NavConnectService.CreateTrip के लिए अनुरोध मैसेज.

फ़ील्ड
parent

string

ज़रूरी है. वह पैरंट संसाधन जिसके तहत यह यात्रा बनाई जाएगी. फ़ॉर्मैट: projects/{project_number}

trip_id

string

ज़रूरी है. यात्रा के लिए इस्तेमाल किया जाने वाला आईडी. यह यात्रा के संसाधन के नाम का आखिरी कॉम्पोनेंट बन जाएगा.

यह वैल्यू, RFC-4122 के मुताबिक मान्य यूयूआईडी होनी चाहिए.

trip

Trip

ज़रूरी है. यात्रा बनाने के लिए.

GetTripRequest

NavConnectService.GetTrip के लिए अनुरोध मैसेज.

फ़ील्ड
name

string

ज़रूरी है. जिस यात्रा की जानकारी चाहिए उसका संसाधन नाम. फ़ॉर्मैट: projects/{project}/trips/{trip_id}

route_polyline_format

RoutePolylineFormat

ज़रूरी नहीं. रास्ते की पॉलीलाइन को किस फ़ॉर्मैट में दिखाना है. अगर इसे सेट नहीं किया जाता है, तो SIMPLE रूट पॉलीलाइन को वापस कर दिया जाएगा.

RoutePolylineFormat

इससे रास्ते की पॉलीलाइन का फ़ॉर्मैट पता चलता है.

Enums
ROUTE_POLYLINE_FORMAT_UNSPECIFIED रास्ते की पॉलीलाइन का फ़ॉर्मैट नहीं बताया गया है.
SIMPLE रास्ते की पॉलीलाइन को पॉइंट के एक सामान्य कलेक्शन के तौर पर दिखाया जाता है. इसे google.type.LatLng के तौर पर दिखाया जाता है.
ENCODED रास्ते की पॉलीलाइन को एन्कोड की गई स्ट्रिंग के तौर पर दिखाया जाता है. https://developers.google.com/maps/documentation/utilities/polylinealgorithm पर जाएं.
S2ENCODED रास्ते की पॉलीलाइन को S2Polyline के तौर पर कोड किया जाता है. https://s2geometry.io/devguide/basic_types.html पर जाएं.
GEO_JSON रास्ते की पॉलीलाइन को GeoJSON LineString के तौर पर दिखाया जाता है. https://tools.ietf.org/html/rfc7946#section-3.1.4 देखें.

जगह

मोबाइल ऐप्लिकेशन से रिपोर्ट की गई जगह की जानकारी.

फ़ील्ड
point

LatLng

सिर्फ़ आउटपुट के लिए. जगह का अक्षांश/देशांतर.

source_time

Timestamp

सिर्फ़ आउटपुट के लिए. क्लाइंट के हिसाब से, जगह की जानकारी का सोर्स.

server_time

Timestamp

सिर्फ़ आउटपुट. यह वह समय है जब सर्वर को जगह की जानकारी का यह अपडेट मिला था.

रास्ता

रास्ते की पॉलीलाइन.

फ़ील्ड
traffic_information[]

SpeedReadingInterval

सिर्फ़ आउटपुट. पॉलीलाइन पर ट्रैफ़िक की जानकारी. इसे स्पीड रीडिंग इंटरवल के तौर पर बताया गया है.

ध्यान दें:

  • इंटरवल ओवरलैप नहीं होते.
  • इंटरवल एक-दूसरे से जुड़े होते हैं.
  • इंटरवल, पूरी पॉलीलाइन को कवर करते हैं.
  • इंटरवल को बढ़ते इंडेक्स के हिसाब से क्रम में लगाया जाता है.
  • हर इंटरवल के लिए स्पीड तय की जाती है.

यूनियन फ़ील्ड format. रास्ते का फ़ॉर्मैट.

route_polyline_format पैरामीटर से, भरे गए फ़ॉर्मैट को कंट्रोल किया जाता है. अगर इसे सेट नहीं किया जाता है, तो डिफ़ॉल्ट रूप से यह एक सामान्य पॉलीलाइन पर सेट होता है. format इनमें से सिर्फ़ एक हो सकता है:

simple_polyline

SimplePolyline

सिर्फ़ आउटपुट के लिए. रास्ते को अक्षांश/देशांतर की सामान्य सूची के तौर पर दिखाया जाता है.

encoded_polyline

string

सिर्फ़ आउटपुट. एन्कोड की गई पॉलीलाइन के तौर पर रास्ता. https://developers.google.com/maps/documentation/utilities/polylinealgorithm देखें.

s2_polyline

bytes

सिर्फ़ आउटपुट के लिए. रास्ते को कोड में बदले गए S2Polyline के तौर पर दिखाया जाता है. https://s2geometry.io/devguide/basic_types.html पर जाएं.

geo_json

Struct

सिर्फ़ आउटपुट. GeoJSON LineString के तौर पर रास्ता. https://tools.ietf.org/html/rfc7946#section-3.1.4 देखें.

SimplePolyline

यह पॉइंट की सामान्य सूची का इस्तेमाल करके, पॉलीलाइन को दिखाता है.

फ़ील्ड
points[]

LatLng

सिर्फ़ आउटपुट के लिए. पॉइंट की क्रम से लगाई गई सूची, पॉलीलाइन दिखाती है.

SpeedReadingInterval

किसी रास्ते के लगातार सेगमेंट पर ट्रैफ़िक डेंसिटी इंडिकेटर. P_0, P_1, ... , P_N (शून्य पर आधारित इंडेक्स) पॉइंट वाले पाथ के लिए, SpeedReadingInterval एक इंटरवल तय करता है. साथ ही, Speed कैटगरी का इस्तेमाल करके, इसके ट्रैफ़िक के बारे में बताता है.

फ़ील्ड
speed

Speed

सिर्फ़ आउटपुट के लिए. इस समयावधि में ट्रैफ़िक की स्पीड.

start_polyline_point_index

int32

सिर्फ़ आउटपुट के लिए. पाथ में इस इंटरवल का शुरुआती इंडेक्स.

end_polyline_point_index

int32

सिर्फ़ आउटपुट के लिए. पाथ में इस इंटरवल का आखिरी इंडेक्स.

स्पीड

ट्रैफ़िक डेटा के आधार पर, पॉलीलाइन की स्पीड का क्लासिफ़िकेशन.

Enums
SPEED_UNSPECIFIED स्पीड की जानकारी नहीं दी गई है.
NORMAL सामान्य रफ़्तार, ट्रैफ़िक की वजह से देर नहीं होगी.
SLOW ट्रैफ़िक धीमा है. ट्रैफ़िक न कम है, न ज़्यादा.
TRAFFIC_JAM ट्रैफ़िक की वजह से होने वाली देरी, जिसमें ट्रैफ़िक का रुक जाना भी शामिल है.

रोकें

यात्रा के दौरान कोई स्टॉप जहां कोई टास्क पूरा करना है.

फ़ील्ड
point

LatLng

ज़रूरी है. स्टॉप की जगह की जानकारी, अक्षांश/देशांतर के तौर पर.

भ्रमण

यात्रा.

फ़ील्ड
name

string

सिर्फ़ आउटपुट. आइडेंटिफ़ायर. यात्रा के संसाधन का नाम. फ़ॉर्मैट: projects/{project_number}/trips/{trip_id}.

config

TripConfig

बदला नहीं जा सकता. यात्रा का कॉन्फ़िगरेशन.

android_app_id

string

सिर्फ़ इनपुट के लिए. इम्यूटेबल. उस मोबाइल ऐप्लिकेशन का Android ऐप्लिकेशन आईडी जो यात्रा की जानकारी का इस्तेमाल करेगा. android_app_id या ios_app_id में से कम से कम एक को सेट करना ज़रूरी है.

ios_app_id

string

सिर्फ़ इनपुट के लिए. इम्यूटेबल. उस मोबाइल ऐप्लिकेशन का iOS बंडल आईडी जो यात्रा का इस्तेमाल करेगा. android_app_id या ios_app_id में से कम से कम एक को सेट करना ज़रूरी है.

auth_token

AuthToken

सिर्फ़ आउटपुट. यह एक ओपेक टोकन है. यह Google Maps या Waze में NavConnect यात्रा शुरू करने का ऐक्सेस देता है. साथ ही, इन ऐप्लिकेशन को यात्रा अपडेट करने का ऐक्सेस देता है. यह सिर्फ़ CreateTrip से मिलता है.

state

State

सिर्फ़ आउटपुट के लिए. यात्रा की स्थिति.

execution

TripExecution

सिर्फ़ आउटपुट. यात्रा पूरी होने के बारे में नया डेटा. अगर यात्रा में कोई गड़बड़ी हुई है, तो हो सकता है कि यह सेट न हो.

create_time

Timestamp

सिर्फ़ आउटपुट के लिए. सर्वर के हिसाब से वह समय जब यात्रा बनाई गई थी.

update_time

Timestamp

सिर्फ़ आउटपुट. वह समय जब सर्वर को यात्रा का नया अपडेट मिला था.

राज्य

यात्रा की सभी संभावित स्थितियां.

Enums
STATE_UNSPECIFIED यात्रा की स्थिति के बारे में जानकारी नहीं दी गई है.
NEW यात्रा बना दी गई है, लेकिन अभी शुरू नहीं हुई है.
ENROUTE ट्रांसपोर्टर, मंज़िल के रास्ते में है.
ARRIVED ट्रांसपोर्टर, मंज़िल पर पहुंच गया है.
SUSPENDED यात्रा को निलंबित कर दिया गया है.
FAILED यात्रा पूरी नहीं हो सकी.
CLIENT_ERROR क्लाइंट की गड़बड़ी की वजह से यात्रा पूरी नहीं हो सकी.
CANCELED यात्रा को डेवलपर ने रद्द कर दिया है.

TripConfig

यात्रा के लिए कॉन्फ़िगरेशन.

फ़ील्ड
enable_high_frequency_updates

bool

ज़रूरी नहीं. यात्रा की जानकारी को बार-बार अपडेट करने की सुविधा चालू करनी है या नहीं.

ध्यान दें: इस सुविधा को चालू करने पर, यात्रा को Enterprise Tier के इस्तेमाल में लॉग किया जाता है. साथ ही, इस पर Enterprise Tier के शुल्क लागू होते हैं.

enable_pubsub

bool

ज़रूरी नहीं. यात्रा के लिए pubsub सूचनाएं चालू करनी हैं या नहीं.

pubsub_field_mask

FieldMask

ज़रूरी नहीं. अगर यह विकल्प सेट किया जाता है, तो pubsub सूचनाओं में सिर्फ़ यात्रा के फ़ील्ड का तय किया गया सबसेट शामिल किया जाएगा.

अगर यह नीति सेट नहीं की जाती है, तो सभी ट्रिप फ़ील्ड, Pub/Sub सूचनाओं में शामिल किए जाएंगे (डिफ़ॉल्ट व्यवहार).

ये फ़ील्ड काम नहीं करते:

  • android_app_id
  • ios_app_id
  • auth_token
  • config

ध्यान दें: अगर enable_pubsub की वैल्यू 'गलत' पर सेट है, तो इस फ़ील्ड को अनदेखा कर दिया जाता है.

enable_remaining_route_reporting

bool

ज़रूरी नहीं. यात्रा के लिए, बचे हुए रास्ते की रिपोर्टिंग चालू करनी है या नहीं.

ध्यान दें: इस सुविधा को चालू करने पर, यात्रा को Enterprise Tier के इस्तेमाल में लॉग किया जाता है. साथ ही, इस पर Enterprise Tier के शुल्क लागू होते हैं.

TripExecution

यात्रा पूरी होने के बारे में डेटा.

फ़ील्ड
origin

Location

सिर्फ़ आउटपुट के लिए. यात्रा की शुरुआत की जगह. आम तौर पर, यह NavConnect की यात्रा शुरू होने के समय, ट्रांसपोर्टर की जगह होती है.

destination

Stop

सिर्फ़ आउटपुट के लिए. मोबाइल ऐप्लिकेशन से मिली जानकारी के मुताबिक, यात्रा की मंज़िल.

location

Location

सिर्फ़ आउटपुट. यह जगह की जानकारी देने वाला सिग्नल है. इससे पता चलता है कि ट्रांसपोर्टर आखिरी बार कहां था. अगर सड़क की जानकारी उपलब्ध है, तो यह सड़क की जानकारी के हिसाब से तय की गई जगह होगी.

remaining_route

Route

सिर्फ़ आउटपुट के लिए. यह रास्ते के बचे हुए हिस्से के लिए पॉलीलाइन उपलब्ध कराता है.

traveled_duration

Duration

सिर्फ़ आउटपुट के लिए. अब तक की गई यात्रा का समय.

remaining_duration

Duration

सिर्फ़ आउटपुट के लिए. Google के अनुमान के मुताबिक, इस यात्रा में बचा हुआ समय.

traveled_distance_meters

int32

सिर्फ़ आउटपुट के लिए. ऑरिजिन से तय की गई दूरी, मीटर में.

remaining_distance_meters

int32

सिर्फ़ आउटपुट के लिए. मंज़िल तक पहुंचने के लिए बची हुई दूरी, मीटर में.

stop_added_in_route

bool

सिर्फ़ आउटपुट के लिए. यह कुकी बताती है कि रास्ते में कोई स्टॉप जोड़ा गया था या नहीं.