เอกสารนี้จะอธิบายวิธีใช้ Google Site Verification API
การเรียกใช้ API
รูปแบบคําขอ
การดําเนินการส่วนใหญ่ในการยืนยันเว็บไซต์ที่รองรับจะแมปกับคํากริยา REST ที่ใช้ HTTP (GET
, POST
, PUT
, DELETE
) โดยตรงตามที่อธิบายไว้ในการทํางานของ Google Site Verification API
รูปแบบเฉพาะสําหรับ URI ของ Google Site Verification API ได้แก่
https://www.googleapis.com/siteVerification/v1/webResource/resourceID?parameters
โดยที่ resourceID
คือตัวระบุสําหรับทรัพยากรเว็บ parameters
คือพารามิเตอร์ที่จะใช้กับการค้นหา พารามิเตอร์ที่ใช้จริงจะแตกต่างกันไปขึ้นอยู่กับการดําเนินการที่คุณทํา นอกจากนี้ หากคุณใช้ OAuth 2.0 คุณควรตั้งค่า access_token
ในพารามิเตอร์เหล่านี้
การค้นหารายการไม่จําเป็นต้องใช้ resourceID ดังนั้นรูปแบบคือ
https://www.googleapis.com/siteVerification/v1/webResource?parameters
คุณเรียกการดําเนินการ getToken ตาม URI ที่ไม่ซ้ําของตนเองได้ รูปแบบสําหรับการเรียก getToken มีดังนี้
https://www.googleapis.com/siteVerification/v1/token?parameters
รูปแบบข้อมูล
Google Site Verification API ส่งคืนข้อมูลในรูปแบบ JSON
JSON (JavaScript Object Notation) เป็นรูปแบบข้อมูลทั่วไปที่ไม่ใช่ภาษาที่นําเสนอข้อความในรูปแบบง่ายๆ ของโครงสร้างข้อมูลที่กําหนดเอง ดูข้อมูลเพิ่มเติมได้ที่ json.org
สรุปการดําเนินการ
คุณเรียกใช้คอลเล็กชันสําหรับแหล่งข้อมูลและทรัพยากรใน Google Site Verification API ได้ 6 วิธีตามที่อธิบายไว้ในตารางต่อไปนี้ URL ของ API จะสัมพันธ์กับ https://www.googleapis.com/siteVerification/v1
การดำเนินการ | คำอธิบาย | URL และไวยากรณ์ |
---|---|---|
list | แสดงรายการทรัพยากรทั้งหมดภายในคอลเล็กชันของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว |
|
แทรก | ยืนยันเว็บไซต์หรือโดเมน หากสําเร็จ ให้แทรกแหล่งข้อมูลทางเว็บใหม่ลงในคอลเล็กชันของผู้ใช้ เนื้อหาของคําขอ: ดูแหล่งข้อมูลในเว็บ พารามิเตอร์การค้นหา: |
โปรดดูตัวอย่างคําขอ insert |
รับ | รับข้อมูลล่าสุดของทรัพยากรเว็บบางรายการ |
|
อัปเดต | แก้ไขรายชื่อเจ้าของทรัพยากรที่ต้องการ เนื้อหาของคําขอ: ดูแหล่งข้อมูลในเว็บ หมายเหตุ
|
โปรดดูตัวอย่างคําขออัปเดต |
ลบ | นําแหล่งข้อมูลออกจากคอลเล็กชันของผู้ใช้ (ซึ่งจะยืนยันว่าเว็บไซต์เป็นของผู้ใช้)
|
โปรดดูตัวอย่างคําขอลบ |
โทเค็น | รับโทเค็นการยืนยันเพื่อใช้ในเว็บไซต์ที่ผ่านการตรวจสอบสิทธิ์ของผู้ใช้ เนื้อหาของคําขอ:
|
โปรดดูตัวอย่างคําขอ getToken |
ตัวอย่างการเรียก API
ส่วนนี้จะถือว่าคุณ (นักพัฒนาแอป) เป็นผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์แล้วด้วย ซึ่งเหมือนกับกรณีที่คุณใช้ API เป็นครั้งแรกโดยใช้ข้อมูลการทดสอบของคุณเอง
ยืนยันเว็บไซต์ใหม่
หากต้องการยืนยันเว็บไซต์
- โดยขั้นแรก ให้ขอโทเค็นการยืนยันโดยเรียก getToken
- วางโทเค็นในเว็บไซต์ด้วยวิธีใดก็ได้ตามต้องการ
- ขอให้ Google ยืนยันว่าเว็บไซต์เป็นของคุณจริงโดยใช้การดําเนินการ insert
getToken (ต้องได้รับสิทธิ์)
POST https://www.googleapis.com/siteVerification/v1/token?access_token=
oauth2-token
คําขอ:
POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token
Content-Type: application/json
{
"verificationMethod": "FILE",
"site": {
"identifier": "http://www.example.com",
"type": "SITE"
}
}
คําตอบ:
{ "token": "google12cfc68677988bb4.html", "method": "FILE" }
แทรก (ต้องได้รับสิทธิ์)
POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=
oauth2-token
คําขอ:
POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token
Content-Type: application/json
{
"site": {
"identifier": "http://www.example.com",
"type": "SITE"
}
}
คําตอบ:
{ "owners": [ "myself@example.com", ], "id": "http%3A%2F%2Fwww.example.com%2F", "site": { "identifier": "http://www.example.com/", "type": "SITE" } }
เรียกข้อมูลสําหรับทรัพยากรบนเว็บที่ยืนยันแล้ว
คุณสามารถเรียกรายการเว็บไซต์และโดเมนที่ยืนยันแล้วทั้งหมดได้โดยการเรียก list คุณสามารถเรียกดูข้อมูลสําหรับทรัพยากรเว็บรายการเดียวได้โดยเรียกใช้ get
รายการ (ต้องได้รับสิทธิ์)
GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=
oauth2-token
คําขอ:
GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token
คําตอบ:
{ "items": [ { "owners": [ "myself@example.com", ], "id": "http%3A%2F%2Fwww.example.com%2F", "site": { "identifier": "http://www.example.com/site1", "type": "SITE" } }, { "owners": [ "myself@example.com", ], "id": "http%3A%2F%2Fwww.example.com%2F", "site": { "identifier": "http://www.example.com/site2", "type": "SITE" } } ] }
ดาวน์โหลด (ต้องได้รับสิทธิ์)
GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=
oauth2-token
คําขอ:
GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
คําตอบ:
{ "owners": [ "myself@example.com", ], "id": "http%3A%2F%2Fwww.example.com%2F", "site": { "identifier": "http://www.example.com/", "type": "SITE" } }
แก้ไขข้อมูลการยืนยัน
คุณมอบสิทธิ์และเพิกถอนการเป็นเจ้าของได้โดยเรียกใช้การอัปเดต คุณนําการเป็นเจ้าของออกได้ด้วยตนเองโดยโทรหาลบ
อัปเดต (ต้องได้รับสิทธิ์)
PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=
oauth2-token
คําขอ:
PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
Content-Type: application/json
{
"owners": [
"myself@example.com",
"another@example.com",
],
"id": "http%3A%2F%2Fwww.example.com%2F",
"site": {
"identifier": "http://www.example.com",
"type": "SITE"
}
}
คําตอบ:
{ "owners": [ "myself@example.com", "another@example.com", ], "id": "http%3A%2F%2Fwww.example.com%2F", "site": { "identifier": "http://www.example.com/", "type": "SITE" } }
ลบ (ต้องได้รับสิทธิ์)
DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=
oauth2-token
คําขอ:
DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
คําตอบ:
รหัสสถานะ HTTP 204 (ไม่มีเนื้อหา) ซึ่งระบุความสําเร็จ