การเรียกใช้ API

เอกสารนี้จะอธิบายวิธีใช้ Google Site Verification API

การเรียกใช้ API

รูปแบบคำขอ

การดำเนินการยืนยันเว็บไซต์ที่รองรับส่วนใหญ่แมปกับคำกริยา HTTP ของ REST (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

สรุปการดำเนินการ

คุณสามารถเรียกใช้ 6 วิธีในการรวบรวมและทรัพยากรใน Google Site Verification API ดังที่อธิบายไว้ในตารางต่อไปนี้ URL ของ API สัมพันธ์กับ https://www.googleapis.com/siteVerification/v1

การดำเนินการ คำอธิบาย URL และไวยากรณ์
list

แสดงรายการทรัพยากรทั้งหมดภายในคอลเล็กชันของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์

GET /webResource

โปรดดูตัวอย่างคำขอรายการ
แทรก

ยืนยันเว็บไซต์หรือโดเมน หากสำเร็จ จะแทรกทรัพยากรบนเว็บใหม่ลงในคอลเล็กชันของผู้ใช้

เนื้อความของคำขอ: ดูแหล่งข้อมูลบนเว็บ

พารามิเตอร์การค้นหา: verificationMethod วิธีการยืนยันที่ใช้สำหรับคำขอนี้ ค่าที่เป็นไปได้: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /webResource

โปรดดูตัวอย่างคำขอ insert
รับ

รับข้อมูลล่าสุดสำหรับทรัพยากรบนเว็บที่เฉพาะเจาะจง

GET /webResource/resourceID

ดูตัวอย่างคำขอ get
อัปเดต

แก้ไขรายการเจ้าของสำหรับทรัพยากรที่เฉพาะเจาะจง

เนื้อความของคำขอ: ดูแหล่งข้อมูลบนเว็บ

หมายเหตุ

  • คุณไม่สามารถนำผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ออกจากรายการเจ้าของโดยใช้การอัปเดตได้ โปรดใช้ delete แทน
  • คุณสามารถนำรายชื่อผู้ใช้ที่ไม่มีโทเค็นการยืนยันในเว็บไซต์ออกจากรายชื่อเจ้าของได้

PUT /webResource/resourceID

โปรดดูตัวอย่างคำขออัปเดต
ลบ

นำทรัพยากรออกจากคอลเล็กชันของผู้ใช้ (ไม่ยืนยันว่าเว็บไซต์เป็นของผู้ใช้)

หมายเหตุ

  • คุณต้องนำโทเค็นการยืนยันของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์ทั้งหมดออกจากเว็บไซต์หรือโดเมนก่อนที่จะเรียกใช้ delete หากมีโทเค็นเหลืออยู่ ระบบจะแสดงข้อผิดพลาด HTTP 400 (คำขอไม่ถูกต้อง)
  • การลบจะส่งผลต่อข้อมูลการเป็นเจ้าของสำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้วเท่านั้น ส่วนผู้ใช้อื่นๆ ทั้งหมดไม่ว่าจะได้รับมอบสิทธิ์หรือได้รับการยืนยันโดยอิสระ จะยังคงเป็นเจ้าของหลังจากลบไปแล้ว

DELETE /webResource/resourceID

โปรดดูตัวอย่างคำขอลบ
getToken

รับโทเค็นการยืนยันเพื่อวางในเว็บไซต์ของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์

เนื้อหาคำขอ:

  • identifier: URL ของเว็บไซต์หรือชื่อโดเมน
  • type: ประเภทของทรัพยากรที่ต้องยืนยัน ค่าที่เป็นไปได้คือ SITE, INET_DOMAIN
  • verificationMethod: วิธีใช้เมื่อยืนยันเว็บไซต์ของคุณ ค่าที่เป็นไปได้: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /token

โปรดดูตัวอย่างคำขอ getToken

ตัวอย่างการเรียก API

ส่วนนี้จะถือว่าคุณ (นักพัฒนาแอป) เป็นผู้ใช้ที่ตรวจสอบสิทธิ์แล้วเช่นกัน เหมือนกับเวลาที่คุณลองใช้ API กับข้อมูลทดสอบของคุณเองเป็นครั้งแรก

ยืนยันเว็บไซต์ใหม่

วิธียืนยันเว็บไซต์

  1. ก่อนอื่น ให้ขอโทเค็นการยืนยันโดยเรียกใช้ getToken
  2. วางโทเค็นในเว็บไซต์โดยใช้วิธีการที่คุณเลือก
  3. ขอให้ 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"
  }
}

เรียกข้อมูลของแหล่งข้อมูลเว็บที่ได้รับการยืนยันแล้ว

คุณสามารถเรียกดูรายการเว็บไซต์และโดเมนที่ยืนยันแล้วทั้งหมดได้โดยโทรหารายการ คุณเรียกข้อมูลสำหรับแหล่งข้อมูลบนเว็บรายการเดียวได้โดยการเรียกใช้ 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"
  }
}

แก้ไขข้อมูลการยืนยัน

คุณมอบสิทธิ์และเพิกถอนการเป็นเจ้าของได้โดยโทรหา update คุณนำการเป็นเจ้าของสำหรับตัวเองออกได้โดยโทรหา delete

อัปเดต (ต้องมีการให้สิทธิ์)

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 (ไม่มีเนื้อหา) ซึ่งบ่งบอกว่าสำเร็จ