این صفحه مروری بر نحوه استفاده از Google Chat API و مستندات مرجع آن ارائه میدهد.
API چت گوگل هم رابطهای gRPC و هم REST و کتابخانههای کلاینتی دارد که از هر دو پشتیبانی میکنند. در صورت تمایل، اگر کتابخانههای کلاینت ارائه شده نیازهای شما را برآورده نمیکنند، میتوانید کتابخانههای کلاینت خودتان را بنویسید که از رابط gRPC یا REST استفاده میکنند.
کتابخانههای کلاینت
روش پیشنهادی اکثر توسعهدهندگان برای فراخوانی API گوگل چت، استفاده از کتابخانههای کلاینت ابری رسمی ما برای زبان مورد نظر شما، مانند پایتون، جاوا یا Node.js است.
اگر با Google Apps Script کدنویسی میکنید، به جای نصب کتابخانه کلاینت، از سرویس Advanced Chat استفاده کنید.
نام نوع، متد و فیلد
بسته به اینکه از کتابخانههای کلاینت، gRPC یا REST استفاده میکنید، نوع، متد و نام فیلدها برای API چت گوگل تا حدودی متفاوت است:
- کتابخانههای کلاینت ابری بر اساس سرویسهای gRPC و متدهای آنها مرتب شدهاند. کتابخانههای کلاینت API گوگل به صورت سرویسهایی مرتب شدهاند که شامل اشیاء یا کلاسهایی هستند که با منابع REST مطابقت دارند و آنها نیز شامل متدهای مربوطه هستند.
- gRPC بر اساس سرویسها و متدهای آنها مرتب شده است.
- REST بر اساس سلسله مراتب منابع و متدهای آنها مرتب شده است.
- نام فیلدهای gRPC از حالت مار مانند استفاده میکند.
- نام فیلدهای REST از حالت شتری (camel case) استفاده میکنند، هرچند سرویس API هم حالت شتری (camel case) و هم حالت مار (snake case) را میپذیرد.
- نامهای فیلدهای کتابخانه کلاینت، بسته به اینکه کدام نام برای زبان اصطلاحی باشد، از یکی از حالتهای عنوان، شتری یا ماری استفاده میکنند.
بافرهای پروتکل
چه از کتابخانههای کلاینت، REST یا gRPC استفاده کنید، سرویس اصلی با استفاده از بافرهای پروتکل تعریف میشود. به طور خاص، این سرویس از proto3 استفاده میکند.
هنگام فراخوانی API، برخی از فیلدهای درخواست یا پاسخ ممکن است نیاز به درک اولیهای از انواع شناختهشده بافر پروتکل داشته باشند.
علاوه بر این، هنگام فراخوانی REST API، رفتار مقدار پیشفرض برای بافرهای پروتکل ممکن است منجر به از دست رفتن فیلدها در پاسخ JSON شود. این فیلدها روی مقدار پیشفرض تنظیم شدهاند، بنابراین در پاسخ گنجانده نمیشوند.
نسخههای API
نسخههای API زیر موجود است:
- نسخه ۱ : پایدار.
پیشنمایش توسعهدهنده
در مستندات، ممکن است متدها یا فیلدهای API را ببینید که فقط از طریق برنامه پیشنمایش توسعهدهندگان در دسترس هستند. برای آزمایش و پیشنمایش و ارائه بازخورد در مورد آخرین ویژگیهای پیشنمایش، به برنامه پیشنمایش توسعهدهندگان بپیوندید.