การเริ่มต้น Java ฉบับย่อ

คู่มือเริ่มใช้งานฉบับย่อนี้จะอธิบายวิธีตั้งค่าแอปพลิเคชันบรรทัดคําสั่งสั้นๆ ที่ส่งคําขอไปยัง YouTube Data API คู่มือเริ่มใช้งานฉบับย่อนี้จะอธิบายวิธีสร้างคําขอ API 2 รายการ

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

สิ่งที่ต้องดำเนินการก่อน

หากต้องการเรียกใช้คู่มือเริ่มต้นฉบับย่อนี้ คุณจะต้องมีสิ่งต่อไปนี้

  • Java 1.7 ขึ้นไป
  • Gradle 2.3 ขึ้นไป
  • การเข้าถึงอินเทอร์เน็ตและเว็บเบราว์เซอร์
  • บัญชี Google

ขั้นตอนที่ 1: ตั้งค่าโปรเจ็กต์และข้อมูลเข้าสู่ระบบ

สร้างหรือเลือกโปรเจ็กต์ในคอนโซล API ทํางานต่อไปนี้ในคอนโซล API สําหรับโปรเจ็กต์ของคุณ

  1. ในแผงไลบรารี ให้ค้นหา YouTube Data API v3 คลิกข้อมูล API นั้นๆ และตรวจสอบว่าได้เปิดใช้ API สําหรับโปรเจ็กต์ของคุณแล้ว

  2. ในแผงข้อมูลเข้าสู่ระบบ ให้สร้างข้อมูลเข้าสู่ระบบ 2 รายการ ดังนี้

    1. สร้างคีย์ API คุณจะใช้คีย์ API เพื่อสร้างคําขอ API ที่ไม่ต้องใช้การให้สิทธิ์ผู้ใช้ เช่น ไม่จําเป็นต้องให้สิทธิ์ผู้ใช้ในการดึงข้อมูลเกี่ยวกับช่อง YouTube สาธารณะ

    2. สร้างรหัสไคลเอ็นต์ OAuth 2.0 ตั้งค่าประเภทแอปพลิเคชันเป็นอื่นๆ คุณต้องใช้ข้อมูลเข้าสู่ระบบ OAuth 2.0 สําหรับคําขอที่ต้องมีการให้สิทธิ์ผู้ใช้ เช่น คุณต้องได้รับสิทธิ์จากผู้ใช้ในการดึงข้อมูลเกี่ยวกับช่อง YouTube ของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วในปัจจุบัน

      ดาวน์โหลดไฟล์ JSON ที่มีข้อมูลเข้าสู่ระบบ OAuth 2.0 ไฟล์มีชื่ออย่างเช่น client_secret_CLIENTID.json โดยที่ CLIENTID คือรหัสไคลเอ็นต์ของโปรเจ็กต์

ขั้นตอนที่ 2: เตรียมโปรเจ็กต์

ทําตามขั้นตอนต่อไปนี้เพื่อเตรียมโปรเจ็กต์ Gradle

  1. เรียกใช้คําสั่งต่อไปนี้ในไดเรกทอรีการทํางานเพื่อสร้างโครงสร้างโปรเจ็กต์ใหม่

    $ gradle init --type basic
$ mkdir -p src/main/java src/main/resources

  2. ย้ายไฟล์ JSON ที่ดาวน์โหลดไว้หลังจากสร้างรหัสไคลเอ็นต์ OAuth 2.0 ไปยังไดเรกทอรี src/main/resources ใต้ไดเรกทอรีที่ทํางาน และเปลี่ยนชื่อไฟล์เป็น client_secret.json

  3. เปิดไฟล์ build.gradle ในไดเรกทอรีการทํางานและแทนที่เนื้อหาของไฟล์ด้วยสิ่งต่อไปนี้

    apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'ApiExample'
sourceCompatibility = 1.7
targetCompatibility = 1.7
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.api-client:google-api-client:1.23.0'
    compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
    compile 'com.google.apis:google-api-services-youtube:v3-revREVISION-CL_VERSION'
}

  4. ในไฟล์ build.gradle คุณต้องแทนที่ตัวแปร REVISION และ CL_VERSION ด้วย 2 ค่าจากเอกสารประกอบเกี่ยวกับไลบรารีของไคลเอ็นต์สําหรับ YouTube Data API ภาพหน้าจอด้านล่างซึ่งแสดงเอกสารประกอบสําหรับ YouTube Analytics API แสดงตําแหน่งที่ตัวแปร 2 ตําแหน่งปรากฏในหน้าเว็บ

    ภาพหน้าจอของการอ้างอิง JavaDoc ที่แสดงวิธีค้นหาค่าของตัวแปร "REVISION" และ "CL_VERSION"

ขั้นตอนที่ 3: ตั้งค่าและเรียกใช้ตัวอย่าง

ใช้วิดเจ็ต API Explorer ในแผงด้านข้างเพื่อรับโค้ดสําหรับดึงข้อมูลเกี่ยวกับช่อง YouTube ของ Google Developers คําขอนี้ใช้คีย์ API เพื่อระบุแอปพลิเคชันของคุณ โดยจะไม่จําเป็นต้องมีการให้สิทธิ์ผู้ใช้หรือสิทธิ์พิเศษจากผู้ใช้ที่เรียกใช้ตัวอย่าง

  1. เปิดเอกสารสําหรับเมธอด channels.list ของ API

  2. ในหน้านั้น ส่วน "Use Case ทั่วไป" มีตารางที่อธิบายวิธีทั่วไปหลายวิธีที่ใช้ รายการแรกในตาราง แสดงรายชื่อผลการค้นหาตามรหัสช่อง

    คลิกสัญลักษณ์โค้ดของรายการแรกเพื่อเปิดและป้อนข้อมูลในตัวสํารวจ API แบบเต็มหน้าจอ

    รูปภาพที่ระบุตําแหน่งลิงก์สัญลักษณ์โค้ดในตารางที่แสดงกรณีการใช้งานสําหรับเอกสารประกอบของ channel.list ข้อความแสดงแทนสําหรับรูปภาพจะระบุรูปภาพเป็นสัญลักษณ์ของโค้ด และระบุกรณีการใช้งานที่เชื่อมโยงกับลิงก์นั้น

  3. ทางด้านซ้ายของโปรแกรมสํารวจ API แบบเต็มหน้าจอจะแสดงข้อมูลต่อไปนี้

    1. ด้านล่างรายการพารามิเตอร์คําขอจะมีรายการพารามิเตอร์ที่เมธอดรองรับ ควรกําหนดค่าพารามิเตอร์ part และ id ค่าพารามิเตอร์ id UC_x5XG1OV2P6uZZ5FSM9Ttw คือรหัสช่อง YouTube ของ Google Developers

    2. ด้านล่างพารามิเตอร์จะมีส่วนชื่อข้อมูลเข้าสู่ระบบ เมนูแบบเลื่อนลงในส่วนดังกล่าวควรแสดงค่าคีย์ API โปรแกรมสํารวจ APIs ใช้ข้อมูลเข้าสู่ระบบสาธิตโดยค่าเริ่มต้นเพื่อให้เริ่มต้นใช้งานได้ง่ายขึ้น แต่คุณต้องใช้คีย์ API ของคุณเองเพื่อเรียกใช้ตัวอย่างในเครื่อง

      รูปภาพที่แสดง "ข้อมูลเข้าสู่ระบบ" ในโปรแกรมสํารวจ API แบบเต็มหน้าจอ และเมนูแบบเลื่อนลงที่มีตัวเลือก "คีย์ API" ที่เลือกไว้

  4. ที่ด้านขวาของโปรแกรมสํารวจ APIs แบบเต็มหน้าจอจะแสดงแท็บที่มีตัวอย่างโค้ดในภาษาต่างๆ เลือกแท็บ Java

  5. คัดลอกตัวอย่างโค้ดแล้วบันทึกในไฟล์ชื่อ src/main/java/ApiExample.java ตัวอย่างทุกรายการใช้ชื่อคลาส (ApiExample) เดียวกัน คุณจึงไม่จําเป็นต้องแก้ไขไฟล์ build.gradle เพื่อเรียกใช้ตัวอย่างที่แตกต่างกัน

  6. ในตัวอย่างที่คุณดาวน์โหลด ให้ค้นหาสตริง YOUR_API_KEY แล้วแทนที่ด้วยคีย์ API ที่คุณสร้างขึ้นในขั้นตอนที่ 1 ของคู่มือเริ่มใช้งานฉบับย่อนี้

  7. เรียกใช้ตัวอย่างจากบรรทัดคําสั่ง ในไดเรกทอรีที่ใช้งานอยู่ ให้เรียกใช้:

    gradle -q run

  8. ตัวอย่างควรเรียกใช้คําขอและพิมพ์การตอบกลับไปยัง STDOUT

ขั้นตอนที่ 4: เรียกใช้คําขอที่ได้รับอนุญาต

ในขั้นตอนนี้ คุณจะแก้ไขตัวอย่างโค้ดเพื่อให้ดึงข้อมูลเกี่ยวกับช่อง YouTube ของ Google Developers แทนการดึงข้อมูลเกี่ยวกับช่อง YouTube ของคุณ คําขอนี้ต้องได้รับอนุญาตจากผู้ใช้

  1. กลับไปที่เอกสารประกอบของเมธอด channels.list ของ API

  2. ในส่วน "กรณีการใช้งานทั่วไป" ให้คลิกสัญลักษณ์โค้ดของรายการที่ 3 ในตาราง กรณีการใช้งานดังกล่าวคือการเรียกใช้เมธอด list สําหรับ "ช่องของฉัน"

  3. เช่นเดียวกัน ทางด้านซ้ายของโปรแกรมสํารวจ APIs แบบเต็มหน้าจอ คุณจะเห็นรายการพารามิเตอร์ตามด้วยส่วนข้อมูลเข้าสู่ระบบ อย่างไรก็ตาม จะมีการเปลี่ยนแปลง 2 ประการจากตัวอย่างที่คุณดึงข้อมูลเกี่ยวกับช่อง Google Developers

    1. ในส่วนพารามิเตอร์ แทนที่จะตั้งค่าพารามิเตอร์ id ควรกําหนดค่าพารามิเตอร์ mine เป็น true การทําเช่นนี้จะเป็นคําสั่งให้เซิร์ฟเวอร์ API ดึงข้อมูลเกี่ยวกับช่องของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วในปัจจุบัน

    2. ในส่วนข้อมูลเข้าสู่ระบบ เมนูแบบเลื่อนลงควรเลือกตัวเลือกสําหรับ Google OAuth 2.0

      นอกจากนี้ หากคุณคลิกลิงก์แสดงขอบเขต ควรเลือกขอบเขต https://www.googleapis.com/auth/youtube.readonly ด้วย

      ภาพที่แสดงขอบเขตในโปรแกรมสํารวจ API แบบเต็มหน้าจอและเลือกให้ใช้ข้อมูลเข้าสู่ระบบ "Google OAuth 2.0"

  4. เช่นเดียวกับตัวอย่างก่อนหน้านี้ ให้เลือกแท็บ Java คัดลอกตัวอย่างโค้ด แล้วบันทึกลงใน src/main/java/ApiExample.java

  5. เรียกใช้ตัวอย่างจากบรรทัดคําสั่ง ในไดเรกทอรีที่ใช้งานอยู่ ให้เรียกใช้:

    gradle -q run

  6. ตัวอย่างควรพยายามเปิดหน้าต่างหรือแท็บใหม่ในเบราว์เซอร์เริ่มต้น หากไม่สําเร็จ ให้คัดลอก URL จากเทอร์มินัลแล้วเปิดในเบราว์เซอร์ด้วยตนเอง

    หากยังไม่ได้เข้าสู่ระบบบัญชี Google ระบบจะแจ้งให้คุณลงชื่อเข้าใช้ หากลงชื่อเข้าใช้บัญชี Google หลายบัญชี ระบบจะขอให้คุณเลือก 1 บัญชีที่จะใช้สําหรับการให้สิทธิ์

  7. คลิกปุ่มเพื่ออนุญาตให้แอปพลิเคชันเข้าถึงขอบเขตที่ระบุไว้ในตัวอย่างโค้ด

  8. ตัวอย่างจะดําเนินการต่อโดยอัตโนมัติ และคุณสามารถปิดแท็บเบราว์เซอร์ที่ใช้สําหรับขั้นตอนการตรวจสอบสิทธิ์

    ควรพิมพ์การตอบกลับ API ไปยัง STDOUT อีกครั้ง

อ่านเพิ่มเติม