ספריות הלקוח של Google Chat API

ספריות הלקוח משפרות את חוויית הפיתוח של קריאות ל-Google Chat API על ידי צמצום הקוד הסטנדרטי שצריך לכתוב. במדריך הזה נסביר על ספריות הלקוח ונראה איך להתקין אותן.

ל-Chat API יש ממשקי gRPC ו-REST, וספריות לקוח שתומכות בשניהם. ספריות הלקוח ב-Cloud תומכות בממשקי gRPC ו-REST, וספריות הלקוח של Google API תומכות רק בממשק ה-REST, אבל אפשר להשתמש בשתי ספריות הלקוח באותו פרויקט. אם ספריות הלקוח שסופקו לא עומדות בצרכים שלכם, תוכלו לכתוב ספריות לקוח משלכם שמשתמשות בממשק gRPC או REST.

למידע נוסף על סוגי ספריות הלקוח שבהן Google תומכת, ראו הסבר על ספריות לקוח.

התקנת ספריות הלקוח של Cloud (מומלץ)

ספריות הלקוח ב-Cloud הן ספריות הלקוח העדכניות והמומלצות לקריאה ל-Chat API. ספריות הלקוח של Cloud תומכות בממשקי gRPC ו-REST.

ל-Chat API יש ספריות לקוח ב-Cloud בשפות הבאות. בוחרים את השפה שבה רוצים להשתמש:

Node.js

כדי להתקין את ספריית הלקוח:

npm install @google-apps/chat

למידע נוסף:

Python

כדי להתקין את ספריית הלקוח:

python -m venv <your-env>
source <your-env>/bin/activate
pip install google-apps-chat

למידע נוסף:

Java

בוחרים את סביבת ה-build מהכרטיסיות הבאות. בכל אחת מהגרסאות, חשוב לזכור לעדכן את הגרסה למהדורה האחרונה שזמינה ב-GitHub.

Maven עם BOM

אם משתמשים ב-Maven עם BOM, צריך להוסיף את הקוד הבא לקובץ pom.xml:

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>com.google.cloud</groupId>
        <artifactId>libraries-bom</artifactId>
        <version>26.42.0</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>google-cloud-chat</artifactId>
    </dependency>

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-chat</artifactId>
  <version>0.10.0</version>
</dependency>

Maven ללא BOM

אם משתמשים ב-Maven בלי BOM, צריך להוסיף את הקוד הבא ליחסי התלות:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-chat</artifactId>
  <version>0.9.0</version>
</dependency>

Gradle

אם משתמשים ב-Gradle בלי BOM, צריך להוסיף את הקוד הבא ליחסי התלות:

implementation 'com.google.cloud:google-cloud-chat:0.10.0'

SBT

אם משתמשים ב-SBT, צריך להוסיף את הקוד הבא ליחסי התלות:

libraryDependencies += "com.google.cloud" % "google-cloud-chat" % "0.10.0"

למידע נוסף:

Go

מייבאים את חבילות Go לשירותי Google Cloud.

import "cloud.google.com/go"

כדי להתקין את החבילה במערכת:

  1. עוברים לספריית הפרויקט: cd /my/cloud/project.
  2. מורידים את החבילה שבה רוצים להשתמש:
go get cloud.google.com/go/chat

למידע נוסף:

Ruby

כדי להתקין את ספריית הלקוח:

gem install google-apps-chat

למידע נוסף:

PHP

כדי להתקין את ספריית הלקוח:

  1. אם צריך, מתקינים את מנהל יחסי התלות Composer.
  2. מריצים את הפקודה הבאה בממשק שורת הפקודה:
composer require google/apps-chat

למידע נוסף:

‎.NET

כדי להתקין את ספריית הלקוח:

מתקינים את החבילה Google.Apps.Chat.V1 מ-NuGet. מוסיפים אותה לפרויקט בדרך הרגילה (לדוגמה, לוחצים לחיצה ימנית על הפרויקט ב-Visual Studio ובוחרים באפשרות Manage NuGet Packages…). חשוב להפעיל את החבילות של הגרסאות המקדימות (למשל, בממשק המשתמש של Visual Studio NuGet, מסמנים את התיבה 'הכללת גרסאות מקדימות').

כדי להתקין את חבילת NuGet, אפשר להיכנס אל Google.Apis ב-NuGet.org.

למידע נוסף:

התקנת ספריות הלקוח של Google API

ספריות הלקוח של Google API הן חלופה לספריות הלקוח ב-Cloud, ומספקות גישה פרוגרמטית ל-Chat API באמצעות משאבים ושיטות של REST. כדאי להשתמש בספריות הלקוח של Google API אם אתם משתמשים בשפה שאין לה ספריית לקוח ב-Cloud, או אם אתם מרחיבים פרויקט שכבר משתמש בהן.

ב-Chat API יש ספריות לקוח של Google API בשפות הבאות: בוחרים את השפה שבה רוצים להשתמש:

Go

אתם יכולים לקבל את ספריית הלקוח העדכנית של Google Chat API ל-Go (אלפא). בנוסף, כדאי לעיין במדריך למפתחים של ספריית הלקוח.

Java

בדף הזה נסביר על תחילת השימוש ב-Google Chat API באמצעות ספריית הלקוח של Google API ל-Java. מידע נוסף זמין במשאבי העזרה הבאים:

הוספה של ספריית הלקוח לפרויקט

קובעים את סביבת ה-build ‏(Maven או Gradle) לפי הכרטיסיות הבאות:

JavaScript

כדאי לעיין במדריך למפתחים של ספריית הלקוח.

‎.NET

בדף הזה נסביר על תחילת השימוש ב-Google Chat API באמצעות ספריית הלקוח של Google API עבור ‎ .NET. מידע נוסף זמין במשאבי העזרה הבאים:

הורדה של הספרייה

מתקינים את החבילה של NuGet:‏ Google.Apis.

Node.js

אתם יכולים לקבל את ספריית הלקוח העדכנית של Google Chat API ל-Node.js. בנוסף, כדאי לעיין במדריך למפתחים של ספריית הלקוח.

Obj-C

אתם יכולים לקבל את ספריית הלקוח העדכנית של Google Chat API ל-Objective-C. בנוסף, כדאי לעיין במדריך למפתחים של ספריית הלקוח.

PHP

אתם יכולים לקבל את ספריית הלקוח העדכנית של Google Chat API ל-PHP. בנוסף, כדאי לעיין במדריך למפתחים של ספריית הלקוח.

Python

בדף הזה נסביר על תחילת השימוש ב-Google Chat API באמצעות ספריית הלקוח של Google API ל-Python. מידע נוסף זמין במשאבי העזרה הבאים:

דרישות מערכת

התקנה של ספריית הלקוח

אפשר להשתמש במנהל חבילות או להוריד ולהתקין באופן ידני את ספריית הלקוח של Python:

התקנה מנוהלת

כדי לנהל את ההתקנה, השתמשו ב-pip או ב-setuptools. יכול להיות שקודם כול תצטרכו להריץ את הפקודה sudo.

  • ‫pip (האפשרות המועדפת): 
    pip install --upgrade google-api-python-client
  • ‏Setuptools: 
    easy_install --upgrade google-api-python-client

התקנה ידנית

  1. מורידים את ספריית הלקוח העדכנית של Python.
  2. פורקים את הקוד.
  3. מתקינים את: 
    python setup.py install

App Engine

מאחר שספריות הלקוח של Python לא מותקנות בסביבת זמן הריצה של Python ב-App Engine, עליכם להעתיק אותן לאפליקציה – בדומה לספריות של צד שלישי.

Ruby

בדף הזה נסביר על תחילת השימוש ב-Google Chat API באמצעות ספריית הלקוח של Google API ל-Ruby. מידע נוסף זמין במשאבי העזרה הבאים:

התקנה של gem‏ google-api-client

בהתאם למערכת שלכם, יכול להיות שתצטרכו להוסיף sudo לתחילת הפקודות האלה.

אם עדיין לא התקנתם את ספריית הלקוח של Google API ל-Ruby, התקינו אותה באמצעות RubyGems: 

gem install google-api-client

אם כבר התקנתם את ה-gem, הורידו את הגרסה העדכנית: 

gem update -y google-api-client

תחילת השימוש בספריית הלקוח של Google API ל-Ruby

כדי ללמוד איך ליצור את הבקשה הראשונה, היעזרו במדריך לתחילת השימוש.

Apps Script וספריות לקוח

הדרך המומלצת לרוב המפתחים לבצע קריאה ל-Google Chat API היא באמצעות ספריות הלקוח של Cloud הנתמכות באופן רשמי בשפה המועדפת עליכם, כמו Python,‏ Java או Node.js.

אם אתם כותבים קוד באמצעות Google Apps Script, תוכלו להשתמש בשירות Chat המתקדם במקום להתקין ספריית לקוח.

אימות

כדי לקרוא ל-Chat API נדרש אימות. כל שיטה של Chat API דורשת אימות משתמש (כדי לבצע פעולות או לגשת לנתונים בשם משתמש) או אימות אפליקציה (כדי לבצע פעולות או לגשת לנתונים כאפליקציית Chat). שיטות מסוימות תומכות גם באימות משתמשים וגם באימות אפליקציות.

למידע נוסף על אימות ב-Chat, קראו את הסקירה הכללית על אימות.