Status

Status türü, REST API'leri ve TBG API'leri de dahil olmak üzere farklı programlama ortamları için uygun olan bir mantıksal hata modeli tanımlar. gTB tarafından kullanılır. Her Status mesajı üç parça veri içerir: hata kodu, hata mesajı ve hata ayrıntıları.

Bu hata modeli ve nasıl çalışılabileceği hakkında daha fazla bilgiyi API Tasarım Kılavuzu'ndan edinebilirsiniz.

JSON gösterimi
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Alanlar
code

integer

google.rpc.Code enum değeri olması gereken durum kodu.

message

string

Geliştiricinin görebileceği hata mesajı (İngilizce olmalıdır). Kullanıcıya yönelik tüm hata mesajları, yerelleştirilip google.rpc.Status.details alanında gönderilmeli veya istemci tarafından yerelleştirilmelidir.

details[]

object

Hata ayrıntılarını içeren iletilerin listesi. API'lerin kullanması gereken yaygın bir mesaj türü grubu vardır.

İsteğe bağlı türlere sahip alanları içeren bir nesne. Ek bir alan ("@type"), türü tanımlayan bir URI içeriyor. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.