Ana içeriğe geç

getTemplateByMarker

Bir şablon nesnesini işaretçi ile almak.

Açıklama

Bu yöntem, API'den tanımlayıcısına (işaretçi) dayalı olarak tek bir şablon nesnesini alır. Bir şablon nesnesi olan ITemplateEntity'ye çözülen bir Promise döner.

Şablonlar.getTemplateByMarker(

marker, langCode

);

Parametreler şeması

Şema

marker(zorunlu): string
Alınacak şablonun benzersiz işaretçisi
örnek: "template_12345"

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

Örnekler

Minimal örnek

const response = await Templates.getTemplateByMarker('my-marker');

langCode niteliği ile örnek

const response = await Templates.getTemplateByMarker('my-marker', 'en_US');

Örnek yanıt

{
"id": 4,
"attributeSetIdentifier": null,
"title": "Şablon",
"generalTypeId": 4,
"identifier": "template",
"version": 0,
"generalTypeName": "catalog_page",
"attributeValues": {},
"position": 1
}

Yanıt şeması

Şema: ITemplateEntity

id: number
Pozisyonun benzersiz tanımlayıcısı.
örnek: 12345

attributeSetIdentifier: string | null
Nitelikler kümesi id'si.
örnek: "attribute_set_1"

title: string
Şablonun adı.
örnek: "Ürün Şablonu"

generalTypeId: number
Genel tür Varlık id'si.
örnek: 67890

identifier: string
Kayıt alanı için metinsel tanımlayıcı.
örnek: "template_12345"

version: number
Nesnenin sürüm numarası.
örnek: 1

generalTypeName: Types
Genel tür adı.
örnek:

"product"

attributeValues: AttributeType
İndeksten alınan nitelik değerleri (kullanıcı nitelik id'si: nitelik değeri çifti olarak temsil edilir).

position: number
Nesnenin pozisyonu.
örnek: NaN