@plentymarkets/shop-api / productSeoSettingsGetters
Variable: productSeoSettingsGetters ​
constproductSeoSettingsGetters:object
Defined in: getters/productSeoSettingsGetters.ts:177
Type Declaration ​
getBrand ​
getBrand: (
product) =>string
Returns the brand name of the product for structured data.
Parameters ​
product ​
The product object.
Returns ​
string
The brand name string, or an empty string if not set.
getCanonical ​
getCanonical: (
product) =>ProductCanonical
Returns the canonical URL configuration from the product's SEO settings.
Parameters ​
product ​
The product object.
Returns ​
The ProductCanonical object, or an empty object cast to ProductCanonical if not set.
getCanonicalAlternate ​
getCanonicalAlternate: (
canonical) =>CanonicalAlternate[]
Returns the list of alternate (hreflang) entries from a canonical configuration object.
Parameters ​
canonical ​
The product canonical object.
Returns ​
An array of CanonicalAlternate objects, or an empty array if not set.
getCanonicalAlternateHref ​
getCanonicalAlternateHref: (
alternate) =>string
Returns the href URL of a canonical alternate entry.
Parameters ​
alternate ​
The canonical alternate object.
Returns ​
string
The href URL string, or an empty string if not set.
getCanonicalAlternateHreflang ​
getCanonicalAlternateHreflang: (
alternate) =>string
Returns the hreflang language tag of a canonical alternate entry.
Parameters ​
alternate ​
The canonical alternate object.
Returns ​
string
The hreflang string (e.g. "de-DE"), or an empty string if not set.
getCanonicalHref ​
getCanonicalHref: (
canonical) =>string
Returns the canonical href URL from a canonical configuration object.
Parameters ​
canonical ​
The product canonical object.
Returns ​
string
The href URL string, or an empty string if not set.
getConditionOfItem ​
getConditionOfItem: (
product) =>string
Returns the structured data condition of the product item (e.g. "NewCondition", "UsedCondition").
Parameters ​
product ​
The product object.
Returns ​
string
The condition string, or an empty string if not set.
getForcedCanonicalUrl ​
getForcedCanonicalUrl: (
product) =>string
Returns the forced canonical URL from the product's SEO settings.
Parameters ​
product ​
The product object.
Returns ​
string
The forced canonical URL string, or an empty string if not set.
getForceRobotsValue ​
getForceRobotsValue: (
product) =>string
Returns the forced robots value override from the product's SEO settings.
Parameters ​
product ​
The product object.
Returns ​
string
The forced robots directive string, or an empty string if not set.
getGtin ​
getGtin: (
product) =>string
Returns the GTIN (Global Trade Item Number) of the product.
Parameters ​
product ​
The product object.
Returns ​
string
The GTIN string, or an empty string if not set.
getGtin13 ​
getGtin13: (
product) =>string
Returns the GTIN-13 (EAN) barcode of the product.
Parameters ​
product ​
The product object.
Returns ​
string
The GTIN-13 string, or an empty string if not set.
getGtin8 ​
getGtin8: (
product) =>string
Returns the GTIN-8 barcode of the product.
Parameters ​
product ​
The product object.
Returns ​
string
The GTIN-8 string, or an empty string if not set.
getIsbn ​
getIsbn: (
product) =>string
Returns the ISBN of the product.
Parameters ​
product ​
The product object.
Returns ​
string
The ISBN string, or an empty string if not set.
getMappedAvailability ​
getMappedAvailability: (
product) =>string
Returns the mapped availability value for structured data (e.g. "InStock", "OutOfStock").
Parameters ​
product ​
The product object.
Returns ​
string
The mapped availability string, or an empty string if not set.
getMpn ​
getMpn: (
product) =>string
Returns the MPN (Manufacturer Part Number) of the product.
Parameters ​
product ​
The product object.
Returns ​
string
The MPN string, or an empty string if not set.
getPriceValidUntil ​
getPriceValidUntil: (
product) =>string
Returns the date until which the product price is valid (for structured data).
Parameters ​
product ​
The product object.
Returns ​
string
The price valid until date string, or an empty string if not set.
getRobots ​
getRobots: (
product) =>string
Returns the robots meta tag setting from the product's SEO settings.
Parameters ​
product ​
The product object.
Returns ​
string
The robots directive string (e.g. "ALL", "NOINDEX"), or an empty string if not set.
getSeoManufacturer ​
getSeoManufacturer: (
product) =>string
Returns the manufacturer name used in structured data SEO settings.
Parameters ​
product ​
The product object.
Returns ​
string
The manufacturer name string, or an empty string if not set.
getSku ​
getSku: (
product) =>string
Returns the SKU (Stock Keeping Unit) of the product for structured data.
Parameters ​
product ​
The product object.
Returns ​
string
The SKU string, or an empty string if not set.