本文說明如何使用 Google Site Verification API。
叫用 API
要求格式
大多數支援的網站驗證作業直接對應至 REST HTTP 動詞 (GET
、POST
、PUT
、DELETE
),如 Google Site Verification API 作業中所述。
Google Site Verification API URI 的具體格式為:
https://www.googleapis.com/siteVerification/v1/webResource/resourceID?parameters
其中 resourceID
是網站資源的 ID,parameters
是要套用至查詢的參數。實際執行的參數因您執行的作業而異。此外,如果您使用的是 OAuth 2.0,請在這些參數中設定 access_token
。
清單查詢不需要 resourceID,因此格式為:
https://www.googleapis.com/siteVerification/v1/webResource?parameters
您可以透過專屬 URI 呼叫 getToken 作業。呼叫 getToken 的格式為:
https://www.googleapis.com/siteVerification/v1/token?parameters
資料格式
Google Site Verification API 會傳回 JSON 格式的資料。
JSON (JavaScript 物件標記法) 是一種常見的語言獨立資料格式,可透過簡單的文字顯示任意資料結構。詳情請參閱 json.org。
作業摘要
您可以在 Google Site Verification API 中,針對集合和資源叫用六種不同方法,如下表所述。API 網址相對於 https://www.googleapis.com/siteVerification/v1
。
作業 | 說明 | 網址和語法 |
---|---|---|
list | 列出已驗證使用者集合中的所有資源。 |
請參閱清單要求範例。 |
插入 | 驗證網站或網域。如果成功,將新的網路資源插入使用者集合。 要求主體:請參閱網路資源。 查詢參數: |
請參閱 insert 要求範例。 |
取得 | 取得特定網站資源的最新資料。 |
查看取得要求範例 |
更新 | 修改特定資源的擁有者清單。 要求主體:請參閱網路資源。 注意事項:
|
請參閱更新要求範例。 |
刪除 | 從使用者的集合中移除資源 (確認網站屬於使用者所有)。
|
請參閱刪除要求範例。 |
getToken | 取得驗證權杖,放置在已驗證使用者的網站上。 要求內容:
|
請參閱 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" } }
擷取已驗證網路資源的資訊
你可以透過呼叫清單,擷取已驗證網站和網域的完整清單。您可以呼叫 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 來委派及撤銷擁有權。刪除刪除即可自行移除擁有權。
更新 (需要授權)
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 (無內容) 狀態碼,表示成功。