Esta página foi traduzida pela API Cloud Translation.

Como invocar a API

Este documento descreve como usar a API Google Site Verification.

Como invocar a API

Formato da solicitação

A maioria das operações de verificação de site compatíveis é mapeada diretamente para os verbos HTTP REST (GET, POST, PUT, DELETE), conforme descrito nas operações da API Google Site Verification.

O formato específico dos URIs da API Google Site Verification é:

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

em que resourceID é o identificador de um recurso da Web, parameters são quaisquer parâmetros a serem aplicados à consulta. Os parâmetros reais usados variam de acordo com a operação realizada. Além disso, se você estiver usando o OAuth 2.0, defina access_token nesses parâmetros.

As consultas de lista não exigem um resourceID. Portanto, o formato é:

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

Você pode fazer chamadas para a operação getToken pelo próprio URI exclusivo. O formato de uma chamada para getToken é:

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

Formato de dados

A API Google Site Verification retorna dados no formato JSON.

JSON (JavaScript Object Notation) é um formato de dados comum e independente de linguagem que oferece uma representação de texto simples das estruturas de dados arbitrárias. Para mais informações, acesse json.org (em inglês).

Resumo das operações

Você pode invocar seis métodos diferentes em coleções e recursos na API Google Site Verification, conforme descrito na tabela a seguir. Os URLs da API são relativos a https://www.googleapis.com/siteVerification/v1.

Operação	Descrição	URL e sintaxe
list	Lista todos os recursos na coleção do usuário autenticado.	`GET /webResource` Veja um exemplo de solicitação list.
inserir	Verifica um site ou domínio. Se for bem-sucedido, insere um novo recurso da Web na coleção do usuário. Corpo da solicitação: consulte Recurso da Web. Parâmetro de consulta: `verificationMethod`. O método de verificação a ser usado para essa solicitação. Valores possíveis: `FILE`, `META`, `ANALYTICS`, `TAG_MANAGER`, `DNS_TXT`, `DNS_CNAME`	`POST /webResource` Consulte o exemplo de solicitação insert.
get	Recebe os dados mais recentes de um recurso da Web específico.	`GET /webResource/resourceID` Veja um exemplo de solicitação get
update	Modifica a lista de proprietários de um recurso específico. Corpo da solicitação: consulte Recurso da Web. Observações: Não é possível remover o usuário autenticado da lista de proprietários com a opção update. Use delete. Você pode remover da lista de proprietários qualquer usuário que não tenha um token de verificação no site.	`PUT /webResource/resourceID` Veja um exemplo de solicitação update.
delete	Remove um recurso da coleção do usuário (não verifica se o site pertence ao usuário). Observações: Primeiro, remova todos os tokens de verificação do usuário autenticado do site ou domínio antes de chamar delete. Se ainda houver tokens, o erro HTTP 400 (solicitação inválida) será retornado. A exclusão afeta apenas os dados de propriedade do usuário autenticado. Todos os outros usuários, delegados ou verificados de forma independente, mantêm a propriedade após a exclusão.	`DELETE /webResource/resourceID` Veja um exemplo de solicitação delete.
getToken.	Recebe o token de verificação a ser colocado no site do usuário autenticado. Corpo da solicitação: `identifier`: o URL do site ou nome de domínio. `type`: o tipo de recurso a ser verificado. Valores possíveis: `SITE`, `INET_DOMAIN`. `verificationMethod`: o método a ser usado na verificação do site. Valores possíveis: `FILE`, `META`, `ANALYTICS`, `TAG_MANAGER`, `DNS_TXT`, `DNS_CNAME`	`POST /token` Veja um exemplo de solicitação getToken.

Exemplos de chamadas de API

Esta seção pressupõe que você (o desenvolvedor) também é o usuário autenticado, como acontece quando você testa a API pela primeira vez com seus próprios dados de teste.

Verificar um novo site

Para verificar um site,

Primeiro solicite um token de verificação chamando getToken.
Coloque o token no seu site usando o método escolhido.
Peça ao Google para verificar se o site é seu usando a operação insert.

getToken (requer autorização)

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

Solicitação:

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

Resposta:

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

Inserir (requer autorização)

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

Solicitação:

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

Resposta:

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

Recuperar informações de recursos verificados da Web

Para recuperar a lista completa de seus sites e domínios verificados, chame list. Você pode recuperar informações de um único recurso da Web chamando get.

Lista (requer autorização)

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

Solicitação:

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

Resposta:

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

Receber (requer autorização)

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

Solicitação:

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

Resposta:

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

Modificar informações de verificação

Você pode delegar e revogar a propriedade chamando update. Para remover sua propriedade, chame delete.

Atualizar (requer autorização)

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

Solicitação:

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

Resposta:

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

Excluir (requer autorização)

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

Solicitação:

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

Resposta:

Código de status HTTP 204 (Sem conteúdo), indicando sucesso.