叫用 API

本文說明如何使用 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 Object Notation) 是一種不涉及語言的常用資料格式，可透過簡單的文字呈現多種資料結構。詳情請參閱 json.org。

作業摘要

您可以在 Google Site Verification API 中對集合和資源叫用六種不同的方法，如下表所述。API 網址與 https://www.googleapis.com/siteVerification/v1 相對。

作業 說明 網址和語法
list

列出已驗證使用者集合內的所有資源。

GET /webResource

請參閱清單要求範例。
插入

驗證網站或網域。如果成功，會將新的網路資源插入使用者的集合。

要求主體：請參閱網路資源。

查詢參數：verificationMethod。用於這項要求的驗證方法。可能的值：FILE、META、ANALYTICS、TAG_MANAGER、DNS_TXT、DNS_CNAME

POST /webResource

請參閱插入要求範例。
取得

取得特定網路資源的最新資料。

GET /webResource/resourceID

請參閱 get 要求範例
更新

修改特定資源的擁有者清單。

要求主體：請參閱網路資源。

注意事項：

  • 您無法使用 update 將已驗證使用者從擁有者清單中移除，請改用 delete。
  • 您可以將網站上沒有驗證權杖的使用者從擁有者清單中移除。

PUT /webResource/resourceID

請參閱 更新 要求範例。
刪除

從使用者的集合中移除資源 (確認網站為使用者所有)。

注意：

  • 您必須先將已驗證使用者的所有驗證權杖從網站或網域中移除，才能呼叫 delete。如果仍有權杖存在，則會傳回 HTTP 400 (錯誤要求) 錯誤。
  • 刪除作業只會影響已驗證使用者的擁有權資料。其他使用者 (無論是委派或獨立驗證) 在刪除後仍保有擁有權。

DELETE /webResource/resourceID

請參閱刪除要求範例。
getToken

取得要放在已驗證使用者網站上的驗證權杖。

要求主體：

  • identifier：網站網址或網域名稱。
  • 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"
  }
}

擷取已驗證網路資源的資訊

您可以呼叫 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"
  }
}

修改驗證資訊

如要委派及撤銷擁有權，請呼叫 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 (無內容) 狀態碼，表示成功。