เริ่มต้นใช้งานไลบรารีของไคลเอ็นต์ 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 นี้ ผู้ใช้ต้องลงชื่อเข้าใช้บัญชี บัญชี

กำหนดค่าแอป

เปิดใช้ API

ก่อนที่จะใช้ Library API ได้ คุณต้องเปิดใช้ API สำหรับโปรเจ็กต์ก่อน

  1. ไปที่คอนโซล Google API
  2. จากแถบเมนู ให้เลือกโปรเจ็กต์หรือสร้างโปรเจ็กต์ใหม่
  3. หากต้องการเปิดไลบรารี Google API จากเมนูการนำทาง ให้เลือก API และ บริการ > คลัง
  4. ค้นหา "Google Photos Library API" เลือกผลลัพธ์ที่ถูกต้องและคลิก เปิดใช้

ขอรหัสไคลเอ็นต์ OAuth 2.0

ทําตามขั้นตอนด้านล่างเพื่อขอรหัสไคลเอ็นต์ OAuth และกําหนดค่าให้กับ แอปพลิเคชัน ตัวอย่างนี้ใช้แอปพลิเคชันที่ขั้นตอน OAuth ทั้งหมด ฝั่งเซิร์ฟเวอร์ที่จัดการ อย่างเช่นในตัวอย่างของเรา ขั้นตอนการตั้งค่าอาจแตกต่างกันไป เพื่อดูสถานการณ์การใช้งานอื่นๆ

  1. ไปที่คอนโซล Google API แล้วเลือกโปรเจ็กต์
  2. จากเมนู ให้เลือก API & บริการ > ข้อมูลเข้าสู่ระบบ
  3. ในหน้าข้อมูลเข้าสู่ระบบ ให้คลิกสร้างข้อมูลเข้าสู่ระบบ > รหัสไคลเอ็นต์ OAuth
  4. เลือกประเภทแอปพลิเคชัน ในตัวอย่างนี้ ประเภทแอปพลิเคชันคือ เว็บแอปพลิเคชัน
  5. ลงทะเบียนต้นทางที่แอปของคุณได้รับอนุญาตให้เข้าถึง Google APIs ดังนี้

    1. หากต้องการระบุรหัสไคลเอ็นต์ ให้ป้อนชื่อ
    2. ในช่องต้นทาง JavaScript ที่ได้รับอนุญาต ให้ป้อนต้นทาง แอป ช่องนี้ไม่อนุญาตให้ใช้ไวลด์การ์ด

      คุณป้อนต้นทางหลายแห่งได้เพื่อให้แอปทำงานบน โปรโตคอล โดเมน หรือโดเมนย่อย URL ที่คุณป้อนได้รับอนุญาตให้ เริ่มคำขอ OAuth

      ตัวอย่างต่อไปนี้แสดง URL การพัฒนาในเครื่อง (ตัวอย่างของเราใช้ localhost:8080) และ URL เวอร์ชันที่ใช้งานจริง

      http://localhost:8080
      https://myproductionurl.example.com
      
    3. ช่อง URL การเปลี่ยนเส้นทางที่ได้รับอนุญาตคือปลายทางที่รับ การตอบกลับจากเซิร์ฟเวอร์ OAuth 2.0 โดยปกติแล้วจะรวมถึง การพัฒนาซอฟต์แวร์และชี้ไปยังเส้นทางในแอปพลิเคชันของคุณ

      http://localhost:8080/auth/google/callback
      https://myproductionurl.example.com/auth/google/callback
      
    4. คลิกสร้าง

  1. ดาวน์โหลดไฟล์ JSON จากกล่องโต้ตอบไคลเอ็นต์ OAuth ที่แสดง ที่มีการกำหนดค่าไคลเอ็นต์ของคุณ รายละเอียดไคลเอ็นต์ของคุณประกอบด้วย ดังต่อไปนี้:

    • Client-ID
    • รหัสลับไคลเอ็นต์

    ระบบจะใช้ไฟล์ JSON นี้เพื่อตั้งค่าในภายหลัง ไลบรารีการตรวจสอบสิทธิ์ของ Google สำหรับ Java ซึ่งทำงานร่วมกับไลบรารีของไคลเอ็นต์นี้

ก่อนที่คุณจะสามารถเปิดแอปพลิเคชันสาธารณะที่เข้าถึง Library API ได้ แอปของคุณต้องได้รับการตรวจสอบจาก Google "แอปที่ไม่ได้รับการยืนยัน" ปรากฏใน เมื่อคุณทดสอบแอปพลิเคชัน จนกว่าจะ ได้รับการยืนยันแล้ว

ตั้งค่าไลบรารีไคลเอ็นต์

ไลบรารีของไคลเอ็นต์ Java จะจัดการการเรียก API แบ็กเอนด์ทั้งหมดให้คุณ และจะแสดง ออบเจ็กต์ friendly ที่ต้องทำงานด้วย ซึ่งรวมถึงตัวอย่างโค้ดสำหรับงาน API ทั่วไปบางรายการ ขั้นแรก ให้ดาวน์โหลดและติดตั้งไลบรารีของไคลเอ็นต์ Google Photos Library API สำหรับ Java ด้วยทรัพยากร Dependency จาก GitHub จากนั้นตั้งค่าข้อมูลเข้าสู่ระบบ OAuth2 สำหรับ Java

ตัวเลือกการดาวน์โหลด

ตัวเลือกในการดาวน์โหลดไลบรารีของไคลเอ็นต์มีดังนี้

  • ทรัพยากร Dependency ของ Gradle:

    หากต้องการใช้ไลบรารีนี้กับ Gradle ให้เพิ่ม Dependency ต่อไปนี้ 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ที่ Command Prompt
    2. คุณจะได้รับไดเรกทอรี java-photoslibrary ไปที่หน้าดังกล่าวโดยเรียกใช้ cd java-photoslibrary
    3. เปิดไฟล์ build.gradle ใน IDE หรือเรียกใช้ ./gradlew assemble ที่ พร้อมท์คำสั่งเพื่อสร้างโปรเจ็กต์ ดู ./gradlew tasks งานที่มีอยู่

ตั้งค่าข้อมูลเข้าสู่ระบบ OAuth2 สำหรับ Java

ไลบรารีของไคลเอ็นต์นี้ใช้งานได้กับไลบรารีการตรวจสอบสิทธิ์ของ Google สำหรับ 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 เพื่อให้คุณลองใช้