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

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

รับบัญชี Google

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

ลองใช้ Google Search Console

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

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

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

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

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

ทำความเข้าใจพื้นฐานของ REST

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

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

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

คำว่า REST เป็นคำสั้นๆ ของ "Assignational State 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