geliştirici belgeleri

biticaret.extension.toml anahtarları

Her uzantı türünün dosyasındaki anahtarlar, türleri ve anlamları.

Bu sayfa koddan üretilir. a.b anahtarı [a] tablosundaki b anahtarıdır; a[].b ise [[a]] tablo dizisinin her öğesindeki b anahtarıdır. Dosyaların nasıl çalıştığı için Uygulama yapılandırma dosyaları sayfasına bakın.

type = "theme"

Anahtar Tür Anlamı
type metin Uzantının türü: theme.
name metin Uzantının adı. Bloklar, parçacıklar ve dosyalar dosyanın yanındaki blocks/, snippets/ ve assets/ klasörlerindedir; her bloğun adı, hedefi ve ayarları kendi {% schema %} bölümündedir.

type = "function"

Anahtar Tür Anlamı
type metin Uzantının türü: function.
handle metin Fonksiyonun kimliği (function_id): küçük harf, rakam, - ve _, en fazla 50 karakter.
function_type metin Fonksiyonun türü. Ödeme adımı fonksiyonları sayfasına bakın.
title metin Fonksiyonun yönetim panelinde görünen adı, en fazla 100 karakter.
input_metafields metin dizisi Fonksiyonun okuduğu metaalanlar: müşterinin <namespace>.<key> alanları (cart_transform için satırdaki varyantın, yalnızca uygulamanın kendi ad alanlarında) ve mağazanın shop.<namespace>.<key> alanları (yalnızca uygulamanın kendi ad alanlarında).
build.command metin app build komutunun fonksiyonun klasöründe çalıştırdığı derleme komutu (sh -c).
build.path metin Derlenen .wasm dosyasının uzantı klasörüne göre yolu; pakete functions/<klasör>.wasm olarak girer.

type = "ui_extension"

Anahtar Tür Anlamı
type metin Uzantının türü: ui_extension.
handle metin Uzantının kimliği (extension_id): küçük harf, rakam, - ve _, en fazla 50 karakter.
name metin Uzantının yönetim panelinde görünen adı, en fazla 100 karakter.
target metin Uzantının gösterildiği yer. Arayüz uzantısı hedefleri sayfasına bakın.
targets metin dizisi Mağazanın uzantıyı taşıyabileceği hedefler; target da aralarında, hepsi aynı tarafın (checkout.* ya da admin.*). Boşsa yalnızca target.
module metin Uzantının .js dosyasının uzantı klasörüne göre yolu; pakete extensions/<klasör>.js olarak girer.
capabilities.network_access boolean Uzantı, uygulamanın kendi sunucusuna fetch ile istek atabilir.
metafields metin dizisi Uzantının okuduğu metaalanlar; yalnızca checkout.* hedeflerinde.
settings.fields[].key metin Ayarın anahtarı.
settings.fields[].type metin Ayarın türü: single_line_text_field, multi_line_text_field, boolean, number_integer veya number_decimal.
settings.fields[].name metin Ayarın mağazaya görünen adı.
settings.fields[].description metin Ayarın mağazaya görünen açıklaması.
settings.fields[].choices metin dizisi Tek seçimli ayarın seçenekleri, 2 ile 20 arası; yalnızca single_line_text_field için. Mağaza bunlardan birini seçer.
settings.fields[].default ayarın türünde değer Ayarın varsayılan değeri, ayarın türünde.

type = "web_pixel"

Anahtar Tür Anlamı
type metin Uzantının türü: web_pixel.
handle metin Pikselin kimliği (pixel_id): küçük harf, rakam, - ve _, en fazla 50 karakter.
name metin Pikselin yönetim panelinde görünen adı.
module metin Pikselin .js dosyasının uzantı klasörüne göre yolu; pakete extensions/<klasör>.js olarak girer.
consent metin Ziyaretçinin onaylamış olması gereken çerez kategorisi: analytics veya marketing. Piksel olayları yalnızca bu onayla alır.
settings.fields[].key metin Ayarın anahtarı: küçük harfle başlar; küçük harf, rakam ve _, en fazla 40 karakter. Piksel değeri init.data.settings altında bu adla okur.
settings.fields[].type metin Ayarın türü: string (en fazla 500 karakter) veya string_list (metin listesi). Ayarları uygulama write_pixels kapsamıyla API üzerinden yazar.
settings.fields[].required boolean Ayar zorunluysa true; zorunlu bir ayar boşken piksel çalışmaz ve Müşteri olayları sayfası onu Ayarları yapılmamış olarak gösterir.