הוראות לביצוע הגדרות

אם אתם לא משתמשים בספרייה שנוצרה, אפשר להוריד בקובץ ZIP את ספריית הלקוח של Google API ל-Java ואת יחסי התלות שלה, או להשתמש ב-Maven.

ראו גם את הוראות ההגדרה של ProGuard, שהן חלק מספריית הלקוח של Google HTTP ל-Java.

הורדת הספרייה עם יחסי התלות

מורידים את קובץ ה-zip העדכני ביותר, שזמין בדף ההורדות, ומחלצים אותו במחשב. קובץ ה-zip הזה מכיל את קובצי ה-jar של הכיתות בספריית הלקוח ואת קובצי ה-jar של המקור המשויכים לכל ארטיפקט והתלות שלו. תרשימי התלות והרישיונות של הספריות השונות נמצאים בתיקיית dependencies. פרטים נוספים על תוכן ההורדה מופיעים בקובץ readme.html.

Android

אם אתם מפתחים ל-Android, וממשק Google API שבו אתם רוצים להשתמש נכלל בספריית Google Play Services, כדאי להשתמש בספריית Google Play Services כדי ליהנות מהביצועים ומהחוויה הטובים ביותר.

אם אתם משתמשים בספריית הלקוח של Google API ל-Java עם Android, חשוב לדעת אילו יחסי תלות תואמים ל-Android, ובפרט איזו רמת SDK של Android. אפליקציות ל-Android דורשות את קובצי ה-jar הבאים, או גרסאות תואמות חדשות יותר, מהתיקייה libs:

• google-api-client-2.4.0.jar
• google-api-client-android-2.4.0.jar
• google-oauth-client-1.34.1.jar
• google-http-client-1.42.2.jar
• google-http-client-android-1.42.2.jar
• gson-2.9.0.jar
• jackson-core-2.13.3.jar
• jsr305-3.0.2.jar
• protobuf-java-3.21.4.jar

אזהרה: ב-Android, חובה להציב את קובצי ה-jar בתיקייה בשם 'libs' כדי שתוכנית האריזה של ה-APK תוכל למצוא אותם. אחרת, תופיע שגיאה מסוג NoClassDefFoundError בזמן הריצה.

Google App Engine

אפליקציות Google App Engine דורשות את קובצי ה-jar הבאים, או גרסאות תואמות חדשות יותר, מהתיקייה libs:

• google-api-client-2.4.0.jar
• google-api-client-appengine-2.4.0.jar
• google-api-client-servlet-2.4.0.jar
• google-oauth-client-1.34.1.jar
• google-oauth-client-appengine-1.34.1.jar
• google-oauth-client-servlet-1.34.1.jar
• google-http-client-1.42.2.jar
• google-http-client-appengine-1.39.2.jar
• gson-2.9.0.jar
• jackson-core-2.13.3.jar
• jdo2-api-2.3-eb.jar
• jsr305-3.0.2.jar
• protobuf-java-3.21.4.jar
• transaction-api-1.1.jar
• xpp3-1.1.4c.jar

Servlet

באפליקציות Servlet נדרשים קובצי ה-jar הבאים, או גרסאות תואמות חדשות יותר, מהתיקייה libs:

• google-api-client-2.4.0.jar
• google-api-client-servlet-2.4.0.jar
• google-oauth-client-1.34.1.jar
• google-oauth-client-servlet-1.34.1.jar
• google-http-client-1.42.2.jar
• commons-logging-1.2.jar
• gson-2.9.0.jar
• httpclient-4.5.13.jar
• httpcore-4.4.12.jar
• jackson-core-2.13.3.jar
• jdo2-api-2.3-eb.jar
• jsr305-3.0.2.jar
• protobuf-java-3.21.4.jar
• transaction-api-1.1.jar
• xpp3-1.1.4c.jar

Java גנרית

לשימוש כללי באפליקציות Java, יש להשתמש בקובצי ה-Jam הבאים או בגרסאות תואמות חדשות יותר, מתיקיית libs:

• google-api-client-2.4.0.jar
• google-oauth-client-1.34.1.jar
• google-http-client-1.42.2.jar
• google-http-client-jackson2-1.39.2.jar
• commons-logging-1.2.jar
• gson-2.9.0.jar
• httpclient-4.5.13.jar
• httpcore-4.4.12.jar
• jackson-core-2.13.3.jar
• jsr305-3.0.2.jar
• protobuf-java-3.21.4.jar
• xpp3-1.1.4c.jar

ספריות שנוצרו עבור ממשקי Google API

במאגר של הספריות שנוצרו מפורטות הוראות לשימוש בכל גרסה של ממשקי ה-API.

Maven

ספריית הלקוח של Google API ל-Java נמצאת במאגר המרכזי של Maven. הערך של Maven groupId לכל הארטיפקטים של הספרייה הזו הוא com.google.api-client. הוראות ספציפיות ל-Maven לכל מודול מפורטות בהמשך.

מודולים

הספרייה הזו מורכבת מתשעה מודולים:

• ‎google-api-client
• google-api-client-android
• google-api-client-appengine
• google-api-client-servlet
• google-api-client-gson
• google-api-client-jackson2
• google-api-client-protobuf
• google-api-client-xml

google-api-client

ספריית הלקוח של Google API ל-Java‏ (google-api-client) תוכננה כך שתהיה תואמת לכל הפלטפורמות הנתמכות של Java, כולל Android.

שימוש ב-Maven:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client</artifactId>
  <version>2.4.0</version>
</dependency>

ב-Android, צריך להחריג באופן מפורש יחסי תלות שלא בשימוש:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client</artifactId>
  <version>2.4.0</version>
  <exclusions>
    <exclusion>
      <artifactId>xpp3</artifactId>
      <groupId>xpp3</groupId>
    </exclusion>
    <exclusion>
      <artifactId>httpclient</artifactId>
      <groupId>org.apache.httpcomponents</groupId>
    </exclusion>
    <exclusion>
      <artifactId>junit</artifactId>
      <groupId>junit</groupId>
    </exclusion>
    <exclusion>
      <artifactId>android</artifactId>
      <groupId>com.google.android</groupId>
    </exclusion>
  </exclusions>
</dependency>

google-api-client-android

התוספים לספריית הלקוח של Google API ל-Java‏ (‎google-api-client-android) תומכים באפליקציות Java Google Android (רק ל-SDK מגרסה 2.1 ואילך). המודול הזה תלוי ב-google-api-client וב-google-http-client-android.

שימוש ב-Maven:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-android</artifactId>
  <version>2.4.0</version>
</dependency>

google-api-client-servlet

התוספים Servlet ו-JDO לספריית הלקוח של Google API ל-Java‏ (‎google-api-client-servlet) תומכים באפליקציות אינטרנט מסוג servlet ב-Java. המודול הזה תלוי ב-google-api-client וב-google-oauth-client-servlet.

שימוש ב-Maven:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-servlet</artifactId>
  <version>2.4.0</version>
</dependency>

google-api-client-appengine

התוספים של Google App Engine לספריית הלקוח של Google API ל-Java‏ (‎google-api-client-appengine) תומכים באפליקציות Java של Google App Engine. המודול הזה תלוי ב-Google-api-client, ב-google-api-client-servlet, ב-google-oauth-client-appengine וב-google-http-client-appengine.

שימוש ב-Maven:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-appengine</artifactId>
  <version>2.4.0</version>
</dependency>

google-api-client-gson

תוספים של GSON לספריית הלקוח של Google API ל-Java‏ (‎google-api-client-gson). המודול הזה תלוי ב-google-api-client וב-google-http-client-gson.

שימוש ב-Maven:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-gson</artifactId>
  <version>2.4.0</version>
</dependency>

google-api-client-jackson2

תוספי Jackson2 לספריית הלקוח של Google API עבור Java (google-api-client-jackson2). המודול הזה תלוי ב-google-api-client וב-google-http-client-jackson2.

שימוש ב-Maven:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-jackson2</artifactId>
  <version>2.4.0</version>
</dependency>

google-api-client-protobuf

תוספים של Protocol buffer לספריית הלקוח של Google API ל-Java‏ (‎google-api-client-protobuf). מודול זה תלוי ב-google-http-client-protobuf וב-google-api-client.

שימוש ב-Maven:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-protobuf</artifactId>
  <version>2.4.0</version>
</dependency>

google-api-client-xml

תוספים של XML לספריית הלקוח של Google API ל-Java‏ (google-api-client-xml). המודול הזה תלוי ב-google-api-client וב-google-http-client-xml.

שימוש ב-Maven:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-xml</artifactId>
  <version>2.4.0</version>
</dependency>