Package google.maps.roads.selection.v1

شاخص

انتخاب جاده ها

تعریف سرویس برای Roads Selection API.

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes( BatchCreateSelectedRoutesRequest ) returns ( BatchCreateSelectedRoutesResponse )

چندین SelectedRoutes ایجاد می کند و برنامه ای را برای بازیابی دوره ای اطلاعات حافظه پنهان برای هر یک از مسیرها شروع می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
CreateSelectedRoute

rpc CreateSelectedRoute( CreateSelectedRouteRequest ) returns ( SelectedRoute )

یک SelectedRoute ایجاد می کند و برنامه ای را برای بازیابی دوره ای اطلاعات حافظه پنهان مسیر شروع می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
DeleteSelectedRoute

rpc DeleteSelectedRoute( DeleteSelectedRouteRequest ) returns ( Empty )

SelectedRoute مشخص شده را برای پروژه مشخص شده حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
GetSelectedRoute

rpc GetSelectedRoute( GetSelectedRouteRequest ) returns ( SelectedRoute )

یک SelectedRoute همانطور که با نام آن مشخص شده است دریافت می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
ListSelectedRoutes

rpc ListSelectedRoutes( ListSelectedRoutesRequest ) returns ( ListSelectedRoutesResponse )

تمام SelectedRoutes را برای پروژه مشخص شده با صفحه بندی فهرست می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform

BatchCreateSelectedRoutesRequest

درخواست ایجاد چندین SelectedRoute s.

فیلدها
parent

string

اختیاری. منبع پروژه به اشتراک گذاشته شده توسط همه مسیرهای انتخاب شده. قالب: پروژه‌ها/{پروژه} اگر این تنظیم شده باشد، فیلد والد در پیام‌های CreateSelectedRouteRequest باید یا خالی باشد یا با این فیلد مطابقت داشته باشد.

requests[]

CreateSelectedRouteRequest

مورد نیاز. پیام درخواست مسیر انتخاب شده برای ایجاد را مشخص می کند. حداکثر 1000 مسیر انتخابی را می توان در یک دسته ایجاد کرد.

BatchCreateSelectedRoutesResponse

پاسخ از ایجاد چندین SelectedRoute s.

فیلدها
selected_routes[]

SelectedRoute

SelectedRoutes ایجاد شد.

CreateSelectedRouteRequest

درخواست ایجاد یک SelectedRoute .

فیلدها
parent

string

مورد نیاز. پروژه ای که SelectedRoute تحت آن ایجاد خواهد شد. قالب: پروژه ها/{پروژه}

selected_route

SelectedRoute

مورد نیاز. SelectedRoute برای ایجاد.

selected_route_id

string

اختیاری. شناسه مورد استفاده برای SelectedRoute ، که جزء نهایی نام منبع SelectedRoute خواهد بود.

این مقدار باید 4-63 کاراکتر باشد و کاراکترهای معتبر عبارتند از: "az"، "AZ"، "0-9" یا "-". اگر ارائه نشده یا خالی باشد، پس از ایجاد منبع، یک UUID ایجاد خواهد شد.

DeleteSelectedRouteRequest

درخواست حذف SelectedRoute .

فیلدها
name

string

مورد نیاز. نام SelectedRoute برای حذف. قالب: پروژه‌ها/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

درخواست دریافت SelectedRoute .

فیلدها
name

string

مورد نیاز. نام SelectedRoute برای بازیابی. قالب: پروژه‌ها/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

درخواست لیست SelectedRoute s.

فیلدها
parent

string

مورد نیاز. والد، که پروژه ای است که تمام SelectedRoute از آن پرس و جو می شود. قالب: پروژه ها/{project}/selectedRoutes

page_size

int32

اختیاری. تعداد نتایجی که باید برای یک صفحه معین برگردانده شود. در صورت عدم تنظیم مقدار پیش فرض 100 است. هنگامی که مقدار 0 داده می شود، مقدار به پیش فرض تنظیم می شود. حداکثر مقدار 5000 است، هر مقدار بالاتر از 5000 روی 5000 تنظیم می شود.

page_token

string

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی ListSelectedRoutes .

ListSelectedRoutesResponse

پاسخی که SelectedRoute s را فهرست می کند.

فیلدها
selected_routes[]

SelectedRoute

صفحه ای از SelectedRoutes که در پروژه مشخص شده در درخواست ذخیره شده است.

next_page_token

string

نشانه ای که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این فیلد خالی باشد، هیچ صفحه بعدی وجود ندارد.

انتخاب مسیر

SelectedRoute نشان دهنده مسیر خاصی است که مشتری می خواهد به صورت دوره ای اطلاعات (مثلا مدت زمان) را برای موارد استفاده قراردادی بازیابی کند.

فیلدها
name

string

شناسه. نام منبع SelectedRoute .

قالب: پروژه‌ها/{project}/selectedRoutes/{selected_route}

display_name

string

اختیاری. نمایش نام مسیر این یک فیلد اختیاری است که مشتری می تواند از آن استفاده کند. لازم نیست منحصر به فرد باشد.

create_time

Timestamp

فقط خروجی زمانی که مسیر انتخابی برای اولین بار ایجاد شد.

state

State

فقط خروجی وضعیت مسیر انتخاب شده

route_attributes

map<string, string>

اختیاری. ویژگی های سفارشی برای مسیر انتخاب شده. افزودن آنها امکان فیلتر کردن / گروه بندی مسیرها را هنگام بازیابی اطلاعات مسیرهای تاریخی و لحظه ای فراهم می کند. حداکثر 10 ویژگی در هر مسیر پشتیبانی می شود. هر کلید و مقدار باید یک رشته غیر خالی باشد و حداکثر 100 کاراکتر داشته باشد. کلیدها نباید با "goog" شروع شوند.

route_type میدان اتحادیه. در حال حاضر فقط DynamicRoute پشتیبانی می شود. route_type می تواند تنها یکی از موارد زیر باشد:
dynamic_route

DynamicRoute

SelectedRoute یک مسیر پویا است.

validation_error

ValidationError

فقط خروجی خطای تأیید اعتبار برای مسیر انتخاب شده زمانی که وضعیت STATE_INVALID است.

DynamicRoute

این نشان دهنده یک مسیر با نقاط بین راه (مبداء، مقصد و واسطه ها) است. مسیر واقعی تضمین شده است که از تمام ایستگاه های بین راه عبور می کند، اما ممکن است به دلیل شرایط ترافیکی متفاوت، هر از گاهی تغییر کند.

فیلدها
origin

LatLng

مورد نیاز. محل مبدا مسیر.

destination

LatLng

مورد نیاز. محل پایان مسیر

intermediates[]

LatLng

اختیاری. مجموعه ای از ایستگاه های بین راهی در طول مسیر (به استثنای نقاط پایانه). آنها همیشه در حال عبور از نقاط هستند. حداکثر 25 ایستگاه بین راهی پشتیبانی می شود. اضافه کردن آنها به درستی می تواند تغییرات مسیر واقعی را در هر زمان کاهش دهد.

ایالت

وضعیت مسیر انتخاب شده

Enums
STATE_UNSPECIFIED وضعیت این مسیر تنظیم نشده است.
STATE_SCHEDULING مسیر ایجاد شده و در حال برنامه ریزی است.
STATE_RUNNING مسیر ایجاد شده و دارای برنامه زمانی فعال است.
STATE_DELETING مسیر برای حذف مشخص شده است.
STATE_VALIDATING مسیر در حال تایید اعتبار است.
STATE_INVALID مسیر بر اساس یکی از معیارهای اعتبارسنجی نامعتبر است.

خطای اعتبارسنجی

خطای اعتبارسنجی مسیر انتخاب شده.

Enums
VALIDATION_ERROR_UNSPECIFIED خطای اعتبارسنجی این مسیر تنظیم نشده است.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION مسیر خارج از صلاحیت پروژه است.
VALIDATION_ERROR_LOW_ROAD_USAGE این مسیر دارای کاربری کم جاده ای است ( افراد بسیار کمی از آن عبور می کنند).