نمای کلی 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 زیر در دسترس هستند:

  • v1 : پایدار.

پیش نمایش توسعه دهنده

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