API 호출

이 문서에서는 Google Site Verification API를 사용하는 방법을 설명합니다.

API 호출

요청 형식

지원되는 대부분의 사이트 확인 작업은 Google Site Verification API 연산에 설명된 대로 REST HTTP 동사 (GET, POST, PUT, DELETE)에 직접 매핑됩니다.

Google Site Verification API URI의 구체적인 형식은 다음과 같습니다.

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

고유 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의 컬렉션 및 리소스에 6가지 메서드를 호출할 수 있습니다. API URL은 https://www.googleapis.com/siteVerification/v1를 기준으로 합니다.

작업 설명 URL 및 구문
list

인증된 사용자의 컬렉션 내에 있는 모든 리소스를 나열합니다.

GET /webResource

list 요청 예를 참고하세요.

insert

사이트 또는 도메인을 확인합니다. 성공하면 사용자의 컬렉션에 새 웹 리소스가 삽입됩니다.

요청 본문: 웹 리소스를 참조하세요.

쿼리 매개변수: verificationMethod 이 요청에 사용할 확인 방법입니다. 가능한 값: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /webResource

insert 요청 예를 참고하세요.

get

특정 웹 리소스의 최신 데이터를 가져옵니다.

GET /webResource/resourceID

get 요청 예를 참조하세요.

업데이트

특정 리소스의 소유자 목록을 수정합니다.

요청 본문: 웹 리소스를 참조하세요.

참고:

  • update를 사용하여 소유자 목록에서 인증된 사용자를 삭제할 수는 없습니다. 대신 delete를 사용하세요.
  • 사이트에 인증 토큰이 없는 모든 사용자를 소유자 목록에서 삭제할 수 있습니다.

PUT /webResource/resourceID

update 요청 예를 참고하세요.

삭제

사용자 컬렉션에서 리소스를 삭제합니다 (사이트가 사용자 소유인지 확인 안 함).

참고:

  • delete를 호출하기 전에 먼저 사이트 또는 도메인에서 인증된 사용자의 확인 토큰을 모두 삭제해야 합니다. 토큰이 남아 있으면 HTTP 400 (잘못된 요청) 오류가 반환됩니다.
  • 삭제는 인증된 사용자의 소유권 데이터에만 영향을 미칩니다. 위임 여부에 상관없이 다른 모든 사용자는 삭제 후에도 소유권을 유지합니다.

DELETE /webResource/resourceID

delete 요청 예시를 참고하세요.

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. insert 작업을 사용하여 Google에 사이트 소유자임을 인증해 달라고 요청합니다.

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 (콘텐츠 없음) 상태 코드입니다.