API çağırma

Bu dokümanda, Google Site Doğrulama API'sinin nasıl kullanılacağı açıklanmaktadır.

API'yi çağırma

İstek biçimi

Desteklenen Site Doğrulama işlemlerinin çoğu, Google Site Doğrulama API'si işlemlerinde açıklandığı gibi doğrudan REST HTTP fiilleriyle (GET, POST, PUT, DELETE) eşlenir.

Google Site Doğrulama API URI'leri için özel biçim şu şekildedir:

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

Burada resourceID bir web kaynağının tanımlayıcısıdır, parameters ise sorguya uygulanacak tüm parametrelerdir. Kullandığınız gerçek parametreler, yaptığınız işleme göre değişiklik gösterir. Ayrıca OAuth 2.0 kullanıyorsanız bu parametrelerde access_token değerini ayarlamanız gerekir.

Liste sorguları bir resourceID gerektirmediğinden biçim şu şekildedir:

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

getToken işlemine kendi benzersiz URI'siyle çağrı yapabilirsiniz. getToken çağrısının biçimi aşağıdaki gibidir:

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

Veri biçimi

Google Site Doğrulama API'si, verileri JSON biçiminde döndürür.

JSON (JavaScript Object Notation - JavaScript Nesne Gösterimi), rastgele veri yapılarının basit metin temsilini sağlayan yaygın, dilden bağımsız bir veri biçimidir. Daha fazla bilgi için json.org adresine bakın.

İşlem özeti

Google Site Doğrulama API'sindeki koleksiyonlar ve kaynaklar için aşağıdaki tabloda açıklandığı gibi altı farklı yöntem çağırabilirsiniz. API URL'leri https://www.googleapis.com/siteVerification/v1 ile ilgilidir.

İşlem Açıklama URL ve söz dizimi
list

Kimliği doğrulanmış kullanıcının koleksiyonundaki tüm kaynakları listeler.

GET /webResource

Örnek liste isteğine bakın.

ekle

Bir siteyi veya alanı doğrular. İşlem başarılı olursa kullanıcının koleksiyonuna yeni bir web kaynağı ekler.

İstek gövdesi: Web Kaynağı'na bakın.

Sorgu parametresi: verificationMethod. Bu istek için kullanılacak doğrulama yöntemi. Muhtemel değerler: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /webResource

Örnek insert isteğine bakın.

al

Belirli bir web kaynağı için en son verileri alır.

GET /webResource/resourceID

Örnek get isteğine bakın.

güncelle

Belirli bir kaynağın sahip listesini değiştirir.

İstek gövdesi: Web Kaynağı'na bakın.

Notlar:

  • Kimliği doğrulanmış kullanıcıyı update kullanarak sahipler listesinden kaldıramazsınız. Bunun yerine delete komutunu kullanın.
  • Sitesinde doğrulama jetonu olmayan tüm kullanıcıları sahipler listesinden kaldırabilirsiniz.

PUT /webResource/resourceID

Örnek güncelleme isteğine bakın.

sil

Bir kaynağı kullanıcının koleksiyonundan kaldırır (sitenin kullanıcıya ait olduğunu doğrular).
.
. Notlar:

  • delete komutunu çağırmadan önce, kimliği doğrulanmış kullanıcının tüm doğrulama jetonlarını siteden veya alandan kaldırmanız gerekir. Herhangi bir jeton hâlâ mevcutsa HTTP 400 (Hatalı İstek) hatası döndürülür.
  • Silme işlemi yalnızca kimliği doğrulanmış kullanıcının sahiplik verilerini etkiler. Yetki verilmiş veya bağımsız olarak doğrulanmış diğer tüm kullanıcılar silme işleminden sonra sahipliklerini korur.

DELETE /webResource/resourceID

Örnek silme isteğine bakın.

getToken

Kimliği doğrulanmış kullanıcının web sitesine yerleştirilecek doğrulama jetonunu alır.

İstek içeriği:

  • identifier: Site URL'si veya alan adı.
  • type: Doğrulanacak kaynağın türü. Muhtemel değerler: SITE, INET_DOMAIN.
  • verificationMethod: Sitenizi doğrularken kullanılacak yöntem. Muhtemel değerler: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /token

Örnek getToken isteğine bakın.

Örnek API çağrıları

Bu bölümde, API'yi kendi test verilerinizle ilk kez denediğinizde olduğu gibi, sizin (geliştirici) de kimliği doğrulanmış kullanıcı olduğunuz varsayılır.

Yeni bir siteyi doğrulayın

Bir siteyi doğrulamak için:

  1. Öncelikle getToken çağrısı yaparak bir doğrulama jetonu isteyin.
  2. Tercih ettiğiniz yöntemi kullanarak jetonu sitenize yerleştirin.
  3. Google'dan, insert işlemini kullanarak sitenin size ait olduğunu doğrulamasını isteyin.

getToken (yetkilendirme gerektirir)

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

İstek:

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

Yanıt:

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

Ekle (yetkilendirme gerektirir)

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

İstek:

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

Yanıt:

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

Doğrulanmış web kaynakları için bilgileri alma

Doğrulanmış sitelerinizin ve alanlarınızın tam listesine list işlevini çağırarak ulaşabilirsiniz. get işlevini çağırarak tek bir web kaynağına ait bilgileri alabilirsiniz.

Liste (yetkilendirme gerektirir)

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

İstek:

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

Yanıt:

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

Al (yetkilendirme gerektirir)

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

İstek:

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

Yanıt:

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

Doğrulama bilgilerini değiştirme

update işlevini çağırarak sahiplik yetkisi verebilir ve sahipliği iptal edebilirsiniz. delete komutunu çağırarak sahipliği kendiniz kaldırabilirsiniz.

Güncelleme (yetkilendirme gerektirir)

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

İstek:

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

Yanıt:

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

Sil (yetkilendirme gerektirir)

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

İstek:

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

Yanıt:

Başarıyı gösteren HTTP 204 (İçerik Yok) durum kodu.