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

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

รับบัญชี Google

คุณต้องมีบัญชี Google จึงจะใช้ API นี้ได้ บัญชีของคุณต้องมีสิทธิ์ Search Console ที่เหมาะสมในพร็อพเพอร์ตี้หนึ่งๆ จึงจะเรียกใช้เมธอดนั้นในพร็อพเพอร์ตี้นั้นได้ ตัวอย่างเช่น หากต้องการเรียกใช้ searchAnalytics.query คุณต้องมีสิทธิ์อ่านในพร็อพเพอร์ตี้นั้น

ลองใช้ Google Search Console

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

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

สร้างโปรเจ็กต์และข้อมูลเข้าสู่ระบบสําหรับลูกค้า

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

Search Console API ทั้งหมด ยกเว้น Test Tools API จะต้องใช้ข้อมูลเข้าสู่ระบบ OAuth2 คู่มือเริ่มใช้งานฉบับย่อสําหรับ Python และ Java ให้รายละเอียดเกี่ยวกับวิธีสร้างโปรเจ็กต์และรับข้อมูลเข้าสู่ระบบสําหรับลูกค้า

ทําความเข้าใจ REST พื้นฐาน

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

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

ข้อมูลเบื้องต้นเกี่ยวกับ 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 ใน Google Search Console API

การดําเนินการของ Google Search Console API จะแมปกับคํากริยา HTTP ของ REST โดยตรง

รูปแบบสําหรับ URI ของ Google Search Console API ส่วนใหญ่จะมีลักษณะดังนี้

VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters

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

ทําความเข้าใจพื้นฐาน JSON

Google Search Console API แสดงผลข้อมูลในรูปแบบ JSON

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