API çağırma

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

API çağırma

İstek biçimi

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

Google Site Doğrulama API URI'ları için belirli biçim şöyledir:

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

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

Liste sorguları için bir resourceID gerekmez. Bu nedenle, biçim şu şekildedir:

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

getToken işlemine kendi benzersiz URI'si ile çağrı yapabilirsiniz. getToken çağrısının biçimi şöyledir:

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), 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.

İşlemler özeti

Aşağıdaki tabloda açıklandığı gibi, Google Site Doğrulama API'sinde koleksiyonlar ve kaynaklar için 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 listrequest bölümüne bakın.

ekle

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

İstek metni: Web Kaynağı'na bakın.

Sorgu parametresi: verificationMethod. Bu istek için kullanılacak doğrulama yöntemi. Olası 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 alın isteğini inceleyin

güncelle

Belirli bir kaynak için sahip listesini değiştirir.

İstek metni: Web Kaynağı'na bakın.

Notlar:

  • Güncelle'yi kullanarak, kimliği doğrulanmış kullanıcıyı sahip listesinden kaldıramazsınız. Bunun yerine delete kullanın.
  • Sitede doğrulama jetonu olmayan tüm kullanıcıları sahip listesinden kaldırabilirsiniz.

PUT /webResource/resourceID

Örnek güncelleme isteğine göz atın.

sil

Kaynağı kullanıcının koleksiyonundan kaldırır (sitenin kullanıcıya ait olduğunu belirtir).

Notlar:

  • Sil çağrısı yapmadan önce, kimliği doğrulanmış kullanıcının tüm doğrulama jetonlarını siteden veya alan adından kaldırmanız gerekir. Hâlâ jeton varsa 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ış olan diğer tüm kullanıcılar, silme işleminden sonra sahiplik hakkını korur.

DELETE /webResource/resourceID

Örnek silme isteğine bakın.

getToken

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

İstek metni:

  • identifier: Site URL'si veya alan adı.
  • type: Doğrulanacak kaynak türü. Olası değerler: SITE, INET_DOMAIN.
  • verificationMethod: Sitenizi doğrulamak için kullanılacak yöntem. Olası 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, sizin (geliştirici) API'yi kendi test verilerinizle ilk denediğinizde olduğu gibi sizin de kimliği doğrulanmış kullanıcı olduğunuz varsayılır.

Yeni bir siteyi doğrulama

Bir siteyi doğrulamak için

  1. Öncelikle getToken adresini arayarak bir doğrulama jetonu isteyin.
  2. Seçtiğiniz yöntemi kullanarak jetonu sitenize yerleştirin.
  3. Google'dan, ekle 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 gerekir)

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 bilgi alma

Listeyi arayarak doğrulanmış sitelerinizin ve alanlarınızın tam listesini alabilirsiniz. get yöntemini çağırarak tek bir web kaynağı için 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 gerekir)

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

Güncelle'yi arayarak sahiplik yetkisi verebilir ve sahipliği iptal edebilirsiniz. Sil çağrısını yaparak sahipliği kendiniz için kaldırabilirsiniz.

Güncelleme (yetkilendirme gerekir)

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 gerekir)

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ılı olduğunu gösteren HTTP 204 (İçerik Yok) durum kodu.