ข้อกำหนดที่จำเป็น

ก่อนที่จะเริ่มเขียนโค้ดแอปพลิเคชันไคลเอ็นต์แรก คุณต้องดําเนินการบางอย่างดังต่อไปนี้หากยังไม่ได้ทํา

รับบัญชี Google

คุณต้องมีบัญชี Google เพื่อสร้างโปรเจ็กต์ในคอนโซล Google API หากมีบัญชีอยู่แล้ว เท่านี้ก็เรียบร้อย

คุณอาจต้องการบัญชี Google แยกต่างหากสําหรับการทดสอบ

ลองใช้ Google Search Console

เอกสารประกอบของ API นี้จะถือว่าคุณใช้ Google Search Console และทําความคุ้นเคยกับแนวคิดการเขียนโปรแกรมเว็บและรูปแบบข้อมูลเว็บ

หากคุณยังไม่ได้ใช้ Google Search Console ให้ลองใช้อินเทอร์เฟซผู้ใช้ก่อนที่จะเริ่มเขียนโค้ด

สร้างโปรเจ็กต์สำหรับไคลเอ็นต์

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

หากต้องการเริ่มต้นใช้งาน Search Console API สําหรับ URL ของ Search Console คุณต้องใช้เครื่องมือตั้งค่าซึ่งจะแนะนําการสร้างโปรเจ็กต์ในคอนโซล Google API, การเปิดใช้ API และสร้างข้อมูลเข้าสู่ระบบก่อน

หากยังไม่ได้สร้างคีย์ ให้สร้างคีย์ API ของแอปพลิเคชันโดยคลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API ถัดไป ให้มองหาคีย์ API ในส่วนคีย์ API

ดูข้อมูลเบื้องต้นเกี่ยวกับ REST

การเรียก API ทําได้ 2 วิธี ดังนี้

หากคุณเลือกที่จะไม่ใช้ไลบรารีของไคลเอ็นต์ คุณจะต้องเข้าใจข้อมูลพื้นฐานของ REST

REST เป็นสถาปัตยกรรมซอฟต์แวร์แบบหนึ่งซึ่งเป็นวิธีที่สะดวกและสอดคล้องกันในการขอและแก้ไขข้อมูล

คําว่า REST ย่อมาจาก "Agentational Transfer" (การโอนสถานะตัวแทน) ในบริบทของ Google APIs หมายถึงการใช้คํากริยา HTTP เพื่อเรียกและแก้ไขข้อมูลที่แสดงโดย Google

ในระบบ RESTful ระบบจะจัดเก็บทรัพยากรไว้ในที่เก็บข้อมูล ไคลเอ็นต์ส่งคําขอที่เซิร์ฟเวอร์ดําเนินการบางอย่าง (เช่น สร้าง ดึง อัปเดต หรือลบทรัพยากร) แล้วเซิร์ฟเวอร์จะดําเนินการตามนั้นและส่งการตอบกลับ โดยมักอยู่ในรูปแบบของการแสดงทรัพยากรที่ระบุ

ใน RESTful API ของ Google ไคลเอ็นต์จะระบุการดําเนินการโดยใช้คํากริยา HTTP เช่น POST, GET, PUT หรือ DELETE ซึ่งระบุทรัพยากรตาม URI ที่ไม่ซ้ําทั่วโลกในรูปแบบต่อไปนี้

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

เนื่องจากทรัพยากร API ทั้งหมดมี URI ที่เข้าถึงได้ด้วย HTTP ที่ไม่ซ้ํากัน REST จะเปิดใช้การแคชข้อมูลและได้รับการเพิ่มประสิทธิภาพให้ทํางานร่วมกับโครงสร้างพื้นฐานที่จัดจําหน่ายในเว็บ

ดูคําจํากัดความเมธอดในเอกสารประกอบของมาตรฐาน HTTP 1.1 ที่เป็นประโยชน์ ซึ่งมีข้อกําหนดของ GET, POST, PUT และ DELETE

REST ใน API เครื่องมือทดสอบของ Search Console

การดําเนินการของ URL ของเครื่องมือทดสอบ URL ของ Search Console จะแมปกับคํากริยา HTTP ของ REST โดยตรง

รูปแบบที่เฉพาะเจาะจงสําหรับ URI ของเครื่องมือทดสอบ URL ของ Search Console มีดังนี้

https://www.googleapis.com/webmaster-tools/search-console-api/v1/resourcePath?parameters

ชุด URI ทั้งหมดที่ใช้สําหรับการดําเนินการที่รองรับแต่ละรายการใน API จะสรุปไว้ในเอกสารการอ้างอิง API เครื่องมือทดสอบของ Search Console

ดูข้อมูลเบื้องต้นเกี่ยวกับ JSON

API เครื่องมือทดสอบของ Search Console จะแสดงผลข้อมูลในรูปแบบ JSON

JSON (JavaScript Object Notation) เป็นรูปแบบข้อมูลทั่วไปที่ใช้ภาษาทั่วไป ซึ่งแสดงถึงโครงสร้างข้อความที่เรียบง่ายในรูปแบบข้อความ ดูข้อมูลเพิ่มเติมได้ที่ json.org