Trang này được dịch bởi Cloud Translation API.

Gọi API

Tài liệu này mô tả cách sử dụng Google Site Verification API.

Gọi API

Định dạng yêu cầu

Hầu hết các thao tác Xác minh trang web được hỗ trợ đều liên kết trực tiếp đến các động từ HTTP REST (GET, POST, PUT, DELETE), như mô tả trong hoạt động của Google Site Verification API.

Định dạng cụ thể cho URI API Xác minh trang web của Google là:

https://www.googleapis.com/siteVerification/v1/webResource/resourceID?parameters

trong đó resourceID là giá trị nhận dạng một tài nguyên trên web, còn parameters là mọi tham số áp dụng cho truy vấn. Các thông số thực tế mà bạn sử dụng sẽ khác nhau tuỳ thuộc vào thao tác mà bạn đang thực hiện. Ngoài ra, nếu đang sử dụng OAuth 2.0, bạn nên đặt access_token trong các tham số này.

Truy vấn danh sách không yêu cầu resourceID, vì vậy định dạng là:

https://www.googleapis.com/siteVerification/v1/webResource?parameters

Bạn có thể thực hiện lệnh gọi đến thao tác getToken bằng URI duy nhất của riêng lệnh đó. Định dạng của lệnh gọi đến getToken là:

https://www.googleapis.com/siteVerification/v1/token?parameters

Định dạng dữ liệu

API Google Site Verification trả về dữ liệu ở định dạng JSON.

JSON (Ký hiệu đối tượng JavaScript) là một định dạng dữ liệu phổ biến, không phụ thuộc vào ngôn ngữ, cung cấp bản trình bày văn bản đơn giản của các cấu trúc dữ liệu tùy ý. Để biết thêm thông tin, hãy xem json.org.

Tóm tắt hoạt động

Bạn có thể gọi 6 phương thức khác nhau đối với các bộ sưu tập và tài nguyên trong Google Site Verification API, như được mô tả trong bảng sau. Các URL API có liên quan đến https://www.googleapis.com/siteVerification/v1.

Hoạt động	Mô tả	URL và cú pháp
list	Liệt kê tất cả tài nguyên trong tập hợp của người dùng đã xác thực.	`GET /webResource` Xem ví dụ về yêu cầu danh sách.
chèn	Xác minh trang web hoặc miền. Nếu thành công, hãy chèn một tài nguyên web mới vào bộ sưu tập của người dùng. Nội dung yêu cầu: Xem phần Tài nguyên web. Tham số truy vấn: `verificationMethod`. Phương thức xác minh cần sử dụng cho yêu cầu này. Giá trị có thể là: `FILE`, `META`, `ANALYTICS`, `TAG_MANAGER`, `DNS_TXT`, `DNS_CNAME`	`POST /webResource` Hãy xem ví dụ về yêu cầu chèn.
nhận	Lấy dữ liệu mới nhất của một tài nguyên cụ thể trên web.	`GET /webResource/resourceID` Xem ví dụ về yêu cầu get
cập nhật	Sửa đổi danh sách chủ sở hữu của một tài nguyên cụ thể. Nội dung yêu cầu: Xem phần Tài nguyên web. Lưu ý: Bạn không thể xóa người dùng đã xác thực khỏi danh sách chủ sở hữu bằng cách sử dụng update. Thay vào đó, hãy sử dụng xoá. Bạn có thể xoá khỏi danh sách chủ sở hữu bất kỳ người dùng nào không có mã xác minh trên trang web.	`PUT /webResource/resourceID` Hãy xem ví dụ về yêu cầu cập nhật.
xóa	Xoá tài nguyên khỏi tập hợp của người dùng (không xác minh rằng trang web thuộc về người dùng). Lưu ý: Trước tiên, bạn phải xoá tất cả mã xác minh của người dùng đã xác thực khỏi trang web hoặc miền trước khi thực hiện lệnh delete. Nếu vẫn còn mã thông báo, thì hệ thống sẽ trả về lỗi HTTP 400 (Yêu cầu không hợp lệ). Việc xoá chỉ ảnh hưởng đến dữ liệu về quyền sở hữu của người dùng đã xác thực. Tất cả những người dùng khác, cho dù họ được uỷ quyền hay đã được xác minh độc lập, vẫn giữ quyền sở hữu sau khi bị xoá.	`DELETE /webResource/resourceID` Xem ví dụ về yêu cầu xoá.
getToken	Lấy mã xác minh để đặt trên trang web của người dùng đã xác thực. Nội dung yêu cầu: `identifier`: URL của trang web hoặc tên miền. `type`: Loại tài nguyên cần xác minh. Các giá trị có thể là: `SITE`, `INET_DOMAIN`. `verificationMethod`: Phương pháp sử dụng khi xác minh trang web của bạn. Giá trị có thể là: `FILE`, `META`, `ANALYTICS`, `TAG_MANAGER`, `DNS_TXT`, `DNS_CNAME`	`POST /token` Xem ví dụ về yêu cầu getToken.

Ví dụ về lệnh gọi API

Phần này giả định rằng bạn (nhà phát triển) cũng là người dùng đã xác thực, giống như trong trường hợp bạn dùng thử API lần đầu tiên bằng dữ liệu kiểm thử của riêng mình.

Xác minh một trang web mới

Để xác minh một trang web,

Trước tiên, hãy yêu cầu một mã xác minh bằng cách gọi getToken.
Đặt mã thông báo trên trang web của bạn bằng bất kỳ phương pháp nào bạn chọn.
Yêu cầu Google xác minh rằng trang web là của bạn bằng cách sử dụng thao tác chèn.

getToken (yêu cầu uỷ quyền)

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token

Yêu cầu:

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"
  }
}

Phản hồi:

{
  "token": "google12cfc68677988bb4.html",
  "method": "FILE"
}

Chèn (yêu cầu uỷ quyền)

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token

Yêu cầu:

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"
  }
}

Phản hồi:

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

Truy xuất thông tin cho các tài nguyên web đã xác minh

Bạn có thể truy xuất toàn bộ danh sách các trang web và miền đã xác minh bằng cách gọi list. Bạn có thể truy xuất thông tin cho một tài nguyên web bằng cách gọi get.

Danh sách (yêu cầu uỷ quyền)

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

Yêu cầu:

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

Phản hồi:

{
  "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"
      }
    }
  ]
}

Nhận (yêu cầu uỷ quyền)

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Yêu cầu:

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Phản hồi:

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

Sửa đổi thông tin xác minh

Bạn có thể uỷ quyền và thu hồi quyền sở hữu bằng cách gọi lệnh update. Bạn có thể tự xoá quyền sở hữu bằng cách gọi lệnh delete.

Cập nhật (yêu cầu uỷ quyền)

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Yêu cầu:

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"
  }
}

Phản hồi:

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

Xoá (yêu cầu uỷ quyền)

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Yêu cầu:

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Phản hồi:

Mã trạng thái HTTP 204 (Không có nội dung), cho biết thành công.