Module: SchemaOrg::Mixins::Offer

Includes:
Intangible
Included in:
AggregateOffer, OfferForLease, OfferForPurchase, Offer
Defined in:
lib/schema_org/mixins/offer.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Thing

#additional_type, #additional_type=, #alternate_name, #alternate_name=, #description, #description=, #disambiguating_description, #disambiguating_description=, #identifier, #identifier=, #image, #image=, #main_entity_of_page, #main_entity_of_page=, #name, #name=, #owner, #owner=, #potential_action, #potential_action=, #same_as, #same_as=, #subject_of, #subject_of=, #url, #url=

Class Method Details

.schema_property_definitions ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/schema_org/mixins/offer.rb', line 11

def self.schema_property_definitions
  {
    accepted_payment_method: {
      schema_name: "acceptedPaymentMethod",
      schema_url: "https://schema.org/acceptedPaymentMethod",
      comment_lines: ["The payment method(s) that are accepted in general by an organization, or for some specific demand or offer."].freeze,
      ranges: ["LoanOrCredit", "PaymentMethod", "Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    add_on: {
      schema_name: "addOn",
      schema_url: "https://schema.org/addOn",
      comment_lines: ["An additional offer that can only be obtained in combination with the first base offer (e.g. supplements and extensions that are available for a surcharge)."].freeze,
      ranges: ["Offer"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    additional_property: {
      schema_name: "additionalProperty",
      schema_url: "https://schema.org/additionalProperty",
      comment_lines: ["A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.\\n\\nNote: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism."].freeze,
      ranges: ["PropertyValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    advance_booking_requirement: {
      schema_name: "advanceBookingRequirement",
      schema_url: "https://schema.org/advanceBookingRequirement",
      comment_lines: ["The amount of time that is required between accepting the offer and the actual usage of the resource or service."].freeze,
      ranges: ["QuantitativeValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    aggregate_rating: {
      schema_name: "aggregateRating",
      schema_url: "https://schema.org/aggregateRating",
      comment_lines: ["The overall rating, based on a collection of reviews or ratings, of the item."].freeze,
      ranges: ["AggregateRating"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    area_served: {
      schema_name: "areaServed",
      schema_url: "https://schema.org/areaServed",
      comment_lines: ["The geographic area where a service or offered item is provided."].freeze,
      ranges: ["AdministrativeArea", "GeoShape", "Place", "Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: ["serviceArea"].freeze
    }.freeze,
    asin: {
      schema_name: "asin",
      schema_url: "https://schema.org/asin",
      comment_lines: ["An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s article).", "", "Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details.", "ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too."].freeze,
      ranges: ["Text", "URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    availability: {
      schema_name: "availability",
      schema_url: "https://schema.org/availability",
      comment_lines: ["The availability of this item—for example In stock, Out of stock, Pre-order, etc."].freeze,
      ranges: ["ItemAvailability"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    availability_ends: {
      schema_name: "availabilityEnds",
      schema_url: "https://schema.org/availabilityEnds",
      comment_lines: ["The end of the availability of the product or service included in the offer."].freeze,
      ranges: ["Date", "DateTime", "Time"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    availability_starts: {
      schema_name: "availabilityStarts",
      schema_url: "https://schema.org/availabilityStarts",
      comment_lines: ["The beginning of the availability of the product or service included in the offer."].freeze,
      ranges: ["Date", "DateTime", "Time"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    available_at_or_from: {
      schema_name: "availableAtOrFrom",
      schema_url: "https://schema.org/availableAtOrFrom",
      comment_lines: ["The place(s) from which the offer can be obtained (e.g. store locations)."].freeze,
      ranges: ["Place"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    available_delivery_method: {
      schema_name: "availableDeliveryMethod",
      schema_url: "https://schema.org/availableDeliveryMethod",
      comment_lines: ["The delivery method(s) available for this offer."].freeze,
      ranges: ["DeliveryMethod"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    business_function: {
      schema_name: "businessFunction",
      schema_url: "https://schema.org/businessFunction",
      comment_lines: ["The business function (e.g. sell, lease, repair, dispose) of the offer or component of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell."].freeze,
      ranges: ["BusinessFunction"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    category: {
      schema_name: "category",
      schema_url: "https://schema.org/category",
      comment_lines: ["A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy."].freeze,
      ranges: ["CategoryCode", "PhysicalActivityCategory", "Text", "Thing", "URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    checkout_page_url_template: {
      schema_name: "checkoutPageURLTemplate",
      schema_url: "https://schema.org/checkoutPageURLTemplate",
      comment_lines: ["A URL template (RFC 6570) for a checkout page for an offer. This approach allows merchants to specify a URL for online checkout of the offered product, by interpolating parameters such as the logged in user ID, product ID, quantity, discount code etc. Parameter naming and standardization are not specified here."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    delivery_lead_time: {
      schema_name: "deliveryLeadTime",
      schema_url: "https://schema.org/deliveryLeadTime",
      comment_lines: ["The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup."].freeze,
      ranges: ["QuantitativeValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    eligible_customer_type: {
      schema_name: "eligibleCustomerType",
      schema_url: "https://schema.org/eligibleCustomerType",
      comment_lines: ["The type(s) of customers for which the given offer is valid."].freeze,
      ranges: ["BusinessEntityType"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    eligible_duration: {
      schema_name: "eligibleDuration",
      schema_url: "https://schema.org/eligibleDuration",
      comment_lines: ["The duration for which the given offer is valid."].freeze,
      ranges: ["QuantitativeValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    eligible_quantity: {
      schema_name: "eligibleQuantity",
      schema_url: "https://schema.org/eligibleQuantity",
      comment_lines: ["The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity."].freeze,
      ranges: ["QuantitativeValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    eligible_region: {
      schema_name: "eligibleRegion",
      schema_url: "https://schema.org/eligibleRegion",
      comment_lines: ["The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is valid.\\n\\nSee also [[ineligibleRegion]]."].freeze,
      ranges: ["GeoShape", "Place", "Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    eligible_transaction_volume: {
      schema_name: "eligibleTransactionVolume",
      schema_url: "https://schema.org/eligibleTransactionVolume",
      comment_lines: ["The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount."].freeze,
      ranges: ["PriceSpecification"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    gtin: {
      schema_name: "gtin",
      schema_url: "https://schema.org/gtin",
      comment_lines: ["A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes.", "", "A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a \"GS1 Digital Link\" URL based on such a string. The numeric component should also have a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.", "", "The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) expresses GTINs as URLs (URIs, IRIs, etc.).", "Digital Links should be populated into the [[hasGS1DigitalLink]] attribute.", "", "Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details."].freeze,
      ranges: ["Text", "URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    gtin12: {
      schema_name: "gtin12",
      schema_url: "https://schema.org/gtin12",
      comment_lines: ["The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    gtin13: {
      schema_name: "gtin13",
      schema_url: "https://schema.org/gtin13",
      comment_lines: ["The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    gtin14: {
      schema_name: "gtin14",
      schema_url: "https://schema.org/gtin14",
      comment_lines: ["The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    gtin8: {
      schema_name: "gtin8",
      schema_url: "https://schema.org/gtin8",
      comment_lines: ["The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    has_adult_consideration: {
      schema_name: "hasAdultConsideration",
      schema_url: "https://schema.org/hasAdultConsideration",
      comment_lines: ["Used to tag an item to be intended or suitable for consumption or use by adults only."].freeze,
      ranges: ["AdultOrientedEnumeration"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    has_gs1_digital_link: {
      schema_name: "hasGS1DigitalLink",
      schema_url: "https://schema.org/hasGS1DigitalLink",
      comment_lines: ["The <a href=\"https://www.gs1.org/standards/gs1-digital-link\">GS1 digital link</a> associated with the object. This URL should conform to the particular requirements of digital links. The link should only contain the Application Identifiers (AIs) that are relevant for the entity being annotated, for instance a [[Product]] or an [[Organization]], and for the correct granularity. In particular, for products:<ul><li>A Digital Link that contains a serial number (AI <code>21</code>) should only be present on instances of [[IndividualProduct]]</li><li>A Digital Link that contains a lot number (AI <code>10</code>) should be annotated as [[SomeProducts]] if only products from that lot are sold, or [[IndividualProduct]] if there is only a specific product.</li><li>A Digital Link that contains a global model number (AI <code>8013</code>) should be attached to a [[Product]] or a [[ProductModel]].</li></ul> Other item types should be adapted similarly."].freeze,
      ranges: ["URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    has_measurement: {
      schema_name: "hasMeasurement",
      schema_url: "https://schema.org/hasMeasurement",
      comment_lines: ["A measurement of an item, For example, the inseam of pants, the wheel size of a bicycle, the gauge of a screw, or the carbon footprint measured for certification by an authority. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings."].freeze,
      ranges: ["QuantitativeValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    has_merchant_return_policy: {
      schema_name: "hasMerchantReturnPolicy",
      schema_url: "https://schema.org/hasMerchantReturnPolicy",
      comment_lines: ["Specifies a MerchantReturnPolicy that may be applicable."].freeze,
      ranges: ["MerchantReturnPolicy"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: ["hasProductReturnPolicy"].freeze
    }.freeze,
    includes_object: {
      schema_name: "includesObject",
      schema_url: "https://schema.org/includesObject",
      comment_lines: ["This links to a node or nodes indicating the exact quantity of the products included in  an [[Offer]] or [[ProductCollection]]."].freeze,
      ranges: ["TypeAndQuantityNode"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    ineligible_region: {
      schema_name: "ineligibleRegion",
      schema_url: "https://schema.org/ineligibleRegion",
      comment_lines: ["The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.\\n\\nSee also [[eligibleRegion]]."].freeze,
      ranges: ["GeoShape", "Place", "Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    inventory_level: {
      schema_name: "inventoryLevel",
      schema_url: "https://schema.org/inventoryLevel",
      comment_lines: ["The current approximate inventory level for the item or items."].freeze,
      ranges: ["QuantitativeValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    is_family_friendly: {
      schema_name: "isFamilyFriendly",
      schema_url: "https://schema.org/isFamilyFriendly",
      comment_lines: ["Indicates whether this content is family friendly."].freeze,
      ranges: ["Boolean"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    item_condition: {
      schema_name: "itemCondition",
      schema_url: "https://schema.org/itemCondition",
      comment_lines: ["A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns."].freeze,
      ranges: ["OfferItemCondition"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    item_offered: {
      schema_name: "itemOffered",
      schema_url: "https://schema.org/itemOffered",
      comment_lines: ["An item being offered (or demanded). The transactional nature of the offer or demand is documented using [[businessFunction]], e.g. sell, lease etc. While several common expected types are listed explicitly in this definition, others can be used. Using a second type, such as Product or a subtype of Product, can clarify the nature of the offer."].freeze,
      ranges: ["AggregateOffer", "CreativeWork", "Event", "MenuItem", "Product", "Service", "Trip"].freeze,
      external_ranges: [].freeze,
      inverse_of: "offers",
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    lease_length: {
      schema_name: "leaseLength",
      schema_url: "https://schema.org/leaseLength",
      comment_lines: ["Length of the lease for some [[Accommodation]], either particular to some [[Offer]] or in some cases intrinsic to the property."].freeze,
      ranges: ["Duration", "QuantitativeValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    mobile_url: {
      schema_name: "mobileUrl",
      schema_url: "https://schema.org/mobileUrl",
      comment_lines: ["The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.", "", "To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design) in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional \"mobile site\" alongside the main one. It should not be taken as an endorsement of this publication style."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    mpn: {
      schema_name: "mpn",
      schema_url: "https://schema.org/mpn",
      comment_lines: ["The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    offered_by: {
      schema_name: "offeredBy",
      schema_url: "https://schema.org/offeredBy",
      comment_lines: ["A pointer to the organization or person making the offer."].freeze,
      ranges: ["Organization", "Person"].freeze,
      external_ranges: [].freeze,
      inverse_of: "makesOffer",
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    price: {
      schema_name: "price",
      schema_url: "https://schema.org/price",
      comment_lines: ["The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.\\n\\nUsage guidelines:\\n\\n* Use the [[priceCurrency]] property (with standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. \"USD\"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. \"BTC\"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. \"Ithaca HOUR\") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.\\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.\\n* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a \"content=\" attribute for publishing simple machine-readable values alongside more human-friendly formatting.\\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols."].freeze,
      ranges: ["Number", "Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    price_currency: {
      schema_name: "priceCurrency",
      schema_url: "https://schema.org/priceCurrency",
      comment_lines: ["The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.\\n\\nUse standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. \"USD\"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. \"BTC\"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. \"Ithaca HOUR\"."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    price_specification: {
      schema_name: "priceSpecification",
      schema_url: "https://schema.org/priceSpecification",
      comment_lines: ["One or more detailed price specifications, indicating the unit price and delivery or payment charges."].freeze,
      ranges: ["PriceSpecification"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    price_valid_until: {
      schema_name: "priceValidUntil",
      schema_url: "https://schema.org/priceValidUntil",
      comment_lines: ["The date after which the price is no longer available."].freeze,
      ranges: ["Date"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    review: {
      schema_name: "review",
      schema_url: "https://schema.org/review",
      comment_lines: ["A review of the item."].freeze,
      ranges: ["Review"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: ["reviews"].freeze
    }.freeze,
    reviews: {
      schema_name: "reviews",
      schema_url: "https://schema.org/reviews",
      comment_lines: ["Review of the item."].freeze,
      ranges: ["Review"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: "review",
      supersedes: nil
    }.freeze,
    seller: {
      schema_name: "seller",
      schema_url: "https://schema.org/seller",
      comment_lines: ["An entity which offers (sells / leases / lends / loans) the services / goods.  A seller may also be a provider."].freeze,
      ranges: ["Organization", "Person"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: ["merchant", "vendor"].freeze
    }.freeze,
    serial_number: {
      schema_name: "serialNumber",
      schema_url: "https://schema.org/serialNumber",
      comment_lines: ["The serial number or any alphanumeric identifier of a particular product. When attached to an offer, it is a shortcut for the serial number of the product included in the offer."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    shipping_details: {
      schema_name: "shippingDetails",
      schema_url: "https://schema.org/shippingDetails",
      comment_lines: ["Indicates information about the shipping policies and options associated with an [[Offer]]."].freeze,
      ranges: ["OfferShippingDetails"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    sku: {
      schema_name: "sku",
      schema_url: "https://schema.org/sku",
      comment_lines: ["The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    valid_for_member_tier: {
      schema_name: "validForMemberTier",
      schema_url: "https://schema.org/validForMemberTier",
      comment_lines: ["The membership program tier(s) an Offer (or a PriceSpecification, OfferShippingDetails, or MerchantReturnPolicy under an Offer) is valid for."].freeze,
      ranges: ["MemberProgramTier"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    valid_from: {
      schema_name: "validFrom",
      schema_url: "https://schema.org/validFrom",
      comment_lines: ["The date when the item becomes valid."].freeze,
      ranges: ["Date", "DateTime"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    valid_through: {
      schema_name: "validThrough",
      schema_url: "https://schema.org/validThrough",
      comment_lines: ["The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours."].freeze,
      ranges: ["Date", "DateTime"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    warranty: {
      schema_name: "warranty",
      schema_url: "https://schema.org/warranty",
      comment_lines: ["The warranty promise(s) included in the offer."].freeze,
      ranges: ["WarrantyPromise"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: ["warrantyPromise"].freeze
    }.freeze
  }.freeze
end

Instance Method Details

#accepted_payment_method ⇒ Object

The payment method(s) that are accepted in general by an organization, or for some specific demand or offer.



557
558
559
 
# File 'lib/schema_org/mixins/offer.rb', line 557

def accepted_payment_method
  read_property(:accepted_payment_method)
end

#accepted_payment_method=(value) ⇒ Object

The payment method(s) that are accepted in general by an organization, or for some specific demand or offer.



562
563
564
 
# File 'lib/schema_org/mixins/offer.rb', line 562

def accepted_payment_method=(value)
  write_property(:accepted_payment_method, value)
end

#add_on ⇒ Object

An additional offer that can only be obtained in combination with the first base offer (e.g. supplements and extensions that are available for a surcharge).



567
568
569
 
# File 'lib/schema_org/mixins/offer.rb', line 567

def add_on
  read_property(:add_on)
end

#add_on=(value) ⇒ Object

An additional offer that can only be obtained in combination with the first base offer (e.g. supplements and extensions that are available for a surcharge).



572
573
574
 
# File 'lib/schema_org/mixins/offer.rb', line 572

def add_on=(value)
  write_property(:add_on, value)
end

#additional_property ⇒ Object

A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.\n\nNote: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.



577
578
579
 
# File 'lib/schema_org/mixins/offer.rb', line 577

def additional_property
  read_property(:additional_property)
end

#additional_property=(value) ⇒ Object

A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.\n\nNote: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.



582
583
584
 
# File 'lib/schema_org/mixins/offer.rb', line 582

def additional_property=(value)
  write_property(:additional_property, value)
end

#advance_booking_requirement ⇒ Object

The amount of time that is required between accepting the offer and the actual usage of the resource or service.



587
588
589
 
# File 'lib/schema_org/mixins/offer.rb', line 587

def advance_booking_requirement
  read_property(:advance_booking_requirement)
end

#advance_booking_requirement=(value) ⇒ Object

The amount of time that is required between accepting the offer and the actual usage of the resource or service.



592
593
594
 
# File 'lib/schema_org/mixins/offer.rb', line 592

def advance_booking_requirement=(value)
  write_property(:advance_booking_requirement, value)
end

#aggregate_rating ⇒ Object

The overall rating, based on a collection of reviews or ratings, of the item.



597
598
599
 
# File 'lib/schema_org/mixins/offer.rb', line 597

def aggregate_rating
  read_property(:aggregate_rating)
end

#aggregate_rating=(value) ⇒ Object

The overall rating, based on a collection of reviews or ratings, of the item.



602
603
604
 
# File 'lib/schema_org/mixins/offer.rb', line 602

def aggregate_rating=(value)
  write_property(:aggregate_rating, value)
end

#area_served ⇒ Object

The geographic area where a service or offered item is provided. Supersedes serviceArea.



608
609
610
 
# File 'lib/schema_org/mixins/offer.rb', line 608

def area_served
  read_property(:area_served)
end

#area_served=(value) ⇒ Object

The geographic area where a service or offered item is provided. Supersedes serviceArea.



614
615
616
 
# File 'lib/schema_org/mixins/offer.rb', line 614

def area_served=(value)
  write_property(:area_served, value)
end

#asin ⇒ Object

An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from Wikipedia's article).

Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details. ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.



622
623
624
 
# File 'lib/schema_org/mixins/offer.rb', line 622

def asin
  read_property(:asin)
end

#asin=(value) ⇒ Object

An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from Wikipedia's article).

Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details. ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.



630
631
632
 
# File 'lib/schema_org/mixins/offer.rb', line 630

def asin=(value)
  write_property(:asin, value)
end

#availability ⇒ Object

The availability of this item—for example In stock, Out of stock, Pre-order, etc.



635
636
637
 
# File 'lib/schema_org/mixins/offer.rb', line 635

def availability
  read_property(:availability)
end

#availability=(value) ⇒ Object

The availability of this item—for example In stock, Out of stock, Pre-order, etc.



640
641
642
 
# File 'lib/schema_org/mixins/offer.rb', line 640

def availability=(value)
  write_property(:availability, value)
end

#availability_ends ⇒ Object

The end of the availability of the product or service included in the offer.



645
646
647
 
# File 'lib/schema_org/mixins/offer.rb', line 645

def availability_ends
  read_property(:availability_ends)
end

#availability_ends=(value) ⇒ Object

The end of the availability of the product or service included in the offer.



650
651
652
 
# File 'lib/schema_org/mixins/offer.rb', line 650

def availability_ends=(value)
  write_property(:availability_ends, value)
end

#availability_starts ⇒ Object

The beginning of the availability of the product or service included in the offer.



655
656
657
 
# File 'lib/schema_org/mixins/offer.rb', line 655

def availability_starts
  read_property(:availability_starts)
end

#availability_starts=(value) ⇒ Object

The beginning of the availability of the product or service included in the offer.



660
661
662
 
# File 'lib/schema_org/mixins/offer.rb', line 660

def availability_starts=(value)
  write_property(:availability_starts, value)
end

#available_at_or_from ⇒ Object

The place(s) from which the offer can be obtained (e.g. store locations).



665
666
667
 
# File 'lib/schema_org/mixins/offer.rb', line 665

def available_at_or_from
  read_property(:available_at_or_from)
end

#available_at_or_from=(value) ⇒ Object

The place(s) from which the offer can be obtained (e.g. store locations).



670
671
672
 
# File 'lib/schema_org/mixins/offer.rb', line 670

def available_at_or_from=(value)
  write_property(:available_at_or_from, value)
end

#available_delivery_method ⇒ Object

The delivery method(s) available for this offer.



675
676
677
 
# File 'lib/schema_org/mixins/offer.rb', line 675

def available_delivery_method
  read_property(:available_delivery_method)
end

#available_delivery_method=(value) ⇒ Object

The delivery method(s) available for this offer.



680
681
682
 
# File 'lib/schema_org/mixins/offer.rb', line 680

def available_delivery_method=(value)
  write_property(:available_delivery_method, value)
end

#business_function ⇒ Object

The business function (e.g. sell, lease, repair, dispose) of the offer or component of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell.



685
686
687
 
# File 'lib/schema_org/mixins/offer.rb', line 685

def business_function
  read_property(:business_function)
end

#business_function=(value) ⇒ Object

The business function (e.g. sell, lease, repair, dispose) of the offer or component of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell.



690
691
692
 
# File 'lib/schema_org/mixins/offer.rb', line 690

def business_function=(value)
  write_property(:business_function, value)
end

#category ⇒ Object

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.



695
696
697
 
# File 'lib/schema_org/mixins/offer.rb', line 695

def category
  read_property(:category)
end

#category=(value) ⇒ Object

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.



700
701
702
 
# File 'lib/schema_org/mixins/offer.rb', line 700

def category=(value)
  write_property(:category, value)
end

#checkout_page_url_template ⇒ Object

A URL template (RFC 6570) for a checkout page for an offer. This approach allows merchants to specify a URL for online checkout of the offered product, by interpolating parameters such as the logged in user ID, product ID, quantity, discount code etc. Parameter naming and standardization are not specified here.



705
706
707
 
# File 'lib/schema_org/mixins/offer.rb', line 705

def checkout_page_url_template
  read_property(:checkout_page_url_template)
end

#checkout_page_url_template=(value) ⇒ Object

A URL template (RFC 6570) for a checkout page for an offer. This approach allows merchants to specify a URL for online checkout of the offered product, by interpolating parameters such as the logged in user ID, product ID, quantity, discount code etc. Parameter naming and standardization are not specified here.



710
711
712
 
# File 'lib/schema_org/mixins/offer.rb', line 710

def checkout_page_url_template=(value)
  write_property(:checkout_page_url_template, value)
end

#delivery_lead_time ⇒ Object

The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup.



715
716
717
 
# File 'lib/schema_org/mixins/offer.rb', line 715

def delivery_lead_time
  read_property(:delivery_lead_time)
end

#delivery_lead_time=(value) ⇒ Object

The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup.



720
721
722
 
# File 'lib/schema_org/mixins/offer.rb', line 720

def delivery_lead_time=(value)
  write_property(:delivery_lead_time, value)
end

#eligible_customer_type ⇒ Object

The type(s) of customers for which the given offer is valid.



725
726
727
 
# File 'lib/schema_org/mixins/offer.rb', line 725

def eligible_customer_type
  read_property(:eligible_customer_type)
end

#eligible_customer_type=(value) ⇒ Object

The type(s) of customers for which the given offer is valid.



730
731
732
 
# File 'lib/schema_org/mixins/offer.rb', line 730

def eligible_customer_type=(value)
  write_property(:eligible_customer_type, value)
end

#eligible_duration ⇒ Object

The duration for which the given offer is valid.



735
736
737
 
# File 'lib/schema_org/mixins/offer.rb', line 735

def eligible_duration
  read_property(:eligible_duration)
end

#eligible_duration=(value) ⇒ Object

The duration for which the given offer is valid.



740
741
742
 
# File 'lib/schema_org/mixins/offer.rb', line 740

def eligible_duration=(value)
  write_property(:eligible_duration, value)
end

#eligible_quantity ⇒ Object

The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity.



745
746
747
 
# File 'lib/schema_org/mixins/offer.rb', line 745

def eligible_quantity
  read_property(:eligible_quantity)
end

#eligible_quantity=(value) ⇒ Object

The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity.



750
751
752
 
# File 'lib/schema_org/mixins/offer.rb', line 750

def eligible_quantity=(value)
  write_property(:eligible_quantity, value)
end

#eligible_region ⇒ Object

The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is valid.\n\nSee also [[ineligibleRegion]].



755
756
757
 
# File 'lib/schema_org/mixins/offer.rb', line 755

def eligible_region
  read_property(:eligible_region)
end

#eligible_region=(value) ⇒ Object

The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is valid.\n\nSee also [[ineligibleRegion]].



760
761
762
 
# File 'lib/schema_org/mixins/offer.rb', line 760

def eligible_region=(value)
  write_property(:eligible_region, value)
end

#eligible_transaction_volume ⇒ Object

The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.



765
766
767
 
# File 'lib/schema_org/mixins/offer.rb', line 765

def eligible_transaction_volume
  read_property(:eligible_transaction_volume)
end

#eligible_transaction_volume=(value) ⇒ Object

The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.



770
771
772
 
# File 'lib/schema_org/mixins/offer.rb', line 770

def eligible_transaction_volume=(value)
  write_property(:eligible_transaction_volume, value)
end

#gtin ⇒ Object

A Global Trade Item Number (GTIN). GTINs identify trade items, including products and services, using numeric identification codes.

A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a valid GS1 check digit and meet the other rules for valid GTINs. See also GS1's GTIN Summary and Wikipedia for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.

The GS1 digital link specifications expresses GTINs as URLs (URIs, IRIs, etc.). Digital Links should be populated into the [[hasGS1DigitalLink]] attribute.

Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.



782
783
784
 
# File 'lib/schema_org/mixins/offer.rb', line 782

def gtin
  read_property(:gtin)
end

#gtin12 ⇒ Object

The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See GS1 GTIN Summary for more details.



799
800
801
 
# File 'lib/schema_org/mixins/offer.rb', line 799

def gtin12
  read_property(:gtin12)
end

#gtin12=(value) ⇒ Object

The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See GS1 GTIN Summary for more details.



804
805
806
 
# File 'lib/schema_org/mixins/offer.rb', line 804

def gtin12=(value)
  write_property(:gtin12, value)
end

#gtin13 ⇒ Object

The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See GS1 GTIN Summary for more details.



809
810
811
 
# File 'lib/schema_org/mixins/offer.rb', line 809

def gtin13
  read_property(:gtin13)
end

#gtin13=(value) ⇒ Object

The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See GS1 GTIN Summary for more details.



814
815
816
 
# File 'lib/schema_org/mixins/offer.rb', line 814

def gtin13=(value)
  write_property(:gtin13, value)
end

#gtin14 ⇒ Object

The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details.



819
820
821
 
# File 'lib/schema_org/mixins/offer.rb', line 819

def gtin14
  read_property(:gtin14)
end

#gtin14=(value) ⇒ Object

The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details.



824
825
826
 
# File 'lib/schema_org/mixins/offer.rb', line 824

def gtin14=(value)
  write_property(:gtin14, value)
end

#gtin8 ⇒ Object

The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See GS1 GTIN Summary for more details.



829
830
831
 
# File 'lib/schema_org/mixins/offer.rb', line 829

def gtin8
  read_property(:gtin8)
end

#gtin8=(value) ⇒ Object

The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See GS1 GTIN Summary for more details.



834
835
836
 
# File 'lib/schema_org/mixins/offer.rb', line 834

def gtin8=(value)
  write_property(:gtin8, value)
end

#gtin=(value) ⇒ Object

A Global Trade Item Number (GTIN). GTINs identify trade items, including products and services, using numeric identification codes.

A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a valid GS1 check digit and meet the other rules for valid GTINs. See also GS1's GTIN Summary and Wikipedia for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.

The GS1 digital link specifications expresses GTINs as URLs (URIs, IRIs, etc.). Digital Links should be populated into the [[hasGS1DigitalLink]] attribute.

Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.



794
795
796
 
# File 'lib/schema_org/mixins/offer.rb', line 794

def gtin=(value)
  write_property(:gtin, value)
end

#has_adult_consideration ⇒ Object

Used to tag an item to be intended or suitable for consumption or use by adults only.



839
840
841
 
# File 'lib/schema_org/mixins/offer.rb', line 839

def has_adult_consideration
  read_property(:has_adult_consideration)
end

#has_adult_consideration=(value) ⇒ Object

Used to tag an item to be intended or suitable for consumption or use by adults only.



844
845
846
 
# File 'lib/schema_org/mixins/offer.rb', line 844

def has_adult_consideration=(value)
  write_property(:has_adult_consideration, value)
end

#has_gs1_digital_link ⇒ Object

The GS1 digital link associated with the object. This URL should conform to the particular requirements of digital links. The link should only contain the Application Identifiers (AIs) that are relevant for the entity being annotated, for instance a [[Product]] or an [[Organization]], and for the correct granularity. In particular, for products:

  • A Digital Link that contains a serial number (AI 21) should only be present on instances of [[IndividualProduct]]
  • A Digital Link that contains a lot number (AI 10) should be annotated as [[SomeProducts]] if only products from that lot are sold, or [[IndividualProduct]] if there is only a specific product.
  • A Digital Link that contains a global model number (AI 8013) should be attached to a [[Product]] or a [[ProductModel]].
Other item types should be adapted similarly.



849
850
851
 
# File 'lib/schema_org/mixins/offer.rb', line 849

def has_gs1_digital_link
  read_property(:has_gs1_digital_link)
end

#has_gs1_digital_link=(value) ⇒ Object

The GS1 digital link associated with the object. This URL should conform to the particular requirements of digital links. The link should only contain the Application Identifiers (AIs) that are relevant for the entity being annotated, for instance a [[Product]] or an [[Organization]], and for the correct granularity. In particular, for products:

  • A Digital Link that contains a serial number (AI 21) should only be present on instances of [[IndividualProduct]]
  • A Digital Link that contains a lot number (AI 10) should be annotated as [[SomeProducts]] if only products from that lot are sold, or [[IndividualProduct]] if there is only a specific product.
  • A Digital Link that contains a global model number (AI 8013) should be attached to a [[Product]] or a [[ProductModel]].
Other item types should be adapted similarly.



854
855
856
 
# File 'lib/schema_org/mixins/offer.rb', line 854

def has_gs1_digital_link=(value)
  write_property(:has_gs1_digital_link, value)
end

#has_measurement ⇒ Object

A measurement of an item, For example, the inseam of pants, the wheel size of a bicycle, the gauge of a screw, or the carbon footprint measured for certification by an authority. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.



859
860
861
 
# File 'lib/schema_org/mixins/offer.rb', line 859

def has_measurement
  read_property(:has_measurement)
end

#has_measurement=(value) ⇒ Object

A measurement of an item, For example, the inseam of pants, the wheel size of a bicycle, the gauge of a screw, or the carbon footprint measured for certification by an authority. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.



864
865
866
 
# File 'lib/schema_org/mixins/offer.rb', line 864

def has_measurement=(value)
  write_property(:has_measurement, value)
end

#has_merchant_return_policy ⇒ Object

Specifies a MerchantReturnPolicy that may be applicable. Supersedes hasProductReturnPolicy.



870
871
872
 
# File 'lib/schema_org/mixins/offer.rb', line 870

def has_merchant_return_policy
  read_property(:has_merchant_return_policy)
end

#has_merchant_return_policy=(value) ⇒ Object

Specifies a MerchantReturnPolicy that may be applicable. Supersedes hasProductReturnPolicy.



876
877
878
 
# File 'lib/schema_org/mixins/offer.rb', line 876

def has_merchant_return_policy=(value)
  write_property(:has_merchant_return_policy, value)
end

#includes_object ⇒ Object

This links to a node or nodes indicating the exact quantity of the products included in an [[Offer]] or [[ProductCollection]].



881
882
883
 
# File 'lib/schema_org/mixins/offer.rb', line 881

def includes_object
  read_property(:includes_object)
end

#includes_object=(value) ⇒ Object

This links to a node or nodes indicating the exact quantity of the products included in an [[Offer]] or [[ProductCollection]].



886
887
888
 
# File 'lib/schema_org/mixins/offer.rb', line 886

def includes_object=(value)
  write_property(:includes_object, value)
end

#ineligible_region ⇒ Object

The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.\n\nSee also [[eligibleRegion]].



891
892
893
 
# File 'lib/schema_org/mixins/offer.rb', line 891

def ineligible_region
  read_property(:ineligible_region)
end

#ineligible_region=(value) ⇒ Object

The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.\n\nSee also [[eligibleRegion]].



896
897
898
 
# File 'lib/schema_org/mixins/offer.rb', line 896

def ineligible_region=(value)
  write_property(:ineligible_region, value)
end

#inventory_level ⇒ Object

The current approximate inventory level for the item or items.



901
902
903
 
# File 'lib/schema_org/mixins/offer.rb', line 901

def inventory_level
  read_property(:inventory_level)
end

#inventory_level=(value) ⇒ Object

The current approximate inventory level for the item or items.



906
907
908
 
# File 'lib/schema_org/mixins/offer.rb', line 906

def inventory_level=(value)
  write_property(:inventory_level, value)
end

#is_family_friendly ⇒ Object

Indicates whether this content is family friendly.



911
912
913
 
# File 'lib/schema_org/mixins/offer.rb', line 911

def is_family_friendly
  read_property(:is_family_friendly)
end

#is_family_friendly=(value) ⇒ Object

Indicates whether this content is family friendly.



916
917
918
 
# File 'lib/schema_org/mixins/offer.rb', line 916

def is_family_friendly=(value)
  write_property(:is_family_friendly, value)
end

#item_condition ⇒ Object

A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.



921
922
923
 
# File 'lib/schema_org/mixins/offer.rb', line 921

def item_condition
  read_property(:item_condition)
end

#item_condition=(value) ⇒ Object

A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.



926
927
928
 
# File 'lib/schema_org/mixins/offer.rb', line 926

def item_condition=(value)
  write_property(:item_condition, value)
end

#item_offered ⇒ Object

An item being offered (or demanded). The transactional nature of the offer or demand is documented using [[businessFunction]], e.g. sell, lease etc. While several common expected types are listed explicitly in this definition, others can be used. Using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. Inverse-property: offers.



932
933
934
 
# File 'lib/schema_org/mixins/offer.rb', line 932

def item_offered
  read_property(:item_offered)
end

#item_offered=(value) ⇒ Object

An item being offered (or demanded). The transactional nature of the offer or demand is documented using [[businessFunction]], e.g. sell, lease etc. While several common expected types are listed explicitly in this definition, others can be used. Using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. Inverse-property: offers.



938
939
940
 
# File 'lib/schema_org/mixins/offer.rb', line 938

def item_offered=(value)
  write_property(:item_offered, value)
end

#lease_length ⇒ Object

Length of the lease for some [[Accommodation]], either particular to some [[Offer]] or in some cases intrinsic to the property.



943
944
945
 
# File 'lib/schema_org/mixins/offer.rb', line 943

def lease_length
  read_property(:lease_length)
end

#lease_length=(value) ⇒ Object

Length of the lease for some [[Accommodation]], either particular to some [[Offer]] or in some cases intrinsic to the property.



948
949
950
 
# File 'lib/schema_org/mixins/offer.rb', line 948

def lease_length=(value)
  write_property(:lease_length, value)
end

#mobile_url ⇒ Object

The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.

To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards responsive design in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style.



955
956
957
 
# File 'lib/schema_org/mixins/offer.rb', line 955

def mobile_url
  read_property(:mobile_url)
end

#mobile_url=(value) ⇒ Object

The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.

To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards responsive design in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style.



962
963
964
 
# File 'lib/schema_org/mixins/offer.rb', line 962

def mobile_url=(value)
  write_property(:mobile_url, value)
end

#mpn ⇒ Object

The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.



967
968
969
 
# File 'lib/schema_org/mixins/offer.rb', line 967

def mpn
  read_property(:mpn)
end

#mpn=(value) ⇒ Object

The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.



972
973
974
 
# File 'lib/schema_org/mixins/offer.rb', line 972

def mpn=(value)
  write_property(:mpn, value)
end

#offered_by ⇒ Object

A pointer to the organization or person making the offer. Inverse-property: makesOffer.



978
979
980
 
# File 'lib/schema_org/mixins/offer.rb', line 978

def offered_by
  read_property(:offered_by)
end

#offered_by=(value) ⇒ Object

A pointer to the organization or person making the offer. Inverse-property: makesOffer.



984
985
986
 
# File 'lib/schema_org/mixins/offer.rb', line 984

def offered_by=(value)
  write_property(:offered_by, value)
end

#price ⇒ Object

The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.\n\nUsage guidelines:\n\n* Use the [[priceCurrency]] property (with standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR") instead of including ambiguous symbols such as '$' in the value.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.\n* Note that both RDFa and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.



989
990
991
 
# File 'lib/schema_org/mixins/offer.rb', line 989

def price
  read_property(:price)
end

#price=(value) ⇒ Object

The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.\n\nUsage guidelines:\n\n* Use the [[priceCurrency]] property (with standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR") instead of including ambiguous symbols such as '$' in the value.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.\n* Note that both RDFa and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.



994
995
996
 
# File 'lib/schema_org/mixins/offer.rb', line 994

def price=(value)
  write_property(:price, value)
end

#price_currency ⇒ Object

The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.\n\nUse standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR".



999
1000
1001
 
# File 'lib/schema_org/mixins/offer.rb', line 999

def price_currency
  read_property(:price_currency)
end

#price_currency=(value) ⇒ Object

The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.\n\nUse standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR".



1004
1005
1006
 
# File 'lib/schema_org/mixins/offer.rb', line 1004

def price_currency=(value)
  write_property(:price_currency, value)
end

#price_specification ⇒ Object

One or more detailed price specifications, indicating the unit price and delivery or payment charges.



1009
1010
1011
 
# File 'lib/schema_org/mixins/offer.rb', line 1009

def price_specification
  read_property(:price_specification)
end

#price_specification=(value) ⇒ Object

One or more detailed price specifications, indicating the unit price and delivery or payment charges.



1014
1015
1016
 
# File 'lib/schema_org/mixins/offer.rb', line 1014

def price_specification=(value)
  write_property(:price_specification, value)
end

#price_valid_until ⇒ Object

The date after which the price is no longer available.



1019
1020
1021
 
# File 'lib/schema_org/mixins/offer.rb', line 1019

def price_valid_until
  read_property(:price_valid_until)
end

#price_valid_until=(value) ⇒ Object

The date after which the price is no longer available.



1024
1025
1026
 
# File 'lib/schema_org/mixins/offer.rb', line 1024

def price_valid_until=(value)
  write_property(:price_valid_until, value)
end

#review ⇒ Object

A review of the item. Supersedes reviews.



1030
1031
1032
 
# File 'lib/schema_org/mixins/offer.rb', line 1030

def review
  read_property(:review)
end

#review=(value) ⇒ Object

A review of the item. Supersedes reviews.



1036
1037
1038
 
# File 'lib/schema_org/mixins/offer.rb', line 1036

def review=(value)
  write_property(:review, value)
end

#reviews ⇒ Object

Review of the item. Superseded by review.



1042
1043
1044
 
# File 'lib/schema_org/mixins/offer.rb', line 1042

def reviews
  read_property(:reviews)
end

#reviews=(value) ⇒ Object

Review of the item. Superseded by review.



1048
1049
1050
 
# File 'lib/schema_org/mixins/offer.rb', line 1048

def reviews=(value)
  write_property(:reviews, value)
end

#seller ⇒ Object

An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider. Supersedes merchant. Supersedes vendor.



1055
1056
1057
 
# File 'lib/schema_org/mixins/offer.rb', line 1055

def seller
  read_property(:seller)
end

#seller=(value) ⇒ Object

An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider. Supersedes merchant. Supersedes vendor.



1062
1063
1064
 
# File 'lib/schema_org/mixins/offer.rb', line 1062

def seller=(value)
  write_property(:seller, value)
end

#serial_number ⇒ Object

The serial number or any alphanumeric identifier of a particular product. When attached to an offer, it is a shortcut for the serial number of the product included in the offer.



1067
1068
1069
 
# File 'lib/schema_org/mixins/offer.rb', line 1067

def serial_number
  read_property(:serial_number)
end

#serial_number=(value) ⇒ Object

The serial number or any alphanumeric identifier of a particular product. When attached to an offer, it is a shortcut for the serial number of the product included in the offer.



1072
1073
1074
 
# File 'lib/schema_org/mixins/offer.rb', line 1072

def serial_number=(value)
  write_property(:serial_number, value)
end

#shipping_details ⇒ Object

Indicates information about the shipping policies and options associated with an [[Offer]].



1077
1078
1079
 
# File 'lib/schema_org/mixins/offer.rb', line 1077

def shipping_details
  read_property(:shipping_details)
end

#shipping_details=(value) ⇒ Object

Indicates information about the shipping policies and options associated with an [[Offer]].



1082
1083
1084
 
# File 'lib/schema_org/mixins/offer.rb', line 1082

def shipping_details=(value)
  write_property(:shipping_details, value)
end

#sku ⇒ Object

The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.



1087
1088
1089
 
# File 'lib/schema_org/mixins/offer.rb', line 1087

def sku
  read_property(:sku)
end

#sku=(value) ⇒ Object

The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.



1092
1093
1094
 
# File 'lib/schema_org/mixins/offer.rb', line 1092

def sku=(value)
  write_property(:sku, value)
end

#valid_for_member_tier ⇒ Object

The membership program tier(s) an Offer (or a PriceSpecification, OfferShippingDetails, or MerchantReturnPolicy under an Offer) is valid for.



1097
1098
1099
 
# File 'lib/schema_org/mixins/offer.rb', line 1097

def valid_for_member_tier
  read_property(:valid_for_member_tier)
end

#valid_for_member_tier=(value) ⇒ Object

The membership program tier(s) an Offer (or a PriceSpecification, OfferShippingDetails, or MerchantReturnPolicy under an Offer) is valid for.



1102
1103
1104
 
# File 'lib/schema_org/mixins/offer.rb', line 1102

def valid_for_member_tier=(value)
  write_property(:valid_for_member_tier, value)
end

#valid_from ⇒ Object

The date when the item becomes valid.



1107
1108
1109
 
# File 'lib/schema_org/mixins/offer.rb', line 1107

def valid_from
  read_property(:valid_from)
end

#valid_from=(value) ⇒ Object

The date when the item becomes valid.



1112
1113
1114
 
# File 'lib/schema_org/mixins/offer.rb', line 1112

def valid_from=(value)
  write_property(:valid_from, value)
end

#valid_through ⇒ Object

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



1117
1118
1119
 
# File 'lib/schema_org/mixins/offer.rb', line 1117

def valid_through
  read_property(:valid_through)
end

#valid_through=(value) ⇒ Object

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



1122
1123
1124
 
# File 'lib/schema_org/mixins/offer.rb', line 1122

def valid_through=(value)
  write_property(:valid_through, value)
end

#warranty ⇒ Object

The warranty promise(s) included in the offer. Supersedes warrantyPromise.



1128
1129
1130
 
# File 'lib/schema_org/mixins/offer.rb', line 1128

def warranty
  read_property(:warranty)
end

#warranty=(value) ⇒ Object

The warranty promise(s) included in the offer. Supersedes warrantyPromise.



1134
1135
1136
 
# File 'lib/schema_org/mixins/offer.rb', line 1134

def warranty=(value)
  write_property(:warranty, value)
end