دستورالعمل‌های راه‌اندازی

اگر از کتابخانه تولیدشده استفاده نمی‌کنید، می‌توانید «کتابخانه کارخواه Google API» برای Java و وابستگی‌های آن را در فایل zip بارگیری کنید، یا می‌توانید از Maven استفاده کنید.

همچنین دستورالعمل‌های راه‌اندازی ProGuard را که بخشی از اسناد «کتابخانه کارخواه Google HTTP برای Java» است ببینید.

بارگیری کتابخانه با وابستگی‌ها

جدیدترین فایل zip را که می‌توانید در صفحه بارگیری‌ها پیدا کنید بارگیری کنید و آن را در رایانه‌تان از حالت فشرده خارج کنید. این فایل zip حاوی فایل‌های jar کلاس کتابخانه مشتری و فایل‌های jar منبع مرتبط برای هر آرتیفکت و وابستگی‌های آن است. می‌توانید نمودارهای وابستگی و پروانه‌های کتابخانه‌های مختلف را در پوشه وابستگی‌ها پیدا کنید. برای جزئیات بیشتر درباره محتوای بارگیری، به فایل readme.html مراجعه کنید.

Android

اگر برای Android توسعه می‌دهید و Google API که می‌خواهید استفاده کنید در کتابخانه «خدمات Google Play» گنجانده شده است، برای بهترین عملکرد و تجربه از کتابخانه «خدمات Google Play» استفاده کنید.

اگر از «کتابخانه کارخواه Google API» برای Java با Android استفاده می‌کنید، مهم است بدانید کدام وابستگی‌ها با Android سازگار هستند، به‌ویژه کدام سطح Android SDK. برنامه‌های 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

موتور برنامهٔ Google

برنامه‌های 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 به فایل‌های 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

Generic Java

برنامه‌های جاوا با هدف عمومی به فایل‌های jar زیر، یا نسخه‌های سازگار جدیدتر، از پوشه 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

مخزن کتابخانه‌های تولیدشده دستورالعمل‌هایی درباره نحوه استفاده از هر نسخه از میاناهای برنامه‌سازی کاربردی دارد.

Maven

«کتابخانه کارخواه Google API» برای جاوا در مخزن مرکزی Maven قرار دارد. ‫Maven groupId برای همه مصنوعات این کتابخانه com.google.api-client است. دستورالعمل‌های Maven خاصی برای هر واحد (در زیر) ارائه شده است.

مدول‌ها

این کتابخانه از نه پیمانه تشکیل شده است:

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) از برنامه‌های وب Java servlet پشتیبانی می‌کنند. این واحد به 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» برای جاوا (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» برای جاوا (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 Client Library for 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

افزونه‌های میان‌گیر پروتکل به کتابخانه کارخواه Google API برای جاوا (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 برای جاوا (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>