Sürüm oluşturma

Bazı Business Profile API'leri birden fazla sürüm ve sürüm kanalında kullanılabilir. Sürüm, istek URL'sinin ana makine adından sonra gelen segmentidir (ör. v1 veya v1alpha). Bu sayfada, sürümlerin nasıl numaralandırıldığı, her sürüm kanalının ne kadar kararlı olduğu ve alfa kanalının nasıl çağrılacağı açıklanmaktadır.

Sürüm numaralandırma

Her API sürümünün bir ana sürüm numarası ve isteğe bağlı bir kanal son eki vardır:

  • Ana sürüm (v1, v2, ...): Kararlı, genel kullanıma sunulan bir sürümdür. Ana sürümler yalnızca geriye dönük uyumlu değişiklikler (ör. yeni yöntemler, yeni alanlar veya yeni enum değerleri) alır. Geriye dönük uyumlu olmayan değişiklikler yeni bir ana sürümde yayınlanır.
  • Alfa kanalı (v1alpha, v2alpha, ...): Ana sürümün yayın öncesi kanalıdır. Bu sürüm, ana sürümdeki her şeyi ve henüz genel kullanıma sunulma tarihi olmayan özellikleri içerir.

Sürüm kanalları

Kanal Kararlılık İçindekiler
Genel kullanıma sunulma tarihi (v1) Kararlı. Ana sürümdeki değişiklikler geriye dönük uyumludur. Desteği sonlandırılan ana sürümler, desteğin sonlandırıldığı duyurulduktan sonra en az 12 ay boyunca kullanılabilir durumda kalır. Desteği sonlandırılan sürümler ve destek sonu tarihleri Desteği sonlandırma planı sayfasında yayınlanır. Genel kullanıma sunulan özellikler.
Alfa (v1alpha) Kararlılık taahhüdü ve tanımlanmış kullanım ömrü olmayan yayın öncesi sürüm. Alfa özellikler, en az 30 gün önceden bildirilerek değiştirilebilir veya kullanımdan kaldırılabilir. Üretim entegrasyonlarında alfa özellikleri kullanmayın. v1 sürümündeki her şey ve henüz genel kullanıma sunulmamış özellikler.

Özellikler kanallar arasında nasıl taşınır?

v1alpha aşamasından v1 aşamasına geçen özellikler v1alpha aşamasında da kullanılabilir.

Yalnızca v1alpha sürümünde kullanılabilen özelliklerle ilgili kılavuzlar ve referans sayfaları alfa olarak işaretlenir. Yeni alfa ve genel kullanıma sunulan özellikler ile alfa özelliklerde yapılan değişiklikler veya kaldırılan özellikler, En son güncellemeler bölümünde ve her API'nin değişiklik günlüğünde duyurulur.

Alfa kanalını kullanma

Alfa kanalını çağırmak için istek URL'sinde v1 yerine v1alpha yazın. Örneğin:

GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/locations/{locationId}?readMask={readMask}

Her iki kanal da aynı API'ye ait olduğundan aşağıdakileri paylaşır:

  • Google Cloud Console'da API'yi etkinleştirme
  • OAuth 2.0 kapsamları ve erişim koşulları
  • Kaynak adları (ör. locations/{locationId}).
  • Kota. v1 ve v1alpha istekleri, proje başına aynı kotaya göre sayılır. Ayrıntılar için Kota sınırları başlıklı makaleyi inceleyin.
  • Temel iş verileri. v1alpha üzerinden yaptığınız değişiklikler v1 üzerinden görünür ve bunun tersi de geçerlidir.

İstemci kitaplıkları ve herkese açık API dizini yalnızca v1 içerir. v1alpha yöntemini çağırmak için doğrudan REST istekleri gönderin.

En iyi uygulamalar

  • Üretim entegrasyonları için v1 gibi kararlı sürümü kullanın.
  • Yeni özellikleri genel kullanıma sunulma tarihine ulaşmadan önce kullanmak için v1alpha gibi alfa kanalını kullanın. Geri bildirim paylaşmak için Destek bölümüne bakın.
  • İstemcinizin tanımadığı alanları ve enum değerlerini tolere etmesini sağlayın.
  • Alfa özellikler üzerinde çalışmaya başlamadan önce, bilinen sınırlamalar için ilgili kılavuzu ve değişiklik günlüğünü kontrol edin.