با کتابخانه مشتری جاوا شروع کنید

برای شروع استفاده از 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 استفاده کنید، باید آن را برای پروژه خود فعال کنید.

  1. به کنسول API Google بروید.
  2. از نوار منو، یک پروژه را انتخاب کنید یا یک پروژه جدید ایجاد کنید.
  3. برای باز کردن کتابخانه Google API، از منوی پیمایش، APIs & Services > Library را انتخاب کنید.
  4. «Google Photos Library API» را جستجو کنید. نتیجه صحیح را انتخاب کنید و روی Enable کلیک کنید.

شناسه مشتری OAuth 2.0 را درخواست کنید

برای درخواست شناسه مشتری OAuth و پیکربندی آن برای برنامه خود، مراحل زیر را دنبال کنید. این مثال از برنامه‌ای استفاده می‌کند که در آن کل جریان OAuth در سمت سرور مدیریت می‌شود، مانند نمونه‌های ما. فرآیند راه اندازی ممکن است برای سایر سناریوهای پیاده سازی متفاوت باشد.

  1. به کنسول API Google بروید و پروژه خود را انتخاب کنید.
  2. از منو، APIs & Services > Credentials را انتخاب کنید.
  3. در صفحه اعتبارنامه ، روی ایجاد اعتبارنامه > شناسه مشتری OAuth کلیک کنید.
  4. نوع برنامه خود را انتخاب کنید. در این مثال، نوع برنامه کاربردی وب است.
  5. مبداهایی را که برنامه شما از آنجا اجازه دسترسی به APIهای Google را دارد به شرح زیر ثبت کنید:

    1. برای شناسایی شناسه مشتری، یک نام وارد کنید.
    2. در قسمت Authorized JavaScript origins ، مبدا برنامه خود را وارد کنید. این فیلد حروف عام را مجاز نمی‌داند.

      می‌توانید چندین منبع را وارد کنید تا به برنامه‌تان اجازه دهید روی پروتکل‌ها، دامنه‌ها یا زیر دامنه‌های مختلف اجرا شود. URL هایی که وارد می کنید مجاز به شروع درخواست OAuth هستند.

      مثال زیر یک URL توسعه محلی (نمونه های ما localhost:8080 استفاده می کنند) و یک URL تولید را نشان می دهد.

      http://localhost:8080
      https://myproductionurl.example.com
      
    3. قسمت Authorized Redirect URI نقطه پایانی است که پاسخ‌ها را از سرور OAuth 2.0 دریافت می‌کند. به طور معمول، این شامل محیط توسعه شما می شود و به مسیری در برنامه شما اشاره می کند.

      http://localhost:8080/auth/google/callback
      https://myproductionurl.example.com/auth/google/callback
      
    4. روی ایجاد کلیک کنید.

  1. از کادر گفتگوی مشتری 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 است.

  • کلون کردن مخزن:

    اگر می‌خواهید این کتابخانه را تغییر دهید یا در آن مشارکت کنید، از این روش استفاده کنید، برای مثال، درخواست‌های کشش را ارسال کنید، یا اگر می‌خواهید نمونه‌های ما را امتحان کنید. هنگامی که مخزن را کلون می کنید، تمام فایل های موجود در این مخزن دانلود می شوند.

    1. git clone https://github.com/google/java-photoslibrary.git را در خط فرمان اجرا کنید.
    2. شما یک دایرکتوری java-photoslibrary دریافت خواهید کرد. با اجرای cd java-photoslibrary به آن بروید.
    3. فایل 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 وجود دارد که می توانید آنها را امتحان کنید.