Hướng dẫn thiết lập

Nếu không sử dụng thư viện được tạo, bạn có thể tải Thư viện ứng dụng API của Google cho Java và các phần phụ thuộc của thư viện đó xuống dưới dạng tệp zip hoặc sử dụng Maven.

Ngoài ra, hãy xem hướng dẫn thiết lập ProGuard trong tài liệu về Thư viện ứng dụng HTTP của Google cho Java.

Tải thư viện có phần phụ thuộc xuống

Tải tệp zip mới nhất xuống (bạn có thể tìm thấy tệp này trên trang tải xuống) rồi giải nén tệp đó trên máy tính. Tệp zip này chứa các tệp jar lớp thư viện ứng dụng và các tệp jar nguồn liên kết cho từng cấu phần phần mềm và phần phụ thuộc của cấu phần phần mềm đó. Bạn có thể tìm thấy biểu đồ phần phụ thuộc và giấy phép cho các thư viện khác nhau trong thư mục phần phụ thuộc. Để biết thêm thông tin chi tiết về nội dung tải xuống, hãy xem tệp readme.html.

Android

Nếu bạn đang phát triển cho Android và API Google mà bạn muốn sử dụng có trong thư viện Dịch vụ Google Play, hãy sử dụng thư viện Dịch vụ Google Play để có hiệu suất và trải nghiệm tốt nhất.

Nếu bạn đang sử dụng Thư viện ứng dụng Java cho API của Google với Android, điều quan trọng là bạn phải biết những phần phụ thuộc nào tương thích với Android, cụ thể là cấp độ SDK Android nào. Ứng dụng Android yêu cầu các tệp jar sau hoặc các phiên bản tương thích mới hơn, từ thư mục 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

Cảnh báo: Đối với Android, bạn PHẢI đặt các tệp .jar vào thư mục có tên "libs" để trình đóng gói APK có thể tìm thấy các tệp đó. Nếu không, bạn sẽ gặp lỗi NoClassDefFoundError trong thời gian chạy.

Google App Engine

Các ứng dụng Google App Engine yêu cầu các tệp jar sau đây hoặc các phiên bản tương thích mới hơn trong thư mục 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

Ứng dụng servlet yêu cầu các tệp jar sau đây hoặc các phiên bản tương thích mới hơn trong thư mục 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-Log-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 chung

Các ứng dụng Java thông thường yêu cầu các tệp jar sau hoặc các phiên bản tương thích mới hơn, từ thư mục 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

Thư viện được tạo cho API của Google

Kho lưu trữ của các thư viện đã tạo có hướng dẫn về cách sử dụng từng phiên bản API.

Maven

Thư viện ứng dụng API của Google dành cho Java nằm trong kho lưu trữ Maven trung tâm. groupId Maven cho tất cả cấu phần phần mềm của thư viện này là com.google.api-client. Hướng dẫn cụ thể về Maven được cung cấp cho từng mô-đun (dưới đây).

Mô-đun

Thư viện này bao gồm 9 mô-đun:

• 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

Thư viện ứng dụng API của Google cho Java (google-api-client) được thiết kế để tương thích với tất cả các nền tảng Java được hỗ trợ, bao gồm cả Android.

Cách sử dụng Maven:

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

Trên Android, bạn cần phải loại trừ một cách rõ ràng các phần phụ thuộc không dùng đến:

<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

Các tiện ích dành cho Thư viện ứng dụng API của Google dành cho Java (google-api-client-android) hỗ trợ các ứng dụng Java Google Android (chỉ dành cho các ứng dụng SDK >= 2.1). Mô-đun này phụ thuộc vào google-api-client và google-http-client-android.

Cách sử dụng Maven:

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

google-api-client-servlet

Tiện ích Servlet và JDO cho Thư viện ứng dụng API của Google cho Java (google-api-client-servlet) hỗ trợ các ứng dụng web servlet Java. Mô-đun này phụ thuộc vào google-api-client và google-oauth-client-servlet.

Cách sử dụng Maven:

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

google-api-client-appengine

Các tiện ích Google App Engine cho Thư viện ứng dụng Google API dành cho Java (google-api-client-appengine) hỗ trợ các ứng dụng Google App Engine Java. Mô-đun này phụ thuộc vào google-api-client, google-api-client-servlet, google-oauth-client-appengine và google-http-client-appengine.

Cách sử dụng Maven:

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

google-api-client-gson

Tiện ích GSON cho Thư viện ứng dụng API của Google cho Java (google-api-client-gson). Mô-đun này phụ thuộc vào google-api-client và google-http-client-gson.

Cách sử dụng Maven:

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

google-api-client-jackson2

Tiện ích Jackson2 cho Thư viện ứng dụng Google API dành cho Java (google-api-client-jackson2). Mô-đun này phụ thuộc vào google-api-client và google-http-client-jackson2.

Cách sử dụng Maven:

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

google-api-client-protobuf

Tiện ích Vùng đệm giao thức cho Thư viện ứng dụng API của Google cho Java (google-api-client-protobuf). Mô-đun này phụ thuộc vào google-http-client-protobuf và google-api-client.

Cách sử dụng Maven:

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

google-api-client-xml

Tiện ích XML cho Thư viện ứng dụng API của Google cho Java (google-api-client-xml). Mô-đun này phụ thuộc vào google-api-client và google-http-client-xml.

Cách sử dụng Maven:

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