Trang này được dịch bởi Cloud Translation API.

Thực thi mẫu mã

Trình khám phá API của Google tự động tạo mã mẫu. Những mã mẫu này được thiết kế để sao chép và chạy cục bộ. Để xem các mẫu, hãy nhấp vào Toàn màn hình trong bảng điều khiển bên của APIs Explorer. Hình bên dưới cho thấy các API Explorer mở rộng toàn màn hình:

**Hình 2**: Bảng điều khiển toàn màn hình của API Explorer cho API Google Sách.

Theo mặc định, APIs Explorer cho thấy cách sử dụng cURL để thực thi yêu cầu của bạn. Một số API cũng có thể hiển thị các mẫu cho các ngôn ngữ khác, chẳng hạn như JavaScript, Java và Python.

Chạy mã mẫu trên máy

Các thẻ sau đây giải thích các điều kiện tiên quyết và các bước để chạy mã mẫu. Để chạy mã mẫu, bạn phải tạo và sử dụng thông tin xác thực ủy quyền của riêng mình. Để được giải thích về cách tạo dự án và tạo thông tin xác thực, hãy tham khảo tài liệu cụ thể của Google API.

Thông tin đăng nhập là một trong những thông tin sau đây, tuỳ thuộc vào loại dữ liệu (công khai hoặc riêng tư) mà phương thức này truy cập:

Đối với dữ liệu công khai, thông tin xác thực là một khóa API.
Đối với dữ liệu riêng tư, thông tin xác thực là tệp client_secret.json chứa mã ứng dụng khách OAuth 2.0 và mật khẩu ứng dụng khách hoặc mã thông báo truy cập OAuth 2.0.

URL

Thiết lập

Làm theo hướng dẫn trong tài liệu API để tạo hoặc chọn một dự án cho ứng dụng của bạn và bật API.
Trong Cloud Console, hãy tạo một khoá API.
Trong bảng điều khiển trên đám mây, hãy tạo thông tin đăng nhập mã nhận dạng ứng dụng khách OAuth cho ứng dụng Web và sử dụng https://developers.google.com/oauthplayground làm URI chuyển hướng.
Trong Playground 2.0 của OAuth, nhấp vào Cấu hình OAuth 2.0 .
Chọn Sử dụng thông tin đăng nhập của riêng bạn.
Nhập mã ứng dụng khách và mật khẩu ứng dụng khách đã tạo ở bước 3.
Trong trường phạm vi, hãy nhập phạm vi để sử dụng với phương thức của bạn và nhấp vào Uỷ quyền API.
(không bắt buộc) Nếu bạn thấy màn hình Đăng nhập, hãy chọn tài khoản cần sử dụng.
(không bắt buộc) Nếu bạn thấy màn hình ủy quyền, hãy nhấp vào Chấp nhận.
Nhấp vào Mã uỷ quyền Exchange cho mã thông báo. Mã thông báo được trả về.
Trong mã mẫu cURL, hãy thay thế [YOUR_API_KEY] bằng khoá API được tạo trong bước 2: 'https://www.googleapis.com/drive/v3/files?key=[YOUR_API_KEY]' \
Trong mã mẫu cURL, hãy thay thế [YOUR_ACCESS_TOKEN] bằng mã truy cập được tạo ở bước 10: --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \

Thực thi mã mẫu

Trên dòng lệnh, hãy thực thi lệnh cURL. Lệnh này sẽ tương tự như lệnh sau:

curl \
'https://www.googleapis.com/drive/v3/files?key=AIzaSyBiKcaoXmVApwnT24hitQG_dwjGvAj6Ddw' \
--header 'Authorization: Bearer ya29.a0ARrdaM_yQn9MWBpJgKPx880BSnRYIizRYIDz0JN9e66nSliIYpqNXmPsvv2ccfplCTG_U4b1' \
--header 'Accept: application/json' \
--compressed

JavaScript

Thiết lập

Làm theo hướng dẫn trong tài liệu API để tạo hoặc chọn một dự án cho ứng dụng của bạn và bật API.
Trong Cloud Console, hãy tạo một khoá API.
Trong bảng điều khiển đám mây, hãy tạo thông tin đăng nhập mã nhận dạng ứng dụng khách OAuth cho một "Web quot; và đặt các nguồn gốc JavaScript được ủy quyền để xác định URL mà từ đó bạn sẽ gửi yêu cầu, chẳng hạn như http://localhost.
Sao chép toàn bộ mã mẫu vào một tệp cục bộ mà máy chủ web có thể truy cập, chẳng hạn như /var/www/html/example.html.
Tìm dòng trong mã mẫu để đặt khoá API hoặc mã ứng dụng khách và thay thế giá trị bằng các giá trị được tạo ở bước 2 và 3:
- Khoá API: gapi.client.setApiKey(YOUR_API_KEY);
- Mã nhận dạng của ứng dụng khách OAuth 2.0: gapi.client.init({ 'clientId': 'YOUR_CLIENT_ID',

Thực thi mã mẫu

Mở tệp trong trình duyệt của bạn, chẳng hạn như http://localhost/example.html. Bạn nên sử dụng một trình duyệt có bảng điều khiển gỡ lỗi, chẳng hạn như Google Chrome.
(không bắt buộc) Nếu bạn thấy màn hình Đăng nhập, hãy chọn tài khoản cần sử dụng.
(không bắt buộc) Nếu bạn thấy màn hình ủy quyền, hãy nhấp vào Chấp nhận. Bảng điều khiển gỡ lỗi phải hiển thị phản hồi của phương thức dưới dạng đối tượng JSON.

Java

Điều kiện tiên quyết

Java 1.7 trở lên.
Gradle 7 trở lên.

Thiết lập

Làm theo hướng dẫn trong tài liệu API để tạo hoặc chọn một dự án cho ứng dụng của bạn và bật API.
Tuỳ thuộc vào loại dữ liệu mà phương thức đó truy cập, hãy tạo khoá API (dữ liệu công khai) hoặc tạo mã ứng dụng khách OAuth 2.0 (dữ liệu riêng tư).
Đặt loại ứng dụng thành Ứng dụng dành cho máy tính để bàn.
Nếu bạn đã tạo mã ứng dụng khách OAuth 2.0, hãy tải tệp JSON chứa thông tin xác thực OAuth 2.0 xuống. Tệp này có tên tương tự như client_secret_CLIENTID.json, trong đó CLIENTID là mã ứng dụng khách của dự án.
Trong thư mục hoạt động của bạn, hãy chạy các lệnh sau để tạo một cấu trúc dự án mới:
```
$ gradle init --type basic
$ mkdir -p src/main/java src/main/resources
```
Nếu bạn đã tạo mã ứng dụng khách OAuth 2.0 ở bước 2, hãy đổi tên tệp JSON mà bạn đã tải xuống thành client_secret.json.
Lưu tệp đã đổi tên trong thư mục src/main/resources mà bạn đã tạo ở bước 5.

Trong thư mục hoạt động, hãy mở tệp build.gradle và thay thế nội dung của tệp đó bằng các thông tin sau:

apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'ApiExample'
sourceCompatibility = 1.7
targetCompatibility = 1.7
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.api-client:google-api-client:1.23.0'
    compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
    API_SPECIFIC_DEPENDENCY
}

Trong tệp build.gradle, hãy thay thế dòng có nội dung API_SPECIFIC_DEPENDENCY bằng hướng dẫn biên dịch mã cho API bạn đang gọi. Dưới đây là một ví dụ về API YouTube Analytics:
```
compile 'com.google.apis:google-api-services-youtubeAnalytics:v2-rev16-1.23.0'
```
Hướng dẫn này tuân theo mẫu sau:
```
compile 'com.google.apis:google-api-services-API_NAME:API_VERSION-   revREVISION-CL_VERSION'
```

Trong trường hợp:

API_NAME là tên API được liệt kê trên GitHub cho API. Để tìm tên, hãy nhấp vào đường liên kết phiên bản bên cạnh API trên trang API Google được hỗ trợ. Đường liên kết đến phiên bản sẽ chuyển đến GitHub. Tên API nằm ở giữa phía trên của trang và đứng sau googleapis/google-apis-services-. Ví dụ: đối với phiên bản 3 của API Drive, API_NAME là drive.
API_VERSION là phiên bản API được liệt kê cho API bên dưới tên API trên trang API Google được hỗ trợ.
REVISION là số bản sửa đổi được liệt kê trong tài liệu tham khảo về JavaDoc cho API. Bạn có thể tìm thấy tài liệu tham khảo về JavaDoc tại https://googleapis.dev/java/google-api-services-API_NAME/latest/index.html
CL_VERSION là phiên bản thư viện ứng dụng. Giá trị này cũng xuất hiện trong tệp tham chiếu JavaDoc.
Trong thư mục hoạt động của bạn, hãy sao chép mã mẫu từ APIs Explorer vào src/main/java/ApiExample.java. (Tên lớp trong mỗi mẫu là ApiExample để bạn không cần sửa đổi tệp build.gradle để chạy các mẫu khác nhau.

Thực thi mã mẫu

Hãy sử dụng lệnh sau để chạy ví dụ này:

  gradle -q run

Mẫu sẽ thực thi yêu cầu API và in nội dung phản hồi cho STDOUT. Bạn cũng có thể kiểm tra dịch vụ mà bạn đang gọi để xem tác động của các yêu cầu ghi dữ liệu.

Node.js

Điều kiện tiên quyết

Nút.js
Thư viện ứng dụng Node.js của Google API:
- Nếu trước đó bạn chưa cài đặt thư viện ứng dụng, hãy chạy lệnh:
```
npm install googleapis --save
```
- Nếu đã cài đặt thư viện ứng dụng trước đó, bạn nên cập nhật thư viện đó để đảm bảo rằng bạn có các lớp mới nhất cho thư viện mà bạn đang thử nghiệm. Để cập nhật thư viện ứng dụng, hãy chạy lệnh:
```
npm update googleapis --save
```

Thiết lập

Làm theo hướng dẫn trong tài liệu API để tạo hoặc chọn một dự án cho ứng dụng của bạn và bật API.
Tuỳ thuộc vào loại dữ liệu mà phương thức đó truy cập, hãy tạo khoá API (dữ liệu công khai) hoặc tạo mã ứng dụng khách OAuth 2.0 (dữ liệu riêng tư).
Đặt loại ứng dụng thành Ứng dụng dành cho máy tính để bàn.
Nếu bạn đã tạo mã ứng dụng khách OAuth 2.0, hãy tải tệp JSON chứa thông tin xác thực OAuth 2.0 xuống. Tệp này có tên tương tự như client_secret_CLIENTID.json, trong đó CLIENTID là mã ứng dụng khách của dự án.
Sao chép mã mẫu vào một tệp cục bộ và sửa đổi mẫu để xác định chính xác khoá API hoặc tệp mật khẩu ứng dụng khách của bạn. Trong mẫu, giá trị khoá API là YOUR_API_KEY và vị trí tệp bí mật của ứng dụng khách là YOUR_CLIENT_SECRET_FILE.json.

Thực thi mã mẫu

Hãy sử dụng lệnh sau để chạy ví dụ này:

  node sample.js

Hầu hết mẫu đều in một phản hồi API (hoặc một nội dung khác) cho STDOUT.

PHP

Điều kiện tiên quyết

PHP 5.4 trở lên với giao diện dòng lệnh (CLI) và tiện ích JSON.
Công cụ quản lý phần phụ thuộc Compose được cài đặt trên toàn cầu.
Thư viện ứng dụng PHP cho API:
- Nếu trước đó bạn chưa cài đặt thư viện ứng dụng, hãy chạy lệnh:
```
composer require google/apiclient:^2.0
```
- Nếu đã cài đặt thư viện ứng dụng trước đó, bạn nên cập nhật thư viện này để đảm bảo rằng bạn có các lớp mới nhất cho thư viện mình đang kiểm thử. Để cập nhật thư viện ứng dụng, hãy chạy lệnh:
```
composer update google/apiclient --with-dependencies
```

Thực thi mã mẫu

Hãy sử dụng lệnh sau để chạy ví dụ này:

  php sample.php

Hầu hết mẫu đều in một phản hồi API (hoặc một nội dung khác) cho STDOUT.

Python

Điều kiện tiên quyết

Python 2.7 hoặc Python 3.5+
Công cụ quản lý gói pip
Thư viện ứng dụng Python cho API của Google:
```
pip install --upgrade google-api-python-client
```
Các thư viện google-auth-oauthlib và google-auth-httplib2 để ủy quyền người dùng:
```
pip install --upgrade google-auth-oauthlib google-auth-httplib2
```

Thiết lập

Làm theo hướng dẫn trong tài liệu API để tạo hoặc chọn một dự án cho ứng dụng của bạn và bật API.
Tuỳ thuộc vào loại dữ liệu mà phương thức đó truy cập, hãy tạo khoá API (dữ liệu công khai) hoặc tạo mã ứng dụng khách OAuth 2.0 (dữ liệu riêng tư).
Đặt loại ứng dụng thành Ứng dụng dành cho máy tính để bàn.
Nếu bạn đã tạo mã ứng dụng khách OAuth 2.0, hãy tải tệp JSON chứa thông tin xác thực OAuth 2.0 xuống. Tệp này có tên tương tự như client_secret_CLIENTID.json, trong đó CLIENTID là mã ứng dụng khách của dự án.
Sao chép mã mẫu vào một tệp cục bộ và sửa đổi mẫu để xác định chính xác khoá API hoặc tệp mật khẩu ứng dụng khách của bạn. Trong mẫu, giá trị khoá API là YOUR_API_KEY và vị trí tệp bí mật của ứng dụng khách là YOUR_CLIENT_SECRET_FILE.json.

Thực thi mã mẫu

Hãy sử dụng lệnh sau để chạy ví dụ này:

  python sample.py

Hầu hết mẫu đều in một phản hồi API (hoặc một nội dung khác) cho STDOUT.

Ruby

Điều kiện tiên quyết

Ruby 2.0 trở lên
Thư viện ứng dụng API của Google cho Ruby:
```
gem install google-api-client`
```

Thiết lập

Làm theo hướng dẫn trong tài liệu API để tạo hoặc chọn một dự án cho ứng dụng của bạn và bật API.
Tuỳ thuộc vào loại dữ liệu mà phương thức đó truy cập, hãy tạo khoá API (dữ liệu công khai) hoặc tạo mã ứng dụng khách OAuth 2.0 (dữ liệu riêng tư).
Đặt loại ứng dụng thành Ứng dụng dành cho máy tính để bàn.
Nếu bạn đã tạo mã ứng dụng khách OAuth 2.0, hãy tải tệp JSON chứa thông tin xác thực OAuth 2.0 xuống. Tệp này có tên tương tự như client_secret_CLIENTID.json, trong đó CLIENTID là mã ứng dụng khách của dự án.
Sao chép mã mẫu vào một tệp cục bộ và sửa đổi mẫu để xác định chính xác khoá API hoặc tệp mật khẩu ứng dụng khách của bạn. Trong mẫu, giá trị khoá API là YOUR_API_KEY và vị trí tệp bí mật của ứng dụng khách là YOUR_CLIENT_SECRET_FILE.json.

Thực thi mã mẫu

Hãy sử dụng lệnh sau để chạy ví dụ này:

  ruby sample.rb

Hầu hết mẫu đều in một phản hồi API (hoặc một nội dung khác) cho STDOUT.

Khắc phục sự cố mẫu

Hộp thoại uỷ quyền không xuất hiện

Trình khám phá API sử dụng cửa sổ bật lên để cấp quyền truy cập vào dữ liệu riêng tư của bạn. Nếu trình duyệt của bạn chặn cửa sổ bật lên, thì cửa sổ bật lên này sẽ không xuất hiện và bạn sẽ không thể cấp quyền truy cập.

Nếu bạn nhấp vào "Allow" trong màn hình cấp phép và không có gì xảy ra, hãy thử thay đổi chế độ cài đặt cửa sổ bật lên của trình duyệt để bật cửa sổ bật lên.

Đã nhận được lỗi 401 hoặc 403

Nếu bạn gặp lỗi 401 hoặc 403 khi kiểm tra mẫu, điều đó có thể là do sự cố với một trong các lỗi sau:

API chưa được bật cho dự án của bạn. Xem lại hướng dẫn dành cho API về cách tạo dự án và bật API.
Bạn đang sử dụng loại uỷ quyền không chính xác (khoá API thay vì OAuth 2.0).
Bạn đang sử dụng OAuth 2.0 nhưng có phạm vi quá hẹp.
Khi thiết lập khoá API, bạn sẽ thiết lập các hạn chế để ngăn việc sử dụng trái phép thông tin xác thực của bạn. Tuy nhiên, yêu cầu đó không đáp ứng những quy định hạn chế đó. Để biết thêm thông tin, hãy tham khảo bài viết Sử dụng các quy tắc hạn chế đối với khoá API.

Đã nhận được cảnh báo về nội dung hỗn hợp

Nếu bạn sử dụng Điểm cuối Google Cloud và đang chạy điểm cuối trong máy chủ phát triển, trình duyệt của bạn có thể đưa ra cảnh báo về nội dung hỗn hợp. Cảnh báo này xảy ra vì API Explorer được tải qua HTTPS, nhưng khi API chạy cục bộ, API này sẽ được lưu trữ trên HTTP.

Để ẩn cảnh báo này bằng Chrome, hãy bắt đầu một phiên Chrome bằng các cờ đặc biệt như sau:

path/to/chrome --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:port

Ví dụ:

/usr/bin/google-chrome-stable --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:8080

Bạn chỉ nên ẩn cảnh báo này nhằm mục đích kiểm thử cục bộ.

Chỉ JavaScript: gapi không được xác định

"gapi không được xác định" lỗi xảy ra khi mã JavaScript cố gọi Thư viện ứng dụng API của Google cho JavaScript trước khi thư viện tải xong. Hãy đảm bảo rằng mã của bạn tham chiếu đến biến gapi không được gọi cho đến khi thư viện ứng dụng khách đã tải.