מוצג לך תיעוד של הגרסה הקודמת של Google Photos Library API.
תחילת העבודה עם ספריית הלקוח של Java
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
כדי להתחיל להשתמש ב-Google Photos Library API עם ספריית הלקוח של Java, צריך:
להגדיר את ספריית הלקוח בסביבת הפיתוח שלכם.
לפני כן, צריך להגדיר את הפרויקט על ידי הפעלת ה-API
דרך מסוף Google API ומגדירים מזהה לקוח OAuth 2.0.
האפליקציה מקיימת אינטראקציה עם Google Photos בשם
משתמש ב-Google Photos. למשל, כשיוצרים אלבומים
ספריית Google Photos או העלאת פריטי מדיה לחשבון של משתמש
חשבון Google Photos, המשתמש אישר את בקשות ה-API האלה דרך
פרוטוקול OAuth 2.0.
מזהה הלקוח ב-OAuth 2.0 מאפשר למשתמשי האפליקציה להיכנס לחשבון, לבצע אימות
וכך להשתמש ב-Library API. ה-Library API לא תומך
חשבונות שירות; כדי להשתמש ב-API הזה, המשתמשים חייבים להיכנס לחשבון Google תקין
חשבון.
הפעלת ה-API
לפני שתוכלו להשתמש ב-Library API, עליכם להפעיל אותו בפרויקט שלכם.
- עוברים אל Google API Console.
- בסרגל התפריטים, בוחרים פרויקט או יוצרים פרויקט חדש.
- כדי לפתוח את ספריית Google API, בתפריט הניווט בוחרים
ממשקי API שירותים > ספרייה.
- מחפשים את Google Photos Library API. בוחרים את התוצאה המתאימה ולוחצים על
הפעלה.
בקשת מזהה לקוח ב-OAuth 2.0
כדי לבקש מזהה לקוח ב-OAuth ולהגדיר אותו עבור
תרגום מכונה. בדוגמה הזו נעשה שימוש באפליקציה שבה כל זרימת OAuth
בצד השרת, כמו זה שמופיע בדוגמאות שלנו. תהליך ההגדרה עשוי להשתנות
לתרחישי הטמעה אחרים.
- עוברים אל Google API Console
ובוחרים את הפרויקט.
- בתפריט, בוחרים באפשרות APIs & שירותים > פרטי כניסה.
- בדף Credentials, לוחצים על Create Credentials > מזהה הלקוח ב-OAuth.
- בוחרים את Application type (סוג האפליקציה). בדוגמה הזו, סוג האפליקציה הוא
אפליקציית אינטרנט.
רישום המקורות שמהם האפליקציה מורשית לגשת ל-Google APIs
ככה:
- כדי לזהות את מזהה הלקוח, מזינים שם.
בשדה מקורות JavaScript מורשים, מזינים את המקור של
אפליקציה. בשדה הזה אי אפשר להשתמש בתווים כלליים לחיפוש.
אפשר להזין כמה מקורות כדי לאפשר לאפליקציה לפעול במכשירים שונים
פרוטוקולים, דומיינים או תת-דומיינים. כתובות ה-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 ל-Java שפועלת עם ספריית הלקוח הזו.
לפני שמפעילים אפליקציה ציבורית שניגשת ל-Library API,
האפליקציה חייבת להיבדק על ידי Google. 'אפליקציה לא מאומתת' ההודעה תופיע
בזמן בדיקת האפליקציה, עד
מאומת.
הגדרה של ספריית הלקוח
ספריית הלקוח של Java מטפלת עבורכם בכל הקריאות ל-API בקצה העורפי, וחושפת את המשתמשים
אובייקטים ידידותיים לעבודה, כולל דוגמאות קוד לכמה משימות API נפוצות.
קודם כול, מורידים ומתקינים את ספריית הלקוח של Google Photos Library API ל-Java
עם יחסי התלות מ-GitHub.
לאחר מכן, מגדירים את פרטי הכניסה של OAuth2 ל-Java.
אפשרויות הורדה
יש כמה דרכים להוריד את ספריית הלקוח:
תלות ב-Gradle:
כדי להשתמש בספרייה הזו עם Gradle, צריך להוסיף את התלות הבאה
קובץ build.gradle.
repositories {
mavenCentral()
}
dependencies {
compile 'com.google.photos.library:google-photos-library-client:1.7.3'
}
תלות של Maven:
כדי להשתמש בספרייה הזו עם Maven, צריך להוסיף את הפריטים הבאים ל-pom.xml של Maven
חדש.
<dependency>
<groupId>com.google.photos.library</groupId>
<artifactId>google-photos-library-client</artifactId>
<version>1.7.3</version>
</dependency>
כדי להוריד גרסה:
דף פריטי התוכן
מכיל פריטי מידע שונים לכל גרסה של ספרייה, כולל קובצי מאגר.
משכפלים את המאגר:
כדאי להשתמש בשיטה הזו אם אתם רוצים לשנות את הספרייה הזו או לתרום לה,
למשל, שליחת בקשות משיכה או אם אתם רוצים לנסות את הדוגמאות שלנו. אחרי ש
לשכפל את המאגר, תתבצע הורדה של כל הקבצים במאגר.
- הריצו את
git clone https://github.com/google/java-photoslibrary.git ב-
שורת הפקודה.
- תקבלו ספרייה של
java-photoslibrary. כדי להגיע ליעד, מריצים את
cd java-photoslibrary
- יש לפתוח את הקובץ
build.gradle בסביבת הפיתוח המשולבת (IDE) או להריץ את ./gradlew assemble
שורת הפקודה כדי לבנות את הפרויקט. אפשר לראות אותן בכתובת ./gradlew tasks
למשימות זמינות.
הגדרת פרטי כניסה של OAuth2 ל-Java
ספריית הלקוח הזו פועלת עם ספריית Google Auth עבור
Java. לקבלת מידע נוסף,
קראו את המאמר שימוש ב-OAuth 2.0 עם ספריית הלקוח של Google API עבור
Java.
צריך לציין את הגדרת ה-OAuth של הלקוח בCredentialsProvider כש
שיוצרות את PhotoLibrarySettings לאובייקט PhotosLibraryClient.
רוצה לנסות כמה דוגמאות?
כדאי לנסות את הקוד שבהמשך כדי לבצע את הקריאה הראשונה ל-API באמצעות ספריית הלקוח של Java.
// 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 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-29 (שעון UTC).
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2025-08-29 (שעון UTC)."],[[["\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."]]
