Package google.maps.places.v1

Landmark

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

Area

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

string

نام منبع منطقه.

string

شناسه مکان منطقه.

LocalizedText

نام نمایشی منطقه.

Containment

رابطه مکانی بین مکان هدف و منطقه را تعریف می‌کند.

string

نام منبعِ آن مکان دیدنی.

string

شناسه مکانِ مورد نظر.

LocalizedText

نام نمایشی بنای تاریخی.

string

مجموعه‌ای از تگ‌های نوع برای این نشانه. برای فهرست کاملی از مقادیر ممکن، به https://developers.google.com/maps/documentation/places/web-service/place-types مراجعه کنید.

SpatialRelationship

رابطه مکانی بین مکان هدف و نقطه عطف را تعریف می‌کند.

float

فاصله مستقیم، بر حسب متر، بین نقطه مرکزی هدف و نقطه مرکزی نقطه عطف. در برخی شرایط، این مقدار می‌تواند بیشتر از travel_distance_meters باشد.

float

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

string

نام نویسنده Photo یا Review .

string

آدرس اینترنتی (URI) نویسنده Photo یا Review .

string

آدرس اینترنتی عکس پروفایل نویسنده Photo یا Review .

string

الزامی. رشته متنی که جستجو روی آن انجام می‌شود.

LocationBias

اختیاری. بایاس نتایج را به یک مکان مشخص شده هدایت می‌کند.

حداکثر یکی از location_bias یا location_restriction باید تنظیم شود. اگر هیچ‌کدام تنظیم نشوند، نتایج توسط آدرس IP بایاس می‌شوند، به این معنی که آدرس IP به یک مکان نامشخص نگاشت شده و به عنوان یک سیگنال بایاس استفاده می‌شود.

LocationRestriction

اختیاری. نتایج را به یک مکان مشخص محدود کنید.

حداکثر یکی از location_bias یا location_restriction باید تنظیم شود. اگر هیچ‌کدام تنظیم نشوند، نتایج توسط آدرس IP بایاس می‌شوند، به این معنی که آدرس IP به یک مکان نامشخص نگاشت شده و به عنوان یک سیگنال بایاس استفاده می‌شود.

string

اختیاری. نوع مکان اصلی (مثلاً "رستوران" یا "پمپ بنزین") در انواع مکان ( https://developers.google.com/maps/documentation/places/web-service/place-types ) ، یا فقط (regions) ، یا فقط (cities) گنجانده شده است. یک مکان فقط در صورتی برگردانده می‌شود که نوع اصلی آن در این لیست گنجانده شده باشد. حداکثر 5 مقدار را می‌توان مشخص کرد. اگر هیچ نوعی مشخص نشود، همه انواع مکان برگردانده می‌شوند.

string

اختیاری. فقط نتایج را در مناطق مشخص شده، که به عنوان حداکثر ۱۵ کد منطقه دو کاراکتری CLDR مشخص شده‌اند، لحاظ کنید. یک مجموعه خالی نتایج را محدود نمی‌کند. اگر هر دو location_restriction و included_region_codes تنظیم شوند، نتایج در ناحیه تقاطع قرار می‌گیرند.

string

اختیاری. زبانی که نتایج به آن برگردانده می‌شود. پیش‌فرض en-US است. اگر زبان مورد استفاده در input با language_code متفاوت باشد یا اگر Place برگردانده شده ترجمه‌ای از زبان محلی به language_code نداشته باشد، نتایج ممکن است به زبان‌های ترکیبی باشند.

string

اختیاری. کد منطقه، که به عنوان کد منطقه دو کاراکتری CLDR مشخص شده است. این بر قالب‌بندی آدرس، رتبه‌بندی نتایج تأثیر می‌گذارد و ممکن است بر نتایج بازگردانده شده تأثیر بگذارد. این امر نتایج را به منطقه مشخص شده محدود نمی‌کند. برای محدود کردن نتایج به یک منطقه، از region_code_restriction استفاده کنید.

LatLng

اختیاری. نقطه مبدا که از آن فاصله ژئودزیک تا مقصد محاسبه می‌شود (به صورت distance_meters برگردانده می‌شود). اگر این مقدار حذف شود، فاصله ژئودزیک برگردانده نخواهد شد.

int32

اختیاری. یک آفست کاراکتر یونیکد مبتنی بر صفر از input که موقعیت مکان‌نما را در input نشان می‌دهد. موقعیت مکان‌نما ممکن است بر پیش‌بینی‌های برگردانده شده تأثیر بگذارد.

اگر خالی باشد، به طور پیش‌فرض طول input را در نظر می‌گیرد.

bool

اختیاری. اگر درست باشد، پاسخ شامل پیش‌بینی‌های مکان و پرس‌وجو خواهد بود. در غیر این صورت، پاسخ فقط پیش‌بینی‌های مکان را برمی‌گرداند.

string

اختیاری. رشته‌ای که یک جلسه تکمیل خودکار را برای اهداف صورتحساب مشخص می‌کند. باید یک رشته base64 ایمن برای URL و نام فایل با حداکثر ۳۶ کاراکتر ASCII باشد. در غیر این صورت خطای INVALID_ARGUMENT بازگردانده می‌شود.

جلسه زمانی شروع می‌شود که کاربر شروع به تایپ یک پرس‌وجو می‌کند و زمانی که مکانی را انتخاب می‌کند و درخواست Place Details یا Address Validation انجام می‌شود، پایان می‌یابد. هر جلسه می‌تواند چندین پرس‌وجو داشته باشد و به دنبال آن یک درخواست Place Details یا Address Validation قرار گیرد. اعتبارنامه‌های استفاده شده برای هر درخواست در یک جلسه باید متعلق به همان پروژه Google Cloud Console باشد. پس از پایان یک جلسه، توکن دیگر معتبر نیست؛ برنامه شما باید برای هر جلسه یک توکن جدید تولید کند. اگر پارامتر session_token حذف شود، یا اگر از یک توکن جلسه دوباره استفاده کنید، هزینه جلسه طوری محاسبه می‌شود که انگار هیچ توکن جلسه‌ای ارائه نشده است (هزینه هر درخواست جداگانه محاسبه می‌شود).

ما دستورالعمل‌های زیر را توصیه می‌کنیم:

• از توکن‌های جلسه برای همه فراخوانی‌های تکمیل خودکار مکان استفاده کنید.
• برای هر جلسه یک توکن جدید ایجاد کنید. استفاده از UUID نسخه ۴ توصیه می‌شود.
• اطمینان حاصل کنید که اعتبارنامه‌های مورد استفاده برای همه درخواست‌های تکمیل خودکار مکان، جزئیات مکان و اعتبارسنجی آدرس در یک جلسه متعلق به یک پروژه Cloud Console هستند.
• حتماً برای هر جلسه جدید، یک توکن جلسه منحصر به فرد ارسال کنید. استفاده از یک توکن برای بیش از یک جلسه منجر به این می‌شود که برای هر درخواست، هزینه جداگانه محاسبه شود.

bool

اختیاری. اگر فیلد روی true تنظیم شده باشد، کسب‌وکارهای صرفاً خدماتی را نیز اضافه کنید. کسب‌وکار صرفاً خدماتی، کسب‌وکاری است که مستقیماً از مشتریان بازدید می‌کند یا به آنها کالا تحویل می‌دهد، اما به آدرس کسب‌وکار آنها خدمات ارائه نمی‌دهد. برای مثال، کسب‌وکارهایی مانند خدمات نظافت یا لوله‌کشی. این کسب‌وکارها آدرس فیزیکی یا مکانی در نقشه‌های گوگل ندارند. Places فیلدهایی از جمله location ، plus_code و سایر فیلدهای مرتبط با مکان را برای این کسب‌وکارها برنمی‌گرداند.

Viewport

دریچه دیدی که توسط یک گوشه شمال شرقی و یک گوشه جنوب غربی تعریف شده است.

Circle

دایره‌ای که با یک نقطه مرکزی و شعاع مشخص می‌شود.

Viewport

دریچه دیدی که توسط یک گوشه شمال شرقی و یک گوشه جنوب غربی تعریف شده است.

Circle

دایره‌ای که با یک نقطه مرکزی و شعاع مشخص می‌شود.

Suggestion

شامل فهرستی از پیشنهادها است که به ترتیب نزولی اهمیت مرتب شده‌اند.

PlacePrediction

پیشگویی برای یک مکان.

QueryPrediction

پیش‌بینی برای یک پرس‌وجو.

string

متنی که می‌تواند به همین صورت استفاده شود یا با matches قالب‌بندی شود.

StringRange

فهرستی از محدوده‌های رشته‌ای که مشخص می‌کند درخواست ورودی در کجای text مطابقت دارد. این محدوده‌ها می‌توانند برای قالب‌بندی بخش‌های خاصی از text استفاده شوند. اگر تطبیق با معیارهایی غیر از تطبیق رشته (مثلاً تصحیح املا یا آوانویسی) تعیین شده باشد، ممکن است زیررشته‌ها دقیقاً با input مطابقت نداشته باشند.

این مقادیر، فاصله‌های کاراکتری text در یونیکد هستند. تضمین می‌شود که محدوده‌ها به ترتیب افزایشی مرتب شوند.

string

نام منبع مکان پیشنهادی. این نام می‌تواند در سایر APIهایی که نام مکان را می‌پذیرند، استفاده شود.

string

شناسه منحصر به فرد مکان پیشنهادی. این شناسه می‌تواند در سایر APIهایی که شناسه مکان را می‌پذیرند، استفاده شود.

FormattableText

شامل نام قابل خواندن توسط انسان برای نتیجه‌ی برگردانده شده است. برای نتایج مربوط به تأسیس، این نام معمولاً نام و آدرس کسب و کار است.

text برای توسعه‌دهندگانی که مایل به نمایش یک عنصر رابط کاربری واحد هستند توصیه می‌شود. توسعه‌دهندگانی که مایل به نمایش دو عنصر رابط کاربری جداگانه اما مرتبط هستند، می‌توانند به جای آن structured_format استفاده کنند. این دو روش مختلف برای نمایش پیش‌بینی مکان هستند. کاربران نباید سعی کنند structured_format به text تجزیه کنند یا برعکس.

این متن ممکن است با display_name برگردانده شده توسط GetPlace متفاوت باشد.

اگر input درخواست و language_code به زبان‌های مختلفی باشند یا اگر Place ترجمه‌ای از زبان محلی به language_code نداشته باشد، ممکن است به زبان‌های ترکیبی باشد.

StructuredFormat

تجزیه پیش‌بینی مکان به متن اصلی شامل نام مکان و متن ثانویه شامل ویژگی‌های ابهام‌زدایی اضافی (مانند شهر یا منطقه).

structured_format برای توسعه‌دهندگانی که مایل به نمایش دو عنصر رابط کاربری جداگانه اما مرتبط هستند، توصیه می‌شود. توسعه‌دهندگانی که مایل به نمایش یک عنصر رابط کاربری واحد هستند، می‌توانند به جای آن text استفاده کنند. این دو روش مختلف برای نمایش پیش‌بینی مکان هستند. کاربران نباید سعی کنند structured_format به text تجزیه کنند یا برعکس.

string

فهرست انواعی که برای این مکان از جدول A یا جدول B در https://developers.google.com/maps/documentation/places/web-service/place-types اعمال می‌شوند.

یک نوع، دسته‌بندی یک مکان است. مکان‌هایی که انواع مشترکی دارند، ویژگی‌های مشابهی نیز خواهند داشت.

int32

طول ژئودزیک بر حسب متر از origin ، در صورتی که origin مشخص شده باشد. پیش‌بینی‌های خاصی مانند مسیرها ممکن است در این فیلد قرار نگیرند.

FormattableText

متن پیش‌بینی‌شده. این متن نشان‌دهنده‌ی یک مکان نیست، بلکه یک عبارت متنی است که می‌تواند در یک نقطه‌ی پایانی جستجو (مثلاً جستجوی متن) استفاده شود.

text برای توسعه‌دهندگانی که مایل به نمایش یک عنصر رابط کاربری واحد هستند توصیه می‌شود. توسعه‌دهندگانی که مایل به نمایش دو عنصر رابط کاربری جداگانه اما مرتبط هستند، می‌توانند به جای آن structured_format استفاده کنند. این دو روش مختلف برای نمایش پیش‌بینی پرس‌وجو هستند. کاربران نباید سعی کنند structured_format به text تجزیه کنند یا برعکس.

اگر input درخواست و language_code به زبان‌های مختلفی باشند یا اگر بخشی از پرس‌وجو ترجمه‌ای از زبان محلی به language_code نداشته باشد، ممکن است به زبان‌های ترکیبی باشد.

StructuredFormat

تجزیه پیش‌بینی پرس‌وجو به متن اصلی حاوی پرس‌وجو و متن ثانویه حاوی ویژگی‌های ابهام‌زدایی اضافی (مانند شهر یا منطقه).

structured_format برای توسعه‌دهندگانی که مایل به نمایش دو عنصر رابط کاربری جداگانه اما مرتبط هستند، توصیه می‌شود. توسعه‌دهندگانی که مایل به نمایش یک عنصر رابط کاربری واحد هستند، می‌توانند به جای آن text استفاده کنند. این دو روش مختلف برای نمایش پیش‌بینی پرس‌وجو هستند. کاربران نباید سعی کنند structured_format به text تجزیه کنند یا برعکس.

int32

آفست مبتنی بر صفر اولین کاراکتر یونیکد رشته (شامل).

int32

آفست آخرین کاراکتر یونیکد مبتنی بر صفر (منحصراً).

FormattableText

نام مکان یا عبارت جستجو را نشان می‌دهد.

FormattableText

ویژگی‌های ابهام‌زدایی اضافی (مانند یک شهر یا منطقه) را برای شناسایی بیشتر مکان یا اصلاح پرس‌وجو نشان می‌دهد.

LatLng

الزامی. طول و عرض جغرافیایی مرکز.

محدوده عرض جغرافیایی باید بین [-90.0، 90.0] و محدوده طول جغرافیایی باید بین [-180.0، 180.0] باشد.

double

الزامی. شعاع بر حسب متر اندازه‌گیری شده است. شعاع باید در محدوده [0.0، 50000.0] باشد.

LocalizedText

مطالب مرتبط با موضوع.

string

فهرست نام‌های منابع مکان‌های ارجاع‌شده. این نام می‌تواند در سایر APIهایی که نام‌های منابع Place را می‌پذیرند، استفاده شود.

Review

فهرست نظرات درباره این مکان، متناسب با عبارت جستجو شده.

Photo

اطلاعات (شامل منابع) درباره عکس‌های این مکان، متناسب با عبارت جستجو شده.

Justification

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.

توجیهاتی برای مکان.

ReviewJustification

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.

BusinessAvailabilityAttributesJustification

آزمایشی: برای جزئیات بیشتر به https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative مراجعه کنید.

bool

اگر جایی غذای بیرون‌بر ارائه می‌دهد.

bool

اگر مکانی خدمات تحویل ارائه می‌دهد.

bool

اگر مکانی امکان صرف غذا در محل را فراهم می‌کند.

HighlightedText

Review

مروری که متن هایلایت شده از آن تولید شده است.

string

HighlightedTextRange

فهرست محدوده‌های متن هایلایت شده.

int32

int32

int32

تعداد کانکتورها در این ایستگاه. با این حال، از آنجا که برخی از پورت‌ها می‌توانند چندین کانکتور داشته باشند اما فقط می‌توانند یک خودرو را در یک زمان شارژ کنند (مثلاً)، تعداد کانکتورها ممکن است بیشتر از تعداد کل خودروهایی باشد که می‌توانند همزمان شارژ شوند.

ConnectorAggregation

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

EVConnectorType

نوع کانکتور این تجمیع.

double

حداکثر نرخ شارژ استاتیک بر حسب کیلووات برای هر کانکتور در تجمیع.

int32

تعداد کانکتورها در این تجمیع.

Timestamp

مهر زمانی که آخرین بار اطلاعات مربوط به در دسترس بودن کانکتور در این مجموعه به‌روزرسانی شده است.

int32

تعداد کانکتورهای موجود در این مجموعه در حال حاضر.

int32

تعداد کانکتورهای موجود در این تجمیع که در حال حاضر از سرویس خارج هستند.

FuelPrice

آخرین قیمت سوخت شناخته شده برای هر نوع سوختی که این جایگاه دارد. برای هر نوع سوختی که این جایگاه دارد، یک ورودی وجود دارد. ترتیب مهم نیست.

FuelType

نوع سوخت.

Money

قیمت سوخت.

Timestamp

آخرین باری که قیمت سوخت به‌روزرسانی شده است.

string

الزامی. نام منبع یک رسانه تصویری با فرمت: places/{place_id}/photos/{photo_reference}/media .

نام منبع یک عکس که در فیلد photos.name شیء Place برگردانده می‌شود، با فرمت places/{place_id}/photos/{photo_reference} می‌آید. برای دریافت نام منبع رسانه عکس، باید /media به انتهای منبع عکس اضافه کنید.

int32

اختیاری. حداکثر عرض دلخواه تصویر را بر حسب پیکسل مشخص می‌کند. اگر تصویر از مقادیر مشخص شده کوچکتر باشد، تصویر اصلی برگردانده می‌شود. اگر تصویر در هر دو بُعد بزرگتر باشد، مقیاس آن به گونه‌ای تنظیم می‌شود که با کوچکترین بُعد از دو بُعد مطابقت داشته باشد و به نسبت ابعاد اصلی خود محدود شود. هر دو ویژگی max_height_px و max_width_px یک عدد صحیح بین ۱ تا ۴۸۰۰ را می‌پذیرند. اگر مقدار در محدوده مجاز نباشد، خطای INVALID_ARGUMENT برگردانده می‌شود.

حداقل یکی از max_height_px یا max_width_px باید مشخص شود. اگر هیچ کدام از max_height_px یا max_width_px مشخص نشده باشند، خطای INVALID_ARGUMENT برگردانده می‌شود.

int32

اختیاری. حداکثر ارتفاع دلخواه تصویر را بر حسب پیکسل مشخص می‌کند. اگر تصویر از مقادیر مشخص شده کوچکتر باشد، تصویر اصلی برگردانده می‌شود. اگر تصویر در هر دو بُعد بزرگتر باشد، مقیاس آن به گونه‌ای تنظیم می‌شود که با کوچکترین بُعد از دو بُعد مطابقت داشته باشد و به نسبت ابعاد اصلی خود محدود شود. هر دو ویژگی max_height_px و max_width_px یک عدد صحیح بین ۱ تا ۴۸۰۰ را می‌پذیرند. اگر مقدار در محدوده مجاز نباشد، خطای INVALID_ARGUMENT برگردانده می‌شود.

حداقل یکی از max_height_px یا max_width_px باید مشخص شود. اگر هیچ کدام از max_height_px یا max_width_px مشخص نشده باشند، خطای INVALID_ARGUMENT برگردانده می‌شود.

bool

اختیاری. در صورت تنظیم، از رفتار پیش‌فرض تغییر مسیر HTTP صرف نظر کرده و پاسخی با فرمت متنی (مثلاً در قالب JSON برای مورد استفاده HTTP) ارائه می‌دهد. در صورت تنظیم نشدن، یک تغییر مسیر HTTP برای هدایت فراخوانی به رسانه تصویر صادر می‌شود. این گزینه برای درخواست‌های غیر HTTP نادیده گرفته می‌شود.

string

الزامی. نام منبع یک مکان، با فرمت places/{place_id} .

string

اختیاری. جزئیات مکان در صورت وجود با زبان دلخواه نمایش داده خواهد شد.

فهرست فعلی زبان‌های پشتیبانی‌شده: https://developers.google.com/maps/faq#languagesupport .

string

اختیاری. کد یونیکد کشور/منطقه (CLDR) مکانی که درخواست از آنجا می‌آید. این پارامتر برای نمایش جزئیات مکان، مانند نام مکان خاص منطقه، در صورت وجود، استفاده می‌شود. این پارامتر می‌تواند بر اساس قانون مربوطه بر نتایج تأثیر بگذارد. برای اطلاعات بیشتر، به https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html مراجعه کنید.

توجه داشته باشید که کدهای منطقه ای سه رقمی در حال حاضر پشتیبانی نمی شوند.

string

اختیاری. رشته‌ای که یک جلسه تکمیل خودکار را برای اهداف صورتحساب مشخص می‌کند. باید یک رشته base64 ایمن برای URL و نام فایل با حداکثر ۳۶ کاراکتر ASCII باشد. در غیر این صورت خطای INVALID_ARGUMENT بازگردانده می‌شود.

جلسه زمانی شروع می‌شود که کاربر شروع به تایپ یک پرس‌وجو می‌کند و زمانی که مکانی را انتخاب می‌کند و درخواست Place Details یا Address Validation انجام می‌شود، پایان می‌یابد. هر جلسه می‌تواند چندین پرس‌وجو داشته باشد و به دنبال آن یک درخواست Place Details یا Address Validation قرار گیرد. اعتبارنامه‌های استفاده شده برای هر درخواست در یک جلسه باید متعلق به همان پروژه Google Cloud Console باشد. پس از پایان یک جلسه، توکن دیگر معتبر نیست؛ برنامه شما باید برای هر جلسه یک توکن جدید تولید کند. اگر پارامتر session_token حذف شود، یا اگر از یک توکن جلسه دوباره استفاده کنید، هزینه جلسه طوری محاسبه می‌شود که انگار هیچ توکن جلسه‌ای ارائه نشده است (هزینه هر درخواست جداگانه محاسبه می‌شود).

ما دستورالعمل‌های زیر را توصیه می‌کنیم:

• از توکن‌های جلسه برای همه فراخوانی‌های تکمیل خودکار مکان استفاده کنید.
• برای هر جلسه یک توکن جدید ایجاد کنید. استفاده از UUID نسخه ۴ توصیه می‌شود.
• اطمینان حاصل کنید که اعتبارنامه‌های مورد استفاده برای همه درخواست‌های تکمیل خودکار مکان، جزئیات مکان و اعتبارسنجی آدرس در یک جلسه متعلق به یک پروژه Cloud Console هستند.
• حتماً برای هر جلسه جدید، یک توکن جلسه منحصر به فرد ارسال کنید. استفاده از یک توکن برای بیش از یک جلسه منجر به این می‌شود که برای هر درخواست، هزینه جداگانه محاسبه شود.

string

شناسه. مرجعی که نشان‌دهنده عکس این مکان است و می‌توان از آن برای جستجوی مجدد عکس این مکان استفاده کرد (همچنین به آن نام "منبع" API نیز گفته می‌شود: places/{place_id}/photos/{photo} ).

int32

حداکثر عرض موجود، بر حسب پیکسل.

int32

حداکثر ارتفاع قابل دسترس، بر حسب پیکسل.

AuthorAttribution

نویسندگان این عکس.

string

پیوندی که کاربران می‌توانند در آن مشکل عکس را گزارش دهند.

string

لینکی برای نمایش عکس روی نقشه گوگل.

string

نام منبع یک رسانه تصویری با فرمت: places/{place_id}/photos/{photo_reference}/media .

string

یک uri کوتاه مدت که می‌تواند برای رندر کردن عکس استفاده شود.

string

نام منبع این مکان، با فرمت places/{place_id} . می‌توان از آن برای جستجوی مکان استفاده کرد.

string

شناسه منحصر به فرد یک مکان.

LocalizedText

نام محلی مکان، مناسب برای توضیح کوتاه و خوانا برای انسان. برای مثال، «گوگل سیدنی»، «استارباکس»، «پیرمونت» و غیره.

string

مجموعه‌ای از برچسب‌های نوع برای این نتیجه. به عنوان مثال، "political" و "locality". برای لیست کامل مقادیر ممکن، به جدول A و جدول B در https://developers.google.com/maps/documentation/places/web-service/place-types مراجعه کنید.

string

نوع اصلی نتیجه داده شده. این نوع باید یکی از انواع پشتیبانی شده توسط Places API باشد. به عنوان مثال، "رستوران"، "کافه"، "فرودگاه" و غیره. یک مکان فقط می‌تواند یک نوع اصلی داشته باشد. برای لیست کامل مقادیر ممکن، به جدول A و جدول B در https://developers.google.com/maps/documentation/places/web-service/place-types مراجعه کنید. اگر نوع اصلی مکان از نوع پشتیبانی شده نباشد، ممکن است نوع اصلی وجود نداشته باشد. وقتی یک نوع اصلی وجود دارد، همیشه یکی از انواع موجود در فیلد types است.

LocalizedText

نام نمایشی نوع اصلی، که در صورت لزوم به زبان درخواست بومی‌سازی شده است. برای لیست کامل مقادیر ممکن، به جدول A و جدول B در https://developers.google.com/maps/documentation/places/web-service/place-types مراجعه کنید. اگر نوع اصلی مکان از نوع پشتیبانی شده نباشد، ممکن است نوع اصلی وجود نداشته باشد.

string

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

string

یک شماره تلفن قابل خواندن توسط انسان برای آن مکان، در قالب بین‌المللی.

string

یک آدرس کامل و قابل خواندن توسط انسان برای این مکان.

string

یک آدرس کوتاه و خوانا برای این مکان.

PostalAddress

آدرس در قالب آدرس پستی.

AddressComponent

اجزای تکراری برای هر سطح محلی. به حقایق زیر در مورد آرایه address_components[] توجه کنید: - آرایه اجزای آدرس ممکن است شامل اجزای بیشتری نسبت به formatted_address باشد. - این آرایه لزوماً شامل تمام موجودیت‌های سیاسی که حاوی یک آدرس هستند، جدا از آنهایی که در formatted_address قرار دارند، نمی‌شود. برای بازیابی تمام موجودیت‌های سیاسی که حاوی یک آدرس خاص هستند، باید از geocoding معکوس استفاده کنید و طول/عرض جغرافیایی آدرس را به عنوان پارامتر به درخواست ارسال کنید. - تضمین نمی‌شود که قالب پاسخ بین درخواست‌ها یکسان باقی بماند. به طور خاص، تعداد address_components بر اساس آدرس درخواستی متفاوت است و می‌تواند در طول زمان برای همان آدرس تغییر کند. یک جزء می‌تواند موقعیت خود را در آرایه تغییر دهد. نوع جزء می‌تواند تغییر کند. یک جزء خاص ممکن است در پاسخ بعدی از دست رفته باشد.

PlusCode

کد بعلاوه موقعیت مکانی (طول/عرض).

LatLng

موقعیت این مکان.

Viewport

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

double

امتیازی بین ۱.۰ تا ۵.۰، بر اساس نظرات کاربران در مورد این مکان.

string

یک URL که اطلاعات بیشتری در مورد این مکان ارائه می‌دهد.

string

وب‌سایت معتبر برای این مکان، مثلاً صفحه اصلی یک کسب‌وکار. توجه داشته باشید که برای مکان‌هایی که بخشی از یک زنجیره هستند (مثلاً یک فروشگاه IKEA)، این معمولاً وب‌سایت فروشگاه مربوطه خواهد بود، نه کل زنجیره.

Review

فهرست نظرات درباره این مکان، مرتب شده بر اساس میزان اهمیت. حداکثر ۵ نظر قابل ارسال است.

OpeningHours

ساعات کاری معمول. توجه داشته باشید که اگر مکانی همیشه باز باشد (24 ساعت)، فیلد close تنظیم نمی‌شود. مشتریان می‌توانند به این نکته تکیه کنند که همیشه باز (24 ساعت) به صورت یک دوره open شامل day با مقدار 0 ، hour با مقدار 0 و minute با مقدار 0 نمایش داده می‌شود.

TimeZone

پایگاه داده منطقه زمانی IANA، منطقه زمانی. برای مثال "America/New_York".

Photo

اطلاعات (شامل منابع) در مورد عکس‌های این مکان. حداکثر ۱۰ عکس قابل بازگشت است.

string

آدرس مکان در ریزفرمت adr: http://microformats.org/wiki/adr .

BusinessStatus

وضعیت تجاری آن مکان.

PriceLevel

سطح قیمت مکان.

Attribution

مجموعه‌ای از ارائه‌دهندگان داده که باید با این نتیجه نشان داده شوند.

string

یک URL کوتاه شده به یک ماسک آیکون. کاربر می‌تواند با اضافه کردن پسوند نوع به انتهای آن (مثلاً ".svg" یا ".png") به نوع آیکون‌های مختلف دسترسی پیدا کند.

string

رنگ پس‌زمینه برای icon_mask با فرمت هگز، مثلاً #909CE1.

OpeningHours

ساعات کاری برای هفت روز آینده (شامل امروز). این بازه زمانی از نیمه‌شب تاریخ درخواست شروع می‌شود و شش روز بعد ساعت ۱۱:۵۹ شب به پایان می‌رسد. این فیلد شامل زیرفیلد special_days مربوط به همه ساعات است که برای تاریخ‌هایی با ساعات کاری استثنایی تنظیم شده است.

OpeningHours

شامل آرایه‌ای از ورودی‌ها برای هفت روز آینده، شامل اطلاعات مربوط به ساعات کاری فرعی یک کسب‌وکار است. ساعات کاری فرعی با ساعات کاری اصلی یک کسب‌وکار متفاوت است. برای مثال، یک رستوران می‌تواند ساعات کاری درایو تو یا ساعات کاری تحویل را به عنوان ساعات کاری فرعی خود مشخص کند. این فیلد، زیرفیلد type را پر می‌کند که از یک لیست از پیش تعریف‌شده از انواع ساعات کاری (مانند DRIVE_THROUGH، PICKUP یا TAKEOUT) بر اساس انواع مکان استخراج می‌شود. این فیلد شامل زیرفیلد special_days مربوط به همه ساعات کاری است که برای تاریخ‌هایی با ساعات کاری استثنایی تنظیم شده است.

OpeningHours

شامل آرایه‌ای از ورودی‌ها برای اطلاعات مربوط به ساعات کاری فرعی معمول یک کسب‌وکار است. ساعات کاری فرعی با ساعات کاری اصلی یک کسب‌وکار متفاوت است. برای مثال، یک رستوران می‌تواند ساعات کاری درایو تو یا ساعات کاری تحویل را به عنوان ساعات کاری فرعی خود مشخص کند. این فیلد، زیرفیلد نوع را پر می‌کند که از یک لیست از پیش تعریف‌شده از انواع ساعات کاری (مانند DRIVE_THROUGH، PICKUP یا TAKEOUT) بر اساس انواع مکان انتخاب می‌شود.

LocalizedText

شامل خلاصه‌ای از مکان است. خلاصه شامل یک مرور متنی است و در صورت لزوم شامل کد زبان برای این موارد نیز می‌شود. متن خلاصه باید به همان شکلی که هست ارائه شود و قابل اصلاح یا تغییر نیست.

PaymentOptions

گزینه‌های پرداختی که مکان می‌پذیرد. اگر داده‌های گزینه پرداخت موجود نباشد، فیلد گزینه پرداخت غیرفعال خواهد شد.

ParkingOptions

گزینه‌های پارکینگ ارائه شده توسط محل.

SubDestination

فهرستی از زیرمقصدهای مرتبط با مکان.

FuelOptions

جدیدترین اطلاعات در مورد گزینه‌های سوخت در پمپ بنزین. این اطلاعات مرتباً به‌روزرسانی می‌شود.

EVChargeOptions

اطلاعات مربوط به گزینه‌های شارژ خودروهای برقی.

GenerativeSummary

خلاصه‌ای از مکان که توسط هوش مصنوعی تولید شده است.

ContainingPlace

فهرست مکان‌هایی که مکان فعلی در آنها قرار دارد.

AddressDescriptor

توصیف‌گر آدرس مکان. توصیف‌گرهای آدرس شامل اطلاعات اضافی هستند که به توصیف یک مکان با استفاده از علائم و مناطق کمک می‌کنند. پوشش منطقه‌ای توصیف‌گر آدرس را در https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage ببینید.

GoogleMapsLinks

لینک‌هایی برای فعال کردن اقدامات مختلف نقشه‌های گوگل.

PriceRange

محدوده قیمت مرتبط با یک مکان.

ReviewSummary

خلاصه‌ای از مکان که توسط هوش مصنوعی و با استفاده از نظرات کاربران تولید شده است.

EvChargeAmenitySummary

خلاصه‌ای از امکانات رفاهی نزدیک ایستگاه شارژ خودروهای برقی.

NeighborhoodSummary

خلاصه‌ای از جاذبه‌های گردشگری نزدیک محل مورد نظر.

ConsumerAlert

پیام هشدار به مصرف‌کننده برای مکانی که در آن فعالیت بررسی مشکوکی را در یک کسب‌وکار تشخیص می‌دهیم یا کسب‌وکاری که سیاست‌های ما را نقض می‌کند.

string

اگر این مکان به طور دائم بسته شده و به مکان جدیدی منتقل شده باشد، این فیلد شامل نام منبع مکان جدید، با فرمت places/{place_id} است. اگر این مکان چندین بار جابجا شده باشد، این فیلد اولین مکان جابجا شده را نشان می‌دهد. اگر این مکان جابجا نشده باشد، این فیلد پر نخواهد شد.

string

اگر این مکان به طور دائم بسته شده و به مکان جدیدی منتقل شده باشد، این فیلد حاوی شناسه مکان جدید است. اگر این مکان چندین بار جابجا شده باشد، این فیلد اولین مکان جابجا شده را نشان می‌دهد. اگر این مکان جابجا نشده باشد، این فیلد پر نخواهد شد.

int32

تعداد دقایقی که منطقه زمانی این مکان در حال حاضر با UTC اختلاف دارد. این مقدار بر حسب دقیقه بیان می‌شود تا از مناطق زمانی که کسری از ساعت اختلاف دارند، مثلاً X ساعت و ۱۵ دقیقه، پشتیبانی کند.

int32

تعداد کل نظرات (با متن یا بدون متن) برای این مکان.

bool

مشخص می‌کند که آیا کسب‌وکار از بیرون‌بر پشتیبانی می‌کند یا خیر.

bool

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

bool

مشخص می‌کند که آیا کسب‌وکار از گزینه‌های نشستن در فضای داخلی یا خارجی پشتیبانی می‌کند یا خیر.

bool

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

bool

مشخص می‌کند که آیا مکان از رزرو پشتیبانی می‌کند یا خیر.

bool

مشخص می‌کند که آیا آن مکان صبحانه سرو می‌کند یا خیر.

bool

مشخص می‌کند که آیا آن مکان ناهار سرو می‌کند یا خیر.

bool

مشخص می‌کند که آیا آن مکان شام سرو می‌کند یا خیر.

bool

مشخص می‌کند که آیا آن مکان آبجو سرو می‌کند یا خیر.

bool

مشخص می‌کند که آیا آن مکان شراب سرو می‌کند یا خیر.

bool

مشخص می‌کند که آیا مکان مورد نظر برانچ سرو می‌کند یا خیر.

bool

مشخص می‌کند که آیا این مکان غذای گیاهی سرو می‌کند یا خیر.

bool

مکان، فضای نشیمن در فضای باز را فراهم می‌کند.

bool

این مکان موسیقی زنده ارائه می‌دهد.

bool

این مکان منوی مخصوص کودکان دارد.

bool

این مکان کوکتل سرو می‌کند.

bool

این مکان دسر سرو می‌کند.

bool

این مکان قهوه سرو می‌کند.

bool

مکان برای کودکان خوب است.

bool

مکان به سگ‌ها اجازه ورود می‌دهد.

bool

مکان دارای سرویس بهداشتی است.

bool

این مکان پذیرای گروه‌ها است.

bool

مکان مناسبی برای تماشای مسابقات ورزشی است.

AccessibilityOptions

اطلاعات مربوط به گزینه‌های دسترسی که یک مکان ارائه می‌دهد.

bool

نشان می‌دهد که آیا آن مکان یک کسب و کار صرفاً خدماتی است یا خیر. کسب و کار صرفاً خدماتی، کسب و کاری است که مستقیماً از مشتریان بازدید می‌کند یا به آنها کالا تحویل می‌دهد، اما به مشتریان در آدرس محل کارشان خدمات ارائه نمی‌دهد. به عنوان مثال، کسب و کارهایی مانند خدمات نظافت یا لوله‌کشی. این کسب و کارها ممکن است آدرس فیزیکی یا مکانی در نقشه گوگل نداشته باشند.

bool

این مکان پارکینگ با دسترسی آسان به ویلچر ارائه می‌دهد.

bool

ورودی مکان‌ها برای افراد دارای صندلی چرخدار مناسب است.

bool

این مکان دارای سرویس بهداشتی مناسب برای ویلچر است.

bool

این مکان دارای صندلی‌های مناسب برای ویلچر است.

string

توضیحات متنی کامل یا نام کامپوننت آدرس. برای مثال، یک کامپوننت آدرس برای کشور استرالیا ممکن است نام طولانی "Australia" داشته باشد.

string

یک نام متنی مختصر برای مؤلفه آدرس، در صورت وجود. برای مثال، یک مؤلفه آدرس برای کشور استرالیا ممکن است نام کوتاه "AU" داشته باشد.

string

آرایه‌ای که نوع(های) مؤلفه آدرس را نشان می‌دهد.

string

زبانی که برای قالب‌بندی این مؤلفه‌ها استفاده می‌شود، با نمادگذاری CLDR.

string

نام ارائه‌دهنده‌ی داده‌های مکان.

string

آدرس اینترنتی (URI) به ارائه دهنده داده مکان.

string

نمای کلی پیام هشدار به مصرف‌کننده.

Details

جزئیات پیام هشدار به مصرف‌کننده.

string

کد زبان پیام هشدار به مصرف‌کننده. این یک کد زبان BCP 47 است.

string

عنوانی که به همراه توضیحات نمایش داده می‌شود.

string

شرح پیام هشدار به مصرف‌کننده.

Link

لینکی که باید نمایش داده شود به همراه توضیحاتی برای ارائه اطلاعات بیشتر.

string

عنوانی که برای لینک نمایش داده می‌شود.

string

آدرس اینترنتی (url) لینک.

string

نام منبع مکانی که این مکان در آن واقع شده است.

string

شناسه مکان مکانی که این مکان در آن واقع شده است.

ContentBlock

مروری بر امکانات رفاهی موجود. ارائه این امکانات تضمین شده است.

ContentBlock

خلاصه‌ای از گزینه‌های قهوه در نزدیکی.

ContentBlock

خلاصه‌ای از رستوران‌های اطراف

ContentBlock

خلاصه‌ای از فروشگاه‌های اطراف

string

پیوندی که کاربران می‌توانند در آن مشکل خلاصه را علامت‌گذاری کنند.

LocalizedText

پیام افشای هوش مصنوعی "خلاصه شده با Gemini" (و انواع بومی‌شده‌ی آن). در صورت وجود، این پیام به زبانی که در درخواست مشخص شده است، خواهد بود.

LocalizedText

نمای کلی مکان.

string

پیوندی که کاربران می‌توانند در آن، مشکل مربوط به خلاصه‌ی مرور کلی را علامت‌گذاری کنند.

LocalizedText

پیام افشای هوش مصنوعی "خلاصه شده با Gemini" (و انواع بومی‌شده‌ی آن). در صورت وجود، این پیام به زبانی که در درخواست مشخص شده است، خواهد بود.

string

لینکی برای نمایش مسیر رسیدن به آن مکان. این لینک فقط مکان مقصد را نمایش می‌دهد و از حالت سفر پیش‌فرض DRIVE استفاده می‌کند.

string

لینکی برای نمایش این مکان.

string

لینکی برای نوشتن نقد و بررسی این مکان در نقشه گوگل.

string

پیوندی برای نمایش نظرات مربوط به این مکان در نقشه‌های گوگل.

string

لینکی برای نمایش عکس‌های این مکان در نقشه گوگل.

ContentBlock

خلاصه‌ای از وضعیت محله.

ContentBlock

شرح مفصلی از محله.

string

پیوندی که کاربران می‌توانند در آن مشکل خلاصه را علامت‌گذاری کنند.

LocalizedText

پیام افشای هوش مصنوعی "خلاصه شده با Gemini" (و انواع بومی‌شده‌ی آن). در صورت وجود، این پیام به زبانی که در درخواست مشخص شده است، خواهد بود.

Period

دوره‌هایی که این مکان در طول هفته باز است. دوره‌ها به ترتیب زمانی، در منطقه زمانی مکانی-محلی هستند. مقدار خالی (اما نه غایب) نشان دهنده مکانی است که هرگز باز نیست، مثلاً به دلیل اینکه به طور موقت برای بازسازی بسته شده است.

روز شروع periods ثابت نیست و نباید یکشنبه فرض شود. API روز شروع را بر اساس عوامل مختلفی تعیین می‌کند. به عنوان مثال، برای یک کسب و کار 24 ساعته، اولین دوره ممکن است از روز درخواست شروع شود. برای سایر مشاغل، ممکن است اولین روز هفته‌ای باشد که باز هستند.

نکته: ترتیب آرایه‌ی periods مستقل از ترتیب آرایه‌ی weekday_descriptions است. فرض نکنید که آن‌ها از یک روز شروع می‌شوند.

string

رشته‌های محلی که ساعات کاری این مکان را توصیف می‌کنند، یک رشته برای هر روز هفته.

نکته: ترتیب روزها و شروع هفته توسط زبان و منطقه تعیین می‌شود. ترتیب آرایه periods مستقل از ترتیب آرایه weekday_descriptions است. فرض نکنید که آنها در همان روز شروع می‌شوند.

اگر ساعات مشخص نباشد یا نتوان آن را به متن محلی تبدیل کرد، خالی خواهد بود. مثال: "یکشنبه: ۱۸:۰۰–۰۶:۰۰"

SecondaryHoursType

یک رشته نوع که برای شناسایی نوع ساعات ثانویه استفاده می‌شود.

SpecialDay

اطلاعات ساختاریافته برای روزهای خاص که در بازه زمانی ساعات کاری اعلام‌شده قرار می‌گیرند. روزهای خاص، روزهایی هستند که می‌توانند بر ساعات کاری یک مکان تأثیر بگذارند، مثلاً روز کریسمس. اگر ساعات کاری استثنایی وجود دارد، برای current_opening_hours و current_secondary_opening_hours تنظیم کنید.

Timestamp

دفعه بعد که دوره ساعات کاری فعلی شروع می‌شود، حداکثر تا ۷ روز آینده. این فیلد فقط در صورتی پر می‌شود که دوره ساعات کاری در زمان ارائه درخواست فعال نباشد.

Timestamp

دفعه بعد که دوره ساعات کاری فعلی تا ۷ روز آینده به پایان می‌رسد. این فیلد فقط در صورتی پر می‌شود که دوره ساعات کاری در زمان ارائه درخواست فعال باشد.

bool

اینکه آیا دوره ساعات کاری در حال حاضر فعال است یا خیر. برای ساعات کاری معمول و ساعات کاری فعلی، این فیلد به این معنی است که آیا مکان باز است یا خیر. برای ساعات کاری ثانویه و ساعات کاری ثانویه فعلی، این فیلد به این معنی است که آیا ساعات کاری ثانویه این مکان فعال است یا خیر.

Point

زمانی که مکان شروع به باز شدن می‌کند.

Point

زمانی که مکان شروع به بسته شدن می‌کند.

Date

تاریخ در منطقه زمانی محلی برای آن مکان.

bool

اینکه آیا این نقطه پایانی کوتاه شده است یا خیر. کوتاه‌سازی زمانی اتفاق می‌افتد که ساعات واقعی خارج از زمان‌هایی باشند که ما مایل به بازگرداندن ساعات بین آنها هستیم، بنابراین ساعات را به این مرزها برمی‌گردانیم. این تضمین می‌کند که حداکثر ۲۴ ساعت از نیمه‌شب روز درخواست، بازگردانده شوند.

int32

یک روز از هفته، به صورت یک عدد صحیح در محدوده ۰ تا ۶. ۰ یعنی یکشنبه، ۱ یعنی دوشنبه و غیره.

int32

ساعت در قالب ۲۴ ساعته. از ۰ تا ۲۳ متغیر است.

int32

دقیقه. از ۰ تا ۵۹ متغیر است.

Date

تاریخ این روز خاص.

bool

این مکان پارکینگ رایگان ارائه می‌دهد.

bool

مکان، پارکینگ‌های پولی ارائه می‌دهد.

bool

این مکان پارکینگ خیابانی رایگان ارائه می‌دهد.

bool

این مکان پارکینگ خیابانی پولی ارائه می‌دهد.

bool

این مکان پارکینگ اختصاصی ارائه می‌دهد.

bool

این مکان پارکینگ گاراژ رایگان ارائه می‌دهد.

bool

این مکان پارکینگ گاراژ پولی ارائه می‌دهد.

bool

سایت Place کارت‌های اعتباری را به عنوان پرداخت می‌پذیرد.

bool

سایت Place کارت‌های نقدی را به عنوان پرداخت می‌پذیرد.

bool

مکان فقط پول نقد را به عنوان پرداخت می‌پذیرد. مکان‌هایی با این ویژگی ممکن است همچنان روش‌های پرداخت دیگری را بپذیرند.

bool

سایت Place پرداخت‌های NFC را می‌پذیرد.

string

کد سراسری (کامل) یک مکان، مانند "9FWM33GV+HQ"، که نشان‌دهنده‌ی منطقه‌ای با ابعاد ۱/۸۰۰۰ در ۱/۸۰۰۰ درجه (حدود ۱۴ در ۱۴ متر) است.

string

کد مرکب مکان، مانند "33GV+HQ, Ramberg, Norway"، که شامل پسوند کد جهانی است و پیشوند را با نام قالب‌بندی‌شده‌ی یک موجودیت مرجع جایگزین می‌کند.

LocalizedText

خلاصه نظرات کاربران.

string

پیوندی که کاربران می‌توانند در آن مشکل خلاصه را علامت‌گذاری کنند.

LocalizedText

پیام افشای هوش مصنوعی "خلاصه شده با Gemini" (و انواع بومی‌شده‌ی آن). در صورت وجود، این پیام به زبانی که در درخواست مشخص شده است، خواهد بود.

string

پیوندی برای نمایش نظرات مربوط به این مکان در نقشه‌های گوگل.

string

نام منبعِ زیرمقصد.

string

شناسه مکانِ زیرمقصد.

string

یک چندخطی کدگذاری شده ، همانطور که به طور پیش‌فرض توسط API مسیرها برگردانده می‌شود. به ابزارهای کدگذاری و رمزگشایی مراجعه کنید.

Money

پایین‌ترین حدِ محدوده‌ی قیمت (شامل). قیمت باید معادل یا بالاتر از این مقدار باشد.

Money

بالاترین قیمت در بازه قیمتی (اختصاصی). قیمت باید کمتر از این مقدار باشد.

string

مرجعی که نشان‌دهنده‌ی نقد این مکان است و می‌تواند برای جستجوی مجدد این نقد مکان مورد استفاده قرار گیرد (همچنین با نام "منبع" API شناخته می‌شود: places/{place_id}/reviews/{review} ).

string

رشته‌ای از زمان اخیر با قالب‌بندی مشخص که زمان بررسی را نسبت به زمان فعلی به شکلی مناسب برای زبان و کشور بیان می‌کند.

LocalizedText

متن بومی‌سازی‌شده‌ی نقد.

LocalizedText

متن نقد به زبان اصلی.

double

عددی بین ۱.۰ تا ۵.۰ که به آن تعداد ستاره‌ها نیز می‌گویند.

AuthorAttribution

نویسنده‌ی این نقد.

Timestamp

مهر زمانی برای بررسی.

string

لینکی که کاربران می‌توانند در آن مشکل مربوط به نقد و بررسی را علامت‌گذاری کنند.

string

لینکی برای نمایش نقد و بررسی روی نقشه گوگل.

Date

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

bool

Optional. When set to true, avoids toll roads where reasonable, giving preference to routes not containing toll roads. Applies only to the DRIVE and TWO_WHEELER TravelMode .

bool

Optional. When set to true, avoids highways where reasonable, giving preference to routes not containing highways. Applies only to the DRIVE and TWO_WHEELER TravelMode .

bool

Optional. When set to true, avoids ferries where reasonable, giving preference to routes not containing ferries. Applies only to the DRIVE and TWO_WHEELER TravelMode .

bool

Optional. When set to true, avoids navigating indoors where reasonable, giving preference to routes not containing indoor navigation. Applies only to the WALK TravelMode .

LatLng

Optional. An explicit routing origin that overrides the origin defined in the polyline. By default, the polyline origin is used.

TravelMode

Optional. The travel mode.

RouteModifiers

Optional. The route modifiers.

RoutingPreference

Optional. Specifies how to compute the routing summaries. The server attempts to use the selected routing preference to compute the route. The traffic aware routing preference is only available for the DRIVE or TWO_WHEELER travelMode .

Leg

The legs of the trip.

When you calculate travel duration and distance from a set origin, legs contains a single leg containing the duration and distance from the origin to the destination. When you do a search along route, legs contains two legs: one from the origin to place, and one from the place to the destination.

string

A link to show directions on Google Maps using the waypoints from the given routing summary. The route generated by this link is not guaranteed to be the same as the route used to generate the routing summary. The link uses information provided in the request, from fields including routingParameters and searchAlongRouteParameters when applicable, to generate the directions link.

Duration

The time it takes to complete this leg of the trip.

int32

The distance of this leg of the trip.

string

Place details will be displayed with the preferred language if available. If the language code is unspecified or unrecognized, place details of any language may be returned, with a preference for English if such details exist.

Current list of supported languages: https://developers.google.com/maps/faq#languagesupport .

string

The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law.

For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html .

Note that 3-digit region codes are not currently supported.

string

Included Place type (eg, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types .

Up to 50 types from Table A may be specified.

If there are any conflicting types, ie a type appears in both included_types and excluded_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

string

Excluded Place type (eg, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types .

Up to 50 types from Table A may be specified.

If the client provides both included_types (eg restaurant) and excluded_types (eg cafe), then the response should include places that are restaurant but not cafe. The response includes places that match at least one of the included_types and none of the excluded_types.

If there are any conflicting types, ie a type appears in both included_types and excluded_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

string

Included primary Place type (eg "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types . A place can only have a single primary type from the supported types table associated with it.

Up to 50 types from Table A may be specified.

If there are any conflicting primary types, ie a type appears in both included_primary_types and excluded_primary_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

string

Excluded primary Place type (eg "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types .

Up to 50 types from Table A may be specified.

If there are any conflicting primary types, ie a type appears in both included_primary_types and excluded_primary_types, an INVALID_ARGUMENT error is returned.

If a Place type is specified with multiple type restrictions, only places that satisfy all of the restrictions are returned. For example, if we have {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, the returned places provide "restaurant" related services but do not operate primarily as "restaurants".

int32

Maximum number of results to return. It must be between 1 and 20 (default), inclusively. If the number is unset, it falls back to the upper limit. If the number is set to negative or exceeds the upper limit, an INVALID_ARGUMENT error is returned.

LocationRestriction

Required. The region to search.

RankPreference

How results will be ranked in the response.

RoutingParameters

Optional. Parameters that affect the routing to the search results.

Circle

A circle defined by center point and radius.

Place

A list of places that meets user's requirements like places types, number of places and specific location restriction.

RoutingSummary

A list of routing summaries where each entry associates to the corresponding place in the same index in the places field. If the routing summary is not available for one of the places, it will contain an empty entry. This list should have as many entries as the list of places if requested.

string

Required. The text query for textual search.

string

Place details will be displayed with the preferred language if available. If the language code is unspecified or unrecognized, place details of any language may be returned, with a preference for English if such details exist.

Current list of supported languages: https://developers.google.com/maps/faq#languagesupport .

string

The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law.

For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html .

Note that 3-digit region codes are not currently supported.

RankPreference

How results will be ranked in the response.

string

The requested place type. Full list of types supported: https://developers.google.com/maps/documentation/places/web-service/place-types . Only support one included type.

bool

Used to restrict the search to places that are currently open. The default is false.

double

Filter out results whose average user rating is strictly less than this limit. A valid value must be a float between 0 and 5 (inclusively) at a 0.5 cadence ie [0, 0.5, 1.0, ... , 5.0] inclusively. The input rating will round up to the nearest 0.5(ceiling). For instance, a rating of 0.6 will eliminate all results with a less than 1.0 rating.

int32

Deprecated: Use page_size instead.

The maximum number of results per page that can be returned. If the number of available results is larger than max_result_count , a next_page_token is returned which can be passed to page_token to get the next page of results in subsequent requests. If 0 or no value is provided, a default of 20 is used. The maximum value is 20; values above 20 will be coerced to 20. Negative values will return an INVALID_ARGUMENT error.

If both max_result_count and page_size are specified, max_result_count will be ignored.

int32

Optional. The maximum number of results per page that can be returned. If the number of available results is larger than page_size , a next_page_token is returned which can be passed to page_token to get the next page of results in subsequent requests. If 0 or no value is provided, a default of 20 is used. The maximum value is 20; values above 20 will be set to 20. Negative values will return an INVALID_ARGUMENT error.

If both max_result_count and page_size are specified, max_result_count will be ignored.

string

Optional. A page token, received from a previous TextSearch call. Provide this to retrieve the subsequent page.

When paginating, all parameters other than page_token , page_size , and max_result_count provided to TextSearch must match the initial call that provided the page token. Otherwise an INVALID_ARGUMENT error is returned.

PriceLevel

Used to restrict the search to places that are marked as certain price levels. Users can choose any combinations of price levels. Default to select all price levels.

bool

Used to set strict type filtering for included_type. If set to true, only results of the same type will be returned. Default to false.

LocationBias

The region to search. This location serves as a bias which means results around given location might be returned. Cannot be set along with location_restriction.

LocationRestriction

The region to search. This location serves as a restriction which means results outside given location will not be returned. Cannot be set along with location_bias.

EVOptions

Optional. Set the searchable EV options of a place search request.

RoutingParameters

Optional. Additional parameters for routing to results.

SearchAlongRouteParameters

Optional. Additional parameters proto for searching along a route.

bool

Optional. Include pure service area businesses if the field is set to true. Pure service area business is a business that visits or delivers to customers directly but does not serve customers at their business address. For example, businesses like cleaning services or plumbers. Those businesses do not have a physical address or location on Google Maps. Places will not return fields including location , plus_code , and other location related fields for these businesses.

double

Optional. Minimum required charging rate in kilowatts. A place with a charging rate less than the specified rate is filtered out.

EVConnectorType

Optional. The list of preferred EV connector types. A place that does not support any of the listed connector types is filtered out.

Viewport

A rectangle box defined by northeast and southwest corner. rectangle.high() must be the northeast point of the rectangle viewport. rectangle.low() must be the southwest point of the rectangle viewport. rectangle.low().latitude() cannot be greater than rectangle.high().latitude() . This will result in an empty latitude range. A rectangle viewport cannot be wider than 180 degrees.

Circle

A circle defined by center point and radius.

Viewport

A rectangle box defined by northeast and southwest corner. rectangle.high() must be the northeast point of the rectangle viewport. rectangle.low() must be the southwest point of the rectangle viewport. rectangle.low().latitude() cannot be greater than rectangle.high().latitude() . This will result in an empty latitude range. A rectangle viewport cannot be wider than 180 degrees.

Polyline

Required. The route polyline.

Place

A list of places that meet the user's text search criteria.

RoutingSummary

A list of routing summaries where each entry associates to the corresponding place in the same index in the places field. If the routing summary is not available for one of the places, it will contain an empty entry. This list will have as many entries as the list of places if requested.

ContextualContent

Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative for more details.

A list of contextual contents where each entry associates to the corresponding place in the same index in the places field. The contents that are relevant to the text_query in the request are preferred. If the contextual content is not available for one of the places, it will return non-contextual content. It will be empty only when the content is unavailable for this place. This list will have as many entries as the list of places if requested.

string

A token that can be sent as page_token to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.

string

A link allows the user to search with the same text query as specified in the request on Google Maps.