API Docs for: 1.3.12
Show:

MonetaryAmount Class

Schema.org/MonetaryAmount A monetary value or range. This type can be used to describe an amount of money such as $50 USD, or a range as in describing a bank account being suitable for a balance between £1,000 and £1,000,000 GBP, or the value of a salary, etc. It is recommended to use [[PriceSpecification]] Types to describe the price of an Offer, Invoice, etc.

Methods

getDescription

() String

Returns the description of the thing

Returns:

String:

description of Thing

getName

() String

Returns the name of the thing

Returns:

String:

name of Thing

setDescription

(
  • description
)

Method to set Thing description

Parameters:

  • description String

    Description to set for its Thing

setName

(
  • name
)

Method to set Thing name

Parameters:

  • name String

    Name to set for this Thing

Properties

additionalType

URL

Schema.org/additionalType An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

alternateName

Text

Schema.org/alternateName An alias for the item.

currency

Text

Schema.org/currency The currency in which the monetary amount is expressed (in 3-letter ISO 4217 format).

description

Text

Schema.org/description A description of the item.

disambiguatingDescription

Text

Schema.org/disambiguatingDescription A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

identifier

Schema, URL | schema,Text | schema,PropertyValue

Schema.org/identifier The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.

image

Schema, URL | schema,ImageObject

Schema.org/image An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

mainEntityOfPage

Schema, URL | schema,CreativeWork

Schema.org/mainEntityOfPage Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.

maxValue

Number

Schema.org/maxValue The upper value of some characteristic or property.

minValue

Number

Schema.org/minValue The lower value of some characteristic or property.

name

Text

Schema.org/name The name of the item.

potentialAction

Action

Schema.org/potentialAction Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

sameAs

URL

Schema.org/sameAs URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

url

URL

Schema.org/url URL of the item.

validFrom

DateTime

Schema.org/validFrom The date when the item becomes valid.

validThrough

DateTime

Schema.org/validThrough The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.

value

StructuredValue

Schema.org/value The value of the quantitative value or property value node.\n\n* For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type for values is 'Number'.\n* For [[PropertyValue]], it can be 'Text;', 'Number', 'Boolean', or 'StructuredValue'.