您目前查看的是 Google Photos Library API 的舊版說明文件。
開始使用 Java 用戶端程式庫
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
如要開始搭配 Java 用戶端程式庫使用 Google Photos Library API,您需要
在您的開發環境中設定用戶端程式庫。
在新增專案前,請先啟用 API 設定專案
,並設定 OAuth 2.0 用戶端 ID。
您的應用程式代表
Google 相簿使用者。例如,當您在使用者的
Google 相簿相片庫或將媒體項目上傳到使用者的
Google 相簿帳戶,使用者透過
OAuth 2.0 通訊協定。
OAuth 2.0 用戶端 ID 可讓應用程式使用者登入、驗證
然後使用 Library APILibrary API 不支援
或服務帳戶如要使用這個 API,使用者必須登入有效的 Google
。
啟用 API
您必須先為專案啟用 Library API,才能使用該 API。
- 前往 Google API 控制台。
- 在選單列中,選取專案或建立新專案。
- 如要開啟 Google API 程式庫,請從導覽選單選取
API 與服務 >程式庫。
- 搜尋「Google Photos Library API」。選取正確的結果並按一下
啟用:
要求 OAuth 2.0 用戶端 ID
請按照下列步驟申請 OAuth 用戶端 ID,並為其進行設定
應用程式。這個範例使用的應用程式,其可存取整個 OAuth 流程
,如我們範例中所示設定程序可能不同
其他導入情境。
- 前往 Google API 控制台
然後選取所需專案
- 從選單中選取「API 與」服務 >憑證。
- 在「Credentials」(憑證) 頁面上,按一下「Create Credentials」(建立憑證) > OAuth 用戶端 ID。
- 選取您的「應用程式類型」。在這個範例中,應用程式類型為
網頁應用程式。
註冊應用程式可存取 Google API 的來源
如下所示:
- 為識別用戶端 ID,請輸入名稱。
在「授權的 JavaScript 來源」欄位中,輸入
應用程式。這個欄位不允許使用萬用字元。
您可以輸入多個來源,讓應用程式在不同的位置執行
通訊協定、網域或子網域您輸入的網址可以
開始 OAuth 要求。
以下範例是本機開發網址 (我們的範例使用
localhost:8080
) 和正式版網址。
http://localhost:8080
https://myproductionurl.example.com
「授權的重新導向 URI」欄位是接收到的端點
OAuth 2.0 伺服器的回應。通常這包括
並指向應用程式中的路徑
http://localhost:8080/auth/google/callback
https://myproductionurl.example.com/auth/google/callback
按一下「建立」。
-
在產生的 OAuth 用戶端對話方塊中,下載 JSON 檔案
包含用戶端設定用戶端詳細資料包含
包括:
這個 JSON 檔案稍後會用來設定
與這個用戶端程式庫搭配使用的 Java 專用 Google 驗證程式庫
在啟動可存取 Library API 的公開應用程式之前,
您的應用程式必須經過 Google 審查。「未驗證的應用程式」訊息會出現在
測試應用程式時的畫面
通過驗證。
設定用戶端程式庫
Java 用戶端程式庫會為您處理所有後端 API 呼叫
方便使用的物件,包括一些常見 API 工作的程式碼範例。
首先,請下載並安裝 Java 適用的 Google Photos Library API 用戶端程式庫
以及 GitHub 的依附元件。
接著,設定 Java 的 OAuth2 憑證。
下載選項
下載用戶端程式庫的方式如下:
Gradle 依附元件:
如要搭配 Gradle 使用這個程式庫,請將以下依附元件新增至
build.gradle
檔案。
repositories {
mavenCentral()
}
dependencies {
compile 'com.google.photos.library:google-photos-library-client:1.7.3'
}
Maven 依附元件:
如要搭配 Maven 使用這個程式庫,請將以下內容新增至 Maven pom.xml
檔案。
<dependency>
<groupId>com.google.photos.library</groupId>
<artifactId>google-photos-library-client</artifactId>
<version>1.7.3</version>
</dependency>
下載版本:
發行內容頁面
包含每個程式庫版本的不同構件,包括 jar 檔案。
複製存放區:
如要修改或為這個程式庫提供內容,請使用這個方法
例如提交提取要求,或想試用範例當您
複製存放區,系統會下載這個存放區中的所有檔案。
- 在以下位置執行
git clone https://github.com/google/java-photoslibrary.git
:
使用指令
- 您會取得
java-photoslibrary
目錄。前往該位置:執行
cd java-photoslibrary
。
- 在 IDE 中開啟
build.gradle
檔案,或在以下位置執行 ./gradlew assemble
:
使用命令提示字元建立專案查看「./gradlew tasks
」即可查看
可用的工作。
設定 Java 的 OAuth2 憑證
此用戶端程式庫可搭配 Google 驗證程式庫
Java。如需更多資訊
請參閱將 OAuth 2.0 與 Google API 用戶端程式庫搭配使用,
Java。
出現下列情況時,請在 CredentialsProvider
中指定您的用戶端 OAuth 設定
建立 PhotosLibraryClient
物件的 PhotoLibrarySettings
。
試用一些範例
請嘗試以下程式碼,透過 Java 用戶端程式庫發出第一個 API 呼叫。
// Set up the Photos Library Client that interacts with the API
PhotosLibrarySettings settings =
PhotosLibrarySettings.newBuilder()
.setCredentialsProvider(
FixedCredentialsProvider.create(/* Add credentials here. */))
.build();
try (PhotosLibraryClient photosLibraryClient =
PhotosLibraryClient.initialize(settings)) {
// Create a new Album with at title
Album createdAlbum = photosLibraryClient.createAlbum("My Album");
// Get some properties from the album, such as its ID and product URL
String id = album.getId();
String url = album.getProductUrl();
} catch (ApiException e) {
// Error during album creation
}
更多範例
向您介紹。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-08-29 (世界標準時間)。
[null,null,["上次更新時間:2025-08-29 (世界標準時間)。"],[[["\u003cp\u003eThe Google Photos Library API allows your application to interact with Google Photos on behalf of a user, requiring user authorization through OAuth 2.0.\u003c/p\u003e\n"],["\u003cp\u003eBefore using the API, you must enable it in the Google API Console and obtain an OAuth 2.0 client ID for your application.\u003c/p\u003e\n"],["\u003cp\u003eThe Java client library simplifies API interaction, and you can install it using Gradle, Maven, or by downloading a release from GitHub.\u003c/p\u003e\n"],["\u003cp\u003eTo authenticate your application, set up OAuth2 credentials using the Google Auth Library for Java and specify your client configuration in the \u003ccode\u003eCredentialsProvider\u003c/code\u003e.\u003c/p\u003e\n"]]],["To use the Google Photos Library API with Java, first enable the API in the Google API Console and create an OAuth 2.0 client ID, configuring authorized JavaScript origins and redirect URIs. Next, download the Java client library using Gradle, Maven, a direct download, or by cloning the GitHub repository. Finally, set up OAuth2 credentials using the Google Auth Library for Java, providing these in the `PhotosLibrarySettings` when initializing the `PhotosLibraryClient`. Then try out some samples.\n"],null,["# Get started with Java client library\n\nTo start using the Google Photos Library API with the Java client library, you will need to\n[set up the client library](#get-library) in your development environment.\nBefore you do that, [configure your project](#configure-app) by enabling the API\nvia the Google API Console and setting up an OAuth 2.0 client ID.\n\nYour application interacts with Google Photos on behalf of a\nGoogle Photos user. For instance, when you create albums in a user's\nGoogle Photos library or upload media items to a user's\nGoogle Photos account, the user authorizes these API requests via the\n[OAuth 2.0](/identity/protocols/OAuth2) protocol.\n\nThe OAuth 2.0 client ID allows your application users to sign in, authenticate,\nand thereby use the Library API. The Library API does not support\nservice accounts; to use this API, users must be signed in to a valid Google\nAccount.\n\nConfigure your app\n------------------\n\n### Enable the API\n\nBefore you can use the Library API, you must enable it for your project.\n\n1. Go to the [Google API Console](https://console.developers.google.com/apis/library).\n2. From the menu bar, select a project or create a new project.\n3. To open the Google API Library, from the Navigation menu, select **APIs \\& Services \\\u003e Library**.\n4. Search for \"Google Photos Library API\". Select the correct result and click **Enable**.\n\n### Request an OAuth 2.0 client ID\n\nFollow the steps below to request an OAuth client ID and configure it for your\napplication. This example uses an application where the entire OAuth flow is\nhandled server-side, such as the one in our samples. The setup process may vary\nfor other [implementation scenarios](/identity/protocols/OAuth2).\n\n1. Go to the [Google API Console](https://console.developers.google.com/apis/library) and select your project.\n2. From the menu, select **APIs \\& Services \\\u003e Credentials**.\n3. On the **Credentials** page, click **Create Credentials \\\u003e OAuth client ID**.\n4. Select your **Application type** . In this example, the application type is **Web application**.\n5. Register the origins from which your app is allowed to access the Google APIs\n as follows:\n\n 1. To identify the client ID, enter a name.\n 2. In the **Authorized JavaScript origins** field, enter the origin for your\n app. This field doesn't allow wildcards.\n\n You can enter multiple origins to allow your app to run on different\n protocols, domains, or subdomains. The URLs you enter are allowed to\n start an OAuth request.\n\n The following example shows a local development URL (our samples use\n `localhost:8080`) and a production URL. \n\n http://localhost:8080\n https://myproductionurl.example.com\n\n 3. The **Authorized redirect URI** field is the endpoint that receives\n responses from the OAuth 2.0 server. Typically, this includes your\n development environment and points to a path in your application.\n\n http://localhost:8080/auth/google/callback\n https://myproductionurl.example.com/auth/google/callback\n\n 4. Click **Create**.\n\n\u003c!-- --\u003e\n\n6. From the resulting OAuth client dialog, download the JSON file\n containing your client configuration. You client details consist of the\n following:\n\n - Client ID\n - Client secret\n\n This JSON file will be used later to [set up](#get-library)\n the Google Auth library for Java which works with this client library.\n\nBefore you can launch a public application that accesses the Library API,\nyour app must be reviewed by Google. An \"Unverified app\" message appears on the\nscreen when you test your application, until it is\n[verified](https://support.google.com/cloud/answer/7454865).\n\nSet up the client library\n-------------------------\n\nThe Java client library handles all the backend API calls for you, and exposes\nfriendly objects to work with, including code samples for some common API tasks.\nFirstly, download and install the Google Photos Library API client library for Java along\nwith the dependencies from [GitHub](https://github.com/google/java-photoslibrary).\nThen, set up your OAuth2 credentials for Java.\n\n### Download options\n\nHere are some options to download the client library:\n\n- **Gradle dependency:**\n\n To use this library with Gradle, add the following dependency to your\n `build.gradle` file. \n\n repositories {\n mavenCentral()\n }\n dependencies {\n compile 'com.google.photos.library:google-photos-library-client:1.7.3'\n }\n\n- **Maven dependency:**\n\n To use this library with Maven, add the following to your Maven `pom.xml`\n file. \n\n \u003cdependency\u003e\n \u003cgroupId\u003ecom.google.photos.library\u003c/groupId\u003e\n \u003cartifactId\u003egoogle-photos-library-client\u003c/artifactId\u003e\n \u003cversion\u003e1.7.3\u003c/version\u003e\n \u003c/dependency\u003e\n\n- **Download a release:**\n\n The [releases page](https://github.com/google/java-photoslibrary/releases)\n contains different artifacts for each library release, including jar files.\n- **Clone the repository:**\n\n Use this method if you want to alter or contribute to this library, for\n example, submitting pull requests, or if you wish to try our samples. When you\n clone the repository, **all** files in this repository will be downloaded.\n 1. Run `git clone https://github.com/google/java-photoslibrary.git` at the command prompt.\n 2. You'll get a `java-photoslibrary` directory. Navigate to it by running `cd java-photoslibrary`.\n 3. Open the `build.gradle` file in your IDE or run `./gradlew assemble` at the command prompt to build the project. See `./gradlew tasks` to see available tasks.\n\n### Set up your OAuth2 credentials for Java\n\nThis client library works with the [Google Auth Library for\nJava](https://github.com/google/google-auth-library-java). For more information,\nrefer to [Using OAuth 2.0 with the Google API Client Library for\nJava](https://developers.google.com/api-client-library/java/google-api-java-client/oauth2).\n\nSpecify your client OAuth configuration in the `CredentialsProvider` when\ncreating the `PhotoLibrarySettings` for a `PhotosLibraryClient` object.\n\nTry out some samples\n--------------------\n\nTry the code below to make your first API call using the Java client library. \n\n // Set up the Photos Library Client that interacts with the API\n PhotosLibrarySettings settings =\n PhotosLibrarySettings.newBuilder()\n .setCredentialsProvider(\n FixedCredentialsProvider.create(/* Add credentials here. */)) \n .build();\n\n try (PhotosLibraryClient photosLibraryClient =\n PhotosLibraryClient.initialize(settings)) {\n\n // Create a new Album with at title\n Album createdAlbum = photosLibraryClient.createAlbum(\"My Album\");\n\n // Get some properties from the album, such as its ID and product URL\n String id = album.getId();\n String url = album.getProductUrl();\n\n } catch (ApiException e) {\n // Error during album creation\n }\n\nThere are more [samples](https://github.com/google/java-photoslibrary/tree/master/sample)\non GitHub for you to try."]]