شما در حال مشاهده اسناد قدیمی برای Google Photos Library API هستید.
با کتابخانه مشتری جاوا شروع کنید
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
برای شروع استفاده از Google Photos Library API با کتابخانه سرویس گیرنده جاوا، باید کتابخانه سرویس گیرنده را در محیط توسعه خود راه اندازی کنید . قبل از انجام این کار، پروژه خود را با فعال کردن API از طریق Google API Console و تنظیم شناسه مشتری OAuth 2.0 پیکربندی کنید .
برنامه شما از طرف یک کاربر Google Photos با Google Photos تعامل دارد. به عنوان مثال، وقتی آلبوم‌هایی را در کتابخانه Google Photos کاربر ایجاد می‌کنید یا موارد رسانه را در حساب Google Photos کاربر آپلود می‌کنید، کاربر این درخواست‌های API را از طریق پروتکل OAuth 2.0 مجاز می‌کند.
شناسه مشتری OAuth 2.0 به کاربران برنامه شما اجازه می دهد تا وارد سیستم شوند، احراز هویت و در نتیجه از کتابخانه API استفاده کنند. کتابخانه API از حساب‌های سرویس پشتیبانی نمی‌کند. برای استفاده از این API، کاربران باید به یک حساب Google معتبر وارد شوند.
API را فعال کنید
قبل از اینکه بتوانید از کتابخانه API استفاده کنید، باید آن را برای پروژه خود فعال کنید.
- به کنسول API Google بروید.
- از نوار منو، یک پروژه را انتخاب کنید یا یک پروژه جدید ایجاد کنید.
- برای باز کردن کتابخانه Google API، از منوی پیمایش، APIs & Services > Library را انتخاب کنید.
- «Google Photos Library API» را جستجو کنید. نتیجه صحیح را انتخاب کنید و روی Enable کلیک کنید.
شناسه مشتری OAuth 2.0 را درخواست کنید
برای درخواست شناسه مشتری OAuth و پیکربندی آن برای برنامه خود، مراحل زیر را دنبال کنید. این مثال از برنامه‌ای استفاده می‌کند که در آن کل جریان OAuth در سمت سرور مدیریت می‌شود، مانند نمونه‌های ما. فرآیند راه اندازی ممکن است برای سایر سناریوهای پیاده سازی متفاوت باشد.
- به کنسول API Google بروید و پروژه خود را انتخاب کنید.
- از منو، APIs & Services > Credentials را انتخاب کنید.
- در صفحه اعتبارنامه ، روی ایجاد اعتبارنامه > شناسه مشتری OAuth کلیک کنید.
- نوع برنامه خود را انتخاب کنید. در این مثال، نوع برنامه کاربردی وب است.
مبداهایی را که برنامه شما از آنجا اجازه دسترسی به APIهای Google را دارد به شرح زیر ثبت کنید:
- برای شناسایی شناسه مشتری، یک نام وارد کنید.
در قسمت Authorized JavaScript origins ، مبدا برنامه خود را وارد کنید. این فیلد حروف عام را مجاز نمی‌داند.
می‌توانید چندین منبع را وارد کنید تا به برنامه‌تان اجازه دهید روی پروتکل‌ها، دامنه‌ها یا زیر دامنه‌های مختلف اجرا شود. URL هایی که وارد می کنید مجاز به شروع درخواست OAuth هستند.
مثال زیر یک URL توسعه محلی (نمونه های ما localhost:8080 استفاده می کنند) و یک URL تولید را نشان می دهد.
http://localhost:8080
https://myproductionurl.example.com
قسمت Authorized Redirect URI نقطه پایانی است که پاسخ‌ها را از سرور OAuth 2.0 دریافت می‌کند. به طور معمول، این شامل محیط توسعه شما می شود و به مسیری در برنامه شما اشاره می کند.
http://localhost:8080/auth/google/callback
https://myproductionurl.example.com/auth/google/callback
روی ایجاد کلیک کنید.
از کادر گفتگوی مشتری OAuth، فایل JSON حاوی پیکربندی کلاینت خود را دانلود کنید. جزئیات مشتری شما شامل موارد زیر است:
این فایل JSON بعداً برای راه‌اندازی کتابخانه Google Auth برای جاوا که با این کتابخانه مشتری کار می‌کند، استفاده خواهد شد.
قبل از اینکه بتوانید یک برنامه عمومی را راه اندازی کنید که به کتابخانه API دسترسی دارد، برنامه شما باید توسط Google بررسی شود. هنگامی که برنامه خود را آزمایش می کنید، پیام "برنامه تایید نشده" روی صفحه ظاهر می شود تا زمانی که تأیید شود.
کتابخانه مشتری را راه اندازی کنید
کتابخانه سرویس گیرنده جاوا همه تماس‌های API پشتیبان را برای شما مدیریت می‌کند و اشیاء دوستانه را برای کار با آنها در معرض دید قرار می‌دهد، از جمله نمونه‌های کد برای برخی از وظایف رایج API. ابتدا، کتابخانه سرویس گیرنده Google Photos Library API برای جاوا را همراه با وابستگی‌ها از GitHub دانلود و نصب کنید. سپس، اعتبارنامه OAuth2 خود را برای جاوا تنظیم کنید.
گزینه های دانلود
در اینجا چند گزینه برای دانلود کتابخانه مشتری وجود دارد:
وابستگی به گرید:
برای استفاده از این کتابخانه با 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 به آن بروید. - فایل
build.gradle در IDE خود باز کنید یا ./gradlew assemble در خط فرمان اجرا کنید تا پروژه را بسازید. برای مشاهده وظایف موجود به ./gradlew tasks مراجعه کنید.
اعتبارنامه OAuth2 خود را برای جاوا تنظیم کنید
این کتابخانه سرویس گیرنده با کتابخانه Google Auth برای جاوا کار می کند. برای اطلاعات بیشتر، به استفاده از OAuth 2.0 با Google API Client Library برای جاوا مراجعه کنید.
هنگام ایجاد PhotoLibrarySettings برای یک شی PhotosLibraryClient ، پیکربندی OAuth مشتری خود را در CredentialsProvider مشخص کنید.
چند نمونه را امتحان کنید
کد زیر را امتحان کنید تا اولین تماس 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
}
نمونه های بیشتری در GitHub وجود دارد که می توانید آنها را امتحان کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده 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."]]
