@leaddreamer/inventorylogic 0.0.3-beta.47 → 0.0.3-beta.53
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1225 -132
- package/business/Product/GoogleMarchantMarkup.js +252 -0
- package/business/Product/GoogleMerchantAPI.js +343 -0
- package/business/Product/Squarespace.js +505 -0
- package/business/Product/index.js +125 -27
- package/business/Utilities/other.js +0 -63
- package/dist/InventoryLogic.0a417df6.js +2 -0
- package/dist/InventoryLogic.4a3c62d7.js +2 -0
- package/dist/InventoryLogic.519aca5b.js +2 -0
- package/dist/InventoryLogic.5e29cd66.js +2 -0
- package/dist/InventoryLogic.76c282a4.js +2 -0
- package/dist/InventoryLogic.b49f09b1.js +2 -0
- package/dist/InventoryLogic.b8b0ac74.js +2 -0
- package/dist/InventoryLogic.ca8dec8b.js +2 -0
- package/dist/InventoryLogic.e0dc6c34.js +2 -0
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -54,6 +54,15 @@ as an abstraction above a specific payment processor.</p>
|
|
|
54
54
|
<dd><p>Functions for managing (potentially)private data for a user or organization.
|
|
55
55
|
Unified structure as a sub-record of fan, organization, or CityManager accounts</p>
|
|
56
56
|
</dd>
|
|
57
|
+
<dt><a href="#module_GoogleProduct">GoogleProduct</a></dt>
|
|
58
|
+
<dd><p>Typedefs, constants, support functions and database operations related to Products</p>
|
|
59
|
+
</dd>
|
|
60
|
+
<dt><a href="#module_GoogleProduct">GoogleProduct</a></dt>
|
|
61
|
+
<dd><p>Typedefs, constants, support functions and database operations related to Products</p>
|
|
62
|
+
</dd>
|
|
63
|
+
<dt><a href="#module_SquarespaceProduct">SquarespaceProduct</a></dt>
|
|
64
|
+
<dd><p>Typedefs, constants, support functions and database operations related to Products</p>
|
|
65
|
+
</dd>
|
|
57
66
|
<dt><a href="#module_Product">Product</a></dt>
|
|
58
67
|
<dd><p>Typedefs, constants, support functions and database operations related to Products</p>
|
|
59
68
|
</dd>
|
|
@@ -1830,6 +1839,1072 @@ creates the "base path" (refPath) to store addresses based on an account (refPat
|
|
|
1830
1839
|
|
|
1831
1840
|
### PrivateData~ChainType : <code>WriteBatch</code> \| <code>Transaction</code> \| <code>void</code>
|
|
1832
1841
|
**Kind**: inner typedef of [<code>PrivateData</code>](#module_PrivateData)
|
|
1842
|
+
<a name="module_GoogleProduct"></a>
|
|
1843
|
+
|
|
1844
|
+
## GoogleProduct
|
|
1845
|
+
Typedefs, constants, support functions and database operations related to Products
|
|
1846
|
+
|
|
1847
|
+
|
|
1848
|
+
* [GoogleProduct](#module_GoogleProduct)
|
|
1849
|
+
* _static_
|
|
1850
|
+
* [.GoogleAPIProductDefault](#module_GoogleProduct.GoogleAPIProductDefault) : <code>GoogleProductAPI</code>
|
|
1851
|
+
* [.GoogleAPIProductMap](#module_GoogleProduct.GoogleAPIProductMap) : <code>GoogleProductAPI</code>
|
|
1852
|
+
* _inner_
|
|
1853
|
+
* [~GoogleProductAPIField(field, InventoryProduct)](#module_GoogleProduct..GoogleProductAPIField)
|
|
1854
|
+
* [~SKU](#module_GoogleProduct..SKU) : <code>string</code>
|
|
1855
|
+
* [~Name](#module_GoogleProduct..Name) : <code>string</code>
|
|
1856
|
+
* [~ImageObject](#module_GoogleProduct..ImageObject) : <code>object</code>
|
|
1857
|
+
* [~ReviewRating](#module_GoogleProduct..ReviewRating) : <code>object</code>
|
|
1858
|
+
* [~ReviewObject](#module_GoogleProduct..ReviewObject) : <code>object</code>
|
|
1859
|
+
* [~AggregateRatingsValue](#module_GoogleProduct..AggregateRatingsValue) : <code>object</code>
|
|
1860
|
+
* [~BrandObject](#module_GoogleProduct..BrandObject) : <code>object</code>
|
|
1861
|
+
* [~QuantitativeValue](#module_GoogleProduct..QuantitativeValue) : <code>object</code>
|
|
1862
|
+
* [~SizeGroupEnumeration](#module_GoogleProduct..SizeGroupEnumeration) : <code>"Big"</code> \| <code>"Boys"</code> \| <code>"ExtraShort"</code> \| <code>"ExtraTall"</code> \| <code>"Girls"</code> \| <code>"Husky"</code> \| <code>"Infants"</code> \| <code>"Juniors"</code> \| <code>"Maternity"</code> \| <code>"Mens"</code> \| <code>"Misses"</code> \| <code>"Petite"</code> \| <code>"Plus"</code> \| <code>"Regular"</code> \| <code>"Short"</code> \| <code>"Tall"</code> \| <code>"Womens"</code>
|
|
1863
|
+
* [~SizeTypeEnumeration](#module_GoogleProduct..SizeTypeEnumeration) : <code>"regular"</code> \| <code>"petite"</code> \| <code>"maternity"</code> \| <code>"big"</code> \| <code>"tall"</code> \| <code>"plus"</code>
|
|
1864
|
+
* [~SizeSystemEnumeration](#module_GoogleProduct..SizeSystemEnumeration) : <code>"US"</code> \| <code>"UK"</code> \| <code>"EU"</code> \| <code>"DE"</code> \| <code>"FR"</code> \| <code>"JP"</code> \| <code>"CN"</code> \| <code>"IT"</code> \| <code>"BR"</code> \| <code>"MEX"</code> \| <code>"AU"</code>
|
|
1865
|
+
* [~GoogleAPIVariantOption](#module_GoogleProduct..GoogleAPIVariantOption) : <code>object</code>
|
|
1866
|
+
* [~SizeSpecification](#module_GoogleProduct..SizeSpecification) : <code>object</code>
|
|
1867
|
+
* [~QAObject](#module_GoogleProduct..QAObject) : <code>object</code>
|
|
1868
|
+
* [~availabilityEnum](#module_GoogleProduct..availabilityEnum) : <code>"in\_stock"</code> \| <code>"out\_of\_stock"</code> \| <code>"preorder"</code> \| <code>"backorder"</code>
|
|
1869
|
+
* [~GoogleProduct](#module_GoogleProduct..GoogleProduct) : <code>object</code>
|
|
1870
|
+
* [~SKU](#module_GoogleProduct..SKU) : <code>string</code>
|
|
1871
|
+
* [~Name](#module_GoogleProduct..Name) : <code>string</code>
|
|
1872
|
+
* [~SizeTypeEnumeration](#module_GoogleProduct..SizeTypeEnumeration) : <code>"regular"</code> \| <code>"petite"</code> \| <code>"maternity"</code> \| <code>"big"</code> \| <code>"tall"</code> \| <code>"plus"</code>
|
|
1873
|
+
* [~SizeSystemEnumeration](#module_GoogleProduct..SizeSystemEnumeration) : <code>"US"</code> \| <code>"UK"</code> \| <code>"EU"</code> \| <code>"DE"</code> \| <code>"FR"</code> \| <code>"JP"</code> \| <code>"CN"</code> \| <code>"IT"</code> \| <code>"BR"</code> \| <code>"MEX"</code> \| <code>"AU"</code>
|
|
1874
|
+
* [~GoogleAPIVariantOption](#module_GoogleProduct..GoogleAPIVariantOption) : <code>object</code>
|
|
1875
|
+
* [~QAObject](#module_GoogleProduct..QAObject) : <code>object</code>
|
|
1876
|
+
* [~GoogleProductAPI](#module_GoogleProduct..GoogleProductAPI) : <code>object</code>
|
|
1877
|
+
|
|
1878
|
+
<a name="module_GoogleProduct.GoogleAPIProductDefault"></a>
|
|
1879
|
+
|
|
1880
|
+
### GoogleProduct.GoogleAPIProductDefault : <code>GoogleProductAPI</code>
|
|
1881
|
+
**Kind**: static constant of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
1882
|
+
<a name="module_GoogleProduct.GoogleAPIProductMap"></a>
|
|
1883
|
+
|
|
1884
|
+
### GoogleProduct.GoogleAPIProductMap : <code>GoogleProductAPI</code>
|
|
1885
|
+
**Kind**: static constant of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
1886
|
+
<a name="module_GoogleProduct..GoogleProductAPIField"></a>
|
|
1887
|
+
|
|
1888
|
+
### GoogleProduct~GoogleProductAPIField(field, InventoryProduct)
|
|
1889
|
+
**Kind**: inner method of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
1890
|
+
|
|
1891
|
+
| Param | Type |
|
|
1892
|
+
| --- | --- |
|
|
1893
|
+
| field | <code>string</code> |
|
|
1894
|
+
| InventoryProduct | <code>Product</code> |
|
|
1895
|
+
|
|
1896
|
+
<a name="module_GoogleProduct..SKU"></a>
|
|
1897
|
+
|
|
1898
|
+
### GoogleProduct~SKU : <code>string</code>
|
|
1899
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
1900
|
+
<a name="module_GoogleProduct..Name"></a>
|
|
1901
|
+
|
|
1902
|
+
### GoogleProduct~Name : <code>string</code>
|
|
1903
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
1904
|
+
<a name="module_GoogleProduct..ImageObject"></a>
|
|
1905
|
+
|
|
1906
|
+
### GoogleProduct~ImageObject : <code>object</code>
|
|
1907
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
1908
|
+
**Properties**
|
|
1909
|
+
|
|
1910
|
+
| Name | Type | Description |
|
|
1911
|
+
| --- | --- | --- |
|
|
1912
|
+
| caption | <code>text</code> \| <code>MediaObject</code> | |
|
|
1913
|
+
| embeddedTextCaption | <code>text</code> | |
|
|
1914
|
+
| exifData | <code>object</code> | |
|
|
1915
|
+
| dateCreated | <code>Date</code> \| <code>DateTime</code> | |
|
|
1916
|
+
| dateModified | <code>Date</code> \| <code>DateTime</code> | |
|
|
1917
|
+
| datePublished | <code>Date</code> \| <code>DateTime</code> | |
|
|
1918
|
+
| position | <code>text</code> \| <code>number</code> | The position of an item in a series or sequence of items. |
|
|
1919
|
+
| text | <code>text</code> | The textual content of this CreativeWork. |
|
|
1920
|
+
| thumbnail | <code>ImageObject</code> | |
|
|
1921
|
+
| alternateName | <code>text</code> | An alias for the item. |
|
|
1922
|
+
| description | <code>text</code> | A description of the item. |
|
|
1923
|
+
| imageAn | <code>URL</code> \| <code>ImageObject</code> | image of the item. This can be a URL or a fully described ImageObject. |
|
|
1924
|
+
| name | <code>Name</code> | The name of the item. |
|
|
1925
|
+
| url | <code>URL</code> | |
|
|
1926
|
+
|
|
1927
|
+
<a name="module_GoogleProduct..ReviewRating"></a>
|
|
1928
|
+
|
|
1929
|
+
### GoogleProduct~ReviewRating : <code>object</code>
|
|
1930
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
1931
|
+
**Properties**
|
|
1932
|
+
|
|
1933
|
+
| Name | Type | Description |
|
|
1934
|
+
| --- | --- | --- |
|
|
1935
|
+
| type | <code>text</code> | "Rating" |
|
|
1936
|
+
| bestRating | <code>integer</code> \| <code>text</code> | The highest value allowed in this rating system. |
|
|
1937
|
+
| worstRating | <code>integer</code> \| <code>text</code> | The lowest value allowed in this rating system. |
|
|
1938
|
+
| ratingValue | <code>Text</code> \| <code>Number</code> | The rating for the content. Usage guidelines: Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols. Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
|
|
1939
|
+
|
|
1940
|
+
<a name="module_GoogleProduct..ReviewObject"></a>
|
|
1941
|
+
|
|
1942
|
+
### GoogleProduct~ReviewObject : <code>object</code>
|
|
1943
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
1944
|
+
**Properties**
|
|
1945
|
+
|
|
1946
|
+
| Name | Type | Description |
|
|
1947
|
+
| --- | --- | --- |
|
|
1948
|
+
| type | <code>text</code> | "Review" |
|
|
1949
|
+
| author | <code>text</code> | |
|
|
1950
|
+
| name | <code>text</code> | |
|
|
1951
|
+
| datePublished | <code>Date</code> \| <code>DateTime</code> | |
|
|
1952
|
+
| reviewBody | <code>text</code> | |
|
|
1953
|
+
| reviews | <code>Array.ReviewRating</code> | |
|
|
1954
|
+
| review | <code>ReviewRating</code> | |
|
|
1955
|
+
|
|
1956
|
+
<a name="module_GoogleProduct..AggregateRatingsValue"></a>
|
|
1957
|
+
|
|
1958
|
+
### GoogleProduct~AggregateRatingsValue : <code>object</code>
|
|
1959
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
1960
|
+
**Properties**
|
|
1961
|
+
|
|
1962
|
+
| Name | Type | Description |
|
|
1963
|
+
| --- | --- | --- |
|
|
1964
|
+
| type | <code>text</code> | "AggregateRating" |
|
|
1965
|
+
| itemReviewed | <code>Thing</code> | The item that is being reviewed/rated. |
|
|
1966
|
+
| ratingCount | <code>integer</code> | The count of total number of ratings. |
|
|
1967
|
+
| reviewCount | <code>integer</code> | The count of total number of reviews. |
|
|
1968
|
+
| ratingExplanation | <code>text</code> | A short explanation (e.g. one to two sentences) providing background context and other information that led to the conclusion expressed in the rating. This is particularly applicable to ratings associated with "fact check" markup using ClaimReview. |
|
|
1969
|
+
| ratingValue | <code>Text</code> \| <code>Number</code> | The rating for the content. Usage guidelines: Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols. Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
|
|
1970
|
+
| bestRating | <code>integer</code> \| <code>text</code> | The highest value allowed in this rating system. |
|
|
1971
|
+
| worstRating | <code>integer</code> \| <code>text</code> | The lowest value allowed in this rating system. |
|
|
1972
|
+
|
|
1973
|
+
<a name="module_GoogleProduct..BrandObject"></a>
|
|
1974
|
+
|
|
1975
|
+
### GoogleProduct~BrandObject : <code>object</code>
|
|
1976
|
+
a Brand Object
|
|
1977
|
+
|
|
1978
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
1979
|
+
**Properties**
|
|
1980
|
+
|
|
1981
|
+
| Name | Type | Description |
|
|
1982
|
+
| --- | --- | --- |
|
|
1983
|
+
| aggregateRating | <code>AggregateRatingsValue</code> | |
|
|
1984
|
+
| logo | <code>URL</code> \| <code>ImageObject</code> | |
|
|
1985
|
+
| review | <code>ReviewObject</code> | A review of the item. Supersedes reviews |
|
|
1986
|
+
| slogan | <code>text</code> | A slogan or motto associated with the item. |
|
|
1987
|
+
| name | <code>Name</code> | The name of the brand. |
|
|
1988
|
+
|
|
1989
|
+
<a name="module_GoogleProduct..QuantitativeValue"></a>
|
|
1990
|
+
|
|
1991
|
+
### GoogleProduct~QuantitativeValue : <code>object</code>
|
|
1992
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
1993
|
+
**Properties**
|
|
1994
|
+
|
|
1995
|
+
| Name | Type | Description |
|
|
1996
|
+
| --- | --- | --- |
|
|
1997
|
+
| value | <code>Boolean</code> \| <code>Number</code> \| <code>text</code> \| <code>StructuredValue</code> | The value of a QuantitativeValue (including Observation) or property value node. * For QuantitativeValue and MonetaryAmount, the recommended type for values is 'Number'. * For PropertyValue, it can be 'Text', 'Number', 'Boolean', or 'StructuredValue'. * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols. * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
|
|
1998
|
+
| maxValue | <code>number</code> | The upper value of some characteristic or property. |
|
|
1999
|
+
| minValue | <code>number</code> | The lower value of some characteristic or property. |
|
|
2000
|
+
| unitText | <code>Text</code> | A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code for unitCode |
|
|
2001
|
+
| unitCode | <code>Text</code> \| <code>URL</code> | The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon |
|
|
2002
|
+
|
|
2003
|
+
<a name="module_GoogleProduct..SizeGroupEnumeration"></a>
|
|
2004
|
+
|
|
2005
|
+
### GoogleProduct~SizeGroupEnumeration : <code>"Big"</code> \| <code>"Boys"</code> \| <code>"ExtraShort"</code> \| <code>"ExtraTall"</code> \| <code>"Girls"</code> \| <code>"Husky"</code> \| <code>"Infants"</code> \| <code>"Juniors"</code> \| <code>"Maternity"</code> \| <code>"Mens"</code> \| <code>"Misses"</code> \| <code>"Petite"</code> \| <code>"Plus"</code> \| <code>"Regular"</code> \| <code>"Short"</code> \| <code>"Tall"</code> \| <code>"Womens"</code>
|
|
2006
|
+
Size Grouping options
|
|
2007
|
+
|
|
2008
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2009
|
+
<a name="module_GoogleProduct..SizeTypeEnumeration"></a>
|
|
2010
|
+
|
|
2011
|
+
### GoogleProduct~SizeTypeEnumeration : <code>"regular"</code> \| <code>"petite"</code> \| <code>"maternity"</code> \| <code>"big"</code> \| <code>"tall"</code> \| <code>"plus"</code>
|
|
2012
|
+
Google Merchant API Size/Fit Options
|
|
2013
|
+
|
|
2014
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2015
|
+
<a name="module_GoogleProduct..SizeSystemEnumeration"></a>
|
|
2016
|
+
|
|
2017
|
+
### GoogleProduct~SizeSystemEnumeration : <code>"US"</code> \| <code>"UK"</code> \| <code>"EU"</code> \| <code>"DE"</code> \| <code>"FR"</code> \| <code>"JP"</code> \| <code>"CN"</code> \| <code>"IT"</code> \| <code>"BR"</code> \| <code>"MEX"</code> \| <code>"AU"</code>
|
|
2018
|
+
Google Merchant API Size System/Country Options
|
|
2019
|
+
|
|
2020
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2021
|
+
<a name="module_GoogleProduct..GoogleAPIVariantOption"></a>
|
|
2022
|
+
|
|
2023
|
+
### GoogleProduct~GoogleAPIVariantOption : <code>object</code>
|
|
2024
|
+
Google Merchant API Variant-identifying dimensions and their values
|
|
2025
|
+
|
|
2026
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2027
|
+
**Properties**
|
|
2028
|
+
|
|
2029
|
+
| Name | Type |
|
|
2030
|
+
| --- | --- |
|
|
2031
|
+
| name | <code>Text</code> |
|
|
2032
|
+
| value | <code>Text</code> |
|
|
2033
|
+
|
|
2034
|
+
<a name="module_GoogleProduct..SizeSpecification"></a>
|
|
2035
|
+
|
|
2036
|
+
### GoogleProduct~SizeSpecification : <code>object</code>
|
|
2037
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2038
|
+
**Properties**
|
|
2039
|
+
|
|
2040
|
+
| Name | Type | Description |
|
|
2041
|
+
| --- | --- | --- |
|
|
2042
|
+
| type | <code>Text</code> | "SizeSpecification" |
|
|
2043
|
+
| hasMeasurement | <code>QuantitativeValue</code> | |
|
|
2044
|
+
| sizeGroup | <code>Array.SizeGroupEnumeration</code> \| <code>SizeGroupEnumeration</code> \| <code>Text</code> | The size group (also known as "size type") for a product's size. Size groups are common in the fashion industry to define size segments and suggested audiences for wearable products. Multiple values can be combined, for example "men's big and tall", "petite maternity" or "regular". |
|
|
2045
|
+
| sizeSystem | <code>Array.SizeSystemEnumeration</code> \| <code>SizeSystemEnumeration</code> \| <code>Text</code> | The size system used to identify a product's size. Typically either a standard (for example, "GS1" or "ISO-EN13402"), country code (for example "US" or "JP"), or a measuring system (for example "Metric" or "Imperial"). |
|
|
2046
|
+
| suggestedAge | <code>QuantitativeValue</code> | The age or age range for the intended audience or user, for example 3-12 months for infants, 1-5 years for toddlers. |
|
|
2047
|
+
| suggestedGender | <code>GenderType</code> \| <code>Text</code> | The suggested gender of the intended user or audience, for example "male", "female", or "unisex". |
|
|
2048
|
+
| suggestedMeasurement | <code>QuantitativeValue</code> | A suggested range of body measurements for the intended audience or user, for example inseam between 32 and 34 inches or height between 170 and 190 cm. Typically found on a size chart for wearable products. |
|
|
2049
|
+
|
|
2050
|
+
<a name="module_GoogleProduct..QAObject"></a>
|
|
2051
|
+
|
|
2052
|
+
### GoogleProduct~QAObject : <code>object</code>
|
|
2053
|
+
Google Merchant API User-, merchant-, and manufacturer-authored questions and answers about the product.
|
|
2054
|
+
|
|
2055
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2056
|
+
**Properties**
|
|
2057
|
+
|
|
2058
|
+
| Name | Type | Description |
|
|
2059
|
+
| --- | --- | --- |
|
|
2060
|
+
| question | <code>Text</code> | Max. 1000 characters. |
|
|
2061
|
+
| answer | <code>Text</code> | Max. 1000 characters. |
|
|
2062
|
+
|
|
2063
|
+
<a name="module_GoogleProduct..availabilityEnum"></a>
|
|
2064
|
+
|
|
2065
|
+
### GoogleProduct~availabilityEnum : <code>"in\_stock"</code> \| <code>"out\_of\_stock"</code> \| <code>"preorder"</code> \| <code>"backorder"</code>
|
|
2066
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2067
|
+
<a name="module_GoogleProduct..GoogleProduct"></a>
|
|
2068
|
+
|
|
2069
|
+
### GoogleProduct~GoogleProduct : <code>object</code>
|
|
2070
|
+
a Google Product record
|
|
2071
|
+
|
|
2072
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2073
|
+
**Properties**
|
|
2074
|
+
|
|
2075
|
+
| Name | Type | Description |
|
|
2076
|
+
| --- | --- | --- |
|
|
2077
|
+
| id | <code>SKU</code> | id of Product also used as sku |
|
|
2078
|
+
| title | <code>Name</code> | title (name) of Product |
|
|
2079
|
+
| description | <code>string</code> | Basic description of the product |
|
|
2080
|
+
| link | <code>URL</code> | Your product’s landing page |
|
|
2081
|
+
| image_link | <code>URL</code> | The URL of your product’s main image |
|
|
2082
|
+
| additional_image_link | <code>URL</code> | The URL of your product’s main image |
|
|
2083
|
+
| video_link | <code>URL</code> | Additional link to show a video of your product. |
|
|
2084
|
+
| virtual_model_link | <code>URL</code> | Additional link to show a 3D model of your product. |
|
|
2085
|
+
| mobile_link | <code>URL</code> | Your product’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic |
|
|
2086
|
+
| availability | <code>availabilityEnum</code> | Accurately submit the product's availability and match the availability from your landing page, checkout pages, and structured data (for example, “in_stock” or “out_of_stock” in your Schema.org markup). If an item is out of stock, the price must still be clearly visible on the landing page. Provide the availability date [availability_date] attribute if you submit preorder [preorder] or backorder [backorder] as the availability value. |
|
|
2087
|
+
| availability_date | <code>string</code> \| <code>ISO8601</code> | Use this attribute if your product's availability is set to preorder. Provide a value up to one year in the future. The availability date should also be added to the product’s landing page and be clear to your customers (for example, “May 6, 2023”). If an exact date can’t be provided, you can use an estimated date (for example, “May 2023”). |
|
|
2088
|
+
| cost_of_goods_sold | <code>string</code> \| <code>ISO4217</code> | The costs associated with the sale of a particular product as defined by the accounting convention you set up. These costs may include material, labor, freight, or other overhead expenses. By submittingthe COGS for your products, you gain insights about other metrics, such as your gross margin and the amount of revenue generated by your ads and free listings. |
|
|
2089
|
+
| expiration_date | <code>ISO8601</code> | The date that your product should stop showing |
|
|
2090
|
+
| price | <code>number</code> \| <code>ISO4217</code> | |
|
|
2091
|
+
| sale_price | <code>number</code> \| <code>ISO4217</code> | |
|
|
2092
|
+
| sale_price_effective_date | <code>DateRange</code> | |
|
|
2093
|
+
| google_product_category | <code>GoogleProductTaxonomy</code> | |
|
|
2094
|
+
| product_type | <code>string</code> | |
|
|
2095
|
+
| brand | <code>Text</code> \| <code>BrandObject</code> | The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business user. |
|
|
2096
|
+
| gtin | <code>gtin8</code> \| <code>gtin12</code> \| <code>gtin13</code> \| <code>gtin14</code> \| <code>gtin</code> \| <code>isbn</code> | |
|
|
2097
|
+
| mpn | <code>Text</code> | The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers. |
|
|
2098
|
+
| adult | <code>"no"</code> \| <code>"yes"</code> | |
|
|
2099
|
+
| age_group | <code>Text</code> | newborn | infant | toddler | kids | adult |
|
|
2100
|
+
| gender | <code>Text</code> | male female unisex |
|
|
2101
|
+
| color | <code>Text</code> | The color of the product. |
|
|
2102
|
+
| condition | <code>"new"</code> \| <code>"refurbished"</code> \| <code>"used"</code> | |
|
|
2103
|
+
| item_group_id | <code>Text</code> | ID for a group of products that come in different versions (variants) |
|
|
2104
|
+
| item_group_title | <code>Text</code> | name for a group of products that come in different versions (variants) |
|
|
2105
|
+
| material | <code>Text</code> | A material that something is made from, e.g. leather, wool, cotton, paper. |
|
|
2106
|
+
| pattern | <code>Text</code> | A pattern that something has |
|
|
2107
|
+
| product_length | <code>Text</code> | Your product's length |
|
|
2108
|
+
| product_width | <code>Text</code> | Your product's width |
|
|
2109
|
+
| product_height | <code>Text</code> | Your product's height Use the same unit of measurement for each product dimension attribute (including product length, width, and height). Otherwise, the information won't be displayed. |
|
|
2110
|
+
| product_highlight | <code>Text</code> | The most relevant highlights of your products |
|
|
2111
|
+
| product_weight | <code>Text</code> | Your product's weight |
|
|
2112
|
+
| question_and_answer | <code>Array.QAObject</code> | User-, merchant-, and manufacturer-authored questions and answers about the product. |
|
|
2113
|
+
| size | <code>Text</code> \| <code>SizeSpecification</code> \| <code>QuantitativeValue</code> | |
|
|
2114
|
+
| size_type | <code>SizeTypeEnumeration</code> | Your apparel product’s cut |
|
|
2115
|
+
| size_system | <code>SizeSystemEnumeration</code> | The country of the size system used by your produc |
|
|
2116
|
+
| variant_option | <code>Array.GoogleAPIVariantOption</code> | Variant-identifying dimensions and their values |
|
|
2117
|
+
| ads_redirect | <code>URL</code> | A URL used to specify additional parameters for your product page. Customers will be sent to this URL rather than the value that you submit for the link [link] or mobile link [mobile_link] attributes |
|
|
2118
|
+
| custom_label_0 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2119
|
+
| custom_label_1 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2120
|
+
| custom_label_2 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2121
|
+
| custom_label_3 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2122
|
+
| custom_label_4 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2123
|
+
| promotion_id | <code>Text</code> | An identifier that allows you to match products to promotions |
|
|
2124
|
+
| lifestyle_image_link | <code>URL</code> | Attribute used to include the URL for a lifestyle image for your product |
|
|
2125
|
+
| short_title | <code>Text</code> | Short product name. Only available for Demand Gen Ads, including YouTube, Gmail, Maps, Discover app, Google Display Network, and Google Video Partners. |
|
|
2126
|
+
| shipping_label | <code>Text</code> | Label that you assign to a product to help assign correct shipping times and transit costs in Merchant Center account settings |
|
|
2127
|
+
| shipping_weight | <code>Text</code> | The weight of the product used to calculate the shipping cost |
|
|
2128
|
+
| shipping_length | <code>Text</code> | The length of the product used to calculate the shipping cost by dimensional weight |
|
|
2129
|
+
| shipping_width | <code>Text</code> | The width of the product used to calculate the shipping cost by dimensional weight |
|
|
2130
|
+
| shipping_height | <code>Text</code> | The height of the product used to calculate the shipping cost by dimensional weight |
|
|
2131
|
+
|
|
2132
|
+
<a name="module_GoogleProduct..SKU"></a>
|
|
2133
|
+
|
|
2134
|
+
### GoogleProduct~SKU : <code>string</code>
|
|
2135
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2136
|
+
<a name="module_GoogleProduct..Name"></a>
|
|
2137
|
+
|
|
2138
|
+
### GoogleProduct~Name : <code>string</code>
|
|
2139
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2140
|
+
<a name="module_GoogleProduct..SizeTypeEnumeration"></a>
|
|
2141
|
+
|
|
2142
|
+
### GoogleProduct~SizeTypeEnumeration : <code>"regular"</code> \| <code>"petite"</code> \| <code>"maternity"</code> \| <code>"big"</code> \| <code>"tall"</code> \| <code>"plus"</code>
|
|
2143
|
+
Google Merchant API Size/Fit Options
|
|
2144
|
+
|
|
2145
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2146
|
+
<a name="module_GoogleProduct..SizeSystemEnumeration"></a>
|
|
2147
|
+
|
|
2148
|
+
### GoogleProduct~SizeSystemEnumeration : <code>"US"</code> \| <code>"UK"</code> \| <code>"EU"</code> \| <code>"DE"</code> \| <code>"FR"</code> \| <code>"JP"</code> \| <code>"CN"</code> \| <code>"IT"</code> \| <code>"BR"</code> \| <code>"MEX"</code> \| <code>"AU"</code>
|
|
2149
|
+
Google Merchant API Size System/Country Options
|
|
2150
|
+
|
|
2151
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2152
|
+
<a name="module_GoogleProduct..GoogleAPIVariantOption"></a>
|
|
2153
|
+
|
|
2154
|
+
### GoogleProduct~GoogleAPIVariantOption : <code>object</code>
|
|
2155
|
+
Google Merchant API Variant-identifying dimensions and their values
|
|
2156
|
+
|
|
2157
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2158
|
+
**Properties**
|
|
2159
|
+
|
|
2160
|
+
| Name | Type |
|
|
2161
|
+
| --- | --- |
|
|
2162
|
+
| name | <code>Text</code> |
|
|
2163
|
+
| value | <code>Text</code> |
|
|
2164
|
+
|
|
2165
|
+
<a name="module_GoogleProduct..QAObject"></a>
|
|
2166
|
+
|
|
2167
|
+
### GoogleProduct~QAObject : <code>object</code>
|
|
2168
|
+
Google Merchant API User-, merchant-, and manufacturer-authored questions and answers about the product.
|
|
2169
|
+
|
|
2170
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2171
|
+
**Properties**
|
|
2172
|
+
|
|
2173
|
+
| Name | Type | Description |
|
|
2174
|
+
| --- | --- | --- |
|
|
2175
|
+
| question | <code>Text</code> | Max. 1000 characters. |
|
|
2176
|
+
| answer | <code>Text</code> | Max. 1000 characters. |
|
|
2177
|
+
|
|
2178
|
+
<a name="module_GoogleProduct..GoogleProductAPI"></a>
|
|
2179
|
+
|
|
2180
|
+
### GoogleProduct~GoogleProductAPI : <code>object</code>
|
|
2181
|
+
a Google Product record
|
|
2182
|
+
|
|
2183
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2184
|
+
**Properties**
|
|
2185
|
+
|
|
2186
|
+
| Name | Type | Description |
|
|
2187
|
+
| --- | --- | --- |
|
|
2188
|
+
| id | <code>SKU</code> | id of Product also used as sku |
|
|
2189
|
+
| title | <code>Name</code> | title (name) of Product |
|
|
2190
|
+
| item_group_id | <code>Text</code> | ID for a group of products that come in different versions (variants) |
|
|
2191
|
+
| item_group_title | <code>Text</code> | name for a group of products that come in different versions (variants) |
|
|
2192
|
+
| description | <code>string</code> | Basic description of the product |
|
|
2193
|
+
| link | <code>URL</code> | Your product’s landing page |
|
|
2194
|
+
| image_link | <code>URL</code> | The URL of your product’s main image |
|
|
2195
|
+
| additional_image_link | <code>URL</code> | The URL of your product’s main image |
|
|
2196
|
+
| video_link | <code>URL</code> | Additional link to show a video of your product. |
|
|
2197
|
+
| virtual_model_link | <code>URL</code> | Additional link to show a 3D model of your product. |
|
|
2198
|
+
| mobile_link | <code>URL</code> | Your product’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic |
|
|
2199
|
+
| availability | <code>"in\_stock"</code> \| <code>"out\_of\_stock"</code> \| <code>"preorder"</code> \| <code>"backorder"</code> | Accurately submit the product's availability and match the availability from your landing page, checkout pages, and structured data (for example, “in_stock” or “out_of_stock” in your Schema.org markup). If an item is out of stock, the price must still be clearly visible on the landing page. Provide the availability date [availability_date] attribute if you submit preorder [preorder] or backorder [backorder] as the availability value. |
|
|
2200
|
+
| availability_date | <code>string</code> \| <code>ISO8601</code> | Use this attribute if your product's availability is set to preorder. Provide a value up to one year in the future. The availability date should also be added to the product’s landing page and be clear to your customers (for example, “May 6, 2023”). If an exact date can’t be provided, you can use an estimated date (for example, “May 2023”). |
|
|
2201
|
+
| cost_of_goods_sold | <code>string</code> \| <code>ISO4217</code> | The costs associated with the sale of a particular product as defined by the accounting convention you set up. These costs may include material, labor, freight, or other overhead expenses. By submittingthe COGS for your products, you gain insights about other metrics, such as your gross margin and the amount of revenue generated by your ads and free listings. |
|
|
2202
|
+
| expiration_date | <code>ISO8601</code> | The date that your product should stop showing |
|
|
2203
|
+
| price | <code>number</code> \| <code>ISO4217</code> | |
|
|
2204
|
+
| sale_price | <code>number</code> \| <code>ISO4217</code> | |
|
|
2205
|
+
| sale_price_effective_date | <code>DateRange</code> | |
|
|
2206
|
+
| google_product_category | <code>GoogleProductTaxonomy</code> | |
|
|
2207
|
+
| product_type | <code>string</code> | "Casual" google_product_category |
|
|
2208
|
+
| brand | <code>Text</code> | The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business user. |
|
|
2209
|
+
| gtin | <code>gtin8</code> \| <code>gtin12</code> \| <code>gtin13</code> \| <code>gtin14</code> \| <code>gtin</code> \| <code>isbn</code> | |
|
|
2210
|
+
| mpn | <code>Text</code> | The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers. |
|
|
2211
|
+
| adult | <code>"no"</code> \| <code>"yes"</code> | |
|
|
2212
|
+
| age_group | <code>Text</code> | newborn | infant | toddler | kids | adult |
|
|
2213
|
+
| gender | <code>"male"</code> \| <code>"female"</code> \| <code>"unisex"</code> | male female unisex |
|
|
2214
|
+
| color | <code>Text</code> | The color of the product. |
|
|
2215
|
+
| condition | <code>"new"</code> \| <code>"refurbished"</code> \| <code>"used"</code> \| <code>null</code> | |
|
|
2216
|
+
| material | <code>Text</code> | A material that something is made from, e.g. leather, wool, cotton, paper. |
|
|
2217
|
+
| pattern | <code>Text</code> | A pattern that something has |
|
|
2218
|
+
| product_length | <code>Text</code> | Your product's length |
|
|
2219
|
+
| product_width | <code>Text</code> | Your product's width |
|
|
2220
|
+
| product_height | <code>Text</code> | Your product's height Use the same unit of measurement for each product dimension attribute (including product length, width, and height). Otherwise, the information won't be displayed. |
|
|
2221
|
+
| product_highlight | <code>Text</code> | The most relevant highlights of your products |
|
|
2222
|
+
| product_weight | <code>Text</code> | Your product's weight |
|
|
2223
|
+
| question_and_answer | <code>Array.QAObject</code> | User-, merchant-, and manufacturer-authored questions and answers about the product. |
|
|
2224
|
+
| size | <code>Text</code> | |
|
|
2225
|
+
| size_type | <code>SizeTypeEnumeration</code> | Your apparel product’s cut |
|
|
2226
|
+
| size_system | <code>SizeSystemEnumeration</code> | The country of the size system used by your produc |
|
|
2227
|
+
| variant_option | <code>Array.GoogleAPIVariantOption</code> | Variant-identifying dimensions and their values |
|
|
2228
|
+
| ads_redirect | <code>URL</code> | A URL used to specify additional parameters for your product page. Customers will be sent to this URL rather than the value that you submit for the link [link] or mobile link [mobile_link] attributes |
|
|
2229
|
+
| custom_label_0 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2230
|
+
| custom_label_1 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2231
|
+
| custom_label_2 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2232
|
+
| custom_label_3 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2233
|
+
| custom_label_4 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2234
|
+
| promotion_id | <code>Text</code> | An identifier that allows you to match products to promotions |
|
|
2235
|
+
| lifestyle_image_link | <code>URL</code> | Attribute used to include the URL for a lifestyle image for your product |
|
|
2236
|
+
| short_title | <code>Text</code> | Short product name. Only available for Demand Gen Ads, including YouTube, Gmail, Maps, Discover app, Google Display Network, and Google Video Partners. |
|
|
2237
|
+
| shipping_label | <code>Text</code> | Label that you assign to a product to help assign correct shipping times and transit costs in Merchant Center account settings |
|
|
2238
|
+
| shipping_weight | <code>Text</code> | The weight of the product used to calculate the shipping cost |
|
|
2239
|
+
| shipping_length | <code>Text</code> | The length of the product used to calculate the shipping cost by dimensional weight |
|
|
2240
|
+
| shipping_width | <code>Text</code> | The width of the product used to calculate the shipping cost by dimensional weight |
|
|
2241
|
+
| shipping_height | <code>Text</code> | The height of the product used to calculate the shipping cost by dimensional weight |
|
|
2242
|
+
|
|
2243
|
+
<a name="module_GoogleProduct"></a>
|
|
2244
|
+
|
|
2245
|
+
## GoogleProduct
|
|
2246
|
+
Typedefs, constants, support functions and database operations related to Products
|
|
2247
|
+
|
|
2248
|
+
|
|
2249
|
+
* [GoogleProduct](#module_GoogleProduct)
|
|
2250
|
+
* _static_
|
|
2251
|
+
* [.GoogleAPIProductDefault](#module_GoogleProduct.GoogleAPIProductDefault) : <code>GoogleProductAPI</code>
|
|
2252
|
+
* [.GoogleAPIProductMap](#module_GoogleProduct.GoogleAPIProductMap) : <code>GoogleProductAPI</code>
|
|
2253
|
+
* _inner_
|
|
2254
|
+
* [~GoogleProductAPIField(field, InventoryProduct)](#module_GoogleProduct..GoogleProductAPIField)
|
|
2255
|
+
* [~SKU](#module_GoogleProduct..SKU) : <code>string</code>
|
|
2256
|
+
* [~Name](#module_GoogleProduct..Name) : <code>string</code>
|
|
2257
|
+
* [~ImageObject](#module_GoogleProduct..ImageObject) : <code>object</code>
|
|
2258
|
+
* [~ReviewRating](#module_GoogleProduct..ReviewRating) : <code>object</code>
|
|
2259
|
+
* [~ReviewObject](#module_GoogleProduct..ReviewObject) : <code>object</code>
|
|
2260
|
+
* [~AggregateRatingsValue](#module_GoogleProduct..AggregateRatingsValue) : <code>object</code>
|
|
2261
|
+
* [~BrandObject](#module_GoogleProduct..BrandObject) : <code>object</code>
|
|
2262
|
+
* [~QuantitativeValue](#module_GoogleProduct..QuantitativeValue) : <code>object</code>
|
|
2263
|
+
* [~SizeGroupEnumeration](#module_GoogleProduct..SizeGroupEnumeration) : <code>"Big"</code> \| <code>"Boys"</code> \| <code>"ExtraShort"</code> \| <code>"ExtraTall"</code> \| <code>"Girls"</code> \| <code>"Husky"</code> \| <code>"Infants"</code> \| <code>"Juniors"</code> \| <code>"Maternity"</code> \| <code>"Mens"</code> \| <code>"Misses"</code> \| <code>"Petite"</code> \| <code>"Plus"</code> \| <code>"Regular"</code> \| <code>"Short"</code> \| <code>"Tall"</code> \| <code>"Womens"</code>
|
|
2264
|
+
* [~SizeTypeEnumeration](#module_GoogleProduct..SizeTypeEnumeration) : <code>"regular"</code> \| <code>"petite"</code> \| <code>"maternity"</code> \| <code>"big"</code> \| <code>"tall"</code> \| <code>"plus"</code>
|
|
2265
|
+
* [~SizeSystemEnumeration](#module_GoogleProduct..SizeSystemEnumeration) : <code>"US"</code> \| <code>"UK"</code> \| <code>"EU"</code> \| <code>"DE"</code> \| <code>"FR"</code> \| <code>"JP"</code> \| <code>"CN"</code> \| <code>"IT"</code> \| <code>"BR"</code> \| <code>"MEX"</code> \| <code>"AU"</code>
|
|
2266
|
+
* [~GoogleAPIVariantOption](#module_GoogleProduct..GoogleAPIVariantOption) : <code>object</code>
|
|
2267
|
+
* [~SizeSpecification](#module_GoogleProduct..SizeSpecification) : <code>object</code>
|
|
2268
|
+
* [~QAObject](#module_GoogleProduct..QAObject) : <code>object</code>
|
|
2269
|
+
* [~availabilityEnum](#module_GoogleProduct..availabilityEnum) : <code>"in\_stock"</code> \| <code>"out\_of\_stock"</code> \| <code>"preorder"</code> \| <code>"backorder"</code>
|
|
2270
|
+
* [~GoogleProduct](#module_GoogleProduct..GoogleProduct) : <code>object</code>
|
|
2271
|
+
* [~SKU](#module_GoogleProduct..SKU) : <code>string</code>
|
|
2272
|
+
* [~Name](#module_GoogleProduct..Name) : <code>string</code>
|
|
2273
|
+
* [~SizeTypeEnumeration](#module_GoogleProduct..SizeTypeEnumeration) : <code>"regular"</code> \| <code>"petite"</code> \| <code>"maternity"</code> \| <code>"big"</code> \| <code>"tall"</code> \| <code>"plus"</code>
|
|
2274
|
+
* [~SizeSystemEnumeration](#module_GoogleProduct..SizeSystemEnumeration) : <code>"US"</code> \| <code>"UK"</code> \| <code>"EU"</code> \| <code>"DE"</code> \| <code>"FR"</code> \| <code>"JP"</code> \| <code>"CN"</code> \| <code>"IT"</code> \| <code>"BR"</code> \| <code>"MEX"</code> \| <code>"AU"</code>
|
|
2275
|
+
* [~GoogleAPIVariantOption](#module_GoogleProduct..GoogleAPIVariantOption) : <code>object</code>
|
|
2276
|
+
* [~QAObject](#module_GoogleProduct..QAObject) : <code>object</code>
|
|
2277
|
+
* [~GoogleProductAPI](#module_GoogleProduct..GoogleProductAPI) : <code>object</code>
|
|
2278
|
+
|
|
2279
|
+
<a name="module_GoogleProduct.GoogleAPIProductDefault"></a>
|
|
2280
|
+
|
|
2281
|
+
### GoogleProduct.GoogleAPIProductDefault : <code>GoogleProductAPI</code>
|
|
2282
|
+
**Kind**: static constant of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2283
|
+
<a name="module_GoogleProduct.GoogleAPIProductMap"></a>
|
|
2284
|
+
|
|
2285
|
+
### GoogleProduct.GoogleAPIProductMap : <code>GoogleProductAPI</code>
|
|
2286
|
+
**Kind**: static constant of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2287
|
+
<a name="module_GoogleProduct..GoogleProductAPIField"></a>
|
|
2288
|
+
|
|
2289
|
+
### GoogleProduct~GoogleProductAPIField(field, InventoryProduct)
|
|
2290
|
+
**Kind**: inner method of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2291
|
+
|
|
2292
|
+
| Param | Type |
|
|
2293
|
+
| --- | --- |
|
|
2294
|
+
| field | <code>string</code> |
|
|
2295
|
+
| InventoryProduct | <code>Product</code> |
|
|
2296
|
+
|
|
2297
|
+
<a name="module_GoogleProduct..SKU"></a>
|
|
2298
|
+
|
|
2299
|
+
### GoogleProduct~SKU : <code>string</code>
|
|
2300
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2301
|
+
<a name="module_GoogleProduct..Name"></a>
|
|
2302
|
+
|
|
2303
|
+
### GoogleProduct~Name : <code>string</code>
|
|
2304
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2305
|
+
<a name="module_GoogleProduct..ImageObject"></a>
|
|
2306
|
+
|
|
2307
|
+
### GoogleProduct~ImageObject : <code>object</code>
|
|
2308
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2309
|
+
**Properties**
|
|
2310
|
+
|
|
2311
|
+
| Name | Type | Description |
|
|
2312
|
+
| --- | --- | --- |
|
|
2313
|
+
| caption | <code>text</code> \| <code>MediaObject</code> | |
|
|
2314
|
+
| embeddedTextCaption | <code>text</code> | |
|
|
2315
|
+
| exifData | <code>object</code> | |
|
|
2316
|
+
| dateCreated | <code>Date</code> \| <code>DateTime</code> | |
|
|
2317
|
+
| dateModified | <code>Date</code> \| <code>DateTime</code> | |
|
|
2318
|
+
| datePublished | <code>Date</code> \| <code>DateTime</code> | |
|
|
2319
|
+
| position | <code>text</code> \| <code>number</code> | The position of an item in a series or sequence of items. |
|
|
2320
|
+
| text | <code>text</code> | The textual content of this CreativeWork. |
|
|
2321
|
+
| thumbnail | <code>ImageObject</code> | |
|
|
2322
|
+
| alternateName | <code>text</code> | An alias for the item. |
|
|
2323
|
+
| description | <code>text</code> | A description of the item. |
|
|
2324
|
+
| imageAn | <code>URL</code> \| <code>ImageObject</code> | image of the item. This can be a URL or a fully described ImageObject. |
|
|
2325
|
+
| name | <code>Name</code> | The name of the item. |
|
|
2326
|
+
| url | <code>URL</code> | |
|
|
2327
|
+
|
|
2328
|
+
<a name="module_GoogleProduct..ReviewRating"></a>
|
|
2329
|
+
|
|
2330
|
+
### GoogleProduct~ReviewRating : <code>object</code>
|
|
2331
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2332
|
+
**Properties**
|
|
2333
|
+
|
|
2334
|
+
| Name | Type | Description |
|
|
2335
|
+
| --- | --- | --- |
|
|
2336
|
+
| type | <code>text</code> | "Rating" |
|
|
2337
|
+
| bestRating | <code>integer</code> \| <code>text</code> | The highest value allowed in this rating system. |
|
|
2338
|
+
| worstRating | <code>integer</code> \| <code>text</code> | The lowest value allowed in this rating system. |
|
|
2339
|
+
| ratingValue | <code>Text</code> \| <code>Number</code> | The rating for the content. Usage guidelines: Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols. Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
|
|
2340
|
+
|
|
2341
|
+
<a name="module_GoogleProduct..ReviewObject"></a>
|
|
2342
|
+
|
|
2343
|
+
### GoogleProduct~ReviewObject : <code>object</code>
|
|
2344
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2345
|
+
**Properties**
|
|
2346
|
+
|
|
2347
|
+
| Name | Type | Description |
|
|
2348
|
+
| --- | --- | --- |
|
|
2349
|
+
| type | <code>text</code> | "Review" |
|
|
2350
|
+
| author | <code>text</code> | |
|
|
2351
|
+
| name | <code>text</code> | |
|
|
2352
|
+
| datePublished | <code>Date</code> \| <code>DateTime</code> | |
|
|
2353
|
+
| reviewBody | <code>text</code> | |
|
|
2354
|
+
| reviews | <code>Array.ReviewRating</code> | |
|
|
2355
|
+
| review | <code>ReviewRating</code> | |
|
|
2356
|
+
|
|
2357
|
+
<a name="module_GoogleProduct..AggregateRatingsValue"></a>
|
|
2358
|
+
|
|
2359
|
+
### GoogleProduct~AggregateRatingsValue : <code>object</code>
|
|
2360
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2361
|
+
**Properties**
|
|
2362
|
+
|
|
2363
|
+
| Name | Type | Description |
|
|
2364
|
+
| --- | --- | --- |
|
|
2365
|
+
| type | <code>text</code> | "AggregateRating" |
|
|
2366
|
+
| itemReviewed | <code>Thing</code> | The item that is being reviewed/rated. |
|
|
2367
|
+
| ratingCount | <code>integer</code> | The count of total number of ratings. |
|
|
2368
|
+
| reviewCount | <code>integer</code> | The count of total number of reviews. |
|
|
2369
|
+
| ratingExplanation | <code>text</code> | A short explanation (e.g. one to two sentences) providing background context and other information that led to the conclusion expressed in the rating. This is particularly applicable to ratings associated with "fact check" markup using ClaimReview. |
|
|
2370
|
+
| ratingValue | <code>Text</code> \| <code>Number</code> | The rating for the content. Usage guidelines: Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols. Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
|
|
2371
|
+
| bestRating | <code>integer</code> \| <code>text</code> | The highest value allowed in this rating system. |
|
|
2372
|
+
| worstRating | <code>integer</code> \| <code>text</code> | The lowest value allowed in this rating system. |
|
|
2373
|
+
|
|
2374
|
+
<a name="module_GoogleProduct..BrandObject"></a>
|
|
2375
|
+
|
|
2376
|
+
### GoogleProduct~BrandObject : <code>object</code>
|
|
2377
|
+
a Brand Object
|
|
2378
|
+
|
|
2379
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2380
|
+
**Properties**
|
|
2381
|
+
|
|
2382
|
+
| Name | Type | Description |
|
|
2383
|
+
| --- | --- | --- |
|
|
2384
|
+
| aggregateRating | <code>AggregateRatingsValue</code> | |
|
|
2385
|
+
| logo | <code>URL</code> \| <code>ImageObject</code> | |
|
|
2386
|
+
| review | <code>ReviewObject</code> | A review of the item. Supersedes reviews |
|
|
2387
|
+
| slogan | <code>text</code> | A slogan or motto associated with the item. |
|
|
2388
|
+
| name | <code>Name</code> | The name of the brand. |
|
|
2389
|
+
|
|
2390
|
+
<a name="module_GoogleProduct..QuantitativeValue"></a>
|
|
2391
|
+
|
|
2392
|
+
### GoogleProduct~QuantitativeValue : <code>object</code>
|
|
2393
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2394
|
+
**Properties**
|
|
2395
|
+
|
|
2396
|
+
| Name | Type | Description |
|
|
2397
|
+
| --- | --- | --- |
|
|
2398
|
+
| value | <code>Boolean</code> \| <code>Number</code> \| <code>text</code> \| <code>StructuredValue</code> | The value of a QuantitativeValue (including Observation) or property value node. * For QuantitativeValue and MonetaryAmount, the recommended type for values is 'Number'. * For PropertyValue, it can be 'Text', 'Number', 'Boolean', or 'StructuredValue'. * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols. * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
|
|
2399
|
+
| maxValue | <code>number</code> | The upper value of some characteristic or property. |
|
|
2400
|
+
| minValue | <code>number</code> | The lower value of some characteristic or property. |
|
|
2401
|
+
| unitText | <code>Text</code> | A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code for unitCode |
|
|
2402
|
+
| unitCode | <code>Text</code> \| <code>URL</code> | The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon |
|
|
2403
|
+
|
|
2404
|
+
<a name="module_GoogleProduct..SizeGroupEnumeration"></a>
|
|
2405
|
+
|
|
2406
|
+
### GoogleProduct~SizeGroupEnumeration : <code>"Big"</code> \| <code>"Boys"</code> \| <code>"ExtraShort"</code> \| <code>"ExtraTall"</code> \| <code>"Girls"</code> \| <code>"Husky"</code> \| <code>"Infants"</code> \| <code>"Juniors"</code> \| <code>"Maternity"</code> \| <code>"Mens"</code> \| <code>"Misses"</code> \| <code>"Petite"</code> \| <code>"Plus"</code> \| <code>"Regular"</code> \| <code>"Short"</code> \| <code>"Tall"</code> \| <code>"Womens"</code>
|
|
2407
|
+
Size Grouping options
|
|
2408
|
+
|
|
2409
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2410
|
+
<a name="module_GoogleProduct..SizeTypeEnumeration"></a>
|
|
2411
|
+
|
|
2412
|
+
### GoogleProduct~SizeTypeEnumeration : <code>"regular"</code> \| <code>"petite"</code> \| <code>"maternity"</code> \| <code>"big"</code> \| <code>"tall"</code> \| <code>"plus"</code>
|
|
2413
|
+
Google Merchant API Size/Fit Options
|
|
2414
|
+
|
|
2415
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2416
|
+
<a name="module_GoogleProduct..SizeSystemEnumeration"></a>
|
|
2417
|
+
|
|
2418
|
+
### GoogleProduct~SizeSystemEnumeration : <code>"US"</code> \| <code>"UK"</code> \| <code>"EU"</code> \| <code>"DE"</code> \| <code>"FR"</code> \| <code>"JP"</code> \| <code>"CN"</code> \| <code>"IT"</code> \| <code>"BR"</code> \| <code>"MEX"</code> \| <code>"AU"</code>
|
|
2419
|
+
Google Merchant API Size System/Country Options
|
|
2420
|
+
|
|
2421
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2422
|
+
<a name="module_GoogleProduct..GoogleAPIVariantOption"></a>
|
|
2423
|
+
|
|
2424
|
+
### GoogleProduct~GoogleAPIVariantOption : <code>object</code>
|
|
2425
|
+
Google Merchant API Variant-identifying dimensions and their values
|
|
2426
|
+
|
|
2427
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2428
|
+
**Properties**
|
|
2429
|
+
|
|
2430
|
+
| Name | Type |
|
|
2431
|
+
| --- | --- |
|
|
2432
|
+
| name | <code>Text</code> |
|
|
2433
|
+
| value | <code>Text</code> |
|
|
2434
|
+
|
|
2435
|
+
<a name="module_GoogleProduct..SizeSpecification"></a>
|
|
2436
|
+
|
|
2437
|
+
### GoogleProduct~SizeSpecification : <code>object</code>
|
|
2438
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2439
|
+
**Properties**
|
|
2440
|
+
|
|
2441
|
+
| Name | Type | Description |
|
|
2442
|
+
| --- | --- | --- |
|
|
2443
|
+
| type | <code>Text</code> | "SizeSpecification" |
|
|
2444
|
+
| hasMeasurement | <code>QuantitativeValue</code> | |
|
|
2445
|
+
| sizeGroup | <code>Array.SizeGroupEnumeration</code> \| <code>SizeGroupEnumeration</code> \| <code>Text</code> | The size group (also known as "size type") for a product's size. Size groups are common in the fashion industry to define size segments and suggested audiences for wearable products. Multiple values can be combined, for example "men's big and tall", "petite maternity" or "regular". |
|
|
2446
|
+
| sizeSystem | <code>Array.SizeSystemEnumeration</code> \| <code>SizeSystemEnumeration</code> \| <code>Text</code> | The size system used to identify a product's size. Typically either a standard (for example, "GS1" or "ISO-EN13402"), country code (for example "US" or "JP"), or a measuring system (for example "Metric" or "Imperial"). |
|
|
2447
|
+
| suggestedAge | <code>QuantitativeValue</code> | The age or age range for the intended audience or user, for example 3-12 months for infants, 1-5 years for toddlers. |
|
|
2448
|
+
| suggestedGender | <code>GenderType</code> \| <code>Text</code> | The suggested gender of the intended user or audience, for example "male", "female", or "unisex". |
|
|
2449
|
+
| suggestedMeasurement | <code>QuantitativeValue</code> | A suggested range of body measurements for the intended audience or user, for example inseam between 32 and 34 inches or height between 170 and 190 cm. Typically found on a size chart for wearable products. |
|
|
2450
|
+
|
|
2451
|
+
<a name="module_GoogleProduct..QAObject"></a>
|
|
2452
|
+
|
|
2453
|
+
### GoogleProduct~QAObject : <code>object</code>
|
|
2454
|
+
Google Merchant API User-, merchant-, and manufacturer-authored questions and answers about the product.
|
|
2455
|
+
|
|
2456
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2457
|
+
**Properties**
|
|
2458
|
+
|
|
2459
|
+
| Name | Type | Description |
|
|
2460
|
+
| --- | --- | --- |
|
|
2461
|
+
| question | <code>Text</code> | Max. 1000 characters. |
|
|
2462
|
+
| answer | <code>Text</code> | Max. 1000 characters. |
|
|
2463
|
+
|
|
2464
|
+
<a name="module_GoogleProduct..availabilityEnum"></a>
|
|
2465
|
+
|
|
2466
|
+
### GoogleProduct~availabilityEnum : <code>"in\_stock"</code> \| <code>"out\_of\_stock"</code> \| <code>"preorder"</code> \| <code>"backorder"</code>
|
|
2467
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2468
|
+
<a name="module_GoogleProduct..GoogleProduct"></a>
|
|
2469
|
+
|
|
2470
|
+
### GoogleProduct~GoogleProduct : <code>object</code>
|
|
2471
|
+
a Google Product record
|
|
2472
|
+
|
|
2473
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2474
|
+
**Properties**
|
|
2475
|
+
|
|
2476
|
+
| Name | Type | Description |
|
|
2477
|
+
| --- | --- | --- |
|
|
2478
|
+
| id | <code>SKU</code> | id of Product also used as sku |
|
|
2479
|
+
| title | <code>Name</code> | title (name) of Product |
|
|
2480
|
+
| description | <code>string</code> | Basic description of the product |
|
|
2481
|
+
| link | <code>URL</code> | Your product’s landing page |
|
|
2482
|
+
| image_link | <code>URL</code> | The URL of your product’s main image |
|
|
2483
|
+
| additional_image_link | <code>URL</code> | The URL of your product’s main image |
|
|
2484
|
+
| video_link | <code>URL</code> | Additional link to show a video of your product. |
|
|
2485
|
+
| virtual_model_link | <code>URL</code> | Additional link to show a 3D model of your product. |
|
|
2486
|
+
| mobile_link | <code>URL</code> | Your product’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic |
|
|
2487
|
+
| availability | <code>availabilityEnum</code> | Accurately submit the product's availability and match the availability from your landing page, checkout pages, and structured data (for example, “in_stock” or “out_of_stock” in your Schema.org markup). If an item is out of stock, the price must still be clearly visible on the landing page. Provide the availability date [availability_date] attribute if you submit preorder [preorder] or backorder [backorder] as the availability value. |
|
|
2488
|
+
| availability_date | <code>string</code> \| <code>ISO8601</code> | Use this attribute if your product's availability is set to preorder. Provide a value up to one year in the future. The availability date should also be added to the product’s landing page and be clear to your customers (for example, “May 6, 2023”). If an exact date can’t be provided, you can use an estimated date (for example, “May 2023”). |
|
|
2489
|
+
| cost_of_goods_sold | <code>string</code> \| <code>ISO4217</code> | The costs associated with the sale of a particular product as defined by the accounting convention you set up. These costs may include material, labor, freight, or other overhead expenses. By submittingthe COGS for your products, you gain insights about other metrics, such as your gross margin and the amount of revenue generated by your ads and free listings. |
|
|
2490
|
+
| expiration_date | <code>ISO8601</code> | The date that your product should stop showing |
|
|
2491
|
+
| price | <code>number</code> \| <code>ISO4217</code> | |
|
|
2492
|
+
| sale_price | <code>number</code> \| <code>ISO4217</code> | |
|
|
2493
|
+
| sale_price_effective_date | <code>DateRange</code> | |
|
|
2494
|
+
| google_product_category | <code>GoogleProductTaxonomy</code> | |
|
|
2495
|
+
| product_type | <code>string</code> | |
|
|
2496
|
+
| brand | <code>Text</code> \| <code>BrandObject</code> | The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business user. |
|
|
2497
|
+
| gtin | <code>gtin8</code> \| <code>gtin12</code> \| <code>gtin13</code> \| <code>gtin14</code> \| <code>gtin</code> \| <code>isbn</code> | |
|
|
2498
|
+
| mpn | <code>Text</code> | The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers. |
|
|
2499
|
+
| adult | <code>"no"</code> \| <code>"yes"</code> | |
|
|
2500
|
+
| age_group | <code>Text</code> | newborn | infant | toddler | kids | adult |
|
|
2501
|
+
| gender | <code>Text</code> | male female unisex |
|
|
2502
|
+
| color | <code>Text</code> | The color of the product. |
|
|
2503
|
+
| condition | <code>"new"</code> \| <code>"refurbished"</code> \| <code>"used"</code> | |
|
|
2504
|
+
| item_group_id | <code>Text</code> | ID for a group of products that come in different versions (variants) |
|
|
2505
|
+
| item_group_title | <code>Text</code> | name for a group of products that come in different versions (variants) |
|
|
2506
|
+
| material | <code>Text</code> | A material that something is made from, e.g. leather, wool, cotton, paper. |
|
|
2507
|
+
| pattern | <code>Text</code> | A pattern that something has |
|
|
2508
|
+
| product_length | <code>Text</code> | Your product's length |
|
|
2509
|
+
| product_width | <code>Text</code> | Your product's width |
|
|
2510
|
+
| product_height | <code>Text</code> | Your product's height Use the same unit of measurement for each product dimension attribute (including product length, width, and height). Otherwise, the information won't be displayed. |
|
|
2511
|
+
| product_highlight | <code>Text</code> | The most relevant highlights of your products |
|
|
2512
|
+
| product_weight | <code>Text</code> | Your product's weight |
|
|
2513
|
+
| question_and_answer | <code>Array.QAObject</code> | User-, merchant-, and manufacturer-authored questions and answers about the product. |
|
|
2514
|
+
| size | <code>Text</code> \| <code>SizeSpecification</code> \| <code>QuantitativeValue</code> | |
|
|
2515
|
+
| size_type | <code>SizeTypeEnumeration</code> | Your apparel product’s cut |
|
|
2516
|
+
| size_system | <code>SizeSystemEnumeration</code> | The country of the size system used by your produc |
|
|
2517
|
+
| variant_option | <code>Array.GoogleAPIVariantOption</code> | Variant-identifying dimensions and their values |
|
|
2518
|
+
| ads_redirect | <code>URL</code> | A URL used to specify additional parameters for your product page. Customers will be sent to this URL rather than the value that you submit for the link [link] or mobile link [mobile_link] attributes |
|
|
2519
|
+
| custom_label_0 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2520
|
+
| custom_label_1 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2521
|
+
| custom_label_2 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2522
|
+
| custom_label_3 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2523
|
+
| custom_label_4 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2524
|
+
| promotion_id | <code>Text</code> | An identifier that allows you to match products to promotions |
|
|
2525
|
+
| lifestyle_image_link | <code>URL</code> | Attribute used to include the URL for a lifestyle image for your product |
|
|
2526
|
+
| short_title | <code>Text</code> | Short product name. Only available for Demand Gen Ads, including YouTube, Gmail, Maps, Discover app, Google Display Network, and Google Video Partners. |
|
|
2527
|
+
| shipping_label | <code>Text</code> | Label that you assign to a product to help assign correct shipping times and transit costs in Merchant Center account settings |
|
|
2528
|
+
| shipping_weight | <code>Text</code> | The weight of the product used to calculate the shipping cost |
|
|
2529
|
+
| shipping_length | <code>Text</code> | The length of the product used to calculate the shipping cost by dimensional weight |
|
|
2530
|
+
| shipping_width | <code>Text</code> | The width of the product used to calculate the shipping cost by dimensional weight |
|
|
2531
|
+
| shipping_height | <code>Text</code> | The height of the product used to calculate the shipping cost by dimensional weight |
|
|
2532
|
+
|
|
2533
|
+
<a name="module_GoogleProduct..SKU"></a>
|
|
2534
|
+
|
|
2535
|
+
### GoogleProduct~SKU : <code>string</code>
|
|
2536
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2537
|
+
<a name="module_GoogleProduct..Name"></a>
|
|
2538
|
+
|
|
2539
|
+
### GoogleProduct~Name : <code>string</code>
|
|
2540
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2541
|
+
<a name="module_GoogleProduct..SizeTypeEnumeration"></a>
|
|
2542
|
+
|
|
2543
|
+
### GoogleProduct~SizeTypeEnumeration : <code>"regular"</code> \| <code>"petite"</code> \| <code>"maternity"</code> \| <code>"big"</code> \| <code>"tall"</code> \| <code>"plus"</code>
|
|
2544
|
+
Google Merchant API Size/Fit Options
|
|
2545
|
+
|
|
2546
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2547
|
+
<a name="module_GoogleProduct..SizeSystemEnumeration"></a>
|
|
2548
|
+
|
|
2549
|
+
### GoogleProduct~SizeSystemEnumeration : <code>"US"</code> \| <code>"UK"</code> \| <code>"EU"</code> \| <code>"DE"</code> \| <code>"FR"</code> \| <code>"JP"</code> \| <code>"CN"</code> \| <code>"IT"</code> \| <code>"BR"</code> \| <code>"MEX"</code> \| <code>"AU"</code>
|
|
2550
|
+
Google Merchant API Size System/Country Options
|
|
2551
|
+
|
|
2552
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2553
|
+
<a name="module_GoogleProduct..GoogleAPIVariantOption"></a>
|
|
2554
|
+
|
|
2555
|
+
### GoogleProduct~GoogleAPIVariantOption : <code>object</code>
|
|
2556
|
+
Google Merchant API Variant-identifying dimensions and their values
|
|
2557
|
+
|
|
2558
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2559
|
+
**Properties**
|
|
2560
|
+
|
|
2561
|
+
| Name | Type |
|
|
2562
|
+
| --- | --- |
|
|
2563
|
+
| name | <code>Text</code> |
|
|
2564
|
+
| value | <code>Text</code> |
|
|
2565
|
+
|
|
2566
|
+
<a name="module_GoogleProduct..QAObject"></a>
|
|
2567
|
+
|
|
2568
|
+
### GoogleProduct~QAObject : <code>object</code>
|
|
2569
|
+
Google Merchant API User-, merchant-, and manufacturer-authored questions and answers about the product.
|
|
2570
|
+
|
|
2571
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2572
|
+
**Properties**
|
|
2573
|
+
|
|
2574
|
+
| Name | Type | Description |
|
|
2575
|
+
| --- | --- | --- |
|
|
2576
|
+
| question | <code>Text</code> | Max. 1000 characters. |
|
|
2577
|
+
| answer | <code>Text</code> | Max. 1000 characters. |
|
|
2578
|
+
|
|
2579
|
+
<a name="module_GoogleProduct..GoogleProductAPI"></a>
|
|
2580
|
+
|
|
2581
|
+
### GoogleProduct~GoogleProductAPI : <code>object</code>
|
|
2582
|
+
a Google Product record
|
|
2583
|
+
|
|
2584
|
+
**Kind**: inner typedef of [<code>GoogleProduct</code>](#module_GoogleProduct)
|
|
2585
|
+
**Properties**
|
|
2586
|
+
|
|
2587
|
+
| Name | Type | Description |
|
|
2588
|
+
| --- | --- | --- |
|
|
2589
|
+
| id | <code>SKU</code> | id of Product also used as sku |
|
|
2590
|
+
| title | <code>Name</code> | title (name) of Product |
|
|
2591
|
+
| item_group_id | <code>Text</code> | ID for a group of products that come in different versions (variants) |
|
|
2592
|
+
| item_group_title | <code>Text</code> | name for a group of products that come in different versions (variants) |
|
|
2593
|
+
| description | <code>string</code> | Basic description of the product |
|
|
2594
|
+
| link | <code>URL</code> | Your product’s landing page |
|
|
2595
|
+
| image_link | <code>URL</code> | The URL of your product’s main image |
|
|
2596
|
+
| additional_image_link | <code>URL</code> | The URL of your product’s main image |
|
|
2597
|
+
| video_link | <code>URL</code> | Additional link to show a video of your product. |
|
|
2598
|
+
| virtual_model_link | <code>URL</code> | Additional link to show a 3D model of your product. |
|
|
2599
|
+
| mobile_link | <code>URL</code> | Your product’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic |
|
|
2600
|
+
| availability | <code>"in\_stock"</code> \| <code>"out\_of\_stock"</code> \| <code>"preorder"</code> \| <code>"backorder"</code> | Accurately submit the product's availability and match the availability from your landing page, checkout pages, and structured data (for example, “in_stock” or “out_of_stock” in your Schema.org markup). If an item is out of stock, the price must still be clearly visible on the landing page. Provide the availability date [availability_date] attribute if you submit preorder [preorder] or backorder [backorder] as the availability value. |
|
|
2601
|
+
| availability_date | <code>string</code> \| <code>ISO8601</code> | Use this attribute if your product's availability is set to preorder. Provide a value up to one year in the future. The availability date should also be added to the product’s landing page and be clear to your customers (for example, “May 6, 2023”). If an exact date can’t be provided, you can use an estimated date (for example, “May 2023”). |
|
|
2602
|
+
| cost_of_goods_sold | <code>string</code> \| <code>ISO4217</code> | The costs associated with the sale of a particular product as defined by the accounting convention you set up. These costs may include material, labor, freight, or other overhead expenses. By submittingthe COGS for your products, you gain insights about other metrics, such as your gross margin and the amount of revenue generated by your ads and free listings. |
|
|
2603
|
+
| expiration_date | <code>ISO8601</code> | The date that your product should stop showing |
|
|
2604
|
+
| price | <code>number</code> \| <code>ISO4217</code> | |
|
|
2605
|
+
| sale_price | <code>number</code> \| <code>ISO4217</code> | |
|
|
2606
|
+
| sale_price_effective_date | <code>DateRange</code> | |
|
|
2607
|
+
| google_product_category | <code>GoogleProductTaxonomy</code> | |
|
|
2608
|
+
| product_type | <code>string</code> | "Casual" google_product_category |
|
|
2609
|
+
| brand | <code>Text</code> | The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business user. |
|
|
2610
|
+
| gtin | <code>gtin8</code> \| <code>gtin12</code> \| <code>gtin13</code> \| <code>gtin14</code> \| <code>gtin</code> \| <code>isbn</code> | |
|
|
2611
|
+
| mpn | <code>Text</code> | The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers. |
|
|
2612
|
+
| adult | <code>"no"</code> \| <code>"yes"</code> | |
|
|
2613
|
+
| age_group | <code>Text</code> | newborn | infant | toddler | kids | adult |
|
|
2614
|
+
| gender | <code>"male"</code> \| <code>"female"</code> \| <code>"unisex"</code> | male female unisex |
|
|
2615
|
+
| color | <code>Text</code> | The color of the product. |
|
|
2616
|
+
| condition | <code>"new"</code> \| <code>"refurbished"</code> \| <code>"used"</code> \| <code>null</code> | |
|
|
2617
|
+
| material | <code>Text</code> | A material that something is made from, e.g. leather, wool, cotton, paper. |
|
|
2618
|
+
| pattern | <code>Text</code> | A pattern that something has |
|
|
2619
|
+
| product_length | <code>Text</code> | Your product's length |
|
|
2620
|
+
| product_width | <code>Text</code> | Your product's width |
|
|
2621
|
+
| product_height | <code>Text</code> | Your product's height Use the same unit of measurement for each product dimension attribute (including product length, width, and height). Otherwise, the information won't be displayed. |
|
|
2622
|
+
| product_highlight | <code>Text</code> | The most relevant highlights of your products |
|
|
2623
|
+
| product_weight | <code>Text</code> | Your product's weight |
|
|
2624
|
+
| question_and_answer | <code>Array.QAObject</code> | User-, merchant-, and manufacturer-authored questions and answers about the product. |
|
|
2625
|
+
| size | <code>Text</code> | |
|
|
2626
|
+
| size_type | <code>SizeTypeEnumeration</code> | Your apparel product’s cut |
|
|
2627
|
+
| size_system | <code>SizeSystemEnumeration</code> | The country of the size system used by your produc |
|
|
2628
|
+
| variant_option | <code>Array.GoogleAPIVariantOption</code> | Variant-identifying dimensions and their values |
|
|
2629
|
+
| ads_redirect | <code>URL</code> | A URL used to specify additional parameters for your product page. Customers will be sent to this URL rather than the value that you submit for the link [link] or mobile link [mobile_link] attributes |
|
|
2630
|
+
| custom_label_0 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2631
|
+
| custom_label_1 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2632
|
+
| custom_label_2 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2633
|
+
| custom_label_3 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2634
|
+
| custom_label_4 | <code>Text</code> | Label that you assign to a product to help organize bidding and reporting in Shopping campaigns |
|
|
2635
|
+
| promotion_id | <code>Text</code> | An identifier that allows you to match products to promotions |
|
|
2636
|
+
| lifestyle_image_link | <code>URL</code> | Attribute used to include the URL for a lifestyle image for your product |
|
|
2637
|
+
| short_title | <code>Text</code> | Short product name. Only available for Demand Gen Ads, including YouTube, Gmail, Maps, Discover app, Google Display Network, and Google Video Partners. |
|
|
2638
|
+
| shipping_label | <code>Text</code> | Label that you assign to a product to help assign correct shipping times and transit costs in Merchant Center account settings |
|
|
2639
|
+
| shipping_weight | <code>Text</code> | The weight of the product used to calculate the shipping cost |
|
|
2640
|
+
| shipping_length | <code>Text</code> | The length of the product used to calculate the shipping cost by dimensional weight |
|
|
2641
|
+
| shipping_width | <code>Text</code> | The width of the product used to calculate the shipping cost by dimensional weight |
|
|
2642
|
+
| shipping_height | <code>Text</code> | The height of the product used to calculate the shipping cost by dimensional weight |
|
|
2643
|
+
|
|
2644
|
+
<a name="module_SquarespaceProduct"></a>
|
|
2645
|
+
|
|
2646
|
+
## SquarespaceProduct
|
|
2647
|
+
Typedefs, constants, support functions and database operations related to Products
|
|
2648
|
+
|
|
2649
|
+
|
|
2650
|
+
* [SquarespaceProduct](#module_SquarespaceProduct)
|
|
2651
|
+
* [~PhysicalProductDefault](#module_SquarespaceProduct..PhysicalProductDefault) : <code>PhysicalProduct</code>
|
|
2652
|
+
* [~PhysicalProductMap](#module_SquarespaceProduct..PhysicalProductMap) : <code>PhysicalProduct</code>
|
|
2653
|
+
* [~ProductDataForm](#module_SquarespaceProduct..ProductDataForm) : <code>Product</code>
|
|
2654
|
+
* [~ProductDefaultForm](#module_SquarespaceProduct..ProductDefaultForm) : <code>Product</code>
|
|
2655
|
+
* [~AttributeList](#module_SquarespaceProduct..AttributeList) : <code>Array.String</code>
|
|
2656
|
+
* [~AttributeValue](#module_SquarespaceProduct..AttributeValue) : <code>object</code>
|
|
2657
|
+
* [~ProductImage](#module_SquarespaceProduct..ProductImage) : <code>object</code>
|
|
2658
|
+
* [~CurrencyDescription](#module_SquarespaceProduct..CurrencyDescription) : <code>object</code>
|
|
2659
|
+
* [~MonetaryValue](#module_SquarespaceProduct..MonetaryValue) : <code>object</code>
|
|
2660
|
+
* [~FullProductPricing](#module_SquarespaceProduct..FullProductPricing) : <code>object</code>
|
|
2661
|
+
* [~ProductDimensionsUnit](#module_SquarespaceProduct..ProductDimensionsUnit) : <code>object</code>
|
|
2662
|
+
* [~ProductDimensions](#module_SquarespaceProduct..ProductDimensions) : <code>object</code>
|
|
2663
|
+
* [~ProductWeightUnitEnum](#module_SquarespaceProduct..ProductWeightUnitEnum) : <code>"KILOGRAM"</code> \| <code>"POUND"</code>
|
|
2664
|
+
* [~ProductWeight](#module_SquarespaceProduct..ProductWeight) : <code>object</code>
|
|
2665
|
+
* [~ProductMeasurements](#module_SquarespaceProduct..ProductMeasurements) : <code>object</code>
|
|
2666
|
+
* [~ProductStock](#module_SquarespaceProduct..ProductStock) : <code>object</code>
|
|
2667
|
+
* [~PhysicalProductVariant](#module_SquarespaceProduct..PhysicalProductVariant) : <code>object</code>
|
|
2668
|
+
* [~MetaData](#module_SquarespaceProduct..MetaData) : <code>object</code>
|
|
2669
|
+
* [~ProductTypeV2Enum](#module_SquarespaceProduct..ProductTypeV2Enum) : <code>"PHYSICAL"</code> \| <code>"SERVICE"</code> \| <code>"GIFT\_CARD"</code> \| <code>"DIGITAL"</code>
|
|
2670
|
+
* [~PhysicalProduct](#module_SquarespaceProduct..PhysicalProduct) : <code>object</code>
|
|
2671
|
+
|
|
2672
|
+
<a name="module_SquarespaceProduct..PhysicalProductDefault"></a>
|
|
2673
|
+
|
|
2674
|
+
### SquarespaceProduct~PhysicalProductDefault : <code>PhysicalProduct</code>
|
|
2675
|
+
**Kind**: inner constant of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2676
|
+
**Default**: <code>{"created":null,"id":null,"modified":null,"storePageId":"","type":"","description":null,"images":"","isVisible":true,"name":"","seoOptions":"","tags":"","url":"","urlSlug":"","variantAttributes":"","variants":""}</code>
|
|
2677
|
+
**Read only**: true
|
|
2678
|
+
<a name="module_SquarespaceProduct..PhysicalProductMap"></a>
|
|
2679
|
+
|
|
2680
|
+
### SquarespaceProduct~PhysicalProductMap : <code>PhysicalProduct</code>
|
|
2681
|
+
/**
|
|
2682
|
+
|
|
2683
|
+
**Kind**: inner constant of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2684
|
+
**Default**: <code>{}</code>
|
|
2685
|
+
**Read only**: true
|
|
2686
|
+
<a name="module_SquarespaceProduct..ProductDataForm"></a>
|
|
2687
|
+
|
|
2688
|
+
### SquarespaceProduct~ProductDataForm : <code>Product</code>
|
|
2689
|
+
**Kind**: inner constant of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2690
|
+
**Default**: <code>{"Id":"","refPath":null,"name":"","description":"","sku":"","markups":"","projectQ":""}</code>
|
|
2691
|
+
**Read only**: true
|
|
2692
|
+
<a name="module_SquarespaceProduct..ProductDefaultForm"></a>
|
|
2693
|
+
|
|
2694
|
+
### SquarespaceProduct~ProductDefaultForm : <code>Product</code>
|
|
2695
|
+
**Kind**: inner constant of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2696
|
+
**Default**: <code>{"Id":"","refPath":"","name":"text","description":"textarea","sku":"text","markups":"","projectQ":""}</code>
|
|
2697
|
+
**Read only**: true
|
|
2698
|
+
<a name="module_SquarespaceProduct..AttributeList"></a>
|
|
2699
|
+
|
|
2700
|
+
### SquarespaceProduct~AttributeList : <code>Array.String</code>
|
|
2701
|
+
A list of attributes for a product
|
|
2702
|
+
|
|
2703
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2704
|
+
<a name="module_SquarespaceProduct..AttributeValue"></a>
|
|
2705
|
+
|
|
2706
|
+
### SquarespaceProduct~AttributeValue : <code>object</code>
|
|
2707
|
+
Array of attribute name/value pairs
|
|
2708
|
+
|
|
2709
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2710
|
+
**Properties**
|
|
2711
|
+
|
|
2712
|
+
| Name | Type | Description |
|
|
2713
|
+
| --- | --- | --- |
|
|
2714
|
+
| AttibuteName | <code>string</code> | attribute name from attribute list |
|
|
2715
|
+
| value | <code>string</code> | value for the particular attribute |
|
|
2716
|
+
|
|
2717
|
+
<a name="module_SquarespaceProduct..ProductImage"></a>
|
|
2718
|
+
|
|
2719
|
+
### SquarespaceProduct~ProductImage : <code>object</code>
|
|
2720
|
+
Image Descriptor
|
|
2721
|
+
|
|
2722
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2723
|
+
**Properties**
|
|
2724
|
+
|
|
2725
|
+
| Name | Type | Description |
|
|
2726
|
+
| --- | --- | --- |
|
|
2727
|
+
| altText | <code>string</code> | alt text for the image - SEO etc |
|
|
2728
|
+
| availableFormats | <code>Array.string</code> | Available image sizes. |
|
|
2729
|
+
| id | <code>string</code> | unique id for this productImage |
|
|
2730
|
+
| orderIndex | <code>integer</code> | Position of the image in the product's image list. |
|
|
2731
|
+
| originalSize | <code>object</code> | Image size when first uploaded. |
|
|
2732
|
+
| URL | <code>string</code> | Absolute URL of the image hosted on Squarespace. |
|
|
2733
|
+
|
|
2734
|
+
<a name="module_SquarespaceProduct..CurrencyDescription"></a>
|
|
2735
|
+
|
|
2736
|
+
### SquarespaceProduct~CurrencyDescription : <code>object</code>
|
|
2737
|
+
Currency Description ISO 4217 currency code
|
|
2738
|
+
|
|
2739
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2740
|
+
**Properties**
|
|
2741
|
+
|
|
2742
|
+
| Name | Type |
|
|
2743
|
+
| --- | --- |
|
|
2744
|
+
| currencyCode | <code>string</code> |
|
|
2745
|
+
| defaultFractionDigits | <code>integer</code> |
|
|
2746
|
+
| displayName | <code>string</code> |
|
|
2747
|
+
| numericCodeAsString | <code>string</code> |
|
|
2748
|
+
| symbol | <code>string</code> |
|
|
2749
|
+
|
|
2750
|
+
<a name="module_SquarespaceProduct..MonetaryValue"></a>
|
|
2751
|
+
|
|
2752
|
+
### SquarespaceProduct~MonetaryValue : <code>object</code>
|
|
2753
|
+
Monetary Value Specification
|
|
2754
|
+
|
|
2755
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2756
|
+
**Properties**
|
|
2757
|
+
|
|
2758
|
+
| Name | Type | Description |
|
|
2759
|
+
| --- | --- | --- |
|
|
2760
|
+
| | <code>CurrencyDescription</code> | |
|
|
2761
|
+
| value | <code>decimal</code> | Decimal monetary value |
|
|
2762
|
+
|
|
2763
|
+
<a name="module_SquarespaceProduct..FullProductPricing"></a>
|
|
2764
|
+
|
|
2765
|
+
### SquarespaceProduct~FullProductPricing : <code>object</code>
|
|
2766
|
+
Pricing Object
|
|
2767
|
+
|
|
2768
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2769
|
+
**Properties**
|
|
2770
|
+
|
|
2771
|
+
| Name | Type |
|
|
2772
|
+
| --- | --- |
|
|
2773
|
+
| basePrice | <code>MonetaryValue</code> |
|
|
2774
|
+
| onSale | <code>boolean</code> |
|
|
2775
|
+
| salePrice | <code>MonetaryValue</code> |
|
|
2776
|
+
|
|
2777
|
+
<a name="module_SquarespaceProduct..ProductDimensionsUnit"></a>
|
|
2778
|
+
|
|
2779
|
+
### SquarespaceProduct~ProductDimensionsUnit : <code>object</code>
|
|
2780
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2781
|
+
**Properties**
|
|
2782
|
+
|
|
2783
|
+
| Name | Type |
|
|
2784
|
+
| --- | --- |
|
|
2785
|
+
| name | <code>Text</code> |
|
|
2786
|
+
| value | <code>Text</code> |
|
|
2787
|
+
|
|
2788
|
+
<a name="module_SquarespaceProduct..ProductDimensions"></a>
|
|
2789
|
+
|
|
2790
|
+
### SquarespaceProduct~ProductDimensions : <code>object</code>
|
|
2791
|
+
Dimensions Object
|
|
2792
|
+
|
|
2793
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2794
|
+
**Properties**
|
|
2795
|
+
|
|
2796
|
+
| Name | Type |
|
|
2797
|
+
| --- | --- |
|
|
2798
|
+
| height | <code>float</code> |
|
|
2799
|
+
| width | <code>float</code> |
|
|
2800
|
+
| length | <code>float</code> |
|
|
2801
|
+
| unit | <code>ProductDimensionsUnit</code> |
|
|
2802
|
+
|
|
2803
|
+
<a name="module_SquarespaceProduct..ProductWeightUnitEnum"></a>
|
|
2804
|
+
|
|
2805
|
+
### SquarespaceProduct~ProductWeightUnitEnum : <code>"KILOGRAM"</code> \| <code>"POUND"</code>
|
|
2806
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2807
|
+
<a name="module_SquarespaceProduct..ProductWeight"></a>
|
|
2808
|
+
|
|
2809
|
+
### SquarespaceProduct~ProductWeight : <code>object</code>
|
|
2810
|
+
Weight Object
|
|
2811
|
+
|
|
2812
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2813
|
+
**Properties**
|
|
2814
|
+
|
|
2815
|
+
| Name | Type |
|
|
2816
|
+
| --- | --- |
|
|
2817
|
+
| unit | <code>"KILOGRAM"</code> \| <code>"POUND"</code> |
|
|
2818
|
+
| value | <code>float</code> |
|
|
2819
|
+
|
|
2820
|
+
<a name="module_SquarespaceProduct..ProductMeasurements"></a>
|
|
2821
|
+
|
|
2822
|
+
### SquarespaceProduct~ProductMeasurements : <code>object</code>
|
|
2823
|
+
Measurements of the variant when it's shipped. Present for PHYSICAL products only.
|
|
2824
|
+
|
|
2825
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2826
|
+
**Properties**
|
|
2827
|
+
|
|
2828
|
+
| Name | Type |
|
|
2829
|
+
| --- | --- |
|
|
2830
|
+
| dimensions | <code>ProductDimensions</code> |
|
|
2831
|
+
| weight | <code>ProductWeight</code> |
|
|
2832
|
+
|
|
2833
|
+
<a name="module_SquarespaceProduct..ProductStock"></a>
|
|
2834
|
+
|
|
2835
|
+
### SquarespaceProduct~ProductStock : <code>object</code>
|
|
2836
|
+
Available stock for the variant. Present for PHYSICAL products only.
|
|
2837
|
+
|
|
2838
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2839
|
+
**Properties**
|
|
2840
|
+
|
|
2841
|
+
| Name | Type |
|
|
2842
|
+
| --- | --- |
|
|
2843
|
+
| quantity | <code>integer</code> |
|
|
2844
|
+
| unlimited | <code>boolean</code> |
|
|
2845
|
+
|
|
2846
|
+
<a name="module_SquarespaceProduct..PhysicalProductVariant"></a>
|
|
2847
|
+
|
|
2848
|
+
### SquarespaceProduct~PhysicalProductVariant : <code>object</code>
|
|
2849
|
+
variant record (including inventory and pricing)
|
|
2850
|
+
|
|
2851
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2852
|
+
**Properties**
|
|
2853
|
+
|
|
2854
|
+
| Name | Type | Description |
|
|
2855
|
+
| --- | --- | --- |
|
|
2856
|
+
| attributes | <code>Array.AttributeValue</code> | array of attribute/value pairs for a variant |
|
|
2857
|
+
| gtin | <code>string</code> | Global Trade Item Number |
|
|
2858
|
+
| id | <code>string</code> | unique ID for product variant |
|
|
2859
|
+
| image | <code>ProductImage</code> | Image associated with this variant |
|
|
2860
|
+
| mpn | <code>string</code> | manufacturer part number |
|
|
2861
|
+
| shippingMeasurements | <code>ProductMeasurements</code> | |
|
|
2862
|
+
| sku | <code>string</code> | |
|
|
2863
|
+
| stock | <code>ProductStock</code> | |
|
|
2864
|
+
|
|
2865
|
+
<a name="module_SquarespaceProduct..MetaData"></a>
|
|
2866
|
+
|
|
2867
|
+
### SquarespaceProduct~MetaData : <code>object</code>
|
|
2868
|
+
Meta Information for SEO
|
|
2869
|
+
|
|
2870
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2871
|
+
**Properties**
|
|
2872
|
+
|
|
2873
|
+
| Name | Type |
|
|
2874
|
+
| --- | --- |
|
|
2875
|
+
| title | <code>string</code> |
|
|
2876
|
+
| description | <code>string</code> |
|
|
2877
|
+
|
|
2878
|
+
<a name="module_SquarespaceProduct..ProductTypeV2Enum"></a>
|
|
2879
|
+
|
|
2880
|
+
### SquarespaceProduct~ProductTypeV2Enum : <code>"PHYSICAL"</code> \| <code>"SERVICE"</code> \| <code>"GIFT\_CARD"</code> \| <code>"DIGITAL"</code>
|
|
2881
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2882
|
+
<a name="module_SquarespaceProduct..PhysicalProduct"></a>
|
|
2883
|
+
|
|
2884
|
+
### SquarespaceProduct~PhysicalProduct : <code>object</code>
|
|
2885
|
+
a Square product record
|
|
2886
|
+
|
|
2887
|
+
**Kind**: inner typedef of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)
|
|
2888
|
+
**Properties**
|
|
2889
|
+
|
|
2890
|
+
| Name | Type | Description |
|
|
2891
|
+
| --- | --- | --- |
|
|
2892
|
+
| createdOn | <code>dateTime</code> | |
|
|
2893
|
+
| id | <code>string</code> | Id of document (redundant for convenience) |
|
|
2894
|
+
| modifiedOn | <code>dateTime</code> | |
|
|
2895
|
+
| storePageId | <code>string</code> | |
|
|
2896
|
+
| type | <code>"PHYSICAL"</code> \| <code>"SERVICE"</code> \| <code>"GIFT\_CARD"</code> \| <code>"DIGITAL"</code> | |
|
|
2897
|
+
| description | <code>string</code> | Basic description of the product |
|
|
2898
|
+
| images | <code>Array.ProductImage</code> | Image associated with this variant |
|
|
2899
|
+
| isVisible | <code>boolean</code> | |
|
|
2900
|
+
| name | <code>string</code> | name for the Product |
|
|
2901
|
+
| seoOptions | <code>MetaData</code> | |
|
|
2902
|
+
| tags | <code>Array.string</code> | |
|
|
2903
|
+
| URL | <code>string</code> | |
|
|
2904
|
+
| urlSlug | <code>string</code> | |
|
|
2905
|
+
| variantAttributes | <code>Array.string</code> | |
|
|
2906
|
+
| variants | <code>Array.PhysicalProductVariant</code> | |
|
|
2907
|
+
|
|
1833
2908
|
<a name="module_Product"></a>
|
|
1834
2909
|
|
|
1835
2910
|
## Product
|
|
@@ -1850,6 +2925,7 @@ Typedefs, constants, support functions and database operations related to Produc
|
|
|
1850
2925
|
* [~AttributeList](#module_Product..AttributeList) : <code>Array.String</code>
|
|
1851
2926
|
* [~AttributeValue](#module_Product..AttributeValue) : <code>object</code>
|
|
1852
2927
|
* [~ProductImage](#module_Product..ProductImage) : <code>object</code>
|
|
2928
|
+
* [~BrandObject](#module_Product..BrandObject) : <code>object</code>
|
|
1853
2929
|
* [~CurrencyDescription](#module_Product..CurrencyDescription) : <code>object</code>
|
|
1854
2930
|
* [~MonetaryValue](#module_Product..MonetaryValue) : <code>object</code>
|
|
1855
2931
|
* [~FullProductPricing](#module_Product..FullProductPricing) : <code>object</code>
|
|
@@ -1857,9 +2933,16 @@ Typedefs, constants, support functions and database operations related to Produc
|
|
|
1857
2933
|
* [~PriceObject](#module_Product..PriceObject) : <code>object</code>
|
|
1858
2934
|
* [~ProductWeight](#module_Product..ProductWeight) : <code>object</code>
|
|
1859
2935
|
* [~ProductMeasurements](#module_Product..ProductMeasurements) : <code>object</code>
|
|
2936
|
+
* [~SizeSpecification](#module_Product..SizeSpecification) : <code>object</code>
|
|
1860
2937
|
* [~ProductStock](#module_Product..ProductStock) : <code>object</code>
|
|
1861
|
-
* [~PhysicalProductVariant](#module_Product..PhysicalProductVariant) : <code>object</code>
|
|
1862
2938
|
* [~MetaData](#module_Product..MetaData) : <code>object</code>
|
|
2939
|
+
* [~GenderEnum](#module_Product..GenderEnum) : <code>"newborn"</code> \| <code>"infant"</code> \| <code>"toddler"</code> \| <code>"kids"</code> \| <code>"adult"</code>
|
|
2940
|
+
* [~Demographics](#module_Product..Demographics) : <code>object</code>
|
|
2941
|
+
* [~PlatformIDs](#module_Product..PlatformIDs) : <code>object</code>
|
|
2942
|
+
* [~SquarespaceDataObject](#module_Product..SquarespaceDataObject) : <code>object</code>
|
|
2943
|
+
* [~PlatformData](#module_Product..PlatformData) : <code>object</code>
|
|
2944
|
+
* [~AttributeValueObject](#module_Product..AttributeValueObject) : <code>object</code>
|
|
2945
|
+
* [~PhysicalProductVariant](#module_Product..PhysicalProductVariant) : <code>object</code>
|
|
1863
2946
|
* [~Product](#module_Product..Product) : <code>object</code>
|
|
1864
2947
|
|
|
1865
2948
|
<a name="module_Product.createProduct"></a>
|
|
@@ -1886,7 +2969,7 @@ Creates a new Blank Product
|
|
|
1886
2969
|
|
|
1887
2970
|
### Product~ProductDefault : <code>Product</code>
|
|
1888
2971
|
**Kind**: inner constant of [<code>Product</code>](#module_Product)
|
|
1889
|
-
**Default**: <code>{"name":"","description":null,"recipe":"","image_links":"","type":"","google_product_type":"","shipping_time":0,"condition":"","adultQ":false,"age_group":"adult","color":"","material":"","gender":"unisex","attributes_gemstones":"","pattern":"","size":"","weight":0,"shippingMeasurements":""}</code>
|
|
2972
|
+
**Default**: <code>{"name":"","description":null,"recipe":"","image_links":"","type":"PHYSICAL","isVisible":true,"seoOptions":"","tags":"","materials":"","patterns":"","URL":"","urlSlug":"","variantAttributes":"","variants":"","google_product_type":"","shipping_time":0,"condition":"","adultQ":false,"age_group":"adult","color":"","material":"","gender":"unisex","attributes_gemstones":"","pattern":"","size":"","weight":0,"shippingMeasurements":""}</code>
|
|
1890
2973
|
**Read only**: true
|
|
1891
2974
|
<a name="module_Product..ProductDataForm"></a>
|
|
1892
2975
|
|
|
@@ -1977,6 +3060,22 @@ Image Descriptor
|
|
|
1977
3060
|
| seoOptions | <code>MetaData</code> | |
|
|
1978
3061
|
| URL | <code>string</code> | Absolute URL of the hosted image. |
|
|
1979
3062
|
|
|
3063
|
+
<a name="module_Product..BrandObject"></a>
|
|
3064
|
+
|
|
3065
|
+
### Product~BrandObject : <code>object</code>
|
|
3066
|
+
a Brand Object
|
|
3067
|
+
|
|
3068
|
+
**Kind**: inner typedef of [<code>Product</code>](#module_Product)
|
|
3069
|
+
**Properties**
|
|
3070
|
+
|
|
3071
|
+
| Name | Type | Description |
|
|
3072
|
+
| --- | --- | --- |
|
|
3073
|
+
| aggregateRating | <code>AggregateRatingsValue</code> | |
|
|
3074
|
+
| logo | <code>URL</code> \| <code>ImageObject</code> | |
|
|
3075
|
+
| review | <code>ReviewObject</code> | A review of the item. Supersedes reviews |
|
|
3076
|
+
| slogan | <code>text</code> | A slogan or motto associated with the item. |
|
|
3077
|
+
| name | <code>Name</code> | The name of the brand. |
|
|
3078
|
+
|
|
1980
3079
|
<a name="module_Product..CurrencyDescription"></a>
|
|
1981
3080
|
|
|
1982
3081
|
### Product~CurrencyDescription : <code>object</code>
|
|
@@ -2003,8 +3102,9 @@ Monetary Value Specification
|
|
|
2003
3102
|
|
|
2004
3103
|
| Name | Type | Description |
|
|
2005
3104
|
| --- | --- | --- |
|
|
2006
|
-
|
|
|
3105
|
+
| currencyDescription | <code>CurrencyDescription</code> | |
|
|
2007
3106
|
| value | <code>decimal</code> | Decimal monetary value |
|
|
3107
|
+
| effectiveDate | <code>Date</code> | |
|
|
2008
3108
|
|
|
2009
3109
|
<a name="module_Product..FullProductPricing"></a>
|
|
2010
3110
|
|
|
@@ -2067,6 +3167,22 @@ Measurements of the variant when it's shipped. Present for PHYSICAL products onl
|
|
|
2067
3167
|
| dimensions | <code>ProductDimensions</code> |
|
|
2068
3168
|
| weight | <code>ProductWeight</code> |
|
|
2069
3169
|
|
|
3170
|
+
<a name="module_Product..SizeSpecification"></a>
|
|
3171
|
+
|
|
3172
|
+
### Product~SizeSpecification : <code>object</code>
|
|
3173
|
+
**Kind**: inner typedef of [<code>Product</code>](#module_Product)
|
|
3174
|
+
**Properties**
|
|
3175
|
+
|
|
3176
|
+
| Name | Type | Description |
|
|
3177
|
+
| --- | --- | --- |
|
|
3178
|
+
| type | <code>Text</code> | "SizeSpecification" |
|
|
3179
|
+
| hasMeasurement | <code>QuantitativeValue</code> | |
|
|
3180
|
+
| sizeGroup | <code>Array.SizeGroupEnumeration</code> \| <code>SizeGroupEnumeration</code> \| <code>Text</code> | The size group (also known as "size type") for a product's size. Size groups are common in the fashion industry to define size segments and suggested audiences for wearable products. Multiple values can be combined, for example "men's big and tall", "petite maternity" or "regular". |
|
|
3181
|
+
| sizeSystem | <code>Array.SizeSystemEnumeration</code> \| <code>SizeSystemEnumeration</code> \| <code>Text</code> | The size system used to identify a product's size. Typically either a standard (for example, "GS1" or "ISO-EN13402"), country code (for example "US" or "JP"), or a measuring system (for example "Metric" or "Imperial"). |
|
|
3182
|
+
| suggestedAge | <code>QuantitativeValue</code> | The age or age range for the intended audience or user, for example 3-12 months for infants, 1-5 years for toddlers. |
|
|
3183
|
+
| suggestedGender | <code>GenderType</code> \| <code>Text</code> | The suggested gender of the intended user or audience, for example "male", "female", or "unisex". |
|
|
3184
|
+
| suggestedMeasurement | <code>QuantitativeValue</code> | A suggested range of body measurements for the intended audience or user, for example inseam between 32 and 34 inches or height between 170 and 190 cm. Typically found on a size chart for wearable products. |
|
|
3185
|
+
|
|
2070
3186
|
<a name="module_Product..ProductStock"></a>
|
|
2071
3187
|
|
|
2072
3188
|
### Product~ProductStock : <code>object</code>
|
|
@@ -2080,37 +3196,112 @@ Available stock for the variant. Present for PHYSICAL products only.
|
|
|
2080
3196
|
| quantity | <code>integer</code> |
|
|
2081
3197
|
| unlimited | <code>boolean</code> |
|
|
2082
3198
|
|
|
2083
|
-
<a name="module_Product..
|
|
3199
|
+
<a name="module_Product..MetaData"></a>
|
|
2084
3200
|
|
|
2085
|
-
### Product~
|
|
2086
|
-
|
|
3201
|
+
### Product~MetaData : <code>object</code>
|
|
3202
|
+
Meta Information for SEO
|
|
2087
3203
|
|
|
2088
3204
|
**Kind**: inner typedef of [<code>Product</code>](#module_Product)
|
|
2089
3205
|
**Properties**
|
|
2090
3206
|
|
|
2091
|
-
| Name | Type |
|
|
2092
|
-
| --- | --- |
|
|
2093
|
-
|
|
|
2094
|
-
|
|
|
2095
|
-
| mpn | <code>string</code> | manufacturer part number |
|
|
2096
|
-
| gtin | <code>string</code> | Global Trade Item Number |
|
|
2097
|
-
| id | <code>string</code> | unique ID for product variant |
|
|
2098
|
-
| image | <code>ProductImage</code> | Image associated with this variant |
|
|
2099
|
-
| shippingMeasurements | <code>ProductMeasurements</code> | |
|
|
2100
|
-
| stock | <code>ProductStock</code> | |
|
|
3207
|
+
| Name | Type |
|
|
3208
|
+
| --- | --- |
|
|
3209
|
+
| title | <code>string</code> |
|
|
3210
|
+
| description | <code>string</code> |
|
|
2101
3211
|
|
|
2102
|
-
<a name="module_Product..
|
|
3212
|
+
<a name="module_Product..GenderEnum"></a>
|
|
2103
3213
|
|
|
2104
|
-
### Product~
|
|
2105
|
-
|
|
3214
|
+
### Product~GenderEnum : <code>"newborn"</code> \| <code>"infant"</code> \| <code>"toddler"</code> \| <code>"kids"</code> \| <code>"adult"</code>
|
|
3215
|
+
**Kind**: inner typedef of [<code>Product</code>](#module_Product)
|
|
3216
|
+
<a name="module_Product..Demographics"></a>
|
|
3217
|
+
|
|
3218
|
+
### Product~Demographics : <code>object</code>
|
|
3219
|
+
Demographics characteristics
|
|
2106
3220
|
|
|
2107
3221
|
**Kind**: inner typedef of [<code>Product</code>](#module_Product)
|
|
2108
3222
|
**Properties**
|
|
2109
3223
|
|
|
2110
3224
|
| Name | Type |
|
|
2111
3225
|
| --- | --- |
|
|
2112
|
-
|
|
|
2113
|
-
|
|
|
3226
|
+
| adult | <code>boolean</code> |
|
|
3227
|
+
| age_group | <code>AgeGroupEnum</code> |
|
|
3228
|
+
| gender | <code>GenderEnum</code> |
|
|
3229
|
+
|
|
3230
|
+
<a name="module_Product..PlatformIDs"></a>
|
|
3231
|
+
|
|
3232
|
+
### Product~PlatformIDs : <code>object</code>
|
|
3233
|
+
List of product ID's for various platforms
|
|
3234
|
+
|
|
3235
|
+
**Kind**: inner typedef of [<code>Product</code>](#module_Product)
|
|
3236
|
+
**Properties**
|
|
3237
|
+
|
|
3238
|
+
| Name | Type |
|
|
3239
|
+
| --- | --- |
|
|
3240
|
+
| SquarespaceId | <code>Text</code> |
|
|
3241
|
+
| GoogleMerchantId | <code>Text</code> |
|
|
3242
|
+
| ShopifyId | <code>Text</code> |
|
|
3243
|
+
|
|
3244
|
+
<a name="module_Product..SquarespaceDataObject"></a>
|
|
3245
|
+
|
|
3246
|
+
### Product~SquarespaceDataObject : <code>object</code>
|
|
3247
|
+
Squarespace Specific Data
|
|
3248
|
+
|
|
3249
|
+
**Kind**: inner typedef of [<code>Product</code>](#module_Product)
|
|
3250
|
+
**Properties**
|
|
3251
|
+
|
|
3252
|
+
| Name | Type |
|
|
3253
|
+
| --- | --- |
|
|
3254
|
+
| storePageId | <code>Text</code> |
|
|
3255
|
+
|
|
3256
|
+
<a name="module_Product..PlatformData"></a>
|
|
3257
|
+
|
|
3258
|
+
### Product~PlatformData : <code>object</code>
|
|
3259
|
+
List of Platform Specific Data
|
|
3260
|
+
|
|
3261
|
+
**Kind**: inner typedef of [<code>Product</code>](#module_Product)
|
|
3262
|
+
**Properties**
|
|
3263
|
+
|
|
3264
|
+
| Name | Type |
|
|
3265
|
+
| --- | --- |
|
|
3266
|
+
| squarespaceData | <code>SquarespaceDataObject</code> |
|
|
3267
|
+
|
|
3268
|
+
<a name="module_Product..AttributeValueObject"></a>
|
|
3269
|
+
|
|
3270
|
+
### Product~AttributeValueObject : <code>object</code>
|
|
3271
|
+
**Kind**: inner typedef of [<code>Product</code>](#module_Product)
|
|
3272
|
+
**Properties**
|
|
3273
|
+
|
|
3274
|
+
| Name | Type |
|
|
3275
|
+
| --- | --- |
|
|
3276
|
+
| condition | <code>Text</code> |
|
|
3277
|
+
| tags | <code>Array.Text</code> |
|
|
3278
|
+
| colors | <code>Array.Text</code> |
|
|
3279
|
+
| materials | <code>Array.Text</code> |
|
|
3280
|
+
| patterns | <code>Array.Text</code> |
|
|
3281
|
+
| createdOn | <code>Date</code> |
|
|
3282
|
+
| modifiedOn | <code>Date</code> |
|
|
3283
|
+
|
|
3284
|
+
<a name="module_Product..PhysicalProductVariant"></a>
|
|
3285
|
+
|
|
3286
|
+
### Product~PhysicalProductVariant : <code>object</code>
|
|
3287
|
+
variant record (including inventory and pricing)
|
|
3288
|
+
|
|
3289
|
+
**Kind**: inner typedef of [<code>Product</code>](#module_Product)
|
|
3290
|
+
**Properties**
|
|
3291
|
+
|
|
3292
|
+
| Name | Type | Description |
|
|
3293
|
+
| --- | --- | --- |
|
|
3294
|
+
| id | <code>string</code> | unique ID for product variant |
|
|
3295
|
+
| sku | <code>string</code> | |
|
|
3296
|
+
| image | <code>ProductImage</code> | Image associated with this variant |
|
|
3297
|
+
| pricing | <code>FullProductPricing</code> | |
|
|
3298
|
+
| stock | <code>ProductStock</code> | |
|
|
3299
|
+
| attributes | <code>Array.AttributeValue</code> | array of attribute/value pairs for a variant |
|
|
3300
|
+
| shippingMeasurements | <code>ProductMeasurements</code> | |
|
|
3301
|
+
| gtin | <code>string</code> | Global Trade Item Number |
|
|
3302
|
+
| mpn | <code>string</code> | manufacturer part number |
|
|
3303
|
+
| productMeasurements | <code>ProductMeasurements</code> | |
|
|
3304
|
+
| availabilityDate | <code>date</code> | |
|
|
2114
3305
|
|
|
2115
3306
|
<a name="module_Product..Product"></a>
|
|
2116
3307
|
|
|
@@ -2124,18 +3315,24 @@ a product record
|
|
|
2124
3315
|
| --- | --- | --- |
|
|
2125
3316
|
| Id | <code>string</code> | Database Id of document (redundant for convenience) |
|
|
2126
3317
|
| refPath | <code>string</code> | if from database, full path to document |
|
|
3318
|
+
| platformIds | <code>PlatformIDs</code> | |
|
|
3319
|
+
| platformData | <code>platformData</code> | |
|
|
3320
|
+
| squarespaceData | <code>SquarespaceDataObject</code> | |
|
|
3321
|
+
| storePageId | <code>Text</code> | |
|
|
2127
3322
|
| name | <code>string</code> | name for the Product |
|
|
2128
3323
|
| description | <code>string</code> | Basic description of the product |
|
|
3324
|
+
| google_product_category | <code>string</code> | |
|
|
3325
|
+
| product_type | <code>string</code> | "casual google_product_category" |
|
|
3326
|
+
| brand | <code>Text</code> \| <code>BrandObject</code> | The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business user. |
|
|
3327
|
+
| demographics | <code>Demographics</code> | |
|
|
3328
|
+
| attributes | <code>AttributeValueObject</code> | array of attribute/value pairs for a product |
|
|
2129
3329
|
| recipe | <code>Recipe\_Data</code> | pricing and fabrication data |
|
|
2130
|
-
|
|
|
2131
|
-
|
|
|
3330
|
+
| images | <code>Array:ProductImage</code> | |
|
|
3331
|
+
| video_image | <code>VideoImage</code> | |
|
|
3332
|
+
| virtual_model | <code>VirtualModel</code> | |
|
|
3333
|
+
| mobileInfo | <code>MobileInfo</code> | |
|
|
2132
3334
|
| isVisible | <code>boolean</code> | |
|
|
2133
3335
|
| seoOptions | <code>MetaData</code> | |
|
|
2134
|
-
| name | <code>string</code> | name for the Product |
|
|
2135
|
-
| seoOptions | <code>MetaData</code> | |
|
|
2136
|
-
| tags | <code>Array.string</code> | |
|
|
2137
|
-
| materials | <code>Array.string</code> | |
|
|
2138
|
-
| patterns | <code>Array.string</code> | |
|
|
2139
3336
|
| URL | <code>string</code> | |
|
|
2140
3337
|
| urlSlug | <code>string</code> | |
|
|
2141
3338
|
| variantAttributes | <code>Array.string</code> | |
|
|
@@ -2488,7 +3685,6 @@ and conversions
|
|
|
2488
3685
|
* [.formatItem(thisItem, thisFormat)](#module_Utilities.formatItem) ⇒ <code>string</code>
|
|
2489
3686
|
* [.compare(thisItem, anotherItem, sort)](#module_Utilities.compare) ⇒ <code>string</code>
|
|
2490
3687
|
* [.anyInAny(findFrom, findIn)](#module_Utilities.anyInAny) ⇒ <code>boolean</code>
|
|
2491
|
-
* [.PromisePoolRunner(entryArray, actionFunction, promiseOptions)](#module_Utilities.PromisePoolRunner) ⇒ <code>Promise</code>
|
|
2492
3688
|
* [.lesserOf(args)](#module_Utilities.lesserOf) ⇒ <code>number</code>
|
|
2493
3689
|
* [.largerOf(args)](#module_Utilities.largerOf) ⇒ <code>number</code>
|
|
2494
3690
|
* [.archiveRecord(record)](#module_Utilities.archiveRecord) ⇒ <code>Promise</code>
|
|
@@ -2498,14 +3694,10 @@ and conversions
|
|
|
2498
3694
|
* [.addToArrayObject(arrayObject, key, object)](#module_Utilities.addToArrayObject)
|
|
2499
3695
|
* [.makeHexAsNeeded(color)](#module_Utilities.makeHexAsNeeded) ⇒ <code>string</code>
|
|
2500
3696
|
* _inner_
|
|
2501
|
-
* [~PromisePool](#module_Utilities..PromisePool)
|
|
2502
|
-
* [~promiseOptionsDefault](#module_Utilities..promiseOptionsDefault) : <code>PromiseOptions</code>
|
|
2503
3697
|
* [~stripDocIdFromRefPath(refPath)](#module_Utilities..stripDocIdFromRefPath) ⇒ <code>string</code>
|
|
2504
3698
|
* [~UpdateChange
|
|
2505
3699
|
Function Signature for UpdateChange functions(prev, value, itemFor, fullChoiceObject)](#module_Utilities..UpdateChange
|
|
2506
3700
|
Function Signature for UpdateChange functions) ⇒ <code>object</code>
|
|
2507
|
-
* [~generateIterator(entryArray, actionFunction)](#module_Utilities..generateIterator)
|
|
2508
|
-
* [~PromiseOptions](#module_Utilities..PromiseOptions) : <code>object</code>
|
|
2509
3701
|
|
|
2510
3702
|
<a name="module_Utilities.recordByIdAndType"></a>
|
|
2511
3703
|
|
|
@@ -2817,17 +4009,6 @@ An array based compare function - is any entry of findFrom present in findIn
|
|
|
2817
4009
|
| findFrom | <code>Array.any</code> |
|
|
2818
4010
|
| findIn | <code>Array.any</code> |
|
|
2819
4011
|
|
|
2820
|
-
<a name="module_Utilities.PromisePoolRunner"></a>
|
|
2821
|
-
|
|
2822
|
-
### Utilities.PromisePoolRunner(entryArray, actionFunction, promiseOptions) ⇒ <code>Promise</code>
|
|
2823
|
-
**Kind**: static method of [<code>Utilities</code>](#module_Utilities)
|
|
2824
|
-
|
|
2825
|
-
| Param | Type |
|
|
2826
|
-
| --- | --- |
|
|
2827
|
-
| entryArray | <code>Array.object</code> |
|
|
2828
|
-
| actionFunction | <code>callback</code> |
|
|
2829
|
-
| promiseOptions | <code>PromiseOptions</code> |
|
|
2830
|
-
|
|
2831
4012
|
<a name="module_Utilities.lesserOf"></a>
|
|
2832
4013
|
|
|
2833
4014
|
### Utilities.lesserOf(args) ⇒ <code>number</code>
|
|
@@ -2922,16 +4103,6 @@ function to push an element to an array which may not be initialized
|
|
|
2922
4103
|
| --- | --- | --- |
|
|
2923
4104
|
| color | <code>string</code> | name of color |
|
|
2924
4105
|
|
|
2925
|
-
<a name="module_Utilities..PromisePool"></a>
|
|
2926
|
-
|
|
2927
|
-
### Utilities~PromisePool
|
|
2928
|
-
**Kind**: inner constant of [<code>Utilities</code>](#module_Utilities)
|
|
2929
|
-
<a name="module_Utilities..promiseOptionsDefault"></a>
|
|
2930
|
-
|
|
2931
|
-
### Utilities~promiseOptionsDefault : <code>PromiseOptions</code>
|
|
2932
|
-
**Kind**: inner constant of [<code>Utilities</code>](#module_Utilities)
|
|
2933
|
-
**Default**: <code>{"concurrency":3,"rate":10}</code>
|
|
2934
|
-
**Read only**: true
|
|
2935
4106
|
<a name="module_Utilities..stripDocIdFromRefPath"></a>
|
|
2936
4107
|
|
|
2937
4108
|
### Utilities~stripDocIdFromRefPath(refPath) ⇒ <code>string</code>
|
|
@@ -2958,32 +4129,6 @@ Function Signature for UpdateChange functions(prev, value, itemFor, fullChoiceOb
|
|
|
2958
4129
|
| itemFor | <code>string</code> |
|
|
2959
4130
|
| fullChoiceObject | <code>object</code> |
|
|
2960
4131
|
|
|
2961
|
-
<a name="module_Utilities..generateIterator"></a>
|
|
2962
|
-
|
|
2963
|
-
### Utilities~generateIterator(entryArray, actionFunction)
|
|
2964
|
-
An Action Iterator Generator. Cycles through the entries in the passed array,
|
|
2965
|
-
yielding the result of a function for each entry.
|
|
2966
|
-
Only cares that inputs are an array, and a function that returns a
|
|
2967
|
-
promise
|
|
2968
|
-
|
|
2969
|
-
**Kind**: inner method of [<code>Utilities</code>](#module_Utilities)
|
|
2970
|
-
|
|
2971
|
-
| Param | Type |
|
|
2972
|
-
| --- | --- |
|
|
2973
|
-
| entryArray | <code>Array.any</code> |
|
|
2974
|
-
| actionFunction | <code>callback</code> |
|
|
2975
|
-
|
|
2976
|
-
<a name="module_Utilities..PromiseOptions"></a>
|
|
2977
|
-
|
|
2978
|
-
### Utilities~PromiseOptions : <code>object</code>
|
|
2979
|
-
**Kind**: inner typedef of [<code>Utilities</code>](#module_Utilities)
|
|
2980
|
-
**Properties**
|
|
2981
|
-
|
|
2982
|
-
| Name | Type |
|
|
2983
|
-
| --- | --- |
|
|
2984
|
-
| concurrency | <code>number</code> |
|
|
2985
|
-
| rate | <code>number</code> |
|
|
2986
|
-
|
|
2987
4132
|
<a name="module_Utilities"></a>
|
|
2988
4133
|
|
|
2989
4134
|
## Utilities
|
|
@@ -3016,7 +4161,6 @@ general Utilities
|
|
|
3016
4161
|
* [.formatItem(thisItem, thisFormat)](#module_Utilities.formatItem) ⇒ <code>string</code>
|
|
3017
4162
|
* [.compare(thisItem, anotherItem, sort)](#module_Utilities.compare) ⇒ <code>string</code>
|
|
3018
4163
|
* [.anyInAny(findFrom, findIn)](#module_Utilities.anyInAny) ⇒ <code>boolean</code>
|
|
3019
|
-
* [.PromisePoolRunner(entryArray, actionFunction, promiseOptions)](#module_Utilities.PromisePoolRunner) ⇒ <code>Promise</code>
|
|
3020
4164
|
* [.lesserOf(args)](#module_Utilities.lesserOf) ⇒ <code>number</code>
|
|
3021
4165
|
* [.largerOf(args)](#module_Utilities.largerOf) ⇒ <code>number</code>
|
|
3022
4166
|
* [.archiveRecord(record)](#module_Utilities.archiveRecord) ⇒ <code>Promise</code>
|
|
@@ -3026,14 +4170,10 @@ general Utilities
|
|
|
3026
4170
|
* [.addToArrayObject(arrayObject, key, object)](#module_Utilities.addToArrayObject)
|
|
3027
4171
|
* [.makeHexAsNeeded(color)](#module_Utilities.makeHexAsNeeded) ⇒ <code>string</code>
|
|
3028
4172
|
* _inner_
|
|
3029
|
-
* [~PromisePool](#module_Utilities..PromisePool)
|
|
3030
|
-
* [~promiseOptionsDefault](#module_Utilities..promiseOptionsDefault) : <code>PromiseOptions</code>
|
|
3031
4173
|
* [~stripDocIdFromRefPath(refPath)](#module_Utilities..stripDocIdFromRefPath) ⇒ <code>string</code>
|
|
3032
4174
|
* [~UpdateChange
|
|
3033
4175
|
Function Signature for UpdateChange functions(prev, value, itemFor, fullChoiceObject)](#module_Utilities..UpdateChange
|
|
3034
4176
|
Function Signature for UpdateChange functions) ⇒ <code>object</code>
|
|
3035
|
-
* [~generateIterator(entryArray, actionFunction)](#module_Utilities..generateIterator)
|
|
3036
|
-
* [~PromiseOptions](#module_Utilities..PromiseOptions) : <code>object</code>
|
|
3037
4177
|
|
|
3038
4178
|
<a name="module_Utilities.recordByIdAndType"></a>
|
|
3039
4179
|
|
|
@@ -3345,17 +4485,6 @@ An array based compare function - is any entry of findFrom present in findIn
|
|
|
3345
4485
|
| findFrom | <code>Array.any</code> |
|
|
3346
4486
|
| findIn | <code>Array.any</code> |
|
|
3347
4487
|
|
|
3348
|
-
<a name="module_Utilities.PromisePoolRunner"></a>
|
|
3349
|
-
|
|
3350
|
-
### Utilities.PromisePoolRunner(entryArray, actionFunction, promiseOptions) ⇒ <code>Promise</code>
|
|
3351
|
-
**Kind**: static method of [<code>Utilities</code>](#module_Utilities)
|
|
3352
|
-
|
|
3353
|
-
| Param | Type |
|
|
3354
|
-
| --- | --- |
|
|
3355
|
-
| entryArray | <code>Array.object</code> |
|
|
3356
|
-
| actionFunction | <code>callback</code> |
|
|
3357
|
-
| promiseOptions | <code>PromiseOptions</code> |
|
|
3358
|
-
|
|
3359
4488
|
<a name="module_Utilities.lesserOf"></a>
|
|
3360
4489
|
|
|
3361
4490
|
### Utilities.lesserOf(args) ⇒ <code>number</code>
|
|
@@ -3450,16 +4579,6 @@ function to push an element to an array which may not be initialized
|
|
|
3450
4579
|
| --- | --- | --- |
|
|
3451
4580
|
| color | <code>string</code> | name of color |
|
|
3452
4581
|
|
|
3453
|
-
<a name="module_Utilities..PromisePool"></a>
|
|
3454
|
-
|
|
3455
|
-
### Utilities~PromisePool
|
|
3456
|
-
**Kind**: inner constant of [<code>Utilities</code>](#module_Utilities)
|
|
3457
|
-
<a name="module_Utilities..promiseOptionsDefault"></a>
|
|
3458
|
-
|
|
3459
|
-
### Utilities~promiseOptionsDefault : <code>PromiseOptions</code>
|
|
3460
|
-
**Kind**: inner constant of [<code>Utilities</code>](#module_Utilities)
|
|
3461
|
-
**Default**: <code>{"concurrency":3,"rate":10}</code>
|
|
3462
|
-
**Read only**: true
|
|
3463
4582
|
<a name="module_Utilities..stripDocIdFromRefPath"></a>
|
|
3464
4583
|
|
|
3465
4584
|
### Utilities~stripDocIdFromRefPath(refPath) ⇒ <code>string</code>
|
|
@@ -3486,32 +4605,6 @@ Function Signature for UpdateChange functions(prev, value, itemFor, fullChoiceOb
|
|
|
3486
4605
|
| itemFor | <code>string</code> |
|
|
3487
4606
|
| fullChoiceObject | <code>object</code> |
|
|
3488
4607
|
|
|
3489
|
-
<a name="module_Utilities..generateIterator"></a>
|
|
3490
|
-
|
|
3491
|
-
### Utilities~generateIterator(entryArray, actionFunction)
|
|
3492
|
-
An Action Iterator Generator. Cycles through the entries in the passed array,
|
|
3493
|
-
yielding the result of a function for each entry.
|
|
3494
|
-
Only cares that inputs are an array, and a function that returns a
|
|
3495
|
-
promise
|
|
3496
|
-
|
|
3497
|
-
**Kind**: inner method of [<code>Utilities</code>](#module_Utilities)
|
|
3498
|
-
|
|
3499
|
-
| Param | Type |
|
|
3500
|
-
| --- | --- |
|
|
3501
|
-
| entryArray | <code>Array.any</code> |
|
|
3502
|
-
| actionFunction | <code>callback</code> |
|
|
3503
|
-
|
|
3504
|
-
<a name="module_Utilities..PromiseOptions"></a>
|
|
3505
|
-
|
|
3506
|
-
### Utilities~PromiseOptions : <code>object</code>
|
|
3507
|
-
**Kind**: inner typedef of [<code>Utilities</code>](#module_Utilities)
|
|
3508
|
-
**Properties**
|
|
3509
|
-
|
|
3510
|
-
| Name | Type |
|
|
3511
|
-
| --- | --- |
|
|
3512
|
-
| concurrency | <code>number</code> |
|
|
3513
|
-
| rate | <code>number</code> |
|
|
3514
|
-
|
|
3515
4608
|
<a name="module_Boilerplate"></a>
|
|
3516
4609
|
|
|
3517
4610
|
## Boilerplate
|