Skip to content

Latest commit

 

History

History
181 lines (133 loc) · 6.29 KB

offer-representation.schema.md

File metadata and controls

181 lines (133 loc) · 6.29 KB
Raw

Representation (deprecated) Schema

https://ns.adobe.com/experience/offer-management/offer-representation

Offer representation (deprecated).

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Deprecated No Forbidden Permitted adobe/experience/offer-management/offer-representation.schema.json

Representation (deprecated) Examples

{
  "xdm:components": [
    {
      "@type": "https://ns.adobe.com/experience/offer-management/content-component-text",
      "dc:format": "text/template",
      "dc:language": [
        "en",
        "en-AU",
        "en-CA",
        "en-GB",
        "en-IN",
        "en-IE",
        "en-MT",
        "en-NZ",
        "en-PH",
        "en-SG",
        "en-ZA"
      ],
      "repo:name": "expiration_message_en",
      "repo:id": "urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e",
      "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e"&resource="api:metadata/application"&name=expiration_message_en",
      "xdm:copyline": "Dear Madam {{profile.person.lastName}}, the offer expires 12/6/2018"
    },
    {
      "@type": "https://ns.adobe.com/experience/offer-management/content-component-text",
      "dc:format": "text/template",
      "dc:language": [
        "en-US"
      ],
      "repo:name": "expiration_message_en-US",
      "repo:id": "urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e",
      "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e"&resource="api:metadata/application"&name="expiration_message_en-US"",
      "xdm:copyline": "Dear Madam {{profile.person.lastName}}, the offer expires 6/12/2018"
    },
    {
      "@type": "https://ns.adobe.com/experience/offer-management/content-component-text",
      "dc:format": "text/template",
      "dc:language": [
        "es"
      ],
      "repo:name": "expiration_message_es",
      "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e"&resource="api:metadata/application"&name="expiration_message_es"",
      "xdm:copyline": "Estimada señora {{profile.person.lastName}}: La oferta vence el 12/6/2018"
    }
  ],
  "xdm:placement": "uri:xcore:placement-0001",
  "xdm:channel": "https://ns.adobe.com/xdm/channels/email"
}
{
  "xdm:components": [
    {
      "@type": "https://ns.adobe.com/experience/offer-management/content-component-imagelink",
      "dc:format": "image/png",
      "dc:language": [
        "en"
      ],
      "repo:name": "holidayOffer.2018.png",
      "repo:id": "urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805eff8a69e",
      "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805eff8a69e"",
      "xdm:linkURL": "https://www.mycompany.com/product?trackId=12345"
    }
  ],
  "xdm:placement": "uri:xcore:placement-0001",
  "xdm:channel": "https://ns.adobe.com/xdm/channels/email"
}
{
  "xdm:components": [
    {
      "@type": "https://ns.adobe.com/experience/offer-management/content-component-html",
      "dc:format": "text/html",
      "dc:language": [
        "de"
      ],
      "repo:name": "widget_quickbooking.html",
      "repo:id": "urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc",
      "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc""
    }
  ],
  "xdm:placement": "uri:xcore:placement-0001",
  "xdm:channel": "https://ns.adobe.com/xdm/channels/email"
}

Representation (deprecated) Properties

Property Type Required Defined by
xdm:channel string Required Representation (deprecated) (this schema)
xdm:components reference Required Representation (deprecated) (this schema)
xdm:placement string Required Representation (deprecated) (this schema)
* any Additional this schema allows additional properties

xdm:channel

Channel

The channel constraint is used to convey not only where the offer will be used but determine the content editor or validator that is used for the offer's representation. The value is a valid Channel URI. See 'https://ns.adobe.com/xdm/channels/channel'

xdm:channel

  • is required
  • type: string
  • defined in this schema

xdm:channel Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:components

The content components of the offer representation, including all their language variants. Specific components are found by 'dx:format', 'dc:subject' and 'dc:language' or a combination thereof. This metadata is used to locate or represent the content that is associated with an offer and integrate it according to the placement contract.

xdm:components

  • is required

  • type: reference

  • defined in this schema

xdm:components Type

Array type: reference

All items must be of the type:

  • – #/definitions/content-component

xdm:placement

Placement

Placement to comply with. The value is the URI (@id) of the offer placement that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-placement

xdm:placement

  • is required
  • type: string
  • defined in this schema

xdm:placement Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)