نمای کلی Google Chat API
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
این صفحه نمای کلی از نحوه استفاده از Google Chat API و مستندات مرجع آن را ارائه می دهد.
Google Chat API دارای هر دو رابط gRPC و REST و کتابخانه های مشتری است که از هر دو پشتیبانی می کنند. به صورت اختیاری، اگر کتابخانه های مشتری ارائه شده نیازهای شما را برآورده نمی کند، می توانید کتابخانه های مشتری خود را بنویسید که از رابط gRPC یا REST استفاده می کنند.
کتابخانه های مشتری
روش توصیه شده برای اکثر توسعه دهندگان برای فراخوانی Google Chat API با کتابخانه های Cloud Client ما برای زبان دلخواه شما مانند Python، جاوا یا Node.js است.
اگر با Google Apps Script کدنویسی می کنید، به جای نصب کتابخانه سرویس گیرنده، از سرویس گفتگوی پیشرفته استفاده کنید.
نوع، روش و نام فیلدها
بسته به اینکه از کتابخانه های سرویس گیرنده، gRPC یا REST استفاده می کنید، نوع، روش و نام فیلدها برای Google Chat API تا حدودی متفاوت است:
- کتابخانه های سرویس گیرنده ابری توسط سرویس های gRPC و روش های آنها مرتب شده اند. Google API Client Libraries به‌عنوان سرویس‌هایی مرتب شده‌اند که حاوی اشیاء یا کلاس‌هایی هستند که با منابع REST مطابقت دارند، که حاوی متدهای مربوطه نیز هستند.
- gRPC بر اساس سرویس ها و روش های آنها مرتب می شود.
- REST توسط سلسله مراتب منابع و روش های آنها مرتب می شود.
- نام فیلدهای gRPC از snake case استفاده می کند.
- نام فیلدهای REST از casel case استفاده می‌کند، اگرچه سرویس API یا casel case یا snake case را می‌پذیرد.
- بسته به اینکه کدام نام برای زبان اصطلاحی باشد، نام‌های فیلد کتابخانه مشتری از حروف عنوان، شتر یا مار استفاده می‌کنند.
بافرهای پروتکل
خواه از کتابخانه های سرویس گیرنده، REST یا gRPC استفاده می کنید، سرویس زیربنایی با استفاده از بافرهای پروتکل تعریف می شود. به طور خاص، این سرویس از proto3 استفاده می کند.
هنگام فراخوانی API، برخی از فیلدهای درخواست یا پاسخ می‌توانند به درک اولیه از انواع شناخته شده بافر پروتکل نیاز داشته باشند.
علاوه بر این، هنگام فراخوانی REST API، رفتار مقدار پیش‌فرض برای بافرهای پروتکل ممکن است منجر به گم شدن فیلدها در پاسخ JSON شود. این فیلدها روی مقدار پیش فرض تنظیم شده اند، بنابراین در پاسخ گنجانده نمی شوند.
نسخه های API
نسخه های API زیر در دسترس هستند:
پیش نمایش توسعه دهنده
در مستندات، ممکن است روش‌ها یا فیلدهای API را ببینید که فقط از طریق برنامه پیش‌نمایش برنامه‌نویس در دسترس هستند. برای آزمایش و پیش نمایش و ارائه بازخورد در مورد آخرین ویژگی های پیش نمایش، به برنامه پیش نمایش برنامه نویس بپیوندید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eThis page offers guidance on utilizing the Google Chat API and navigating its reference documentation, including gRPC and REST interfaces.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers are encouraged to use the provided client libraries for Python, Java, Node.js, or the Advanced Chat service for Google Apps Script.\u003c/p\u003e\n"],["\u003cp\u003eType, method, and field names may vary slightly depending on whether you are using client libraries, gRPC, or REST, with details provided on their respective conventions.\u003c/p\u003e\n"],["\u003cp\u003eThe Google Chat API is built upon protocol buffers, specifically proto3, which may require a basic understanding for certain request and response fields.\u003c/p\u003e\n"],["\u003cp\u003eStable API version v1 is currently available, with access to developer preview features obtainable through the Developer Preview Program.\u003c/p\u003e\n"]]],["The Google Chat API offers gRPC and REST interfaces, with corresponding client libraries or the option to create custom ones. Developers can use Cloud Client Libraries, or the Advanced Chat service with Google Apps Script. Type, method, and field names vary across libraries, gRPC, and REST. The API relies on protocol buffers (proto3), which can impact JSON responses due to default value behavior. The current stable version is v1, with a Developer Preview program for testing new features.\n"],null,["# Google Chat API overview\n\nThis page provides an overview of how to use Google Chat API and its reference\ndocumentation.\n\nGoogle Chat API has both [gRPC](/workspace/chat/api/reference/rpc) and\n[REST](/workspace/chat/api/reference/rest) interfaces, and\n[client libraries](/workspace/chat/libraries) that support both. Optionally, if\nthe provided client libraries don't meet your needs, you can write your own\nclient libraries that use the gRPC or REST interface.\n\nClient libraries\n----------------\n\nThe recommended way for most developers to call the Google Chat API\nis with our officially supported\n[Cloud Client Libraries](/workspace/chat/libraries)\nfor your preferred language, like Python, Java, or Node.js.\n\nIf you're coding with Google Apps Script, use the\n[Advanced Chat service](/apps-script/advanced/chat)\ninstead of installing a client library.\n\nType, method, and field names\n-----------------------------\n\nDepending on whether you're using client libraries, gRPC, or REST, the type,\nmethod, and field names for the Google Chat API vary somewhat:\n\n- Cloud Client Libraries are arranged by gRPC services and their methods. Google API Client Libraries are arranged as services that contain objects or classes that correspond with REST resources, which also contain corresponding methods.\n- gRPC is arranged by services and their methods.\n- REST is arranged by resource hierarchies and their methods.\n- gRPC field names use snake case.\n- REST field names use camel case, though the API service will accept either camel case or snake case.\n- Client library field names use either title case, camel case or snake case, depending on which name is idiomatic for the language.\n\nProtocol buffers\n----------------\n\nWhether you are using client libraries, REST, or gRPC, the underlying service is\ndefined using [protocol buffers](/protocol-buffers). In particular, the service\nuses [proto3](/protocol-buffers/docs/proto3).\n\nWhen calling the API, some request or response fields can require a basic\nunderstanding of\n[protocol buffer well-known types](/protocol-buffers/docs/reference/google.protobuf).\n\nIn addition, when calling the REST API, the\n[default value](/protocol-buffers/docs/proto3#default) behavior for protocol\nbuffers may result in missing fields in a JSON response. These fields are\nset to the default value, so they are not included in the response.\n\nAPI versions\n------------\n\nThe following API versions are available:\n\n- **v1**: Stable.\n\nDeveloper Preview\n-----------------\n\nIn the documentation, you might see API methods or fields that are only\navailable through the Developer Preview Program. To test and preview and offer\nfeedback on the latest preview features, join the\n[Developer Preview Program](/workspace/preview).\n\nRelated topics\n--------------\n\n- [Call the Google Chat API](/workspace/chat/api-overview)"]]
