diff --git a/docs/reference/README.md b/docs/reference/README.md new file mode 100644 index 000000000..3631446b7 --- /dev/null +++ b/docs/reference/README.md @@ -0,0 +1,290 @@ + + + # Readme + + + +## /behaviors/ + +* [Ad Hoc Schema](./behaviors/adhoc.schema.md) – `https://ns.adobe.com/xdm/data/adhoc` (Stable) +* [Record Schema](./behaviors/record.schema.md) – `https://ns.adobe.com/xdm/data/record` (Stable) +* [Time-series Schema](./behaviors/time-series.schema.md) – `https://ns.adobe.com/xdm/data/time-series` (Stable) + +## /common/ + +* [User identity](./common/identity.schema.md) – `https://ns.adobe.com/xdm/common/identity` (Deprecated) + +## /descriptors/ + +* [Item Selector](./descriptors/itemselector.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/itemselector` (Stable) +* [Relationship Descriptor](./descriptors/relationshipdescriptor.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor` (Stable) +* [Schema Descriptor](./descriptors/schemadescriptor.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/schemadescriptor` (Stable) + +## /classes/ + +* [Segment definition](./classes/segmentdefinition.schema.md) – `https://ns.adobe.com/xdm/context/segmentdefinition` (Stable) +* [XDM Activity Type](./classes/activity-type.schema.md) – `https://ns.adobe.com/xdm/context/activity-type` (Experimental) +* [XDM Business Account](./classes/account.schema.md) – `https://ns.adobe.com/xdm/context/account` (Experimental) +* [XDM Business Activity Log](./classes/activity-log.schema.md) – `https://ns.adobe.com/xdm/context/activity-log` (Experimental) +* [XDM Business Campaign Member](./classes/campaign-member.schema.md) – `https://ns.adobe.com/xdm/context/campaign-member` (Experimental) +* [XDM Business Campaign Workflow](./classes/campaign-workflow.schema.md) – `https://ns.adobe.com/xdm/context/campaign-workflow` (Experimental) +* [XDM Business Opportunity](./classes/opportunity.schema.md) – `https://ns.adobe.com/xdm/context/opportunity` (Experimental) +* [XDM Buying Group](./classes/opportunity-contact-role.schema.md) – `https://ns.adobe.com/xdm/context/opportunity-contact-role` (Experimental) +* [XDM ExperienceEvent](./classes/experienceevent.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent` (Stable) +* [XDM Graphs](./classes/graphs.schema.md) – `https://ns.adobe.com/xdm/context/graphs` (Stable) +* [XDM Individual Profile](./classes/profile.schema.md) – `https://ns.adobe.com/xdm/context/profile` (Stable) + +## /destinations/ + +* [Destinations](./destinations/destination.schema.md) – `https://ns.adobe.com/xdm/context/destination` (Stable) +* [Destinations Namespace Mapping](./destinations/destination-namespace.schema.md) – `https://ns.adobe.com/xdm/context/destination-namespace` (Stable) +* [Destinations Segment Mapping](./destinations/destination-segment.schema.md) – `https://ns.adobe.com/xdm/context/destination-segment` (Stable) + +## /notifications/ + +* [Customer Data Ingestion Notifications Event](./notifications/ingestion.schema.md) – `https://ns.adobe.com/xdm/common/notifications/ingestion` (Stable) + +## /datatypes/ + +* [Ad asset reference](./datatypes/advertising-timed-asset-reference.schema.md) – `https://ns.adobe.com/xdm/context/advertising-timed-asset-reference` (Stable) +* [Ad asset view details](./datatypes/advertising-timed-asset-view-details.schema.md) – `https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details` (Stable) +* [Ad break](./datatypes/advertising-break.schema.md) – `https://ns.adobe.com/xdm/context/advertising-break` (Stable) +* [Advertising](./datatypes/advertising.schema.md) – `https://ns.adobe.com/xdm/context/advertising` (Stable) +* [Application](./datatypes/application.schema.md) – `https://ns.adobe.com/xdm/context/application` (Stable) +* [Audit trail](./datatypes/auditable.schema.md) – `https://ns.adobe.com/xdm/common/auditable` (Stable) +* [B2B Contact](./datatypes/b2b-contact.schema.md) – `https://ns.adobe.com/xdm/common/b2b-contact` (Experimental) +* [B2B Lead](./datatypes/b2b-lead.schema.md) – `https://ns.adobe.com/xdm/common/b2b-lead` (Experimental) +* [Beacon](./datatypes/beacon-interaction-details.schema.md) – `https://ns.adobe.com/xdm/context/beacon-interaction-details` (Stable) +* [Browser details](./datatypes/browserdetails.schema.md) – `https://ns.adobe.com/xdm/context/browserdetails` (Stable) +* [Commerce](./datatypes/commerce.schema.md) – `https://ns.adobe.com/xdm/context/commerce` (Stable) +* [Consent String](./datatypes/consentstring.schema.md) – `https://ns.adobe.com/xdm/context/consentstring` (Stable) +* [Customer Managed Environment](./datatypes/selfservice.schema.md) – `https://ns.adobe.com/xdm/common/selfservice` (Stable) +* [Device](./datatypes/device.schema.md) – `https://ns.adobe.com/xdm/context/device` (Stable) +* [Direct marketing](./datatypes/direct-marketing.schema.md) – `https://ns.adobe.com/xdm/context/direct-marketing` (Stable) +* [Direct marketing email address](./datatypes/directmarketing-emailaddress.schema.md) – `https://ns.adobe.com/xdm/context/directmarketing-emailaddress` (Stable) +* [Direct marketing phone number](./datatypes/directmarketing-phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/directmarketing-phonenumber` (Stable) +* [Direct marketing postal address](./datatypes/directmarketing-address.schema.md) – `https://ns.adobe.com/xdm/context/directmarketing-address` (Stable) +* [Email Interaction](./datatypes/email-interaction.schema.md) – `https://ns.adobe.com/xdm/common/emailinteraction` (Experimental) +* [Email address](./datatypes/emailaddress.schema.md) – `https://ns.adobe.com/xdm/context/emailaddress` (Stable) +* [End user IDs](./datatypes/enduserids.schema.md) – `https://ns.adobe.com/xdm/context/enduserids` (Stable) +* [Environment](./datatypes/environment.schema.md) – `https://ns.adobe.com/xdm/context/environment` (Stable) +* [Extensibility base schema](./datatypes/extensible.schema.md) – `https://ns.adobe.com/xdm/common/extensible` (Stable) +* [External Source System Audit Attributes](./datatypes/external-source-system-audit.schema.md) – `https://ns.adobe.com/xdm/common/external-source-system-audit` (Stable) +* [Geo](./datatypes/geo.schema.md) – `https://ns.adobe.com/xdm/common/geo` (Stable) +* [Geo interaction details](./datatypes/geo-interaction-details.schema.md) – `https://ns.adobe.com/xdm/context/geo-interaction-details` (Stable) +* [Geographical unit](./datatypes/geounit.schema.md) – `https://ns.adobe.com/xdm/common/geounit` (Stable) +* [Identity](./datatypes/identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` (Stable) +* [Identity Provider](./datatypes/identity-provider.schema.md) – `https://ns.adobe.com/xdm/common/identity-provider` (Stable) +* [Identity item](./datatypes/identityitem.schema.md) – `https://ns.adobe.com/xdm/context/identityitem` (Stable) +* [Implementation details](./datatypes/implementationdetails.schema.md) – `https://ns.adobe.com/xdm/context/implementationdetails` (Stable) +* [MRC Viewability](./datatypes/adviewability.schema.md) – `https://ns.adobe.com/xdm/context/adviewability` (Stable) +* [Marketing](./datatypes/marketing.schema.md) – `https://ns.adobe.com/xdm/context/marketing` (Stable) +* [Media audio](./datatypes/media-timed-audio.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-audio` (Stable) +* [Media information](./datatypes/media.schema.md) – `https://ns.adobe.com/xdm/context/media` (Stable) +* [Meeting Interaction](./datatypes/meeting-interaction.schema.md) – `https://ns.adobe.com/xdm/common/meetinginteraction` (Experimental) +* [Namespace](./datatypes/namespace.schema.md) – `https://ns.adobe.com/xdm/context/namespace` (Stable) +* [OptInOut](./datatypes/optinout.schema.md) – `https://ns.adobe.com/xdm/context/optinout` (Stable) +* [OptOut Additional Details](./datatypes/optinout-additional-details.schema.md) – `https://ns.adobe.com/xdm/common/optinout-additional-details` (Experimental) +* [Organization](./datatypes/organization.schema.md) – `https://ns.adobe.com/xdm/common/organization` (Experimental) +* [Organizational unit](./datatypes/orgunit.schema.md) – `https://ns.adobe.com/xdm/common/orgunit` (Stable) +* [Page](./datatypes/page.schema.md) – `https://ns.adobe.com/xdm/common/page` (Stable) +* [Person](./datatypes/person.schema.md) – `https://ns.adobe.com/xdm/context/person` (Stable) +* [Person name](./datatypes/person-name.schema.md) – `https://ns.adobe.com/xdm/context/person-name` (Stable) +* [Phone Interaction](./datatypes/phone-interaction.schema.md) – `https://ns.adobe.com/xdm/common/phoneinteraction` (Experimental) +* [Phone number](./datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` (Stable) +* [Physical place](./datatypes/place.schema.md) – `https://ns.adobe.com/xdm/context/place` (Stable) +* [Place context](./datatypes/placecontext.schema.md) – `https://ns.adobe.com/xdm/context/placecontext` (Stable) +* [Player state information](./datatypes/player-state.schema.md) – `https://ns.adobe.com/xdm/context/player-state` (Stable) +* [Point of interest details](./datatypes/poi-detail.schema.md) – `https://ns.adobe.com/xdm/context/poi-detail` (Stable) +* [Point of interest interaction](./datatypes/poi-interaction.schema.md) – `https://ns.adobe.com/xdm/context/poi-interaction` (Stable) +* [Postal address](./datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` (Stable) +* [Primary asset view details](./datatypes/media-timed-asset-view-details.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-asset-view-details` (Stable) +* [Principal](./datatypes/principal.schema.md) – `https://ns.adobe.com/xdm/common/principal` (Stable) +* [Product](./datatypes/product.schema.md) – `https://ns.adobe.com/xdm/context/product` (Stable) +* [Product list item](./datatypes/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem` (Stable) +* [Profile stitch](./datatypes/profilestitch.schema.md) – `https://ns.adobe.com/xdm/context/profileStitch` (Stable) +* [Profile stitch identity](./datatypes/profilestitchidentity.schema.md) – `https://ns.adobe.com/xdm/context/profileStitchIdentity` (Stable) +* [Push notification detail](./datatypes/pushdetail.schema.md) – `https://ns.adobe.com/xdm/context/pushdetail` (Stable) +* [Push notification token](./datatypes/pushnotificationtoken.schema.md) – `https://ns.adobe.com/xdm/context/pushnotificationtoken` (Stable) +* [Search](./datatypes/search.schema.md) – `https://ns.adobe.com/xdm/context/search` (Stable) +* [Segment identity](./datatypes/segmentidentity.schema.md) – `https://ns.adobe.com/xdm/context/segmentidentity` (Stable) +* [Segment membership](./datatypes/segmentmembership.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembership` (Stable) +* [Segment membership item](./datatypes/segmentmembershipitem.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembershipitem` (Stable) +* [Subscription](./datatypes/subscription.schema.md) – `https://ns.adobe.com/xdm/context/subscription` (Stable) +* [Timed media chapter asset reference](./datatypes/media-timed-chapter-asset-reference.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference` (Stable) +* [Timed media chapter information](./datatypes/media-timed-chapter.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-chapter` (Stable) +* [Timed media chapter view details](./datatypes/media-timed-chapter-view-details.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-chapter-view-details` (Stable) +* [Timed media information](./datatypes/media-timed.schema.md) – `https://ns.adobe.com/xdm/context/media-timed` (Stable) +* [Timed media primary asset reference](./datatypes/media-timed-asset-reference.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-asset-reference` (Stable) +* [Timed media quality of experience](./datatypes/media-timed-qoe.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-qoe` (Stable) +* [Web information](./datatypes/webinfo.schema.md) – `https://ns.adobe.com/xdm/context/webinfo` (Stable) +* [Web interaction](./datatypes/webinteraction.schema.md) – `https://ns.adobe.com/xdm/context/webinteraction` (Stable) +* [Web page details](./datatypes/webpagedetails.schema.md) – `https://ns.adobe.com/xdm/context/webpagedetails` (Stable) +* [Web referrer](./datatypes/webreferrer.schema.md) – `https://ns.adobe.com/xdm/context/webreferrer` (Stable) +* [XDM Activity](./datatypes/activity-type-reference-details.schema.md) – `https://ns.adobe.com/xdm/common/activity-type-reference-details` (Experimental) +* [XDM Contact and Lead common B2B attributes](./datatypes/contact-lead.schema.md) – `https://ns.adobe.com/xdm/common/contact-lead` (Experimental) + +## /descriptors/display/ + +* [Friendly Name Descriptor](./descriptors/display/alternateDisplayInfo.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/alternateDisplayInfo` (Stable) + +## /descriptors/relationship/ + +* [Event Relationship Descriptor](./descriptors/relationship/eventRelationship.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/eventRelationship` (Stable) +* [Many to Many Relationship Descriptor](./descriptors/relationship/descriptorManyToMany.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/descriptorManyToMany` (Stable) +* [One to Many Relationship Descriptor](./descriptors/relationship/descriptorOneToMany.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/descriptorOneToMany` (Stable) +* [One to One Relationship Descriptor](./descriptors/relationship/descriptorOneToOne.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne` (Stable) + +## /descriptors/identity/ + +* [Identity Descriptor](./descriptors/identity/descriptorIdentity.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/descriptorIdentity` (Stable) +* [Identity Reference Descriptor](./descriptors/identity/descriptorReferenceIdentity.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/descriptorReferenceIdentity` (Stable) + +## /descriptors/search/ + +* [Search Descriptor](./descriptors/search/searchdescriptor.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/searchdescriptor` (Stable) + +## /mixins/activity-type/ + +* [XDM Activity Type Details](./mixins/activity-type/activity-type-details.schema.md) – `https://ns.adobe.com/xdm/context/activity-type-details` (Experimental) + +## /mixins/activity-log/ + +* [XDM Business Activity Log details](./mixins/activity-log/activity-log-details.schema.md) – `https://ns.adobe.com/xdm/context/activity-log-details` (Experimental) + +## /mixins/account/ + +* [XDM Business Account](./mixins/account/account-crm.schema.md) – `https://ns.adobe.com/xdm/context/account-crm` (Experimental) + +## /mixins/experience-event/ + +* [Consumer ExperienceEvent mixin](./mixins/experience-event/experienceevent-consumer.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-consumer` (Stable) +* [Experience event privacy mixin](./mixins/experience-event/experienceevent-privacy.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-privacy` (Stable) +* [ExperienceEvent EndUserIDs](./mixins/experience-event/experienceevent-enduserids.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-enduserids` (Stable) +* [ExperienceEvent Segment Membership Details](./mixins/experience-event/experienceevent-segmentmembership.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-segmentmembership` (Stable) +* [ExperienceEvent application details](./mixins/experience-event/experienceevent-application.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-application` (Stable) +* [ExperienceEvent channel details](./mixins/experience-event/experienceevent-channel.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-channel` (Stable) +* [ExperienceEvent commerce details](./mixins/experience-event/experienceevent-commerce.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-commerce` (Stable) +* [ExperienceEvent details for advertising](./mixins/experience-event/experienceevent-advertising.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-advertising` (Stable) +* [ExperienceEvent details for marketing](./mixins/experience-event/experienceevent-marketing.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-marketing` (Stable) +* [ExperienceEvent details for media](./mixins/experience-event/experienceevent-media.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-media` (Stable) +* [ExperienceEvent details for search](./mixins/experience-event/experienceevent-search.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-search` (Stable) +* [ExperienceEvent direct marketing details](./mixins/experience-event/experienceevent-directmarketing.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-directmarketing` (Stable) +* [ExperienceEvent endUserIDs (deprecated)](./mixins/experience-event/experienceevent-enduserids-deprecated.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-enduserids-deprecated` (Deprecated) +* [ExperienceEvent environment details](./mixins/experience-event/experienceevent-environment-details.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-environment-details` (Stable) +* [ExperienceEvent implementation details](./mixins/experience-event/experienceevent-implementation-details.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-implementation-details` (Stable) +* [ExperienceEvent profile stitch details](./mixins/experience-event/experienceevent-profile-stitch.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-profile-stitch` (Stable) +* [ExperienceEvent technical details](./mixins/experience-event/experienceevent-technical-details.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-technical-details` (Stable) +* [ExperienceEvent web details](./mixins/experience-event/experienceevent-web.schema.md) – `https://ns.adobe.com/xdm/context/experienceevent-web` (Stable) + +## /mixins/campaign-member/ + +* [XDM Business Campaign Member Details](./mixins/campaign-member/campaign-member-details.schema.md) – `https://ns.adobe.com/xdm/context/campaign-member-details` (Experimental) + +## /mixins/opportunity/ + +* [B2B Opportunity Additional Properties](./mixins/opportunity/opportunity-crm.schema.md) – `https://ns.adobe.com/xdm/context/opportunity-crm` (Experimental) + +## /mixins/graphs/ + +* [XDM Graph Edge](./mixins/graphs/graph-edge.schema.md) – `https://ns.adobe.com/xdm/context/graph-edge` (Stable) +* [XDM Graph Node/Vertex Schema](./mixins/graphs/graph-node.schema.md) – `https://ns.adobe.com/xdm/context/graph-node` (Stable) +* [XDM Graph Schema](./mixins/graphs/graph.schema.md) – `https://ns.adobe.com/xdm/context/graph` (Stable) + +## /mixins/campaign-workflow/ + +* [XDM Business Campaign workflow](./mixins/campaign-workflow/campaign-workflow-details.schema.md) – `https://ns.adobe.com/xdm/context/campaign-workflow-details` (Experimental) + +## /mixins/opportunity-contact-role/ + +* [XDM Buying Group Additional Properties](./mixins/opportunity-contact-role/opportunity-contact-role-details.schema.md) – `https://ns.adobe.com/xdm/context/opportunity-contact-role-details` (Experimental) + +## /mixins/segment-definition/ + +* [Segment expression](./mixins/segment-definition/segmentdefinition-expression.schema.md) – `https://ns.adobe.com/xdm/context/segmentdefinition-expression` (Stable) + +## /mixins/profile/ + +* [Identities array for profile (deprecated)](./mixins/profile/profile-identities-deprecated.schema.md) – `https://ns.adobe.com/xdm/context/profile-identities-deprecated` (Deprecated) +* [Profile Other Work Details](./mixins/profile/profile-other-work-details.schema.md) – `https://ns.adobe.com/xdm/context/profile-other-work-details` (Experimental) +* [Profile Phones](./mixins/profile/profile-phones.schema.md) – `https://ns.adobe.com/xdm/context/profile-phones` (Experimental) +* [Profile direct marketing](./mixins/profile/profile-directmarketing.schema.md) – `https://ns.adobe.com/xdm/context/profile-directmarketing` (Stable) +* [Profile owning entity details](./mixins/profile/profile-owning-entities.schema.md) – `https://ns.adobe.com/xdm/context/profile-owning-entities` (Stable) +* [Profile person details](./mixins/profile/profile-person-details.schema.md) – `https://ns.adobe.com/xdm/context/profile-person-details` (Stable) +* [Profile personal details](./mixins/profile/profile-personal-details.schema.md) – `https://ns.adobe.com/xdm/context/profile-personal-details` (Stable) +* [Profile preferences details](./mixins/profile/profile-preferences-details.schema.md) – `https://ns.adobe.com/xdm/context/profile-preferences-details` (Stable) +* [Profile privacy](./mixins/profile/profile-privacy.schema.md) – `https://ns.adobe.com/xdm/context/profile-privacy` (Stable) +* [Profile push details](./mixins/profile/profile-push-details.schema.md) – `https://ns.adobe.com/xdm/context/profile-push-details` (Stable) +* [Profile segmentation](./mixins/profile/profile-segmentation.schema.md) – `https://ns.adobe.com/xdm/context/profile-segmentation` (Stable) +* [Profile subscriptions](./mixins/profile/profile-subscriptions.schema.md) – `https://ns.adobe.com/xdm/context/profile-subscriptions` (Stable) +* [Profile test details](./mixins/profile/profile-test-profile.schema.md) – `https://ns.adobe.com/xdm/context/profile-test-profile` (Stable) +* [Profile work details](./mixins/profile/profile-work-details.schema.md) – `https://ns.adobe.com/xdm/context/profile-work-details` (Stable) +* [Push notification details](./mixins/profile/profile-push-notification-details.schema.md) – `https://ns.adobe.com/xdm/context/profile-push-notification-details` (Stable) +* [XDM Business Contact](./mixins/profile/profile-contact-crm.schema.md) – `https://ns.adobe.com/xdm/context/profile-contact-crm` (Experimental) +* [XDM Business Lead ](./mixins/profile/profile-lead-crm.schema.md) – `https://ns.adobe.com/xdm/context/profile-lead-crm` (Experimental) + +## /mixins/shared/ + +* [External Source System Audit Details Mixin](./mixins/shared/external-source-system-audit-details.schema.md) – `https://ns.adobe.com/xdm/common/external-source-system-audit-details` (Stable) +* [IdentityMap](./mixins/shared/identitymap.schema.md) – `https://ns.adobe.com/xdm/context/identitymap` (Stable) + +## /datatypes/channels/ + +* [Application Channel](./datatypes/channels/application.schema.md) – `https://ns.adobe.com/xdm/channels/application` (Stable) +* [Experience Channel](./datatypes/channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel` (Stable) +* [Phone Channel](./datatypes/channels/phone.schema.md) – `https://ns.adobe.com/xdm/channels/phone` (Stable) + +## /datatypes/data/ + +* [Bounces](./datatypes/data/bounces.schema.md) – `https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces` (Stable) +* [Cart Abandons](./datatypes/data/cart-abandons.schema.md) – `https://ns.adobe.com/xdm/data/metrics/cart-abandons` (Stable) +* [Checkouts](./datatypes/data/checkouts.schema.md) – `https://ns.adobe.com/xdm/data/metrics/checkouts` (Stable) +* [Data Source](./datatypes/data/datasource.schema.md) – `https://ns.adobe.com/xdm/data/datasource` (Stable) +* [Impressions](./datatypes/data/impressions.schema.md) – `https://ns.adobe.com/xdm/data/metrics/advertising/impressions` (Stable) +* [Link-Clicks](./datatypes/data/linkclicks.schema.md) – `https://ns.adobe.com/xdm/data/metrics/web/linkclicks` (Stable) +* [Measure](./datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` (Stable) +* [Metric Definition](./datatypes/data/metricdefinition.schema.md) – `https://ns.adobe.com/xdm/data/metricdefinition` (Stable) +* [Mirror Pages](./datatypes/data/mirror-pages.schema.md) – `https://ns.adobe.com/xdm/data/metrics/direct-marketing/mirror-pages` (Stable) +* [Non-Deliverables](./datatypes/data/non-deliverables.schema.md) – `https://ns.adobe.com/xdm/data/metrics/direct-marketing/non-deliverables` (Stable) +* [Not Sent](./datatypes/data/not-sent.schema.md) – `https://ns.adobe.com/xdm/data/metrics/direct-marketing/notSent` (Stable) +* [Opens](./datatypes/data/opens.schema.md) – `https://ns.adobe.com/xdm/data/metrics/direct-marketing/opens` (Stable) +* [Order](./datatypes/data/order.schema.md) – `https://ns.adobe.com/xdm/data/order` (Stable) +* [Page Views](./datatypes/data/pageviews.schema.md) – `https://ns.adobe.com/xdm/data/metrics/web/pageviews` (Stable) +* [Payment Item](./datatypes/data/paymentitem.schema.md) – `https://ns.adobe.com/xdm/data/paymentitem` (Stable) +* [Point of Interest (POI) Entries](./datatypes/data/poi-entries.schema.md) – `https://ns.adobe.com/xdm/data/metrics/placecontext/poi-entries` (Stable) +* [Point of Interest (POI) Exits](./datatypes/data/poi-exits.schema.md) – `https://ns.adobe.com/xdm/data/metrics/placecontext/poi-exits` (Stable) +* [Product List Adds](./datatypes/data/product-list-adds.schema.md) – `https://ns.adobe.com/xdm/data/metrics/product-list-adds` (Stable) +* [Product List Opens](./datatypes/data/product-list-opens.schema.md) – `https://ns.adobe.com/xdm/data/metrics/product-list-opens` (Stable) +* [Product List Removals](./datatypes/data/product-list-removals.schema.md) – `https://ns.adobe.com/xdm/data/metrics/product-list-removals` (Stable) +* [Product List Reopens](./datatypes/data/product-list-reopens.schema.md) – `https://ns.adobe.com/xdm/data/metrics/product-list-reopens` (Stable) +* [Product List Views](./datatypes/data/product-list-views.schema.md) – `https://ns.adobe.com/xdm/data/metrics/product-list-views` (Stable) +* [Product Views](./datatypes/data/product-views.schema.md) – `https://ns.adobe.com/xdm/data/metrics/product-views` (Stable) +* [Purchases](./datatypes/data/purchases.schema.md) – `https://ns.adobe.com/xdm/data/metrics/purchases` (Stable) +* [Save For Laters](./datatypes/data/save-for-laters.schema.md) – `https://ns.adobe.com/xdm/data/metrics/save-for-laters` (Stable) +* [Sends](./datatypes/data/sends.schema.md) – `https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends` (Stable) +* [Time-series Extension for Record Data](./datatypes/data/record-timeseries-events.schema.md) – `https://ns.adobe.com/xdm/data/record-timeseries-events` (Stable) +* [Unsubscriptions](./datatypes/data/unsubscriptions.schema.md) – `https://ns.adobe.com/xdm/data/metrics/direct-marketing/unsubscriptions` (Stable) +* [User Complaints](./datatypes/data/user-complaints.schema.md) – `https://ns.adobe.com/xdm/data/metrics/direct-marketing/user-complaints` (Stable) + +## /datatypes/external/schema/ + +* [Geo Circle](./datatypes/external/schema/geocircle.schema.md) – `http://schema.org/GeoCircle` (Stable) +* [Geo Coordinates](./datatypes/external/schema/geocoordinates.schema.md) – `http://schema.org/GeoCoordinates` (Stable) +* [Geo Shape](./datatypes/external/schema/geoshape.schema.md) – `http://schema.org/GeoShape` (Stable) + +## /datatypes/external/repo/ + +* [Common Properties](./datatypes/external/repo/common.schema.md) – `http://ns.adobe.com/adobecloud/core/1.0` (Stable) + +## /datatypes/external/iptc/ + +* [Creator](./datatypes/external/iptc/creator.schema.md) – `http://www.iptc.org/creator` (Stable) +* [Episode](./datatypes/external/iptc/episode.schema.md) – `http://www.iptc.org/episode` (Stable) +* [Rating](./datatypes/external/iptc/rating.schema.md) – `http://www.iptc.org/rating` (Stable) +* [Season](./datatypes/external/iptc/season.schema.md) – `http://www.iptc.org/season` (Stable) +* [Series](./datatypes/external/iptc/series.schema.md) – `http://www.iptc.org/series` (Stable) + +## /datatypes/external/id3/ + +* [Audio](./datatypes/external/id3/audio.schema.md) – `https://id3.org/id3v2.4/audio` (Stable) + diff --git a/docs/reference/adobe/experience/aam-experienceevent.schema.json b/docs/reference/adobe/experience/aam-experienceevent.schema.json new file mode 100644 index 000000000..687ea92c0 --- /dev/null +++ b/docs/reference/adobe/experience/aam-experienceevent.schema.json @@ -0,0 +1,188 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/aam-experienceevent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Audience Manager Template Mixin", + "type": "object", + "description": "Adobe Audience Manager mixin for use with schemas for Solution data ingestion. Includes the core/standard ExperienceEvent as well as the other required core mixins.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership", + "https://ns.adobe.com/xdm/context/experienceevent-environment-details", + "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch", + "https://ns.adobe.com/experience/experienceevent-edgeregion", + "https://ns.adobe.com/xdm/context/experienceevent-privacy", + "https://ns.adobe.com/experience/audiencemanager/experienceevent-all" + ], + "definitions": { + "aam-experienceevent": { + "properties": {} + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch" + }, + { + "$ref": "https://ns.adobe.com/experience/experienceevent-edgeregion" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-privacy" + }, + { + "$ref": "https://ns.adobe.com/experience/audiencemanager/experienceevent-all" + }, + { + "$ref": "#/definitions/aam-experienceevent" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2394509340-30453470347" + } + ], + "https://data.adobe.io/entities/namespace/9": [ + { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" + } + ] + }, + "xdm:userActivityRegion": { + "xdm:dataCenterLocation": "VA6", + "xdm:captureTimestamp": "2017-09-26T15:52:20+00:00" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:profileStitch": [ + { + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "1.0", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/92312748749128" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/62312748749321" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" + } + ] + } + } + ], + "xdm:segmentMemberships": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + }, + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:version": "1.0", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "realized" + } + } + ], + "xdm:signals": { + "pageTagCloud": [ + "analytics", + "bigdata" + ], + "pagelinkshovered": [ + "http://abcxyzabcxyz.com", + "http://abcxyzabcxyz1.com" + ] + }, + "xdm:derivedSignals": { + "derivedPageTagCloud": [ + "aam" + ], + "derivedPagelinkshovered": [ + "https://jhdjdi09002kdjjsl.com" + ] + }, + "xdm:overwriteTraits": true, + "xdm:consentStrings": [ + { + "xdm:consentStandard": "IAB TCF", + "xdm:consentStandardVersion": "2.0", + "xdm:consentStringValue": "BObdrPUOevsguAfDqFENCNAAAAAmeAAA.PVAfDObdrA.DqFENCAmeAENCDA", + "xdm:gdprApplies": true, + "xdm:containsPersonalData": false + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/aam-experienceevent.schema.md b/docs/reference/adobe/experience/aam-experienceevent.schema.md new file mode 100644 index 000000000..4194202d4 --- /dev/null +++ b/docs/reference/adobe/experience/aam-experienceevent.schema.md @@ -0,0 +1,611 @@ + +# Adobe Audience Manager Template Mixin Schema + +``` +https://ns.adobe.com/experience/aam-experienceevent +``` + +Adobe Audience Manager mixin for use with schemas for Solution data ingestion. Includes the core/standard ExperienceEvent as well as the other required core mixins. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/aam-experienceevent.schema.json](adobe/experience/aam-experienceevent.schema.json) | +## Schema Hierarchy + +* Adobe Audience Manager Template Mixin `https://ns.adobe.com/experience/aam-experienceevent` + * [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-segmentmembership` + * [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-environment-details` + * [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-profile-stitch` + * [Data capture region for Experience Events](experienceevent-edgeregion.schema.md) `https://ns.adobe.com/experience/experienceevent-edgeregion` + * [Experience event privacy mixin](../../mixins/experience-event/experienceevent-privacy.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-privacy` + * [Adobe Audience Manager ExperienceEvent Full Extension](audiencemanager/experienceevent-all.schema.md) `https://ns.adobe.com/experience/audiencemanager/experienceevent-all` + + +## Adobe Audience Manager Template Mixin Example +```json +{ + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2394509340-30453470347" + } + ], + "https://data.adobe.io/entities/namespace/9": [ + { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" + } + ] + }, + "xdm:userActivityRegion": { + "xdm:dataCenterLocation": "VA6", + "xdm:captureTimestamp": "2017-09-26T15:52:20+00:00" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:profileStitch": [ + { + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "1.0", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/92312748749128" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/62312748749321" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" + } + ] + } + } + ], + "xdm:segmentMemberships": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + }, + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:version": "1.0", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "realized" + } + } + ], + "xdm:signals": { + "pageTagCloud": [ + "analytics", + "bigdata" + ], + "pagelinkshovered": [ + "http://abcxyzabcxyz.com", + "http://abcxyzabcxyz1.com" + ] + }, + "xdm:derivedSignals": { + "derivedPageTagCloud": [ + "aam" + ], + "derivedPagelinkshovered": [ + "https://jhdjdi09002kdjjsl.com" + ] + }, + "xdm:overwriteTraits": true, + "xdm:consentStrings": [ + { + "xdm:consentStandard": "IAB TCF", + "xdm:consentStandardVersion": "2.0", + "xdm:consentStringValue": "BObdrPUOevsguAfDqFENCNAAAAAmeAAA.PVAfDObdrA.DqFENCAmeAENCDA", + "xdm:gdprApplies": true, + "xdm:containsPersonalData": false + } + ] +} +``` + +# Adobe Audience Manager Template Mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:consentStrings](#xdmconsentstrings) | Consent String | Optional | [Experience event privacy mixin](../../mixins/experience-event/experienceevent-privacy.schema.md#xdmconsentstrings) | +| [xdm:derivedSignals](#xdmderivedsignals) | `object` | Optional | [Adobe Audience Manager ExperienceEvent Full Extension](audiencemanager/experienceevent-all.schema.md#xdmderivedsignals) | +| [xdm:device](#xdmdevice) | Device | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) | +| [xdm:environment](#xdmenvironment) | Environment | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) | +| [xdm:overwriteTraits](#xdmoverwritetraits) | `boolean` | Optional | [Adobe Audience Manager ExperienceEvent Full Extension](audiencemanager/experienceevent-all.schema.md#xdmoverwritetraits) | +| [xdm:placeContext](#xdmplacecontext) | Place context | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) | +| [xdm:profileStitch](#xdmprofilestitch) | Profile stitch | Optional | [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md#xdmprofilestitch) | +| [xdm:segmentMembership](#xdmsegmentmembership) | `object` | Optional | [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmembership) | +| [xdm:segmentMemberships](#xdmsegmentmemberships) | Segment membership item | Optional | [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) | +| [xdm:signals](#xdmsignals) | `object` | Optional | [Adobe Audience Manager ExperienceEvent Full Extension](audiencemanager/experienceevent-all.schema.md#xdmsignals) | +| [xdm:userActivityRegion](#xdmuseractivityregion) | `object` | Optional | [Data capture region for Experience Events](experienceevent-edgeregion.schema.md#xdmuseractivityregion) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:consentStrings +### Identity level consent information + +`xdm:consentStrings` +* is optional +* type: Consent String + +* defined in [Experience event privacy mixin](../../mixins/experience-event/experienceevent-privacy.schema.md#xdmconsentstrings) + +### xdm:consentStrings Type + + +Array type: Consent String + +All items must be of the type: +* [Consent String](../../datatypes/consentstring.schema.md) – `https://ns.adobe.com/xdm/context/consentstring` + + + + + + + + +## xdm:derivedSignals +### Derived Signals + +Derived properties from event data + +`xdm:derivedSignals` +* is optional +* type: `object` +* defined in [Adobe Audience Manager ExperienceEvent Full Extension](audiencemanager/experienceevent-all.schema.md#xdmderivedsignals) + +### xdm:derivedSignals Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:device +### Device + +An identified device, application or device browser instance that is trackable across sessions, normally by cookies. + +`xdm:device` +* is optional +* type: Device +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) + +### xdm:device Type + + +* [Device](../../datatypes/device.schema.md) – `https://ns.adobe.com/xdm/context/device` + + + + + +## xdm:environment +### Environment + +Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions. + +`xdm:environment` +* is optional +* type: Environment +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) + +### xdm:environment Type + + +* [Environment](../../datatypes/environment.schema.md) – `https://ns.adobe.com/xdm/context/environment` + + + + + +## xdm:overwriteTraits +### Overwrite Traits + +Flag highlighting that all the traits realized before this for this id and data source, need to be discarded. + +`xdm:overwriteTraits` +* is optional +* type: `boolean` +* defined in [Adobe Audience Manager ExperienceEvent Full Extension](audiencemanager/experienceevent-all.schema.md#xdmoverwritetraits) + +### xdm:overwriteTraits Type + + +`boolean` + + + + + +## xdm:placeContext +### Place context + +The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, and working hours. + +`xdm:placeContext` +* is optional +* type: Place context +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) + +### xdm:placeContext Type + + +* [Place context](../../datatypes/placecontext.schema.md) – `https://ns.adobe.com/xdm/context/placecontext` + + + + + +## xdm:profileStitch +### Profile stitch + +Details about the IDs that were joined by profile stitching. + +`xdm:profileStitch` +* is optional +* type: Profile stitch + +* defined in [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md#xdmprofilestitch) + +### xdm:profileStitch Type + + +Array type: Profile stitch + +All items must be of the type: +* [Profile stitch](../../datatypes/profilestitch.schema.md) – `https://ns.adobe.com/xdm/context/profileStitch` + + + + + + + + +## xdm:segmentMembership +### Segment Membership Map + +`xdm:segmentMembership` +* is optional +* type: `object` +* defined in [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmembership) + +### xdm:segmentMembership Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:segmentMemberships +### Segment Memberships + +The segments associated with this ExperienceEvent. Deprecated, use `xdm:segmentMembership` instead. + +`xdm:segmentMemberships` +* is optional +* type: Segment membership item + +* defined in [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) + +### xdm:segmentMemberships Type + + +Array type: Segment membership item + +All items must be of the type: +* [Segment membership item](../../datatypes/segmentmembershipitem.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembershipitem` + + + + + + + + +## xdm:signals +### Signals + +Additional frequently changing properties captured with an event via request parameters or other means. + +`xdm:signals` +* is optional +* type: `object` +* defined in [Adobe Audience Manager ExperienceEvent Full Extension](audiencemanager/experienceevent-all.schema.md#xdmsignals) + +### xdm:signals Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:userActivityRegion +### User activity region + +Region info where event is captured. + +`xdm:userActivityRegion` +* is optional +* type: `object` +* defined in [Data capture region for Experience Events](experienceevent-edgeregion.schema.md#xdmuseractivityregion) + +### xdm:userActivityRegion Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:captureTimestamp`| string | Optional | +| `xdm:dataCenterLocation`| string | Optional | + + + +#### xdm:captureTimestamp +##### Data Capture Timestamp + +The time when data was captured on data center node. + +`xdm:captureTimestamp` +* is optional +* type: `string` + +##### xdm:captureTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + +#### xdm:dataCenterLocation +##### Location of Data Center where data was captured + +undefined + +`xdm:dataCenterLocation` +* is optional +* type: `string` + +##### xdm:dataCenterLocation Type + + +`string` + + + +##### xdm:dataCenterLocation Known Values +| Value | Description | +|-------|-------------| +| `ARE1` | ARE1 | +| `ARE2` | ARE2 | +| `AUS1` | AUS1 | +| `AUS10` | AUS10 | +| `AUS2` | AUS2 | +| `AUS3` | AUS3 | +| `AUS4` | AUS4 | +| `AUS5` | AUS5 | +| `AUS6` | AUS6 | +| `AUS7` | AUS7 | +| `AUS8` | AUS8 | +| `AUS9` | AUS9 | +| `BEL1` | BEL1 | +| `BHR1` | BHR1 | +| `BRA2` | BRA2 | +| `BRA3` | BRA3 | +| `BRA4` | BRA4 | +| `CA1` | CA1 | +| `CA10` | CA10 | +| `CA12` | CA12 | +| `CA13` | CA13 | +| `CA14` | CA14 | +| `CA3` | CA3 | +| `CA4` | CA4 | +| `CA5` | CA5 | +| `CA6` | CA6 | +| `CA7` | CA7 | +| `CAN1` | CAN1 | +| `CAN2` | CAN2 | +| `CAN4` | CAN4 | +| `CAN5` | CAN5 | +| `CAN6` | CAN6 | +| `CAN7` | CAN7 | +| `CHE1` | CHE1 | +| `CHE2` | CHE2 | +| `CHE3` | CHE3 | +| `CHN1` | CHN1 | +| `CHN2` | CHN2 | +| `CHN3` | CHN3 | +| `CHN4` | CHN4 | +| `CHN5` | CHN5 | +| `CHN6` | CHN6 | +| `DEU1` | DEU1 | +| `DEU2` | DEU2 | +| `DEU4` | DEU4 | +| `DEU5` | DEU5 | +| `DEU6` | DEU6 | +| `DEU7` | DEU7 | +| `DNK1` | DNK1 | +| `FIN1` | FIN1 | +| `FRA10` | FRA10 | +| `FRA2` | FRA2 | +| `FRA3` | FRA3 | +| `FRA4` | FRA4 | +| `FRA5` | FRA5 | +| `FRA6` | FRA6 | +| `FRA7` | FRA7 | +| `FRA8` | FRA8 | +| `FRA9` | FRA9 | +| `GBR1` | GBR1 | +| `GBR10` | GBR10 | +| `GBR11` | GBR11 | +| `GBR12` | GBR12 | +| `GBR13` | GBR13 | +| `GBR5` | GBR5 | +| `GBR7` | GBR7 | +| `GBR8` | GBR8 | +| `GBR9` | GBR9 | +| `HKG1` | HKG1 | +| `HKG2` | HKG2 | +| `HKG3` | HKG3 | +| `HKG4` | HKG4 | +| `HKG5` | HKG5 | +| `IA1` | IA1 | +| `IA2` | IA2 | +| `IA3` | IA3 | +| `IA4` | IA4 | +| `IL1` | IL1 | +| `IND1` | IND1 | +| `IND2` | IND2 | +| `IND3` | IND3 | +| `IND4` | IND4 | +| `IND5` | IND5 | +| `IND6` | IND6 | +| `IRL1` | IRL1 | +| `IRL2` | IRL2 | +| `IRL3` | IRL3 | +| `JPN2` | JPN2 | +| `JPN3` | JPN3 | +| `JPN4` | JPN4 | +| `JPN5` | JPN5 | +| `JPN6` | JPN6 | +| `JPN7` | JPN7 | +| `JPN8` | JPN8 | +| `KOR1` | KOR1 | +| `KOR2` | KOR2 | +| `KOR3` | KOR3 | +| `MA1` | MA1 | +| `MA2` | MA2 | +| `MA3` | MA3 | +| `MDA1` | MDA1 | +| `NLD1` | NLD1 | +| `NLD2` | NLD2 | +| `NLD3` | NLD3 | +| `NLD4` | NLD4 | +| `NOR1` | NOR1 | +| `NOR2` | NOR2 | +| `NY7` | NY7 | +| `OH2` | OH2 | +| `OR1` | OR1 | +| `OR2` | OR2 | +| `OR3` | OR3 | +| `OR4` | OR4 | +| `ROU1` | ROU1 | +| `SC1` | SC1 | +| `SGP2` | SGP2 | +| `SGP3` | SGP3 | +| `SGP4` | SGP4 | +| `SGP5` | SGP5 | +| `SGP6` | SGP6 | +| `SGP7` | SGP7 | +| `SWE1` | SWE1 | +| `TWN1` | TWN1 | +| `TX3` | TX3 | +| `UT1` | UT1 | +| `UT2` | UT2 | +| `VA1` | VA1 | +| `VA10` | VA10 | +| `VA11` | VA11 | +| `VA12` | VA12 | +| `VA13` | VA13 | +| `VA14` | VA14 | +| `VA5` | VA5 | +| `VA6` | VA6 | +| `VA7` | VA7 | +| `VA8` | VA8 | +| `VA9` | VA9 | +| `WA1` | WA1 | +| `WA2` | WA2 | +| `WY1` | WY1 | +| `ZAF1` | ZAF1 | +| `ZAF2` | ZAF2 | + + + + + + + + diff --git a/docs/reference/adobe/experience/adcloud-experienceevent.schema.json b/docs/reference/adobe/experience/adcloud-experienceevent.schema.json new file mode 100644 index 000000000..a9aabba19 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud-experienceevent.schema.json @@ -0,0 +1,128 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/adcloud-experienceevent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Advertising Cloud ExperienceEvent Template Mixin", + "type": "object", + "description": "Adobe Advertising Cloud ExperienceEvent mixin for use with schemas for Solution data ingestion. Includes the core and standard ExperienceEvent as well as the required Adobe Advertising Cloud ExperienceEvent mixins.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/experienceevent-advertising", + "https://ns.adobe.com/xdm/context/experienceevent-application", + "https://ns.adobe.com/xdm/context/experienceevent-channel", + "https://ns.adobe.com/xdm/context/experienceevent-commerce", + "https://ns.adobe.com/xdm/context/experienceevent-directmarketing", + "https://ns.adobe.com/xdm/context/experienceevent-environment-details", + "https://ns.adobe.com/xdm/context/experienceevent-marketing", + "https://ns.adobe.com/xdm/context/experienceevent-media", + "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch", + "https://ns.adobe.com/xdm/context/experienceevent-search", + "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership", + "https://ns.adobe.com/xdm/context/experienceevent-technical-details", + "https://ns.adobe.com/xdm/context/experienceevent-web", + "https://ns.adobe.com/experience/adcloud/experienceevent-all", + "https://ns.adobe.com/experience/adcloud/creative-event", + "https://ns.adobe.com/experience/target/experienceevent-shared", + "https://ns.adobe.com/experience/profile/experienceevent-shared", + "https://ns.adobe.com/experience/implementations-ext", + "https://ns.adobe.com/xdm/context/experienceevent-enduserids" + ], + "definitions": { + "adcloud-experienceevent": { + "properties": {} + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-advertising" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-application" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-channel" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-commerce" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-directmarketing" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-marketing" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-media" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-search" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-technical-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-web" + }, + { + "$ref": "https://ns.adobe.com/experience/adcloud/experienceevent-all" + }, + { + "$ref": "https://ns.adobe.com/experience/adcloud/creative-event" + }, + { + "$ref": "https://ns.adobe.com/experience/target/experienceevent-shared" + }, + { + "$ref": "https://ns.adobe.com/experience/profile/experienceevent-shared" + }, + { + "$ref": "https://ns.adobe.com/experience/implementations-ext" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-enduserids" + }, + { + "$ref": "#/definitions/adcloud-experienceevent" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "id": "68519882713298129995549973016107434638", + "primary": true + } + ] + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud-experienceevent.schema.md b/docs/reference/adobe/experience/adcloud-experienceevent.schema.md new file mode 100644 index 000000000..384a3581a --- /dev/null +++ b/docs/reference/adobe/experience/adcloud-experienceevent.schema.md @@ -0,0 +1,751 @@ + +# Adobe Advertising Cloud ExperienceEvent Template Mixin Schema + +``` +https://ns.adobe.com/experience/adcloud-experienceevent +``` + +Adobe Advertising Cloud ExperienceEvent mixin for use with schemas for Solution data ingestion. Includes the core and standard ExperienceEvent as well as the required Adobe Advertising Cloud ExperienceEvent mixins. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/adcloud-experienceevent.schema.json](adobe/experience/adcloud-experienceevent.schema.json) | +## Schema Hierarchy + +* Adobe Advertising Cloud ExperienceEvent Template Mixin `https://ns.adobe.com/experience/adcloud-experienceevent` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [ExperienceEvent details for advertising](../../mixins/experience-event/experienceevent-advertising.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-advertising` + * [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-application` + * [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-channel` + * [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-commerce` + * [ExperienceEvent direct marketing details](../../mixins/experience-event/experienceevent-directmarketing.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-directmarketing` + * [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-environment-details` + * [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-marketing` + * [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-media` + * [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-profile-stitch` + * [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-search` + * [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-segmentmembership` + * [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-technical-details` + * [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-web` + * [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md) `https://ns.adobe.com/experience/adcloud/experienceevent-all` + * [Adobe Advertising Cloud Creative Management Platform Event Extension](adcloud/creative-event.schema.md) `https://ns.adobe.com/experience/adcloud/creative-event` + * [Adobe Target ExperienceEvent Shared Extension](target/experienceevent-shared.schema.md) `https://ns.adobe.com/experience/target/experienceevent-shared` + * [Adobe Unified Profile Service ExperienceEvent Shared Extension](profile/experienceevent-shared.schema.md) `https://ns.adobe.com/experience/profile/experienceevent-shared` + * [Adobe Experience Platform Implementation Details Mixin](implementations-ext.schema.md) `https://ns.adobe.com/experience/implementations-ext` + * [ExperienceEvent EndUserIDs](../../mixins/experience-event/experienceevent-enduserids.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-enduserids` + + +## Adobe Advertising Cloud ExperienceEvent Template Mixin Example +```json +{ + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "id": "68519882713298129995549973016107434638", + "primary": true + } + ] + } +} +``` + +# Adobe Advertising Cloud ExperienceEvent Template Mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/adcloud/adDeliveryDetails](#httpsnsadobecomexperienceadcloudaddeliverydetails) | Adobe Advertising Cloud Ad Delivery Details | Optional | [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudaddeliverydetails) | +| [https://ns.adobe.com/experience/adcloud/advertisement](#httpsnsadobecomexperienceadcloudadvertisement) | Adobe Advertising Cloud Ad Details | Optional | [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudadvertisement) | +| [https://ns.adobe.com/experience/adcloud/campaign](#httpsnsadobecomexperienceadcloudcampaign) | Ad Campaign Detail | Optional | [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudcampaign) | +| [https://ns.adobe.com/experience/adcloud/conversionDetails](#httpsnsadobecomexperienceadcloudconversiondetails) | Conversion Details | Optional | [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudconversiondetails) | +| [https://ns.adobe.com/experience/adcloud/creative](#httpsnsadobecomexperienceadcloudcreative) | Advertising Creative Management Platform Details | Optional | [Adobe Advertising Cloud Creative Management Platform Event Extension](adcloud/creative-event.schema.md#httpsnsadobecomexperienceadcloudcreative) | +| [https://ns.adobe.com/experience/adcloud/eventType](#httpsnsadobecomexperienceadcloudeventtype) | `string` | Optional | [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudeventtype) | +| [https://ns.adobe.com/experience/adcloud/fees](#httpsnsadobecomexperienceadcloudfees) | Advertising Fee Details | Optional | [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudfees) | +| [https://ns.adobe.com/experience/adcloud/inventory](#httpsnsadobecomexperienceadcloudinventory) | Adobe Advertising Cloud Inventory | Optional | [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudinventory) | +| [https://ns.adobe.com/experience/adcloud/productDetails](#httpsnsadobecomexperienceadcloudproductdetails) | Adobe Advertising Cloud Product Details displayed in Search Advertisement. | Optional | [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudproductdetails) | +| [https://ns.adobe.com/experience/adcloud/stitchId](#httpsnsadobecomexperienceadcloudstitchid) | `string` | Optional | [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudstitchid) | +| [https://ns.adobe.com/experience/implementations](#httpsnsadobecomexperienceimplementations) | Adobe Experience Platform Implementation Details | Optional | [Adobe Experience Platform Implementation Details Mixin](implementations-ext.schema.md#httpsnsadobecomexperienceimplementations) | +| [https://ns.adobe.com/experience/profile/originDatasetID](#httpsnsadobecomexperienceprofileorigindatasetid) | `string` | Optional | [Adobe Unified Profile Service ExperienceEvent Shared Extension](profile/experienceevent-shared.schema.md#httpsnsadobecomexperienceprofileorigindatasetid) | +| [https://ns.adobe.com/experience/target/supplementalDataID](#httpsnsadobecomexperiencetargetsupplementaldataid) | `string` | Optional | [Adobe Target ExperienceEvent Shared Extension](target/experienceevent-shared.schema.md#httpsnsadobecomexperiencetargetsupplementaldataid) | +| [xdm:advertising](#xdmadvertising) | Advertising | Optional | [ExperienceEvent details for advertising](../../mixins/experience-event/experienceevent-advertising.schema.md#xdmadvertising) | +| [xdm:application](#xdmapplication) | Application | Optional | [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md#xdmapplication) | +| [xdm:channel](#xdmchannel) | Experience Channel | Optional | [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md#xdmchannel) | +| [xdm:commerce](#xdmcommerce) | Commerce | Optional | [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmcommerce) | +| [xdm:dataSource](#xdmdatasource) | Data Source | Optional | [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmdatasource) | +| [xdm:device](#xdmdevice) | Device | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) | +| [xdm:directMarketing](#xdmdirectmarketing) | Direct marketing | Optional | [ExperienceEvent direct marketing details](../../mixins/experience-event/experienceevent-directmarketing.schema.md#xdmdirectmarketing) | +| [xdm:endUserIDs](#xdmenduserids) | End user IDs | Optional | [ExperienceEvent EndUserIDs](../../mixins/experience-event/experienceevent-enduserids.schema.md#xdmenduserids) | +| [xdm:environment](#xdmenvironment) | Environment | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) | +| [xdm:eventMergeId](#xdmeventmergeid) | `string` | Optional | [Adobe Advertising Cloud Creative Management Platform Event Extension](adcloud/creative-event.schema.md#xdmeventmergeid) | +| [xdm:marketing](#xdmmarketing) | Marketing | Optional | [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md#xdmmarketing) | +| [xdm:media](#xdmmedia) | Media information | Optional | [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md#xdmmedia) | +| [xdm:placeContext](#xdmplacecontext) | Place context | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) | +| [xdm:productListItems](#xdmproductlistitems) | Product list item | Optional | [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmproductlistitems) | +| [xdm:profileStitch](#xdmprofilestitch) | Profile stitch | Optional | [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md#xdmprofilestitch) | +| [xdm:receivedTimestamp](#xdmreceivedtimestamp) | `string` | Optional | [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmreceivedtimestamp) | +| [xdm:search](#xdmsearch) | Search | Optional | [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md#xdmsearch) | +| [xdm:segmentMembership](#xdmsegmentmembership) | `object` | Optional | [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmembership) | +| [xdm:segmentMemberships](#xdmsegmentmemberships) | Segment membership item | Optional | [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) | +| [xdm:web](#xdmweb) | Web information | Optional | [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md#xdmweb) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/adcloud/adDeliveryDetails +### Ad Delivery Details + +Adobe AdCloud Search Ad Delivery Details. + +`https://ns.adobe.com/experience/adcloud/adDeliveryDetails` +* is optional +* type: Adobe Advertising Cloud Ad Delivery Details +* defined in [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudaddeliverydetails) + +### https://ns.adobe.com/experience/adcloud/adDeliveryDetails Type + + +* [Adobe Advertising Cloud Ad Delivery Details](adcloud/addeliverydetails.schema.md) – `https://ns.adobe.com/experience/adcloud/addeliverydetails` + + + + + +## https://ns.adobe.com/experience/adcloud/advertisement +### Ad Asset Details + +Digital advertisement details. + +`https://ns.adobe.com/experience/adcloud/advertisement` +* is optional +* type: Adobe Advertising Cloud Ad Details +* defined in [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudadvertisement) + +### https://ns.adobe.com/experience/adcloud/advertisement Type + + +* [Adobe Advertising Cloud Ad Details](adcloud/advertisement.schema.md) – `https://ns.adobe.com/experience/adcloud/advertisement` + + + + + +## https://ns.adobe.com/experience/adcloud/campaign +### Ad Campaign Details + +Adobe Advertising Cloud ad campaign hierarchy details. + +`https://ns.adobe.com/experience/adcloud/campaign` +* is optional +* type: Ad Campaign Detail +* defined in [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudcampaign) + +### https://ns.adobe.com/experience/adcloud/campaign Type + + +* [Ad Campaign Detail](adcloud/campaign.schema.md) – `https://ns.adobe.com/experience/adcloud/campaign` + + + + + +## https://ns.adobe.com/experience/adcloud/conversionDetails +### Ad Conversion Details + +Search Ad Conversion Details. + +`https://ns.adobe.com/experience/adcloud/conversionDetails` +* is optional +* type: Conversion Details +* defined in [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudconversiondetails) + +### https://ns.adobe.com/experience/adcloud/conversionDetails Type + + +* [Conversion Details](adcloud/conversiondetails.schema.md) – `https://ns.adobe.com/experience/adcloud/conversiondetails` + + + + + +## https://ns.adobe.com/experience/adcloud/creative +### Advertising Creative Management Platform Details + +Advertising Creative Management Platform Details. + +`https://ns.adobe.com/experience/adcloud/creative` +* is optional +* type: Advertising Creative Management Platform Details +* defined in [Adobe Advertising Cloud Creative Management Platform Event Extension](adcloud/creative-event.schema.md#httpsnsadobecomexperienceadcloudcreative) + +### https://ns.adobe.com/experience/adcloud/creative Type + + +* [Advertising Creative Management Platform Details](adcloud/creative.schema.md) – `https://ns.adobe.com/experience/adcloud/creative` + + + + + +## https://ns.adobe.com/experience/adcloud/eventType +### Event Type + +Adobe Advertising Cloud event type. + +`https://ns.adobe.com/experience/adcloud/eventType` +* is optional +* type: `string` +* defined in [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudeventtype) + +### https://ns.adobe.com/experience/adcloud/eventType Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/adcloud/fees +### Advertising Fees + +Advertising Fees Details. + +`https://ns.adobe.com/experience/adcloud/fees` +* is optional +* type: Advertising Fee Details +* defined in [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudfees) + +### https://ns.adobe.com/experience/adcloud/fees Type + + +* [Advertising Fee Details](adcloud/fees.schema.md) – `https://ns.adobe.com/experience/adcloud/fees` + + + + + +## https://ns.adobe.com/experience/adcloud/inventory +### Ad Inventory Details + +Adobe Advertising Cloud inventory details. + +`https://ns.adobe.com/experience/adcloud/inventory` +* is optional +* type: Adobe Advertising Cloud Inventory +* defined in [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudinventory) + +### https://ns.adobe.com/experience/adcloud/inventory Type + + +* [Adobe Advertising Cloud Inventory](adcloud/inventory.schema.md) – `https://ns.adobe.com/experience/adcloud/inventory` + + + + + +## https://ns.adobe.com/experience/adcloud/productDetails +### Ad Product Details + +Adobe AdCloud Search Ad Product Details. + +`https://ns.adobe.com/experience/adcloud/productDetails` +* is optional +* type: Adobe Advertising Cloud Product Details displayed in Search Advertisement. +* defined in [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudproductdetails) + +### https://ns.adobe.com/experience/adcloud/productDetails Type + + +* [Adobe Advertising Cloud Product Details displayed in Search Advertisement.](adcloud/productdetails.schema.md) – `https://ns.adobe.com/experience/adcloud/productdetails` + + + + + +## https://ns.adobe.com/experience/adcloud/stitchId +### Stitch ID Chosen + +ID from the ad servers through Adobe Advertising Cloud STATS to track click-through conversion on browsers that block third party cookies. + +`https://ns.adobe.com/experience/adcloud/stitchId` +* is optional +* type: `string` +* defined in [Adobe Advertising Cloud ExperienceEvent Full Extension](adcloud/experienceevent-all.schema.md#httpsnsadobecomexperienceadcloudstitchid) + +### https://ns.adobe.com/experience/adcloud/stitchId Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/implementations + + +`https://ns.adobe.com/experience/implementations` +* is optional +* type: Adobe Experience Platform Implementation Details +* defined in [Adobe Experience Platform Implementation Details Mixin](implementations-ext.schema.md#httpsnsadobecomexperienceimplementations) + +### https://ns.adobe.com/experience/implementations Type + + +* [Adobe Experience Platform Implementation Details](implementations.schema.md) – `https://ns.adobe.com/experience/implementations` + + + + + +## https://ns.adobe.com/experience/profile/originDatasetID +### Origin Dataset ID + +Identity of the dataset that the Unified Profile Service ingested the data from. Usage is reserved for the Unified Profile Service. + +`https://ns.adobe.com/experience/profile/originDatasetID` +* is optional +* type: `string` +* defined in [Adobe Unified Profile Service ExperienceEvent Shared Extension](profile/experienceevent-shared.schema.md#httpsnsadobecomexperienceprofileorigindatasetid) + +### https://ns.adobe.com/experience/profile/originDatasetID Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/supplementalDataID +### Supplemental Data Identifier + +Identifier used to stitch Target events with Analytics events + +`https://ns.adobe.com/experience/target/supplementalDataID` +* is optional +* type: `string` +* defined in [Adobe Target ExperienceEvent Shared Extension](target/experienceevent-shared.schema.md#httpsnsadobecomexperiencetargetsupplementaldataid) + +### https://ns.adobe.com/experience/target/supplementalDataID Type + + +`string` + + + + + + +## xdm:advertising +### Advertising + +Information related to advertising activity in ExperienceEvents. + +`xdm:advertising` +* is optional +* type: Advertising +* defined in [ExperienceEvent details for advertising](../../mixins/experience-event/experienceevent-advertising.schema.md#xdmadvertising) + +### xdm:advertising Type + + +* [Advertising](../../datatypes/advertising.schema.md) – `https://ns.adobe.com/xdm/context/advertising` + + + + + +## xdm:application +### Application + +This mixin is used to capture application information related to an ExperienceEvent, including the name of the application, app version, installs, launches, crashes, and closures. It could be either the application targeted by the event like the send of a push notification or the application originating the event such as a click, or a login. + +`xdm:application` +* is optional +* type: Application +* defined in [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md#xdmapplication) + +### xdm:application Type + + +* [Application](../../datatypes/application.schema.md) – `https://ns.adobe.com/xdm/context/application` + + + + + +## xdm:channel +### Experience channel + +Experience channel related to the ExperienceEvent. + +`xdm:channel` +* is optional +* type: Experience Channel +* defined in [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md#xdmchannel) + +### xdm:channel Type + + +* [Experience Channel](../../datatypes/channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel` + + + + + +## xdm:commerce +### Commerce + +Commerce specific data related to this event. + +`xdm:commerce` +* is optional +* type: Commerce +* defined in [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmcommerce) + +### xdm:commerce Type + + +* [Commerce](../../datatypes/commerce.schema.md) – `https://ns.adobe.com/xdm/context/commerce` + + + + + +## xdm:dataSource +### Data source + +Globally unique identification of a data source. + +`xdm:dataSource` +* is optional +* type: Data Source +* defined in [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmdatasource) + +### xdm:dataSource Type + + +* [Data Source](../../datatypes/data/datasource.schema.md) – `https://ns.adobe.com/xdm/data/datasource` + + + + + +## xdm:device +### Device + +An identified device, application or device browser instance that is trackable across sessions, normally by cookies. + +`xdm:device` +* is optional +* type: Device +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) + +### xdm:device Type + + +* [Device](../../datatypes/device.schema.md) – `https://ns.adobe.com/xdm/context/device` + + + + + +## xdm:directMarketing +### Direct marketing + +Events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications. + +`xdm:directMarketing` +* is optional +* type: Direct marketing +* defined in [ExperienceEvent direct marketing details](../../mixins/experience-event/experienceevent-directmarketing.schema.md#xdmdirectmarketing) + +### xdm:directMarketing Type + + +* [Direct marketing](../../datatypes/direct-marketing.schema.md) – `https://ns.adobe.com/xdm/context/direct-marketing` + + + + + +## xdm:endUserIDs +### EndUserIDs + +Condensed, normalized encapsulation of end user identifiers asserted for this ExperienceEvent. + +`xdm:endUserIDs` +* is optional +* type: End user IDs +* defined in [ExperienceEvent EndUserIDs](../../mixins/experience-event/experienceevent-enduserids.schema.md#xdmenduserids) + +### xdm:endUserIDs Type + + +* [End user IDs](../../datatypes/enduserids.schema.md) – `https://ns.adobe.com/xdm/context/enduserids` + + + + + +## xdm:environment +### Environment + +Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions. + +`xdm:environment` +* is optional +* type: Environment +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) + +### xdm:environment Type + + +* [Environment](../../datatypes/environment.schema.md) – `https://ns.adobe.com/xdm/context/environment` + + + + + +## xdm:eventMergeId +### ExperienceEvent merge ID + +An ID to correlate or merge multiple Experience events together that are essentially the same event or should be merged. This is intended to be populated by the data producer prior to ingestion. + +`xdm:eventMergeId` +* is optional +* type: `string` +* defined in [Adobe Advertising Cloud Creative Management Platform Event Extension](adcloud/creative-event.schema.md#xdmeventmergeid) + +### xdm:eventMergeId Type + + +`string` + + + + + + +## xdm:marketing +### Marketing + +The information related to marketing activities that are active with the touchpoint. + +`xdm:marketing` +* is optional +* type: Marketing +* defined in [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md#xdmmarketing) + +### xdm:marketing Type + + +* [Marketing](../../datatypes/marketing.schema.md) – `https://ns.adobe.com/xdm/context/marketing` + + + + + +## xdm:media +### Media + +Media activity information related to the experience event. + +`xdm:media` +* is optional +* type: Media information +* defined in [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md#xdmmedia) + +### xdm:media Type + + +* [Media information](../../datatypes/media.schema.md) – `https://ns.adobe.com/xdm/context/media` + + + + + +## xdm:placeContext +### Place context + +The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, and working hours. + +`xdm:placeContext` +* is optional +* type: Place context +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) + +### xdm:placeContext Type + + +* [Place context](../../datatypes/placecontext.schema.md) – `https://ns.adobe.com/xdm/context/placecontext` + + + + + +## xdm:productListItems +### Product list items + +A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record. + +`xdm:productListItems` +* is optional +* type: Product list item + +* defined in [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmproductlistitems) + +### xdm:productListItems Type + + +Array type: Product list item + +All items must be of the type: +* [Product list item](../../datatypes/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem` + + + + + + + + +## xdm:profileStitch +### Profile stitch + +Details about the IDs that were joined by profile stitching. + +`xdm:profileStitch` +* is optional +* type: Profile stitch + +* defined in [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md#xdmprofilestitch) + +### xdm:profileStitch Type + + +Array type: Profile stitch + +All items must be of the type: +* [Profile stitch](../../datatypes/profilestitch.schema.md) – `https://ns.adobe.com/xdm/context/profileStitch` + + + + + + + + +## xdm:receivedTimestamp +### Received time stamp + +The time at which this interaction was received by a server. + +`xdm:receivedTimestamp` +* is optional +* type: `string` +* defined in [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmreceivedtimestamp) + +### xdm:receivedTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:search +### Search + +The information related to web or mobile search. + +`xdm:search` +* is optional +* type: Search +* defined in [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md#xdmsearch) + +### xdm:search Type + + +* [Search](../../datatypes/search.schema.md) – `https://ns.adobe.com/xdm/context/search` + + + + + +## xdm:segmentMembership +### Segment Membership Map + +`xdm:segmentMembership` +* is optional +* type: `object` +* defined in [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmembership) + +### xdm:segmentMembership Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:segmentMemberships +### Segment Memberships + +The segments associated with this ExperienceEvent. Deprecated, use `xdm:segmentMembership` instead. + +`xdm:segmentMemberships` +* is optional +* type: Segment membership item + +* defined in [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) + +### xdm:segmentMemberships Type + + +Array type: Segment membership item + +All items must be of the type: +* [Segment membership item](../../datatypes/segmentmembershipitem.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembershipitem` + + + + + + + + +## xdm:web +### Web + +The information related to web page and link of the ExperienceEvent. + +`xdm:web` +* is optional +* type: Web information +* defined in [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md#xdmweb) + +### xdm:web Type + + +* [Web information](../../datatypes/webinfo.schema.md) – `https://ns.adobe.com/xdm/context/webinfo` + + + + diff --git a/docs/reference/adobe/experience/adcloud-profile.schema.json b/docs/reference/adobe/experience/adcloud-profile.schema.json new file mode 100644 index 000000000..9e4c8dc84 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud-profile.schema.json @@ -0,0 +1,104 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/adcloud-profile", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Advertising Cloud Profile Template Mixin", + "type": "object", + "description": "Adobe Advertising Cloud profile mixin for use with schemas for Solution data ingestion. Includes the core and standard profile as well as the required Adobe Advertising Cloud profile mixins.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/profile-segmentation", + "https://ns.adobe.com/experience/adcloud/profile-all" + ], + "definitions": { + "adcloud-profile": { + "properties": {} + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-segmentation" + }, + { + "$ref": "https://ns.adobe.com/experience/adcloud/profile-all" + }, + { + "$ref": "#/definitions/adcloud-profile" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:segments": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "15", + "xdm:timestamp": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2019-04-26T15:52:25+00:00", + "xdm:status": "existing" + }, + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/53cba6b2-a23b-454a-8069-fc41308f1c0f", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "3", + "xdm:lastQualificationTime": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2018-04-27T15:52:25+00:00", + "xdm:status": "realized" + } + ], + "xdm:syncedRemarketingAudiences": [ + { + "xdm:segmentID": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9", + "xdm:segmentType": 3, + "xdm:timestamp": "2018-08-07T08:06:34.672Z", + "xdm:partnerDetails": [ + { + "xdm:id": "2", + "xdm:data": "sample-conversion-id-123" + }, + { + "xdm:id": "1", + "xdm:data": "sample-conversion-id-124" + } + ] + }, + { + "xdm:segmentID": "https://data.adobe.io/entities/segmentidentity/53cba6b2-a23b-454a-8069-fc41308f1c0f", + "xdm:segmentType": 3, + "xdm:timestamp": "2018-08-07T08:06:34.672Z", + "xdm:partnerDetails": [ + { + "xdm:id": "2", + "xdm:data": "sample-conversion-id-125" + }, + { + "xdm:id": "1", + "xdm:data": "sample-conversion-id-126" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud-profile.schema.md b/docs/reference/adobe/experience/adcloud-profile.schema.md new file mode 100644 index 000000000..9b117511c --- /dev/null +++ b/docs/reference/adobe/experience/adcloud-profile.schema.md @@ -0,0 +1,164 @@ + +# Adobe Advertising Cloud Profile Template Mixin Schema + +``` +https://ns.adobe.com/experience/adcloud-profile +``` + +Adobe Advertising Cloud profile mixin for use with schemas for Solution data ingestion. Includes the core and standard profile as well as the required Adobe Advertising Cloud profile mixins. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/adcloud-profile.schema.json](adobe/experience/adcloud-profile.schema.json) | +## Schema Hierarchy + +* Adobe Advertising Cloud Profile Template Mixin `https://ns.adobe.com/experience/adcloud-profile` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Profile segmentation](../../mixins/profile/profile-segmentation.schema.md) `https://ns.adobe.com/xdm/context/profile-segmentation` + * [Adobe Advertising Cloud Profile Full Extension](adcloud/profile-all.schema.md) `https://ns.adobe.com/experience/adcloud/profile-all` + + +## Adobe Advertising Cloud Profile Template Mixin Example +```json +{ + "xdm:segments": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "15", + "xdm:timestamp": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2019-04-26T15:52:25+00:00", + "xdm:status": "existing" + }, + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/53cba6b2-a23b-454a-8069-fc41308f1c0f", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "3", + "xdm:lastQualificationTime": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2018-04-27T15:52:25+00:00", + "xdm:status": "realized" + } + ], + "xdm:syncedRemarketingAudiences": [ + { + "xdm:segmentID": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9", + "xdm:segmentType": 3, + "xdm:timestamp": "2018-08-07T08:06:34.672Z", + "xdm:partnerDetails": [ + { + "xdm:id": "2", + "xdm:data": "sample-conversion-id-123" + }, + { + "xdm:id": "1", + "xdm:data": "sample-conversion-id-124" + } + ] + }, + { + "xdm:segmentID": "https://data.adobe.io/entities/segmentidentity/53cba6b2-a23b-454a-8069-fc41308f1c0f", + "xdm:segmentType": 3, + "xdm:timestamp": "2018-08-07T08:06:34.672Z", + "xdm:partnerDetails": [ + { + "xdm:id": "2", + "xdm:data": "sample-conversion-id-125" + }, + { + "xdm:id": "1", + "xdm:data": "sample-conversion-id-126" + } + ] + } + ] +} +``` + +# Adobe Advertising Cloud Profile Template Mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:segmentMembership](#xdmsegmentmembership) | `object` | Optional | [Profile segmentation](../../mixins/profile/profile-segmentation.schema.md#xdmsegmentmembership) | +| [xdm:segments](#xdmsegments) | Segment membership | Optional | [Profile segmentation](../../mixins/profile/profile-segmentation.schema.md#xdmsegments) | +| [xdm:syncedRemarketingAudiences](#xdmsyncedremarketingaudiences) | Synchronized Remarketing Audiences | Optional | [Adobe Advertising Cloud Profile Full Extension](adcloud/profile-all.schema.md#xdmsyncedremarketingaudiences) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:segmentMembership +### Segment membership map + +`xdm:segmentMembership` +* is optional +* type: `object` +* defined in [Profile segmentation](../../mixins/profile/profile-segmentation.schema.md#xdmsegmentmembership) + +### xdm:segmentMembership Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:segments +### Segment membership + +`xdm:segments` +* is optional +* type: Segment membership + +* defined in [Profile segmentation](../../mixins/profile/profile-segmentation.schema.md#xdmsegments) + +### xdm:segments Type + + +Array type: Segment membership + +All items must be of the type: +* [Segment membership](../../datatypes/segmentmembership.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembership` + + + + + + + + +## xdm:syncedRemarketingAudiences +### Synchronized Segments + +List of search retargeting entities that have been synced with the Adobe Advertising Cloud partner to build audiences on the platform, e.g. RLSA for Google, WCA for Facebook. + +`xdm:syncedRemarketingAudiences` +* is optional +* type: Synchronized Remarketing Audiences + +* defined in [Adobe Advertising Cloud Profile Full Extension](adcloud/profile-all.schema.md#xdmsyncedremarketingaudiences) + +### xdm:syncedRemarketingAudiences Type + + +Array type: Synchronized Remarketing Audiences + +All items must be of the type: +* [Synchronized Remarketing Audiences](adcloud/syncedremarketingaudience.schema.md) – `https://ns.adobe.com/experience/adcloud/syncedremarketingaudience` + + + + + + + diff --git a/docs/reference/adobe/experience/adcloud/adcloudsegment.schema.json b/docs/reference/adobe/experience/adcloud/adcloudsegment.schema.json new file mode 100644 index 000000000..8087b638b --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/adcloudsegment.schema.json @@ -0,0 +1,68 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/adcloud/adcloudsegment", + "title": "Adobe Advertising Cloud Audience Segment Details", + "type": "object", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record", + "https://ns.adobe.com/xdm/common/auditable", + "https://ns.adobe.com/xdm/context/segmentdefinition" + ], + "description": "Adobe Advertising Cloud segmentation traits.", + "definitions": { + "adcloudsegment": { + "properties": { + "xdm:targeted": { + "title": "Targeted", + "type": "boolean", + "description": "Indicates if the user segment was targeted with the ad." + }, + "xdm:partnerId": { + "title": "Attributable Partner ID", + "type": "string", + "description": "The segment provider who owns the user segment." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/segmentdefinition" + }, + { + "$ref": "#/definitions/adcloudsegment" + } + ], + "examples": [ + { + "xdm:identityMap": { + "AdCloudSegments": [ + { + "xdm:id": "112233", + "xdm:primary": true + } + ] + }, + "xdm:segmentName": "Users with TV segment", + "xdm:description": "Segment is about users who have TV", + "xdm:segmentStatus": "ACTIVE", + "repo:createDate": "2018-10-23T12:00:00-06:00", + "repo:modifyDate": "2019-03-21T12:00:00-06:00", + "xdm:targeted": true, + "xdm:partnerId": "10" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/adcloudsegment.schema.md b/docs/reference/adobe/experience/adcloud/adcloudsegment.schema.md new file mode 100644 index 000000000..5e3c41706 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/adcloudsegment.schema.md @@ -0,0 +1,353 @@ + +# Adobe Advertising Cloud Audience Segment Details Schema + +``` +https://ns.adobe.com/experience/adcloud/adcloudsegment +``` + +Adobe Advertising Cloud segmentation traits. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/adcloud/adcloudsegment.schema.json](adobe/experience/adcloud/adcloudsegment.schema.json) | +## Schema Hierarchy + +* Adobe Advertising Cloud Audience Segment Details `https://ns.adobe.com/experience/adcloud/adcloudsegment` + * [Audit trail](../../../datatypes/auditable.schema.md) `https://ns.adobe.com/xdm/common/auditable` + * [Record Schema](../../../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + * [Segment definition](../../../classes/segmentdefinition.schema.md) `https://ns.adobe.com/xdm/context/segmentdefinition` + + +## Adobe Advertising Cloud Audience Segment Details Example +```json +{ + "xdm:identityMap": { + "AdCloudSegments": [ + { + "xdm:id": "112233", + "xdm:primary": true + } + ] + }, + "xdm:segmentName": "Users with TV segment", + "xdm:description": "Segment is about users who have TV", + "xdm:segmentStatus": "ACTIVE", + "repo:createDate": "2018-10-23T12:00:00-06:00", + "repo:modifyDate": "2019-03-21T12:00:00-06:00", + "xdm:targeted": true, + "xdm:partnerId": "10" +} +``` + +# Adobe Advertising Cloud Audience Segment Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../../../behaviors/record.schema.md#id) | +| [repo:createDate](#repocreatedate) | `string` | Optional | [Audit trail](../../../datatypes/auditable.schema.md#repocreatedate) | +| [repo:modifyDate](#repomodifydate) | `string` | Optional | [Audit trail](../../../datatypes/auditable.schema.md#repomodifydate) | +| [xdm:createdByBatchID](#xdmcreatedbybatchid) | `string` | Optional | [Audit trail](../../../datatypes/auditable.schema.md#xdmcreatedbybatchid) | +| [xdm:description](#xdmdescription) | `string` | Optional | [Segment definition](../../../classes/segmentdefinition.schema.md#xdmdescription) | +| [xdm:modifiedByBatchID](#xdmmodifiedbybatchid) | `string` | Optional | [Audit trail](../../../datatypes/auditable.schema.md#xdmmodifiedbybatchid) | +| [xdm:partnerId](#xdmpartnerid) | `string` | Optional | Adobe Advertising Cloud Audience Segment Details (this schema) | +| [xdm:repositoryCreatedBy](#xdmrepositorycreatedby) | `string` | Optional | [Audit trail](../../../datatypes/auditable.schema.md#xdmrepositorycreatedby) | +| [xdm:repositoryLastModifiedBy](#xdmrepositorylastmodifiedby) | `string` | Optional | [Audit trail](../../../datatypes/auditable.schema.md#xdmrepositorylastmodifiedby) | +| [xdm:segmentIdentity](#xdmsegmentidentity) | Segment identity | Optional | [Segment definition](../../../classes/segmentdefinition.schema.md#xdmsegmentidentity) | +| [xdm:segmentName](#xdmsegmentname) | `string` | Optional | [Segment definition](../../../classes/segmentdefinition.schema.md#xdmsegmentname) | +| [xdm:segmentStatus](#xdmsegmentstatus) | `enum` | Optional | [Segment definition](../../../classes/segmentdefinition.schema.md#xdmsegmentstatus) | +| [xdm:targeted](#xdmtargeted) | `boolean` | Optional | Adobe Advertising Cloud Audience Segment Details (this schema) | +| [xdm:version](#xdmversion) | `string` | Optional | [Segment definition](../../../classes/segmentdefinition.schema.md#xdmversion) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../../../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## repo:createDate + +The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:createDate` +* is optional +* type: `string` +* defined in [Audit trail](../../../datatypes/auditable.schema.md#repocreatedate) + +### repo:createDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:createDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## repo:modifyDate + +The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:modifyDate` +* is optional +* type: `string` +* defined in [Audit trail](../../../datatypes/auditable.schema.md#repomodifydate) + +### repo:modifyDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:modifyDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## xdm:createdByBatchID +### Created by batch identifier + +The dataset files in Catalog which has been originating the creation of the record. + +`xdm:createdByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](../../../datatypes/auditable.schema.md#xdmcreatedbybatchid) + +### xdm:createdByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:description +### Segment description + +Description of the segment. + +`xdm:description` +* is optional +* type: `string` +* defined in [Segment definition](../../../classes/segmentdefinition.schema.md#xdmdescription) + +### xdm:description Type + + +`string` + + + + + + +## xdm:modifiedByBatchID +### Modified by batch identifier + +The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`. + +`xdm:modifiedByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](../../../datatypes/auditable.schema.md#xdmmodifiedbybatchid) + +### xdm:modifiedByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:partnerId +### Attributable Partner ID + +The segment provider who owns the user segment. + +`xdm:partnerId` +* is optional +* type: `string` +* defined in this schema + +### xdm:partnerId Type + + +`string` + + + + + + +## xdm:repositoryCreatedBy +### Created by user identifier + +User ID of who created the record. + +`xdm:repositoryCreatedBy` +* is optional +* type: `string` +* defined in [Audit trail](../../../datatypes/auditable.schema.md#xdmrepositorycreatedby) + +### xdm:repositoryCreatedBy Type + + +`string` + + + + + + +## xdm:repositoryLastModifiedBy +### Modified by user identifier + +User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`. + +`xdm:repositoryLastModifiedBy` +* is optional +* type: `string` +* defined in [Audit trail](../../../datatypes/auditable.schema.md#xdmrepositorylastmodifiedby) + +### xdm:repositoryLastModifiedBy Type + + +`string` + + + + + + +## xdm:segmentIdentity +### Segment identity + +Identity of the segment. + +`xdm:segmentIdentity` +* is optional +* type: Segment identity +* defined in [Segment definition](../../../classes/segmentdefinition.schema.md#xdmsegmentidentity) + +### xdm:segmentIdentity Type + + +* [Segment identity](../../../datatypes/segmentidentity.schema.md) – `https://ns.adobe.com/xdm/context/segmentidentity` + + + + + +## xdm:segmentName +### Segment name + +Name of the segment. + +`xdm:segmentName` +* is optional +* type: `string` +* defined in [Segment definition](../../../classes/segmentdefinition.schema.md#xdmsegmentname) + +### xdm:segmentName Type + + +`string` + + + + + + +## xdm:segmentStatus +### Segment status + +Current status of segment from external system normalized to active or inactive. + +`xdm:segmentStatus` +* is optional +* type: `enum` +* defined in [Segment definition](../../../classes/segmentdefinition.schema.md#xdmsegmentstatus) + +The value of this property **must** be equal to one of the [known values below](#xdmsegmentstatus-known-values). + +### xdm:segmentStatus Known Values +| Value | Description | +|-------|-------------| +| `ACTIVE` | | +| `INACTIVE` | | +| `DELETED` | | + + + + +## xdm:targeted +### Targeted + +Indicates if the user segment was targeted with the ad. + +`xdm:targeted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:targeted Type + + +`boolean` + + + + + +## xdm:version +### Segment version + +Version of the segment. + +`xdm:version` +* is optional +* type: `string` +* defined in [Segment definition](../../../classes/segmentdefinition.schema.md#xdmversion) + +### xdm:version Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/adcloud/addeliverydetails.schema.json b/docs/reference/adobe/experience/adcloud/addeliverydetails.schema.json new file mode 100644 index 000000000..56047959a --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/addeliverydetails.schema.json @@ -0,0 +1,53 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/adcloud/addeliverydetails", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Advertising Cloud Ad Delivery Details", + "type": "object", + "description": "Adobe Advertising Cloud Search Ad Delivery Details.", + "definitions": { + "addeliverydetails": { + "properties": { + "xdm:placementWebsite": { + "title": "Placement website", + "type": "string", + "description": "Website where the advertisement was shown." + }, + "xdm:siteLinkText": { + "title": "Site Link Text", + "type": "string", + "description": "Actual site link is being clicked in advertisement." + }, + "xdm:interestLocationID": { + "title": "Interest Location Identifier", + "type": "string", + "description": "Location based on interest expressed in search query. For eg. when the search is for string- 'hotel in goa' here the request might be originating from Bangalore but the interest is on Goa." + }, + "xdm:physicalLocationID": { + "title": "Physical Location Identifier", + "type": "string", + "description": "Surfer browsing location. This isn't exactly the location name - like city or country, instead it is a reference from SE for a geo target." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/addeliverydetails" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:placementWebsite": "happyordinaryday.com", + "xdm:siteLinkText": "Healthy Diets", + "xdm:interestLocationID": "4087", + "xdm:physicalLocationID": "1014185" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/addeliverydetails.schema.md b/docs/reference/adobe/experience/adcloud/addeliverydetails.schema.md new file mode 100644 index 000000000..28003e6b7 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/addeliverydetails.schema.md @@ -0,0 +1,112 @@ + +# Adobe Advertising Cloud Ad Delivery Details Schema + +``` +https://ns.adobe.com/experience/adcloud/addeliverydetails +``` + +Adobe Advertising Cloud Search Ad Delivery Details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/adcloud/addeliverydetails.schema.json](adobe/experience/adcloud/addeliverydetails.schema.json) | + +## Adobe Advertising Cloud Ad Delivery Details Example +```json +{ + "xdm:placementWebsite": "happyordinaryday.com", + "xdm:siteLinkText": "Healthy Diets", + "xdm:interestLocationID": "4087", + "xdm:physicalLocationID": "1014185" +} +``` + +# Adobe Advertising Cloud Ad Delivery Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:interestLocationID](#xdminterestlocationid) | `string` | Optional | Adobe Advertising Cloud Ad Delivery Details (this schema) | +| [xdm:physicalLocationID](#xdmphysicallocationid) | `string` | Optional | Adobe Advertising Cloud Ad Delivery Details (this schema) | +| [xdm:placementWebsite](#xdmplacementwebsite) | `string` | Optional | Adobe Advertising Cloud Ad Delivery Details (this schema) | +| [xdm:siteLinkText](#xdmsitelinktext) | `string` | Optional | Adobe Advertising Cloud Ad Delivery Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:interestLocationID +### Interest Location Identifier + +Location based on interest expressed in search query. For eg. when the search is for string- 'hotel in goa' here the request might be originating from Bangalore but the interest is on Goa. + +`xdm:interestLocationID` +* is optional +* type: `string` +* defined in this schema + +### xdm:interestLocationID Type + + +`string` + + + + + + +## xdm:physicalLocationID +### Physical Location Identifier + +Surfer browsing location. This isn't exactly the location name - like city or country, instead it is a reference from SE for a geo target. + +`xdm:physicalLocationID` +* is optional +* type: `string` +* defined in this schema + +### xdm:physicalLocationID Type + + +`string` + + + + + + +## xdm:placementWebsite +### Placement website + +Website where the advertisement was shown. + +`xdm:placementWebsite` +* is optional +* type: `string` +* defined in this schema + +### xdm:placementWebsite Type + + +`string` + + + + + + +## xdm:siteLinkText +### Site Link Text + +Actual site link is being clicked in advertisement. + +`xdm:siteLinkText` +* is optional +* type: `string` +* defined in this schema + +### xdm:siteLinkText Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/adcloud/advertisement.schema.json b/docs/reference/adobe/experience/adcloud/advertisement.schema.json new file mode 100644 index 000000000..37d196e74 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/advertisement.schema.json @@ -0,0 +1,158 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/adcloud/advertisement", + "title": "Adobe Advertising Cloud Ad Details", + "type": "object", + "description": "Adobe Advertising Cloud Ad Details.", + "definitions": { + "advertisement": { + "properties": { + "xdm:adId": { + "title": "Ad Identifier", + "type": "string", + "description": "Identifier for the ad this event is associated with. Not related to the Ad-ID standard." + }, + "xdm:runtime": { + "title": "Runtime Type", + "type": "string", + "description": "Runtime of the ad unit itself. Not the runtime of the browser or the operating system.", + "meta:enum": { + "unknown": "Unknown", + "HTML5": "HTML5" + } + }, + "xdm:adClass": { + "title": "Ad Class", + "type": "string", + "description": "Ad class of driving event.", + "meta:enum": { + "display": "Display", + "video": "Video", + "social": "Social" + } + }, + "xdm:adUnitType": { + "title": "Ad Unit Type", + "type": "string", + "description": "Identifier for the literal piece of code driving display of the ad in a browser/device.", + "meta:enum": { + "linearVideo": "Linear video", + "interactiveVideo": "Interactive video", + "banner": "Banner", + "richMediaBanner": "Rich media banner", + "newsFeedVideo": "News feed video", + "newsFeedDisplay": "News feed display", + "HTML5": "HTML5", + "inPageVideo": "In page video", + "inPageDisplay": "In page display", + "facebook": "Facebook", + "twitter": "Twitter", + "linearTv": "Linear TV", + "vod": "Video on Demand" + } + }, + "xdm:promotedAssetId": { + "title": "Promoted Asset Identifier", + "type": "string", + "description": "Identifier for the underlying asset being promoted in the ad which this event is associated with." + }, + "xdm:creativeID": { + "title": "Creative Identifier", + "type": "string", + "description": "Identifier for the creative which this event is associated with." + }, + "xdm:keywordID": { + "title": "Keyword Identifier", + "type": "string", + "description": "Identifier for the keyword that the surfer used to search, which triggered this click event." + }, + "xdm:keyword": { + "title": "Keyword", + "type": "string", + "description": "Listing keyword for which customer is bidding " + }, + "xdm:isDynamicSearchAd": { + "title": "Is Dynamic Search Advertisement", + "type": "boolean", + "description": "Indicates if the click comes from a dynamic search advertisement." + }, + "xdm:audienceID": { + "title": "Audience Identifier", + "type": "string", + "description": "Identifier for the audience segment for which the ad is targeted." + }, + "xdm:adGroupID": { + "title": "Ad Group Identifier", + "type": "string", + "description": "Identifier for the adGroup which ad is displayed and triggered this click event." + }, + "xdm:campaignID": { + "title": "Campaign Identifier", + "type": "string", + "description": "Identifier for the campaign that belongs to the current displayed advertisement which triggers this click event." + }, + "xdm:networkType": { + "title": "Network Type", + "type": "string", + "description": "Network type the click event came from a search advertisement or content advertisement.", + "meta:enum": { + "search": "Advertisement is displayed in Search Network", + "content": "Advertisement is displayed in Content Network" + } + }, + "xdm:matchType": { + "title": "matchType", + "type": "string", + "description": "Match type used to match keyword.", + "meta:enum": { + "exact": "Exact Match of the keyword", + "broad": "Broad Match of the keyword", + "phrase": "Phrase Match of the keyword" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/advertisement" + } + ], + "examples": [ + { + "xdm:adId": "4116904851", + "xdm:runtime": "HTML5", + "xdm:adClass": "video", + "xdm:adUnitType": "HTML5", + "xdm:promotedAssetId": "4116761052" + }, + { + "xdm:creativeID": "301404063528", + "xdm:keywordID": "147741280", + "xdm:audienceID": "257600311580", + "xdm:adGroupID": "32345812783", + "xdm:campaignID": "663049855", + "xdm:networkType": "search", + "xdm:matchType": "broad" + }, + { + "@id": "14", + "dsp:adKey": "yyyy029YLCDvseo8QhTE", + "dsp:adStatus": "Active", + "dsp:adClass": "inbanner", + "dsp:adUnitType": "Flash", + "dsp:externalCreativeId": "5121209", + "dsp:promotedVideoId": "14", + "dsp:adServerId": "2", + "dsp:placementIds": [ + "1" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/advertisement.schema.md b/docs/reference/adobe/experience/adcloud/advertisement.schema.md new file mode 100644 index 000000000..4b86652a9 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/advertisement.schema.md @@ -0,0 +1,395 @@ + +# Adobe Advertising Cloud Ad Details Schema + +``` +https://ns.adobe.com/experience/adcloud/advertisement +``` + +Adobe Advertising Cloud Ad Details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/adcloud/advertisement.schema.json](adobe/experience/adcloud/advertisement.schema.json) | + +## Adobe Advertising Cloud Ad Details Examples + +```json +{ + "xdm:adId": "4116904851", + "xdm:runtime": "HTML5", + "xdm:adClass": "video", + "xdm:adUnitType": "HTML5", + "xdm:promotedAssetId": "4116761052" +} +``` + +```json +{ + "xdm:creativeID": "301404063528", + "xdm:keywordID": "147741280", + "xdm:audienceID": "257600311580", + "xdm:adGroupID": "32345812783", + "xdm:campaignID": "663049855", + "xdm:networkType": "search", + "xdm:matchType": "broad" +} +``` + +```json +{ + "@id": "14", + "dsp:adKey": "yyyy029YLCDvseo8QhTE", + "dsp:adStatus": "Active", + "dsp:adClass": "inbanner", + "dsp:adUnitType": "Flash", + "dsp:externalCreativeId": "5121209", + "dsp:promotedVideoId": "14", + "dsp:adServerId": "2", + "dsp:placementIds": [ + "1" + ] +} +``` + + +# Adobe Advertising Cloud Ad Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:adClass](#xdmadclass) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:adGroupID](#xdmadgroupid) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:adId](#xdmadid) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:adUnitType](#xdmadunittype) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:audienceID](#xdmaudienceid) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:campaignID](#xdmcampaignid) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:creativeID](#xdmcreativeid) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:isDynamicSearchAd](#xdmisdynamicsearchad) | `boolean` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:keyword](#xdmkeyword) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:keywordID](#xdmkeywordid) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:matchType](#xdmmatchtype) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:networkType](#xdmnetworktype) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:promotedAssetId](#xdmpromotedassetid) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| [xdm:runtime](#xdmruntime) | `string` | Optional | Adobe Advertising Cloud Ad Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:adClass +### Ad Class + +Ad class of driving event. + +`xdm:adClass` +* is optional +* type: `string` +* defined in this schema + +### xdm:adClass Type + + +`string` + + + +### xdm:adClass Known Values +| Value | Description | +|-------|-------------| +| `display` | Display | +| `video` | Video | +| `social` | Social | + + + + +## xdm:adGroupID +### Ad Group Identifier + +Identifier for the adGroup which ad is displayed and triggered this click event. + +`xdm:adGroupID` +* is optional +* type: `string` +* defined in this schema + +### xdm:adGroupID Type + + +`string` + + + + + + +## xdm:adId +### Ad Identifier + +Identifier for the ad this event is associated with. Not related to the Ad-ID standard. + +`xdm:adId` +* is optional +* type: `string` +* defined in this schema + +### xdm:adId Type + + +`string` + + + + + + +## xdm:adUnitType +### Ad Unit Type + +Identifier for the literal piece of code driving display of the ad in a browser/device. + +`xdm:adUnitType` +* is optional +* type: `string` +* defined in this schema + +### xdm:adUnitType Type + + +`string` + + + +### xdm:adUnitType Known Values +| Value | Description | +|-------|-------------| +| `linearVideo` | Linear video | +| `interactiveVideo` | Interactive video | +| `banner` | Banner | +| `richMediaBanner` | Rich media banner | +| `newsFeedVideo` | News feed video | +| `newsFeedDisplay` | News feed display | +| `HTML5` | HTML5 | +| `inPageVideo` | In page video | +| `inPageDisplay` | In page display | +| `facebook` | Facebook | +| `twitter` | Twitter | +| `linearTv` | Linear TV | +| `vod` | Video on Demand | + + + + +## xdm:audienceID +### Audience Identifier + +Identifier for the audience segment for which the ad is targeted. + +`xdm:audienceID` +* is optional +* type: `string` +* defined in this schema + +### xdm:audienceID Type + + +`string` + + + + + + +## xdm:campaignID +### Campaign Identifier + +Identifier for the campaign that belongs to the current displayed advertisement which triggers this click event. + +`xdm:campaignID` +* is optional +* type: `string` +* defined in this schema + +### xdm:campaignID Type + + +`string` + + + + + + +## xdm:creativeID +### Creative Identifier + +Identifier for the creative which this event is associated with. + +`xdm:creativeID` +* is optional +* type: `string` +* defined in this schema + +### xdm:creativeID Type + + +`string` + + + + + + +## xdm:isDynamicSearchAd +### Is Dynamic Search Advertisement + +Indicates if the click comes from a dynamic search advertisement. + +`xdm:isDynamicSearchAd` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isDynamicSearchAd Type + + +`boolean` + + + + + +## xdm:keyword +### Keyword + +Listing keyword for which customer is bidding + +`xdm:keyword` +* is optional +* type: `string` +* defined in this schema + +### xdm:keyword Type + + +`string` + + + + + + +## xdm:keywordID +### Keyword Identifier + +Identifier for the keyword that the surfer used to search, which triggered this click event. + +`xdm:keywordID` +* is optional +* type: `string` +* defined in this schema + +### xdm:keywordID Type + + +`string` + + + + + + +## xdm:matchType +### matchType + +Match type used to match keyword. + +`xdm:matchType` +* is optional +* type: `string` +* defined in this schema + +### xdm:matchType Type + + +`string` + + + +### xdm:matchType Known Values +| Value | Description | +|-------|-------------| +| `exact` | Exact Match of the keyword | +| `broad` | Broad Match of the keyword | +| `phrase` | Phrase Match of the keyword | + + + + +## xdm:networkType +### Network Type + +Network type the click event came from a search advertisement or content advertisement. + +`xdm:networkType` +* is optional +* type: `string` +* defined in this schema + +### xdm:networkType Type + + +`string` + + + +### xdm:networkType Known Values +| Value | Description | +|-------|-------------| +| `search` | Advertisement is displayed in Search Network | +| `content` | Advertisement is displayed in Content Network | + + + + +## xdm:promotedAssetId +### Promoted Asset Identifier + +Identifier for the underlying asset being promoted in the ad which this event is associated with. + +`xdm:promotedAssetId` +* is optional +* type: `string` +* defined in this schema + +### xdm:promotedAssetId Type + + +`string` + + + + + + +## xdm:runtime +### Runtime Type + +Runtime of the ad unit itself. Not the runtime of the browser or the operating system. + +`xdm:runtime` +* is optional +* type: `string` +* defined in this schema + +### xdm:runtime Type + + +`string` + + + +### xdm:runtime Known Values +| Value | Description | +|-------|-------------| +| `unknown` | Unknown | +| `HTML5` | HTML5 | + + + diff --git a/docs/reference/adobe/experience/adcloud/attributedconversionmodel.schema.json b/docs/reference/adobe/experience/adcloud/attributedconversionmodel.schema.json new file mode 100644 index 000000000..d6ed46866 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/attributedconversionmodel.schema.json @@ -0,0 +1,185 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/adcloud/attributedconversionmodel", + "title": "Attributed Model Conversions", + "type": "object", + "meta:extensible": false, + "meta:abstract": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/time-series" + ], + "description": "Attributed Model Conversions is the Raw Conversion Count and Sum of Conversions", + "definitions": { + "attributedconversionmodel": { + "properties": { + "adcloud:advertiserId": { + "title": "Advertiser Identifier", + "type": "string", + "description": "Identifier for the advertiser" + }, + "adcloud:searchEngineId": { + "title": "Search Engine Identifier", + "type": "integer", + "description": "The application-specified identifier used to identify the Search Advertising Platform Name" + }, + "adcloud:campaignId": { + "title": "Campaign Identifier", + "type": "string", + "description": "Campaign Identifer on the advertising platform" + }, + "adcloud:placementId": { + "title": "Placement Identifier", + "type": "string", + "description": "Placement ID on the dsp advertising platform" + }, + "adcloud:adgroupId": { + "title": "Ad Group Identifier", + "type": "string", + "description": "Ad Group ID on the search advertising platform" + }, + "adcloud:adId": { + "title": "Ad Identifier", + "type": "string", + "description": "Ad ID on the advertising platform" + }, + "adcloud:term": { + "title": "Search Term", + "type": "string", + "description": "Search Term that contributed to the conversion" + }, + "adcloud:termId": { + "title": "Search Term Identifier", + "type": "string", + "description": "Search Term ID on the search advertising platform" + }, + "adcloud:matchType": { + "title": "Term Match Type", + "type": "string", + "description": "Match Type associated to the Search Term being targeted for the Ad", + "enum": [ + "Broad", + "Phrase", + "Exact", + "Advanced", + "Standard", + "Website", + "Product Target", + "Product Group", + "Content", + "SiteCpc", + "SiteCpm", + "Category", + "Search", + "Adgroup", + "Dynamic Ad Target", + "Unknown" + ], + "meta:enum": { + "Broad": "Broad", + "Phrase": "Phrase", + "Exact": "Exact", + "Advanced": "Advanced", + "Standard": "Standard", + "Website": "Website", + "Product Target": "Product Target", + "Product Group": "Product Group", + "Content": "Content", + "SiteCpc": "SiteCpc", + "Sitecpm": "SiteCpm", + "Category": "Category", + "Search": "Search", + "Adgroup": "Adgroup", + "Dynamic Ad Target": "Dynamic Ad Target", + "Unknown": "Unknown" + } + }, + "adcloud:propertyName": { + "title": "Property Name", + "type": "string", + "description": "Property Name Configured by Pixel, Analytics, Custom Feeds" + }, + "adcloud:modelName": { + "title": "Model Name", + "type": "string", + "description": "Model that was executed to generate Raw Conversion Count and Sum for the attributed conversion", + "examples": [ + "LAST EVENT", + "FIRST EVENT", + "EVEN" + ] + }, + "adcloud:clickThroughCount": { + "title": "Click Through Conversion Count", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Evaluated as Raw Conversion Count for models if trigger event is Click" + }, + "adcloud:clickThroughValue": { + "title": "Click Through Conversion Sum", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Evaluated as Raw Conversion Sum for models if trigger event is Click" + }, + "adcloud:viewThroughCount": { + "title": "View Through Conversion Count", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Evaluated as Raw Conversion Count for models if trigger event is Impression" + }, + "adcloud:viewThroughValue": { + "title": "View Through Conversion Sum", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Evaluated as Raw Conversion Sum for models if trigger event is Impression" + }, + "adcloud:clickPlusViewThroughCount": { + "title": "Click Plus View Through Conversion Count", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Evaluated as Raw Conversion Count for models if trigger event is click but impressions present in path" + }, + "adcloud:clickPlusViewThroughValue": { + "title": "Click Plus View Through Conversion Sum", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Evaluated as Raw Conversion Sum for models if trigger event is click but impressions present in path" + }, + "adcloud:viewPlusClickThroughCount": { + "title": "View Plus Click Through Conversion Count", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Raw Conversion Count for models if trigger event is impression but clicks present in path" + }, + "adcloud:viewPlusClickThroughValue": { + "title": "View Plus Click Through Conversion Sum", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Raw Conversion Sum for models if trigger event is impression but clicks present in path" + }, + "adcloud:conversionType": { + "title": "Conversion Type", + "type": "string", + "description": "Feed Conversion Type the conversion event originated from", + "enum": [ + "Feed", + "Pixel", + "Cross Device" + ] + }, + "adcloud:device": { + "title": "Device", + "$ref": "https://ns.adobe.com/xdm/context/device", + "description": "The device conversion event originated from" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/data/time-series" + }, + { + "$ref": "#/definitions/attributedconversionmodel" + } + ], + "meta:status": "stable", + "examples": [] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/attributedconversionmodel.schema.md b/docs/reference/adobe/experience/adcloud/attributedconversionmodel.schema.md new file mode 100644 index 000000000..116423818 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/attributedconversionmodel.schema.md @@ -0,0 +1,581 @@ + +# Attributed Model Conversions Schema + +``` +https://ns.adobe.com/xdm/adcloud/attributedconversionmodel +``` + +Attributed Model Conversions is the Raw Conversion Count and Sum of Conversions + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/adcloud/attributedconversionmodel.schema.json](adobe/experience/adcloud/attributedconversionmodel.schema.json) | +## Schema Hierarchy + +* Attributed Model Conversions `https://ns.adobe.com/xdm/adcloud/attributedconversionmodel` + * [Time-series Schema](../../../behaviors/time-series.schema.md) `https://ns.adobe.com/xdm/data/time-series` + * [Measure](../../../datatypes/data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + * [Device](../../../datatypes/device.schema.md) `https://ns.adobe.com/xdm/context/device` + + +# Attributed Model Conversions Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Time-series Schema](../../../behaviors/time-series.schema.md#id) | +| [adcloud:adId](#adcloudadid) | `string` | Optional | Attributed Model Conversions (this schema) | +| [adcloud:adgroupId](#adcloudadgroupid) | `string` | Optional | Attributed Model Conversions (this schema) | +| [adcloud:advertiserId](#adcloudadvertiserid) | `string` | Optional | Attributed Model Conversions (this schema) | +| [adcloud:campaignId](#adcloudcampaignid) | `string` | Optional | Attributed Model Conversions (this schema) | +| [adcloud:clickPlusViewThroughCount](#adcloudclickplusviewthroughcount) | Measure | Optional | Attributed Model Conversions (this schema) | +| [adcloud:clickPlusViewThroughValue](#adcloudclickplusviewthroughvalue) | Measure | Optional | Attributed Model Conversions (this schema) | +| [adcloud:clickThroughCount](#adcloudclickthroughcount) | Measure | Optional | Attributed Model Conversions (this schema) | +| [adcloud:clickThroughValue](#adcloudclickthroughvalue) | Measure | Optional | Attributed Model Conversions (this schema) | +| [adcloud:conversionType](#adcloudconversiontype) | `enum` | Optional | Attributed Model Conversions (this schema) | +| [adcloud:device](#adclouddevice) | Device | Optional | Attributed Model Conversions (this schema) | +| [adcloud:matchType](#adcloudmatchtype) | `enum` | Optional | Attributed Model Conversions (this schema) | +| [adcloud:modelName](#adcloudmodelname) | `string` | Optional | Attributed Model Conversions (this schema) | +| [adcloud:placementId](#adcloudplacementid) | `string` | Optional | Attributed Model Conversions (this schema) | +| [adcloud:propertyName](#adcloudpropertyname) | `string` | Optional | Attributed Model Conversions (this schema) | +| [adcloud:searchEngineId](#adcloudsearchengineid) | `integer` | Optional | Attributed Model Conversions (this schema) | +| [adcloud:term](#adcloudterm) | `string` | Optional | Attributed Model Conversions (this schema) | +| [adcloud:termId](#adcloudtermid) | `string` | Optional | Attributed Model Conversions (this schema) | +| [adcloud:viewPlusClickThroughCount](#adcloudviewplusclickthroughcount) | Measure | Optional | Attributed Model Conversions (this schema) | +| [adcloud:viewPlusClickThroughValue](#adcloudviewplusclickthroughvalue) | Measure | Optional | Attributed Model Conversions (this schema) | +| [adcloud:viewThroughCount](#adcloudviewthroughcount) | Measure | Optional | Attributed Model Conversions (this schema) | +| [adcloud:viewThroughValue](#adcloudviewthroughvalue) | Measure | Optional | Attributed Model Conversions (this schema) | +| [xdm:eventType](#xdmeventtype) | `string` | Optional | [Time-series Schema](../../../behaviors/time-series.schema.md#xdmeventtype) | +| [xdm:timestamp](#xdmtimestamp) | `string` | Optional | [Time-series Schema](../../../behaviors/time-series.schema.md#xdmtimestamp) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the time-series event. + +`@id` +* is optional +* type: `string` +* defined in [Time-series Schema](../../../behaviors/time-series.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## adcloud:adId +### Ad Identifier + +Ad ID on the advertising platform + +`adcloud:adId` +* is optional +* type: `string` +* defined in this schema + +### adcloud:adId Type + + +`string` + + + + + + +## adcloud:adgroupId +### Ad Group Identifier + +Ad Group ID on the search advertising platform + +`adcloud:adgroupId` +* is optional +* type: `string` +* defined in this schema + +### adcloud:adgroupId Type + + +`string` + + + + + + +## adcloud:advertiserId +### Advertiser Identifier + +Identifier for the advertiser + +`adcloud:advertiserId` +* is optional +* type: `string` +* defined in this schema + +### adcloud:advertiserId Type + + +`string` + + + + + + +## adcloud:campaignId +### Campaign Identifier + +Campaign Identifer on the advertising platform + +`adcloud:campaignId` +* is optional +* type: `string` +* defined in this schema + +### adcloud:campaignId Type + + +`string` + + + + + + +## adcloud:clickPlusViewThroughCount +### Click Plus View Through Conversion Count + +Evaluated as Raw Conversion Count for models if trigger event is click but impressions present in path + +`adcloud:clickPlusViewThroughCount` +* is optional +* type: Measure +* defined in this schema + +### adcloud:clickPlusViewThroughCount Type + + +* [Measure](../../../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## adcloud:clickPlusViewThroughValue +### Click Plus View Through Conversion Sum + +Evaluated as Raw Conversion Sum for models if trigger event is click but impressions present in path + +`adcloud:clickPlusViewThroughValue` +* is optional +* type: Measure +* defined in this schema + +### adcloud:clickPlusViewThroughValue Type + + +* [Measure](../../../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## adcloud:clickThroughCount +### Click Through Conversion Count + +Evaluated as Raw Conversion Count for models if trigger event is Click + +`adcloud:clickThroughCount` +* is optional +* type: Measure +* defined in this schema + +### adcloud:clickThroughCount Type + + +* [Measure](../../../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## adcloud:clickThroughValue +### Click Through Conversion Sum + +Evaluated as Raw Conversion Sum for models if trigger event is Click + +`adcloud:clickThroughValue` +* is optional +* type: Measure +* defined in this schema + +### adcloud:clickThroughValue Type + + +* [Measure](../../../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## adcloud:conversionType +### Conversion Type + +Feed Conversion Type the conversion event originated from + +`adcloud:conversionType` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#adcloudconversiontype-known-values). + +### adcloud:conversionType Known Values +| Value | Description | +|-------|-------------| +| `Feed` | | +| `Pixel` | | +| `Cross Device` | | + + + + +## adcloud:device +### Device + +The device conversion event originated from + +`adcloud:device` +* is optional +* type: Device +* defined in this schema + +### adcloud:device Type + + +* [Device](../../../datatypes/device.schema.md) – `https://ns.adobe.com/xdm/context/device` + + + + + +## adcloud:matchType +### Term Match Type + +Match Type associated to the Search Term being targeted for the Ad + +`adcloud:matchType` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#adcloudmatchtype-known-values). + +### adcloud:matchType Known Values +| Value | Description | +|-------|-------------| +| `Broad` | Broad | +| `Phrase` | Phrase | +| `Exact` | Exact | +| `Advanced` | Advanced | +| `Standard` | Standard | +| `Website` | Website | +| `Product Target` | Product Target | +| `Product Group` | Product Group | +| `Content` | Content | +| `SiteCpc` | SiteCpc | +| `Sitecpm` | SiteCpm | +| `Category` | Category | +| `Search` | Search | +| `Adgroup` | Adgroup | +| `Dynamic Ad Target` | Dynamic Ad Target | +| `Unknown` | Unknown | +| `SiteCpm` | | + + + + +## adcloud:modelName +### Model Name + +Model that was executed to generate Raw Conversion Count and Sum for the attributed conversion + +`adcloud:modelName` +* is optional +* type: `string` +* defined in this schema + +### adcloud:modelName Type + + +`string` + + + + + +### adcloud:modelName Examples + +```json +"LAST EVENT" +``` + +```json +"FIRST EVENT" +``` + +```json +"EVEN" +``` + + + +## adcloud:placementId +### Placement Identifier + +Placement ID on the dsp advertising platform + +`adcloud:placementId` +* is optional +* type: `string` +* defined in this schema + +### adcloud:placementId Type + + +`string` + + + + + + +## adcloud:propertyName +### Property Name + +Property Name Configured by Pixel, Analytics, Custom Feeds + +`adcloud:propertyName` +* is optional +* type: `string` +* defined in this schema + +### adcloud:propertyName Type + + +`string` + + + + + + +## adcloud:searchEngineId +### Search Engine Identifier + +The application-specified identifier used to identify the Search Advertising Platform Name + +`adcloud:searchEngineId` +* is optional +* type: `integer` +* defined in this schema + +### adcloud:searchEngineId Type + + +`integer` + + + + + + +## adcloud:term +### Search Term + +Search Term that contributed to the conversion + +`adcloud:term` +* is optional +* type: `string` +* defined in this schema + +### adcloud:term Type + + +`string` + + + + + + +## adcloud:termId +### Search Term Identifier + +Search Term ID on the search advertising platform + +`adcloud:termId` +* is optional +* type: `string` +* defined in this schema + +### adcloud:termId Type + + +`string` + + + + + + +## adcloud:viewPlusClickThroughCount +### View Plus Click Through Conversion Count + +Raw Conversion Count for models if trigger event is impression but clicks present in path + +`adcloud:viewPlusClickThroughCount` +* is optional +* type: Measure +* defined in this schema + +### adcloud:viewPlusClickThroughCount Type + + +* [Measure](../../../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## adcloud:viewPlusClickThroughValue +### View Plus Click Through Conversion Sum + +Raw Conversion Sum for models if trigger event is impression but clicks present in path + +`adcloud:viewPlusClickThroughValue` +* is optional +* type: Measure +* defined in this schema + +### adcloud:viewPlusClickThroughValue Type + + +* [Measure](../../../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## adcloud:viewThroughCount +### View Through Conversion Count + +Evaluated as Raw Conversion Count for models if trigger event is Impression + +`adcloud:viewThroughCount` +* is optional +* type: Measure +* defined in this schema + +### adcloud:viewThroughCount Type + + +* [Measure](../../../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## adcloud:viewThroughValue +### View Through Conversion Sum + +Evaluated as Raw Conversion Sum for models if trigger event is Impression + +`adcloud:viewThroughValue` +* is optional +* type: Measure +* defined in this schema + +### adcloud:viewThroughValue Type + + +* [Measure](../../../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:eventType +### Event Type + +The primary event type for this time-series record. + +`xdm:eventType` +* is optional +* type: `string` +* defined in [Time-series Schema](../../../behaviors/time-series.schema.md#xdmeventtype) + +### xdm:eventType Type + + +`string` + + + +### xdm:eventType Known Values +| Value | Description | +|-------|-------------| +| `advertising.completes` | Indicates if a timed media asset was watched to completion - this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead. | +| `advertising.timePlayed` | Describes the amount of time spent by a user on a specific timed media asset. | +| `advertising.federated` | Indicates if an experience event was created through data federation (data sharing between customers). | +| `advertising.clicks` | Click(s) actions on an advertisement. | +| `advertising.conversions` | A customer pre-defined action(s) which triggers an event for performance evaluation. | +| `advertising.firstQuartiles` | A digital video ad has played through 25% of its duration at normal speed. | +| `advertising.impressions` | Impression(s) of an advertisement to an end-user with the potential of being viewed. | +| `advertising.midpoints` | A digital video ad has played through 50% of its duration at normal speed. | +| `advertising.starts` | A digital video ad has started playing. | +| `advertising.thirdQuartiles` | A digital video ad has played through 75% of its duration at normal speed. | +| `web.webpagedetails.pageViews` | View(s) of a webpage has occurred. | +| `web.webinteraction.linkClicks` | Click of a web-link has occurred. | +| `commerce.checkouts` | An action during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order. | +| `commerce.productListAdds` | Addition of a product to the product list. Example a product is added to a shopping cart. | +| `commerce.productListOpens` | Initializations of a new product list. Example a shopping cart is created. | +| `commerce.productListRemovals` | Removal(s) of a product entry from a product list. Example a product is removed from a shopping cart. | +| `commerce.productListReopens` | A product list that was no longer accessible(abandoned) has been re-activated by the user. Example via a re-marketing activity. | +| `commerce.productListViews` | View(s) of a product-list has occurred. | +| `commerce.productViews` | View(s) of a product have occurred. | +| `commerce.purchases` | An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced. | +| `commerce.saveForLaters` | Product list is saved for future use. Example a product wish list. | +| `delivery.feedback` | Feedback events for a delivery. Example feedback events for an email delivery. | + + + + +## xdm:timestamp +### Timestamp + +The time when an event or observation occurred. + +`xdm:timestamp` +* is optional +* type: `string` +* defined in [Time-series Schema](../../../behaviors/time-series.schema.md#xdmtimestamp) + +### xdm:timestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + diff --git a/docs/reference/adobe/experience/adcloud/campaign.schema.json b/docs/reference/adobe/experience/adcloud/campaign.schema.json new file mode 100644 index 000000000..4cf423d2a --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/campaign.schema.json @@ -0,0 +1,131 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/adcloud/campaign", + "title": "Ad Campaign Detail", + "type": "object", + "description": "Adobe Advertising Cloud ad campaign hierarchy details such as, account, package, advertiser, and campaign IDs.", + "definitions": { + "campaign": { + "properties": { + "xdm:accountId": { + "title": "Account Identifier", + "type": "string", + "description": "Identifier for the account." + }, + "xdm:dspId": { + "title": "Demand Side Platform(DSP) Identifier", + "type": "string", + "description": "Identifier for the Demand Side Platform where the campaign is defined. Usually, is the id of Adobe Advertising Cloud DSP." + }, + "xdm:campaignId": { + "title": "Campaign Identifier", + "type": "string", + "description": "Identifier for the campaign." + }, + "xdm:placementId": { + "title": "Placement Identifier", + "type": "string", + "description": "Identifier for the placement." + }, + "xdm:packageId": { + "title": "Package Identifier", + "type": "string", + "description": "Identifier for the package." + }, + "xdm:advertiserId": { + "title": "Advertiser Identifier", + "type": "string", + "description": "Identifier for the advertiser." + }, + "xdm:experimentId": { + "title": "Experiment Identifier", + "type": "string", + "description": "Identifier for the experiment." + }, + "xdm:sampleGroupId": { + "title": "Sample Group Identifier", + "type": "string", + "description": "Identifier for the sample group." + }, + "xdm:currency": { + "title": "Account Currency", + "type": "string", + "examples": [ + "USD", + "EUR" + ], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 billing currency code for the account." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/campaign" + } + ], + "examples": [ + { + "@id": "100001061", + "searchads:campaignId": "10001234", + "searchads:accountId": "10001456", + "searchads:campaignName": "My First Campaign", + "searchads:campaignDescription": "Branded Mobile Campaign", + "searchads:campaignStatus": "Active", + "searchads:channelType": "Search", + "searchads:budget": 123.45, + "searchads:budgetType": "Monthly", + "searchads.adDeliveryType": "Standard", + "searchads.CampaignObjective": "visit_web", + "repo:createDate": "2019-04-26T14:00:00+00:00", + "repo:modifyDate": "2019-04-26T14:00:00+00:00" + }, + { + "xdm:accountId": "123456", + "xdm:dspId": "2", + "xdm:campaignId": "987654", + "xdm:placementId": "7656467", + "xdm:packageId": "98766172", + "xdm:advertiserId": "87612391", + "xdm:experimentId": "9812987", + "xdm:sampleGroupId": "8676378", + "xdm:currency": "USD" + }, + { + "@id": "12", + "dsp:campaignKey": "QEr8RnlYHwnG4KbFSQor", + "dsp:campaignName": "News At Cisco", + "dsp:campaignStatus": "Active", + "dsp:timezone": "America/New_York", + "dsp:type": "Media", + "dsp:userId": 495991, + "dsp:accountId": "1", + "dsp:advertiserId": "3", + "dsp:campaignStartTime": "2019-01-09 00:00:00", + "dsp:campaignEndTime": "2019-01-11 00:00:00", + "repo:createDate": "2019-04-26T14:00:00+00:00", + "repo:modifyDate": "2019-04-26T14:00:00+00:00" + }, + { + "xdm:id": "100001061", + "xdm:campaignId": "10001234", + "xdm:campaignName": "My First Campaign", + "xdm:campaignDescription": "Branded Mobile Campaign", + "xdm:campaignStatus": "Active", + "xdm:channelType": "Search", + "xdm:budget": 123.45, + "xdm:budgetType": "Monthly", + "xdm.adDeliveryType": "Standard", + "xdm.CampaignObjective": "visit_web", + "repo:createDate": "2019-04-26T14:00:00+00:00", + "repo:modifyDate": "2019-04-26T14:00:00+00:00" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/campaign.schema.md b/docs/reference/adobe/experience/adcloud/campaign.schema.md new file mode 100644 index 000000000..87863c3cc --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/campaign.schema.md @@ -0,0 +1,296 @@ + +# Ad Campaign Detail Schema + +``` +https://ns.adobe.com/experience/adcloud/campaign +``` + +Adobe Advertising Cloud ad campaign hierarchy details such as, account, package, advertiser, and campaign IDs. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/adcloud/campaign.schema.json](adobe/experience/adcloud/campaign.schema.json) | + +## Ad Campaign Detail Examples + +```json +{ + "@id": "100001061", + "searchads:campaignId": "10001234", + "searchads:accountId": "10001456", + "searchads:campaignName": "My First Campaign", + "searchads:campaignDescription": "Branded Mobile Campaign", + "searchads:campaignStatus": "Active", + "searchads:channelType": "Search", + "searchads:budget": 123.45, + "searchads:budgetType": "Monthly", + "searchads.adDeliveryType": "Standard", + "searchads.CampaignObjective": "visit_web", + "repo:createDate": "2019-04-26T14:00:00+00:00", + "repo:modifyDate": "2019-04-26T14:00:00+00:00" +} +``` + +```json +{ + "xdm:accountId": "123456", + "xdm:dspId": "2", + "xdm:campaignId": "987654", + "xdm:placementId": "7656467", + "xdm:packageId": "98766172", + "xdm:advertiserId": "87612391", + "xdm:experimentId": "9812987", + "xdm:sampleGroupId": "8676378", + "xdm:currency": "USD" +} +``` + +```json +{ + "@id": "12", + "dsp:campaignKey": "QEr8RnlYHwnG4KbFSQor", + "dsp:campaignName": "News At Cisco", + "dsp:campaignStatus": "Active", + "dsp:timezone": "America/New_York", + "dsp:type": "Media", + "dsp:userId": 495991, + "dsp:accountId": "1", + "dsp:advertiserId": "3", + "dsp:campaignStartTime": "2019-01-09 00:00:00", + "dsp:campaignEndTime": "2019-01-11 00:00:00", + "repo:createDate": "2019-04-26T14:00:00+00:00", + "repo:modifyDate": "2019-04-26T14:00:00+00:00" +} +``` + +```json +{ + "xdm:id": "100001061", + "xdm:campaignId": "10001234", + "xdm:campaignName": "My First Campaign", + "xdm:campaignDescription": "Branded Mobile Campaign", + "xdm:campaignStatus": "Active", + "xdm:channelType": "Search", + "xdm:budget": 123.45, + "xdm:budgetType": "Monthly", + "xdm.adDeliveryType": "Standard", + "xdm.CampaignObjective": "visit_web", + "repo:createDate": "2019-04-26T14:00:00+00:00", + "repo:modifyDate": "2019-04-26T14:00:00+00:00" +} +``` + + +# Ad Campaign Detail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:accountId](#xdmaccountid) | `string` | Optional | Ad Campaign Detail (this schema) | +| [xdm:advertiserId](#xdmadvertiserid) | `string` | Optional | Ad Campaign Detail (this schema) | +| [xdm:campaignId](#xdmcampaignid) | `string` | Optional | Ad Campaign Detail (this schema) | +| [xdm:currency](#xdmcurrency) | `string` | Optional | Ad Campaign Detail (this schema) | +| [xdm:dspId](#xdmdspid) | `string` | Optional | Ad Campaign Detail (this schema) | +| [xdm:experimentId](#xdmexperimentid) | `string` | Optional | Ad Campaign Detail (this schema) | +| [xdm:packageId](#xdmpackageid) | `string` | Optional | Ad Campaign Detail (this schema) | +| [xdm:placementId](#xdmplacementid) | `string` | Optional | Ad Campaign Detail (this schema) | +| [xdm:sampleGroupId](#xdmsamplegroupid) | `string` | Optional | Ad Campaign Detail (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:accountId +### Account Identifier + +Identifier for the account. + +`xdm:accountId` +* is optional +* type: `string` +* defined in this schema + +### xdm:accountId Type + + +`string` + + + + + + +## xdm:advertiserId +### Advertiser Identifier + +Identifier for the advertiser. + +`xdm:advertiserId` +* is optional +* type: `string` +* defined in this schema + +### xdm:advertiserId Type + + +`string` + + + + + + +## xdm:campaignId +### Campaign Identifier + +Identifier for the campaign. + +`xdm:campaignId` +* is optional +* type: `string` +* defined in this schema + +### xdm:campaignId Type + + +`string` + + + + + + +## xdm:currency +### Account Currency + +The ISO 4217 billing currency code for the account. + +`xdm:currency` +* is optional +* type: `string` +* defined in this schema + +### xdm:currency Type + + +`string` + + +All instances must conform to this regular expression +```regex +^[A-Z]{3}$ +``` + +* test example: [USD](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=USD) +* test example: [EUR](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=EUR) + + + + +### xdm:currency Examples + +```json +"USD" +``` + +```json +"EUR" +``` + + + +## xdm:dspId +### Demand Side Platform(DSP) Identifier + +Identifier for the Demand Side Platform where the campaign is defined. Usually, is the id of Adobe Advertising Cloud DSP. + +`xdm:dspId` +* is optional +* type: `string` +* defined in this schema + +### xdm:dspId Type + + +`string` + + + + + + +## xdm:experimentId +### Experiment Identifier + +Identifier for the experiment. + +`xdm:experimentId` +* is optional +* type: `string` +* defined in this schema + +### xdm:experimentId Type + + +`string` + + + + + + +## xdm:packageId +### Package Identifier + +Identifier for the package. + +`xdm:packageId` +* is optional +* type: `string` +* defined in this schema + +### xdm:packageId Type + + +`string` + + + + + + +## xdm:placementId +### Placement Identifier + +Identifier for the placement. + +`xdm:placementId` +* is optional +* type: `string` +* defined in this schema + +### xdm:placementId Type + + +`string` + + + + + + +## xdm:sampleGroupId +### Sample Group Identifier + +Identifier for the sample group. + +`xdm:sampleGroupId` +* is optional +* type: `string` +* defined in this schema + +### xdm:sampleGroupId Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/adcloud/conversiondetails.schema.json b/docs/reference/adobe/experience/adcloud/conversiondetails.schema.json new file mode 100644 index 000000000..906b50bfa --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/conversiondetails.schema.json @@ -0,0 +1,35 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/adcloud/conversiondetails", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Conversion Details", + "type": "object", + "description": "Adobe Advertising Cloud Search Conversion Details.", + "definitions": { + "conversiondetails": { + "properties": { + "xdm:conversionProperties": { + "type": "object", + "description": "List of Conversion Property Map.", + "meta:xdmType": "map", + "additionalProperties": { + "title": "Conversion Property Item", + "type": "string", + "meta:xdmType": "string" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/conversiondetails" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/conversiondetails.schema.md b/docs/reference/adobe/experience/adcloud/conversiondetails.schema.md new file mode 100644 index 000000000..54b28fbdd --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/conversiondetails.schema.md @@ -0,0 +1,42 @@ + +# Conversion Details Schema + +``` +https://ns.adobe.com/experience/adcloud/conversiondetails +``` + +Adobe Advertising Cloud Search Conversion Details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/adcloud/conversiondetails.schema.json](adobe/experience/adcloud/conversiondetails.schema.json) | + +# Conversion Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:conversionProperties](#xdmconversionproperties) | `object` | Optional | Conversion Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:conversionProperties + +List of Conversion Property Map. + +`xdm:conversionProperties` +* is optional +* type: `object` +* defined in this schema + +### xdm:conversionProperties Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + diff --git a/docs/reference/adobe/experience/adcloud/creative-event.schema.json b/docs/reference/adobe/experience/adcloud/creative-event.schema.json new file mode 100644 index 000000000..70895e450 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/creative-event.schema.json @@ -0,0 +1,66 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/adcloud/creative-event", + "title": "Adobe Advertising Cloud Creative Management Platform Event Extension", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Advertising Cloud Creative Management Platform Event extension.", + "definitions": { + "creative-event": { + "properties": { + "https://ns.adobe.com/experience/adcloud/creative": { + "title": "Advertising Creative Management Platform Details", + "description": "Advertising Creative Management Platform Details.", + "$ref": "https://ns.adobe.com/experience/adcloud/creative" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent#/definitions/experienceevent" + }, + { + "$ref": "#/definitions/creative-event" + } + ], + "meta:status": "stable", + "examples": [ + { + "https://ns.adobe.com/experience/adcloud/creative": { + "xdm:experienceId": "1001", + "xdm:targetingBranchId": "4001", + "xdm:adThemeCreativeId": "3001", + "xdm:segments": [ + { + "xdm:identityMap": { + "AdCloudSegments": [ + { + "xdm:id": "112233", + "xdm:primary": true + } + ] + }, + "xdm:segmentName": "Users with TV segment", + "xdm:description": "Segment is about users who have TV", + "xdm:segmentStatus": "ACTIVE", + "repo:createDate": "2018-10-23T12:00:00-06:00", + "repo:modifyDate": "2019-03-21T12:00:00-06:00", + "xdm:targeted": true, + "xdm:partnerId": "10" + } + ] + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/creative-event.schema.md b/docs/reference/adobe/experience/adcloud/creative-event.schema.md new file mode 100644 index 000000000..f09048ea9 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/creative-event.schema.md @@ -0,0 +1,95 @@ + +# Adobe Advertising Cloud Creative Management Platform Event Extension Schema + +``` +https://ns.adobe.com/experience/adcloud/creative-event +``` + +Adobe Advertising Cloud Creative Management Platform Event extension. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/adcloud/creative-event.schema.json](adobe/experience/adcloud/creative-event.schema.json) | +## Schema Hierarchy + +* Adobe Advertising Cloud Creative Management Platform Event Extension `https://ns.adobe.com/experience/adcloud/creative-event` + * [XDM ExperienceEvent](../../../classes/experienceevent.schema.md) `https://ns.adobe.com/xdm/context/experienceevent` + * [Advertising Creative Management Platform Details](creative.schema.md) `https://ns.adobe.com/experience/adcloud/creative` + + +## Adobe Advertising Cloud Creative Management Platform Event Extension Example +```json +{ + "https://ns.adobe.com/experience/adcloud/creative": { + "xdm:experienceId": "1001", + "xdm:targetingBranchId": "4001", + "xdm:adThemeCreativeId": "3001", + "xdm:segments": [ + { + "xdm:identityMap": { + "AdCloudSegments": [ + { + "xdm:id": "112233", + "xdm:primary": true + } + ] + }, + "xdm:segmentName": "Users with TV segment", + "xdm:description": "Segment is about users who have TV", + "xdm:segmentStatus": "ACTIVE", + "repo:createDate": "2018-10-23T12:00:00-06:00", + "repo:modifyDate": "2019-03-21T12:00:00-06:00", + "xdm:targeted": true, + "xdm:partnerId": "10" + } + ] + } +} +``` + +# Adobe Advertising Cloud Creative Management Platform Event Extension Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/adcloud/creative](#httpsnsadobecomexperienceadcloudcreative) | Advertising Creative Management Platform Details | Optional | Adobe Advertising Cloud Creative Management Platform Event Extension (this schema) | +| [xdm:eventMergeId](#xdmeventmergeid) | `string` | Optional | [XDM ExperienceEvent](../../../classes/experienceevent.schema.md#xdmeventmergeid) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/adcloud/creative +### Advertising Creative Management Platform Details + +Advertising Creative Management Platform Details. + +`https://ns.adobe.com/experience/adcloud/creative` +* is optional +* type: Advertising Creative Management Platform Details +* defined in this schema + +### https://ns.adobe.com/experience/adcloud/creative Type + + +* [Advertising Creative Management Platform Details](creative.schema.md) – `https://ns.adobe.com/experience/adcloud/creative` + + + + + +## xdm:eventMergeId +### ExperienceEvent merge ID + +An ID to correlate or merge multiple Experience events together that are essentially the same event or should be merged. This is intended to be populated by the data producer prior to ingestion. + +`xdm:eventMergeId` +* is optional +* type: `string` +* defined in [XDM ExperienceEvent](../../../classes/experienceevent.schema.md#xdmeventmergeid) + +### xdm:eventMergeId Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/adcloud/creative.schema.json b/docs/reference/adobe/experience/adcloud/creative.schema.json new file mode 100644 index 000000000..5b4508308 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/creative.schema.json @@ -0,0 +1,72 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/adcloud/creative", + "title": "Advertising Creative Management Platform Details", + "type": "object", + "description": "Advertising Creative Management Platform details.", + "definitions": { + "creative": { + "properties": { + "xdm:experienceId": { + "title": "Experience Identifier", + "type": "string", + "description": "Identifier for the Creative experience." + }, + "xdm:targetingBranchId": { + "title": "Targeting Branch Identifier", + "type": "string", + "description": "Identifier for the targeting branch." + }, + "xdm:adThemeCreativeId": { + "title": "Ad Theme Creative Identifier", + "type": "string", + "description": "Identifier for the ad theme creative." + }, + "xdm:segments": { + "title": "Audience Segments Details", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/experience/adcloud/adcloudsegment" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/creative" + } + ], + "examples": [ + { + "xdm:experienceId": "1001", + "xdm:targetingBranchId": "4001", + "xdm:adThemeCreativeId": "3001", + "xdm:segments": [ + { + "xdm:identityMap": { + "AdCloudSegments": [ + { + "xdm:id": "112233", + "xdm:primary": true + } + ] + }, + "xdm:segmentName": "Users with TV segment", + "xdm:description": "Segment is about users who have TV", + "xdm:segmentStatus": "ACTIVE", + "repo:createDate": "2018-10-23T12:00:00-06:00", + "repo:modifyDate": "2019-03-21T12:00:00-06:00", + "xdm:targeted": true, + "xdm:partnerId": "10" + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/creative.schema.md b/docs/reference/adobe/experience/adcloud/creative.schema.md new file mode 100644 index 000000000..138a3ea47 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/creative.schema.md @@ -0,0 +1,134 @@ + +# Advertising Creative Management Platform Details Schema + +``` +https://ns.adobe.com/experience/adcloud/creative +``` + +Advertising Creative Management Platform details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/adcloud/creative.schema.json](adobe/experience/adcloud/creative.schema.json) | + +## Advertising Creative Management Platform Details Example +```json +{ + "xdm:experienceId": "1001", + "xdm:targetingBranchId": "4001", + "xdm:adThemeCreativeId": "3001", + "xdm:segments": [ + { + "xdm:identityMap": { + "AdCloudSegments": [ + { + "xdm:id": "112233", + "xdm:primary": true + } + ] + }, + "xdm:segmentName": "Users with TV segment", + "xdm:description": "Segment is about users who have TV", + "xdm:segmentStatus": "ACTIVE", + "repo:createDate": "2018-10-23T12:00:00-06:00", + "repo:modifyDate": "2019-03-21T12:00:00-06:00", + "xdm:targeted": true, + "xdm:partnerId": "10" + } + ] +} +``` + +# Advertising Creative Management Platform Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:adThemeCreativeId](#xdmadthemecreativeid) | `string` | Optional | Advertising Creative Management Platform Details (this schema) | +| [xdm:experienceId](#xdmexperienceid) | `string` | Optional | Advertising Creative Management Platform Details (this schema) | +| [xdm:segments](#xdmsegments) | Adobe Advertising Cloud Audience Segment Details | Optional | Advertising Creative Management Platform Details (this schema) | +| [xdm:targetingBranchId](#xdmtargetingbranchid) | `string` | Optional | Advertising Creative Management Platform Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:adThemeCreativeId +### Ad Theme Creative Identifier + +Identifier for the ad theme creative. + +`xdm:adThemeCreativeId` +* is optional +* type: `string` +* defined in this schema + +### xdm:adThemeCreativeId Type + + +`string` + + + + + + +## xdm:experienceId +### Experience Identifier + +Identifier for the Creative experience. + +`xdm:experienceId` +* is optional +* type: `string` +* defined in this schema + +### xdm:experienceId Type + + +`string` + + + + + + +## xdm:segments +### Audience Segments Details + +`xdm:segments` +* is optional +* type: Adobe Advertising Cloud Audience Segment Details + +* defined in this schema + +### xdm:segments Type + + +Array type: Adobe Advertising Cloud Audience Segment Details + +All items must be of the type: +* [Adobe Advertising Cloud Audience Segment Details](adcloudsegment.schema.md) – `https://ns.adobe.com/experience/adcloud/adcloudsegment` + + + + + + + + +## xdm:targetingBranchId +### Targeting Branch Identifier + +Identifier for the targeting branch. + +`xdm:targetingBranchId` +* is optional +* type: `string` +* defined in this schema + +### xdm:targetingBranchId Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/adcloud/experienceevent-all.schema.json b/docs/reference/adobe/experience/adcloud/experienceevent-all.schema.json new file mode 100644 index 000000000..cc4129964 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/experienceevent-all.schema.json @@ -0,0 +1,78 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/adcloud/experienceevent-all", + "title": "Adobe Advertising Cloud ExperienceEvent Full Extension", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Advertising Cloud ExperienceEvent full extension. Contains all Solution added fields.", + "definitions": { + "experienceevent-all": { + "properties": { + "https://ns.adobe.com/experience/adcloud/eventType": { + "title": "Event Type", + "type": "string", + "description": "Adobe Advertising Cloud event type." + }, + "https://ns.adobe.com/experience/adcloud/campaign": { + "title": "Ad Campaign Details", + "$ref": "https://ns.adobe.com/experience/adcloud/campaign", + "description": "Adobe Advertising Cloud ad campaign hierarchy details." + }, + "https://ns.adobe.com/experience/adcloud/inventory": { + "title": "Ad Inventory Details", + "$ref": "https://ns.adobe.com/experience/adcloud/inventory", + "description": "Adobe Advertising Cloud inventory details." + }, + "https://ns.adobe.com/experience/adcloud/advertisement": { + "title": "Ad Asset Details", + "$ref": "https://ns.adobe.com/experience/adcloud/advertisement", + "description": "Digital advertisement details." + }, + "https://ns.adobe.com/experience/adcloud/stitchId": { + "title": "Stitch ID Chosen", + "type": "string", + "description": "ID from the ad servers through Adobe Advertising Cloud STATS to track click-through conversion on browsers that block third party cookies." + }, + "https://ns.adobe.com/experience/adcloud/adDeliveryDetails": { + "title": "Ad Delivery Details", + "$ref": "https://ns.adobe.com/experience/adcloud/addeliverydetails", + "description": "Adobe AdCloud Search Ad Delivery Details." + }, + "https://ns.adobe.com/experience/adcloud/productDetails": { + "title": "Ad Product Details", + "$ref": "https://ns.adobe.com/experience/adcloud/productdetails", + "description": "Adobe AdCloud Search Ad Product Details." + }, + "https://ns.adobe.com/experience/adcloud/conversionDetails": { + "title": "Ad Conversion Details", + "$ref": "https://ns.adobe.com/experience/adcloud/conversiondetails", + "description": "Search Ad Conversion Details." + }, + "https://ns.adobe.com/experience/adcloud/fees": { + "title": "Advertising Fees", + "description": "Advertising Fees Details.", + "$ref": "https://ns.adobe.com/experience/adcloud/fees" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent#/definitions/experienceevent" + }, + { + "$ref": "#/definitions/experienceevent-all" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/experienceevent-all.schema.md b/docs/reference/adobe/experience/adcloud/experienceevent-all.schema.md new file mode 100644 index 000000000..993a583c5 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/experienceevent-all.schema.md @@ -0,0 +1,233 @@ + +# Adobe Advertising Cloud ExperienceEvent Full Extension Schema + +``` +https://ns.adobe.com/experience/adcloud/experienceevent-all +``` + +Adobe Advertising Cloud ExperienceEvent full extension. Contains all Solution added fields. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/adcloud/experienceevent-all.schema.json](adobe/experience/adcloud/experienceevent-all.schema.json) | +## Schema Hierarchy + +* Adobe Advertising Cloud ExperienceEvent Full Extension `https://ns.adobe.com/experience/adcloud/experienceevent-all` + * [XDM ExperienceEvent](../../../classes/experienceevent.schema.md) `https://ns.adobe.com/xdm/context/experienceevent` + * [Ad Campaign Detail](campaign.schema.md) `https://ns.adobe.com/experience/adcloud/campaign` + * [Adobe Advertising Cloud Inventory](inventory.schema.md) `https://ns.adobe.com/experience/adcloud/inventory` + * [Adobe Advertising Cloud Ad Details](advertisement.schema.md) `https://ns.adobe.com/experience/adcloud/advertisement` + * [Adobe Advertising Cloud Ad Delivery Details](addeliverydetails.schema.md) `https://ns.adobe.com/experience/adcloud/addeliverydetails` + * [Adobe Advertising Cloud Product Details displayed in Search Advertisement.](productdetails.schema.md) `https://ns.adobe.com/experience/adcloud/productdetails` + * [Conversion Details](conversiondetails.schema.md) `https://ns.adobe.com/experience/adcloud/conversiondetails` + * [Advertising Fee Details](fees.schema.md) `https://ns.adobe.com/experience/adcloud/fees` + + +# Adobe Advertising Cloud ExperienceEvent Full Extension Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/adcloud/adDeliveryDetails](#httpsnsadobecomexperienceadcloudaddeliverydetails) | Adobe Advertising Cloud Ad Delivery Details | Optional | Adobe Advertising Cloud ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/adcloud/advertisement](#httpsnsadobecomexperienceadcloudadvertisement) | Adobe Advertising Cloud Ad Details | Optional | Adobe Advertising Cloud ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/adcloud/campaign](#httpsnsadobecomexperienceadcloudcampaign) | Ad Campaign Detail | Optional | Adobe Advertising Cloud ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/adcloud/conversionDetails](#httpsnsadobecomexperienceadcloudconversiondetails) | Conversion Details | Optional | Adobe Advertising Cloud ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/adcloud/eventType](#httpsnsadobecomexperienceadcloudeventtype) | `string` | Optional | Adobe Advertising Cloud ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/adcloud/fees](#httpsnsadobecomexperienceadcloudfees) | Advertising Fee Details | Optional | Adobe Advertising Cloud ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/adcloud/inventory](#httpsnsadobecomexperienceadcloudinventory) | Adobe Advertising Cloud Inventory | Optional | Adobe Advertising Cloud ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/adcloud/productDetails](#httpsnsadobecomexperienceadcloudproductdetails) | Adobe Advertising Cloud Product Details displayed in Search Advertisement. | Optional | Adobe Advertising Cloud ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/adcloud/stitchId](#httpsnsadobecomexperienceadcloudstitchid) | `string` | Optional | Adobe Advertising Cloud ExperienceEvent Full Extension (this schema) | +| [xdm:eventMergeId](#xdmeventmergeid) | `string` | Optional | [XDM ExperienceEvent](../../../classes/experienceevent.schema.md#xdmeventmergeid) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/adcloud/adDeliveryDetails +### Ad Delivery Details + +Adobe AdCloud Search Ad Delivery Details. + +`https://ns.adobe.com/experience/adcloud/adDeliveryDetails` +* is optional +* type: Adobe Advertising Cloud Ad Delivery Details +* defined in this schema + +### https://ns.adobe.com/experience/adcloud/adDeliveryDetails Type + + +* [Adobe Advertising Cloud Ad Delivery Details](addeliverydetails.schema.md) – `https://ns.adobe.com/experience/adcloud/addeliverydetails` + + + + + +## https://ns.adobe.com/experience/adcloud/advertisement +### Ad Asset Details + +Digital advertisement details. + +`https://ns.adobe.com/experience/adcloud/advertisement` +* is optional +* type: Adobe Advertising Cloud Ad Details +* defined in this schema + +### https://ns.adobe.com/experience/adcloud/advertisement Type + + +* [Adobe Advertising Cloud Ad Details](advertisement.schema.md) – `https://ns.adobe.com/experience/adcloud/advertisement` + + + + + +## https://ns.adobe.com/experience/adcloud/campaign +### Ad Campaign Details + +Adobe Advertising Cloud ad campaign hierarchy details. + +`https://ns.adobe.com/experience/adcloud/campaign` +* is optional +* type: Ad Campaign Detail +* defined in this schema + +### https://ns.adobe.com/experience/adcloud/campaign Type + + +* [Ad Campaign Detail](campaign.schema.md) – `https://ns.adobe.com/experience/adcloud/campaign` + + + + + +## https://ns.adobe.com/experience/adcloud/conversionDetails +### Ad Conversion Details + +Search Ad Conversion Details. + +`https://ns.adobe.com/experience/adcloud/conversionDetails` +* is optional +* type: Conversion Details +* defined in this schema + +### https://ns.adobe.com/experience/adcloud/conversionDetails Type + + +* [Conversion Details](conversiondetails.schema.md) – `https://ns.adobe.com/experience/adcloud/conversiondetails` + + + + + +## https://ns.adobe.com/experience/adcloud/eventType +### Event Type + +Adobe Advertising Cloud event type. + +`https://ns.adobe.com/experience/adcloud/eventType` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/adcloud/eventType Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/adcloud/fees +### Advertising Fees + +Advertising Fees Details. + +`https://ns.adobe.com/experience/adcloud/fees` +* is optional +* type: Advertising Fee Details +* defined in this schema + +### https://ns.adobe.com/experience/adcloud/fees Type + + +* [Advertising Fee Details](fees.schema.md) – `https://ns.adobe.com/experience/adcloud/fees` + + + + + +## https://ns.adobe.com/experience/adcloud/inventory +### Ad Inventory Details + +Adobe Advertising Cloud inventory details. + +`https://ns.adobe.com/experience/adcloud/inventory` +* is optional +* type: Adobe Advertising Cloud Inventory +* defined in this schema + +### https://ns.adobe.com/experience/adcloud/inventory Type + + +* [Adobe Advertising Cloud Inventory](inventory.schema.md) – `https://ns.adobe.com/experience/adcloud/inventory` + + + + + +## https://ns.adobe.com/experience/adcloud/productDetails +### Ad Product Details + +Adobe AdCloud Search Ad Product Details. + +`https://ns.adobe.com/experience/adcloud/productDetails` +* is optional +* type: Adobe Advertising Cloud Product Details displayed in Search Advertisement. +* defined in this schema + +### https://ns.adobe.com/experience/adcloud/productDetails Type + + +* [Adobe Advertising Cloud Product Details displayed in Search Advertisement.](productdetails.schema.md) – `https://ns.adobe.com/experience/adcloud/productdetails` + + + + + +## https://ns.adobe.com/experience/adcloud/stitchId +### Stitch ID Chosen + +ID from the ad servers through Adobe Advertising Cloud STATS to track click-through conversion on browsers that block third party cookies. + +`https://ns.adobe.com/experience/adcloud/stitchId` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/adcloud/stitchId Type + + +`string` + + + + + + +## xdm:eventMergeId +### ExperienceEvent merge ID + +An ID to correlate or merge multiple Experience events together that are essentially the same event or should be merged. This is intended to be populated by the data producer prior to ingestion. + +`xdm:eventMergeId` +* is optional +* type: `string` +* defined in [XDM ExperienceEvent](../../../classes/experienceevent.schema.md#xdmeventmergeid) + +### xdm:eventMergeId Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/adcloud/fees.schema.json b/docs/reference/adobe/experience/adcloud/fees.schema.json new file mode 100644 index 000000000..1b88e099b --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/fees.schema.json @@ -0,0 +1,124 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/adcloud/fees", + "title": "Advertising Fee Details", + "type": "object", + "description": "Adobe Advertising Cloud Fee Details.", + "definitions": { + "fees": { + "properties": { + "xdm:DSPMediaFees": { + "title": "DSP Media Fees", + "type": "number", + "description": "Media fees billable by DSP." + }, + "xdm:DSPDataFees": { + "title": "DSP Data Fees", + "type": "number", + "description": "Data fees billable by DSP." + }, + "xdm:DSPOtherFees": { + "title": "DSP Other Fees", + "type": "number", + "description": "Other fees billable by DSP." + }, + "xdm:accountMediaFees": { + "title": "Account Media Fees", + "type": "number", + "description": "Media fees for the account but not billable by DSP." + }, + "xdm:accountDataFees": { + "title": "Account Data Fees", + "type": "number", + "description": "Data fees for the account but not billable by DSP." + }, + "xdm:accountOtherFees": { + "title": "Account Other Fees", + "type": "number", + "description": "Other fees for the account but not billable by DSP." + }, + "xdm:advertiserMediaFees": { + "title": "Advertiser Media Fees", + "type": "number", + "description": "Media advertiser fees charged to the advertiser from the account." + }, + "xdm:advertiserDataFees": { + "title": "Advertiser Data Fees", + "type": "number", + "description": "Other advertiser fees charged to the advertiser from the account." + }, + "xdm:advertiserOtherFees": { + "title": "Advertiser Other Fees", + "type": "number", + "description": "Other advertiser fees charged to the advertiser from the account." + }, + "xdm:billableMediaNetSpend": { + "title": "Billable Media Net Spend", + "type": "number", + "description": "The billable net spend for media advertising." + }, + "xdm:totalMediaNetSpend": { + "title": "Total Media Net Spend", + "type": "number", + "description": "The total net spend for media advertising." + }, + "xdm:billableDataNetSpend": { + "title": "Billable Data Net Spend", + "type": "number", + "description": "The billable net spend for data advertising." + }, + "xdm:billableOtherNetSpend": { + "title": "Billable Other Net Spend", + "type": "number", + "description": "The billable net spend for other types of advertising." + }, + "xdm:totalBillableNetSpend": { + "title": "Total Billable Net Spend", + "type": "number", + "description": "The total billable net spend." + }, + "xdm:totalNonBillableNetSpend": { + "title": "Total Non-Billable Net Spend", + "type": "number", + "description": "The total non-billable net spend" + }, + "xdm:totalNetSpend": { + "title": "Total Net Spend", + "type": "number", + "description": "The total net spend." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/fees" + } + ], + "examples": [ + { + "xdm:DSPMediaFee": 23, + "xdm:DSPDataFees": 55, + "xdm:DSPOtherFees": 2212313, + "xdm:accountMediaFee": 555, + "xdm:accountDataFees": 35353, + "xdm:accountOtherFees": 257600311580, + "xdm:advertiserMediaFee": 301404063528, + "xdm:advertiserDataFees": 147741280, + "xdm:advertiserOtherFees": 257600311580, + "xdm:billableMediaNetSpend": 232434, + "xdm:totalMediaNetSpend": 344, + "xdm:billableDataNetSpend": 6676767, + "xdm:billableOtherNetSpend": 34545, + "xdm:totalBillableNetSpend": 998, + "xdm:totalNonBillableNetSpend": 777, + "xdm:totalNetSpend": 5656875433 + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/fees.schema.md b/docs/reference/adobe/experience/adcloud/fees.schema.md new file mode 100644 index 000000000..3dc4c099c --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/fees.schema.md @@ -0,0 +1,376 @@ + +# Advertising Fee Details Schema + +``` +https://ns.adobe.com/experience/adcloud/fees +``` + +Adobe Advertising Cloud Fee Details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/adcloud/fees.schema.json](adobe/experience/adcloud/fees.schema.json) | + +## Advertising Fee Details Example +```json +{ + "xdm:DSPMediaFee": 23, + "xdm:DSPDataFees": 55, + "xdm:DSPOtherFees": 2212313, + "xdm:accountMediaFee": 555, + "xdm:accountDataFees": 35353, + "xdm:accountOtherFees": 257600311580, + "xdm:advertiserMediaFee": 301404063528, + "xdm:advertiserDataFees": 147741280, + "xdm:advertiserOtherFees": 257600311580, + "xdm:billableMediaNetSpend": 232434, + "xdm:totalMediaNetSpend": 344, + "xdm:billableDataNetSpend": 6676767, + "xdm:billableOtherNetSpend": 34545, + "xdm:totalBillableNetSpend": 998, + "xdm:totalNonBillableNetSpend": 777, + "xdm:totalNetSpend": 5656875433 +} +``` + +# Advertising Fee Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:DSPDataFees](#xdmdspdatafees) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:DSPMediaFees](#xdmdspmediafees) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:DSPOtherFees](#xdmdspotherfees) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:accountDataFees](#xdmaccountdatafees) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:accountMediaFees](#xdmaccountmediafees) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:accountOtherFees](#xdmaccountotherfees) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:advertiserDataFees](#xdmadvertiserdatafees) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:advertiserMediaFees](#xdmadvertisermediafees) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:advertiserOtherFees](#xdmadvertiserotherfees) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:billableDataNetSpend](#xdmbillabledatanetspend) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:billableMediaNetSpend](#xdmbillablemedianetspend) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:billableOtherNetSpend](#xdmbillableothernetspend) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:totalBillableNetSpend](#xdmtotalbillablenetspend) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:totalMediaNetSpend](#xdmtotalmedianetspend) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:totalNetSpend](#xdmtotalnetspend) | `number` | Optional | Advertising Fee Details (this schema) | +| [xdm:totalNonBillableNetSpend](#xdmtotalnonbillablenetspend) | `number` | Optional | Advertising Fee Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:DSPDataFees +### DSP Data Fees + +Data fees billable by DSP. + +`xdm:DSPDataFees` +* is optional +* type: `number` +* defined in this schema + +### xdm:DSPDataFees Type + + +`number` + + + + + + +## xdm:DSPMediaFees +### DSP Media Fees + +Media fees billable by DSP. + +`xdm:DSPMediaFees` +* is optional +* type: `number` +* defined in this schema + +### xdm:DSPMediaFees Type + + +`number` + + + + + + +## xdm:DSPOtherFees +### DSP Other Fees + +Other fees billable by DSP. + +`xdm:DSPOtherFees` +* is optional +* type: `number` +* defined in this schema + +### xdm:DSPOtherFees Type + + +`number` + + + + + + +## xdm:accountDataFees +### Account Data Fees + +Data fees for the account but not billable by DSP. + +`xdm:accountDataFees` +* is optional +* type: `number` +* defined in this schema + +### xdm:accountDataFees Type + + +`number` + + + + + + +## xdm:accountMediaFees +### Account Media Fees + +Media fees for the account but not billable by DSP. + +`xdm:accountMediaFees` +* is optional +* type: `number` +* defined in this schema + +### xdm:accountMediaFees Type + + +`number` + + + + + + +## xdm:accountOtherFees +### Account Other Fees + +Other fees for the account but not billable by DSP. + +`xdm:accountOtherFees` +* is optional +* type: `number` +* defined in this schema + +### xdm:accountOtherFees Type + + +`number` + + + + + + +## xdm:advertiserDataFees +### Advertiser Data Fees + +Other advertiser fees charged to the advertiser from the account. + +`xdm:advertiserDataFees` +* is optional +* type: `number` +* defined in this schema + +### xdm:advertiserDataFees Type + + +`number` + + + + + + +## xdm:advertiserMediaFees +### Advertiser Media Fees + +Media advertiser fees charged to the advertiser from the account. + +`xdm:advertiserMediaFees` +* is optional +* type: `number` +* defined in this schema + +### xdm:advertiserMediaFees Type + + +`number` + + + + + + +## xdm:advertiserOtherFees +### Advertiser Other Fees + +Other advertiser fees charged to the advertiser from the account. + +`xdm:advertiserOtherFees` +* is optional +* type: `number` +* defined in this schema + +### xdm:advertiserOtherFees Type + + +`number` + + + + + + +## xdm:billableDataNetSpend +### Billable Data Net Spend + +The billable net spend for data advertising. + +`xdm:billableDataNetSpend` +* is optional +* type: `number` +* defined in this schema + +### xdm:billableDataNetSpend Type + + +`number` + + + + + + +## xdm:billableMediaNetSpend +### Billable Media Net Spend + +The billable net spend for media advertising. + +`xdm:billableMediaNetSpend` +* is optional +* type: `number` +* defined in this schema + +### xdm:billableMediaNetSpend Type + + +`number` + + + + + + +## xdm:billableOtherNetSpend +### Billable Other Net Spend + +The billable net spend for other types of advertising. + +`xdm:billableOtherNetSpend` +* is optional +* type: `number` +* defined in this schema + +### xdm:billableOtherNetSpend Type + + +`number` + + + + + + +## xdm:totalBillableNetSpend +### Total Billable Net Spend + +The total billable net spend. + +`xdm:totalBillableNetSpend` +* is optional +* type: `number` +* defined in this schema + +### xdm:totalBillableNetSpend Type + + +`number` + + + + + + +## xdm:totalMediaNetSpend +### Total Media Net Spend + +The total net spend for media advertising. + +`xdm:totalMediaNetSpend` +* is optional +* type: `number` +* defined in this schema + +### xdm:totalMediaNetSpend Type + + +`number` + + + + + + +## xdm:totalNetSpend +### Total Net Spend + +The total net spend. + +`xdm:totalNetSpend` +* is optional +* type: `number` +* defined in this schema + +### xdm:totalNetSpend Type + + +`number` + + + + + + +## xdm:totalNonBillableNetSpend +### Total Non-Billable Net Spend + +The total non-billable net spend + +`xdm:totalNonBillableNetSpend` +* is optional +* type: `number` +* defined in this schema + +### xdm:totalNonBillableNetSpend Type + + +`number` + + + + + diff --git a/docs/reference/adobe/experience/adcloud/inventory.schema.json b/docs/reference/adobe/experience/adcloud/inventory.schema.json new file mode 100644 index 000000000..e21ad7dff --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/inventory.schema.json @@ -0,0 +1,91 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/adcloud/inventory", + "title": "Adobe Advertising Cloud Inventory", + "type": "object", + "description": "Adobe Advertising Cloud inventory traits.", + "definitions": { + "inventory": { + "properties": { + "xdm:sessionId": { + "title": "Session ID", + "type": "string", + "description": "Session ID associated with experience event, used to stitch together independent events which occurred in the same session." + }, + "xdm:feedId": { + "title": "Feed ID", + "type": "string", + "description": "Composite ID of the publisher, ad exchange, and other features." + }, + "xdm:sspPartnerCode": { + "title": "SSP Partner Code", + "type": "string", + "description": "The partner (exchange) through which Adobe Advertising Cloud receives the inventory opportunity." + }, + "xdm:siteId": { + "title": "Site ID", + "type": "string", + "description": "Identifier for the web site where ad impression was served." + }, + "xdm:costCurrency": { + "title": "Cost Currency", + "type": "string", + "examples": [ + "USD", + "EUR" + ], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 currency code used to pay partner for in ad opportunity." + }, + "xdm:inventorySourceId": { + "title": "Inventory Source ID", + "type": "string", + "description": "The ID of the Adobe Advertising Cloud inventory source this opportunity was delivered on." + }, + "xdm:segment": { + "title": "Segmentation Details", + "$ref": "https://ns.adobe.com/experience/adcloud/segment", + "description": "Details associated with user segmentation rules." + }, + "xdm:optimizationTag": { + "title": "Optimization tag", + "type": "string", + "description": "Tag related with Optimization/ML." + }, + "xdm:attributableDeviceGraphId": { + "title": "Attributable Device Graph Identifier", + "type": "string", + "description": "Identifier for the device graph attributable to a conversion event." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/inventory" + } + ], + "examples": [ + { + "xdm:sessionId": "8ba48d0a-dd4a-41fb-a258-80c824186f11.1", + "xdm:feedId": "1234556", + "xdm:sspPartnerCode": "spotx", + "xdm:siteId": "987654", + "xdm:costCurrency": "USD", + "xdm:inventorySourceId": "9", + "xdm:segment": { + "xdm:attributablePartnerId": "13", + "xdm:attributableSegmentId": "123445", + "xdm:segments": "AbbKlvGfgVH7WK2TH6jd,5lmd4aQCvvrv1yIhjlLQ,9uGk1eYROeHVWiGAOR4p" + }, + "xdm:optimizationTag": "explt", + "xdm:attributableDeviceGraphId": "1000" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/inventory.schema.md b/docs/reference/adobe/experience/adcloud/inventory.schema.md new file mode 100644 index 000000000..6262659ec --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/inventory.schema.md @@ -0,0 +1,249 @@ + +# Adobe Advertising Cloud Inventory Schema + +``` +https://ns.adobe.com/experience/adcloud/inventory +``` + +Adobe Advertising Cloud inventory traits. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/adcloud/inventory.schema.json](adobe/experience/adcloud/inventory.schema.json) | +## Schema Hierarchy + +* Adobe Advertising Cloud Inventory `https://ns.adobe.com/experience/adcloud/inventory` + * [Adobe Advertising Cloud Segment Detail](segment.schema.md) `https://ns.adobe.com/experience/adcloud/segment` + + +## Adobe Advertising Cloud Inventory Example +```json +{ + "xdm:sessionId": "8ba48d0a-dd4a-41fb-a258-80c824186f11.1", + "xdm:feedId": "1234556", + "xdm:sspPartnerCode": "spotx", + "xdm:siteId": "987654", + "xdm:costCurrency": "USD", + "xdm:inventorySourceId": "9", + "xdm:segment": { + "xdm:attributablePartnerId": "13", + "xdm:attributableSegmentId": "123445", + "xdm:segments": "AbbKlvGfgVH7WK2TH6jd,5lmd4aQCvvrv1yIhjlLQ,9uGk1eYROeHVWiGAOR4p" + }, + "xdm:optimizationTag": "explt", + "xdm:attributableDeviceGraphId": "1000" +} +``` + +# Adobe Advertising Cloud Inventory Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:attributableDeviceGraphId](#xdmattributabledevicegraphid) | `string` | Optional | Adobe Advertising Cloud Inventory (this schema) | +| [xdm:costCurrency](#xdmcostcurrency) | `string` | Optional | Adobe Advertising Cloud Inventory (this schema) | +| [xdm:feedId](#xdmfeedid) | `string` | Optional | Adobe Advertising Cloud Inventory (this schema) | +| [xdm:inventorySourceId](#xdminventorysourceid) | `string` | Optional | Adobe Advertising Cloud Inventory (this schema) | +| [xdm:optimizationTag](#xdmoptimizationtag) | `string` | Optional | Adobe Advertising Cloud Inventory (this schema) | +| [xdm:segment](#xdmsegment) | Adobe Advertising Cloud Segment Detail | Optional | Adobe Advertising Cloud Inventory (this schema) | +| [xdm:sessionId](#xdmsessionid) | `string` | Optional | Adobe Advertising Cloud Inventory (this schema) | +| [xdm:siteId](#xdmsiteid) | `string` | Optional | Adobe Advertising Cloud Inventory (this schema) | +| [xdm:sspPartnerCode](#xdmssppartnercode) | `string` | Optional | Adobe Advertising Cloud Inventory (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:attributableDeviceGraphId +### Attributable Device Graph Identifier + +Identifier for the device graph attributable to a conversion event. + +`xdm:attributableDeviceGraphId` +* is optional +* type: `string` +* defined in this schema + +### xdm:attributableDeviceGraphId Type + + +`string` + + + + + + +## xdm:costCurrency +### Cost Currency + +The ISO 4217 currency code used to pay partner for in ad opportunity. + +`xdm:costCurrency` +* is optional +* type: `string` +* defined in this schema + +### xdm:costCurrency Type + + +`string` + + +All instances must conform to this regular expression +```regex +^[A-Z]{3}$ +``` + +* test example: [USD](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=USD) +* test example: [EUR](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=EUR) + + + + +### xdm:costCurrency Examples + +```json +"USD" +``` + +```json +"EUR" +``` + + + +## xdm:feedId +### Feed ID + +Composite ID of the publisher, ad exchange, and other features. + +`xdm:feedId` +* is optional +* type: `string` +* defined in this schema + +### xdm:feedId Type + + +`string` + + + + + + +## xdm:inventorySourceId +### Inventory Source ID + +The ID of the Adobe Advertising Cloud inventory source this opportunity was delivered on. + +`xdm:inventorySourceId` +* is optional +* type: `string` +* defined in this schema + +### xdm:inventorySourceId Type + + +`string` + + + + + + +## xdm:optimizationTag +### Optimization tag + +Tag related with Optimization/ML. + +`xdm:optimizationTag` +* is optional +* type: `string` +* defined in this schema + +### xdm:optimizationTag Type + + +`string` + + + + + + +## xdm:segment +### Segmentation Details + +Details associated with user segmentation rules. + +`xdm:segment` +* is optional +* type: Adobe Advertising Cloud Segment Detail +* defined in this schema + +### xdm:segment Type + + +* [Adobe Advertising Cloud Segment Detail](segment.schema.md) – `https://ns.adobe.com/experience/adcloud/segment` + + + + + +## xdm:sessionId +### Session ID + +Session ID associated with experience event, used to stitch together independent events which occurred in the same session. + +`xdm:sessionId` +* is optional +* type: `string` +* defined in this schema + +### xdm:sessionId Type + + +`string` + + + + + + +## xdm:siteId +### Site ID + +Identifier for the web site where ad impression was served. + +`xdm:siteId` +* is optional +* type: `string` +* defined in this schema + +### xdm:siteId Type + + +`string` + + + + + + +## xdm:sspPartnerCode +### SSP Partner Code + +The partner (exchange) through which Adobe Advertising Cloud receives the inventory opportunity. + +`xdm:sspPartnerCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:sspPartnerCode Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/adcloud/partnerdata.schema.json b/docs/reference/adobe/experience/adcloud/partnerdata.schema.json new file mode 100644 index 000000000..fb384ca2e --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/partnerdata.schema.json @@ -0,0 +1,41 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/adcloud/partnerdata", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Advertising Cloud Partner Data", + "type": "object", + "description": "Details related to Adobe Advertising Cloud partner data such as data associated with a segment and search and marketing partner IDs.", + "definitions": { + "partnerdata": { + "properties": { + "xdm:id": { + "title": "Search/Marketing partner ID", + "type": "string", + "description": "Internal mapping of search/marketing platforms/partners to IDs for Adobe Advertising Cloud search." + }, + "xdm:data": { + "title": "Search/Marketing partner data associated with a segment", + "type": "string", + "description": "Unique identifiers such conversion ID (in case of Google) associated with the synced segment." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/partnerdata" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:id": "2", + "xdm:data": "sample-conversion-id-123" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/partnerdata.schema.md b/docs/reference/adobe/experience/adcloud/partnerdata.schema.md new file mode 100644 index 000000000..699657299 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/partnerdata.schema.md @@ -0,0 +1,68 @@ + +# Adobe Advertising Cloud Partner Data Schema + +``` +https://ns.adobe.com/experience/adcloud/partnerdata +``` + +Details related to Adobe Advertising Cloud partner data such as data associated with a segment and search and marketing partner IDs. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/adcloud/partnerdata.schema.json](adobe/experience/adcloud/partnerdata.schema.json) | + +## Adobe Advertising Cloud Partner Data Example +```json +{ + "xdm:id": "2", + "xdm:data": "sample-conversion-id-123" +} +``` + +# Adobe Advertising Cloud Partner Data Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:data](#xdmdata) | `string` | Optional | Adobe Advertising Cloud Partner Data (this schema) | +| [xdm:id](#xdmid) | `string` | Optional | Adobe Advertising Cloud Partner Data (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:data +### Search/Marketing partner data associated with a segment + +Unique identifiers such conversion ID (in case of Google) associated with the synced segment. + +`xdm:data` +* is optional +* type: `string` +* defined in this schema + +### xdm:data Type + + +`string` + + + + + + +## xdm:id +### Search/Marketing partner ID + +Internal mapping of search/marketing platforms/partners to IDs for Adobe Advertising Cloud search. + +`xdm:id` +* is optional +* type: `string` +* defined in this schema + +### xdm:id Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/adcloud/productdetails.schema.json b/docs/reference/adobe/experience/adcloud/productdetails.schema.json new file mode 100644 index 000000000..58044777a --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/productdetails.schema.json @@ -0,0 +1,71 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/adcloud/productdetails", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Advertising Cloud Product Details displayed in Search Advertisement.", + "type": "object", + "description": "Adobe Advertising Cloud Search Product Details.", + "definitions": { + "productdetails": { + "properties": { + "xdm:productID": { + "title": "Product Identifier", + "type": "string", + "description": "Identifier for the product featured in the clicked advertisement." + }, + "xdm:country": { + "title": "Product Country", + "type": "string", + "description": "The country of sale for the product in the clicked ad." + }, + "xdm:language": { + "title": "Product Language", + "type": "string", + "description": "The language of your product information, as indicated in client's Merchant Center data feed." + }, + "xdm:partitionID": { + "title": "Product Partition Identifier", + "type": "string", + "description": "Identifier for the product group the clicked product advertisement belongs to." + }, + "xdm:title": { + "title": "Product Title", + "type": "string", + "description": "Product title value shown in the advertisement." + }, + "xdm:adType": { + "title": "Product Ad Type", + "type": "string", + "description": "Ad Type for Product used in Google Shopping Campaigns.", + "meta:enum": { + "pla_with_pog": "If the click is coming from a Purchases on Google-enabled Shopping ad", + "pla": "If the click is coming from a Shopping ad", + "pla_multichannel": "If the clicked Shopping ad included options for both “online” and “local” shopping channels.", + "pla_with_promotion": "If the clicked Shopping ad displayed a merchant promotion." + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/productdetails" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:productID": "LSTTDSF9J4DQYH8ZZZUSDBCRG", + "xdm:country": "IN", + "xdm:language": "en", + "xdm:partitionID": "342294687595", + "xdm:title": "Winter Jacket", + "xdm:adType": "pla" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/productdetails.schema.md b/docs/reference/adobe/experience/adcloud/productdetails.schema.md new file mode 100644 index 000000000..c5c18cc2d --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/productdetails.schema.md @@ -0,0 +1,164 @@ + +# Adobe Advertising Cloud Product Details displayed in Search Advertisement. Schema + +``` +https://ns.adobe.com/experience/adcloud/productdetails +``` + +Adobe Advertising Cloud Search Product Details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/adcloud/productdetails.schema.json](adobe/experience/adcloud/productdetails.schema.json) | + +## Adobe Advertising Cloud Product Details displayed in Search Advertisement. Example +```json +{ + "xdm:productID": "LSTTDSF9J4DQYH8ZZZUSDBCRG", + "xdm:country": "IN", + "xdm:language": "en", + "xdm:partitionID": "342294687595", + "xdm:title": "Winter Jacket", + "xdm:adType": "pla" +} +``` + +# Adobe Advertising Cloud Product Details displayed in Search Advertisement. Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:adType](#xdmadtype) | `string` | Optional | Adobe Advertising Cloud Product Details displayed in Search Advertisement. (this schema) | +| [xdm:country](#xdmcountry) | `string` | Optional | Adobe Advertising Cloud Product Details displayed in Search Advertisement. (this schema) | +| [xdm:language](#xdmlanguage) | `string` | Optional | Adobe Advertising Cloud Product Details displayed in Search Advertisement. (this schema) | +| [xdm:partitionID](#xdmpartitionid) | `string` | Optional | Adobe Advertising Cloud Product Details displayed in Search Advertisement. (this schema) | +| [xdm:productID](#xdmproductid) | `string` | Optional | Adobe Advertising Cloud Product Details displayed in Search Advertisement. (this schema) | +| [xdm:title](#xdmtitle) | `string` | Optional | Adobe Advertising Cloud Product Details displayed in Search Advertisement. (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:adType +### Product Ad Type + +Ad Type for Product used in Google Shopping Campaigns. + +`xdm:adType` +* is optional +* type: `string` +* defined in this schema + +### xdm:adType Type + + +`string` + + + +### xdm:adType Known Values +| Value | Description | +|-------|-------------| +| `pla_with_pog` | If the click is coming from a Purchases on Google-enabled Shopping ad | +| `pla` | If the click is coming from a Shopping ad | +| `pla_multichannel` | If the clicked Shopping ad included options for both “online” and “local” shopping channels. | +| `pla_with_promotion` | If the clicked Shopping ad displayed a merchant promotion. | + + + + +## xdm:country +### Product Country + +The country of sale for the product in the clicked ad. + +`xdm:country` +* is optional +* type: `string` +* defined in this schema + +### xdm:country Type + + +`string` + + + + + + +## xdm:language +### Product Language + +The language of your product information, as indicated in client's Merchant Center data feed. + +`xdm:language` +* is optional +* type: `string` +* defined in this schema + +### xdm:language Type + + +`string` + + + + + + +## xdm:partitionID +### Product Partition Identifier + +Identifier for the product group the clicked product advertisement belongs to. + +`xdm:partitionID` +* is optional +* type: `string` +* defined in this schema + +### xdm:partitionID Type + + +`string` + + + + + + +## xdm:productID +### Product Identifier + +Identifier for the product featured in the clicked advertisement. + +`xdm:productID` +* is optional +* type: `string` +* defined in this schema + +### xdm:productID Type + + +`string` + + + + + + +## xdm:title +### Product Title + +Product title value shown in the advertisement. + +`xdm:title` +* is optional +* type: `string` +* defined in this schema + +### xdm:title Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/adcloud/profile-all.schema.json b/docs/reference/adobe/experience/adcloud/profile-all.schema.json new file mode 100644 index 000000000..f0b84fe05 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/profile-all.schema.json @@ -0,0 +1,74 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/adcloud/profile-all", + "title": "Adobe Advertising Cloud Profile Full Extension", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "Details related to Adobe Advertising Cloud ExperienceEvent full extension. Contains all Solution added fields.", + "definitions": { + "profile-all": { + "properties": { + "xdm:syncedRemarketingAudiences": { + "title": "Synchronized Segments", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/experience/adcloud/syncedremarketingaudience" + }, + "description": "List of search retargeting entities that have been synced with the Adobe Advertising Cloud partner to build audiences on the platform, e.g. RLSA for Google, WCA for Facebook." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/profile-all" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:syncedRemarketingAudiences": [ + { + "xdm:segmentID": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9", + "xdm:segmentType": 3, + "xdm:timestamp": "2018-08-07T08:06:34.672Z", + "xdm:partnerDetails": [ + { + "xdm:id": "2", + "xdm:data": "sample-conversion-id-123" + }, + { + "xdm:id": "1", + "xdm:data": "sample-conversion-id-124" + } + ] + }, + { + "xdm:segmentID": "https://data.adobe.io/entities/segmentidentity/53cba6b2-a23b-454a-8069-fc41308f1c0f", + "xdm:segmentType": 3, + "xdm:timestamp": "2018-08-07T08:06:34.672Z", + "xdm:partnerDetails": [ + { + "xdm:id": "2", + "xdm:data": "sample-conversion-id-125" + }, + { + "xdm:id": "1", + "xdm:data": "sample-conversion-id-126" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/profile-all.schema.md b/docs/reference/adobe/experience/adcloud/profile-all.schema.md new file mode 100644 index 000000000..6fb23e14b --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/profile-all.schema.md @@ -0,0 +1,83 @@ + +# Adobe Advertising Cloud Profile Full Extension Schema + +``` +https://ns.adobe.com/experience/adcloud/profile-all +``` + +Details related to Adobe Advertising Cloud ExperienceEvent full extension. Contains all Solution added fields. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/adcloud/profile-all.schema.json](adobe/experience/adcloud/profile-all.schema.json) | + +## Adobe Advertising Cloud Profile Full Extension Example +```json +{ + "xdm:syncedRemarketingAudiences": [ + { + "xdm:segmentID": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9", + "xdm:segmentType": 3, + "xdm:timestamp": "2018-08-07T08:06:34.672Z", + "xdm:partnerDetails": [ + { + "xdm:id": "2", + "xdm:data": "sample-conversion-id-123" + }, + { + "xdm:id": "1", + "xdm:data": "sample-conversion-id-124" + } + ] + }, + { + "xdm:segmentID": "https://data.adobe.io/entities/segmentidentity/53cba6b2-a23b-454a-8069-fc41308f1c0f", + "xdm:segmentType": 3, + "xdm:timestamp": "2018-08-07T08:06:34.672Z", + "xdm:partnerDetails": [ + { + "xdm:id": "2", + "xdm:data": "sample-conversion-id-125" + }, + { + "xdm:id": "1", + "xdm:data": "sample-conversion-id-126" + } + ] + } + ] +} +``` + +# Adobe Advertising Cloud Profile Full Extension Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:syncedRemarketingAudiences](#xdmsyncedremarketingaudiences) | Synchronized Remarketing Audiences | Optional | Adobe Advertising Cloud Profile Full Extension (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:syncedRemarketingAudiences +### Synchronized Segments + +List of search retargeting entities that have been synced with the Adobe Advertising Cloud partner to build audiences on the platform, e.g. RLSA for Google, WCA for Facebook. + +`xdm:syncedRemarketingAudiences` +* is optional +* type: Synchronized Remarketing Audiences + +* defined in this schema + +### xdm:syncedRemarketingAudiences Type + + +Array type: Synchronized Remarketing Audiences + +All items must be of the type: +* [Synchronized Remarketing Audiences](syncedremarketingaudience.schema.md) – `https://ns.adobe.com/experience/adcloud/syncedremarketingaudience` + + + + + + + diff --git a/docs/reference/adobe/experience/adcloud/segment.schema.json b/docs/reference/adobe/experience/adcloud/segment.schema.json new file mode 100644 index 000000000..acd316780 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/segment.schema.json @@ -0,0 +1,46 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/adcloud/segment", + "title": "Adobe Advertising Cloud Segment Detail", + "type": "object", + "description": "Adobe Advertising Cloud segmentation traits.", + "definitions": { + "segment": { + "properties": { + "xdm:attributablePartnerId": { + "title": "Attributable Partner ID", + "type": "string", + "description": "The segment provider who owns the attributableSegmentId." + }, + "xdm:attributableSegmentId": { + "title": "Attributable Segment ID", + "type": "string", + "description": "The single segment accredit for user targeting among all the segments in the placement's targeting rule for the purposes of tracking costs and paying partners." + }, + "xdm:segments": { + "title": "Segments", + "type": "string", + "description": "The intersection of the user segments that both: a) the user belonged to, and b) the ad was targeting. NOT the full list of segments that the user belonged to at the time of the auction." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/segment" + } + ], + "examples": [ + { + "xdm:attributablePartnerId": "13", + "xdm:attributableSegmentId": "123445", + "xdm:segments": "AbbKlvGfgVH7WK2TH6jd,5lmd4aQCvvrv1yIhjlLQ,9uGk1eYROeHVWiGAOR4p" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/segment.schema.md b/docs/reference/adobe/experience/adcloud/segment.schema.md new file mode 100644 index 000000000..03ccd6733 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/segment.schema.md @@ -0,0 +1,90 @@ + +# Adobe Advertising Cloud Segment Detail Schema + +``` +https://ns.adobe.com/experience/adcloud/segment +``` + +Adobe Advertising Cloud segmentation traits. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/adcloud/segment.schema.json](adobe/experience/adcloud/segment.schema.json) | + +## Adobe Advertising Cloud Segment Detail Example +```json +{ + "xdm:attributablePartnerId": "13", + "xdm:attributableSegmentId": "123445", + "xdm:segments": "AbbKlvGfgVH7WK2TH6jd,5lmd4aQCvvrv1yIhjlLQ,9uGk1eYROeHVWiGAOR4p" +} +``` + +# Adobe Advertising Cloud Segment Detail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:attributablePartnerId](#xdmattributablepartnerid) | `string` | Optional | Adobe Advertising Cloud Segment Detail (this schema) | +| [xdm:attributableSegmentId](#xdmattributablesegmentid) | `string` | Optional | Adobe Advertising Cloud Segment Detail (this schema) | +| [xdm:segments](#xdmsegments) | `string` | Optional | Adobe Advertising Cloud Segment Detail (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:attributablePartnerId +### Attributable Partner ID + +The segment provider who owns the attributableSegmentId. + +`xdm:attributablePartnerId` +* is optional +* type: `string` +* defined in this schema + +### xdm:attributablePartnerId Type + + +`string` + + + + + + +## xdm:attributableSegmentId +### Attributable Segment ID + +The single segment accredit for user targeting among all the segments in the placement's targeting rule for the purposes of tracking costs and paying partners. + +`xdm:attributableSegmentId` +* is optional +* type: `string` +* defined in this schema + +### xdm:attributableSegmentId Type + + +`string` + + + + + + +## xdm:segments +### Segments + +The intersection of the user segments that both: a) the user belonged to, and b) the ad was targeting. NOT the full list of segments that the user belonged to at the time of the auction. + +`xdm:segments` +* is optional +* type: `string` +* defined in this schema + +### xdm:segments Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/adcloud/syncedremarketingaudience.schema.json b/docs/reference/adobe/experience/adcloud/syncedremarketingaudience.schema.json new file mode 100644 index 000000000..fd2d0554b --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/syncedremarketingaudience.schema.json @@ -0,0 +1,65 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/adcloud/syncedremarketingaudience", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Synchronized Remarketing Audiences", + "type": "object", + "description": "Details about Adobe Advertising Cloud search segments used for retargeting surfers on a search and/or marketing platform.", + "definitions": { + "syncedremarketingaudience": { + "properties": { + "xdm:segmentID": { + "title": "Segment ID", + "type": "string", + "description": "ID for the segment that would be used to retarget the surfer." + }, + "xdm:type": { + "title": "Segment/Audience Type", + "type": "integer", + "description": "Type of segment, eg. AAM." + }, + "xdm:timestamp": { + "title": "Timestamp", + "type": "string", + "format": "date-time", + "description": "The timestamp when the retargeting entity, e.g. aam-segment, was synced to the marketing platform." + }, + "xdm:partnerDetails": { + "title": "Marketing Partner Details", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/experience/adcloud/partnerdata" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/syncedremarketingaudience" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:segmentId": "https://data.adobe.io/entities/aam-segment/4238827", + "xdm:segmentType": 3, + "xdm:timestamp": "2018-08-07T08:06:34.672Z", + "xdm:partnerDetails": [ + { + "xdm:id": "2", + "xdm:data": "sample-conversion-id-123" + }, + { + "xdm:id": "1", + "xdm:data": "sample-conversion-id-124" + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/adcloud/syncedremarketingaudience.schema.md b/docs/reference/adobe/experience/adcloud/syncedremarketingaudience.schema.md new file mode 100644 index 000000000..db7f29500 --- /dev/null +++ b/docs/reference/adobe/experience/adcloud/syncedremarketingaudience.schema.md @@ -0,0 +1,126 @@ + +# Synchronized Remarketing Audiences Schema + +``` +https://ns.adobe.com/experience/adcloud/syncedremarketingaudience +``` + +Details about Adobe Advertising Cloud search segments used for retargeting surfers on a search and/or marketing platform. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/adcloud/syncedremarketingaudience.schema.json](adobe/experience/adcloud/syncedremarketingaudience.schema.json) | + +## Synchronized Remarketing Audiences Example +```json +{ + "xdm:segmentId": "https://data.adobe.io/entities/aam-segment/4238827", + "xdm:segmentType": 3, + "xdm:timestamp": "2018-08-07T08:06:34.672Z", + "xdm:partnerDetails": [ + { + "xdm:id": "2", + "xdm:data": "sample-conversion-id-123" + }, + { + "xdm:id": "1", + "xdm:data": "sample-conversion-id-124" + } + ] +} +``` + +# Synchronized Remarketing Audiences Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:partnerDetails](#xdmpartnerdetails) | Adobe Advertising Cloud Partner Data | Optional | Synchronized Remarketing Audiences (this schema) | +| [xdm:segmentID](#xdmsegmentid) | `string` | Optional | Synchronized Remarketing Audiences (this schema) | +| [xdm:timestamp](#xdmtimestamp) | `string` | Optional | Synchronized Remarketing Audiences (this schema) | +| [xdm:type](#xdmtype) | `integer` | Optional | Synchronized Remarketing Audiences (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:partnerDetails +### Marketing Partner Details + +`xdm:partnerDetails` +* is optional +* type: Adobe Advertising Cloud Partner Data + +* defined in this schema + +### xdm:partnerDetails Type + + +Array type: Adobe Advertising Cloud Partner Data + +All items must be of the type: +* [Adobe Advertising Cloud Partner Data](partnerdata.schema.md) – `https://ns.adobe.com/experience/adcloud/partnerdata` + + + + + + + + +## xdm:segmentID +### Segment ID + +ID for the segment that would be used to retarget the surfer. + +`xdm:segmentID` +* is optional +* type: `string` +* defined in this schema + +### xdm:segmentID Type + + +`string` + + + + + + +## xdm:timestamp +### Timestamp + +The timestamp when the retargeting entity, e.g. aam-segment, was synced to the marketing platform. + +`xdm:timestamp` +* is optional +* type: `string` +* defined in this schema + +### xdm:timestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:type +### Segment/Audience Type + +Type of segment, eg. AAM. + +`xdm:type` +* is optional +* type: `integer` +* defined in this schema + +### xdm:type Type + + +`integer` + + + + + diff --git a/docs/reference/adobe/experience/aep-web-sdk-experienceevent.schema.json b/docs/reference/adobe/experience/aep-web-sdk-experienceevent.schema.json new file mode 100644 index 000000000..34756cd32 --- /dev/null +++ b/docs/reference/adobe/experience/aep-web-sdk-experienceevent.schema.json @@ -0,0 +1,96 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/aep-web-sdk-experienceevent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "AEP Web SDK ExperienceEvent Mixin", + "type": "object", + "description": "Adobe Experience Platform Web SDK ExperienceEvent Mixin. Includes field definitions for automatically collected data by the AEP Web SDK (Alloy) library.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/experienceevent-implementation-details", + "https://ns.adobe.com/experience/experienceevent-edgeregion", + "https://ns.adobe.com/xdm/context/experienceevent-environment-details", + "https://ns.adobe.com/xdm/context/experienceevent-web" + ], + "definitions": { + "aep-web-sdk-experienceevent": { + "properties": {} + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-implementation-details" + }, + { + "$ref": "https://ns.adobe.com/experience/experienceevent-edgeregion" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-web" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:identityMap": { + "Email_LC_SHA256": [ + { + "id": "81d1a7135b9722577fb4f094a2004296d6230512d37b68e64b73f050b919f7c4", + "authenticatedState": "ambiguous", + "primary": true + } + ], + "HYP": [ + { + "id": "1234", + "authenticatedState": "ambiguous" + } + ] + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:URL": "http://localhost:3000/" + }, + "xdm:webReferrer": { + "xdm:URL": "" + } + }, + "xdm:device": { + "xdm:screenHeight": 1692, + "xdm:screenWidth": 3008, + "xdm:screenOrientation": "landscape" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:viewportWidth": 1586, + "xdm:viewportHeight": 555 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2020-01-07T15:11:14.143-07:00", + "xdm:localTimezoneOffset": 420 + }, + "xdm:timestamp": "2020-01-07T22:11:14.143Z", + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/alloy", + "xdm:version": "0.0.11" + }, + "xdm:eventType": "page-view" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/aep-web-sdk-experienceevent.schema.md b/docs/reference/adobe/experience/aep-web-sdk-experienceevent.schema.md new file mode 100644 index 000000000..c1d47c487 --- /dev/null +++ b/docs/reference/adobe/experience/aep-web-sdk-experienceevent.schema.md @@ -0,0 +1,394 @@ + +# AEP Web SDK ExperienceEvent Mixin Schema + +``` +https://ns.adobe.com/experience/aep-web-sdk-experienceevent +``` + +Adobe Experience Platform Web SDK ExperienceEvent Mixin. Includes field definitions for automatically collected data by the AEP Web SDK (Alloy) library. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/aep-web-sdk-experienceevent.schema.json](adobe/experience/aep-web-sdk-experienceevent.schema.json) | +## Schema Hierarchy + +* AEP Web SDK ExperienceEvent Mixin `https://ns.adobe.com/experience/aep-web-sdk-experienceevent` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [ExperienceEvent implementation details](../../mixins/experience-event/experienceevent-implementation-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-implementation-details` + * [Data capture region for Experience Events](experienceevent-edgeregion.schema.md) `https://ns.adobe.com/experience/experienceevent-edgeregion` + * [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-environment-details` + * [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-web` + + +## AEP Web SDK ExperienceEvent Mixin Example +```json +{ + "xdm:identityMap": { + "Email_LC_SHA256": [ + { + "id": "81d1a7135b9722577fb4f094a2004296d6230512d37b68e64b73f050b919f7c4", + "authenticatedState": "ambiguous", + "primary": true + } + ], + "HYP": [ + { + "id": "1234", + "authenticatedState": "ambiguous" + } + ] + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:URL": "http://localhost:3000/" + }, + "xdm:webReferrer": { + "xdm:URL": "" + } + }, + "xdm:device": { + "xdm:screenHeight": 1692, + "xdm:screenWidth": 3008, + "xdm:screenOrientation": "landscape" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:viewportWidth": 1586, + "xdm:viewportHeight": 555 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2020-01-07T15:11:14.143-07:00", + "xdm:localTimezoneOffset": 420 + }, + "xdm:timestamp": "2020-01-07T22:11:14.143Z", + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/alloy", + "xdm:version": "0.0.11" + }, + "xdm:eventType": "page-view" +} +``` + +# AEP Web SDK ExperienceEvent Mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:device](#xdmdevice) | Device | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) | +| [xdm:environment](#xdmenvironment) | Environment | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) | +| [xdm:implementationDetails](#xdmimplementationdetails) | Implementation details | Optional | [ExperienceEvent implementation details](../../mixins/experience-event/experienceevent-implementation-details.schema.md#xdmimplementationdetails) | +| [xdm:placeContext](#xdmplacecontext) | Place context | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) | +| [xdm:userActivityRegion](#xdmuseractivityregion) | `object` | Optional | [Data capture region for Experience Events](experienceevent-edgeregion.schema.md#xdmuseractivityregion) | +| [xdm:web](#xdmweb) | Web information | Optional | [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md#xdmweb) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:device +### Device + +An identified device, application or device browser instance that is trackable across sessions, normally by cookies. + +`xdm:device` +* is optional +* type: Device +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) + +### xdm:device Type + + +* [Device](../../datatypes/device.schema.md) – `https://ns.adobe.com/xdm/context/device` + + + + + +## xdm:environment +### Environment + +Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions. + +`xdm:environment` +* is optional +* type: Environment +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) + +### xdm:environment Type + + +* [Environment](../../datatypes/environment.schema.md) – `https://ns.adobe.com/xdm/context/environment` + + + + + +## xdm:implementationDetails +### Implementation details + +The details of the software used to collect the ExperienceEvent. + +`xdm:implementationDetails` +* is optional +* type: Implementation details +* defined in [ExperienceEvent implementation details](../../mixins/experience-event/experienceevent-implementation-details.schema.md#xdmimplementationdetails) + +### xdm:implementationDetails Type + + +* [Implementation details](../../datatypes/implementationdetails.schema.md) – `https://ns.adobe.com/xdm/context/implementationdetails` + + + + + +## xdm:placeContext +### Place context + +The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, and working hours. + +`xdm:placeContext` +* is optional +* type: Place context +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) + +### xdm:placeContext Type + + +* [Place context](../../datatypes/placecontext.schema.md) – `https://ns.adobe.com/xdm/context/placecontext` + + + + + +## xdm:userActivityRegion +### User activity region + +Region info where event is captured. + +`xdm:userActivityRegion` +* is optional +* type: `object` +* defined in [Data capture region for Experience Events](experienceevent-edgeregion.schema.md#xdmuseractivityregion) + +### xdm:userActivityRegion Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:captureTimestamp`| string | Optional | +| `xdm:dataCenterLocation`| string | Optional | + + + +#### xdm:captureTimestamp +##### Data Capture Timestamp + +The time when data was captured on data center node. + +`xdm:captureTimestamp` +* is optional +* type: `string` + +##### xdm:captureTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + +#### xdm:dataCenterLocation +##### Location of Data Center where data was captured + +undefined + +`xdm:dataCenterLocation` +* is optional +* type: `string` + +##### xdm:dataCenterLocation Type + + +`string` + + + +##### xdm:dataCenterLocation Known Values +| Value | Description | +|-------|-------------| +| `ARE1` | ARE1 | +| `ARE2` | ARE2 | +| `AUS1` | AUS1 | +| `AUS10` | AUS10 | +| `AUS2` | AUS2 | +| `AUS3` | AUS3 | +| `AUS4` | AUS4 | +| `AUS5` | AUS5 | +| `AUS6` | AUS6 | +| `AUS7` | AUS7 | +| `AUS8` | AUS8 | +| `AUS9` | AUS9 | +| `BEL1` | BEL1 | +| `BHR1` | BHR1 | +| `BRA2` | BRA2 | +| `BRA3` | BRA3 | +| `BRA4` | BRA4 | +| `CA1` | CA1 | +| `CA10` | CA10 | +| `CA12` | CA12 | +| `CA13` | CA13 | +| `CA14` | CA14 | +| `CA3` | CA3 | +| `CA4` | CA4 | +| `CA5` | CA5 | +| `CA6` | CA6 | +| `CA7` | CA7 | +| `CAN1` | CAN1 | +| `CAN2` | CAN2 | +| `CAN4` | CAN4 | +| `CAN5` | CAN5 | +| `CAN6` | CAN6 | +| `CAN7` | CAN7 | +| `CHE1` | CHE1 | +| `CHE2` | CHE2 | +| `CHE3` | CHE3 | +| `CHN1` | CHN1 | +| `CHN2` | CHN2 | +| `CHN3` | CHN3 | +| `CHN4` | CHN4 | +| `CHN5` | CHN5 | +| `CHN6` | CHN6 | +| `DEU1` | DEU1 | +| `DEU2` | DEU2 | +| `DEU4` | DEU4 | +| `DEU5` | DEU5 | +| `DEU6` | DEU6 | +| `DEU7` | DEU7 | +| `DNK1` | DNK1 | +| `FIN1` | FIN1 | +| `FRA10` | FRA10 | +| `FRA2` | FRA2 | +| `FRA3` | FRA3 | +| `FRA4` | FRA4 | +| `FRA5` | FRA5 | +| `FRA6` | FRA6 | +| `FRA7` | FRA7 | +| `FRA8` | FRA8 | +| `FRA9` | FRA9 | +| `GBR1` | GBR1 | +| `GBR10` | GBR10 | +| `GBR11` | GBR11 | +| `GBR12` | GBR12 | +| `GBR13` | GBR13 | +| `GBR5` | GBR5 | +| `GBR7` | GBR7 | +| `GBR8` | GBR8 | +| `GBR9` | GBR9 | +| `HKG1` | HKG1 | +| `HKG2` | HKG2 | +| `HKG3` | HKG3 | +| `HKG4` | HKG4 | +| `HKG5` | HKG5 | +| `IA1` | IA1 | +| `IA2` | IA2 | +| `IA3` | IA3 | +| `IA4` | IA4 | +| `IL1` | IL1 | +| `IND1` | IND1 | +| `IND2` | IND2 | +| `IND3` | IND3 | +| `IND4` | IND4 | +| `IND5` | IND5 | +| `IND6` | IND6 | +| `IRL1` | IRL1 | +| `IRL2` | IRL2 | +| `IRL3` | IRL3 | +| `JPN2` | JPN2 | +| `JPN3` | JPN3 | +| `JPN4` | JPN4 | +| `JPN5` | JPN5 | +| `JPN6` | JPN6 | +| `JPN7` | JPN7 | +| `JPN8` | JPN8 | +| `KOR1` | KOR1 | +| `KOR2` | KOR2 | +| `KOR3` | KOR3 | +| `MA1` | MA1 | +| `MA2` | MA2 | +| `MA3` | MA3 | +| `MDA1` | MDA1 | +| `NLD1` | NLD1 | +| `NLD2` | NLD2 | +| `NLD3` | NLD3 | +| `NLD4` | NLD4 | +| `NOR1` | NOR1 | +| `NOR2` | NOR2 | +| `NY7` | NY7 | +| `OH2` | OH2 | +| `OR1` | OR1 | +| `OR2` | OR2 | +| `OR3` | OR3 | +| `OR4` | OR4 | +| `ROU1` | ROU1 | +| `SC1` | SC1 | +| `SGP2` | SGP2 | +| `SGP3` | SGP3 | +| `SGP4` | SGP4 | +| `SGP5` | SGP5 | +| `SGP6` | SGP6 | +| `SGP7` | SGP7 | +| `SWE1` | SWE1 | +| `TWN1` | TWN1 | +| `TX3` | TX3 | +| `UT1` | UT1 | +| `UT2` | UT2 | +| `VA1` | VA1 | +| `VA10` | VA10 | +| `VA11` | VA11 | +| `VA12` | VA12 | +| `VA13` | VA13 | +| `VA14` | VA14 | +| `VA5` | VA5 | +| `VA6` | VA6 | +| `VA7` | VA7 | +| `VA8` | VA8 | +| `VA9` | VA9 | +| `WA1` | WA1 | +| `WA2` | WA2 | +| `WY1` | WY1 | +| `ZAF1` | ZAF1 | +| `ZAF2` | ZAF2 | + + + + + + + + + +## xdm:web +### Web + +The information related to web page and link of the ExperienceEvent. + +`xdm:web` +* is optional +* type: Web information +* defined in [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md#xdmweb) + +### xdm:web Type + + +* [Web information](../../datatypes/webinfo.schema.md) – `https://ns.adobe.com/xdm/context/webinfo` + + + + diff --git a/docs/reference/adobe/experience/analytics-experienceevent.schema.json b/docs/reference/adobe/experience/analytics-experienceevent.schema.json new file mode 100644 index 000000000..dc663793f --- /dev/null +++ b/docs/reference/adobe/experience/analytics-experienceevent.schema.json @@ -0,0 +1,228 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/analytics-experienceevent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Analytics ExperienceEvent Template Mixin", + "type": "object", + "description": "Analytics ExperienceEvent mixin for use with schemas for Solution data ingestion. Includes the core/standard ExperienceEvent as well as the required Adobe Analytics ExperienceEvent mixins.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/experienceevent-advertising", + "https://ns.adobe.com/xdm/context/experienceevent-application", + "https://ns.adobe.com/xdm/context/experienceevent-channel", + "https://ns.adobe.com/xdm/context/experienceevent-directmarketing", + "https://ns.adobe.com/xdm/context/experienceevent-environment-details", + "https://ns.adobe.com/xdm/context/experienceevent-marketing", + "https://ns.adobe.com/xdm/context/experienceevent-media", + "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch", + "https://ns.adobe.com/xdm/context/experienceevent-search", + "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership", + "https://ns.adobe.com/xdm/context/experienceevent-technical-details", + "https://ns.adobe.com/xdm/context/experienceevent-web", + "https://ns.adobe.com/experience/analytics/experienceevent-all", + "https://ns.adobe.com/experience/experienceevent-edgeregion", + "https://ns.adobe.com/experience/target/experienceevent-shared", + "https://ns.adobe.com/experience/profile/experienceevent-shared", + "https://ns.adobe.com/experience/implementations-ext", + "https://ns.adobe.com/xdm/context/experienceevent-enduserids", + "https://ns.adobe.com/experience/analytics/commerce" + ], + "definitions": { + "analytics-experienceevent": { + "properties": {} + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-advertising" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-application" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-channel" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-directmarketing" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-marketing" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-media" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-search" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-technical-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-web" + }, + { + "$ref": "https://ns.adobe.com/experience/analytics/experienceevent-all" + }, + { + "$ref": "https://ns.adobe.com/experience/experienceevent-edgeregion" + }, + { + "$ref": "https://ns.adobe.com/experience/target/experienceevent-shared" + }, + { + "$ref": "https://ns.adobe.com/experience/profile/experienceevent-shared" + }, + { + "$ref": "https://ns.adobe.com/experience/implementations-ext" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-enduserids" + }, + { + "$ref": "https://ns.adobe.com/experience/analytics/commerce" + }, + { + "$ref": "#/definitions/analytics-experienceevent" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "id": "68519882713298129995549973016107434638", + "primary": true + } + ], + "AVID": [ + { + "id": "2dfb7d8e00003ba4-056de00000000085", + "primary": false + } + ] + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + }, + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + }, + "https://ns.adobe.com/experience/analytics/customDimensions": { + "xdm:eVars": { + "xdm:eVar1": "customer" + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics-experienceevent.schema.md b/docs/reference/adobe/experience/analytics-experienceevent.schema.md new file mode 100644 index 000000000..523134787 --- /dev/null +++ b/docs/reference/adobe/experience/analytics-experienceevent.schema.md @@ -0,0 +1,3442 @@ + +# Adobe Analytics ExperienceEvent Template Mixin Schema + +``` +https://ns.adobe.com/experience/analytics-experienceevent +``` + +Analytics ExperienceEvent mixin for use with schemas for Solution data ingestion. Includes the core/standard ExperienceEvent as well as the required Adobe Analytics ExperienceEvent mixins. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/analytics-experienceevent.schema.json](adobe/experience/analytics-experienceevent.schema.json) | +## Schema Hierarchy + +* Adobe Analytics ExperienceEvent Template Mixin `https://ns.adobe.com/experience/analytics-experienceevent` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [ExperienceEvent details for advertising](../../mixins/experience-event/experienceevent-advertising.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-advertising` + * [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-application` + * [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-channel` + * [ExperienceEvent direct marketing details](../../mixins/experience-event/experienceevent-directmarketing.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-directmarketing` + * [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-environment-details` + * [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-marketing` + * [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-media` + * [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-profile-stitch` + * [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-search` + * [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-segmentmembership` + * [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-technical-details` + * [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-web` + * [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md) `https://ns.adobe.com/experience/analytics/experienceevent-all` + * [Data capture region for Experience Events](experienceevent-edgeregion.schema.md) `https://ns.adobe.com/experience/experienceevent-edgeregion` + * [Adobe Target ExperienceEvent Shared Extension](target/experienceevent-shared.schema.md) `https://ns.adobe.com/experience/target/experienceevent-shared` + * [Adobe Unified Profile Service ExperienceEvent Shared Extension](profile/experienceevent-shared.schema.md) `https://ns.adobe.com/experience/profile/experienceevent-shared` + * [Adobe Experience Platform Implementation Details Mixin](implementations-ext.schema.md) `https://ns.adobe.com/experience/implementations-ext` + * [ExperienceEvent EndUserIDs](../../mixins/experience-event/experienceevent-enduserids.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-enduserids` + * [Adobe Analytics ExperienceEvent Commerce Mixin](analytics/commerce.schema.md) `https://ns.adobe.com/experience/analytics/commerce` + + +## Adobe Analytics ExperienceEvent Template Mixin Example +```json +{ + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "id": "68519882713298129995549973016107434638", + "primary": true + } + ], + "AVID": [ + { + "id": "2dfb7d8e00003ba4-056de00000000085", + "primary": false + } + ] + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + }, + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + }, + "https://ns.adobe.com/experience/analytics/customDimensions": { + "xdm:eVars": { + "xdm:eVar1": "customer" + } + } +} +``` + +# Adobe Analytics ExperienceEvent Template Mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/analytics/customDimensions](#httpsnsadobecomexperienceanalyticscustomdimensions) | `object` | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticscustomdimensions) | +| [https://ns.adobe.com/experience/analytics/endUser](#httpsnsadobecomexperienceanalyticsenduser) | endUser.schema | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsenduser) | +| [https://ns.adobe.com/experience/analytics/environment](#httpsnsadobecomexperienceanalyticsenvironment) | `object` | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsenvironment) | +| [https://ns.adobe.com/experience/analytics/event101to200](#httpsnsadobecomexperienceanalyticsevent101to200) | event101to200.schema | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent101to200) | +| [https://ns.adobe.com/experience/analytics/event1to100](#httpsnsadobecomexperienceanalyticsevent1to100) | event1to100.schema | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent1to100) | +| [https://ns.adobe.com/experience/analytics/event201to300](#httpsnsadobecomexperienceanalyticsevent201to300) | event201to300.schema | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent201to300) | +| [https://ns.adobe.com/experience/analytics/event301to400](#httpsnsadobecomexperienceanalyticsevent301to400) | event301to400.schema | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent301to400) | +| [https://ns.adobe.com/experience/analytics/event401to500](#httpsnsadobecomexperienceanalyticsevent401to500) | event401to500.schema | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent401to500) | +| [https://ns.adobe.com/experience/analytics/event501to600](#httpsnsadobecomexperienceanalyticsevent501to600) | event501to600.schema | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent501to600) | +| [https://ns.adobe.com/experience/analytics/event601to700](#httpsnsadobecomexperienceanalyticsevent601to700) | event601to700.schema | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent601to700) | +| [https://ns.adobe.com/experience/analytics/event701to800](#httpsnsadobecomexperienceanalyticsevent701to800) | event701to800.schema | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent701to800) | +| [https://ns.adobe.com/experience/analytics/event801to900](#httpsnsadobecomexperienceanalyticsevent801to900) | event801to900.schema | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent801to900) | +| [https://ns.adobe.com/experience/analytics/event901to1000](#httpsnsadobecomexperienceanalyticsevent901to1000) | event901to1000.schema | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent901to1000) | +| [https://ns.adobe.com/experience/analytics/session](#httpsnsadobecomexperienceanalyticssession) | session.schema | Optional | [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticssession) | +| [https://ns.adobe.com/experience/implementations](#httpsnsadobecomexperienceimplementations) | Adobe Experience Platform Implementation Details | Optional | [Adobe Experience Platform Implementation Details Mixin](implementations-ext.schema.md#httpsnsadobecomexperienceimplementations) | +| [https://ns.adobe.com/experience/profile/originDatasetID](#httpsnsadobecomexperienceprofileorigindatasetid) | `string` | Optional | [Adobe Unified Profile Service ExperienceEvent Shared Extension](profile/experienceevent-shared.schema.md#httpsnsadobecomexperienceprofileorigindatasetid) | +| [https://ns.adobe.com/experience/target/supplementalDataID](#httpsnsadobecomexperiencetargetsupplementaldataid) | `string` | Optional | [Adobe Target ExperienceEvent Shared Extension](target/experienceevent-shared.schema.md#httpsnsadobecomexperiencetargetsupplementaldataid) | +| [xdm:advertising](#xdmadvertising) | Advertising | Optional | [ExperienceEvent details for advertising](../../mixins/experience-event/experienceevent-advertising.schema.md#xdmadvertising) | +| [xdm:application](#xdmapplication) | Application | Optional | [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md#xdmapplication) | +| [xdm:channel](#xdmchannel) | Experience Channel | Optional | [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md#xdmchannel) | +| [xdm:commerce](#xdmcommerce) | Commerce | Optional | [Adobe Analytics ExperienceEvent Commerce Mixin](analytics/commerce.schema.md#xdmcommerce) | +| [xdm:dataSource](#xdmdatasource) | Data Source | Optional | [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmdatasource) | +| [xdm:device](#xdmdevice) | Device | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) | +| [xdm:directMarketing](#xdmdirectmarketing) | Direct marketing | Optional | [ExperienceEvent direct marketing details](../../mixins/experience-event/experienceevent-directmarketing.schema.md#xdmdirectmarketing) | +| [xdm:endUserIDs](#xdmenduserids) | End user IDs | Optional | [ExperienceEvent EndUserIDs](../../mixins/experience-event/experienceevent-enduserids.schema.md#xdmenduserids) | +| [xdm:environment](#xdmenvironment) | Environment | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) | +| [xdm:marketing](#xdmmarketing) | Marketing | Optional | [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md#xdmmarketing) | +| [xdm:media](#xdmmedia) | Media information | Optional | [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md#xdmmedia) | +| [xdm:placeContext](#xdmplacecontext) | Place context | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) | +| [xdm:productListItems](#xdmproductlistitems) | Adobe Analytics extension to XDM Product List Item | Optional | [Adobe Analytics ExperienceEvent Commerce Mixin](analytics/commerce.schema.md#xdmproductlistitems) | +| [xdm:profileStitch](#xdmprofilestitch) | Profile stitch | Optional | [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md#xdmprofilestitch) | +| [xdm:receivedTimestamp](#xdmreceivedtimestamp) | `string` | Optional | [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmreceivedtimestamp) | +| [xdm:search](#xdmsearch) | Search | Optional | [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md#xdmsearch) | +| [xdm:segmentMembership](#xdmsegmentmembership) | `object` | Optional | [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmembership) | +| [xdm:segmentMemberships](#xdmsegmentmemberships) | Segment membership item | Optional | [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) | +| [xdm:userActivityRegion](#xdmuseractivityregion) | `object` | Optional | [Data capture region for Experience Events](experienceevent-edgeregion.schema.md#xdmuseractivityregion) | +| [xdm:web](#xdmweb) | Web information | Optional | [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md#xdmweb) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/analytics/customDimensions +### Custom Dimensions + +`https://ns.adobe.com/experience/analytics/customDimensions` +* is optional +* type: `object` +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticscustomdimensions) + +### https://ns.adobe.com/experience/analytics/customDimensions Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:eVars`| object | Optional | +| `xdm:hierarchies`| object | Optional | +| `xdm:listProps`| object | Optional | +| `xdm:lists`| object | Optional | +| `xdm:postalCode`| string | Optional | +| `xdm:props`| object | Optional | +| `xdm:stateProvince`| string | Optional | + + + +#### xdm:eVars +##### eVars + +undefined + +`xdm:eVars` +* is optional +* type: `object` + +##### xdm:eVars Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "eVars", + "properties": { + "xdm:eVar1": { + "title": "eVar1", + "type": "string", + "description": "Custom conversion variable 1." + }, + "xdm:eVar2": { + "title": "eVar2", + "type": "string", + "description": "Custom conversion variable 2." + }, + "xdm:eVar3": { + "title": "eVar3", + "type": "string", + "description": "Custom conversion variable 3." + }, + "xdm:eVar4": { + "title": "eVar4", + "type": "string", + "description": "Custom conversion variable 4." + }, + "xdm:eVar5": { + "title": "eVar5", + "type": "string", + "description": "Custom conversion variable 5." + }, + "xdm:eVar6": { + "title": "eVar6", + "type": "string", + "description": "Custom conversion variable 6." + }, + "xdm:eVar7": { + "title": "eVar7", + "type": "string", + "description": "Custom conversion variable 7." + }, + "xdm:eVar8": { + "title": "eVar8", + "type": "string", + "description": "Custom conversion variable 8." + }, + "xdm:eVar9": { + "title": "eVar9", + "type": "string", + "description": "Custom conversion variable 9." + }, + "xdm:eVar10": { + "title": "eVar10", + "type": "string", + "description": "Custom conversion variable 10." + }, + "xdm:eVar11": { + "title": "eVar11", + "type": "string", + "description": "Custom conversion variable 11." + }, + "xdm:eVar12": { + "title": "eVar12", + "type": "string", + "description": "Custom conversion variable 12." + }, + "xdm:eVar13": { + "title": "eVar13", + "type": "string", + "description": "Custom conversion variable 13." + }, + "xdm:eVar14": { + "title": "eVar14", + "type": "string", + "description": "Custom conversion variable 14." + }, + "xdm:eVar15": { + "title": "eVar15", + "type": "string", + "description": "Custom conversion variable 15." + }, + "xdm:eVar16": { + "title": "eVar16", + "type": "string", + "description": "Custom conversion variable 16." + }, + "xdm:eVar17": { + "title": "eVar17", + "type": "string", + "description": "Custom conversion variable 17." + }, + "xdm:eVar18": { + "title": "eVar18", + "type": "string", + "description": "Custom conversion variable 18." + }, + "xdm:eVar19": { + "title": "eVar19", + "type": "string", + "description": "Custom conversion variable 19." + }, + "xdm:eVar20": { + "title": "eVar20", + "type": "string", + "description": "Custom conversion variable 20." + }, + "xdm:eVar21": { + "title": "eVar21", + "type": "string", + "description": "Custom conversion variable 21." + }, + "xdm:eVar22": { + "title": "eVar22", + "type": "string", + "description": "Custom conversion variable 22." + }, + "xdm:eVar23": { + "title": "eVar23", + "type": "string", + "description": "Custom conversion variable 23." + }, + "xdm:eVar24": { + "title": "eVar24", + "type": "string", + "description": "Custom conversion variable 24." + }, + "xdm:eVar25": { + "title": "eVar25", + "type": "string", + "description": "Custom conversion variable 25." + }, + "xdm:eVar26": { + "title": "eVar26", + "type": "string", + "description": "Custom conversion variable 26." + }, + "xdm:eVar27": { + "title": "eVar27", + "type": "string", + "description": "Custom conversion variable 27." + }, + "xdm:eVar28": { + "title": "eVar28", + "type": "string", + "description": "Custom conversion variable 28." + }, + "xdm:eVar29": { + "title": "eVar29", + "type": "string", + "description": "Custom conversion variable 29." + }, + "xdm:eVar30": { + "title": "eVar30", + "type": "string", + "description": "Custom conversion variable 30." + }, + "xdm:eVar31": { + "title": "eVar31", + "type": "string", + "description": "Custom conversion variable 31." + }, + "xdm:eVar32": { + "title": "eVar32", + "type": "string", + "description": "Custom conversion variable 32." + }, + "xdm:eVar33": { + "title": "eVar33", + "type": "string", + "description": "Custom conversion variable 33." + }, + "xdm:eVar34": { + "title": "eVar34", + "type": "string", + "description": "Custom conversion variable 34." + }, + "xdm:eVar35": { + "title": "eVar35", + "type": "string", + "description": "Custom conversion variable 35." + }, + "xdm:eVar36": { + "title": "eVar36", + "type": "string", + "description": "Custom conversion variable 36." + }, + "xdm:eVar37": { + "title": "eVar37", + "type": "string", + "description": "Custom conversion variable 37." + }, + "xdm:eVar38": { + "title": "eVar38", + "type": "string", + "description": "Custom conversion variable 38." + }, + "xdm:eVar39": { + "title": "eVar39", + "type": "string", + "description": "Custom conversion variable 39." + }, + "xdm:eVar40": { + "title": "eVar40", + "type": "string", + "description": "Custom conversion variable 40." + }, + "xdm:eVar41": { + "title": "eVar41", + "type": "string", + "description": "Custom conversion variable 41." + }, + "xdm:eVar42": { + "title": "eVar42", + "type": "string", + "description": "Custom conversion variable 42." + }, + "xdm:eVar43": { + "title": "eVar43", + "type": "string", + "description": "Custom conversion variable 43." + }, + "xdm:eVar44": { + "title": "eVar44", + "type": "string", + "description": "Custom conversion variable 44." + }, + "xdm:eVar45": { + "title": "eVar45", + "type": "string", + "description": "Custom conversion variable 45." + }, + "xdm:eVar46": { + "title": "eVar46", + "type": "string", + "description": "Custom conversion variable 46." + }, + "xdm:eVar47": { + "title": "eVar47", + "type": "string", + "description": "Custom conversion variable 47." + }, + "xdm:eVar48": { + "title": "eVar48", + "type": "string", + "description": "Custom conversion variable 48." + }, + "xdm:eVar49": { + "title": "eVar49", + "type": "string", + "description": "Custom conversion variable 49." + }, + "xdm:eVar50": { + "title": "eVar50", + "type": "string", + "description": "Custom conversion variable 50." + }, + "xdm:eVar51": { + "title": "eVar51", + "type": "string", + "description": "Custom conversion variable 51." + }, + "xdm:eVar52": { + "title": "eVar52", + "type": "string", + "description": "Custom conversion variable 52." + }, + "xdm:eVar53": { + "title": "eVar53", + "type": "string", + "description": "Custom conversion variable 53." + }, + "xdm:eVar54": { + "title": "eVar54", + "type": "string", + "description": "Custom conversion variable 54." + }, + "xdm:eVar55": { + "title": "eVar55", + "type": "string", + "description": "Custom conversion variable 55." + }, + "xdm:eVar56": { + "title": "eVar56", + "type": "string", + "description": "Custom conversion variable 56." + }, + "xdm:eVar57": { + "title": "eVar57", + "type": "string", + "description": "Custom conversion variable 57." + }, + "xdm:eVar58": { + "title": "eVar58", + "type": "string", + "description": "Custom conversion variable 58." + }, + "xdm:eVar59": { + "title": "eVar59", + "type": "string", + "description": "Custom conversion variable 59." + }, + "xdm:eVar60": { + "title": "eVar60", + "type": "string", + "description": "Custom conversion variable 60." + }, + "xdm:eVar61": { + "title": "eVar61", + "type": "string", + "description": "Custom conversion variable 61." + }, + "xdm:eVar62": { + "title": "eVar62", + "type": "string", + "description": "Custom conversion variable 62." + }, + "xdm:eVar63": { + "title": "eVar63", + "type": "string", + "description": "Custom conversion variable 63." + }, + "xdm:eVar64": { + "title": "eVar64", + "type": "string", + "description": "Custom conversion variable 64." + }, + "xdm:eVar65": { + "title": "eVar65", + "type": "string", + "description": "Custom conversion variable 65." + }, + "xdm:eVar66": { + "title": "eVar66", + "type": "string", + "description": "Custom conversion variable 66." + }, + "xdm:eVar67": { + "title": "eVar67", + "type": "string", + "description": "Custom conversion variable 67." + }, + "xdm:eVar68": { + "title": "eVar68", + "type": "string", + "description": "Custom conversion variable 68." + }, + "xdm:eVar69": { + "title": "eVar69", + "type": "string", + "description": "Custom conversion variable 69." + }, + "xdm:eVar70": { + "title": "eVar70", + "type": "string", + "description": "Custom conversion variable 70." + }, + "xdm:eVar71": { + "title": "eVar71", + "type": "string", + "description": "Custom conversion variable 71." + }, + "xdm:eVar72": { + "title": "eVar72", + "type": "string", + "description": "Custom conversion variable 72." + }, + "xdm:eVar73": { + "title": "eVar73", + "type": "string", + "description": "Custom conversion variable 73." + }, + "xdm:eVar74": { + "title": "eVar74", + "type": "string", + "description": "Custom conversion variable 74." + }, + "xdm:eVar75": { + "title": "eVar75", + "type": "string", + "description": "Custom conversion variable 75." + }, + "xdm:eVar76": { + "title": "eVar76", + "type": "string", + "description": "Custom conversion variable 76." + }, + "xdm:eVar77": { + "title": "eVar77", + "type": "string", + "description": "Custom conversion variable 77." + }, + "xdm:eVar78": { + "title": "eVar78", + "type": "string", + "description": "Custom conversion variable 78." + }, + "xdm:eVar79": { + "title": "eVar79", + "type": "string", + "description": "Custom conversion variable 79." + }, + "xdm:eVar80": { + "title": "eVar80", + "type": "string", + "description": "Custom conversion variable 80." + }, + "xdm:eVar81": { + "title": "eVar81", + "type": "string", + "description": "Custom conversion variable 81." + }, + "xdm:eVar82": { + "title": "eVar82", + "type": "string", + "description": "Custom conversion variable 82." + }, + "xdm:eVar83": { + "title": "eVar83", + "type": "string", + "description": "Custom conversion variable 83." + }, + "xdm:eVar84": { + "title": "eVar84", + "type": "string", + "description": "Custom conversion variable 84." + }, + "xdm:eVar85": { + "title": "eVar85", + "type": "string", + "description": "Custom conversion variable 85." + }, + "xdm:eVar86": { + "title": "eVar86", + "type": "string", + "description": "Custom conversion variable 86." + }, + "xdm:eVar87": { + "title": "eVar87", + "type": "string", + "description": "Custom conversion variable 87." + }, + "xdm:eVar88": { + "title": "eVar88", + "type": "string", + "description": "Custom conversion variable 88." + }, + "xdm:eVar89": { + "title": "eVar89", + "type": "string", + "description": "Custom conversion variable 89." + }, + "xdm:eVar90": { + "title": "eVar90", + "type": "string", + "description": "Custom conversion variable 90." + }, + "xdm:eVar91": { + "title": "eVar91", + "type": "string", + "description": "Custom conversion variable 91." + }, + "xdm:eVar92": { + "title": "eVar92", + "type": "string", + "description": "Custom conversion variable 92." + }, + "xdm:eVar93": { + "title": "eVar93", + "type": "string", + "description": "Custom conversion variable 93." + }, + "xdm:eVar94": { + "title": "eVar94", + "type": "string", + "description": "Custom conversion variable 94." + }, + "xdm:eVar95": { + "title": "eVar95", + "type": "string", + "description": "Custom conversion variable 95." + }, + "xdm:eVar96": { + "title": "eVar96", + "type": "string", + "description": "Custom conversion variable 96." + }, + "xdm:eVar97": { + "title": "eVar97", + "type": "string", + "description": "Custom conversion variable 97." + }, + "xdm:eVar98": { + "title": "eVar98", + "type": "string", + "description": "Custom conversion variable 98." + }, + "xdm:eVar99": { + "title": "eVar99", + "type": "string", + "description": "Custom conversion variable 99." + }, + "xdm:eVar100": { + "title": "eVar100", + "type": "string", + "description": "Custom conversion variable 100." + }, + "xdm:eVar101": { + "title": "eVar101", + "type": "string", + "description": "Custom conversion variable 101." + }, + "xdm:eVar102": { + "title": "eVar102", + "type": "string", + "description": "Custom conversion variable 102." + }, + "xdm:eVar103": { + "title": "eVar103", + "type": "string", + "description": "Custom conversion variable 103." + }, + "xdm:eVar104": { + "title": "eVar104", + "type": "string", + "description": "Custom conversion variable 104." + }, + "xdm:eVar105": { + "title": "eVar105", + "type": "string", + "description": "Custom conversion variable 105." + }, + "xdm:eVar106": { + "title": "eVar106", + "type": "string", + "description": "Custom conversion variable 106." + }, + "xdm:eVar107": { + "title": "eVar107", + "type": "string", + "description": "Custom conversion variable 107." + }, + "xdm:eVar108": { + "title": "eVar108", + "type": "string", + "description": "Custom conversion variable 108." + }, + "xdm:eVar109": { + "title": "eVar109", + "type": "string", + "description": "Custom conversion variable 109." + }, + "xdm:eVar110": { + "title": "eVar110", + "type": "string", + "description": "Custom conversion variable 110." + }, + "xdm:eVar111": { + "title": "eVar111", + "type": "string", + "description": "Custom conversion variable 111." + }, + "xdm:eVar112": { + "title": "eVar112", + "type": "string", + "description": "Custom conversion variable 112." + }, + "xdm:eVar113": { + "title": "eVar113", + "type": "string", + "description": "Custom conversion variable 113." + }, + "xdm:eVar114": { + "title": "eVar114", + "type": "string", + "description": "Custom conversion variable 114." + }, + "xdm:eVar115": { + "title": "eVar115", + "type": "string", + "description": "Custom conversion variable 115." + }, + "xdm:eVar116": { + "title": "eVar116", + "type": "string", + "description": "Custom conversion variable 116." + }, + "xdm:eVar117": { + "title": "eVar117", + "type": "string", + "description": "Custom conversion variable 117." + }, + "xdm:eVar118": { + "title": "eVar118", + "type": "string", + "description": "Custom conversion variable 118." + }, + "xdm:eVar119": { + "title": "eVar119", + "type": "string", + "description": "Custom conversion variable 119." + }, + "xdm:eVar120": { + "title": "eVar120", + "type": "string", + "description": "Custom conversion variable 120." + }, + "xdm:eVar121": { + "title": "eVar121", + "type": "string", + "description": "Custom conversion variable 121." + }, + "xdm:eVar122": { + "title": "eVar122", + "type": "string", + "description": "Custom conversion variable 122." + }, + "xdm:eVar123": { + "title": "eVar123", + "type": "string", + "description": "Custom conversion variable 123." + }, + "xdm:eVar124": { + "title": "eVar124", + "type": "string", + "description": "Custom conversion variable 124." + }, + "xdm:eVar125": { + "title": "eVar125", + "type": "string", + "description": "Custom conversion variable 125." + }, + "xdm:eVar126": { + "title": "eVar126", + "type": "string", + "description": "Custom conversion variable 126." + }, + "xdm:eVar127": { + "title": "eVar127", + "type": "string", + "description": "Custom conversion variable 127." + }, + "xdm:eVar128": { + "title": "eVar128", + "type": "string", + "description": "Custom conversion variable 128." + }, + "xdm:eVar129": { + "title": "eVar129", + "type": "string", + "description": "Custom conversion variable 129." + }, + "xdm:eVar130": { + "title": "eVar130", + "type": "string", + "description": "Custom conversion variable 130." + }, + "xdm:eVar131": { + "title": "eVar131", + "type": "string", + "description": "Custom conversion variable 131." + }, + "xdm:eVar132": { + "title": "eVar132", + "type": "string", + "description": "Custom conversion variable 132." + }, + "xdm:eVar133": { + "title": "eVar133", + "type": "string", + "description": "Custom conversion variable 133." + }, + "xdm:eVar134": { + "title": "eVar134", + "type": "string", + "description": "Custom conversion variable 134." + }, + "xdm:eVar135": { + "title": "eVar135", + "type": "string", + "description": "Custom conversion variable 135." + }, + "xdm:eVar136": { + "title": "eVar136", + "type": "string", + "description": "Custom conversion variable 136." + }, + "xdm:eVar137": { + "title": "eVar137", + "type": "string", + "description": "Custom conversion variable 137." + }, + "xdm:eVar138": { + "title": "eVar138", + "type": "string", + "description": "Custom conversion variable 138." + }, + "xdm:eVar139": { + "title": "eVar139", + "type": "string", + "description": "Custom conversion variable 139." + }, + "xdm:eVar140": { + "title": "eVar140", + "type": "string", + "description": "Custom conversion variable 140." + }, + "xdm:eVar141": { + "title": "eVar141", + "type": "string", + "description": "Custom conversion variable 141." + }, + "xdm:eVar142": { + "title": "eVar142", + "type": "string", + "description": "Custom conversion variable 142." + }, + "xdm:eVar143": { + "title": "eVar143", + "type": "string", + "description": "Custom conversion variable 143." + }, + "xdm:eVar144": { + "title": "eVar144", + "type": "string", + "description": "Custom conversion variable 144." + }, + "xdm:eVar145": { + "title": "eVar145", + "type": "string", + "description": "Custom conversion variable 145." + }, + "xdm:eVar146": { + "title": "eVar146", + "type": "string", + "description": "Custom conversion variable 146." + }, + "xdm:eVar147": { + "title": "eVar147", + "type": "string", + "description": "Custom conversion variable 147." + }, + "xdm:eVar148": { + "title": "eVar148", + "type": "string", + "description": "Custom conversion variable 148." + }, + "xdm:eVar149": { + "title": "eVar149", + "type": "string", + "description": "Custom conversion variable 149." + }, + "xdm:eVar150": { + "title": "eVar150", + "type": "string", + "description": "Custom conversion variable 150." + }, + "xdm:eVar151": { + "title": "eVar151", + "type": "string", + "description": "Custom conversion variable 151." + }, + "xdm:eVar152": { + "title": "eVar152", + "type": "string", + "description": "Custom conversion variable 152." + }, + "xdm:eVar153": { + "title": "eVar153", + "type": "string", + "description": "Custom conversion variable 153." + }, + "xdm:eVar154": { + "title": "eVar154", + "type": "string", + "description": "Custom conversion variable 154." + }, + "xdm:eVar155": { + "title": "eVar155", + "type": "string", + "description": "Custom conversion variable 155." + }, + "xdm:eVar156": { + "title": "eVar156", + "type": "string", + "description": "Custom conversion variable 156." + }, + "xdm:eVar157": { + "title": "eVar157", + "type": "string", + "description": "Custom conversion variable 157." + }, + "xdm:eVar158": { + "title": "eVar158", + "type": "string", + "description": "Custom conversion variable 158." + }, + "xdm:eVar159": { + "title": "eVar159", + "type": "string", + "description": "Custom conversion variable 159." + }, + "xdm:eVar160": { + "title": "eVar160", + "type": "string", + "description": "Custom conversion variable 160." + }, + "xdm:eVar161": { + "title": "eVar161", + "type": "string", + "description": "Custom conversion variable 161." + }, + "xdm:eVar162": { + "title": "eVar162", + "type": "string", + "description": "Custom conversion variable 162." + }, + "xdm:eVar163": { + "title": "eVar163", + "type": "string", + "description": "Custom conversion variable 163." + }, + "xdm:eVar164": { + "title": "eVar164", + "type": "string", + "description": "Custom conversion variable 164." + }, + "xdm:eVar165": { + "title": "eVar165", + "type": "string", + "description": "Custom conversion variable 165." + }, + "xdm:eVar166": { + "title": "eVar166", + "type": "string", + "description": "Custom conversion variable 166." + }, + "xdm:eVar167": { + "title": "eVar167", + "type": "string", + "description": "Custom conversion variable 167." + }, + "xdm:eVar168": { + "title": "eVar168", + "type": "string", + "description": "Custom conversion variable 168." + }, + "xdm:eVar169": { + "title": "eVar169", + "type": "string", + "description": "Custom conversion variable 169." + }, + "xdm:eVar170": { + "title": "eVar170", + "type": "string", + "description": "Custom conversion variable 170." + }, + "xdm:eVar171": { + "title": "eVar171", + "type": "string", + "description": "Custom conversion variable 171." + }, + "xdm:eVar172": { + "title": "eVar172", + "type": "string", + "description": "Custom conversion variable 172." + }, + "xdm:eVar173": { + "title": "eVar173", + "type": "string", + "description": "Custom conversion variable 173." + }, + "xdm:eVar174": { + "title": "eVar174", + "type": "string", + "description": "Custom conversion variable 174." + }, + "xdm:eVar175": { + "title": "eVar175", + "type": "string", + "description": "Custom conversion variable 175." + }, + "xdm:eVar176": { + "title": "eVar176", + "type": "string", + "description": "Custom conversion variable 176." + }, + "xdm:eVar177": { + "title": "eVar177", + "type": "string", + "description": "Custom conversion variable 177." + }, + "xdm:eVar178": { + "title": "eVar178", + "type": "string", + "description": "Custom conversion variable 178." + }, + "xdm:eVar179": { + "title": "eVar179", + "type": "string", + "description": "Custom conversion variable 179." + }, + "xdm:eVar180": { + "title": "eVar180", + "type": "string", + "description": "Custom conversion variable 180." + }, + "xdm:eVar181": { + "title": "eVar181", + "type": "string", + "description": "Custom conversion variable 181." + }, + "xdm:eVar182": { + "title": "eVar182", + "type": "string", + "description": "Custom conversion variable 182." + }, + "xdm:eVar183": { + "title": "eVar183", + "type": "string", + "description": "Custom conversion variable 183." + }, + "xdm:eVar184": { + "title": "eVar184", + "type": "string", + "description": "Custom conversion variable 184." + }, + "xdm:eVar185": { + "title": "eVar185", + "type": "string", + "description": "Custom conversion variable 185." + }, + "xdm:eVar186": { + "title": "eVar186", + "type": "string", + "description": "Custom conversion variable 186." + }, + "xdm:eVar187": { + "title": "eVar187", + "type": "string", + "description": "Custom conversion variable 187." + }, + "xdm:eVar188": { + "title": "eVar188", + "type": "string", + "description": "Custom conversion variable 188." + }, + "xdm:eVar189": { + "title": "eVar189", + "type": "string", + "description": "Custom conversion variable 189." + }, + "xdm:eVar190": { + "title": "eVar190", + "type": "string", + "description": "Custom conversion variable 190." + }, + "xdm:eVar191": { + "title": "eVar191", + "type": "string", + "description": "Custom conversion variable 191." + }, + "xdm:eVar192": { + "title": "eVar192", + "type": "string", + "description": "Custom conversion variable 192." + }, + "xdm:eVar193": { + "title": "eVar193", + "type": "string", + "description": "Custom conversion variable 193." + }, + "xdm:eVar194": { + "title": "eVar194", + "type": "string", + "description": "Custom conversion variable 194." + }, + "xdm:eVar195": { + "title": "eVar195", + "type": "string", + "description": "Custom conversion variable 195." + }, + "xdm:eVar196": { + "title": "eVar196", + "type": "string", + "description": "Custom conversion variable 196." + }, + "xdm:eVar197": { + "title": "eVar197", + "type": "string", + "description": "Custom conversion variable 197." + }, + "xdm:eVar198": { + "title": "eVar198", + "type": "string", + "description": "Custom conversion variable 198." + }, + "xdm:eVar199": { + "title": "eVar199", + "type": "string", + "description": "Custom conversion variable 199." + }, + "xdm:eVar200": { + "title": "eVar200", + "type": "string", + "description": "Custom conversion variable 200." + }, + "xdm:eVar201": { + "title": "eVar201", + "type": "string", + "description": "Custom conversion variable 201." + }, + "xdm:eVar202": { + "title": "eVar202", + "type": "string", + "description": "Custom conversion variable 202." + }, + "xdm:eVar203": { + "title": "eVar203", + "type": "string", + "description": "Custom conversion variable 203." + }, + "xdm:eVar204": { + "title": "eVar204", + "type": "string", + "description": "Custom conversion variable 204." + }, + "xdm:eVar205": { + "title": "eVar205", + "type": "string", + "description": "Custom conversion variable 205." + }, + "xdm:eVar206": { + "title": "eVar206", + "type": "string", + "description": "Custom conversion variable 206." + }, + "xdm:eVar207": { + "title": "eVar207", + "type": "string", + "description": "Custom conversion variable 207." + }, + "xdm:eVar208": { + "title": "eVar208", + "type": "string", + "description": "Custom conversion variable 208." + }, + "xdm:eVar209": { + "title": "eVar209", + "type": "string", + "description": "Custom conversion variable 209." + }, + "xdm:eVar210": { + "title": "eVar210", + "type": "string", + "description": "Custom conversion variable 210." + }, + "xdm:eVar211": { + "title": "eVar211", + "type": "string", + "description": "Custom conversion variable 211." + }, + "xdm:eVar212": { + "title": "eVar212", + "type": "string", + "description": "Custom conversion variable 212." + }, + "xdm:eVar213": { + "title": "eVar213", + "type": "string", + "description": "Custom conversion variable 213." + }, + "xdm:eVar214": { + "title": "eVar214", + "type": "string", + "description": "Custom conversion variable 214." + }, + "xdm:eVar215": { + "title": "eVar215", + "type": "string", + "description": "Custom conversion variable 215." + }, + "xdm:eVar216": { + "title": "eVar216", + "type": "string", + "description": "Custom conversion variable 216." + }, + "xdm:eVar217": { + "title": "eVar217", + "type": "string", + "description": "Custom conversion variable 217." + }, + "xdm:eVar218": { + "title": "eVar218", + "type": "string", + "description": "Custom conversion variable 218." + }, + "xdm:eVar219": { + "title": "eVar219", + "type": "string", + "description": "Custom conversion variable 219." + }, + "xdm:eVar220": { + "title": "eVar220", + "type": "string", + "description": "Custom conversion variable 220." + }, + "xdm:eVar221": { + "title": "eVar221", + "type": "string", + "description": "Custom conversion variable 221." + }, + "xdm:eVar222": { + "title": "eVar222", + "type": "string", + "description": "Custom conversion variable 222." + }, + "xdm:eVar223": { + "title": "eVar223", + "type": "string", + "description": "Custom conversion variable 223." + }, + "xdm:eVar224": { + "title": "eVar224", + "type": "string", + "description": "Custom conversion variable 224." + }, + "xdm:eVar225": { + "title": "eVar225", + "type": "string", + "description": "Custom conversion variable 225." + }, + "xdm:eVar226": { + "title": "eVar226", + "type": "string", + "description": "Custom conversion variable 226." + }, + "xdm:eVar227": { + "title": "eVar227", + "type": "string", + "description": "Custom conversion variable 227." + }, + "xdm:eVar228": { + "title": "eVar228", + "type": "string", + "description": "Custom conversion variable 228." + }, + "xdm:eVar229": { + "title": "eVar229", + "type": "string", + "description": "Custom conversion variable 229." + }, + "xdm:eVar230": { + "title": "eVar230", + "type": "string", + "description": "Custom conversion variable 230." + }, + "xdm:eVar231": { + "title": "eVar231", + "type": "string", + "description": "Custom conversion variable 231." + }, + "xdm:eVar232": { + "title": "eVar232", + "type": "string", + "description": "Custom conversion variable 232." + }, + "xdm:eVar233": { + "title": "eVar233", + "type": "string", + "description": "Custom conversion variable 233." + }, + "xdm:eVar234": { + "title": "eVar234", + "type": "string", + "description": "Custom conversion variable 234." + }, + "xdm:eVar235": { + "title": "eVar235", + "type": "string", + "description": "Custom conversion variable 235." + }, + "xdm:eVar236": { + "title": "eVar236", + "type": "string", + "description": "Custom conversion variable 236." + }, + "xdm:eVar237": { + "title": "eVar237", + "type": "string", + "description": "Custom conversion variable 237." + }, + "xdm:eVar238": { + "title": "eVar238", + "type": "string", + "description": "Custom conversion variable 238." + }, + "xdm:eVar239": { + "title": "eVar239", + "type": "string", + "description": "Custom conversion variable 239." + }, + "xdm:eVar240": { + "title": "eVar240", + "type": "string", + "description": "Custom conversion variable 240." + }, + "xdm:eVar241": { + "title": "eVar241", + "type": "string", + "description": "Custom conversion variable 241." + }, + "xdm:eVar242": { + "title": "eVar242", + "type": "string", + "description": "Custom conversion variable 242." + }, + "xdm:eVar243": { + "title": "eVar243", + "type": "string", + "description": "Custom conversion variable 243." + }, + "xdm:eVar244": { + "title": "eVar244", + "type": "string", + "description": "Custom conversion variable 244." + }, + "xdm:eVar245": { + "title": "eVar245", + "type": "string", + "description": "Custom conversion variable 245." + }, + "xdm:eVar246": { + "title": "eVar246", + "type": "string", + "description": "Custom conversion variable 246." + }, + "xdm:eVar247": { + "title": "eVar247", + "type": "string", + "description": "Custom conversion variable 247." + }, + "xdm:eVar248": { + "title": "eVar248", + "type": "string", + "description": "Custom conversion variable 248." + }, + "xdm:eVar249": { + "title": "eVar249", + "type": "string", + "description": "Custom conversion variable 249." + }, + "xdm:eVar250": { + "title": "eVar250", + "type": "string", + "description": "Custom conversion variable 250." + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:hierarchies +##### Hierarchies + +undefined + +`xdm:hierarchies` +* is optional +* type: `object` + +##### xdm:hierarchies Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "Hierarchies", + "properties": { + "xdm:hier1": { + "title": "hier1", + "description": "Custom hierarchy variable 1.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:hier2": { + "title": "hier2", + "description": "Custom hierarchy variable 2.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:hier3": { + "title": "hier3", + "description": "Custom hierarchy variable 3.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:hier4": { + "title": "hier4", + "description": "Custom hierarchy variable 4.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:hier5": { + "title": "hier5", + "description": "Custom hierarchy variable 5.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:listProps +##### List Props + +undefined + +`xdm:listProps` +* is optional +* type: `object` + +##### xdm:listProps Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "List Props", + "properties": { + "xdm:prop1": { + "title": "prop1", + "description": "Custom property variable1", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop2": { + "title": "prop2", + "description": "Custom property variable2", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop3": { + "title": "prop3", + "description": "Custom property variable3", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop4": { + "title": "prop4", + "description": "Custom property variable4", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop5": { + "title": "prop5", + "description": "Custom property variable5", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop6": { + "title": "prop6", + "description": "Custom property variable6", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop7": { + "title": "prop7", + "description": "Custom property variable7", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop8": { + "title": "prop8", + "description": "Custom property variable8", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop9": { + "title": "prop9", + "description": "Custom property variable9", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop10": { + "title": "prop10", + "description": "Custom property variable10", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop11": { + "title": "prop11", + "description": "Custom property variable11", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop12": { + "title": "prop12", + "description": "Custom property variable12", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop13": { + "title": "prop13", + "description": "Custom property variable13", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop14": { + "title": "prop14", + "description": "Custom property variable14", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop15": { + "title": "prop15", + "description": "Custom property variable15", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop16": { + "title": "prop16", + "description": "Custom property variable16", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop17": { + "title": "prop17", + "description": "Custom property variable17", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop18": { + "title": "prop18", + "description": "Custom property variable18", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop19": { + "title": "prop19", + "description": "Custom property variable19", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop20": { + "title": "prop20", + "description": "Custom property variable20", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop21": { + "title": "prop21", + "description": "Custom property variable21", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop22": { + "title": "prop22", + "description": "Custom property variable22", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop23": { + "title": "prop23", + "description": "Custom property variable23", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop24": { + "title": "prop24", + "description": "Custom property variable24", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop25": { + "title": "prop25", + "description": "Custom property variable25", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop26": { + "title": "prop26", + "description": "Custom property variable26", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop27": { + "title": "prop27", + "description": "Custom property variable27", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop28": { + "title": "prop28", + "description": "Custom property variable28", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop29": { + "title": "prop29", + "description": "Custom property variable29", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop30": { + "title": "prop30", + "description": "Custom property variable30", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop31": { + "title": "prop31", + "description": "Custom property variable31", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop32": { + "title": "prop32", + "description": "Custom property variable32", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop33": { + "title": "prop33", + "description": "Custom property variable33", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop34": { + "title": "prop34", + "description": "Custom property variable34", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop35": { + "title": "prop35", + "description": "Custom property variable35", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop36": { + "title": "prop36", + "description": "Custom property variable36", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop37": { + "title": "prop37", + "description": "Custom property variable37", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop38": { + "title": "prop38", + "description": "Custom property variable38", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop39": { + "title": "prop39", + "description": "Custom property variable39", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop40": { + "title": "prop40", + "description": "Custom property variable40", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop41": { + "title": "prop41", + "description": "Custom property variable41", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop42": { + "title": "prop42", + "description": "Custom property variable42", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop43": { + "title": "prop43", + "description": "Custom property variable43", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop44": { + "title": "prop44", + "description": "Custom property variable44", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop45": { + "title": "prop45", + "description": "Custom property variable45", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop46": { + "title": "prop46", + "description": "Custom property variable46", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop47": { + "title": "prop47", + "description": "Custom property variable47", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop48": { + "title": "prop48", + "description": "Custom property variable48", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop49": { + "title": "prop49", + "description": "Custom property variable49", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop50": { + "title": "prop50", + "description": "Custom property variable50", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop51": { + "title": "prop51", + "description": "Custom property variable51", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop52": { + "title": "prop52", + "description": "Custom property variable52", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop53": { + "title": "prop53", + "description": "Custom property variable53", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop54": { + "title": "prop54", + "description": "Custom property variable54", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop55": { + "title": "prop55", + "description": "Custom property variable55", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop56": { + "title": "prop56", + "description": "Custom property variable56", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop57": { + "title": "prop57", + "description": "Custom property variable57", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop58": { + "title": "prop58", + "description": "Custom property variable58", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop59": { + "title": "prop59", + "description": "Custom property variable59", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop60": { + "title": "prop60", + "description": "Custom property variable60", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop61": { + "title": "prop61", + "description": "Custom property variable61", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop62": { + "title": "prop62", + "description": "Custom property variable62", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop63": { + "title": "prop63", + "description": "Custom property variable63", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop64": { + "title": "prop64", + "description": "Custom property variable64", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop65": { + "title": "prop65", + "description": "Custom property variable65", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop66": { + "title": "prop66", + "description": "Custom property variable66", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop67": { + "title": "prop67", + "description": "Custom property variable67", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop68": { + "title": "prop68", + "description": "Custom property variable68", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop69": { + "title": "prop69", + "description": "Custom property variable69", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop70": { + "title": "prop70", + "description": "Custom property variable70", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop71": { + "title": "prop71", + "description": "Custom property variable71", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop72": { + "title": "prop72", + "description": "Custom property variable72", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop73": { + "title": "prop73", + "description": "Custom property variable73", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop74": { + "title": "prop74", + "description": "Custom property variable74", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop75": { + "title": "prop75", + "description": "Custom property variable75", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:lists +##### Custom List Variables + +undefined + +`xdm:lists` +* is optional +* type: `object` + +##### xdm:lists Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "Custom List Variables", + "properties": { + "xdm:list1": { + "title": "List 1", + "description": "Custom list variable 1.", + "$ref": "https://ns.adobe.com/experience/analytics/keyedlist" + }, + "xdm:list2": { + "title": "List 2", + "description": "Custom list variable 2.", + "$ref": "https://ns.adobe.com/experience/analytics/keyedlist" + }, + "xdm:list3": { + "title": "List 3", + "description": "Custom list variable 3.", + "$ref": "https://ns.adobe.com/experience/analytics/keyedlist" + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:postalCode +##### zip + +Client supplied zip code/postal code. + +`xdm:postalCode` +* is optional +* type: `string` + +##### xdm:postalCode Type + + +`string` + + + + + + + + +#### xdm:props +##### Props + +undefined + +`xdm:props` +* is optional +* type: `object` + +##### xdm:props Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "Props", + "properties": { + "xdm:prop1": { + "title": "prop1", + "type": "string", + "description": "Custom property variable 1." + }, + "xdm:prop2": { + "title": "prop2", + "type": "string", + "description": "Custom property variable 2." + }, + "xdm:prop3": { + "title": "prop3", + "type": "string", + "description": "Custom property variable 3." + }, + "xdm:prop4": { + "title": "prop4", + "type": "string", + "description": "Custom property variable 4." + }, + "xdm:prop5": { + "title": "prop5", + "type": "string", + "description": "Custom property variable 5." + }, + "xdm:prop6": { + "title": "prop6", + "type": "string", + "description": "Custom property variable 6." + }, + "xdm:prop7": { + "title": "prop7", + "type": "string", + "description": "Custom property variable 7." + }, + "xdm:prop8": { + "title": "prop8", + "type": "string", + "description": "Custom property variable 8." + }, + "xdm:prop9": { + "title": "prop9", + "type": "string", + "description": "Custom property variable 9." + }, + "xdm:prop10": { + "title": "prop10", + "type": "string", + "description": "Custom property variable 10." + }, + "xdm:prop11": { + "title": "prop11", + "type": "string", + "description": "Custom property variable 11." + }, + "xdm:prop12": { + "title": "prop12", + "type": "string", + "description": "Custom property variable 12." + }, + "xdm:prop13": { + "title": "prop13", + "type": "string", + "description": "Custom property variable 13." + }, + "xdm:prop14": { + "title": "prop14", + "type": "string", + "description": "Custom property variable 14." + }, + "xdm:prop15": { + "title": "prop15", + "type": "string", + "description": "Custom property variable 15." + }, + "xdm:prop16": { + "title": "prop16", + "type": "string", + "description": "Custom property variable 16." + }, + "xdm:prop17": { + "title": "prop17", + "type": "string", + "description": "Custom property variable 17." + }, + "xdm:prop18": { + "title": "prop18", + "type": "string", + "description": "Custom property variable 18." + }, + "xdm:prop19": { + "title": "prop19", + "type": "string", + "description": "Custom property variable 19." + }, + "xdm:prop20": { + "title": "prop20", + "type": "string", + "description": "Custom property variable 20." + }, + "xdm:prop21": { + "title": "prop21", + "type": "string", + "description": "Custom property variable 21." + }, + "xdm:prop22": { + "title": "prop22", + "type": "string", + "description": "Custom property variable 22." + }, + "xdm:prop23": { + "title": "prop23", + "type": "string", + "description": "Custom property variable 23." + }, + "xdm:prop24": { + "title": "prop24", + "type": "string", + "description": "Custom property variable 24." + }, + "xdm:prop25": { + "title": "prop25", + "type": "string", + "description": "Custom property variable 25." + }, + "xdm:prop26": { + "title": "prop26", + "type": "string", + "description": "Custom property variable 26." + }, + "xdm:prop27": { + "title": "prop27", + "type": "string", + "description": "Custom property variable 27." + }, + "xdm:prop28": { + "title": "prop28", + "type": "string", + "description": "Custom property variable 28." + }, + "xdm:prop29": { + "title": "prop29", + "type": "string", + "description": "Custom property variable 29." + }, + "xdm:prop30": { + "title": "prop30", + "type": "string", + "description": "Custom property variable 30." + }, + "xdm:prop31": { + "title": "prop31", + "type": "string", + "description": "Custom property variable 31." + }, + "xdm:prop32": { + "title": "prop32", + "type": "string", + "description": "Custom property variable 32." + }, + "xdm:prop33": { + "title": "prop33", + "type": "string", + "description": "Custom property variable 33." + }, + "xdm:prop34": { + "title": "prop34", + "type": "string", + "description": "Custom property variable 34." + }, + "xdm:prop35": { + "title": "prop35", + "type": "string", + "description": "Custom property variable 35." + }, + "xdm:prop36": { + "title": "prop36", + "type": "string", + "description": "Custom property variable 36." + }, + "xdm:prop37": { + "title": "prop37", + "type": "string", + "description": "Custom property variable 37." + }, + "xdm:prop38": { + "title": "prop38", + "type": "string", + "description": "Custom property variable 38." + }, + "xdm:prop39": { + "title": "prop39", + "type": "string", + "description": "Custom property variable 39." + }, + "xdm:prop40": { + "title": "prop40", + "type": "string", + "description": "Custom property variable 40." + }, + "xdm:prop41": { + "title": "prop41", + "type": "string", + "description": "Custom property variable 41." + }, + "xdm:prop42": { + "title": "prop42", + "type": "string", + "description": "Custom property variable 42." + }, + "xdm:prop43": { + "title": "prop43", + "type": "string", + "description": "Custom property variable 43." + }, + "xdm:prop44": { + "title": "prop44", + "type": "string", + "description": "Custom property variable 44." + }, + "xdm:prop45": { + "title": "prop45", + "type": "string", + "description": "Custom property variable 45." + }, + "xdm:prop46": { + "title": "prop46", + "type": "string", + "description": "Custom property variable 46." + }, + "xdm:prop47": { + "title": "prop47", + "type": "string", + "description": "Custom property variable 47." + }, + "xdm:prop48": { + "title": "prop48", + "type": "string", + "description": "Custom property variable 48." + }, + "xdm:prop49": { + "title": "prop49", + "type": "string", + "description": "Custom property variable 49." + }, + "xdm:prop50": { + "title": "prop50", + "type": "string", + "description": "Custom property variable 50." + }, + "xdm:prop51": { + "title": "prop51", + "type": "string", + "description": "Custom property variable 51." + }, + "xdm:prop52": { + "title": "prop52", + "type": "string", + "description": "Custom property variable 52." + }, + "xdm:prop53": { + "title": "prop53", + "type": "string", + "description": "Custom property variable 53." + }, + "xdm:prop54": { + "title": "prop54", + "type": "string", + "description": "Custom property variable 54." + }, + "xdm:prop55": { + "title": "prop55", + "type": "string", + "description": "Custom property variable 55." + }, + "xdm:prop56": { + "title": "prop56", + "type": "string", + "description": "Custom property variable 56." + }, + "xdm:prop57": { + "title": "prop57", + "type": "string", + "description": "Custom property variable 57." + }, + "xdm:prop58": { + "title": "prop58", + "type": "string", + "description": "Custom property variable 58." + }, + "xdm:prop59": { + "title": "prop59", + "type": "string", + "description": "Custom property variable 59." + }, + "xdm:prop60": { + "title": "prop60", + "type": "string", + "description": "Custom property variable 60." + }, + "xdm:prop61": { + "title": "prop61", + "type": "string", + "description": "Custom property variable 61." + }, + "xdm:prop62": { + "title": "prop62", + "type": "string", + "description": "Custom property variable 62." + }, + "xdm:prop63": { + "title": "prop63", + "type": "string", + "description": "Custom property variable 63." + }, + "xdm:prop64": { + "title": "prop64", + "type": "string", + "description": "Custom property variable 64." + }, + "xdm:prop65": { + "title": "prop65", + "type": "string", + "description": "Custom property variable 65." + }, + "xdm:prop66": { + "title": "prop66", + "type": "string", + "description": "Custom property variable 66." + }, + "xdm:prop67": { + "title": "prop67", + "type": "string", + "description": "Custom property variable 67." + }, + "xdm:prop68": { + "title": "prop68", + "type": "string", + "description": "Custom property variable 68." + }, + "xdm:prop69": { + "title": "prop69", + "type": "string", + "description": "Custom property variable 69." + }, + "xdm:prop70": { + "title": "prop70", + "type": "string", + "description": "Custom property variable 70." + }, + "xdm:prop71": { + "title": "prop71", + "type": "string", + "description": "Custom property variable 71." + }, + "xdm:prop72": { + "title": "prop72", + "type": "string", + "description": "Custom property variable 72." + }, + "xdm:prop73": { + "title": "prop73", + "type": "string", + "description": "Custom property variable 73." + }, + "xdm:prop74": { + "title": "prop74", + "type": "string", + "description": "Custom property variable 74." + }, + "xdm:prop75": { + "title": "prop75", + "type": "string", + "description": "Custom property variable 75." + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:stateProvince +##### state + +Client supplied state or province location. + +`xdm:stateProvince` +* is optional +* type: `string` + +##### xdm:stateProvince Type + + +`string` + + + + + + + + + + + +## https://ns.adobe.com/experience/analytics/endUser +### End-User + +`https://ns.adobe.com/experience/analytics/endUser` +* is optional +* type: endUser.schema +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsenduser) + +### https://ns.adobe.com/experience/analytics/endUser Type + + +* [endUser.schema](analytics/endUser.schema.md) – `https://ns.adobe.com/experience/analytics/endUser` + + + + + +## https://ns.adobe.com/experience/analytics/environment +### Environment + +`https://ns.adobe.com/experience/analytics/environment` +* is optional +* type: `object` +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsenvironment) + +### https://ns.adobe.com/experience/analytics/environment Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:browserID`| integer | Optional | +| `xdm:browserIDStr`| string | Optional | +| `xdm:operatingSystemID`| integer | Optional | +| `xdm:operatingSystemIDStr`| string | Optional | + + + +#### xdm:browserID +##### Browser ID + +The Adobe Analytics identifier for the browser used. Deprecated, use xdm:browserIDStr instead. + +`xdm:browserID` +* is optional +* type: `integer` + +##### xdm:browserID Type + + +`integer` + + + + + + + + +#### xdm:browserIDStr +##### Browser ID + +The Adobe Analytics identifier for the browser used. + +`xdm:browserIDStr` +* is optional +* type: `string` + +##### xdm:browserIDStr Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E%5B0-9%5D%2B)): +```regex +^[0-9]+ +``` + + + + + + + + +#### xdm:operatingSystemID +##### Operating System ID + +The Adobe Analytics identifier of the operating system used. Deprecated, use xdm:operatingSystemIDStr instead. + +`xdm:operatingSystemID` +* is optional +* type: `integer` + +##### xdm:operatingSystemID Type + + +`integer` + + + + + + + + +#### xdm:operatingSystemIDStr +##### Operating System ID + +The Adobe Analytics identifier of the operating system used. + +`xdm:operatingSystemIDStr` +* is optional +* type: `string` + +##### xdm:operatingSystemIDStr Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E%5B0-9%5D%2B)): +```regex +^[0-9]+ +``` + + + + + + + + + + + +## https://ns.adobe.com/experience/analytics/event101to200 +### Event 101 to 200 + +`https://ns.adobe.com/experience/analytics/event101to200` +* is optional +* type: event101to200.schema +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent101to200) + +### https://ns.adobe.com/experience/analytics/event101to200 Type + + +* [event101to200.schema](analytics/event101to200.schema.md) – `https://ns.adobe.com/experience/analytics/event101to200` + + + + + +## https://ns.adobe.com/experience/analytics/event1to100 +### Event 1 to 100 + +`https://ns.adobe.com/experience/analytics/event1to100` +* is optional +* type: event1to100.schema +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent1to100) + +### https://ns.adobe.com/experience/analytics/event1to100 Type + + +* [event1to100.schema](analytics/event1to100.schema.md) – `https://ns.adobe.com/experience/analytics/event1to100` + + + + + +## https://ns.adobe.com/experience/analytics/event201to300 +### Event 201 to 300 + +`https://ns.adobe.com/experience/analytics/event201to300` +* is optional +* type: event201to300.schema +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent201to300) + +### https://ns.adobe.com/experience/analytics/event201to300 Type + + +* [event201to300.schema](analytics/event201to300.schema.md) – `https://ns.adobe.com/experience/analytics/event201to300` + + + + + +## https://ns.adobe.com/experience/analytics/event301to400 +### Event 301 to 400 + +`https://ns.adobe.com/experience/analytics/event301to400` +* is optional +* type: event301to400.schema +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent301to400) + +### https://ns.adobe.com/experience/analytics/event301to400 Type + + +* [event301to400.schema](analytics/event301to400.schema.md) – `https://ns.adobe.com/experience/analytics/event301to400` + + + + + +## https://ns.adobe.com/experience/analytics/event401to500 +### Event 401 to 500 + +`https://ns.adobe.com/experience/analytics/event401to500` +* is optional +* type: event401to500.schema +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent401to500) + +### https://ns.adobe.com/experience/analytics/event401to500 Type + + +* [event401to500.schema](analytics/event401to500.schema.md) – `https://ns.adobe.com/experience/analytics/event401to500` + + + + + +## https://ns.adobe.com/experience/analytics/event501to600 +### Event 501 to 600 + +`https://ns.adobe.com/experience/analytics/event501to600` +* is optional +* type: event501to600.schema +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent501to600) + +### https://ns.adobe.com/experience/analytics/event501to600 Type + + +* [event501to600.schema](analytics/event501to600.schema.md) – `https://ns.adobe.com/experience/analytics/event501to600` + + + + + +## https://ns.adobe.com/experience/analytics/event601to700 +### Event 601 to 700 + +`https://ns.adobe.com/experience/analytics/event601to700` +* is optional +* type: event601to700.schema +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent601to700) + +### https://ns.adobe.com/experience/analytics/event601to700 Type + + +* [event601to700.schema](analytics/event601to700.schema.md) – `https://ns.adobe.com/experience/analytics/event601to700` + + + + + +## https://ns.adobe.com/experience/analytics/event701to800 +### Event 701 to 800 + +`https://ns.adobe.com/experience/analytics/event701to800` +* is optional +* type: event701to800.schema +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent701to800) + +### https://ns.adobe.com/experience/analytics/event701to800 Type + + +* [event701to800.schema](analytics/event701to800.schema.md) – `https://ns.adobe.com/experience/analytics/event701to800` + + + + + +## https://ns.adobe.com/experience/analytics/event801to900 +### Event 801 to 900 + +`https://ns.adobe.com/experience/analytics/event801to900` +* is optional +* type: event801to900.schema +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent801to900) + +### https://ns.adobe.com/experience/analytics/event801to900 Type + + +* [event801to900.schema](analytics/event801to900.schema.md) – `https://ns.adobe.com/experience/analytics/event801to900` + + + + + +## https://ns.adobe.com/experience/analytics/event901to1000 +### Event 901 to 1000 + +`https://ns.adobe.com/experience/analytics/event901to1000` +* is optional +* type: event901to1000.schema +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticsevent901to1000) + +### https://ns.adobe.com/experience/analytics/event901to1000 Type + + +* [event901to1000.schema](analytics/event901to1000.schema.md) – `https://ns.adobe.com/experience/analytics/event901to1000` + + + + + +## https://ns.adobe.com/experience/analytics/session +### Session + +`https://ns.adobe.com/experience/analytics/session` +* is optional +* type: session.schema +* defined in [Adobe Analytics ExperienceEvent Full Extension](analytics/experienceevent-all.schema.md#httpsnsadobecomexperienceanalyticssession) + +### https://ns.adobe.com/experience/analytics/session Type + + +* [session.schema](analytics/session.schema.md) – `https://ns.adobe.com/experience/analytics/session` + + + + + +## https://ns.adobe.com/experience/implementations + + +`https://ns.adobe.com/experience/implementations` +* is optional +* type: Adobe Experience Platform Implementation Details +* defined in [Adobe Experience Platform Implementation Details Mixin](implementations-ext.schema.md#httpsnsadobecomexperienceimplementations) + +### https://ns.adobe.com/experience/implementations Type + + +* [Adobe Experience Platform Implementation Details](implementations.schema.md) – `https://ns.adobe.com/experience/implementations` + + + + + +## https://ns.adobe.com/experience/profile/originDatasetID +### Origin Dataset ID + +Identity of the dataset that the Unified Profile Service ingested the data from. Usage is reserved for the Unified Profile Service. + +`https://ns.adobe.com/experience/profile/originDatasetID` +* is optional +* type: `string` +* defined in [Adobe Unified Profile Service ExperienceEvent Shared Extension](profile/experienceevent-shared.schema.md#httpsnsadobecomexperienceprofileorigindatasetid) + +### https://ns.adobe.com/experience/profile/originDatasetID Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/supplementalDataID +### Supplemental Data Identifier + +Identifier used to stitch Target events with Analytics events + +`https://ns.adobe.com/experience/target/supplementalDataID` +* is optional +* type: `string` +* defined in [Adobe Target ExperienceEvent Shared Extension](target/experienceevent-shared.schema.md#httpsnsadobecomexperiencetargetsupplementaldataid) + +### https://ns.adobe.com/experience/target/supplementalDataID Type + + +`string` + + + + + + +## xdm:advertising +### Advertising + +Information related to advertising activity in ExperienceEvents. + +`xdm:advertising` +* is optional +* type: Advertising +* defined in [ExperienceEvent details for advertising](../../mixins/experience-event/experienceevent-advertising.schema.md#xdmadvertising) + +### xdm:advertising Type + + +* [Advertising](../../datatypes/advertising.schema.md) – `https://ns.adobe.com/xdm/context/advertising` + + + + + +## xdm:application +### Application + +This mixin is used to capture application information related to an ExperienceEvent, including the name of the application, app version, installs, launches, crashes, and closures. It could be either the application targeted by the event like the send of a push notification or the application originating the event such as a click, or a login. + +`xdm:application` +* is optional +* type: Application +* defined in [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md#xdmapplication) + +### xdm:application Type + + +* [Application](../../datatypes/application.schema.md) – `https://ns.adobe.com/xdm/context/application` + + + + + +## xdm:channel +### Experience channel + +Experience channel related to the ExperienceEvent. + +`xdm:channel` +* is optional +* type: Experience Channel +* defined in [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md#xdmchannel) + +### xdm:channel Type + + +* [Experience Channel](../../datatypes/channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel` + + + + + +## xdm:commerce +### Commerce + +Commerce specific data related to this event. + +`xdm:commerce` +* is optional +* type: Commerce +* defined in [Adobe Analytics ExperienceEvent Commerce Mixin](analytics/commerce.schema.md#xdmcommerce) + +### xdm:commerce Type + + +* [Commerce](../../datatypes/commerce.schema.md) – `https://ns.adobe.com/xdm/context/commerce` + + + + + +## xdm:dataSource +### Data source + +Globally unique identification of a data source. + +`xdm:dataSource` +* is optional +* type: Data Source +* defined in [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmdatasource) + +### xdm:dataSource Type + + +* [Data Source](../../datatypes/data/datasource.schema.md) – `https://ns.adobe.com/xdm/data/datasource` + + + + + +## xdm:device +### Device + +An identified device, application or device browser instance that is trackable across sessions, normally by cookies. + +`xdm:device` +* is optional +* type: Device +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) + +### xdm:device Type + + +* [Device](../../datatypes/device.schema.md) – `https://ns.adobe.com/xdm/context/device` + + + + + +## xdm:directMarketing +### Direct marketing + +Events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications. + +`xdm:directMarketing` +* is optional +* type: Direct marketing +* defined in [ExperienceEvent direct marketing details](../../mixins/experience-event/experienceevent-directmarketing.schema.md#xdmdirectmarketing) + +### xdm:directMarketing Type + + +* [Direct marketing](../../datatypes/direct-marketing.schema.md) – `https://ns.adobe.com/xdm/context/direct-marketing` + + + + + +## xdm:endUserIDs +### EndUserIDs + +Condensed, normalized encapsulation of end user identifiers asserted for this ExperienceEvent. + +`xdm:endUserIDs` +* is optional +* type: End user IDs +* defined in [ExperienceEvent EndUserIDs](../../mixins/experience-event/experienceevent-enduserids.schema.md#xdmenduserids) + +### xdm:endUserIDs Type + + +* [End user IDs](../../datatypes/enduserids.schema.md) – `https://ns.adobe.com/xdm/context/enduserids` + + + + + +## xdm:environment +### Environment + +Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions. + +`xdm:environment` +* is optional +* type: Environment +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) + +### xdm:environment Type + + +* [Environment](../../datatypes/environment.schema.md) – `https://ns.adobe.com/xdm/context/environment` + + + + + +## xdm:marketing +### Marketing + +The information related to marketing activities that are active with the touchpoint. + +`xdm:marketing` +* is optional +* type: Marketing +* defined in [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md#xdmmarketing) + +### xdm:marketing Type + + +* [Marketing](../../datatypes/marketing.schema.md) – `https://ns.adobe.com/xdm/context/marketing` + + + + + +## xdm:media +### Media + +Media activity information related to the experience event. + +`xdm:media` +* is optional +* type: Media information +* defined in [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md#xdmmedia) + +### xdm:media Type + + +* [Media information](../../datatypes/media.schema.md) – `https://ns.adobe.com/xdm/context/media` + + + + + +## xdm:placeContext +### Place context + +The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, and working hours. + +`xdm:placeContext` +* is optional +* type: Place context +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) + +### xdm:placeContext Type + + +* [Place context](../../datatypes/placecontext.schema.md) – `https://ns.adobe.com/xdm/context/placecontext` + + + + + +## xdm:productListItems +### Product List Items + +A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record. + +`xdm:productListItems` +* is optional +* type: Adobe Analytics extension to XDM Product List Item + +* defined in [Adobe Analytics ExperienceEvent Commerce Mixin](analytics/commerce.schema.md#xdmproductlistitems) + +### xdm:productListItems Type + + +Array type: Adobe Analytics extension to XDM Product List Item + +All items must be of the type: +* [Adobe Analytics extension to XDM Product List Item](analytics/productlistitem.schema.md) – `https://ns.adobe.com/experience/analytics/productlistitem` + + + + + + + + +## xdm:profileStitch +### Profile stitch + +Details about the IDs that were joined by profile stitching. + +`xdm:profileStitch` +* is optional +* type: Profile stitch + +* defined in [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md#xdmprofilestitch) + +### xdm:profileStitch Type + + +Array type: Profile stitch + +All items must be of the type: +* [Profile stitch](../../datatypes/profilestitch.schema.md) – `https://ns.adobe.com/xdm/context/profileStitch` + + + + + + + + +## xdm:receivedTimestamp +### Received time stamp + +The time at which this interaction was received by a server. + +`xdm:receivedTimestamp` +* is optional +* type: `string` +* defined in [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmreceivedtimestamp) + +### xdm:receivedTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:search +### Search + +The information related to web or mobile search. + +`xdm:search` +* is optional +* type: Search +* defined in [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md#xdmsearch) + +### xdm:search Type + + +* [Search](../../datatypes/search.schema.md) – `https://ns.adobe.com/xdm/context/search` + + + + + +## xdm:segmentMembership +### Segment Membership Map + +`xdm:segmentMembership` +* is optional +* type: `object` +* defined in [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmembership) + +### xdm:segmentMembership Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:segmentMemberships +### Segment Memberships + +The segments associated with this ExperienceEvent. Deprecated, use `xdm:segmentMembership` instead. + +`xdm:segmentMemberships` +* is optional +* type: Segment membership item + +* defined in [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) + +### xdm:segmentMemberships Type + + +Array type: Segment membership item + +All items must be of the type: +* [Segment membership item](../../datatypes/segmentmembershipitem.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembershipitem` + + + + + + + + +## xdm:userActivityRegion +### User activity region + +Region info where event is captured. + +`xdm:userActivityRegion` +* is optional +* type: `object` +* defined in [Data capture region for Experience Events](experienceevent-edgeregion.schema.md#xdmuseractivityregion) + +### xdm:userActivityRegion Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:captureTimestamp`| string | Optional | +| `xdm:dataCenterLocation`| string | Optional | + + + +#### xdm:captureTimestamp +##### Data Capture Timestamp + +The time when data was captured on data center node. + +`xdm:captureTimestamp` +* is optional +* type: `string` + +##### xdm:captureTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + +#### xdm:dataCenterLocation +##### Location of Data Center where data was captured + +undefined + +`xdm:dataCenterLocation` +* is optional +* type: `string` + +##### xdm:dataCenterLocation Type + + +`string` + + + +##### xdm:dataCenterLocation Known Values +| Value | Description | +|-------|-------------| +| `ARE1` | ARE1 | +| `ARE2` | ARE2 | +| `AUS1` | AUS1 | +| `AUS10` | AUS10 | +| `AUS2` | AUS2 | +| `AUS3` | AUS3 | +| `AUS4` | AUS4 | +| `AUS5` | AUS5 | +| `AUS6` | AUS6 | +| `AUS7` | AUS7 | +| `AUS8` | AUS8 | +| `AUS9` | AUS9 | +| `BEL1` | BEL1 | +| `BHR1` | BHR1 | +| `BRA2` | BRA2 | +| `BRA3` | BRA3 | +| `BRA4` | BRA4 | +| `CA1` | CA1 | +| `CA10` | CA10 | +| `CA12` | CA12 | +| `CA13` | CA13 | +| `CA14` | CA14 | +| `CA3` | CA3 | +| `CA4` | CA4 | +| `CA5` | CA5 | +| `CA6` | CA6 | +| `CA7` | CA7 | +| `CAN1` | CAN1 | +| `CAN2` | CAN2 | +| `CAN4` | CAN4 | +| `CAN5` | CAN5 | +| `CAN6` | CAN6 | +| `CAN7` | CAN7 | +| `CHE1` | CHE1 | +| `CHE2` | CHE2 | +| `CHE3` | CHE3 | +| `CHN1` | CHN1 | +| `CHN2` | CHN2 | +| `CHN3` | CHN3 | +| `CHN4` | CHN4 | +| `CHN5` | CHN5 | +| `CHN6` | CHN6 | +| `DEU1` | DEU1 | +| `DEU2` | DEU2 | +| `DEU4` | DEU4 | +| `DEU5` | DEU5 | +| `DEU6` | DEU6 | +| `DEU7` | DEU7 | +| `DNK1` | DNK1 | +| `FIN1` | FIN1 | +| `FRA10` | FRA10 | +| `FRA2` | FRA2 | +| `FRA3` | FRA3 | +| `FRA4` | FRA4 | +| `FRA5` | FRA5 | +| `FRA6` | FRA6 | +| `FRA7` | FRA7 | +| `FRA8` | FRA8 | +| `FRA9` | FRA9 | +| `GBR1` | GBR1 | +| `GBR10` | GBR10 | +| `GBR11` | GBR11 | +| `GBR12` | GBR12 | +| `GBR13` | GBR13 | +| `GBR5` | GBR5 | +| `GBR7` | GBR7 | +| `GBR8` | GBR8 | +| `GBR9` | GBR9 | +| `HKG1` | HKG1 | +| `HKG2` | HKG2 | +| `HKG3` | HKG3 | +| `HKG4` | HKG4 | +| `HKG5` | HKG5 | +| `IA1` | IA1 | +| `IA2` | IA2 | +| `IA3` | IA3 | +| `IA4` | IA4 | +| `IL1` | IL1 | +| `IND1` | IND1 | +| `IND2` | IND2 | +| `IND3` | IND3 | +| `IND4` | IND4 | +| `IND5` | IND5 | +| `IND6` | IND6 | +| `IRL1` | IRL1 | +| `IRL2` | IRL2 | +| `IRL3` | IRL3 | +| `JPN2` | JPN2 | +| `JPN3` | JPN3 | +| `JPN4` | JPN4 | +| `JPN5` | JPN5 | +| `JPN6` | JPN6 | +| `JPN7` | JPN7 | +| `JPN8` | JPN8 | +| `KOR1` | KOR1 | +| `KOR2` | KOR2 | +| `KOR3` | KOR3 | +| `MA1` | MA1 | +| `MA2` | MA2 | +| `MA3` | MA3 | +| `MDA1` | MDA1 | +| `NLD1` | NLD1 | +| `NLD2` | NLD2 | +| `NLD3` | NLD3 | +| `NLD4` | NLD4 | +| `NOR1` | NOR1 | +| `NOR2` | NOR2 | +| `NY7` | NY7 | +| `OH2` | OH2 | +| `OR1` | OR1 | +| `OR2` | OR2 | +| `OR3` | OR3 | +| `OR4` | OR4 | +| `ROU1` | ROU1 | +| `SC1` | SC1 | +| `SGP2` | SGP2 | +| `SGP3` | SGP3 | +| `SGP4` | SGP4 | +| `SGP5` | SGP5 | +| `SGP6` | SGP6 | +| `SGP7` | SGP7 | +| `SWE1` | SWE1 | +| `TWN1` | TWN1 | +| `TX3` | TX3 | +| `UT1` | UT1 | +| `UT2` | UT2 | +| `VA1` | VA1 | +| `VA10` | VA10 | +| `VA11` | VA11 | +| `VA12` | VA12 | +| `VA13` | VA13 | +| `VA14` | VA14 | +| `VA5` | VA5 | +| `VA6` | VA6 | +| `VA7` | VA7 | +| `VA8` | VA8 | +| `VA9` | VA9 | +| `WA1` | WA1 | +| `WA2` | WA2 | +| `WY1` | WY1 | +| `ZAF1` | ZAF1 | +| `ZAF2` | ZAF2 | + + + + + + + + + +## xdm:web +### Web + +The information related to web page and link of the ExperienceEvent. + +`xdm:web` +* is optional +* type: Web information +* defined in [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md#xdmweb) + +### xdm:web Type + + +* [Web information](../../datatypes/webinfo.schema.md) – `https://ns.adobe.com/xdm/context/webinfo` + + + + diff --git a/docs/reference/adobe/experience/analytics/commerce.schema.json b/docs/reference/adobe/experience/analytics/commerce.schema.json new file mode 100644 index 000000000..f97113ba8 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/commerce.schema.json @@ -0,0 +1,46 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/analytics/commerce", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Analytics ExperienceEvent Commerce Mixin", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Analytics ExperienceEvent Commerce Mixin.", + "definitions": { + "analytics-commerce": { + "properties": { + "xdm:productListItems": { + "title": "Product List Items", + "type": "array", + "description": "A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record.", + "items": { + "$ref": "https://ns.adobe.com/experience/analytics/productlistitem" + } + }, + "xdm:commerce": { + "title": "Commerce", + "$ref": "https://ns.adobe.com/xdm/context/commerce", + "description": "Commerce specific data related to this event." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/analytics-commerce" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/commerce.schema.md b/docs/reference/adobe/experience/analytics/commerce.schema.md new file mode 100644 index 000000000..001f6e961 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/commerce.schema.md @@ -0,0 +1,71 @@ + +# Adobe Analytics ExperienceEvent Commerce Mixin Schema + +``` +https://ns.adobe.com/experience/analytics/commerce +``` + +Adobe Analytics ExperienceEvent Commerce Mixin. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/analytics/commerce.schema.json](adobe/experience/analytics/commerce.schema.json) | +## Schema Hierarchy + +* Adobe Analytics ExperienceEvent Commerce Mixin `https://ns.adobe.com/experience/analytics/commerce` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Commerce](../../../datatypes/commerce.schema.md) `https://ns.adobe.com/xdm/context/commerce` + + +# Adobe Analytics ExperienceEvent Commerce Mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:commerce](#xdmcommerce) | Commerce | Optional | Adobe Analytics ExperienceEvent Commerce Mixin (this schema) | +| [xdm:productListItems](#xdmproductlistitems) | Adobe Analytics extension to XDM Product List Item | Optional | Adobe Analytics ExperienceEvent Commerce Mixin (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:commerce +### Commerce + +Commerce specific data related to this event. + +`xdm:commerce` +* is optional +* type: Commerce +* defined in this schema + +### xdm:commerce Type + + +* [Commerce](../../../datatypes/commerce.schema.md) – `https://ns.adobe.com/xdm/context/commerce` + + + + + +## xdm:productListItems +### Product List Items + +A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record. + +`xdm:productListItems` +* is optional +* type: Adobe Analytics extension to XDM Product List Item + +* defined in this schema + +### xdm:productListItems Type + + +Array type: Adobe Analytics extension to XDM Product List Item + +All items must be of the type: +* [Adobe Analytics extension to XDM Product List Item](productlistitem.schema.md) – `https://ns.adobe.com/experience/analytics/productlistitem` + + + + + + + diff --git a/docs/reference/adobe/experience/analytics/customDimensions.schema.json b/docs/reference/adobe/experience/analytics/customDimensions.schema.json new file mode 100644 index 000000000..a0902da80 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/customDimensions.schema.json @@ -0,0 +1,8 @@ +{ + "xdm:eVars": { + "title": "Merchandizing eVars", + "$ref": "https://ns.adobe.com/experience/analytics/evars" + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/customDimensions" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/customDimensions.schema.md b/docs/reference/adobe/experience/analytics/customDimensions.schema.md new file mode 100644 index 000000000..0b12ce5af --- /dev/null +++ b/docs/reference/adobe/experience/analytics/customDimensions.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/customDimensions +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/customDimensions.schema.json](adobe/experience/analytics/customDimensions.schema.json) | diff --git a/docs/reference/adobe/experience/analytics/endUser.schema.json b/docs/reference/adobe/experience/analytics/endUser.schema.json new file mode 100644 index 000000000..b970a33f5 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/endUser.schema.json @@ -0,0 +1,16 @@ +{ + "xdm:firstTimestamp": { + "title": "End-User First Timestamp", + "type": "integer", + "description": "The timestamp for the first ExperienceEvent for this end-user. Milliseconds since midnight of January 1, 1970.", + "minimum": 1, + "maximum": 9223372036854770000 + }, + "xdm:firstWeb": { + "title": "End-User First Web Details", + "$ref": "https://ns.adobe.com/xdm/context/webinfo", + "description": "The information related to web page, link, and referrer from the first ExperienceEvent for this end-user." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/endUser" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/endUser.schema.md b/docs/reference/adobe/experience/analytics/endUser.schema.md new file mode 100644 index 000000000..fb65f861b --- /dev/null +++ b/docs/reference/adobe/experience/analytics/endUser.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/endUser +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/endUser.schema.json](adobe/experience/analytics/endUser.schema.json) | diff --git a/docs/reference/adobe/experience/analytics/evars.schema.json b/docs/reference/adobe/experience/analytics/evars.schema.json new file mode 100644 index 000000000..3c7e4133c --- /dev/null +++ b/docs/reference/adobe/experience/analytics/evars.schema.json @@ -0,0 +1,1277 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/analytics/evars", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "eVars", + "type": "object", + "description": "Custom eVars.", + "definitions": { + "eVars": { + "properties": { + "xdm:eVar1": { + "title": "eVar1", + "type": "string", + "description": "Custom conversion variable 1." + }, + "xdm:eVar2": { + "title": "eVar2", + "type": "string", + "description": "Custom conversion variable 2." + }, + "xdm:eVar3": { + "title": "eVar3", + "type": "string", + "description": "Custom conversion variable 3." + }, + "xdm:eVar4": { + "title": "eVar4", + "type": "string", + "description": "Custom conversion variable 4." + }, + "xdm:eVar5": { + "title": "eVar5", + "type": "string", + "description": "Custom conversion variable 5." + }, + "xdm:eVar6": { + "title": "eVar6", + "type": "string", + "description": "Custom conversion variable 6." + }, + "xdm:eVar7": { + "title": "eVar7", + "type": "string", + "description": "Custom conversion variable 7." + }, + "xdm:eVar8": { + "title": "eVar8", + "type": "string", + "description": "Custom conversion variable 8." + }, + "xdm:eVar9": { + "title": "eVar9", + "type": "string", + "description": "Custom conversion variable 9." + }, + "xdm:eVar10": { + "title": "eVar10", + "type": "string", + "description": "Custom conversion variable 10." + }, + "xdm:eVar11": { + "title": "eVar11", + "type": "string", + "description": "Custom conversion variable 11." + }, + "xdm:eVar12": { + "title": "eVar12", + "type": "string", + "description": "Custom conversion variable 12." + }, + "xdm:eVar13": { + "title": "eVar13", + "type": "string", + "description": "Custom conversion variable 13." + }, + "xdm:eVar14": { + "title": "eVar14", + "type": "string", + "description": "Custom conversion variable 14." + }, + "xdm:eVar15": { + "title": "eVar15", + "type": "string", + "description": "Custom conversion variable 15." + }, + "xdm:eVar16": { + "title": "eVar16", + "type": "string", + "description": "Custom conversion variable 16." + }, + "xdm:eVar17": { + "title": "eVar17", + "type": "string", + "description": "Custom conversion variable 17." + }, + "xdm:eVar18": { + "title": "eVar18", + "type": "string", + "description": "Custom conversion variable 18." + }, + "xdm:eVar19": { + "title": "eVar19", + "type": "string", + "description": "Custom conversion variable 19." + }, + "xdm:eVar20": { + "title": "eVar20", + "type": "string", + "description": "Custom conversion variable 20." + }, + "xdm:eVar21": { + "title": "eVar21", + "type": "string", + "description": "Custom conversion variable 21." + }, + "xdm:eVar22": { + "title": "eVar22", + "type": "string", + "description": "Custom conversion variable 22." + }, + "xdm:eVar23": { + "title": "eVar23", + "type": "string", + "description": "Custom conversion variable 23." + }, + "xdm:eVar24": { + "title": "eVar24", + "type": "string", + "description": "Custom conversion variable 24." + }, + "xdm:eVar25": { + "title": "eVar25", + "type": "string", + "description": "Custom conversion variable 25." + }, + "xdm:eVar26": { + "title": "eVar26", + "type": "string", + "description": "Custom conversion variable 26." + }, + "xdm:eVar27": { + "title": "eVar27", + "type": "string", + "description": "Custom conversion variable 27." + }, + "xdm:eVar28": { + "title": "eVar28", + "type": "string", + "description": "Custom conversion variable 28." + }, + "xdm:eVar29": { + "title": "eVar29", + "type": "string", + "description": "Custom conversion variable 29." + }, + "xdm:eVar30": { + "title": "eVar30", + "type": "string", + "description": "Custom conversion variable 30." + }, + "xdm:eVar31": { + "title": "eVar31", + "type": "string", + "description": "Custom conversion variable 31." + }, + "xdm:eVar32": { + "title": "eVar32", + "type": "string", + "description": "Custom conversion variable 32." + }, + "xdm:eVar33": { + "title": "eVar33", + "type": "string", + "description": "Custom conversion variable 33." + }, + "xdm:eVar34": { + "title": "eVar34", + "type": "string", + "description": "Custom conversion variable 34." + }, + "xdm:eVar35": { + "title": "eVar35", + "type": "string", + "description": "Custom conversion variable 35." + }, + "xdm:eVar36": { + "title": "eVar36", + "type": "string", + "description": "Custom conversion variable 36." + }, + "xdm:eVar37": { + "title": "eVar37", + "type": "string", + "description": "Custom conversion variable 37." + }, + "xdm:eVar38": { + "title": "eVar38", + "type": "string", + "description": "Custom conversion variable 38." + }, + "xdm:eVar39": { + "title": "eVar39", + "type": "string", + "description": "Custom conversion variable 39." + }, + "xdm:eVar40": { + "title": "eVar40", + "type": "string", + "description": "Custom conversion variable 40." + }, + "xdm:eVar41": { + "title": "eVar41", + "type": "string", + "description": "Custom conversion variable 41." + }, + "xdm:eVar42": { + "title": "eVar42", + "type": "string", + "description": "Custom conversion variable 42." + }, + "xdm:eVar43": { + "title": "eVar43", + "type": "string", + "description": "Custom conversion variable 43." + }, + "xdm:eVar44": { + "title": "eVar44", + "type": "string", + "description": "Custom conversion variable 44." + }, + "xdm:eVar45": { + "title": "eVar45", + "type": "string", + "description": "Custom conversion variable 45." + }, + "xdm:eVar46": { + "title": "eVar46", + "type": "string", + "description": "Custom conversion variable 46." + }, + "xdm:eVar47": { + "title": "eVar47", + "type": "string", + "description": "Custom conversion variable 47." + }, + "xdm:eVar48": { + "title": "eVar48", + "type": "string", + "description": "Custom conversion variable 48." + }, + "xdm:eVar49": { + "title": "eVar49", + "type": "string", + "description": "Custom conversion variable 49." + }, + "xdm:eVar50": { + "title": "eVar50", + "type": "string", + "description": "Custom conversion variable 50." + }, + "xdm:eVar51": { + "title": "eVar51", + "type": "string", + "description": "Custom conversion variable 51." + }, + "xdm:eVar52": { + "title": "eVar52", + "type": "string", + "description": "Custom conversion variable 52." + }, + "xdm:eVar53": { + "title": "eVar53", + "type": "string", + "description": "Custom conversion variable 53." + }, + "xdm:eVar54": { + "title": "eVar54", + "type": "string", + "description": "Custom conversion variable 54." + }, + "xdm:eVar55": { + "title": "eVar55", + "type": "string", + "description": "Custom conversion variable 55." + }, + "xdm:eVar56": { + "title": "eVar56", + "type": "string", + "description": "Custom conversion variable 56." + }, + "xdm:eVar57": { + "title": "eVar57", + "type": "string", + "description": "Custom conversion variable 57." + }, + "xdm:eVar58": { + "title": "eVar58", + "type": "string", + "description": "Custom conversion variable 58." + }, + "xdm:eVar59": { + "title": "eVar59", + "type": "string", + "description": "Custom conversion variable 59." + }, + "xdm:eVar60": { + "title": "eVar60", + "type": "string", + "description": "Custom conversion variable 60." + }, + "xdm:eVar61": { + "title": "eVar61", + "type": "string", + "description": "Custom conversion variable 61." + }, + "xdm:eVar62": { + "title": "eVar62", + "type": "string", + "description": "Custom conversion variable 62." + }, + "xdm:eVar63": { + "title": "eVar63", + "type": "string", + "description": "Custom conversion variable 63." + }, + "xdm:eVar64": { + "title": "eVar64", + "type": "string", + "description": "Custom conversion variable 64." + }, + "xdm:eVar65": { + "title": "eVar65", + "type": "string", + "description": "Custom conversion variable 65." + }, + "xdm:eVar66": { + "title": "eVar66", + "type": "string", + "description": "Custom conversion variable 66." + }, + "xdm:eVar67": { + "title": "eVar67", + "type": "string", + "description": "Custom conversion variable 67." + }, + "xdm:eVar68": { + "title": "eVar68", + "type": "string", + "description": "Custom conversion variable 68." + }, + "xdm:eVar69": { + "title": "eVar69", + "type": "string", + "description": "Custom conversion variable 69." + }, + "xdm:eVar70": { + "title": "eVar70", + "type": "string", + "description": "Custom conversion variable 70." + }, + "xdm:eVar71": { + "title": "eVar71", + "type": "string", + "description": "Custom conversion variable 71." + }, + "xdm:eVar72": { + "title": "eVar72", + "type": "string", + "description": "Custom conversion variable 72." + }, + "xdm:eVar73": { + "title": "eVar73", + "type": "string", + "description": "Custom conversion variable 73." + }, + "xdm:eVar74": { + "title": "eVar74", + "type": "string", + "description": "Custom conversion variable 74." + }, + "xdm:eVar75": { + "title": "eVar75", + "type": "string", + "description": "Custom conversion variable 75." + }, + "xdm:eVar76": { + "title": "eVar76", + "type": "string", + "description": "Custom conversion variable 76." + }, + "xdm:eVar77": { + "title": "eVar77", + "type": "string", + "description": "Custom conversion variable 77." + }, + "xdm:eVar78": { + "title": "eVar78", + "type": "string", + "description": "Custom conversion variable 78." + }, + "xdm:eVar79": { + "title": "eVar79", + "type": "string", + "description": "Custom conversion variable 79." + }, + "xdm:eVar80": { + "title": "eVar80", + "type": "string", + "description": "Custom conversion variable 80." + }, + "xdm:eVar81": { + "title": "eVar81", + "type": "string", + "description": "Custom conversion variable 81." + }, + "xdm:eVar82": { + "title": "eVar82", + "type": "string", + "description": "Custom conversion variable 82." + }, + "xdm:eVar83": { + "title": "eVar83", + "type": "string", + "description": "Custom conversion variable 83." + }, + "xdm:eVar84": { + "title": "eVar84", + "type": "string", + "description": "Custom conversion variable 84." + }, + "xdm:eVar85": { + "title": "eVar85", + "type": "string", + "description": "Custom conversion variable 85." + }, + "xdm:eVar86": { + "title": "eVar86", + "type": "string", + "description": "Custom conversion variable 86." + }, + "xdm:eVar87": { + "title": "eVar87", + "type": "string", + "description": "Custom conversion variable 87." + }, + "xdm:eVar88": { + "title": "eVar88", + "type": "string", + "description": "Custom conversion variable 88." + }, + "xdm:eVar89": { + "title": "eVar89", + "type": "string", + "description": "Custom conversion variable 89." + }, + "xdm:eVar90": { + "title": "eVar90", + "type": "string", + "description": "Custom conversion variable 90." + }, + "xdm:eVar91": { + "title": "eVar91", + "type": "string", + "description": "Custom conversion variable 91." + }, + "xdm:eVar92": { + "title": "eVar92", + "type": "string", + "description": "Custom conversion variable 92." + }, + "xdm:eVar93": { + "title": "eVar93", + "type": "string", + "description": "Custom conversion variable 93." + }, + "xdm:eVar94": { + "title": "eVar94", + "type": "string", + "description": "Custom conversion variable 94." + }, + "xdm:eVar95": { + "title": "eVar95", + "type": "string", + "description": "Custom conversion variable 95." + }, + "xdm:eVar96": { + "title": "eVar96", + "type": "string", + "description": "Custom conversion variable 96." + }, + "xdm:eVar97": { + "title": "eVar97", + "type": "string", + "description": "Custom conversion variable 97." + }, + "xdm:eVar98": { + "title": "eVar98", + "type": "string", + "description": "Custom conversion variable 98." + }, + "xdm:eVar99": { + "title": "eVar99", + "type": "string", + "description": "Custom conversion variable 99." + }, + "xdm:eVar100": { + "title": "eVar100", + "type": "string", + "description": "Custom conversion variable 100." + }, + "xdm:eVar101": { + "title": "eVar101", + "type": "string", + "description": "Custom conversion variable 101." + }, + "xdm:eVar102": { + "title": "eVar102", + "type": "string", + "description": "Custom conversion variable 102." + }, + "xdm:eVar103": { + "title": "eVar103", + "type": "string", + "description": "Custom conversion variable 103." + }, + "xdm:eVar104": { + "title": "eVar104", + "type": "string", + "description": "Custom conversion variable 104." + }, + "xdm:eVar105": { + "title": "eVar105", + "type": "string", + "description": "Custom conversion variable 105." + }, + "xdm:eVar106": { + "title": "eVar106", + "type": "string", + "description": "Custom conversion variable 106." + }, + "xdm:eVar107": { + "title": "eVar107", + "type": "string", + "description": "Custom conversion variable 107." + }, + "xdm:eVar108": { + "title": "eVar108", + "type": "string", + "description": "Custom conversion variable 108." + }, + "xdm:eVar109": { + "title": "eVar109", + "type": "string", + "description": "Custom conversion variable 109." + }, + "xdm:eVar110": { + "title": "eVar110", + "type": "string", + "description": "Custom conversion variable 110." + }, + "xdm:eVar111": { + "title": "eVar111", + "type": "string", + "description": "Custom conversion variable 111." + }, + "xdm:eVar112": { + "title": "eVar112", + "type": "string", + "description": "Custom conversion variable 112." + }, + "xdm:eVar113": { + "title": "eVar113", + "type": "string", + "description": "Custom conversion variable 113." + }, + "xdm:eVar114": { + "title": "eVar114", + "type": "string", + "description": "Custom conversion variable 114." + }, + "xdm:eVar115": { + "title": "eVar115", + "type": "string", + "description": "Custom conversion variable 115." + }, + "xdm:eVar116": { + "title": "eVar116", + "type": "string", + "description": "Custom conversion variable 116." + }, + "xdm:eVar117": { + "title": "eVar117", + "type": "string", + "description": "Custom conversion variable 117." + }, + "xdm:eVar118": { + "title": "eVar118", + "type": "string", + "description": "Custom conversion variable 118." + }, + "xdm:eVar119": { + "title": "eVar119", + "type": "string", + "description": "Custom conversion variable 119." + }, + "xdm:eVar120": { + "title": "eVar120", + "type": "string", + "description": "Custom conversion variable 120." + }, + "xdm:eVar121": { + "title": "eVar121", + "type": "string", + "description": "Custom conversion variable 121." + }, + "xdm:eVar122": { + "title": "eVar122", + "type": "string", + "description": "Custom conversion variable 122." + }, + "xdm:eVar123": { + "title": "eVar123", + "type": "string", + "description": "Custom conversion variable 123." + }, + "xdm:eVar124": { + "title": "eVar124", + "type": "string", + "description": "Custom conversion variable 124." + }, + "xdm:eVar125": { + "title": "eVar125", + "type": "string", + "description": "Custom conversion variable 125." + }, + "xdm:eVar126": { + "title": "eVar126", + "type": "string", + "description": "Custom conversion variable 126." + }, + "xdm:eVar127": { + "title": "eVar127", + "type": "string", + "description": "Custom conversion variable 127." + }, + "xdm:eVar128": { + "title": "eVar128", + "type": "string", + "description": "Custom conversion variable 128." + }, + "xdm:eVar129": { + "title": "eVar129", + "type": "string", + "description": "Custom conversion variable 129." + }, + "xdm:eVar130": { + "title": "eVar130", + "type": "string", + "description": "Custom conversion variable 130." + }, + "xdm:eVar131": { + "title": "eVar131", + "type": "string", + "description": "Custom conversion variable 131." + }, + "xdm:eVar132": { + "title": "eVar132", + "type": "string", + "description": "Custom conversion variable 132." + }, + "xdm:eVar133": { + "title": "eVar133", + "type": "string", + "description": "Custom conversion variable 133." + }, + "xdm:eVar134": { + "title": "eVar134", + "type": "string", + "description": "Custom conversion variable 134." + }, + "xdm:eVar135": { + "title": "eVar135", + "type": "string", + "description": "Custom conversion variable 135." + }, + "xdm:eVar136": { + "title": "eVar136", + "type": "string", + "description": "Custom conversion variable 136." + }, + "xdm:eVar137": { + "title": "eVar137", + "type": "string", + "description": "Custom conversion variable 137." + }, + "xdm:eVar138": { + "title": "eVar138", + "type": "string", + "description": "Custom conversion variable 138." + }, + "xdm:eVar139": { + "title": "eVar139", + "type": "string", + "description": "Custom conversion variable 139." + }, + "xdm:eVar140": { + "title": "eVar140", + "type": "string", + "description": "Custom conversion variable 140." + }, + "xdm:eVar141": { + "title": "eVar141", + "type": "string", + "description": "Custom conversion variable 141." + }, + "xdm:eVar142": { + "title": "eVar142", + "type": "string", + "description": "Custom conversion variable 142." + }, + "xdm:eVar143": { + "title": "eVar143", + "type": "string", + "description": "Custom conversion variable 143." + }, + "xdm:eVar144": { + "title": "eVar144", + "type": "string", + "description": "Custom conversion variable 144." + }, + "xdm:eVar145": { + "title": "eVar145", + "type": "string", + "description": "Custom conversion variable 145." + }, + "xdm:eVar146": { + "title": "eVar146", + "type": "string", + "description": "Custom conversion variable 146." + }, + "xdm:eVar147": { + "title": "eVar147", + "type": "string", + "description": "Custom conversion variable 147." + }, + "xdm:eVar148": { + "title": "eVar148", + "type": "string", + "description": "Custom conversion variable 148." + }, + "xdm:eVar149": { + "title": "eVar149", + "type": "string", + "description": "Custom conversion variable 149." + }, + "xdm:eVar150": { + "title": "eVar150", + "type": "string", + "description": "Custom conversion variable 150." + }, + "xdm:eVar151": { + "title": "eVar151", + "type": "string", + "description": "Custom conversion variable 151." + }, + "xdm:eVar152": { + "title": "eVar152", + "type": "string", + "description": "Custom conversion variable 152." + }, + "xdm:eVar153": { + "title": "eVar153", + "type": "string", + "description": "Custom conversion variable 153." + }, + "xdm:eVar154": { + "title": "eVar154", + "type": "string", + "description": "Custom conversion variable 154." + }, + "xdm:eVar155": { + "title": "eVar155", + "type": "string", + "description": "Custom conversion variable 155." + }, + "xdm:eVar156": { + "title": "eVar156", + "type": "string", + "description": "Custom conversion variable 156." + }, + "xdm:eVar157": { + "title": "eVar157", + "type": "string", + "description": "Custom conversion variable 157." + }, + "xdm:eVar158": { + "title": "eVar158", + "type": "string", + "description": "Custom conversion variable 158." + }, + "xdm:eVar159": { + "title": "eVar159", + "type": "string", + "description": "Custom conversion variable 159." + }, + "xdm:eVar160": { + "title": "eVar160", + "type": "string", + "description": "Custom conversion variable 160." + }, + "xdm:eVar161": { + "title": "eVar161", + "type": "string", + "description": "Custom conversion variable 161." + }, + "xdm:eVar162": { + "title": "eVar162", + "type": "string", + "description": "Custom conversion variable 162." + }, + "xdm:eVar163": { + "title": "eVar163", + "type": "string", + "description": "Custom conversion variable 163." + }, + "xdm:eVar164": { + "title": "eVar164", + "type": "string", + "description": "Custom conversion variable 164." + }, + "xdm:eVar165": { + "title": "eVar165", + "type": "string", + "description": "Custom conversion variable 165." + }, + "xdm:eVar166": { + "title": "eVar166", + "type": "string", + "description": "Custom conversion variable 166." + }, + "xdm:eVar167": { + "title": "eVar167", + "type": "string", + "description": "Custom conversion variable 167." + }, + "xdm:eVar168": { + "title": "eVar168", + "type": "string", + "description": "Custom conversion variable 168." + }, + "xdm:eVar169": { + "title": "eVar169", + "type": "string", + "description": "Custom conversion variable 169." + }, + "xdm:eVar170": { + "title": "eVar170", + "type": "string", + "description": "Custom conversion variable 170." + }, + "xdm:eVar171": { + "title": "eVar171", + "type": "string", + "description": "Custom conversion variable 171." + }, + "xdm:eVar172": { + "title": "eVar172", + "type": "string", + "description": "Custom conversion variable 172." + }, + "xdm:eVar173": { + "title": "eVar173", + "type": "string", + "description": "Custom conversion variable 173." + }, + "xdm:eVar174": { + "title": "eVar174", + "type": "string", + "description": "Custom conversion variable 174." + }, + "xdm:eVar175": { + "title": "eVar175", + "type": "string", + "description": "Custom conversion variable 175." + }, + "xdm:eVar176": { + "title": "eVar176", + "type": "string", + "description": "Custom conversion variable 176." + }, + "xdm:eVar177": { + "title": "eVar177", + "type": "string", + "description": "Custom conversion variable 177." + }, + "xdm:eVar178": { + "title": "eVar178", + "type": "string", + "description": "Custom conversion variable 178." + }, + "xdm:eVar179": { + "title": "eVar179", + "type": "string", + "description": "Custom conversion variable 179." + }, + "xdm:eVar180": { + "title": "eVar180", + "type": "string", + "description": "Custom conversion variable 180." + }, + "xdm:eVar181": { + "title": "eVar181", + "type": "string", + "description": "Custom conversion variable 181." + }, + "xdm:eVar182": { + "title": "eVar182", + "type": "string", + "description": "Custom conversion variable 182." + }, + "xdm:eVar183": { + "title": "eVar183", + "type": "string", + "description": "Custom conversion variable 183." + }, + "xdm:eVar184": { + "title": "eVar184", + "type": "string", + "description": "Custom conversion variable 184." + }, + "xdm:eVar185": { + "title": "eVar185", + "type": "string", + "description": "Custom conversion variable 185." + }, + "xdm:eVar186": { + "title": "eVar186", + "type": "string", + "description": "Custom conversion variable 186." + }, + "xdm:eVar187": { + "title": "eVar187", + "type": "string", + "description": "Custom conversion variable 187." + }, + "xdm:eVar188": { + "title": "eVar188", + "type": "string", + "description": "Custom conversion variable 188." + }, + "xdm:eVar189": { + "title": "eVar189", + "type": "string", + "description": "Custom conversion variable 189." + }, + "xdm:eVar190": { + "title": "eVar190", + "type": "string", + "description": "Custom conversion variable 190." + }, + "xdm:eVar191": { + "title": "eVar191", + "type": "string", + "description": "Custom conversion variable 191." + }, + "xdm:eVar192": { + "title": "eVar192", + "type": "string", + "description": "Custom conversion variable 192." + }, + "xdm:eVar193": { + "title": "eVar193", + "type": "string", + "description": "Custom conversion variable 193." + }, + "xdm:eVar194": { + "title": "eVar194", + "type": "string", + "description": "Custom conversion variable 194." + }, + "xdm:eVar195": { + "title": "eVar195", + "type": "string", + "description": "Custom conversion variable 195." + }, + "xdm:eVar196": { + "title": "eVar196", + "type": "string", + "description": "Custom conversion variable 196." + }, + "xdm:eVar197": { + "title": "eVar197", + "type": "string", + "description": "Custom conversion variable 197." + }, + "xdm:eVar198": { + "title": "eVar198", + "type": "string", + "description": "Custom conversion variable 198." + }, + "xdm:eVar199": { + "title": "eVar199", + "type": "string", + "description": "Custom conversion variable 199." + }, + "xdm:eVar200": { + "title": "eVar200", + "type": "string", + "description": "Custom conversion variable 200." + }, + "xdm:eVar201": { + "title": "eVar201", + "type": "string", + "description": "Custom conversion variable 201." + }, + "xdm:eVar202": { + "title": "eVar202", + "type": "string", + "description": "Custom conversion variable 202." + }, + "xdm:eVar203": { + "title": "eVar203", + "type": "string", + "description": "Custom conversion variable 203." + }, + "xdm:eVar204": { + "title": "eVar204", + "type": "string", + "description": "Custom conversion variable 204." + }, + "xdm:eVar205": { + "title": "eVar205", + "type": "string", + "description": "Custom conversion variable 205." + }, + "xdm:eVar206": { + "title": "eVar206", + "type": "string", + "description": "Custom conversion variable 206." + }, + "xdm:eVar207": { + "title": "eVar207", + "type": "string", + "description": "Custom conversion variable 207." + }, + "xdm:eVar208": { + "title": "eVar208", + "type": "string", + "description": "Custom conversion variable 208." + }, + "xdm:eVar209": { + "title": "eVar209", + "type": "string", + "description": "Custom conversion variable 209." + }, + "xdm:eVar210": { + "title": "eVar210", + "type": "string", + "description": "Custom conversion variable 210." + }, + "xdm:eVar211": { + "title": "eVar211", + "type": "string", + "description": "Custom conversion variable 211." + }, + "xdm:eVar212": { + "title": "eVar212", + "type": "string", + "description": "Custom conversion variable 212." + }, + "xdm:eVar213": { + "title": "eVar213", + "type": "string", + "description": "Custom conversion variable 213." + }, + "xdm:eVar214": { + "title": "eVar214", + "type": "string", + "description": "Custom conversion variable 214." + }, + "xdm:eVar215": { + "title": "eVar215", + "type": "string", + "description": "Custom conversion variable 215." + }, + "xdm:eVar216": { + "title": "eVar216", + "type": "string", + "description": "Custom conversion variable 216." + }, + "xdm:eVar217": { + "title": "eVar217", + "type": "string", + "description": "Custom conversion variable 217." + }, + "xdm:eVar218": { + "title": "eVar218", + "type": "string", + "description": "Custom conversion variable 218." + }, + "xdm:eVar219": { + "title": "eVar219", + "type": "string", + "description": "Custom conversion variable 219." + }, + "xdm:eVar220": { + "title": "eVar220", + "type": "string", + "description": "Custom conversion variable 220." + }, + "xdm:eVar221": { + "title": "eVar221", + "type": "string", + "description": "Custom conversion variable 221." + }, + "xdm:eVar222": { + "title": "eVar222", + "type": "string", + "description": "Custom conversion variable 222." + }, + "xdm:eVar223": { + "title": "eVar223", + "type": "string", + "description": "Custom conversion variable 223." + }, + "xdm:eVar224": { + "title": "eVar224", + "type": "string", + "description": "Custom conversion variable 224." + }, + "xdm:eVar225": { + "title": "eVar225", + "type": "string", + "description": "Custom conversion variable 225." + }, + "xdm:eVar226": { + "title": "eVar226", + "type": "string", + "description": "Custom conversion variable 226." + }, + "xdm:eVar227": { + "title": "eVar227", + "type": "string", + "description": "Custom conversion variable 227." + }, + "xdm:eVar228": { + "title": "eVar228", + "type": "string", + "description": "Custom conversion variable 228." + }, + "xdm:eVar229": { + "title": "eVar229", + "type": "string", + "description": "Custom conversion variable 229." + }, + "xdm:eVar230": { + "title": "eVar230", + "type": "string", + "description": "Custom conversion variable 230." + }, + "xdm:eVar231": { + "title": "eVar231", + "type": "string", + "description": "Custom conversion variable 231." + }, + "xdm:eVar232": { + "title": "eVar232", + "type": "string", + "description": "Custom conversion variable 232." + }, + "xdm:eVar233": { + "title": "eVar233", + "type": "string", + "description": "Custom conversion variable 233." + }, + "xdm:eVar234": { + "title": "eVar234", + "type": "string", + "description": "Custom conversion variable 234." + }, + "xdm:eVar235": { + "title": "eVar235", + "type": "string", + "description": "Custom conversion variable 235." + }, + "xdm:eVar236": { + "title": "eVar236", + "type": "string", + "description": "Custom conversion variable 236." + }, + "xdm:eVar237": { + "title": "eVar237", + "type": "string", + "description": "Custom conversion variable 237." + }, + "xdm:eVar238": { + "title": "eVar238", + "type": "string", + "description": "Custom conversion variable 238." + }, + "xdm:eVar239": { + "title": "eVar239", + "type": "string", + "description": "Custom conversion variable 239." + }, + "xdm:eVar240": { + "title": "eVar240", + "type": "string", + "description": "Custom conversion variable 240." + }, + "xdm:eVar241": { + "title": "eVar241", + "type": "string", + "description": "Custom conversion variable 241." + }, + "xdm:eVar242": { + "title": "eVar242", + "type": "string", + "description": "Custom conversion variable 242." + }, + "xdm:eVar243": { + "title": "eVar243", + "type": "string", + "description": "Custom conversion variable 243." + }, + "xdm:eVar244": { + "title": "eVar244", + "type": "string", + "description": "Custom conversion variable 244." + }, + "xdm:eVar245": { + "title": "eVar245", + "type": "string", + "description": "Custom conversion variable 245." + }, + "xdm:eVar246": { + "title": "eVar246", + "type": "string", + "description": "Custom conversion variable 246." + }, + "xdm:eVar247": { + "title": "eVar247", + "type": "string", + "description": "Custom conversion variable 247." + }, + "xdm:eVar248": { + "title": "eVar248", + "type": "string", + "description": "Custom conversion variable 248." + }, + "xdm:eVar249": { + "title": "eVar249", + "type": "string", + "description": "Custom conversion variable 249." + }, + "xdm:eVar250": { + "title": "eVar250", + "type": "string", + "description": "Custom conversion variable 250." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/eVars" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/evars.schema.md b/docs/reference/adobe/experience/analytics/evars.schema.md new file mode 100644 index 000000000..4b48eb360 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/evars.schema.md @@ -0,0 +1,5273 @@ + +# eVars Schema + +``` +https://ns.adobe.com/experience/analytics/evars +``` + +Custom eVars. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/evars.schema.json](adobe/experience/analytics/evars.schema.json) | +## Schema Hierarchy + +* eVars `https://ns.adobe.com/experience/analytics/evars` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +# eVars Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:eVar1](#xdmevar1) | `string` | Optional | eVars (this schema) | +| [xdm:eVar10](#xdmevar10) | `string` | Optional | eVars (this schema) | +| [xdm:eVar100](#xdmevar100) | `string` | Optional | eVars (this schema) | +| [xdm:eVar101](#xdmevar101) | `string` | Optional | eVars (this schema) | +| [xdm:eVar102](#xdmevar102) | `string` | Optional | eVars (this schema) | +| [xdm:eVar103](#xdmevar103) | `string` | Optional | eVars (this schema) | +| [xdm:eVar104](#xdmevar104) | `string` | Optional | eVars (this schema) | +| [xdm:eVar105](#xdmevar105) | `string` | Optional | eVars (this schema) | +| [xdm:eVar106](#xdmevar106) | `string` | Optional | eVars (this schema) | +| [xdm:eVar107](#xdmevar107) | `string` | Optional | eVars (this schema) | +| [xdm:eVar108](#xdmevar108) | `string` | Optional | eVars (this schema) | +| [xdm:eVar109](#xdmevar109) | `string` | Optional | eVars (this schema) | +| [xdm:eVar11](#xdmevar11) | `string` | Optional | eVars (this schema) | +| [xdm:eVar110](#xdmevar110) | `string` | Optional | eVars (this schema) | +| [xdm:eVar111](#xdmevar111) | `string` | Optional | eVars (this schema) | +| [xdm:eVar112](#xdmevar112) | `string` | Optional | eVars (this schema) | +| [xdm:eVar113](#xdmevar113) | `string` | Optional | eVars (this schema) | +| [xdm:eVar114](#xdmevar114) | `string` | Optional | eVars (this schema) | +| [xdm:eVar115](#xdmevar115) | `string` | Optional | eVars (this schema) | +| [xdm:eVar116](#xdmevar116) | `string` | Optional | eVars (this schema) | +| [xdm:eVar117](#xdmevar117) | `string` | Optional | eVars (this schema) | +| [xdm:eVar118](#xdmevar118) | `string` | Optional | eVars (this schema) | +| [xdm:eVar119](#xdmevar119) | `string` | Optional | eVars (this schema) | +| [xdm:eVar12](#xdmevar12) | `string` | Optional | eVars (this schema) | +| [xdm:eVar120](#xdmevar120) | `string` | Optional | eVars (this schema) | +| [xdm:eVar121](#xdmevar121) | `string` | Optional | eVars (this schema) | +| [xdm:eVar122](#xdmevar122) | `string` | Optional | eVars (this schema) | +| [xdm:eVar123](#xdmevar123) | `string` | Optional | eVars (this schema) | +| [xdm:eVar124](#xdmevar124) | `string` | Optional | eVars (this schema) | +| [xdm:eVar125](#xdmevar125) | `string` | Optional | eVars (this schema) | +| [xdm:eVar126](#xdmevar126) | `string` | Optional | eVars (this schema) | +| [xdm:eVar127](#xdmevar127) | `string` | Optional | eVars (this schema) | +| [xdm:eVar128](#xdmevar128) | `string` | Optional | eVars (this schema) | +| [xdm:eVar129](#xdmevar129) | `string` | Optional | eVars (this schema) | +| [xdm:eVar13](#xdmevar13) | `string` | Optional | eVars (this schema) | +| [xdm:eVar130](#xdmevar130) | `string` | Optional | eVars (this schema) | +| [xdm:eVar131](#xdmevar131) | `string` | Optional | eVars (this schema) | +| [xdm:eVar132](#xdmevar132) | `string` | Optional | eVars (this schema) | +| [xdm:eVar133](#xdmevar133) | `string` | Optional | eVars (this schema) | +| [xdm:eVar134](#xdmevar134) | `string` | Optional | eVars (this schema) | +| [xdm:eVar135](#xdmevar135) | `string` | Optional | eVars (this schema) | +| [xdm:eVar136](#xdmevar136) | `string` | Optional | eVars (this schema) | +| [xdm:eVar137](#xdmevar137) | `string` | Optional | eVars (this schema) | +| [xdm:eVar138](#xdmevar138) | `string` | Optional | eVars (this schema) | +| [xdm:eVar139](#xdmevar139) | `string` | Optional | eVars (this schema) | +| [xdm:eVar14](#xdmevar14) | `string` | Optional | eVars (this schema) | +| [xdm:eVar140](#xdmevar140) | `string` | Optional | eVars (this schema) | +| [xdm:eVar141](#xdmevar141) | `string` | Optional | eVars (this schema) | +| [xdm:eVar142](#xdmevar142) | `string` | Optional | eVars (this schema) | +| [xdm:eVar143](#xdmevar143) | `string` | Optional | eVars (this schema) | +| [xdm:eVar144](#xdmevar144) | `string` | Optional | eVars (this schema) | +| [xdm:eVar145](#xdmevar145) | `string` | Optional | eVars (this schema) | +| [xdm:eVar146](#xdmevar146) | `string` | Optional | eVars (this schema) | +| [xdm:eVar147](#xdmevar147) | `string` | Optional | eVars (this schema) | +| [xdm:eVar148](#xdmevar148) | `string` | Optional | eVars (this schema) | +| [xdm:eVar149](#xdmevar149) | `string` | Optional | eVars (this schema) | +| [xdm:eVar15](#xdmevar15) | `string` | Optional | eVars (this schema) | +| [xdm:eVar150](#xdmevar150) | `string` | Optional | eVars (this schema) | +| [xdm:eVar151](#xdmevar151) | `string` | Optional | eVars (this schema) | +| [xdm:eVar152](#xdmevar152) | `string` | Optional | eVars (this schema) | +| [xdm:eVar153](#xdmevar153) | `string` | Optional | eVars (this schema) | +| [xdm:eVar154](#xdmevar154) | `string` | Optional | eVars (this schema) | +| [xdm:eVar155](#xdmevar155) | `string` | Optional | eVars (this schema) | +| [xdm:eVar156](#xdmevar156) | `string` | Optional | eVars (this schema) | +| [xdm:eVar157](#xdmevar157) | `string` | Optional | eVars (this schema) | +| [xdm:eVar158](#xdmevar158) | `string` | Optional | eVars (this schema) | +| [xdm:eVar159](#xdmevar159) | `string` | Optional | eVars (this schema) | +| [xdm:eVar16](#xdmevar16) | `string` | Optional | eVars (this schema) | +| [xdm:eVar160](#xdmevar160) | `string` | Optional | eVars (this schema) | +| [xdm:eVar161](#xdmevar161) | `string` | Optional | eVars (this schema) | +| [xdm:eVar162](#xdmevar162) | `string` | Optional | eVars (this schema) | +| [xdm:eVar163](#xdmevar163) | `string` | Optional | eVars (this schema) | +| [xdm:eVar164](#xdmevar164) | `string` | Optional | eVars (this schema) | +| [xdm:eVar165](#xdmevar165) | `string` | Optional | eVars (this schema) | +| [xdm:eVar166](#xdmevar166) | `string` | Optional | eVars (this schema) | +| [xdm:eVar167](#xdmevar167) | `string` | Optional | eVars (this schema) | +| [xdm:eVar168](#xdmevar168) | `string` | Optional | eVars (this schema) | +| [xdm:eVar169](#xdmevar169) | `string` | Optional | eVars (this schema) | +| [xdm:eVar17](#xdmevar17) | `string` | Optional | eVars (this schema) | +| [xdm:eVar170](#xdmevar170) | `string` | Optional | eVars (this schema) | +| [xdm:eVar171](#xdmevar171) | `string` | Optional | eVars (this schema) | +| [xdm:eVar172](#xdmevar172) | `string` | Optional | eVars (this schema) | +| [xdm:eVar173](#xdmevar173) | `string` | Optional | eVars (this schema) | +| [xdm:eVar174](#xdmevar174) | `string` | Optional | eVars (this schema) | +| [xdm:eVar175](#xdmevar175) | `string` | Optional | eVars (this schema) | +| [xdm:eVar176](#xdmevar176) | `string` | Optional | eVars (this schema) | +| [xdm:eVar177](#xdmevar177) | `string` | Optional | eVars (this schema) | +| [xdm:eVar178](#xdmevar178) | `string` | Optional | eVars (this schema) | +| [xdm:eVar179](#xdmevar179) | `string` | Optional | eVars (this schema) | +| [xdm:eVar18](#xdmevar18) | `string` | Optional | eVars (this schema) | +| [xdm:eVar180](#xdmevar180) | `string` | Optional | eVars (this schema) | +| [xdm:eVar181](#xdmevar181) | `string` | Optional | eVars (this schema) | +| [xdm:eVar182](#xdmevar182) | `string` | Optional | eVars (this schema) | +| [xdm:eVar183](#xdmevar183) | `string` | Optional | eVars (this schema) | +| [xdm:eVar184](#xdmevar184) | `string` | Optional | eVars (this schema) | +| [xdm:eVar185](#xdmevar185) | `string` | Optional | eVars (this schema) | +| [xdm:eVar186](#xdmevar186) | `string` | Optional | eVars (this schema) | +| [xdm:eVar187](#xdmevar187) | `string` | Optional | eVars (this schema) | +| [xdm:eVar188](#xdmevar188) | `string` | Optional | eVars (this schema) | +| [xdm:eVar189](#xdmevar189) | `string` | Optional | eVars (this schema) | +| [xdm:eVar19](#xdmevar19) | `string` | Optional | eVars (this schema) | +| [xdm:eVar190](#xdmevar190) | `string` | Optional | eVars (this schema) | +| [xdm:eVar191](#xdmevar191) | `string` | Optional | eVars (this schema) | +| [xdm:eVar192](#xdmevar192) | `string` | Optional | eVars (this schema) | +| [xdm:eVar193](#xdmevar193) | `string` | Optional | eVars (this schema) | +| [xdm:eVar194](#xdmevar194) | `string` | Optional | eVars (this schema) | +| [xdm:eVar195](#xdmevar195) | `string` | Optional | eVars (this schema) | +| [xdm:eVar196](#xdmevar196) | `string` | Optional | eVars (this schema) | +| [xdm:eVar197](#xdmevar197) | `string` | Optional | eVars (this schema) | +| [xdm:eVar198](#xdmevar198) | `string` | Optional | eVars (this schema) | +| [xdm:eVar199](#xdmevar199) | `string` | Optional | eVars (this schema) | +| [xdm:eVar2](#xdmevar2) | `string` | Optional | eVars (this schema) | +| [xdm:eVar20](#xdmevar20) | `string` | Optional | eVars (this schema) | +| [xdm:eVar200](#xdmevar200) | `string` | Optional | eVars (this schema) | +| [xdm:eVar201](#xdmevar201) | `string` | Optional | eVars (this schema) | +| [xdm:eVar202](#xdmevar202) | `string` | Optional | eVars (this schema) | +| [xdm:eVar203](#xdmevar203) | `string` | Optional | eVars (this schema) | +| [xdm:eVar204](#xdmevar204) | `string` | Optional | eVars (this schema) | +| [xdm:eVar205](#xdmevar205) | `string` | Optional | eVars (this schema) | +| [xdm:eVar206](#xdmevar206) | `string` | Optional | eVars (this schema) | +| [xdm:eVar207](#xdmevar207) | `string` | Optional | eVars (this schema) | +| [xdm:eVar208](#xdmevar208) | `string` | Optional | eVars (this schema) | +| [xdm:eVar209](#xdmevar209) | `string` | Optional | eVars (this schema) | +| [xdm:eVar21](#xdmevar21) | `string` | Optional | eVars (this schema) | +| [xdm:eVar210](#xdmevar210) | `string` | Optional | eVars (this schema) | +| [xdm:eVar211](#xdmevar211) | `string` | Optional | eVars (this schema) | +| [xdm:eVar212](#xdmevar212) | `string` | Optional | eVars (this schema) | +| [xdm:eVar213](#xdmevar213) | `string` | Optional | eVars (this schema) | +| [xdm:eVar214](#xdmevar214) | `string` | Optional | eVars (this schema) | +| [xdm:eVar215](#xdmevar215) | `string` | Optional | eVars (this schema) | +| [xdm:eVar216](#xdmevar216) | `string` | Optional | eVars (this schema) | +| [xdm:eVar217](#xdmevar217) | `string` | Optional | eVars (this schema) | +| [xdm:eVar218](#xdmevar218) | `string` | Optional | eVars (this schema) | +| [xdm:eVar219](#xdmevar219) | `string` | Optional | eVars (this schema) | +| [xdm:eVar22](#xdmevar22) | `string` | Optional | eVars (this schema) | +| [xdm:eVar220](#xdmevar220) | `string` | Optional | eVars (this schema) | +| [xdm:eVar221](#xdmevar221) | `string` | Optional | eVars (this schema) | +| [xdm:eVar222](#xdmevar222) | `string` | Optional | eVars (this schema) | +| [xdm:eVar223](#xdmevar223) | `string` | Optional | eVars (this schema) | +| [xdm:eVar224](#xdmevar224) | `string` | Optional | eVars (this schema) | +| [xdm:eVar225](#xdmevar225) | `string` | Optional | eVars (this schema) | +| [xdm:eVar226](#xdmevar226) | `string` | Optional | eVars (this schema) | +| [xdm:eVar227](#xdmevar227) | `string` | Optional | eVars (this schema) | +| [xdm:eVar228](#xdmevar228) | `string` | Optional | eVars (this schema) | +| [xdm:eVar229](#xdmevar229) | `string` | Optional | eVars (this schema) | +| [xdm:eVar23](#xdmevar23) | `string` | Optional | eVars (this schema) | +| [xdm:eVar230](#xdmevar230) | `string` | Optional | eVars (this schema) | +| [xdm:eVar231](#xdmevar231) | `string` | Optional | eVars (this schema) | +| [xdm:eVar232](#xdmevar232) | `string` | Optional | eVars (this schema) | +| [xdm:eVar233](#xdmevar233) | `string` | Optional | eVars (this schema) | +| [xdm:eVar234](#xdmevar234) | `string` | Optional | eVars (this schema) | +| [xdm:eVar235](#xdmevar235) | `string` | Optional | eVars (this schema) | +| [xdm:eVar236](#xdmevar236) | `string` | Optional | eVars (this schema) | +| [xdm:eVar237](#xdmevar237) | `string` | Optional | eVars (this schema) | +| [xdm:eVar238](#xdmevar238) | `string` | Optional | eVars (this schema) | +| [xdm:eVar239](#xdmevar239) | `string` | Optional | eVars (this schema) | +| [xdm:eVar24](#xdmevar24) | `string` | Optional | eVars (this schema) | +| [xdm:eVar240](#xdmevar240) | `string` | Optional | eVars (this schema) | +| [xdm:eVar241](#xdmevar241) | `string` | Optional | eVars (this schema) | +| [xdm:eVar242](#xdmevar242) | `string` | Optional | eVars (this schema) | +| [xdm:eVar243](#xdmevar243) | `string` | Optional | eVars (this schema) | +| [xdm:eVar244](#xdmevar244) | `string` | Optional | eVars (this schema) | +| [xdm:eVar245](#xdmevar245) | `string` | Optional | eVars (this schema) | +| [xdm:eVar246](#xdmevar246) | `string` | Optional | eVars (this schema) | +| [xdm:eVar247](#xdmevar247) | `string` | Optional | eVars (this schema) | +| [xdm:eVar248](#xdmevar248) | `string` | Optional | eVars (this schema) | +| [xdm:eVar249](#xdmevar249) | `string` | Optional | eVars (this schema) | +| [xdm:eVar25](#xdmevar25) | `string` | Optional | eVars (this schema) | +| [xdm:eVar250](#xdmevar250) | `string` | Optional | eVars (this schema) | +| [xdm:eVar26](#xdmevar26) | `string` | Optional | eVars (this schema) | +| [xdm:eVar27](#xdmevar27) | `string` | Optional | eVars (this schema) | +| [xdm:eVar28](#xdmevar28) | `string` | Optional | eVars (this schema) | +| [xdm:eVar29](#xdmevar29) | `string` | Optional | eVars (this schema) | +| [xdm:eVar3](#xdmevar3) | `string` | Optional | eVars (this schema) | +| [xdm:eVar30](#xdmevar30) | `string` | Optional | eVars (this schema) | +| [xdm:eVar31](#xdmevar31) | `string` | Optional | eVars (this schema) | +| [xdm:eVar32](#xdmevar32) | `string` | Optional | eVars (this schema) | +| [xdm:eVar33](#xdmevar33) | `string` | Optional | eVars (this schema) | +| [xdm:eVar34](#xdmevar34) | `string` | Optional | eVars (this schema) | +| [xdm:eVar35](#xdmevar35) | `string` | Optional | eVars (this schema) | +| [xdm:eVar36](#xdmevar36) | `string` | Optional | eVars (this schema) | +| [xdm:eVar37](#xdmevar37) | `string` | Optional | eVars (this schema) | +| [xdm:eVar38](#xdmevar38) | `string` | Optional | eVars (this schema) | +| [xdm:eVar39](#xdmevar39) | `string` | Optional | eVars (this schema) | +| [xdm:eVar4](#xdmevar4) | `string` | Optional | eVars (this schema) | +| [xdm:eVar40](#xdmevar40) | `string` | Optional | eVars (this schema) | +| [xdm:eVar41](#xdmevar41) | `string` | Optional | eVars (this schema) | +| [xdm:eVar42](#xdmevar42) | `string` | Optional | eVars (this schema) | +| [xdm:eVar43](#xdmevar43) | `string` | Optional | eVars (this schema) | +| [xdm:eVar44](#xdmevar44) | `string` | Optional | eVars (this schema) | +| [xdm:eVar45](#xdmevar45) | `string` | Optional | eVars (this schema) | +| [xdm:eVar46](#xdmevar46) | `string` | Optional | eVars (this schema) | +| [xdm:eVar47](#xdmevar47) | `string` | Optional | eVars (this schema) | +| [xdm:eVar48](#xdmevar48) | `string` | Optional | eVars (this schema) | +| [xdm:eVar49](#xdmevar49) | `string` | Optional | eVars (this schema) | +| [xdm:eVar5](#xdmevar5) | `string` | Optional | eVars (this schema) | +| [xdm:eVar50](#xdmevar50) | `string` | Optional | eVars (this schema) | +| [xdm:eVar51](#xdmevar51) | `string` | Optional | eVars (this schema) | +| [xdm:eVar52](#xdmevar52) | `string` | Optional | eVars (this schema) | +| [xdm:eVar53](#xdmevar53) | `string` | Optional | eVars (this schema) | +| [xdm:eVar54](#xdmevar54) | `string` | Optional | eVars (this schema) | +| [xdm:eVar55](#xdmevar55) | `string` | Optional | eVars (this schema) | +| [xdm:eVar56](#xdmevar56) | `string` | Optional | eVars (this schema) | +| [xdm:eVar57](#xdmevar57) | `string` | Optional | eVars (this schema) | +| [xdm:eVar58](#xdmevar58) | `string` | Optional | eVars (this schema) | +| [xdm:eVar59](#xdmevar59) | `string` | Optional | eVars (this schema) | +| [xdm:eVar6](#xdmevar6) | `string` | Optional | eVars (this schema) | +| [xdm:eVar60](#xdmevar60) | `string` | Optional | eVars (this schema) | +| [xdm:eVar61](#xdmevar61) | `string` | Optional | eVars (this schema) | +| [xdm:eVar62](#xdmevar62) | `string` | Optional | eVars (this schema) | +| [xdm:eVar63](#xdmevar63) | `string` | Optional | eVars (this schema) | +| [xdm:eVar64](#xdmevar64) | `string` | Optional | eVars (this schema) | +| [xdm:eVar65](#xdmevar65) | `string` | Optional | eVars (this schema) | +| [xdm:eVar66](#xdmevar66) | `string` | Optional | eVars (this schema) | +| [xdm:eVar67](#xdmevar67) | `string` | Optional | eVars (this schema) | +| [xdm:eVar68](#xdmevar68) | `string` | Optional | eVars (this schema) | +| [xdm:eVar69](#xdmevar69) | `string` | Optional | eVars (this schema) | +| [xdm:eVar7](#xdmevar7) | `string` | Optional | eVars (this schema) | +| [xdm:eVar70](#xdmevar70) | `string` | Optional | eVars (this schema) | +| [xdm:eVar71](#xdmevar71) | `string` | Optional | eVars (this schema) | +| [xdm:eVar72](#xdmevar72) | `string` | Optional | eVars (this schema) | +| [xdm:eVar73](#xdmevar73) | `string` | Optional | eVars (this schema) | +| [xdm:eVar74](#xdmevar74) | `string` | Optional | eVars (this schema) | +| [xdm:eVar75](#xdmevar75) | `string` | Optional | eVars (this schema) | +| [xdm:eVar76](#xdmevar76) | `string` | Optional | eVars (this schema) | +| [xdm:eVar77](#xdmevar77) | `string` | Optional | eVars (this schema) | +| [xdm:eVar78](#xdmevar78) | `string` | Optional | eVars (this schema) | +| [xdm:eVar79](#xdmevar79) | `string` | Optional | eVars (this schema) | +| [xdm:eVar8](#xdmevar8) | `string` | Optional | eVars (this schema) | +| [xdm:eVar80](#xdmevar80) | `string` | Optional | eVars (this schema) | +| [xdm:eVar81](#xdmevar81) | `string` | Optional | eVars (this schema) | +| [xdm:eVar82](#xdmevar82) | `string` | Optional | eVars (this schema) | +| [xdm:eVar83](#xdmevar83) | `string` | Optional | eVars (this schema) | +| [xdm:eVar84](#xdmevar84) | `string` | Optional | eVars (this schema) | +| [xdm:eVar85](#xdmevar85) | `string` | Optional | eVars (this schema) | +| [xdm:eVar86](#xdmevar86) | `string` | Optional | eVars (this schema) | +| [xdm:eVar87](#xdmevar87) | `string` | Optional | eVars (this schema) | +| [xdm:eVar88](#xdmevar88) | `string` | Optional | eVars (this schema) | +| [xdm:eVar89](#xdmevar89) | `string` | Optional | eVars (this schema) | +| [xdm:eVar9](#xdmevar9) | `string` | Optional | eVars (this schema) | +| [xdm:eVar90](#xdmevar90) | `string` | Optional | eVars (this schema) | +| [xdm:eVar91](#xdmevar91) | `string` | Optional | eVars (this schema) | +| [xdm:eVar92](#xdmevar92) | `string` | Optional | eVars (this schema) | +| [xdm:eVar93](#xdmevar93) | `string` | Optional | eVars (this schema) | +| [xdm:eVar94](#xdmevar94) | `string` | Optional | eVars (this schema) | +| [xdm:eVar95](#xdmevar95) | `string` | Optional | eVars (this schema) | +| [xdm:eVar96](#xdmevar96) | `string` | Optional | eVars (this schema) | +| [xdm:eVar97](#xdmevar97) | `string` | Optional | eVars (this schema) | +| [xdm:eVar98](#xdmevar98) | `string` | Optional | eVars (this schema) | +| [xdm:eVar99](#xdmevar99) | `string` | Optional | eVars (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:eVar1 +### eVar1 + +Custom conversion variable 1. + +`xdm:eVar1` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar1 Type + + +`string` + + + + + + +## xdm:eVar10 +### eVar10 + +Custom conversion variable 10. + +`xdm:eVar10` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar10 Type + + +`string` + + + + + + +## xdm:eVar100 +### eVar100 + +Custom conversion variable 100. + +`xdm:eVar100` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar100 Type + + +`string` + + + + + + +## xdm:eVar101 +### eVar101 + +Custom conversion variable 101. + +`xdm:eVar101` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar101 Type + + +`string` + + + + + + +## xdm:eVar102 +### eVar102 + +Custom conversion variable 102. + +`xdm:eVar102` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar102 Type + + +`string` + + + + + + +## xdm:eVar103 +### eVar103 + +Custom conversion variable 103. + +`xdm:eVar103` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar103 Type + + +`string` + + + + + + +## xdm:eVar104 +### eVar104 + +Custom conversion variable 104. + +`xdm:eVar104` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar104 Type + + +`string` + + + + + + +## xdm:eVar105 +### eVar105 + +Custom conversion variable 105. + +`xdm:eVar105` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar105 Type + + +`string` + + + + + + +## xdm:eVar106 +### eVar106 + +Custom conversion variable 106. + +`xdm:eVar106` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar106 Type + + +`string` + + + + + + +## xdm:eVar107 +### eVar107 + +Custom conversion variable 107. + +`xdm:eVar107` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar107 Type + + +`string` + + + + + + +## xdm:eVar108 +### eVar108 + +Custom conversion variable 108. + +`xdm:eVar108` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar108 Type + + +`string` + + + + + + +## xdm:eVar109 +### eVar109 + +Custom conversion variable 109. + +`xdm:eVar109` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar109 Type + + +`string` + + + + + + +## xdm:eVar11 +### eVar11 + +Custom conversion variable 11. + +`xdm:eVar11` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar11 Type + + +`string` + + + + + + +## xdm:eVar110 +### eVar110 + +Custom conversion variable 110. + +`xdm:eVar110` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar110 Type + + +`string` + + + + + + +## xdm:eVar111 +### eVar111 + +Custom conversion variable 111. + +`xdm:eVar111` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar111 Type + + +`string` + + + + + + +## xdm:eVar112 +### eVar112 + +Custom conversion variable 112. + +`xdm:eVar112` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar112 Type + + +`string` + + + + + + +## xdm:eVar113 +### eVar113 + +Custom conversion variable 113. + +`xdm:eVar113` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar113 Type + + +`string` + + + + + + +## xdm:eVar114 +### eVar114 + +Custom conversion variable 114. + +`xdm:eVar114` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar114 Type + + +`string` + + + + + + +## xdm:eVar115 +### eVar115 + +Custom conversion variable 115. + +`xdm:eVar115` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar115 Type + + +`string` + + + + + + +## xdm:eVar116 +### eVar116 + +Custom conversion variable 116. + +`xdm:eVar116` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar116 Type + + +`string` + + + + + + +## xdm:eVar117 +### eVar117 + +Custom conversion variable 117. + +`xdm:eVar117` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar117 Type + + +`string` + + + + + + +## xdm:eVar118 +### eVar118 + +Custom conversion variable 118. + +`xdm:eVar118` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar118 Type + + +`string` + + + + + + +## xdm:eVar119 +### eVar119 + +Custom conversion variable 119. + +`xdm:eVar119` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar119 Type + + +`string` + + + + + + +## xdm:eVar12 +### eVar12 + +Custom conversion variable 12. + +`xdm:eVar12` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar12 Type + + +`string` + + + + + + +## xdm:eVar120 +### eVar120 + +Custom conversion variable 120. + +`xdm:eVar120` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar120 Type + + +`string` + + + + + + +## xdm:eVar121 +### eVar121 + +Custom conversion variable 121. + +`xdm:eVar121` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar121 Type + + +`string` + + + + + + +## xdm:eVar122 +### eVar122 + +Custom conversion variable 122. + +`xdm:eVar122` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar122 Type + + +`string` + + + + + + +## xdm:eVar123 +### eVar123 + +Custom conversion variable 123. + +`xdm:eVar123` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar123 Type + + +`string` + + + + + + +## xdm:eVar124 +### eVar124 + +Custom conversion variable 124. + +`xdm:eVar124` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar124 Type + + +`string` + + + + + + +## xdm:eVar125 +### eVar125 + +Custom conversion variable 125. + +`xdm:eVar125` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar125 Type + + +`string` + + + + + + +## xdm:eVar126 +### eVar126 + +Custom conversion variable 126. + +`xdm:eVar126` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar126 Type + + +`string` + + + + + + +## xdm:eVar127 +### eVar127 + +Custom conversion variable 127. + +`xdm:eVar127` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar127 Type + + +`string` + + + + + + +## xdm:eVar128 +### eVar128 + +Custom conversion variable 128. + +`xdm:eVar128` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar128 Type + + +`string` + + + + + + +## xdm:eVar129 +### eVar129 + +Custom conversion variable 129. + +`xdm:eVar129` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar129 Type + + +`string` + + + + + + +## xdm:eVar13 +### eVar13 + +Custom conversion variable 13. + +`xdm:eVar13` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar13 Type + + +`string` + + + + + + +## xdm:eVar130 +### eVar130 + +Custom conversion variable 130. + +`xdm:eVar130` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar130 Type + + +`string` + + + + + + +## xdm:eVar131 +### eVar131 + +Custom conversion variable 131. + +`xdm:eVar131` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar131 Type + + +`string` + + + + + + +## xdm:eVar132 +### eVar132 + +Custom conversion variable 132. + +`xdm:eVar132` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar132 Type + + +`string` + + + + + + +## xdm:eVar133 +### eVar133 + +Custom conversion variable 133. + +`xdm:eVar133` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar133 Type + + +`string` + + + + + + +## xdm:eVar134 +### eVar134 + +Custom conversion variable 134. + +`xdm:eVar134` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar134 Type + + +`string` + + + + + + +## xdm:eVar135 +### eVar135 + +Custom conversion variable 135. + +`xdm:eVar135` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar135 Type + + +`string` + + + + + + +## xdm:eVar136 +### eVar136 + +Custom conversion variable 136. + +`xdm:eVar136` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar136 Type + + +`string` + + + + + + +## xdm:eVar137 +### eVar137 + +Custom conversion variable 137. + +`xdm:eVar137` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar137 Type + + +`string` + + + + + + +## xdm:eVar138 +### eVar138 + +Custom conversion variable 138. + +`xdm:eVar138` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar138 Type + + +`string` + + + + + + +## xdm:eVar139 +### eVar139 + +Custom conversion variable 139. + +`xdm:eVar139` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar139 Type + + +`string` + + + + + + +## xdm:eVar14 +### eVar14 + +Custom conversion variable 14. + +`xdm:eVar14` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar14 Type + + +`string` + + + + + + +## xdm:eVar140 +### eVar140 + +Custom conversion variable 140. + +`xdm:eVar140` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar140 Type + + +`string` + + + + + + +## xdm:eVar141 +### eVar141 + +Custom conversion variable 141. + +`xdm:eVar141` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar141 Type + + +`string` + + + + + + +## xdm:eVar142 +### eVar142 + +Custom conversion variable 142. + +`xdm:eVar142` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar142 Type + + +`string` + + + + + + +## xdm:eVar143 +### eVar143 + +Custom conversion variable 143. + +`xdm:eVar143` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar143 Type + + +`string` + + + + + + +## xdm:eVar144 +### eVar144 + +Custom conversion variable 144. + +`xdm:eVar144` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar144 Type + + +`string` + + + + + + +## xdm:eVar145 +### eVar145 + +Custom conversion variable 145. + +`xdm:eVar145` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar145 Type + + +`string` + + + + + + +## xdm:eVar146 +### eVar146 + +Custom conversion variable 146. + +`xdm:eVar146` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar146 Type + + +`string` + + + + + + +## xdm:eVar147 +### eVar147 + +Custom conversion variable 147. + +`xdm:eVar147` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar147 Type + + +`string` + + + + + + +## xdm:eVar148 +### eVar148 + +Custom conversion variable 148. + +`xdm:eVar148` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar148 Type + + +`string` + + + + + + +## xdm:eVar149 +### eVar149 + +Custom conversion variable 149. + +`xdm:eVar149` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar149 Type + + +`string` + + + + + + +## xdm:eVar15 +### eVar15 + +Custom conversion variable 15. + +`xdm:eVar15` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar15 Type + + +`string` + + + + + + +## xdm:eVar150 +### eVar150 + +Custom conversion variable 150. + +`xdm:eVar150` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar150 Type + + +`string` + + + + + + +## xdm:eVar151 +### eVar151 + +Custom conversion variable 151. + +`xdm:eVar151` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar151 Type + + +`string` + + + + + + +## xdm:eVar152 +### eVar152 + +Custom conversion variable 152. + +`xdm:eVar152` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar152 Type + + +`string` + + + + + + +## xdm:eVar153 +### eVar153 + +Custom conversion variable 153. + +`xdm:eVar153` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar153 Type + + +`string` + + + + + + +## xdm:eVar154 +### eVar154 + +Custom conversion variable 154. + +`xdm:eVar154` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar154 Type + + +`string` + + + + + + +## xdm:eVar155 +### eVar155 + +Custom conversion variable 155. + +`xdm:eVar155` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar155 Type + + +`string` + + + + + + +## xdm:eVar156 +### eVar156 + +Custom conversion variable 156. + +`xdm:eVar156` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar156 Type + + +`string` + + + + + + +## xdm:eVar157 +### eVar157 + +Custom conversion variable 157. + +`xdm:eVar157` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar157 Type + + +`string` + + + + + + +## xdm:eVar158 +### eVar158 + +Custom conversion variable 158. + +`xdm:eVar158` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar158 Type + + +`string` + + + + + + +## xdm:eVar159 +### eVar159 + +Custom conversion variable 159. + +`xdm:eVar159` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar159 Type + + +`string` + + + + + + +## xdm:eVar16 +### eVar16 + +Custom conversion variable 16. + +`xdm:eVar16` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar16 Type + + +`string` + + + + + + +## xdm:eVar160 +### eVar160 + +Custom conversion variable 160. + +`xdm:eVar160` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar160 Type + + +`string` + + + + + + +## xdm:eVar161 +### eVar161 + +Custom conversion variable 161. + +`xdm:eVar161` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar161 Type + + +`string` + + + + + + +## xdm:eVar162 +### eVar162 + +Custom conversion variable 162. + +`xdm:eVar162` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar162 Type + + +`string` + + + + + + +## xdm:eVar163 +### eVar163 + +Custom conversion variable 163. + +`xdm:eVar163` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar163 Type + + +`string` + + + + + + +## xdm:eVar164 +### eVar164 + +Custom conversion variable 164. + +`xdm:eVar164` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar164 Type + + +`string` + + + + + + +## xdm:eVar165 +### eVar165 + +Custom conversion variable 165. + +`xdm:eVar165` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar165 Type + + +`string` + + + + + + +## xdm:eVar166 +### eVar166 + +Custom conversion variable 166. + +`xdm:eVar166` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar166 Type + + +`string` + + + + + + +## xdm:eVar167 +### eVar167 + +Custom conversion variable 167. + +`xdm:eVar167` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar167 Type + + +`string` + + + + + + +## xdm:eVar168 +### eVar168 + +Custom conversion variable 168. + +`xdm:eVar168` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar168 Type + + +`string` + + + + + + +## xdm:eVar169 +### eVar169 + +Custom conversion variable 169. + +`xdm:eVar169` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar169 Type + + +`string` + + + + + + +## xdm:eVar17 +### eVar17 + +Custom conversion variable 17. + +`xdm:eVar17` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar17 Type + + +`string` + + + + + + +## xdm:eVar170 +### eVar170 + +Custom conversion variable 170. + +`xdm:eVar170` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar170 Type + + +`string` + + + + + + +## xdm:eVar171 +### eVar171 + +Custom conversion variable 171. + +`xdm:eVar171` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar171 Type + + +`string` + + + + + + +## xdm:eVar172 +### eVar172 + +Custom conversion variable 172. + +`xdm:eVar172` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar172 Type + + +`string` + + + + + + +## xdm:eVar173 +### eVar173 + +Custom conversion variable 173. + +`xdm:eVar173` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar173 Type + + +`string` + + + + + + +## xdm:eVar174 +### eVar174 + +Custom conversion variable 174. + +`xdm:eVar174` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar174 Type + + +`string` + + + + + + +## xdm:eVar175 +### eVar175 + +Custom conversion variable 175. + +`xdm:eVar175` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar175 Type + + +`string` + + + + + + +## xdm:eVar176 +### eVar176 + +Custom conversion variable 176. + +`xdm:eVar176` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar176 Type + + +`string` + + + + + + +## xdm:eVar177 +### eVar177 + +Custom conversion variable 177. + +`xdm:eVar177` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar177 Type + + +`string` + + + + + + +## xdm:eVar178 +### eVar178 + +Custom conversion variable 178. + +`xdm:eVar178` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar178 Type + + +`string` + + + + + + +## xdm:eVar179 +### eVar179 + +Custom conversion variable 179. + +`xdm:eVar179` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar179 Type + + +`string` + + + + + + +## xdm:eVar18 +### eVar18 + +Custom conversion variable 18. + +`xdm:eVar18` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar18 Type + + +`string` + + + + + + +## xdm:eVar180 +### eVar180 + +Custom conversion variable 180. + +`xdm:eVar180` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar180 Type + + +`string` + + + + + + +## xdm:eVar181 +### eVar181 + +Custom conversion variable 181. + +`xdm:eVar181` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar181 Type + + +`string` + + + + + + +## xdm:eVar182 +### eVar182 + +Custom conversion variable 182. + +`xdm:eVar182` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar182 Type + + +`string` + + + + + + +## xdm:eVar183 +### eVar183 + +Custom conversion variable 183. + +`xdm:eVar183` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar183 Type + + +`string` + + + + + + +## xdm:eVar184 +### eVar184 + +Custom conversion variable 184. + +`xdm:eVar184` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar184 Type + + +`string` + + + + + + +## xdm:eVar185 +### eVar185 + +Custom conversion variable 185. + +`xdm:eVar185` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar185 Type + + +`string` + + + + + + +## xdm:eVar186 +### eVar186 + +Custom conversion variable 186. + +`xdm:eVar186` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar186 Type + + +`string` + + + + + + +## xdm:eVar187 +### eVar187 + +Custom conversion variable 187. + +`xdm:eVar187` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar187 Type + + +`string` + + + + + + +## xdm:eVar188 +### eVar188 + +Custom conversion variable 188. + +`xdm:eVar188` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar188 Type + + +`string` + + + + + + +## xdm:eVar189 +### eVar189 + +Custom conversion variable 189. + +`xdm:eVar189` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar189 Type + + +`string` + + + + + + +## xdm:eVar19 +### eVar19 + +Custom conversion variable 19. + +`xdm:eVar19` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar19 Type + + +`string` + + + + + + +## xdm:eVar190 +### eVar190 + +Custom conversion variable 190. + +`xdm:eVar190` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar190 Type + + +`string` + + + + + + +## xdm:eVar191 +### eVar191 + +Custom conversion variable 191. + +`xdm:eVar191` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar191 Type + + +`string` + + + + + + +## xdm:eVar192 +### eVar192 + +Custom conversion variable 192. + +`xdm:eVar192` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar192 Type + + +`string` + + + + + + +## xdm:eVar193 +### eVar193 + +Custom conversion variable 193. + +`xdm:eVar193` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar193 Type + + +`string` + + + + + + +## xdm:eVar194 +### eVar194 + +Custom conversion variable 194. + +`xdm:eVar194` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar194 Type + + +`string` + + + + + + +## xdm:eVar195 +### eVar195 + +Custom conversion variable 195. + +`xdm:eVar195` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar195 Type + + +`string` + + + + + + +## xdm:eVar196 +### eVar196 + +Custom conversion variable 196. + +`xdm:eVar196` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar196 Type + + +`string` + + + + + + +## xdm:eVar197 +### eVar197 + +Custom conversion variable 197. + +`xdm:eVar197` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar197 Type + + +`string` + + + + + + +## xdm:eVar198 +### eVar198 + +Custom conversion variable 198. + +`xdm:eVar198` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar198 Type + + +`string` + + + + + + +## xdm:eVar199 +### eVar199 + +Custom conversion variable 199. + +`xdm:eVar199` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar199 Type + + +`string` + + + + + + +## xdm:eVar2 +### eVar2 + +Custom conversion variable 2. + +`xdm:eVar2` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar2 Type + + +`string` + + + + + + +## xdm:eVar20 +### eVar20 + +Custom conversion variable 20. + +`xdm:eVar20` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar20 Type + + +`string` + + + + + + +## xdm:eVar200 +### eVar200 + +Custom conversion variable 200. + +`xdm:eVar200` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar200 Type + + +`string` + + + + + + +## xdm:eVar201 +### eVar201 + +Custom conversion variable 201. + +`xdm:eVar201` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar201 Type + + +`string` + + + + + + +## xdm:eVar202 +### eVar202 + +Custom conversion variable 202. + +`xdm:eVar202` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar202 Type + + +`string` + + + + + + +## xdm:eVar203 +### eVar203 + +Custom conversion variable 203. + +`xdm:eVar203` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar203 Type + + +`string` + + + + + + +## xdm:eVar204 +### eVar204 + +Custom conversion variable 204. + +`xdm:eVar204` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar204 Type + + +`string` + + + + + + +## xdm:eVar205 +### eVar205 + +Custom conversion variable 205. + +`xdm:eVar205` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar205 Type + + +`string` + + + + + + +## xdm:eVar206 +### eVar206 + +Custom conversion variable 206. + +`xdm:eVar206` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar206 Type + + +`string` + + + + + + +## xdm:eVar207 +### eVar207 + +Custom conversion variable 207. + +`xdm:eVar207` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar207 Type + + +`string` + + + + + + +## xdm:eVar208 +### eVar208 + +Custom conversion variable 208. + +`xdm:eVar208` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar208 Type + + +`string` + + + + + + +## xdm:eVar209 +### eVar209 + +Custom conversion variable 209. + +`xdm:eVar209` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar209 Type + + +`string` + + + + + + +## xdm:eVar21 +### eVar21 + +Custom conversion variable 21. + +`xdm:eVar21` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar21 Type + + +`string` + + + + + + +## xdm:eVar210 +### eVar210 + +Custom conversion variable 210. + +`xdm:eVar210` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar210 Type + + +`string` + + + + + + +## xdm:eVar211 +### eVar211 + +Custom conversion variable 211. + +`xdm:eVar211` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar211 Type + + +`string` + + + + + + +## xdm:eVar212 +### eVar212 + +Custom conversion variable 212. + +`xdm:eVar212` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar212 Type + + +`string` + + + + + + +## xdm:eVar213 +### eVar213 + +Custom conversion variable 213. + +`xdm:eVar213` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar213 Type + + +`string` + + + + + + +## xdm:eVar214 +### eVar214 + +Custom conversion variable 214. + +`xdm:eVar214` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar214 Type + + +`string` + + + + + + +## xdm:eVar215 +### eVar215 + +Custom conversion variable 215. + +`xdm:eVar215` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar215 Type + + +`string` + + + + + + +## xdm:eVar216 +### eVar216 + +Custom conversion variable 216. + +`xdm:eVar216` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar216 Type + + +`string` + + + + + + +## xdm:eVar217 +### eVar217 + +Custom conversion variable 217. + +`xdm:eVar217` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar217 Type + + +`string` + + + + + + +## xdm:eVar218 +### eVar218 + +Custom conversion variable 218. + +`xdm:eVar218` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar218 Type + + +`string` + + + + + + +## xdm:eVar219 +### eVar219 + +Custom conversion variable 219. + +`xdm:eVar219` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar219 Type + + +`string` + + + + + + +## xdm:eVar22 +### eVar22 + +Custom conversion variable 22. + +`xdm:eVar22` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar22 Type + + +`string` + + + + + + +## xdm:eVar220 +### eVar220 + +Custom conversion variable 220. + +`xdm:eVar220` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar220 Type + + +`string` + + + + + + +## xdm:eVar221 +### eVar221 + +Custom conversion variable 221. + +`xdm:eVar221` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar221 Type + + +`string` + + + + + + +## xdm:eVar222 +### eVar222 + +Custom conversion variable 222. + +`xdm:eVar222` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar222 Type + + +`string` + + + + + + +## xdm:eVar223 +### eVar223 + +Custom conversion variable 223. + +`xdm:eVar223` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar223 Type + + +`string` + + + + + + +## xdm:eVar224 +### eVar224 + +Custom conversion variable 224. + +`xdm:eVar224` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar224 Type + + +`string` + + + + + + +## xdm:eVar225 +### eVar225 + +Custom conversion variable 225. + +`xdm:eVar225` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar225 Type + + +`string` + + + + + + +## xdm:eVar226 +### eVar226 + +Custom conversion variable 226. + +`xdm:eVar226` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar226 Type + + +`string` + + + + + + +## xdm:eVar227 +### eVar227 + +Custom conversion variable 227. + +`xdm:eVar227` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar227 Type + + +`string` + + + + + + +## xdm:eVar228 +### eVar228 + +Custom conversion variable 228. + +`xdm:eVar228` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar228 Type + + +`string` + + + + + + +## xdm:eVar229 +### eVar229 + +Custom conversion variable 229. + +`xdm:eVar229` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar229 Type + + +`string` + + + + + + +## xdm:eVar23 +### eVar23 + +Custom conversion variable 23. + +`xdm:eVar23` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar23 Type + + +`string` + + + + + + +## xdm:eVar230 +### eVar230 + +Custom conversion variable 230. + +`xdm:eVar230` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar230 Type + + +`string` + + + + + + +## xdm:eVar231 +### eVar231 + +Custom conversion variable 231. + +`xdm:eVar231` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar231 Type + + +`string` + + + + + + +## xdm:eVar232 +### eVar232 + +Custom conversion variable 232. + +`xdm:eVar232` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar232 Type + + +`string` + + + + + + +## xdm:eVar233 +### eVar233 + +Custom conversion variable 233. + +`xdm:eVar233` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar233 Type + + +`string` + + + + + + +## xdm:eVar234 +### eVar234 + +Custom conversion variable 234. + +`xdm:eVar234` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar234 Type + + +`string` + + + + + + +## xdm:eVar235 +### eVar235 + +Custom conversion variable 235. + +`xdm:eVar235` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar235 Type + + +`string` + + + + + + +## xdm:eVar236 +### eVar236 + +Custom conversion variable 236. + +`xdm:eVar236` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar236 Type + + +`string` + + + + + + +## xdm:eVar237 +### eVar237 + +Custom conversion variable 237. + +`xdm:eVar237` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar237 Type + + +`string` + + + + + + +## xdm:eVar238 +### eVar238 + +Custom conversion variable 238. + +`xdm:eVar238` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar238 Type + + +`string` + + + + + + +## xdm:eVar239 +### eVar239 + +Custom conversion variable 239. + +`xdm:eVar239` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar239 Type + + +`string` + + + + + + +## xdm:eVar24 +### eVar24 + +Custom conversion variable 24. + +`xdm:eVar24` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar24 Type + + +`string` + + + + + + +## xdm:eVar240 +### eVar240 + +Custom conversion variable 240. + +`xdm:eVar240` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar240 Type + + +`string` + + + + + + +## xdm:eVar241 +### eVar241 + +Custom conversion variable 241. + +`xdm:eVar241` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar241 Type + + +`string` + + + + + + +## xdm:eVar242 +### eVar242 + +Custom conversion variable 242. + +`xdm:eVar242` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar242 Type + + +`string` + + + + + + +## xdm:eVar243 +### eVar243 + +Custom conversion variable 243. + +`xdm:eVar243` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar243 Type + + +`string` + + + + + + +## xdm:eVar244 +### eVar244 + +Custom conversion variable 244. + +`xdm:eVar244` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar244 Type + + +`string` + + + + + + +## xdm:eVar245 +### eVar245 + +Custom conversion variable 245. + +`xdm:eVar245` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar245 Type + + +`string` + + + + + + +## xdm:eVar246 +### eVar246 + +Custom conversion variable 246. + +`xdm:eVar246` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar246 Type + + +`string` + + + + + + +## xdm:eVar247 +### eVar247 + +Custom conversion variable 247. + +`xdm:eVar247` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar247 Type + + +`string` + + + + + + +## xdm:eVar248 +### eVar248 + +Custom conversion variable 248. + +`xdm:eVar248` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar248 Type + + +`string` + + + + + + +## xdm:eVar249 +### eVar249 + +Custom conversion variable 249. + +`xdm:eVar249` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar249 Type + + +`string` + + + + + + +## xdm:eVar25 +### eVar25 + +Custom conversion variable 25. + +`xdm:eVar25` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar25 Type + + +`string` + + + + + + +## xdm:eVar250 +### eVar250 + +Custom conversion variable 250. + +`xdm:eVar250` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar250 Type + + +`string` + + + + + + +## xdm:eVar26 +### eVar26 + +Custom conversion variable 26. + +`xdm:eVar26` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar26 Type + + +`string` + + + + + + +## xdm:eVar27 +### eVar27 + +Custom conversion variable 27. + +`xdm:eVar27` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar27 Type + + +`string` + + + + + + +## xdm:eVar28 +### eVar28 + +Custom conversion variable 28. + +`xdm:eVar28` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar28 Type + + +`string` + + + + + + +## xdm:eVar29 +### eVar29 + +Custom conversion variable 29. + +`xdm:eVar29` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar29 Type + + +`string` + + + + + + +## xdm:eVar3 +### eVar3 + +Custom conversion variable 3. + +`xdm:eVar3` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar3 Type + + +`string` + + + + + + +## xdm:eVar30 +### eVar30 + +Custom conversion variable 30. + +`xdm:eVar30` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar30 Type + + +`string` + + + + + + +## xdm:eVar31 +### eVar31 + +Custom conversion variable 31. + +`xdm:eVar31` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar31 Type + + +`string` + + + + + + +## xdm:eVar32 +### eVar32 + +Custom conversion variable 32. + +`xdm:eVar32` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar32 Type + + +`string` + + + + + + +## xdm:eVar33 +### eVar33 + +Custom conversion variable 33. + +`xdm:eVar33` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar33 Type + + +`string` + + + + + + +## xdm:eVar34 +### eVar34 + +Custom conversion variable 34. + +`xdm:eVar34` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar34 Type + + +`string` + + + + + + +## xdm:eVar35 +### eVar35 + +Custom conversion variable 35. + +`xdm:eVar35` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar35 Type + + +`string` + + + + + + +## xdm:eVar36 +### eVar36 + +Custom conversion variable 36. + +`xdm:eVar36` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar36 Type + + +`string` + + + + + + +## xdm:eVar37 +### eVar37 + +Custom conversion variable 37. + +`xdm:eVar37` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar37 Type + + +`string` + + + + + + +## xdm:eVar38 +### eVar38 + +Custom conversion variable 38. + +`xdm:eVar38` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar38 Type + + +`string` + + + + + + +## xdm:eVar39 +### eVar39 + +Custom conversion variable 39. + +`xdm:eVar39` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar39 Type + + +`string` + + + + + + +## xdm:eVar4 +### eVar4 + +Custom conversion variable 4. + +`xdm:eVar4` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar4 Type + + +`string` + + + + + + +## xdm:eVar40 +### eVar40 + +Custom conversion variable 40. + +`xdm:eVar40` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar40 Type + + +`string` + + + + + + +## xdm:eVar41 +### eVar41 + +Custom conversion variable 41. + +`xdm:eVar41` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar41 Type + + +`string` + + + + + + +## xdm:eVar42 +### eVar42 + +Custom conversion variable 42. + +`xdm:eVar42` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar42 Type + + +`string` + + + + + + +## xdm:eVar43 +### eVar43 + +Custom conversion variable 43. + +`xdm:eVar43` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar43 Type + + +`string` + + + + + + +## xdm:eVar44 +### eVar44 + +Custom conversion variable 44. + +`xdm:eVar44` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar44 Type + + +`string` + + + + + + +## xdm:eVar45 +### eVar45 + +Custom conversion variable 45. + +`xdm:eVar45` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar45 Type + + +`string` + + + + + + +## xdm:eVar46 +### eVar46 + +Custom conversion variable 46. + +`xdm:eVar46` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar46 Type + + +`string` + + + + + + +## xdm:eVar47 +### eVar47 + +Custom conversion variable 47. + +`xdm:eVar47` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar47 Type + + +`string` + + + + + + +## xdm:eVar48 +### eVar48 + +Custom conversion variable 48. + +`xdm:eVar48` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar48 Type + + +`string` + + + + + + +## xdm:eVar49 +### eVar49 + +Custom conversion variable 49. + +`xdm:eVar49` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar49 Type + + +`string` + + + + + + +## xdm:eVar5 +### eVar5 + +Custom conversion variable 5. + +`xdm:eVar5` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar5 Type + + +`string` + + + + + + +## xdm:eVar50 +### eVar50 + +Custom conversion variable 50. + +`xdm:eVar50` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar50 Type + + +`string` + + + + + + +## xdm:eVar51 +### eVar51 + +Custom conversion variable 51. + +`xdm:eVar51` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar51 Type + + +`string` + + + + + + +## xdm:eVar52 +### eVar52 + +Custom conversion variable 52. + +`xdm:eVar52` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar52 Type + + +`string` + + + + + + +## xdm:eVar53 +### eVar53 + +Custom conversion variable 53. + +`xdm:eVar53` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar53 Type + + +`string` + + + + + + +## xdm:eVar54 +### eVar54 + +Custom conversion variable 54. + +`xdm:eVar54` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar54 Type + + +`string` + + + + + + +## xdm:eVar55 +### eVar55 + +Custom conversion variable 55. + +`xdm:eVar55` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar55 Type + + +`string` + + + + + + +## xdm:eVar56 +### eVar56 + +Custom conversion variable 56. + +`xdm:eVar56` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar56 Type + + +`string` + + + + + + +## xdm:eVar57 +### eVar57 + +Custom conversion variable 57. + +`xdm:eVar57` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar57 Type + + +`string` + + + + + + +## xdm:eVar58 +### eVar58 + +Custom conversion variable 58. + +`xdm:eVar58` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar58 Type + + +`string` + + + + + + +## xdm:eVar59 +### eVar59 + +Custom conversion variable 59. + +`xdm:eVar59` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar59 Type + + +`string` + + + + + + +## xdm:eVar6 +### eVar6 + +Custom conversion variable 6. + +`xdm:eVar6` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar6 Type + + +`string` + + + + + + +## xdm:eVar60 +### eVar60 + +Custom conversion variable 60. + +`xdm:eVar60` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar60 Type + + +`string` + + + + + + +## xdm:eVar61 +### eVar61 + +Custom conversion variable 61. + +`xdm:eVar61` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar61 Type + + +`string` + + + + + + +## xdm:eVar62 +### eVar62 + +Custom conversion variable 62. + +`xdm:eVar62` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar62 Type + + +`string` + + + + + + +## xdm:eVar63 +### eVar63 + +Custom conversion variable 63. + +`xdm:eVar63` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar63 Type + + +`string` + + + + + + +## xdm:eVar64 +### eVar64 + +Custom conversion variable 64. + +`xdm:eVar64` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar64 Type + + +`string` + + + + + + +## xdm:eVar65 +### eVar65 + +Custom conversion variable 65. + +`xdm:eVar65` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar65 Type + + +`string` + + + + + + +## xdm:eVar66 +### eVar66 + +Custom conversion variable 66. + +`xdm:eVar66` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar66 Type + + +`string` + + + + + + +## xdm:eVar67 +### eVar67 + +Custom conversion variable 67. + +`xdm:eVar67` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar67 Type + + +`string` + + + + + + +## xdm:eVar68 +### eVar68 + +Custom conversion variable 68. + +`xdm:eVar68` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar68 Type + + +`string` + + + + + + +## xdm:eVar69 +### eVar69 + +Custom conversion variable 69. + +`xdm:eVar69` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar69 Type + + +`string` + + + + + + +## xdm:eVar7 +### eVar7 + +Custom conversion variable 7. + +`xdm:eVar7` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar7 Type + + +`string` + + + + + + +## xdm:eVar70 +### eVar70 + +Custom conversion variable 70. + +`xdm:eVar70` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar70 Type + + +`string` + + + + + + +## xdm:eVar71 +### eVar71 + +Custom conversion variable 71. + +`xdm:eVar71` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar71 Type + + +`string` + + + + + + +## xdm:eVar72 +### eVar72 + +Custom conversion variable 72. + +`xdm:eVar72` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar72 Type + + +`string` + + + + + + +## xdm:eVar73 +### eVar73 + +Custom conversion variable 73. + +`xdm:eVar73` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar73 Type + + +`string` + + + + + + +## xdm:eVar74 +### eVar74 + +Custom conversion variable 74. + +`xdm:eVar74` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar74 Type + + +`string` + + + + + + +## xdm:eVar75 +### eVar75 + +Custom conversion variable 75. + +`xdm:eVar75` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar75 Type + + +`string` + + + + + + +## xdm:eVar76 +### eVar76 + +Custom conversion variable 76. + +`xdm:eVar76` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar76 Type + + +`string` + + + + + + +## xdm:eVar77 +### eVar77 + +Custom conversion variable 77. + +`xdm:eVar77` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar77 Type + + +`string` + + + + + + +## xdm:eVar78 +### eVar78 + +Custom conversion variable 78. + +`xdm:eVar78` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar78 Type + + +`string` + + + + + + +## xdm:eVar79 +### eVar79 + +Custom conversion variable 79. + +`xdm:eVar79` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar79 Type + + +`string` + + + + + + +## xdm:eVar8 +### eVar8 + +Custom conversion variable 8. + +`xdm:eVar8` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar8 Type + + +`string` + + + + + + +## xdm:eVar80 +### eVar80 + +Custom conversion variable 80. + +`xdm:eVar80` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar80 Type + + +`string` + + + + + + +## xdm:eVar81 +### eVar81 + +Custom conversion variable 81. + +`xdm:eVar81` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar81 Type + + +`string` + + + + + + +## xdm:eVar82 +### eVar82 + +Custom conversion variable 82. + +`xdm:eVar82` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar82 Type + + +`string` + + + + + + +## xdm:eVar83 +### eVar83 + +Custom conversion variable 83. + +`xdm:eVar83` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar83 Type + + +`string` + + + + + + +## xdm:eVar84 +### eVar84 + +Custom conversion variable 84. + +`xdm:eVar84` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar84 Type + + +`string` + + + + + + +## xdm:eVar85 +### eVar85 + +Custom conversion variable 85. + +`xdm:eVar85` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar85 Type + + +`string` + + + + + + +## xdm:eVar86 +### eVar86 + +Custom conversion variable 86. + +`xdm:eVar86` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar86 Type + + +`string` + + + + + + +## xdm:eVar87 +### eVar87 + +Custom conversion variable 87. + +`xdm:eVar87` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar87 Type + + +`string` + + + + + + +## xdm:eVar88 +### eVar88 + +Custom conversion variable 88. + +`xdm:eVar88` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar88 Type + + +`string` + + + + + + +## xdm:eVar89 +### eVar89 + +Custom conversion variable 89. + +`xdm:eVar89` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar89 Type + + +`string` + + + + + + +## xdm:eVar9 +### eVar9 + +Custom conversion variable 9. + +`xdm:eVar9` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar9 Type + + +`string` + + + + + + +## xdm:eVar90 +### eVar90 + +Custom conversion variable 90. + +`xdm:eVar90` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar90 Type + + +`string` + + + + + + +## xdm:eVar91 +### eVar91 + +Custom conversion variable 91. + +`xdm:eVar91` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar91 Type + + +`string` + + + + + + +## xdm:eVar92 +### eVar92 + +Custom conversion variable 92. + +`xdm:eVar92` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar92 Type + + +`string` + + + + + + +## xdm:eVar93 +### eVar93 + +Custom conversion variable 93. + +`xdm:eVar93` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar93 Type + + +`string` + + + + + + +## xdm:eVar94 +### eVar94 + +Custom conversion variable 94. + +`xdm:eVar94` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar94 Type + + +`string` + + + + + + +## xdm:eVar95 +### eVar95 + +Custom conversion variable 95. + +`xdm:eVar95` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar95 Type + + +`string` + + + + + + +## xdm:eVar96 +### eVar96 + +Custom conversion variable 96. + +`xdm:eVar96` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar96 Type + + +`string` + + + + + + +## xdm:eVar97 +### eVar97 + +Custom conversion variable 97. + +`xdm:eVar97` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar97 Type + + +`string` + + + + + + +## xdm:eVar98 +### eVar98 + +Custom conversion variable 98. + +`xdm:eVar98` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar98 Type + + +`string` + + + + + + +## xdm:eVar99 +### eVar99 + +Custom conversion variable 99. + +`xdm:eVar99` +* is optional +* type: `string` +* defined in this schema + +### xdm:eVar99 Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/analytics/event101to200.schema.json b/docs/reference/adobe/experience/analytics/event101to200.schema.json new file mode 100644 index 000000000..465e5d01d --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event101to200.schema.json @@ -0,0 +1,504 @@ +{ + "xdm:event101": { + "title": "event101", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 101." + }, + "xdm:event102": { + "title": "event102", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 102." + }, + "xdm:event103": { + "title": "event103", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 103." + }, + "xdm:event104": { + "title": "event104", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 104." + }, + "xdm:event105": { + "title": "event105", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 105." + }, + "xdm:event106": { + "title": "event106", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 106." + }, + "xdm:event107": { + "title": "event107", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 107." + }, + "xdm:event108": { + "title": "event108", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 108." + }, + "xdm:event109": { + "title": "event109", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 109." + }, + "xdm:event110": { + "title": "event110", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 110." + }, + "xdm:event111": { + "title": "event111", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 111." + }, + "xdm:event112": { + "title": "event112", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 112." + }, + "xdm:event113": { + "title": "event113", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 113." + }, + "xdm:event114": { + "title": "event114", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 114." + }, + "xdm:event115": { + "title": "event115", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 115." + }, + "xdm:event116": { + "title": "event116", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 116." + }, + "xdm:event117": { + "title": "event117", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 117." + }, + "xdm:event118": { + "title": "event118", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 118." + }, + "xdm:event119": { + "title": "event119", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 119." + }, + "xdm:event120": { + "title": "event120", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 120." + }, + "xdm:event121": { + "title": "event121", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 121." + }, + "xdm:event122": { + "title": "event122", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 122." + }, + "xdm:event123": { + "title": "event123", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 123." + }, + "xdm:event124": { + "title": "event124", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 124." + }, + "xdm:event125": { + "title": "event125", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 125." + }, + "xdm:event126": { + "title": "event126", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 126." + }, + "xdm:event127": { + "title": "event127", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 127." + }, + "xdm:event128": { + "title": "event128", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 128." + }, + "xdm:event129": { + "title": "event129", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 129." + }, + "xdm:event130": { + "title": "event130", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 130." + }, + "xdm:event131": { + "title": "event131", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 131." + }, + "xdm:event132": { + "title": "event132", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 132." + }, + "xdm:event133": { + "title": "event133", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 133." + }, + "xdm:event134": { + "title": "event134", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 134." + }, + "xdm:event135": { + "title": "event135", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 135." + }, + "xdm:event136": { + "title": "event136", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 136." + }, + "xdm:event137": { + "title": "event137", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 137." + }, + "xdm:event138": { + "title": "event138", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 138." + }, + "xdm:event139": { + "title": "event139", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 139." + }, + "xdm:event140": { + "title": "event140", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 140." + }, + "xdm:event141": { + "title": "event141", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 141." + }, + "xdm:event142": { + "title": "event142", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 142." + }, + "xdm:event143": { + "title": "event143", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 143." + }, + "xdm:event144": { + "title": "event144", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 144." + }, + "xdm:event145": { + "title": "event145", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 145." + }, + "xdm:event146": { + "title": "event146", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 146." + }, + "xdm:event147": { + "title": "event147", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 147." + }, + "xdm:event148": { + "title": "event148", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 148." + }, + "xdm:event149": { + "title": "event149", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 149." + }, + "xdm:event150": { + "title": "event150", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 150." + }, + "xdm:event151": { + "title": "event151", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 151." + }, + "xdm:event152": { + "title": "event152", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 152." + }, + "xdm:event153": { + "title": "event153", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 153." + }, + "xdm:event154": { + "title": "event154", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 154." + }, + "xdm:event155": { + "title": "event155", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 155." + }, + "xdm:event156": { + "title": "event156", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 156." + }, + "xdm:event157": { + "title": "event157", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 157." + }, + "xdm:event158": { + "title": "event158", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 158." + }, + "xdm:event159": { + "title": "event159", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 159." + }, + "xdm:event160": { + "title": "event160", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 160." + }, + "xdm:event161": { + "title": "event161", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 161." + }, + "xdm:event162": { + "title": "event162", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 162." + }, + "xdm:event163": { + "title": "event163", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 163." + }, + "xdm:event164": { + "title": "event164", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 164." + }, + "xdm:event165": { + "title": "event165", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 165." + }, + "xdm:event166": { + "title": "event166", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 166." + }, + "xdm:event167": { + "title": "event167", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 167." + }, + "xdm:event168": { + "title": "event168", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 168." + }, + "xdm:event169": { + "title": "event169", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 169." + }, + "xdm:event170": { + "title": "event170", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 170." + }, + "xdm:event171": { + "title": "event171", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 171." + }, + "xdm:event172": { + "title": "event172", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 172." + }, + "xdm:event173": { + "title": "event173", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 173." + }, + "xdm:event174": { + "title": "event174", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 174." + }, + "xdm:event175": { + "title": "event175", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 175." + }, + "xdm:event176": { + "title": "event176", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 176." + }, + "xdm:event177": { + "title": "event177", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 177." + }, + "xdm:event178": { + "title": "event178", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 178." + }, + "xdm:event179": { + "title": "event179", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 179." + }, + "xdm:event180": { + "title": "event180", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 180." + }, + "xdm:event181": { + "title": "event181", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 181." + }, + "xdm:event182": { + "title": "event182", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 182." + }, + "xdm:event183": { + "title": "event183", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 183." + }, + "xdm:event184": { + "title": "event184", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 184." + }, + "xdm:event185": { + "title": "event185", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 185." + }, + "xdm:event186": { + "title": "event186", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 186." + }, + "xdm:event187": { + "title": "event187", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 187." + }, + "xdm:event188": { + "title": "event188", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 188." + }, + "xdm:event189": { + "title": "event189", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 189." + }, + "xdm:event190": { + "title": "event190", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 190." + }, + "xdm:event191": { + "title": "event191", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 191." + }, + "xdm:event192": { + "title": "event192", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 192." + }, + "xdm:event193": { + "title": "event193", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 193." + }, + "xdm:event194": { + "title": "event194", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 194." + }, + "xdm:event195": { + "title": "event195", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 195." + }, + "xdm:event196": { + "title": "event196", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 196." + }, + "xdm:event197": { + "title": "event197", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 197." + }, + "xdm:event198": { + "title": "event198", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 198." + }, + "xdm:event199": { + "title": "event199", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 199." + }, + "xdm:event200": { + "title": "event200", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 200." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/event101to200" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/event101to200.schema.md b/docs/reference/adobe/experience/analytics/event101to200.schema.md new file mode 100644 index 000000000..dfa511f2b --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event101to200.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/event101to200 +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/event101to200.schema.json](adobe/experience/analytics/event101to200.schema.json) | diff --git a/docs/reference/adobe/experience/analytics/event1to100.schema.json b/docs/reference/adobe/experience/analytics/event1to100.schema.json new file mode 100644 index 000000000..a8b2ebaed --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event1to100.schema.json @@ -0,0 +1,504 @@ +{ + "xdm:event1": { + "title": "event1", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 1." + }, + "xdm:event2": { + "title": "event2", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 2." + }, + "xdm:event3": { + "title": "event3", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 3." + }, + "xdm:event4": { + "title": "event4", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 4." + }, + "xdm:event5": { + "title": "event5", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 5." + }, + "xdm:event6": { + "title": "event6", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 6." + }, + "xdm:event7": { + "title": "event7", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 7." + }, + "xdm:event8": { + "title": "event8", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 8." + }, + "xdm:event9": { + "title": "event9", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 9." + }, + "xdm:event10": { + "title": "event10", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 10." + }, + "xdm:event11": { + "title": "event11", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 11." + }, + "xdm:event12": { + "title": "event12", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 12." + }, + "xdm:event13": { + "title": "event13", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 13." + }, + "xdm:event14": { + "title": "event14", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 14." + }, + "xdm:event15": { + "title": "event15", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 15." + }, + "xdm:event16": { + "title": "event16", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 16." + }, + "xdm:event17": { + "title": "event17", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 17." + }, + "xdm:event18": { + "title": "event18", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 18." + }, + "xdm:event19": { + "title": "event19", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 19." + }, + "xdm:event20": { + "title": "event20", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 20." + }, + "xdm:event21": { + "title": "event21", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 21." + }, + "xdm:event22": { + "title": "event22", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 22." + }, + "xdm:event23": { + "title": "event23", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 23." + }, + "xdm:event24": { + "title": "event24", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 24." + }, + "xdm:event25": { + "title": "event25", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 25." + }, + "xdm:event26": { + "title": "event26", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 26." + }, + "xdm:event27": { + "title": "event27", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 27." + }, + "xdm:event28": { + "title": "event28", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 28." + }, + "xdm:event29": { + "title": "event29", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 29." + }, + "xdm:event30": { + "title": "event30", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 30." + }, + "xdm:event31": { + "title": "event31", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 31." + }, + "xdm:event32": { + "title": "event32", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 32." + }, + "xdm:event33": { + "title": "event33", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 33." + }, + "xdm:event34": { + "title": "event34", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 34." + }, + "xdm:event35": { + "title": "event35", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 35." + }, + "xdm:event36": { + "title": "event36", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 36." + }, + "xdm:event37": { + "title": "event37", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 37." + }, + "xdm:event38": { + "title": "event38", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 38." + }, + "xdm:event39": { + "title": "event39", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 39." + }, + "xdm:event40": { + "title": "event40", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 40." + }, + "xdm:event41": { + "title": "event41", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 41." + }, + "xdm:event42": { + "title": "event42", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 42." + }, + "xdm:event43": { + "title": "event43", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 43." + }, + "xdm:event44": { + "title": "event44", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 44." + }, + "xdm:event45": { + "title": "event45", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 45." + }, + "xdm:event46": { + "title": "event46", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 46." + }, + "xdm:event47": { + "title": "event47", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 47." + }, + "xdm:event48": { + "title": "event48", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 48." + }, + "xdm:event49": { + "title": "event49", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 49." + }, + "xdm:event50": { + "title": "event50", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 50." + }, + "xdm:event51": { + "title": "event51", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 51." + }, + "xdm:event52": { + "title": "event52", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 52." + }, + "xdm:event53": { + "title": "event53", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 53." + }, + "xdm:event54": { + "title": "event54", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 54." + }, + "xdm:event55": { + "title": "event55", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 55." + }, + "xdm:event56": { + "title": "event56", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 56." + }, + "xdm:event57": { + "title": "event57", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 57." + }, + "xdm:event58": { + "title": "event58", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 58." + }, + "xdm:event59": { + "title": "event59", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 59." + }, + "xdm:event60": { + "title": "event60", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 60." + }, + "xdm:event61": { + "title": "event61", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 61." + }, + "xdm:event62": { + "title": "event62", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 62." + }, + "xdm:event63": { + "title": "event63", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 63." + }, + "xdm:event64": { + "title": "event64", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 64." + }, + "xdm:event65": { + "title": "event65", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 65." + }, + "xdm:event66": { + "title": "event66", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 66." + }, + "xdm:event67": { + "title": "event67", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 67." + }, + "xdm:event68": { + "title": "event68", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 68." + }, + "xdm:event69": { + "title": "event69", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 69." + }, + "xdm:event70": { + "title": "event70", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 70." + }, + "xdm:event71": { + "title": "event71", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 71." + }, + "xdm:event72": { + "title": "event72", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 72." + }, + "xdm:event73": { + "title": "event73", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 73." + }, + "xdm:event74": { + "title": "event74", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 74." + }, + "xdm:event75": { + "title": "event75", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 75." + }, + "xdm:event76": { + "title": "event76", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 76." + }, + "xdm:event77": { + "title": "event77", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 77." + }, + "xdm:event78": { + "title": "event78", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 78." + }, + "xdm:event79": { + "title": "event79", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 79." + }, + "xdm:event80": { + "title": "event80", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 80." + }, + "xdm:event81": { + "title": "event81", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 81." + }, + "xdm:event82": { + "title": "event82", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 82." + }, + "xdm:event83": { + "title": "event83", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 83." + }, + "xdm:event84": { + "title": "event84", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 84." + }, + "xdm:event85": { + "title": "event85", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 85." + }, + "xdm:event86": { + "title": "event86", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 86." + }, + "xdm:event87": { + "title": "event87", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 87." + }, + "xdm:event88": { + "title": "event88", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 88." + }, + "xdm:event89": { + "title": "event89", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 89." + }, + "xdm:event90": { + "title": "event90", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 90." + }, + "xdm:event91": { + "title": "event91", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 91." + }, + "xdm:event92": { + "title": "event92", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 92." + }, + "xdm:event93": { + "title": "event93", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 93." + }, + "xdm:event94": { + "title": "event94", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 94." + }, + "xdm:event95": { + "title": "event95", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 95." + }, + "xdm:event96": { + "title": "event96", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 96." + }, + "xdm:event97": { + "title": "event97", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 97." + }, + "xdm:event98": { + "title": "event98", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 98." + }, + "xdm:event99": { + "title": "event99", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 99." + }, + "xdm:event100": { + "title": "event100", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 100." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/event1to100" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/event1to100.schema.md b/docs/reference/adobe/experience/analytics/event1to100.schema.md new file mode 100644 index 000000000..bae3454ab --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event1to100.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/event1to100 +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/event1to100.schema.json](adobe/experience/analytics/event1to100.schema.json) | diff --git a/docs/reference/adobe/experience/analytics/event201to300.schema.json b/docs/reference/adobe/experience/analytics/event201to300.schema.json new file mode 100644 index 000000000..75f74ed2d --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event201to300.schema.json @@ -0,0 +1,504 @@ +{ + "xdm:event201": { + "title": "event201", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 201." + }, + "xdm:event202": { + "title": "event202", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 202." + }, + "xdm:event203": { + "title": "event203", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 203." + }, + "xdm:event204": { + "title": "event204", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 204." + }, + "xdm:event205": { + "title": "event205", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 205." + }, + "xdm:event206": { + "title": "event206", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 206." + }, + "xdm:event207": { + "title": "event207", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 207." + }, + "xdm:event208": { + "title": "event208", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 208." + }, + "xdm:event209": { + "title": "event209", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 209." + }, + "xdm:event210": { + "title": "event210", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 210." + }, + "xdm:event211": { + "title": "event211", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 211." + }, + "xdm:event212": { + "title": "event212", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 212." + }, + "xdm:event213": { + "title": "event213", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 213." + }, + "xdm:event214": { + "title": "event214", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 214." + }, + "xdm:event215": { + "title": "event215", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 215." + }, + "xdm:event216": { + "title": "event216", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 216." + }, + "xdm:event217": { + "title": "event217", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 217." + }, + "xdm:event218": { + "title": "event218", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 218." + }, + "xdm:event219": { + "title": "event219", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 219." + }, + "xdm:event220": { + "title": "event220", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 220." + }, + "xdm:event221": { + "title": "event221", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 221." + }, + "xdm:event222": { + "title": "event222", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 222." + }, + "xdm:event223": { + "title": "event223", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 223." + }, + "xdm:event224": { + "title": "event224", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 224." + }, + "xdm:event225": { + "title": "event225", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 225." + }, + "xdm:event226": { + "title": "event226", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 226." + }, + "xdm:event227": { + "title": "event227", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 227." + }, + "xdm:event228": { + "title": "event228", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 228." + }, + "xdm:event229": { + "title": "event229", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 229." + }, + "xdm:event230": { + "title": "event230", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 230." + }, + "xdm:event231": { + "title": "event231", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 231." + }, + "xdm:event232": { + "title": "event232", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 232." + }, + "xdm:event233": { + "title": "event233", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 233." + }, + "xdm:event234": { + "title": "event234", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 234." + }, + "xdm:event235": { + "title": "event235", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 235." + }, + "xdm:event236": { + "title": "event236", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 236." + }, + "xdm:event237": { + "title": "event237", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 237." + }, + "xdm:event238": { + "title": "event238", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 238." + }, + "xdm:event239": { + "title": "event239", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 239." + }, + "xdm:event240": { + "title": "event240", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 240." + }, + "xdm:event241": { + "title": "event241", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 241." + }, + "xdm:event242": { + "title": "event242", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 242." + }, + "xdm:event243": { + "title": "event243", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 243." + }, + "xdm:event244": { + "title": "event244", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 244." + }, + "xdm:event245": { + "title": "event245", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 245." + }, + "xdm:event246": { + "title": "event246", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 246." + }, + "xdm:event247": { + "title": "event247", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 247." + }, + "xdm:event248": { + "title": "event248", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 248." + }, + "xdm:event249": { + "title": "event249", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 249." + }, + "xdm:event250": { + "title": "event250", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 250." + }, + "xdm:event251": { + "title": "event251", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 251." + }, + "xdm:event252": { + "title": "event252", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 252." + }, + "xdm:event253": { + "title": "event253", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 253." + }, + "xdm:event254": { + "title": "event254", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 254." + }, + "xdm:event255": { + "title": "event255", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 255." + }, + "xdm:event256": { + "title": "event256", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 256." + }, + "xdm:event257": { + "title": "event257", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 257." + }, + "xdm:event258": { + "title": "event258", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 258." + }, + "xdm:event259": { + "title": "event259", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 259." + }, + "xdm:event260": { + "title": "event260", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 260." + }, + "xdm:event261": { + "title": "event261", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 261." + }, + "xdm:event262": { + "title": "event262", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 262." + }, + "xdm:event263": { + "title": "event263", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 263." + }, + "xdm:event264": { + "title": "event264", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 264." + }, + "xdm:event265": { + "title": "event265", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 265." + }, + "xdm:event266": { + "title": "event266", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 266." + }, + "xdm:event267": { + "title": "event267", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 267." + }, + "xdm:event268": { + "title": "event268", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 268." + }, + "xdm:event269": { + "title": "event269", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 269." + }, + "xdm:event270": { + "title": "event270", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 270." + }, + "xdm:event271": { + "title": "event271", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 271." + }, + "xdm:event272": { + "title": "event272", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 272." + }, + "xdm:event273": { + "title": "event273", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 273." + }, + "xdm:event274": { + "title": "event274", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 274." + }, + "xdm:event275": { + "title": "event275", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 275." + }, + "xdm:event276": { + "title": "event276", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 276." + }, + "xdm:event277": { + "title": "event277", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 277." + }, + "xdm:event278": { + "title": "event278", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 278." + }, + "xdm:event279": { + "title": "event279", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 279." + }, + "xdm:event280": { + "title": "event280", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 280." + }, + "xdm:event281": { + "title": "event281", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 281." + }, + "xdm:event282": { + "title": "event282", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 282." + }, + "xdm:event283": { + "title": "event283", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 283." + }, + "xdm:event284": { + "title": "event284", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 284." + }, + "xdm:event285": { + "title": "event285", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 285." + }, + "xdm:event286": { + "title": "event286", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 286." + }, + "xdm:event287": { + "title": "event287", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 287." + }, + "xdm:event288": { + "title": "event288", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 288." + }, + "xdm:event289": { + "title": "event289", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 289." + }, + "xdm:event290": { + "title": "event290", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 290." + }, + "xdm:event291": { + "title": "event291", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 291." + }, + "xdm:event292": { + "title": "event292", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 292." + }, + "xdm:event293": { + "title": "event293", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 293." + }, + "xdm:event294": { + "title": "event294", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 294." + }, + "xdm:event295": { + "title": "event295", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 295." + }, + "xdm:event296": { + "title": "event296", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 296." + }, + "xdm:event297": { + "title": "event297", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 297." + }, + "xdm:event298": { + "title": "event298", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 298." + }, + "xdm:event299": { + "title": "event299", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 299." + }, + "xdm:event300": { + "title": "event300", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 300." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/event201to300" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/event201to300.schema.md b/docs/reference/adobe/experience/analytics/event201to300.schema.md new file mode 100644 index 000000000..dd9ee25cc --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event201to300.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/event201to300 +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/event201to300.schema.json](adobe/experience/analytics/event201to300.schema.json) | diff --git a/docs/reference/adobe/experience/analytics/event301to400.schema.json b/docs/reference/adobe/experience/analytics/event301to400.schema.json new file mode 100644 index 000000000..4348744a8 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event301to400.schema.json @@ -0,0 +1,504 @@ +{ + "xdm:event301": { + "title": "event301", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 301." + }, + "xdm:event302": { + "title": "event302", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 302." + }, + "xdm:event303": { + "title": "event303", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 303." + }, + "xdm:event304": { + "title": "event304", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 304." + }, + "xdm:event305": { + "title": "event305", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 305." + }, + "xdm:event306": { + "title": "event306", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 306." + }, + "xdm:event307": { + "title": "event307", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 307." + }, + "xdm:event308": { + "title": "event308", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 308." + }, + "xdm:event309": { + "title": "event309", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 309." + }, + "xdm:event310": { + "title": "event310", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 310." + }, + "xdm:event311": { + "title": "event311", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 311." + }, + "xdm:event312": { + "title": "event312", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 312." + }, + "xdm:event313": { + "title": "event313", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 313." + }, + "xdm:event314": { + "title": "event314", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 314." + }, + "xdm:event315": { + "title": "event315", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 315." + }, + "xdm:event316": { + "title": "event316", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 316." + }, + "xdm:event317": { + "title": "event317", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 317." + }, + "xdm:event318": { + "title": "event318", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 318." + }, + "xdm:event319": { + "title": "event319", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 319." + }, + "xdm:event320": { + "title": "event320", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 320." + }, + "xdm:event321": { + "title": "event321", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 321." + }, + "xdm:event322": { + "title": "event322", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 322." + }, + "xdm:event323": { + "title": "event323", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 323." + }, + "xdm:event324": { + "title": "event324", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 324." + }, + "xdm:event325": { + "title": "event325", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 325." + }, + "xdm:event326": { + "title": "event326", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 326." + }, + "xdm:event327": { + "title": "event327", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 327." + }, + "xdm:event328": { + "title": "event328", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 328." + }, + "xdm:event329": { + "title": "event329", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 329." + }, + "xdm:event330": { + "title": "event330", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 330." + }, + "xdm:event331": { + "title": "event331", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 331." + }, + "xdm:event332": { + "title": "event332", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 332." + }, + "xdm:event333": { + "title": "event333", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 333." + }, + "xdm:event334": { + "title": "event334", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 334." + }, + "xdm:event335": { + "title": "event335", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 335." + }, + "xdm:event336": { + "title": "event336", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 336." + }, + "xdm:event337": { + "title": "event337", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 337." + }, + "xdm:event338": { + "title": "event338", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 338." + }, + "xdm:event339": { + "title": "event339", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 339." + }, + "xdm:event340": { + "title": "event340", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 340." + }, + "xdm:event341": { + "title": "event341", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 341." + }, + "xdm:event342": { + "title": "event342", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 342." + }, + "xdm:event343": { + "title": "event343", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 343." + }, + "xdm:event344": { + "title": "event344", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 344." + }, + "xdm:event345": { + "title": "event345", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 345." + }, + "xdm:event346": { + "title": "event346", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 346." + }, + "xdm:event347": { + "title": "event347", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 347." + }, + "xdm:event348": { + "title": "event348", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 348." + }, + "xdm:event349": { + "title": "event349", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 349." + }, + "xdm:event350": { + "title": "event350", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 350." + }, + "xdm:event351": { + "title": "event351", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 351." + }, + "xdm:event352": { + "title": "event352", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 352." + }, + "xdm:event353": { + "title": "event353", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 353." + }, + "xdm:event354": { + "title": "event354", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 354." + }, + "xdm:event355": { + "title": "event355", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 355." + }, + "xdm:event356": { + "title": "event356", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 356." + }, + "xdm:event357": { + "title": "event357", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 357." + }, + "xdm:event358": { + "title": "event358", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 358." + }, + "xdm:event359": { + "title": "event359", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 359." + }, + "xdm:event360": { + "title": "event360", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 360." + }, + "xdm:event361": { + "title": "event361", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 361." + }, + "xdm:event362": { + "title": "event362", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 362." + }, + "xdm:event363": { + "title": "event363", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 363." + }, + "xdm:event364": { + "title": "event364", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 364." + }, + "xdm:event365": { + "title": "event365", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 365." + }, + "xdm:event366": { + "title": "event366", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 366." + }, + "xdm:event367": { + "title": "event367", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 367." + }, + "xdm:event368": { + "title": "event368", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 368." + }, + "xdm:event369": { + "title": "event369", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 369." + }, + "xdm:event370": { + "title": "event370", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 370." + }, + "xdm:event371": { + "title": "event371", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 371." + }, + "xdm:event372": { + "title": "event372", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 372." + }, + "xdm:event373": { + "title": "event373", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 373." + }, + "xdm:event374": { + "title": "event374", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 374." + }, + "xdm:event375": { + "title": "event375", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 375." + }, + "xdm:event376": { + "title": "event376", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 376." + }, + "xdm:event377": { + "title": "event377", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 377." + }, + "xdm:event378": { + "title": "event378", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 378." + }, + "xdm:event379": { + "title": "event379", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 379." + }, + "xdm:event380": { + "title": "event380", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 380." + }, + "xdm:event381": { + "title": "event381", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 381." + }, + "xdm:event382": { + "title": "event382", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 382." + }, + "xdm:event383": { + "title": "event383", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 383." + }, + "xdm:event384": { + "title": "event384", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 384." + }, + "xdm:event385": { + "title": "event385", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 385." + }, + "xdm:event386": { + "title": "event386", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 386." + }, + "xdm:event387": { + "title": "event387", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 387." + }, + "xdm:event388": { + "title": "event388", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 388." + }, + "xdm:event389": { + "title": "event389", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 389." + }, + "xdm:event390": { + "title": "event390", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 390." + }, + "xdm:event391": { + "title": "event391", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 391." + }, + "xdm:event392": { + "title": "event392", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 392." + }, + "xdm:event393": { + "title": "event393", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 393." + }, + "xdm:event394": { + "title": "event394", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 394." + }, + "xdm:event395": { + "title": "event395", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 395." + }, + "xdm:event396": { + "title": "event396", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 396." + }, + "xdm:event397": { + "title": "event397", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 397." + }, + "xdm:event398": { + "title": "event398", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 398." + }, + "xdm:event399": { + "title": "event399", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 399." + }, + "xdm:event400": { + "title": "event400", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 400." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/event301to400" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/event301to400.schema.md b/docs/reference/adobe/experience/analytics/event301to400.schema.md new file mode 100644 index 000000000..2a495a34d --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event301to400.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/event301to400 +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/event301to400.schema.json](adobe/experience/analytics/event301to400.schema.json) | diff --git a/docs/reference/adobe/experience/analytics/event401to500.schema.json b/docs/reference/adobe/experience/analytics/event401to500.schema.json new file mode 100644 index 000000000..c286da512 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event401to500.schema.json @@ -0,0 +1,504 @@ +{ + "xdm:event401": { + "title": "event401", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 401." + }, + "xdm:event402": { + "title": "event402", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 402." + }, + "xdm:event403": { + "title": "event403", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 403." + }, + "xdm:event404": { + "title": "event404", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 404." + }, + "xdm:event405": { + "title": "event405", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 405." + }, + "xdm:event406": { + "title": "event406", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 406." + }, + "xdm:event407": { + "title": "event407", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 407." + }, + "xdm:event408": { + "title": "event408", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 408." + }, + "xdm:event409": { + "title": "event409", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 409." + }, + "xdm:event410": { + "title": "event410", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 410." + }, + "xdm:event411": { + "title": "event411", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 411." + }, + "xdm:event412": { + "title": "event412", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 412." + }, + "xdm:event413": { + "title": "event413", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 413." + }, + "xdm:event414": { + "title": "event414", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 414." + }, + "xdm:event415": { + "title": "event415", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 415." + }, + "xdm:event416": { + "title": "event416", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 416." + }, + "xdm:event417": { + "title": "event417", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 417." + }, + "xdm:event418": { + "title": "event418", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 418." + }, + "xdm:event419": { + "title": "event419", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 419." + }, + "xdm:event420": { + "title": "event420", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 420." + }, + "xdm:event421": { + "title": "event421", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 421." + }, + "xdm:event422": { + "title": "event422", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 422." + }, + "xdm:event423": { + "title": "event423", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 423." + }, + "xdm:event424": { + "title": "event424", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 424." + }, + "xdm:event425": { + "title": "event425", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 425." + }, + "xdm:event426": { + "title": "event426", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 426." + }, + "xdm:event427": { + "title": "event427", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 427." + }, + "xdm:event428": { + "title": "event428", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 428." + }, + "xdm:event429": { + "title": "event429", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 429." + }, + "xdm:event430": { + "title": "event430", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 430." + }, + "xdm:event431": { + "title": "event431", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 431." + }, + "xdm:event432": { + "title": "event432", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 432." + }, + "xdm:event433": { + "title": "event433", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 433." + }, + "xdm:event434": { + "title": "event434", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 434." + }, + "xdm:event435": { + "title": "event435", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 435." + }, + "xdm:event436": { + "title": "event436", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 436." + }, + "xdm:event437": { + "title": "event437", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 437." + }, + "xdm:event438": { + "title": "event438", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 438." + }, + "xdm:event439": { + "title": "event439", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 439." + }, + "xdm:event440": { + "title": "event440", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 440." + }, + "xdm:event441": { + "title": "event441", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 441." + }, + "xdm:event442": { + "title": "event442", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 442." + }, + "xdm:event443": { + "title": "event443", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 443." + }, + "xdm:event444": { + "title": "event444", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 444." + }, + "xdm:event445": { + "title": "event445", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 445." + }, + "xdm:event446": { + "title": "event446", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 446." + }, + "xdm:event447": { + "title": "event447", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 447." + }, + "xdm:event448": { + "title": "event448", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 448." + }, + "xdm:event449": { + "title": "event449", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 449." + }, + "xdm:event450": { + "title": "event450", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 450." + }, + "xdm:event451": { + "title": "event451", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 451." + }, + "xdm:event452": { + "title": "event452", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 452." + }, + "xdm:event453": { + "title": "event453", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 453." + }, + "xdm:event454": { + "title": "event454", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 454." + }, + "xdm:event455": { + "title": "event455", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 455." + }, + "xdm:event456": { + "title": "event456", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 456." + }, + "xdm:event457": { + "title": "event457", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 457." + }, + "xdm:event458": { + "title": "event458", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 458." + }, + "xdm:event459": { + "title": "event459", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 459." + }, + "xdm:event460": { + "title": "event460", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 460." + }, + "xdm:event461": { + "title": "event461", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 461." + }, + "xdm:event462": { + "title": "event462", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 462." + }, + "xdm:event463": { + "title": "event463", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 463." + }, + "xdm:event464": { + "title": "event464", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 464." + }, + "xdm:event465": { + "title": "event465", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 465." + }, + "xdm:event466": { + "title": "event466", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 466." + }, + "xdm:event467": { + "title": "event467", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 467." + }, + "xdm:event468": { + "title": "event468", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 468." + }, + "xdm:event469": { + "title": "event469", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 469." + }, + "xdm:event470": { + "title": "event470", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 470." + }, + "xdm:event471": { + "title": "event471", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 471." + }, + "xdm:event472": { + "title": "event472", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 472." + }, + "xdm:event473": { + "title": "event473", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 473." + }, + "xdm:event474": { + "title": "event474", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 474." + }, + "xdm:event475": { + "title": "event475", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 475." + }, + "xdm:event476": { + "title": "event476", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 476." + }, + "xdm:event477": { + "title": "event477", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 477." + }, + "xdm:event478": { + "title": "event478", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 478." + }, + "xdm:event479": { + "title": "event479", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 479." + }, + "xdm:event480": { + "title": "event480", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 480." + }, + "xdm:event481": { + "title": "event481", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 481." + }, + "xdm:event482": { + "title": "event482", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 482." + }, + "xdm:event483": { + "title": "event483", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 483." + }, + "xdm:event484": { + "title": "event484", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 484." + }, + "xdm:event485": { + "title": "event485", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 485." + }, + "xdm:event486": { + "title": "event486", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 486." + }, + "xdm:event487": { + "title": "event487", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 487." + }, + "xdm:event488": { + "title": "event488", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 488." + }, + "xdm:event489": { + "title": "event489", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 489." + }, + "xdm:event490": { + "title": "event490", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 490." + }, + "xdm:event491": { + "title": "event491", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 491." + }, + "xdm:event492": { + "title": "event492", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 492." + }, + "xdm:event493": { + "title": "event493", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 493." + }, + "xdm:event494": { + "title": "event494", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 494." + }, + "xdm:event495": { + "title": "event495", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 495." + }, + "xdm:event496": { + "title": "event496", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 496." + }, + "xdm:event497": { + "title": "event497", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 497." + }, + "xdm:event498": { + "title": "event498", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 498." + }, + "xdm:event499": { + "title": "event499", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 499." + }, + "xdm:event500": { + "title": "event500", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 500." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/event401to500" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/event401to500.schema.md b/docs/reference/adobe/experience/analytics/event401to500.schema.md new file mode 100644 index 000000000..a86f181e3 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event401to500.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/event401to500 +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/event401to500.schema.json](adobe/experience/analytics/event401to500.schema.json) | diff --git a/docs/reference/adobe/experience/analytics/event501to600.schema.json b/docs/reference/adobe/experience/analytics/event501to600.schema.json new file mode 100644 index 000000000..4d1ccfee4 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event501to600.schema.json @@ -0,0 +1,504 @@ +{ + "xdm:event501": { + "title": "event501", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 501." + }, + "xdm:event502": { + "title": "event502", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 502." + }, + "xdm:event503": { + "title": "event503", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 503." + }, + "xdm:event504": { + "title": "event504", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 504." + }, + "xdm:event505": { + "title": "event505", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 505." + }, + "xdm:event506": { + "title": "event506", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 506." + }, + "xdm:event507": { + "title": "event507", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 507." + }, + "xdm:event508": { + "title": "event508", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 508." + }, + "xdm:event509": { + "title": "event509", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 509." + }, + "xdm:event510": { + "title": "event510", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 510." + }, + "xdm:event511": { + "title": "event511", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 511." + }, + "xdm:event512": { + "title": "event512", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 512." + }, + "xdm:event513": { + "title": "event513", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 513." + }, + "xdm:event514": { + "title": "event514", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 514." + }, + "xdm:event515": { + "title": "event515", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 515." + }, + "xdm:event516": { + "title": "event516", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 516." + }, + "xdm:event517": { + "title": "event517", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 517." + }, + "xdm:event518": { + "title": "event518", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 518." + }, + "xdm:event519": { + "title": "event519", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 519." + }, + "xdm:event520": { + "title": "event520", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 520." + }, + "xdm:event521": { + "title": "event521", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 521." + }, + "xdm:event522": { + "title": "event522", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 522." + }, + "xdm:event523": { + "title": "event523", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 523." + }, + "xdm:event524": { + "title": "event524", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 524." + }, + "xdm:event525": { + "title": "event525", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 525." + }, + "xdm:event526": { + "title": "event526", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 526." + }, + "xdm:event527": { + "title": "event527", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 527." + }, + "xdm:event528": { + "title": "event528", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 528." + }, + "xdm:event529": { + "title": "event529", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 529." + }, + "xdm:event530": { + "title": "event530", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 530." + }, + "xdm:event531": { + "title": "event531", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 531." + }, + "xdm:event532": { + "title": "event532", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 532." + }, + "xdm:event533": { + "title": "event533", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 533." + }, + "xdm:event534": { + "title": "event534", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 534." + }, + "xdm:event535": { + "title": "event535", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 535." + }, + "xdm:event536": { + "title": "event536", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 536." + }, + "xdm:event537": { + "title": "event537", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 537." + }, + "xdm:event538": { + "title": "event538", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 538." + }, + "xdm:event539": { + "title": "event539", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 539." + }, + "xdm:event540": { + "title": "event540", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 540." + }, + "xdm:event541": { + "title": "event541", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 541." + }, + "xdm:event542": { + "title": "event542", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 542." + }, + "xdm:event543": { + "title": "event543", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 543." + }, + "xdm:event544": { + "title": "event544", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 544." + }, + "xdm:event545": { + "title": "event545", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 545." + }, + "xdm:event546": { + "title": "event546", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 546." + }, + "xdm:event547": { + "title": "event547", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 547." + }, + "xdm:event548": { + "title": "event548", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 548." + }, + "xdm:event549": { + "title": "event549", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 549." + }, + "xdm:event550": { + "title": "event550", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 550." + }, + "xdm:event551": { + "title": "event551", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 551." + }, + "xdm:event552": { + "title": "event552", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 552." + }, + "xdm:event553": { + "title": "event553", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 553." + }, + "xdm:event554": { + "title": "event554", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 554." + }, + "xdm:event555": { + "title": "event555", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 555." + }, + "xdm:event556": { + "title": "event556", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 556." + }, + "xdm:event557": { + "title": "event557", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 557." + }, + "xdm:event558": { + "title": "event558", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 558." + }, + "xdm:event559": { + "title": "event559", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 559." + }, + "xdm:event560": { + "title": "event560", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 560." + }, + "xdm:event561": { + "title": "event561", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 561." + }, + "xdm:event562": { + "title": "event562", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 562." + }, + "xdm:event563": { + "title": "event563", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 563." + }, + "xdm:event564": { + "title": "event564", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 564." + }, + "xdm:event565": { + "title": "event565", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 565." + }, + "xdm:event566": { + "title": "event566", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 566." + }, + "xdm:event567": { + "title": "event567", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 567." + }, + "xdm:event568": { + "title": "event568", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 568." + }, + "xdm:event569": { + "title": "event569", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 569." + }, + "xdm:event570": { + "title": "event570", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 570." + }, + "xdm:event571": { + "title": "event571", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 571." + }, + "xdm:event572": { + "title": "event572", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 572." + }, + "xdm:event573": { + "title": "event573", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 573." + }, + "xdm:event574": { + "title": "event574", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 574." + }, + "xdm:event575": { + "title": "event575", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 575." + }, + "xdm:event576": { + "title": "event576", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 576." + }, + "xdm:event577": { + "title": "event577", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 577." + }, + "xdm:event578": { + "title": "event578", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 578." + }, + "xdm:event579": { + "title": "event579", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 579." + }, + "xdm:event580": { + "title": "event580", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 580." + }, + "xdm:event581": { + "title": "event581", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 581." + }, + "xdm:event582": { + "title": "event582", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 582." + }, + "xdm:event583": { + "title": "event583", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 583." + }, + "xdm:event584": { + "title": "event584", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 584." + }, + "xdm:event585": { + "title": "event585", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 585." + }, + "xdm:event586": { + "title": "event586", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 586." + }, + "xdm:event587": { + "title": "event587", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 587." + }, + "xdm:event588": { + "title": "event588", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 588." + }, + "xdm:event589": { + "title": "event589", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 589." + }, + "xdm:event590": { + "title": "event590", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 590." + }, + "xdm:event591": { + "title": "event591", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 591." + }, + "xdm:event592": { + "title": "event592", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 592." + }, + "xdm:event593": { + "title": "event593", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 593." + }, + "xdm:event594": { + "title": "event594", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 594." + }, + "xdm:event595": { + "title": "event595", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 595." + }, + "xdm:event596": { + "title": "event596", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 596." + }, + "xdm:event597": { + "title": "event597", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 597." + }, + "xdm:event598": { + "title": "event598", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 598." + }, + "xdm:event599": { + "title": "event599", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 599." + }, + "xdm:event600": { + "title": "event600", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 600." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/event501to600" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/event501to600.schema.md b/docs/reference/adobe/experience/analytics/event501to600.schema.md new file mode 100644 index 000000000..ce06a7719 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event501to600.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/event501to600 +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/event501to600.schema.json](adobe/experience/analytics/event501to600.schema.json) | diff --git a/docs/reference/adobe/experience/analytics/event601to700.schema.json b/docs/reference/adobe/experience/analytics/event601to700.schema.json new file mode 100644 index 000000000..bb7cdf613 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event601to700.schema.json @@ -0,0 +1,504 @@ +{ + "xdm:event601": { + "title": "event601", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 601." + }, + "xdm:event602": { + "title": "event602", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 602." + }, + "xdm:event603": { + "title": "event603", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 603." + }, + "xdm:event604": { + "title": "event604", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 604." + }, + "xdm:event605": { + "title": "event605", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 605." + }, + "xdm:event606": { + "title": "event606", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 606." + }, + "xdm:event607": { + "title": "event607", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 607." + }, + "xdm:event608": { + "title": "event608", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 608." + }, + "xdm:event609": { + "title": "event609", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 609." + }, + "xdm:event610": { + "title": "event610", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 610." + }, + "xdm:event611": { + "title": "event611", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 611." + }, + "xdm:event612": { + "title": "event612", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 612." + }, + "xdm:event613": { + "title": "event613", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 613." + }, + "xdm:event614": { + "title": "event614", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 614." + }, + "xdm:event615": { + "title": "event615", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 615." + }, + "xdm:event616": { + "title": "event616", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 616." + }, + "xdm:event617": { + "title": "event617", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 617." + }, + "xdm:event618": { + "title": "event618", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 618." + }, + "xdm:event619": { + "title": "event619", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 619." + }, + "xdm:event620": { + "title": "event620", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 620." + }, + "xdm:event621": { + "title": "event621", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 621." + }, + "xdm:event622": { + "title": "event622", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 622." + }, + "xdm:event623": { + "title": "event623", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 623." + }, + "xdm:event624": { + "title": "event624", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 624." + }, + "xdm:event625": { + "title": "event625", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 625." + }, + "xdm:event626": { + "title": "event626", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 626." + }, + "xdm:event627": { + "title": "event627", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 627." + }, + "xdm:event628": { + "title": "event628", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 628." + }, + "xdm:event629": { + "title": "event629", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 629." + }, + "xdm:event630": { + "title": "event630", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 630." + }, + "xdm:event631": { + "title": "event631", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 631." + }, + "xdm:event632": { + "title": "event632", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 632." + }, + "xdm:event633": { + "title": "event633", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 633." + }, + "xdm:event634": { + "title": "event634", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 634." + }, + "xdm:event635": { + "title": "event635", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 635." + }, + "xdm:event636": { + "title": "event636", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 636." + }, + "xdm:event637": { + "title": "event637", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 637." + }, + "xdm:event638": { + "title": "event638", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 638." + }, + "xdm:event639": { + "title": "event639", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 639." + }, + "xdm:event640": { + "title": "event640", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 640." + }, + "xdm:event641": { + "title": "event641", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 641." + }, + "xdm:event642": { + "title": "event642", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 642." + }, + "xdm:event643": { + "title": "event643", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 643." + }, + "xdm:event644": { + "title": "event644", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 644." + }, + "xdm:event645": { + "title": "event645", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 645." + }, + "xdm:event646": { + "title": "event646", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 646." + }, + "xdm:event647": { + "title": "event647", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 647." + }, + "xdm:event648": { + "title": "event648", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 648." + }, + "xdm:event649": { + "title": "event649", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 649." + }, + "xdm:event650": { + "title": "event650", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 650." + }, + "xdm:event651": { + "title": "event651", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 651." + }, + "xdm:event652": { + "title": "event652", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 652." + }, + "xdm:event653": { + "title": "event653", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 653." + }, + "xdm:event654": { + "title": "event654", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 654." + }, + "xdm:event655": { + "title": "event655", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 655." + }, + "xdm:event656": { + "title": "event656", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 656." + }, + "xdm:event657": { + "title": "event657", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 657." + }, + "xdm:event658": { + "title": "event658", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 658." + }, + "xdm:event659": { + "title": "event659", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 659." + }, + "xdm:event660": { + "title": "event660", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 660." + }, + "xdm:event661": { + "title": "event661", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 661." + }, + "xdm:event662": { + "title": "event662", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 662." + }, + "xdm:event663": { + "title": "event663", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 663." + }, + "xdm:event664": { + "title": "event664", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 664." + }, + "xdm:event665": { + "title": "event665", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 665." + }, + "xdm:event666": { + "title": "event666", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 666." + }, + "xdm:event667": { + "title": "event667", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 667." + }, + "xdm:event668": { + "title": "event668", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 668." + }, + "xdm:event669": { + "title": "event669", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 669." + }, + "xdm:event670": { + "title": "event670", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 670." + }, + "xdm:event671": { + "title": "event671", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 671." + }, + "xdm:event672": { + "title": "event672", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 672." + }, + "xdm:event673": { + "title": "event673", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 673." + }, + "xdm:event674": { + "title": "event674", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 674." + }, + "xdm:event675": { + "title": "event675", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 675." + }, + "xdm:event676": { + "title": "event676", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 676." + }, + "xdm:event677": { + "title": "event677", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 677." + }, + "xdm:event678": { + "title": "event678", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 678." + }, + "xdm:event679": { + "title": "event679", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 679." + }, + "xdm:event680": { + "title": "event680", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 680." + }, + "xdm:event681": { + "title": "event681", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 681." + }, + "xdm:event682": { + "title": "event682", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 682." + }, + "xdm:event683": { + "title": "event683", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 683." + }, + "xdm:event684": { + "title": "event684", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 684." + }, + "xdm:event685": { + "title": "event685", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 685." + }, + "xdm:event686": { + "title": "event686", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 686." + }, + "xdm:event687": { + "title": "event687", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 687." + }, + "xdm:event688": { + "title": "event688", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 688." + }, + "xdm:event689": { + "title": "event689", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 689." + }, + "xdm:event690": { + "title": "event690", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 690." + }, + "xdm:event691": { + "title": "event691", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 691." + }, + "xdm:event692": { + "title": "event692", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 692." + }, + "xdm:event693": { + "title": "event693", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 693." + }, + "xdm:event694": { + "title": "event694", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 694." + }, + "xdm:event695": { + "title": "event695", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 695." + }, + "xdm:event696": { + "title": "event696", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 696." + }, + "xdm:event697": { + "title": "event697", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 697." + }, + "xdm:event698": { + "title": "event698", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 698." + }, + "xdm:event699": { + "title": "event699", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 699." + }, + "xdm:event700": { + "title": "event700", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 700." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/event601to700" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/event601to700.schema.md b/docs/reference/adobe/experience/analytics/event601to700.schema.md new file mode 100644 index 000000000..45cad63d6 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event601to700.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/event601to700 +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/event601to700.schema.json](adobe/experience/analytics/event601to700.schema.json) | diff --git a/docs/reference/adobe/experience/analytics/event701to800.schema.json b/docs/reference/adobe/experience/analytics/event701to800.schema.json new file mode 100644 index 000000000..7a5abd1c2 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event701to800.schema.json @@ -0,0 +1,504 @@ +{ + "xdm:event701": { + "title": "event701", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 701." + }, + "xdm:event702": { + "title": "event702", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 702." + }, + "xdm:event703": { + "title": "event703", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 703." + }, + "xdm:event704": { + "title": "event704", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 704." + }, + "xdm:event705": { + "title": "event705", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 705." + }, + "xdm:event706": { + "title": "event706", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 706." + }, + "xdm:event707": { + "title": "event707", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 707." + }, + "xdm:event708": { + "title": "event708", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 708." + }, + "xdm:event709": { + "title": "event709", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 709." + }, + "xdm:event710": { + "title": "event710", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 710." + }, + "xdm:event711": { + "title": "event711", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 711." + }, + "xdm:event712": { + "title": "event712", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 712." + }, + "xdm:event713": { + "title": "event713", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 713." + }, + "xdm:event714": { + "title": "event714", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 714." + }, + "xdm:event715": { + "title": "event715", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 715." + }, + "xdm:event716": { + "title": "event716", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 716." + }, + "xdm:event717": { + "title": "event717", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 717." + }, + "xdm:event718": { + "title": "event718", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 718." + }, + "xdm:event719": { + "title": "event719", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 719." + }, + "xdm:event720": { + "title": "event720", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 720." + }, + "xdm:event721": { + "title": "event721", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 721." + }, + "xdm:event722": { + "title": "event722", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 722." + }, + "xdm:event723": { + "title": "event723", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 723." + }, + "xdm:event724": { + "title": "event724", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 724." + }, + "xdm:event725": { + "title": "event725", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 725." + }, + "xdm:event726": { + "title": "event726", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 726." + }, + "xdm:event727": { + "title": "event727", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 727." + }, + "xdm:event728": { + "title": "event728", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 728." + }, + "xdm:event729": { + "title": "event729", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 729." + }, + "xdm:event730": { + "title": "event730", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 730." + }, + "xdm:event731": { + "title": "event731", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 731." + }, + "xdm:event732": { + "title": "event732", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 732." + }, + "xdm:event733": { + "title": "event733", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 733." + }, + "xdm:event734": { + "title": "event734", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 734." + }, + "xdm:event735": { + "title": "event735", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 735." + }, + "xdm:event736": { + "title": "event736", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 736." + }, + "xdm:event737": { + "title": "event737", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 737." + }, + "xdm:event738": { + "title": "event738", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 738." + }, + "xdm:event739": { + "title": "event739", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 739." + }, + "xdm:event740": { + "title": "event740", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 740." + }, + "xdm:event741": { + "title": "event741", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 741." + }, + "xdm:event742": { + "title": "event742", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 742." + }, + "xdm:event743": { + "title": "event743", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 743." + }, + "xdm:event744": { + "title": "event744", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 744." + }, + "xdm:event745": { + "title": "event745", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 745." + }, + "xdm:event746": { + "title": "event746", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 746." + }, + "xdm:event747": { + "title": "event747", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 747." + }, + "xdm:event748": { + "title": "event748", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 748." + }, + "xdm:event749": { + "title": "event749", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 749." + }, + "xdm:event750": { + "title": "event750", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 750." + }, + "xdm:event751": { + "title": "event751", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 751." + }, + "xdm:event752": { + "title": "event752", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 752." + }, + "xdm:event753": { + "title": "event753", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 753." + }, + "xdm:event754": { + "title": "event754", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 754." + }, + "xdm:event755": { + "title": "event755", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 755." + }, + "xdm:event756": { + "title": "event756", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 756." + }, + "xdm:event757": { + "title": "event757", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 757." + }, + "xdm:event758": { + "title": "event758", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 758." + }, + "xdm:event759": { + "title": "event759", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 759." + }, + "xdm:event760": { + "title": "event760", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 760." + }, + "xdm:event761": { + "title": "event761", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 761." + }, + "xdm:event762": { + "title": "event762", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 762." + }, + "xdm:event763": { + "title": "event763", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 763." + }, + "xdm:event764": { + "title": "event764", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 764." + }, + "xdm:event765": { + "title": "event765", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 765." + }, + "xdm:event766": { + "title": "event766", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 766." + }, + "xdm:event767": { + "title": "event767", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 767." + }, + "xdm:event768": { + "title": "event768", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 768." + }, + "xdm:event769": { + "title": "event769", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 769." + }, + "xdm:event770": { + "title": "event770", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 770." + }, + "xdm:event771": { + "title": "event771", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 771." + }, + "xdm:event772": { + "title": "event772", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 772." + }, + "xdm:event773": { + "title": "event773", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 773." + }, + "xdm:event774": { + "title": "event774", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 774." + }, + "xdm:event775": { + "title": "event775", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 775." + }, + "xdm:event776": { + "title": "event776", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 776." + }, + "xdm:event777": { + "title": "event777", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 777." + }, + "xdm:event778": { + "title": "event778", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 778." + }, + "xdm:event779": { + "title": "event779", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 779." + }, + "xdm:event780": { + "title": "event780", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 780." + }, + "xdm:event781": { + "title": "event781", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 781." + }, + "xdm:event782": { + "title": "event782", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 782." + }, + "xdm:event783": { + "title": "event783", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 783." + }, + "xdm:event784": { + "title": "event784", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 784." + }, + "xdm:event785": { + "title": "event785", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 785." + }, + "xdm:event786": { + "title": "event786", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 786." + }, + "xdm:event787": { + "title": "event787", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 787." + }, + "xdm:event788": { + "title": "event788", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 788." + }, + "xdm:event789": { + "title": "event789", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 789." + }, + "xdm:event790": { + "title": "event790", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 790." + }, + "xdm:event791": { + "title": "event791", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 791." + }, + "xdm:event792": { + "title": "event792", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 792." + }, + "xdm:event793": { + "title": "event793", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 793." + }, + "xdm:event794": { + "title": "event794", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 794." + }, + "xdm:event795": { + "title": "event795", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 795." + }, + "xdm:event796": { + "title": "event796", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 796." + }, + "xdm:event797": { + "title": "event797", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 797." + }, + "xdm:event798": { + "title": "event798", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 798." + }, + "xdm:event799": { + "title": "event799", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 799." + }, + "xdm:event800": { + "title": "event800", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 800." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/event701to800" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/event701to800.schema.md b/docs/reference/adobe/experience/analytics/event701to800.schema.md new file mode 100644 index 000000000..fae005361 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event701to800.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/event701to800 +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/event701to800.schema.json](adobe/experience/analytics/event701to800.schema.json) | diff --git a/docs/reference/adobe/experience/analytics/event801to900.schema.json b/docs/reference/adobe/experience/analytics/event801to900.schema.json new file mode 100644 index 000000000..21902181d --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event801to900.schema.json @@ -0,0 +1,504 @@ +{ + "xdm:event801": { + "title": "event801", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 801." + }, + "xdm:event802": { + "title": "event802", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 802." + }, + "xdm:event803": { + "title": "event803", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 803." + }, + "xdm:event804": { + "title": "event804", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 804." + }, + "xdm:event805": { + "title": "event805", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 805." + }, + "xdm:event806": { + "title": "event806", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 806." + }, + "xdm:event807": { + "title": "event807", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 807." + }, + "xdm:event808": { + "title": "event808", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 808." + }, + "xdm:event809": { + "title": "event809", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 809." + }, + "xdm:event810": { + "title": "event810", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 810." + }, + "xdm:event811": { + "title": "event811", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 811." + }, + "xdm:event812": { + "title": "event812", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 812." + }, + "xdm:event813": { + "title": "event813", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 813." + }, + "xdm:event814": { + "title": "event814", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 814." + }, + "xdm:event815": { + "title": "event815", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 815." + }, + "xdm:event816": { + "title": "event816", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 816." + }, + "xdm:event817": { + "title": "event817", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 817." + }, + "xdm:event818": { + "title": "event818", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 818." + }, + "xdm:event819": { + "title": "event819", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 819." + }, + "xdm:event820": { + "title": "event820", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 820." + }, + "xdm:event821": { + "title": "event821", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 821." + }, + "xdm:event822": { + "title": "event822", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 822." + }, + "xdm:event823": { + "title": "event823", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 823." + }, + "xdm:event824": { + "title": "event824", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 824." + }, + "xdm:event825": { + "title": "event825", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 825." + }, + "xdm:event826": { + "title": "event826", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 826." + }, + "xdm:event827": { + "title": "event827", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 827." + }, + "xdm:event828": { + "title": "event828", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 828." + }, + "xdm:event829": { + "title": "event829", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 829." + }, + "xdm:event830": { + "title": "event830", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 830." + }, + "xdm:event831": { + "title": "event831", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 831." + }, + "xdm:event832": { + "title": "event832", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 832." + }, + "xdm:event833": { + "title": "event833", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 833." + }, + "xdm:event834": { + "title": "event834", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 834." + }, + "xdm:event835": { + "title": "event835", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 835." + }, + "xdm:event836": { + "title": "event836", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 836." + }, + "xdm:event837": { + "title": "event837", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 837." + }, + "xdm:event838": { + "title": "event838", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 838." + }, + "xdm:event839": { + "title": "event839", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 839." + }, + "xdm:event840": { + "title": "event840", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 840." + }, + "xdm:event841": { + "title": "event841", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 841." + }, + "xdm:event842": { + "title": "event842", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 842." + }, + "xdm:event843": { + "title": "event843", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 843." + }, + "xdm:event844": { + "title": "event844", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 844." + }, + "xdm:event845": { + "title": "event845", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 845." + }, + "xdm:event846": { + "title": "event846", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 846." + }, + "xdm:event847": { + "title": "event847", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 847." + }, + "xdm:event848": { + "title": "event848", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 848." + }, + "xdm:event849": { + "title": "event849", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 849." + }, + "xdm:event850": { + "title": "event850", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 850." + }, + "xdm:event851": { + "title": "event851", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 851." + }, + "xdm:event852": { + "title": "event852", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 852." + }, + "xdm:event853": { + "title": "event853", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 853." + }, + "xdm:event854": { + "title": "event854", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 854." + }, + "xdm:event855": { + "title": "event855", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 855." + }, + "xdm:event856": { + "title": "event856", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 856." + }, + "xdm:event857": { + "title": "event857", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 857." + }, + "xdm:event858": { + "title": "event858", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 858." + }, + "xdm:event859": { + "title": "event859", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 859." + }, + "xdm:event860": { + "title": "event860", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 860." + }, + "xdm:event861": { + "title": "event861", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 861." + }, + "xdm:event862": { + "title": "event862", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 862." + }, + "xdm:event863": { + "title": "event863", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 863." + }, + "xdm:event864": { + "title": "event864", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 864." + }, + "xdm:event865": { + "title": "event865", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 865." + }, + "xdm:event866": { + "title": "event866", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 866." + }, + "xdm:event867": { + "title": "event867", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 867." + }, + "xdm:event868": { + "title": "event868", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 868." + }, + "xdm:event869": { + "title": "event869", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 869." + }, + "xdm:event870": { + "title": "event870", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 870." + }, + "xdm:event871": { + "title": "event871", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 871." + }, + "xdm:event872": { + "title": "event872", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 872." + }, + "xdm:event873": { + "title": "event873", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 873." + }, + "xdm:event874": { + "title": "event874", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 874." + }, + "xdm:event875": { + "title": "event875", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 875." + }, + "xdm:event876": { + "title": "event876", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 876." + }, + "xdm:event877": { + "title": "event877", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 877." + }, + "xdm:event878": { + "title": "event878", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 878." + }, + "xdm:event879": { + "title": "event879", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 879." + }, + "xdm:event880": { + "title": "event880", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 880." + }, + "xdm:event881": { + "title": "event881", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 881." + }, + "xdm:event882": { + "title": "event882", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 882." + }, + "xdm:event883": { + "title": "event883", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 883." + }, + "xdm:event884": { + "title": "event884", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 884." + }, + "xdm:event885": { + "title": "event885", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 885." + }, + "xdm:event886": { + "title": "event886", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 886." + }, + "xdm:event887": { + "title": "event887", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 887." + }, + "xdm:event888": { + "title": "event888", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 888." + }, + "xdm:event889": { + "title": "event889", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 889." + }, + "xdm:event890": { + "title": "event890", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 890." + }, + "xdm:event891": { + "title": "event891", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 891." + }, + "xdm:event892": { + "title": "event892", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 892." + }, + "xdm:event893": { + "title": "event893", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 893." + }, + "xdm:event894": { + "title": "event894", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 894." + }, + "xdm:event895": { + "title": "event895", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 895." + }, + "xdm:event896": { + "title": "event896", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 896." + }, + "xdm:event897": { + "title": "event897", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 897." + }, + "xdm:event898": { + "title": "event898", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 898." + }, + "xdm:event899": { + "title": "event899", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 899." + }, + "xdm:event900": { + "title": "event900", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 900." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/event801to900" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/event801to900.schema.md b/docs/reference/adobe/experience/analytics/event801to900.schema.md new file mode 100644 index 000000000..9e906854e --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event801to900.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/event801to900 +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/event801to900.schema.json](adobe/experience/analytics/event801to900.schema.json) | diff --git a/docs/reference/adobe/experience/analytics/event901to1000.schema.json b/docs/reference/adobe/experience/analytics/event901to1000.schema.json new file mode 100644 index 000000000..318188bce --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event901to1000.schema.json @@ -0,0 +1,504 @@ +{ + "xdm:event901": { + "title": "event901", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 901." + }, + "xdm:event902": { + "title": "event902", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 902." + }, + "xdm:event903": { + "title": "event903", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 903." + }, + "xdm:event904": { + "title": "event904", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 904." + }, + "xdm:event905": { + "title": "event905", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 905." + }, + "xdm:event906": { + "title": "event906", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 906." + }, + "xdm:event907": { + "title": "event907", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 907." + }, + "xdm:event908": { + "title": "event908", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 908." + }, + "xdm:event909": { + "title": "event909", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 909." + }, + "xdm:event910": { + "title": "event910", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 910." + }, + "xdm:event911": { + "title": "event911", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 911." + }, + "xdm:event912": { + "title": "event912", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 912." + }, + "xdm:event913": { + "title": "event913", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 913." + }, + "xdm:event914": { + "title": "event914", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 914." + }, + "xdm:event915": { + "title": "event915", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 915." + }, + "xdm:event916": { + "title": "event916", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 916." + }, + "xdm:event917": { + "title": "event917", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 917." + }, + "xdm:event918": { + "title": "event918", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 918." + }, + "xdm:event919": { + "title": "event919", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 919." + }, + "xdm:event920": { + "title": "event920", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 920." + }, + "xdm:event921": { + "title": "event921", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 921." + }, + "xdm:event922": { + "title": "event922", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 922." + }, + "xdm:event923": { + "title": "event923", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 923." + }, + "xdm:event924": { + "title": "event924", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 924." + }, + "xdm:event925": { + "title": "event925", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 925." + }, + "xdm:event926": { + "title": "event926", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 926." + }, + "xdm:event927": { + "title": "event927", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 927." + }, + "xdm:event928": { + "title": "event928", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 928." + }, + "xdm:event929": { + "title": "event929", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 929." + }, + "xdm:event930": { + "title": "event930", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 930." + }, + "xdm:event931": { + "title": "event931", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 931." + }, + "xdm:event932": { + "title": "event932", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 932." + }, + "xdm:event933": { + "title": "event933", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 933." + }, + "xdm:event934": { + "title": "event934", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 934." + }, + "xdm:event935": { + "title": "event935", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 935." + }, + "xdm:event936": { + "title": "event936", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 936." + }, + "xdm:event937": { + "title": "event937", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 937." + }, + "xdm:event938": { + "title": "event938", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 938." + }, + "xdm:event939": { + "title": "event939", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 939." + }, + "xdm:event940": { + "title": "event940", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 940." + }, + "xdm:event941": { + "title": "event941", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 941." + }, + "xdm:event942": { + "title": "event942", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 942." + }, + "xdm:event943": { + "title": "event943", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 943." + }, + "xdm:event944": { + "title": "event944", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 944." + }, + "xdm:event945": { + "title": "event945", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 945." + }, + "xdm:event946": { + "title": "event946", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 946." + }, + "xdm:event947": { + "title": "event947", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 947." + }, + "xdm:event948": { + "title": "event948", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 948." + }, + "xdm:event949": { + "title": "event949", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 949." + }, + "xdm:event950": { + "title": "event950", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 950." + }, + "xdm:event951": { + "title": "event951", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 951." + }, + "xdm:event952": { + "title": "event952", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 952." + }, + "xdm:event953": { + "title": "event953", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 953." + }, + "xdm:event954": { + "title": "event954", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 954." + }, + "xdm:event955": { + "title": "event955", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 955." + }, + "xdm:event956": { + "title": "event956", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 956." + }, + "xdm:event957": { + "title": "event957", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 957." + }, + "xdm:event958": { + "title": "event958", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 958." + }, + "xdm:event959": { + "title": "event959", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 959." + }, + "xdm:event960": { + "title": "event960", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 960." + }, + "xdm:event961": { + "title": "event961", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 961." + }, + "xdm:event962": { + "title": "event962", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 962." + }, + "xdm:event963": { + "title": "event963", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 963." + }, + "xdm:event964": { + "title": "event964", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 964." + }, + "xdm:event965": { + "title": "event965", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 965." + }, + "xdm:event966": { + "title": "event966", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 966." + }, + "xdm:event967": { + "title": "event967", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 967." + }, + "xdm:event968": { + "title": "event968", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 968." + }, + "xdm:event969": { + "title": "event969", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 969." + }, + "xdm:event970": { + "title": "event970", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 970." + }, + "xdm:event971": { + "title": "event971", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 971." + }, + "xdm:event972": { + "title": "event972", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 972." + }, + "xdm:event973": { + "title": "event973", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 973." + }, + "xdm:event974": { + "title": "event974", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 974." + }, + "xdm:event975": { + "title": "event975", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 975." + }, + "xdm:event976": { + "title": "event976", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 976." + }, + "xdm:event977": { + "title": "event977", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 977." + }, + "xdm:event978": { + "title": "event978", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 978." + }, + "xdm:event979": { + "title": "event979", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 979." + }, + "xdm:event980": { + "title": "event980", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 980." + }, + "xdm:event981": { + "title": "event981", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 981." + }, + "xdm:event982": { + "title": "event982", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 982." + }, + "xdm:event983": { + "title": "event983", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 983." + }, + "xdm:event984": { + "title": "event984", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 984." + }, + "xdm:event985": { + "title": "event985", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 985." + }, + "xdm:event986": { + "title": "event986", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 986." + }, + "xdm:event987": { + "title": "event987", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 987." + }, + "xdm:event988": { + "title": "event988", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 988." + }, + "xdm:event989": { + "title": "event989", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 989." + }, + "xdm:event990": { + "title": "event990", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 990." + }, + "xdm:event991": { + "title": "event991", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 991." + }, + "xdm:event992": { + "title": "event992", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 992." + }, + "xdm:event993": { + "title": "event993", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 993." + }, + "xdm:event994": { + "title": "event994", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 994." + }, + "xdm:event995": { + "title": "event995", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 995." + }, + "xdm:event996": { + "title": "event996", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 996." + }, + "xdm:event997": { + "title": "event997", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 997." + }, + "xdm:event998": { + "title": "event998", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 998." + }, + "xdm:event999": { + "title": "event999", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 999." + }, + "xdm:event1000": { + "title": "event1000", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Custom event 1000." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/event901to1000" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/event901to1000.schema.md b/docs/reference/adobe/experience/analytics/event901to1000.schema.md new file mode 100644 index 000000000..cf7cce958 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/event901to1000.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/event901to1000 +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/event901to1000.schema.json](adobe/experience/analytics/event901to1000.schema.json) | diff --git a/docs/reference/adobe/experience/analytics/events.schema.json b/docs/reference/adobe/experience/analytics/events.schema.json new file mode 100644 index 000000000..ec5f680bc --- /dev/null +++ b/docs/reference/adobe/experience/analytics/events.schema.json @@ -0,0 +1,69 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/analytics/events", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Analytics Custom Events", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "Adobe Analytics custom event fields.", + "definitions": { + "events": { + "properties": { + "https://ns.adobe.com/experience/analytics/event1to100": { + "title": "Event 1 to 100", + "$ref": "https://ns.adobe.com/experience/analytics/event1to100" + }, + "https://ns.adobe.com/experience/analytics/event101to200": { + "title": "Event 101 to 200", + "$ref": "https://ns.adobe.com/experience/analytics/event101to200" + }, + "https://ns.adobe.com/experience/analytics/event201to300": { + "title": "Event 201 to 300", + "$ref": "https://ns.adobe.com/experience/analytics/event201to300" + }, + "https://ns.adobe.com/experience/analytics/event301to400": { + "title": "Event 301 to 400", + "$ref": "https://ns.adobe.com/experience/analytics/event301to400" + }, + "https://ns.adobe.com/experience/analytics/event401to500": { + "title": "Event 401 to 500", + "$ref": "https://ns.adobe.com/experience/analytics/event401to500" + }, + "https://ns.adobe.com/experience/analytics/event501to600": { + "title": "Event 501 to 600", + "$ref": "https://ns.adobe.com/experience/analytics/event501to600" + }, + "https://ns.adobe.com/experience/analytics/event601to700": { + "title": "Event 601 to 700", + "$ref": "https://ns.adobe.com/experience/analytics/event601to700" + }, + "https://ns.adobe.com/experience/analytics/event701to800": { + "title": "Event 701 to 800", + "$ref": "https://ns.adobe.com/experience/analytics/event701to800" + }, + "https://ns.adobe.com/experience/analytics/event801to900": { + "title": "Event 801 to 900", + "$ref": "https://ns.adobe.com/experience/analytics/event801to900" + }, + "https://ns.adobe.com/experience/analytics/event901to1000": { + "title": "Event 901 to 1000", + "$ref": "https://ns.adobe.com/experience/analytics/event901to1000" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/events" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/events.schema.md b/docs/reference/adobe/experience/analytics/events.schema.md new file mode 100644 index 000000000..c2d902cfb --- /dev/null +++ b/docs/reference/adobe/experience/analytics/events.schema.md @@ -0,0 +1,213 @@ + +# Adobe Analytics Custom Events Schema + +``` +https://ns.adobe.com/experience/analytics/events +``` + +Adobe Analytics custom event fields. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/events.schema.json](adobe/experience/analytics/events.schema.json) | +## Schema Hierarchy + +* Adobe Analytics Custom Events `https://ns.adobe.com/experience/analytics/events` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [event1to100.schema](event1to100.schema.md) `https://ns.adobe.com/experience/analytics/event1to100` + * [event101to200.schema](event101to200.schema.md) `https://ns.adobe.com/experience/analytics/event101to200` + * [event201to300.schema](event201to300.schema.md) `https://ns.adobe.com/experience/analytics/event201to300` + * [event301to400.schema](event301to400.schema.md) `https://ns.adobe.com/experience/analytics/event301to400` + * [event401to500.schema](event401to500.schema.md) `https://ns.adobe.com/experience/analytics/event401to500` + * [event501to600.schema](event501to600.schema.md) `https://ns.adobe.com/experience/analytics/event501to600` + * [event601to700.schema](event601to700.schema.md) `https://ns.adobe.com/experience/analytics/event601to700` + * [event701to800.schema](event701to800.schema.md) `https://ns.adobe.com/experience/analytics/event701to800` + * [event801to900.schema](event801to900.schema.md) `https://ns.adobe.com/experience/analytics/event801to900` + * [event901to1000.schema](event901to1000.schema.md) `https://ns.adobe.com/experience/analytics/event901to1000` + + +# Adobe Analytics Custom Events Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/analytics/event101to200](#httpsnsadobecomexperienceanalyticsevent101to200) | event101to200.schema | Optional | Adobe Analytics Custom Events (this schema) | +| [https://ns.adobe.com/experience/analytics/event1to100](#httpsnsadobecomexperienceanalyticsevent1to100) | event1to100.schema | Optional | Adobe Analytics Custom Events (this schema) | +| [https://ns.adobe.com/experience/analytics/event201to300](#httpsnsadobecomexperienceanalyticsevent201to300) | event201to300.schema | Optional | Adobe Analytics Custom Events (this schema) | +| [https://ns.adobe.com/experience/analytics/event301to400](#httpsnsadobecomexperienceanalyticsevent301to400) | event301to400.schema | Optional | Adobe Analytics Custom Events (this schema) | +| [https://ns.adobe.com/experience/analytics/event401to500](#httpsnsadobecomexperienceanalyticsevent401to500) | event401to500.schema | Optional | Adobe Analytics Custom Events (this schema) | +| [https://ns.adobe.com/experience/analytics/event501to600](#httpsnsadobecomexperienceanalyticsevent501to600) | event501to600.schema | Optional | Adobe Analytics Custom Events (this schema) | +| [https://ns.adobe.com/experience/analytics/event601to700](#httpsnsadobecomexperienceanalyticsevent601to700) | event601to700.schema | Optional | Adobe Analytics Custom Events (this schema) | +| [https://ns.adobe.com/experience/analytics/event701to800](#httpsnsadobecomexperienceanalyticsevent701to800) | event701to800.schema | Optional | Adobe Analytics Custom Events (this schema) | +| [https://ns.adobe.com/experience/analytics/event801to900](#httpsnsadobecomexperienceanalyticsevent801to900) | event801to900.schema | Optional | Adobe Analytics Custom Events (this schema) | +| [https://ns.adobe.com/experience/analytics/event901to1000](#httpsnsadobecomexperienceanalyticsevent901to1000) | event901to1000.schema | Optional | Adobe Analytics Custom Events (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/analytics/event101to200 +### Event 101 to 200 + +`https://ns.adobe.com/experience/analytics/event101to200` +* is optional +* type: event101to200.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event101to200 Type + + +* [event101to200.schema](event101to200.schema.md) – `https://ns.adobe.com/experience/analytics/event101to200` + + + + + +## https://ns.adobe.com/experience/analytics/event1to100 +### Event 1 to 100 + +`https://ns.adobe.com/experience/analytics/event1to100` +* is optional +* type: event1to100.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event1to100 Type + + +* [event1to100.schema](event1to100.schema.md) – `https://ns.adobe.com/experience/analytics/event1to100` + + + + + +## https://ns.adobe.com/experience/analytics/event201to300 +### Event 201 to 300 + +`https://ns.adobe.com/experience/analytics/event201to300` +* is optional +* type: event201to300.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event201to300 Type + + +* [event201to300.schema](event201to300.schema.md) – `https://ns.adobe.com/experience/analytics/event201to300` + + + + + +## https://ns.adobe.com/experience/analytics/event301to400 +### Event 301 to 400 + +`https://ns.adobe.com/experience/analytics/event301to400` +* is optional +* type: event301to400.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event301to400 Type + + +* [event301to400.schema](event301to400.schema.md) – `https://ns.adobe.com/experience/analytics/event301to400` + + + + + +## https://ns.adobe.com/experience/analytics/event401to500 +### Event 401 to 500 + +`https://ns.adobe.com/experience/analytics/event401to500` +* is optional +* type: event401to500.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event401to500 Type + + +* [event401to500.schema](event401to500.schema.md) – `https://ns.adobe.com/experience/analytics/event401to500` + + + + + +## https://ns.adobe.com/experience/analytics/event501to600 +### Event 501 to 600 + +`https://ns.adobe.com/experience/analytics/event501to600` +* is optional +* type: event501to600.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event501to600 Type + + +* [event501to600.schema](event501to600.schema.md) – `https://ns.adobe.com/experience/analytics/event501to600` + + + + + +## https://ns.adobe.com/experience/analytics/event601to700 +### Event 601 to 700 + +`https://ns.adobe.com/experience/analytics/event601to700` +* is optional +* type: event601to700.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event601to700 Type + + +* [event601to700.schema](event601to700.schema.md) – `https://ns.adobe.com/experience/analytics/event601to700` + + + + + +## https://ns.adobe.com/experience/analytics/event701to800 +### Event 701 to 800 + +`https://ns.adobe.com/experience/analytics/event701to800` +* is optional +* type: event701to800.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event701to800 Type + + +* [event701to800.schema](event701to800.schema.md) – `https://ns.adobe.com/experience/analytics/event701to800` + + + + + +## https://ns.adobe.com/experience/analytics/event801to900 +### Event 801 to 900 + +`https://ns.adobe.com/experience/analytics/event801to900` +* is optional +* type: event801to900.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event801to900 Type + + +* [event801to900.schema](event801to900.schema.md) – `https://ns.adobe.com/experience/analytics/event801to900` + + + + + +## https://ns.adobe.com/experience/analytics/event901to1000 +### Event 901 to 1000 + +`https://ns.adobe.com/experience/analytics/event901to1000` +* is optional +* type: event901to1000.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event901to1000 Type + + +* [event901to1000.schema](event901to1000.schema.md) – `https://ns.adobe.com/experience/analytics/event901to1000` + + + + diff --git a/docs/reference/adobe/experience/analytics/experienceevent-all.schema.json b/docs/reference/adobe/experience/analytics/experienceevent-all.schema.json new file mode 100644 index 000000000..9f5fa3a03 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/experienceevent-all.schema.json @@ -0,0 +1,2193 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/analytics/experienceevent-all", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Analytics ExperienceEvent Full Extension", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Analytics ExperienceEvent full extension. Contains all Solution added fields.", + "definitions": { + "experienceevent": { + "properties": { + "https://ns.adobe.com/experience/analytics/session": { + "title": "Session", + "$ref": "https://ns.adobe.com/experience/analytics/session" + }, + "https://ns.adobe.com/experience/analytics/endUser": { + "title": "End-User", + "$ref": "https://ns.adobe.com/experience/analytics/endUser" + }, + "https://ns.adobe.com/experience/analytics/customDimensions": { + "type": "object", + "title": "Custom Dimensions", + "properties": { + "xdm:eVars": { + "type": "object", + "title": "eVars", + "properties": { + "xdm:eVar1": { + "title": "eVar1", + "type": "string", + "description": "Custom conversion variable 1." + }, + "xdm:eVar2": { + "title": "eVar2", + "type": "string", + "description": "Custom conversion variable 2." + }, + "xdm:eVar3": { + "title": "eVar3", + "type": "string", + "description": "Custom conversion variable 3." + }, + "xdm:eVar4": { + "title": "eVar4", + "type": "string", + "description": "Custom conversion variable 4." + }, + "xdm:eVar5": { + "title": "eVar5", + "type": "string", + "description": "Custom conversion variable 5." + }, + "xdm:eVar6": { + "title": "eVar6", + "type": "string", + "description": "Custom conversion variable 6." + }, + "xdm:eVar7": { + "title": "eVar7", + "type": "string", + "description": "Custom conversion variable 7." + }, + "xdm:eVar8": { + "title": "eVar8", + "type": "string", + "description": "Custom conversion variable 8." + }, + "xdm:eVar9": { + "title": "eVar9", + "type": "string", + "description": "Custom conversion variable 9." + }, + "xdm:eVar10": { + "title": "eVar10", + "type": "string", + "description": "Custom conversion variable 10." + }, + "xdm:eVar11": { + "title": "eVar11", + "type": "string", + "description": "Custom conversion variable 11." + }, + "xdm:eVar12": { + "title": "eVar12", + "type": "string", + "description": "Custom conversion variable 12." + }, + "xdm:eVar13": { + "title": "eVar13", + "type": "string", + "description": "Custom conversion variable 13." + }, + "xdm:eVar14": { + "title": "eVar14", + "type": "string", + "description": "Custom conversion variable 14." + }, + "xdm:eVar15": { + "title": "eVar15", + "type": "string", + "description": "Custom conversion variable 15." + }, + "xdm:eVar16": { + "title": "eVar16", + "type": "string", + "description": "Custom conversion variable 16." + }, + "xdm:eVar17": { + "title": "eVar17", + "type": "string", + "description": "Custom conversion variable 17." + }, + "xdm:eVar18": { + "title": "eVar18", + "type": "string", + "description": "Custom conversion variable 18." + }, + "xdm:eVar19": { + "title": "eVar19", + "type": "string", + "description": "Custom conversion variable 19." + }, + "xdm:eVar20": { + "title": "eVar20", + "type": "string", + "description": "Custom conversion variable 20." + }, + "xdm:eVar21": { + "title": "eVar21", + "type": "string", + "description": "Custom conversion variable 21." + }, + "xdm:eVar22": { + "title": "eVar22", + "type": "string", + "description": "Custom conversion variable 22." + }, + "xdm:eVar23": { + "title": "eVar23", + "type": "string", + "description": "Custom conversion variable 23." + }, + "xdm:eVar24": { + "title": "eVar24", + "type": "string", + "description": "Custom conversion variable 24." + }, + "xdm:eVar25": { + "title": "eVar25", + "type": "string", + "description": "Custom conversion variable 25." + }, + "xdm:eVar26": { + "title": "eVar26", + "type": "string", + "description": "Custom conversion variable 26." + }, + "xdm:eVar27": { + "title": "eVar27", + "type": "string", + "description": "Custom conversion variable 27." + }, + "xdm:eVar28": { + "title": "eVar28", + "type": "string", + "description": "Custom conversion variable 28." + }, + "xdm:eVar29": { + "title": "eVar29", + "type": "string", + "description": "Custom conversion variable 29." + }, + "xdm:eVar30": { + "title": "eVar30", + "type": "string", + "description": "Custom conversion variable 30." + }, + "xdm:eVar31": { + "title": "eVar31", + "type": "string", + "description": "Custom conversion variable 31." + }, + "xdm:eVar32": { + "title": "eVar32", + "type": "string", + "description": "Custom conversion variable 32." + }, + "xdm:eVar33": { + "title": "eVar33", + "type": "string", + "description": "Custom conversion variable 33." + }, + "xdm:eVar34": { + "title": "eVar34", + "type": "string", + "description": "Custom conversion variable 34." + }, + "xdm:eVar35": { + "title": "eVar35", + "type": "string", + "description": "Custom conversion variable 35." + }, + "xdm:eVar36": { + "title": "eVar36", + "type": "string", + "description": "Custom conversion variable 36." + }, + "xdm:eVar37": { + "title": "eVar37", + "type": "string", + "description": "Custom conversion variable 37." + }, + "xdm:eVar38": { + "title": "eVar38", + "type": "string", + "description": "Custom conversion variable 38." + }, + "xdm:eVar39": { + "title": "eVar39", + "type": "string", + "description": "Custom conversion variable 39." + }, + "xdm:eVar40": { + "title": "eVar40", + "type": "string", + "description": "Custom conversion variable 40." + }, + "xdm:eVar41": { + "title": "eVar41", + "type": "string", + "description": "Custom conversion variable 41." + }, + "xdm:eVar42": { + "title": "eVar42", + "type": "string", + "description": "Custom conversion variable 42." + }, + "xdm:eVar43": { + "title": "eVar43", + "type": "string", + "description": "Custom conversion variable 43." + }, + "xdm:eVar44": { + "title": "eVar44", + "type": "string", + "description": "Custom conversion variable 44." + }, + "xdm:eVar45": { + "title": "eVar45", + "type": "string", + "description": "Custom conversion variable 45." + }, + "xdm:eVar46": { + "title": "eVar46", + "type": "string", + "description": "Custom conversion variable 46." + }, + "xdm:eVar47": { + "title": "eVar47", + "type": "string", + "description": "Custom conversion variable 47." + }, + "xdm:eVar48": { + "title": "eVar48", + "type": "string", + "description": "Custom conversion variable 48." + }, + "xdm:eVar49": { + "title": "eVar49", + "type": "string", + "description": "Custom conversion variable 49." + }, + "xdm:eVar50": { + "title": "eVar50", + "type": "string", + "description": "Custom conversion variable 50." + }, + "xdm:eVar51": { + "title": "eVar51", + "type": "string", + "description": "Custom conversion variable 51." + }, + "xdm:eVar52": { + "title": "eVar52", + "type": "string", + "description": "Custom conversion variable 52." + }, + "xdm:eVar53": { + "title": "eVar53", + "type": "string", + "description": "Custom conversion variable 53." + }, + "xdm:eVar54": { + "title": "eVar54", + "type": "string", + "description": "Custom conversion variable 54." + }, + "xdm:eVar55": { + "title": "eVar55", + "type": "string", + "description": "Custom conversion variable 55." + }, + "xdm:eVar56": { + "title": "eVar56", + "type": "string", + "description": "Custom conversion variable 56." + }, + "xdm:eVar57": { + "title": "eVar57", + "type": "string", + "description": "Custom conversion variable 57." + }, + "xdm:eVar58": { + "title": "eVar58", + "type": "string", + "description": "Custom conversion variable 58." + }, + "xdm:eVar59": { + "title": "eVar59", + "type": "string", + "description": "Custom conversion variable 59." + }, + "xdm:eVar60": { + "title": "eVar60", + "type": "string", + "description": "Custom conversion variable 60." + }, + "xdm:eVar61": { + "title": "eVar61", + "type": "string", + "description": "Custom conversion variable 61." + }, + "xdm:eVar62": { + "title": "eVar62", + "type": "string", + "description": "Custom conversion variable 62." + }, + "xdm:eVar63": { + "title": "eVar63", + "type": "string", + "description": "Custom conversion variable 63." + }, + "xdm:eVar64": { + "title": "eVar64", + "type": "string", + "description": "Custom conversion variable 64." + }, + "xdm:eVar65": { + "title": "eVar65", + "type": "string", + "description": "Custom conversion variable 65." + }, + "xdm:eVar66": { + "title": "eVar66", + "type": "string", + "description": "Custom conversion variable 66." + }, + "xdm:eVar67": { + "title": "eVar67", + "type": "string", + "description": "Custom conversion variable 67." + }, + "xdm:eVar68": { + "title": "eVar68", + "type": "string", + "description": "Custom conversion variable 68." + }, + "xdm:eVar69": { + "title": "eVar69", + "type": "string", + "description": "Custom conversion variable 69." + }, + "xdm:eVar70": { + "title": "eVar70", + "type": "string", + "description": "Custom conversion variable 70." + }, + "xdm:eVar71": { + "title": "eVar71", + "type": "string", + "description": "Custom conversion variable 71." + }, + "xdm:eVar72": { + "title": "eVar72", + "type": "string", + "description": "Custom conversion variable 72." + }, + "xdm:eVar73": { + "title": "eVar73", + "type": "string", + "description": "Custom conversion variable 73." + }, + "xdm:eVar74": { + "title": "eVar74", + "type": "string", + "description": "Custom conversion variable 74." + }, + "xdm:eVar75": { + "title": "eVar75", + "type": "string", + "description": "Custom conversion variable 75." + }, + "xdm:eVar76": { + "title": "eVar76", + "type": "string", + "description": "Custom conversion variable 76." + }, + "xdm:eVar77": { + "title": "eVar77", + "type": "string", + "description": "Custom conversion variable 77." + }, + "xdm:eVar78": { + "title": "eVar78", + "type": "string", + "description": "Custom conversion variable 78." + }, + "xdm:eVar79": { + "title": "eVar79", + "type": "string", + "description": "Custom conversion variable 79." + }, + "xdm:eVar80": { + "title": "eVar80", + "type": "string", + "description": "Custom conversion variable 80." + }, + "xdm:eVar81": { + "title": "eVar81", + "type": "string", + "description": "Custom conversion variable 81." + }, + "xdm:eVar82": { + "title": "eVar82", + "type": "string", + "description": "Custom conversion variable 82." + }, + "xdm:eVar83": { + "title": "eVar83", + "type": "string", + "description": "Custom conversion variable 83." + }, + "xdm:eVar84": { + "title": "eVar84", + "type": "string", + "description": "Custom conversion variable 84." + }, + "xdm:eVar85": { + "title": "eVar85", + "type": "string", + "description": "Custom conversion variable 85." + }, + "xdm:eVar86": { + "title": "eVar86", + "type": "string", + "description": "Custom conversion variable 86." + }, + "xdm:eVar87": { + "title": "eVar87", + "type": "string", + "description": "Custom conversion variable 87." + }, + "xdm:eVar88": { + "title": "eVar88", + "type": "string", + "description": "Custom conversion variable 88." + }, + "xdm:eVar89": { + "title": "eVar89", + "type": "string", + "description": "Custom conversion variable 89." + }, + "xdm:eVar90": { + "title": "eVar90", + "type": "string", + "description": "Custom conversion variable 90." + }, + "xdm:eVar91": { + "title": "eVar91", + "type": "string", + "description": "Custom conversion variable 91." + }, + "xdm:eVar92": { + "title": "eVar92", + "type": "string", + "description": "Custom conversion variable 92." + }, + "xdm:eVar93": { + "title": "eVar93", + "type": "string", + "description": "Custom conversion variable 93." + }, + "xdm:eVar94": { + "title": "eVar94", + "type": "string", + "description": "Custom conversion variable 94." + }, + "xdm:eVar95": { + "title": "eVar95", + "type": "string", + "description": "Custom conversion variable 95." + }, + "xdm:eVar96": { + "title": "eVar96", + "type": "string", + "description": "Custom conversion variable 96." + }, + "xdm:eVar97": { + "title": "eVar97", + "type": "string", + "description": "Custom conversion variable 97." + }, + "xdm:eVar98": { + "title": "eVar98", + "type": "string", + "description": "Custom conversion variable 98." + }, + "xdm:eVar99": { + "title": "eVar99", + "type": "string", + "description": "Custom conversion variable 99." + }, + "xdm:eVar100": { + "title": "eVar100", + "type": "string", + "description": "Custom conversion variable 100." + }, + "xdm:eVar101": { + "title": "eVar101", + "type": "string", + "description": "Custom conversion variable 101." + }, + "xdm:eVar102": { + "title": "eVar102", + "type": "string", + "description": "Custom conversion variable 102." + }, + "xdm:eVar103": { + "title": "eVar103", + "type": "string", + "description": "Custom conversion variable 103." + }, + "xdm:eVar104": { + "title": "eVar104", + "type": "string", + "description": "Custom conversion variable 104." + }, + "xdm:eVar105": { + "title": "eVar105", + "type": "string", + "description": "Custom conversion variable 105." + }, + "xdm:eVar106": { + "title": "eVar106", + "type": "string", + "description": "Custom conversion variable 106." + }, + "xdm:eVar107": { + "title": "eVar107", + "type": "string", + "description": "Custom conversion variable 107." + }, + "xdm:eVar108": { + "title": "eVar108", + "type": "string", + "description": "Custom conversion variable 108." + }, + "xdm:eVar109": { + "title": "eVar109", + "type": "string", + "description": "Custom conversion variable 109." + }, + "xdm:eVar110": { + "title": "eVar110", + "type": "string", + "description": "Custom conversion variable 110." + }, + "xdm:eVar111": { + "title": "eVar111", + "type": "string", + "description": "Custom conversion variable 111." + }, + "xdm:eVar112": { + "title": "eVar112", + "type": "string", + "description": "Custom conversion variable 112." + }, + "xdm:eVar113": { + "title": "eVar113", + "type": "string", + "description": "Custom conversion variable 113." + }, + "xdm:eVar114": { + "title": "eVar114", + "type": "string", + "description": "Custom conversion variable 114." + }, + "xdm:eVar115": { + "title": "eVar115", + "type": "string", + "description": "Custom conversion variable 115." + }, + "xdm:eVar116": { + "title": "eVar116", + "type": "string", + "description": "Custom conversion variable 116." + }, + "xdm:eVar117": { + "title": "eVar117", + "type": "string", + "description": "Custom conversion variable 117." + }, + "xdm:eVar118": { + "title": "eVar118", + "type": "string", + "description": "Custom conversion variable 118." + }, + "xdm:eVar119": { + "title": "eVar119", + "type": "string", + "description": "Custom conversion variable 119." + }, + "xdm:eVar120": { + "title": "eVar120", + "type": "string", + "description": "Custom conversion variable 120." + }, + "xdm:eVar121": { + "title": "eVar121", + "type": "string", + "description": "Custom conversion variable 121." + }, + "xdm:eVar122": { + "title": "eVar122", + "type": "string", + "description": "Custom conversion variable 122." + }, + "xdm:eVar123": { + "title": "eVar123", + "type": "string", + "description": "Custom conversion variable 123." + }, + "xdm:eVar124": { + "title": "eVar124", + "type": "string", + "description": "Custom conversion variable 124." + }, + "xdm:eVar125": { + "title": "eVar125", + "type": "string", + "description": "Custom conversion variable 125." + }, + "xdm:eVar126": { + "title": "eVar126", + "type": "string", + "description": "Custom conversion variable 126." + }, + "xdm:eVar127": { + "title": "eVar127", + "type": "string", + "description": "Custom conversion variable 127." + }, + "xdm:eVar128": { + "title": "eVar128", + "type": "string", + "description": "Custom conversion variable 128." + }, + "xdm:eVar129": { + "title": "eVar129", + "type": "string", + "description": "Custom conversion variable 129." + }, + "xdm:eVar130": { + "title": "eVar130", + "type": "string", + "description": "Custom conversion variable 130." + }, + "xdm:eVar131": { + "title": "eVar131", + "type": "string", + "description": "Custom conversion variable 131." + }, + "xdm:eVar132": { + "title": "eVar132", + "type": "string", + "description": "Custom conversion variable 132." + }, + "xdm:eVar133": { + "title": "eVar133", + "type": "string", + "description": "Custom conversion variable 133." + }, + "xdm:eVar134": { + "title": "eVar134", + "type": "string", + "description": "Custom conversion variable 134." + }, + "xdm:eVar135": { + "title": "eVar135", + "type": "string", + "description": "Custom conversion variable 135." + }, + "xdm:eVar136": { + "title": "eVar136", + "type": "string", + "description": "Custom conversion variable 136." + }, + "xdm:eVar137": { + "title": "eVar137", + "type": "string", + "description": "Custom conversion variable 137." + }, + "xdm:eVar138": { + "title": "eVar138", + "type": "string", + "description": "Custom conversion variable 138." + }, + "xdm:eVar139": { + "title": "eVar139", + "type": "string", + "description": "Custom conversion variable 139." + }, + "xdm:eVar140": { + "title": "eVar140", + "type": "string", + "description": "Custom conversion variable 140." + }, + "xdm:eVar141": { + "title": "eVar141", + "type": "string", + "description": "Custom conversion variable 141." + }, + "xdm:eVar142": { + "title": "eVar142", + "type": "string", + "description": "Custom conversion variable 142." + }, + "xdm:eVar143": { + "title": "eVar143", + "type": "string", + "description": "Custom conversion variable 143." + }, + "xdm:eVar144": { + "title": "eVar144", + "type": "string", + "description": "Custom conversion variable 144." + }, + "xdm:eVar145": { + "title": "eVar145", + "type": "string", + "description": "Custom conversion variable 145." + }, + "xdm:eVar146": { + "title": "eVar146", + "type": "string", + "description": "Custom conversion variable 146." + }, + "xdm:eVar147": { + "title": "eVar147", + "type": "string", + "description": "Custom conversion variable 147." + }, + "xdm:eVar148": { + "title": "eVar148", + "type": "string", + "description": "Custom conversion variable 148." + }, + "xdm:eVar149": { + "title": "eVar149", + "type": "string", + "description": "Custom conversion variable 149." + }, + "xdm:eVar150": { + "title": "eVar150", + "type": "string", + "description": "Custom conversion variable 150." + }, + "xdm:eVar151": { + "title": "eVar151", + "type": "string", + "description": "Custom conversion variable 151." + }, + "xdm:eVar152": { + "title": "eVar152", + "type": "string", + "description": "Custom conversion variable 152." + }, + "xdm:eVar153": { + "title": "eVar153", + "type": "string", + "description": "Custom conversion variable 153." + }, + "xdm:eVar154": { + "title": "eVar154", + "type": "string", + "description": "Custom conversion variable 154." + }, + "xdm:eVar155": { + "title": "eVar155", + "type": "string", + "description": "Custom conversion variable 155." + }, + "xdm:eVar156": { + "title": "eVar156", + "type": "string", + "description": "Custom conversion variable 156." + }, + "xdm:eVar157": { + "title": "eVar157", + "type": "string", + "description": "Custom conversion variable 157." + }, + "xdm:eVar158": { + "title": "eVar158", + "type": "string", + "description": "Custom conversion variable 158." + }, + "xdm:eVar159": { + "title": "eVar159", + "type": "string", + "description": "Custom conversion variable 159." + }, + "xdm:eVar160": { + "title": "eVar160", + "type": "string", + "description": "Custom conversion variable 160." + }, + "xdm:eVar161": { + "title": "eVar161", + "type": "string", + "description": "Custom conversion variable 161." + }, + "xdm:eVar162": { + "title": "eVar162", + "type": "string", + "description": "Custom conversion variable 162." + }, + "xdm:eVar163": { + "title": "eVar163", + "type": "string", + "description": "Custom conversion variable 163." + }, + "xdm:eVar164": { + "title": "eVar164", + "type": "string", + "description": "Custom conversion variable 164." + }, + "xdm:eVar165": { + "title": "eVar165", + "type": "string", + "description": "Custom conversion variable 165." + }, + "xdm:eVar166": { + "title": "eVar166", + "type": "string", + "description": "Custom conversion variable 166." + }, + "xdm:eVar167": { + "title": "eVar167", + "type": "string", + "description": "Custom conversion variable 167." + }, + "xdm:eVar168": { + "title": "eVar168", + "type": "string", + "description": "Custom conversion variable 168." + }, + "xdm:eVar169": { + "title": "eVar169", + "type": "string", + "description": "Custom conversion variable 169." + }, + "xdm:eVar170": { + "title": "eVar170", + "type": "string", + "description": "Custom conversion variable 170." + }, + "xdm:eVar171": { + "title": "eVar171", + "type": "string", + "description": "Custom conversion variable 171." + }, + "xdm:eVar172": { + "title": "eVar172", + "type": "string", + "description": "Custom conversion variable 172." + }, + "xdm:eVar173": { + "title": "eVar173", + "type": "string", + "description": "Custom conversion variable 173." + }, + "xdm:eVar174": { + "title": "eVar174", + "type": "string", + "description": "Custom conversion variable 174." + }, + "xdm:eVar175": { + "title": "eVar175", + "type": "string", + "description": "Custom conversion variable 175." + }, + "xdm:eVar176": { + "title": "eVar176", + "type": "string", + "description": "Custom conversion variable 176." + }, + "xdm:eVar177": { + "title": "eVar177", + "type": "string", + "description": "Custom conversion variable 177." + }, + "xdm:eVar178": { + "title": "eVar178", + "type": "string", + "description": "Custom conversion variable 178." + }, + "xdm:eVar179": { + "title": "eVar179", + "type": "string", + "description": "Custom conversion variable 179." + }, + "xdm:eVar180": { + "title": "eVar180", + "type": "string", + "description": "Custom conversion variable 180." + }, + "xdm:eVar181": { + "title": "eVar181", + "type": "string", + "description": "Custom conversion variable 181." + }, + "xdm:eVar182": { + "title": "eVar182", + "type": "string", + "description": "Custom conversion variable 182." + }, + "xdm:eVar183": { + "title": "eVar183", + "type": "string", + "description": "Custom conversion variable 183." + }, + "xdm:eVar184": { + "title": "eVar184", + "type": "string", + "description": "Custom conversion variable 184." + }, + "xdm:eVar185": { + "title": "eVar185", + "type": "string", + "description": "Custom conversion variable 185." + }, + "xdm:eVar186": { + "title": "eVar186", + "type": "string", + "description": "Custom conversion variable 186." + }, + "xdm:eVar187": { + "title": "eVar187", + "type": "string", + "description": "Custom conversion variable 187." + }, + "xdm:eVar188": { + "title": "eVar188", + "type": "string", + "description": "Custom conversion variable 188." + }, + "xdm:eVar189": { + "title": "eVar189", + "type": "string", + "description": "Custom conversion variable 189." + }, + "xdm:eVar190": { + "title": "eVar190", + "type": "string", + "description": "Custom conversion variable 190." + }, + "xdm:eVar191": { + "title": "eVar191", + "type": "string", + "description": "Custom conversion variable 191." + }, + "xdm:eVar192": { + "title": "eVar192", + "type": "string", + "description": "Custom conversion variable 192." + }, + "xdm:eVar193": { + "title": "eVar193", + "type": "string", + "description": "Custom conversion variable 193." + }, + "xdm:eVar194": { + "title": "eVar194", + "type": "string", + "description": "Custom conversion variable 194." + }, + "xdm:eVar195": { + "title": "eVar195", + "type": "string", + "description": "Custom conversion variable 195." + }, + "xdm:eVar196": { + "title": "eVar196", + "type": "string", + "description": "Custom conversion variable 196." + }, + "xdm:eVar197": { + "title": "eVar197", + "type": "string", + "description": "Custom conversion variable 197." + }, + "xdm:eVar198": { + "title": "eVar198", + "type": "string", + "description": "Custom conversion variable 198." + }, + "xdm:eVar199": { + "title": "eVar199", + "type": "string", + "description": "Custom conversion variable 199." + }, + "xdm:eVar200": { + "title": "eVar200", + "type": "string", + "description": "Custom conversion variable 200." + }, + "xdm:eVar201": { + "title": "eVar201", + "type": "string", + "description": "Custom conversion variable 201." + }, + "xdm:eVar202": { + "title": "eVar202", + "type": "string", + "description": "Custom conversion variable 202." + }, + "xdm:eVar203": { + "title": "eVar203", + "type": "string", + "description": "Custom conversion variable 203." + }, + "xdm:eVar204": { + "title": "eVar204", + "type": "string", + "description": "Custom conversion variable 204." + }, + "xdm:eVar205": { + "title": "eVar205", + "type": "string", + "description": "Custom conversion variable 205." + }, + "xdm:eVar206": { + "title": "eVar206", + "type": "string", + "description": "Custom conversion variable 206." + }, + "xdm:eVar207": { + "title": "eVar207", + "type": "string", + "description": "Custom conversion variable 207." + }, + "xdm:eVar208": { + "title": "eVar208", + "type": "string", + "description": "Custom conversion variable 208." + }, + "xdm:eVar209": { + "title": "eVar209", + "type": "string", + "description": "Custom conversion variable 209." + }, + "xdm:eVar210": { + "title": "eVar210", + "type": "string", + "description": "Custom conversion variable 210." + }, + "xdm:eVar211": { + "title": "eVar211", + "type": "string", + "description": "Custom conversion variable 211." + }, + "xdm:eVar212": { + "title": "eVar212", + "type": "string", + "description": "Custom conversion variable 212." + }, + "xdm:eVar213": { + "title": "eVar213", + "type": "string", + "description": "Custom conversion variable 213." + }, + "xdm:eVar214": { + "title": "eVar214", + "type": "string", + "description": "Custom conversion variable 214." + }, + "xdm:eVar215": { + "title": "eVar215", + "type": "string", + "description": "Custom conversion variable 215." + }, + "xdm:eVar216": { + "title": "eVar216", + "type": "string", + "description": "Custom conversion variable 216." + }, + "xdm:eVar217": { + "title": "eVar217", + "type": "string", + "description": "Custom conversion variable 217." + }, + "xdm:eVar218": { + "title": "eVar218", + "type": "string", + "description": "Custom conversion variable 218." + }, + "xdm:eVar219": { + "title": "eVar219", + "type": "string", + "description": "Custom conversion variable 219." + }, + "xdm:eVar220": { + "title": "eVar220", + "type": "string", + "description": "Custom conversion variable 220." + }, + "xdm:eVar221": { + "title": "eVar221", + "type": "string", + "description": "Custom conversion variable 221." + }, + "xdm:eVar222": { + "title": "eVar222", + "type": "string", + "description": "Custom conversion variable 222." + }, + "xdm:eVar223": { + "title": "eVar223", + "type": "string", + "description": "Custom conversion variable 223." + }, + "xdm:eVar224": { + "title": "eVar224", + "type": "string", + "description": "Custom conversion variable 224." + }, + "xdm:eVar225": { + "title": "eVar225", + "type": "string", + "description": "Custom conversion variable 225." + }, + "xdm:eVar226": { + "title": "eVar226", + "type": "string", + "description": "Custom conversion variable 226." + }, + "xdm:eVar227": { + "title": "eVar227", + "type": "string", + "description": "Custom conversion variable 227." + }, + "xdm:eVar228": { + "title": "eVar228", + "type": "string", + "description": "Custom conversion variable 228." + }, + "xdm:eVar229": { + "title": "eVar229", + "type": "string", + "description": "Custom conversion variable 229." + }, + "xdm:eVar230": { + "title": "eVar230", + "type": "string", + "description": "Custom conversion variable 230." + }, + "xdm:eVar231": { + "title": "eVar231", + "type": "string", + "description": "Custom conversion variable 231." + }, + "xdm:eVar232": { + "title": "eVar232", + "type": "string", + "description": "Custom conversion variable 232." + }, + "xdm:eVar233": { + "title": "eVar233", + "type": "string", + "description": "Custom conversion variable 233." + }, + "xdm:eVar234": { + "title": "eVar234", + "type": "string", + "description": "Custom conversion variable 234." + }, + "xdm:eVar235": { + "title": "eVar235", + "type": "string", + "description": "Custom conversion variable 235." + }, + "xdm:eVar236": { + "title": "eVar236", + "type": "string", + "description": "Custom conversion variable 236." + }, + "xdm:eVar237": { + "title": "eVar237", + "type": "string", + "description": "Custom conversion variable 237." + }, + "xdm:eVar238": { + "title": "eVar238", + "type": "string", + "description": "Custom conversion variable 238." + }, + "xdm:eVar239": { + "title": "eVar239", + "type": "string", + "description": "Custom conversion variable 239." + }, + "xdm:eVar240": { + "title": "eVar240", + "type": "string", + "description": "Custom conversion variable 240." + }, + "xdm:eVar241": { + "title": "eVar241", + "type": "string", + "description": "Custom conversion variable 241." + }, + "xdm:eVar242": { + "title": "eVar242", + "type": "string", + "description": "Custom conversion variable 242." + }, + "xdm:eVar243": { + "title": "eVar243", + "type": "string", + "description": "Custom conversion variable 243." + }, + "xdm:eVar244": { + "title": "eVar244", + "type": "string", + "description": "Custom conversion variable 244." + }, + "xdm:eVar245": { + "title": "eVar245", + "type": "string", + "description": "Custom conversion variable 245." + }, + "xdm:eVar246": { + "title": "eVar246", + "type": "string", + "description": "Custom conversion variable 246." + }, + "xdm:eVar247": { + "title": "eVar247", + "type": "string", + "description": "Custom conversion variable 247." + }, + "xdm:eVar248": { + "title": "eVar248", + "type": "string", + "description": "Custom conversion variable 248." + }, + "xdm:eVar249": { + "title": "eVar249", + "type": "string", + "description": "Custom conversion variable 249." + }, + "xdm:eVar250": { + "title": "eVar250", + "type": "string", + "description": "Custom conversion variable 250." + } + } + }, + "xdm:props": { + "type": "object", + "title": "Props", + "properties": { + "xdm:prop1": { + "title": "prop1", + "type": "string", + "description": "Custom property variable 1." + }, + "xdm:prop2": { + "title": "prop2", + "type": "string", + "description": "Custom property variable 2." + }, + "xdm:prop3": { + "title": "prop3", + "type": "string", + "description": "Custom property variable 3." + }, + "xdm:prop4": { + "title": "prop4", + "type": "string", + "description": "Custom property variable 4." + }, + "xdm:prop5": { + "title": "prop5", + "type": "string", + "description": "Custom property variable 5." + }, + "xdm:prop6": { + "title": "prop6", + "type": "string", + "description": "Custom property variable 6." + }, + "xdm:prop7": { + "title": "prop7", + "type": "string", + "description": "Custom property variable 7." + }, + "xdm:prop8": { + "title": "prop8", + "type": "string", + "description": "Custom property variable 8." + }, + "xdm:prop9": { + "title": "prop9", + "type": "string", + "description": "Custom property variable 9." + }, + "xdm:prop10": { + "title": "prop10", + "type": "string", + "description": "Custom property variable 10." + }, + "xdm:prop11": { + "title": "prop11", + "type": "string", + "description": "Custom property variable 11." + }, + "xdm:prop12": { + "title": "prop12", + "type": "string", + "description": "Custom property variable 12." + }, + "xdm:prop13": { + "title": "prop13", + "type": "string", + "description": "Custom property variable 13." + }, + "xdm:prop14": { + "title": "prop14", + "type": "string", + "description": "Custom property variable 14." + }, + "xdm:prop15": { + "title": "prop15", + "type": "string", + "description": "Custom property variable 15." + }, + "xdm:prop16": { + "title": "prop16", + "type": "string", + "description": "Custom property variable 16." + }, + "xdm:prop17": { + "title": "prop17", + "type": "string", + "description": "Custom property variable 17." + }, + "xdm:prop18": { + "title": "prop18", + "type": "string", + "description": "Custom property variable 18." + }, + "xdm:prop19": { + "title": "prop19", + "type": "string", + "description": "Custom property variable 19." + }, + "xdm:prop20": { + "title": "prop20", + "type": "string", + "description": "Custom property variable 20." + }, + "xdm:prop21": { + "title": "prop21", + "type": "string", + "description": "Custom property variable 21." + }, + "xdm:prop22": { + "title": "prop22", + "type": "string", + "description": "Custom property variable 22." + }, + "xdm:prop23": { + "title": "prop23", + "type": "string", + "description": "Custom property variable 23." + }, + "xdm:prop24": { + "title": "prop24", + "type": "string", + "description": "Custom property variable 24." + }, + "xdm:prop25": { + "title": "prop25", + "type": "string", + "description": "Custom property variable 25." + }, + "xdm:prop26": { + "title": "prop26", + "type": "string", + "description": "Custom property variable 26." + }, + "xdm:prop27": { + "title": "prop27", + "type": "string", + "description": "Custom property variable 27." + }, + "xdm:prop28": { + "title": "prop28", + "type": "string", + "description": "Custom property variable 28." + }, + "xdm:prop29": { + "title": "prop29", + "type": "string", + "description": "Custom property variable 29." + }, + "xdm:prop30": { + "title": "prop30", + "type": "string", + "description": "Custom property variable 30." + }, + "xdm:prop31": { + "title": "prop31", + "type": "string", + "description": "Custom property variable 31." + }, + "xdm:prop32": { + "title": "prop32", + "type": "string", + "description": "Custom property variable 32." + }, + "xdm:prop33": { + "title": "prop33", + "type": "string", + "description": "Custom property variable 33." + }, + "xdm:prop34": { + "title": "prop34", + "type": "string", + "description": "Custom property variable 34." + }, + "xdm:prop35": { + "title": "prop35", + "type": "string", + "description": "Custom property variable 35." + }, + "xdm:prop36": { + "title": "prop36", + "type": "string", + "description": "Custom property variable 36." + }, + "xdm:prop37": { + "title": "prop37", + "type": "string", + "description": "Custom property variable 37." + }, + "xdm:prop38": { + "title": "prop38", + "type": "string", + "description": "Custom property variable 38." + }, + "xdm:prop39": { + "title": "prop39", + "type": "string", + "description": "Custom property variable 39." + }, + "xdm:prop40": { + "title": "prop40", + "type": "string", + "description": "Custom property variable 40." + }, + "xdm:prop41": { + "title": "prop41", + "type": "string", + "description": "Custom property variable 41." + }, + "xdm:prop42": { + "title": "prop42", + "type": "string", + "description": "Custom property variable 42." + }, + "xdm:prop43": { + "title": "prop43", + "type": "string", + "description": "Custom property variable 43." + }, + "xdm:prop44": { + "title": "prop44", + "type": "string", + "description": "Custom property variable 44." + }, + "xdm:prop45": { + "title": "prop45", + "type": "string", + "description": "Custom property variable 45." + }, + "xdm:prop46": { + "title": "prop46", + "type": "string", + "description": "Custom property variable 46." + }, + "xdm:prop47": { + "title": "prop47", + "type": "string", + "description": "Custom property variable 47." + }, + "xdm:prop48": { + "title": "prop48", + "type": "string", + "description": "Custom property variable 48." + }, + "xdm:prop49": { + "title": "prop49", + "type": "string", + "description": "Custom property variable 49." + }, + "xdm:prop50": { + "title": "prop50", + "type": "string", + "description": "Custom property variable 50." + }, + "xdm:prop51": { + "title": "prop51", + "type": "string", + "description": "Custom property variable 51." + }, + "xdm:prop52": { + "title": "prop52", + "type": "string", + "description": "Custom property variable 52." + }, + "xdm:prop53": { + "title": "prop53", + "type": "string", + "description": "Custom property variable 53." + }, + "xdm:prop54": { + "title": "prop54", + "type": "string", + "description": "Custom property variable 54." + }, + "xdm:prop55": { + "title": "prop55", + "type": "string", + "description": "Custom property variable 55." + }, + "xdm:prop56": { + "title": "prop56", + "type": "string", + "description": "Custom property variable 56." + }, + "xdm:prop57": { + "title": "prop57", + "type": "string", + "description": "Custom property variable 57." + }, + "xdm:prop58": { + "title": "prop58", + "type": "string", + "description": "Custom property variable 58." + }, + "xdm:prop59": { + "title": "prop59", + "type": "string", + "description": "Custom property variable 59." + }, + "xdm:prop60": { + "title": "prop60", + "type": "string", + "description": "Custom property variable 60." + }, + "xdm:prop61": { + "title": "prop61", + "type": "string", + "description": "Custom property variable 61." + }, + "xdm:prop62": { + "title": "prop62", + "type": "string", + "description": "Custom property variable 62." + }, + "xdm:prop63": { + "title": "prop63", + "type": "string", + "description": "Custom property variable 63." + }, + "xdm:prop64": { + "title": "prop64", + "type": "string", + "description": "Custom property variable 64." + }, + "xdm:prop65": { + "title": "prop65", + "type": "string", + "description": "Custom property variable 65." + }, + "xdm:prop66": { + "title": "prop66", + "type": "string", + "description": "Custom property variable 66." + }, + "xdm:prop67": { + "title": "prop67", + "type": "string", + "description": "Custom property variable 67." + }, + "xdm:prop68": { + "title": "prop68", + "type": "string", + "description": "Custom property variable 68." + }, + "xdm:prop69": { + "title": "prop69", + "type": "string", + "description": "Custom property variable 69." + }, + "xdm:prop70": { + "title": "prop70", + "type": "string", + "description": "Custom property variable 70." + }, + "xdm:prop71": { + "title": "prop71", + "type": "string", + "description": "Custom property variable 71." + }, + "xdm:prop72": { + "title": "prop72", + "type": "string", + "description": "Custom property variable 72." + }, + "xdm:prop73": { + "title": "prop73", + "type": "string", + "description": "Custom property variable 73." + }, + "xdm:prop74": { + "title": "prop74", + "type": "string", + "description": "Custom property variable 74." + }, + "xdm:prop75": { + "title": "prop75", + "type": "string", + "description": "Custom property variable 75." + } + } + }, + "xdm:listProps": { + "type": "object", + "title": "List Props", + "properties": { + "xdm:prop1": { + "title": "prop1", + "description": "Custom property variable1", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop2": { + "title": "prop2", + "description": "Custom property variable2", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop3": { + "title": "prop3", + "description": "Custom property variable3", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop4": { + "title": "prop4", + "description": "Custom property variable4", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop5": { + "title": "prop5", + "description": "Custom property variable5", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop6": { + "title": "prop6", + "description": "Custom property variable6", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop7": { + "title": "prop7", + "description": "Custom property variable7", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop8": { + "title": "prop8", + "description": "Custom property variable8", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop9": { + "title": "prop9", + "description": "Custom property variable9", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop10": { + "title": "prop10", + "description": "Custom property variable10", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop11": { + "title": "prop11", + "description": "Custom property variable11", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop12": { + "title": "prop12", + "description": "Custom property variable12", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop13": { + "title": "prop13", + "description": "Custom property variable13", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop14": { + "title": "prop14", + "description": "Custom property variable14", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop15": { + "title": "prop15", + "description": "Custom property variable15", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop16": { + "title": "prop16", + "description": "Custom property variable16", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop17": { + "title": "prop17", + "description": "Custom property variable17", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop18": { + "title": "prop18", + "description": "Custom property variable18", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop19": { + "title": "prop19", + "description": "Custom property variable19", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop20": { + "title": "prop20", + "description": "Custom property variable20", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop21": { + "title": "prop21", + "description": "Custom property variable21", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop22": { + "title": "prop22", + "description": "Custom property variable22", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop23": { + "title": "prop23", + "description": "Custom property variable23", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop24": { + "title": "prop24", + "description": "Custom property variable24", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop25": { + "title": "prop25", + "description": "Custom property variable25", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop26": { + "title": "prop26", + "description": "Custom property variable26", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop27": { + "title": "prop27", + "description": "Custom property variable27", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop28": { + "title": "prop28", + "description": "Custom property variable28", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop29": { + "title": "prop29", + "description": "Custom property variable29", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop30": { + "title": "prop30", + "description": "Custom property variable30", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop31": { + "title": "prop31", + "description": "Custom property variable31", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop32": { + "title": "prop32", + "description": "Custom property variable32", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop33": { + "title": "prop33", + "description": "Custom property variable33", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop34": { + "title": "prop34", + "description": "Custom property variable34", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop35": { + "title": "prop35", + "description": "Custom property variable35", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop36": { + "title": "prop36", + "description": "Custom property variable36", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop37": { + "title": "prop37", + "description": "Custom property variable37", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop38": { + "title": "prop38", + "description": "Custom property variable38", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop39": { + "title": "prop39", + "description": "Custom property variable39", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop40": { + "title": "prop40", + "description": "Custom property variable40", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop41": { + "title": "prop41", + "description": "Custom property variable41", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop42": { + "title": "prop42", + "description": "Custom property variable42", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop43": { + "title": "prop43", + "description": "Custom property variable43", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop44": { + "title": "prop44", + "description": "Custom property variable44", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop45": { + "title": "prop45", + "description": "Custom property variable45", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop46": { + "title": "prop46", + "description": "Custom property variable46", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop47": { + "title": "prop47", + "description": "Custom property variable47", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop48": { + "title": "prop48", + "description": "Custom property variable48", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop49": { + "title": "prop49", + "description": "Custom property variable49", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop50": { + "title": "prop50", + "description": "Custom property variable50", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop51": { + "title": "prop51", + "description": "Custom property variable51", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop52": { + "title": "prop52", + "description": "Custom property variable52", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop53": { + "title": "prop53", + "description": "Custom property variable53", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop54": { + "title": "prop54", + "description": "Custom property variable54", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop55": { + "title": "prop55", + "description": "Custom property variable55", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop56": { + "title": "prop56", + "description": "Custom property variable56", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop57": { + "title": "prop57", + "description": "Custom property variable57", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop58": { + "title": "prop58", + "description": "Custom property variable58", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop59": { + "title": "prop59", + "description": "Custom property variable59", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop60": { + "title": "prop60", + "description": "Custom property variable60", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop61": { + "title": "prop61", + "description": "Custom property variable61", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop62": { + "title": "prop62", + "description": "Custom property variable62", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop63": { + "title": "prop63", + "description": "Custom property variable63", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop64": { + "title": "prop64", + "description": "Custom property variable64", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop65": { + "title": "prop65", + "description": "Custom property variable65", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop66": { + "title": "prop66", + "description": "Custom property variable66", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop67": { + "title": "prop67", + "description": "Custom property variable67", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop68": { + "title": "prop68", + "description": "Custom property variable68", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop69": { + "title": "prop69", + "description": "Custom property variable69", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop70": { + "title": "prop70", + "description": "Custom property variable70", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop71": { + "title": "prop71", + "description": "Custom property variable71", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop72": { + "title": "prop72", + "description": "Custom property variable72", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop73": { + "title": "prop73", + "description": "Custom property variable73", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop74": { + "title": "prop74", + "description": "Custom property variable74", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop75": { + "title": "prop75", + "description": "Custom property variable75", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + } + } + }, + "xdm:hierarchies": { + "type": "object", + "title": "Hierarchies", + "properties": { + "xdm:hier1": { + "title": "hier1", + "description": "Custom hierarchy variable 1.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:hier2": { + "title": "hier2", + "description": "Custom hierarchy variable 2.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:hier3": { + "title": "hier3", + "description": "Custom hierarchy variable 3.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:hier4": { + "title": "hier4", + "description": "Custom hierarchy variable 4.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:hier5": { + "title": "hier5", + "description": "Custom hierarchy variable 5.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + } + } + }, + "xdm:lists": { + "type": "object", + "title": "Custom List Variables", + "properties": { + "xdm:list1": { + "title": "List 1", + "description": "Custom list variable 1.", + "$ref": "https://ns.adobe.com/experience/analytics/keyedlist" + }, + "xdm:list2": { + "title": "List 2", + "description": "Custom list variable 2.", + "$ref": "https://ns.adobe.com/experience/analytics/keyedlist" + }, + "xdm:list3": { + "title": "List 3", + "description": "Custom list variable 3.", + "$ref": "https://ns.adobe.com/experience/analytics/keyedlist" + } + } + }, + "xdm:stateProvince": { + "title": "state", + "type": "string", + "description": "Client supplied state or province location." + }, + "xdm:postalCode": { + "title": "zip", + "type": "string", + "description": "Client supplied zip code/postal code." + } + } + }, + "https://ns.adobe.com/experience/analytics/event1to100": { + "title": "Event 1 to 100", + "$ref": "https://ns.adobe.com/experience/analytics/event1to100" + }, + "https://ns.adobe.com/experience/analytics/event101to200": { + "title": "Event 101 to 200", + "$ref": "https://ns.adobe.com/experience/analytics/event101to200" + }, + "https://ns.adobe.com/experience/analytics/event201to300": { + "title": "Event 201 to 300", + "$ref": "https://ns.adobe.com/experience/analytics/event201to300" + }, + "https://ns.adobe.com/experience/analytics/event301to400": { + "title": "Event 301 to 400", + "$ref": "https://ns.adobe.com/experience/analytics/event301to400" + }, + "https://ns.adobe.com/experience/analytics/event401to500": { + "title": "Event 401 to 500", + "$ref": "https://ns.adobe.com/experience/analytics/event401to500" + }, + "https://ns.adobe.com/experience/analytics/event501to600": { + "title": "Event 501 to 600", + "$ref": "https://ns.adobe.com/experience/analytics/event501to600" + }, + "https://ns.adobe.com/experience/analytics/event601to700": { + "title": "Event 601 to 700", + "$ref": "https://ns.adobe.com/experience/analytics/event601to700" + }, + "https://ns.adobe.com/experience/analytics/event701to800": { + "title": "Event 701 to 800", + "$ref": "https://ns.adobe.com/experience/analytics/event701to800" + }, + "https://ns.adobe.com/experience/analytics/event801to900": { + "title": "Event 801 to 900", + "$ref": "https://ns.adobe.com/experience/analytics/event801to900" + }, + "https://ns.adobe.com/experience/analytics/event901to1000": { + "title": "Event 901 to 1000", + "$ref": "https://ns.adobe.com/experience/analytics/event901to1000" + }, + "https://ns.adobe.com/experience/analytics/environment": { + "type": "object", + "title": "Environment", + "properties": { + "xdm:browserID": { + "title": "Browser ID", + "meta:status": "deprecated", + "type": "integer", + "description": "The Adobe Analytics identifier for the browser used. Deprecated, use xdm:browserIDStr instead." + }, + "xdm:operatingSystemID": { + "title": "Operating System ID", + "meta:status": "deprecated", + "type": "integer", + "description": "The Adobe Analytics identifier of the operating system used. Deprecated, use xdm:operatingSystemIDStr instead." + }, + "xdm:browserIDStr": { + "title": "Browser ID", + "type": "string", + "pattern": "^[0-9]+", + "description": "The Adobe Analytics identifier for the browser used." + }, + "xdm:operatingSystemIDStr": { + "title": "Operating System ID", + "type": "string", + "pattern": "^[0-9]+", + "description": "The Adobe Analytics identifier of the operating system used." + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/experienceevent" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/experienceevent-all.schema.md b/docs/reference/adobe/experience/analytics/experienceevent-all.schema.md new file mode 100644 index 000000000..623a540a3 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/experienceevent-all.schema.md @@ -0,0 +1,2632 @@ + +# Adobe Analytics ExperienceEvent Full Extension Schema + +``` +https://ns.adobe.com/experience/analytics/experienceevent-all +``` + +Adobe Analytics ExperienceEvent full extension. Contains all Solution added fields. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/experienceevent-all.schema.json](adobe/experience/analytics/experienceevent-all.schema.json) | +## Schema Hierarchy + +* Adobe Analytics ExperienceEvent Full Extension `https://ns.adobe.com/experience/analytics/experienceevent-all` + * [session.schema](session.schema.md) `https://ns.adobe.com/experience/analytics/session` + * [endUser.schema](endUser.schema.md) `https://ns.adobe.com/experience/analytics/endUser` + * [event1to100.schema](event1to100.schema.md) `https://ns.adobe.com/experience/analytics/event1to100` + * [event101to200.schema](event101to200.schema.md) `https://ns.adobe.com/experience/analytics/event101to200` + * [event201to300.schema](event201to300.schema.md) `https://ns.adobe.com/experience/analytics/event201to300` + * [event301to400.schema](event301to400.schema.md) `https://ns.adobe.com/experience/analytics/event301to400` + * [event401to500.schema](event401to500.schema.md) `https://ns.adobe.com/experience/analytics/event401to500` + * [event501to600.schema](event501to600.schema.md) `https://ns.adobe.com/experience/analytics/event501to600` + * [event601to700.schema](event601to700.schema.md) `https://ns.adobe.com/experience/analytics/event601to700` + * [event701to800.schema](event701to800.schema.md) `https://ns.adobe.com/experience/analytics/event701to800` + * [event801to900.schema](event801to900.schema.md) `https://ns.adobe.com/experience/analytics/event801to900` + * [event901to1000.schema](event901to1000.schema.md) `https://ns.adobe.com/experience/analytics/event901to1000` + + +# Adobe Analytics ExperienceEvent Full Extension Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/analytics/customDimensions](#httpsnsadobecomexperienceanalyticscustomdimensions) | `object` | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/endUser](#httpsnsadobecomexperienceanalyticsenduser) | endUser.schema | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/environment](#httpsnsadobecomexperienceanalyticsenvironment) | `object` | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/event101to200](#httpsnsadobecomexperienceanalyticsevent101to200) | event101to200.schema | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/event1to100](#httpsnsadobecomexperienceanalyticsevent1to100) | event1to100.schema | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/event201to300](#httpsnsadobecomexperienceanalyticsevent201to300) | event201to300.schema | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/event301to400](#httpsnsadobecomexperienceanalyticsevent301to400) | event301to400.schema | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/event401to500](#httpsnsadobecomexperienceanalyticsevent401to500) | event401to500.schema | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/event501to600](#httpsnsadobecomexperienceanalyticsevent501to600) | event501to600.schema | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/event601to700](#httpsnsadobecomexperienceanalyticsevent601to700) | event601to700.schema | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/event701to800](#httpsnsadobecomexperienceanalyticsevent701to800) | event701to800.schema | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/event801to900](#httpsnsadobecomexperienceanalyticsevent801to900) | event801to900.schema | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/event901to1000](#httpsnsadobecomexperienceanalyticsevent901to1000) | event901to1000.schema | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/analytics/session](#httpsnsadobecomexperienceanalyticssession) | session.schema | Optional | Adobe Analytics ExperienceEvent Full Extension (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/analytics/customDimensions +### Custom Dimensions + +`https://ns.adobe.com/experience/analytics/customDimensions` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/analytics/customDimensions Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:eVars`| object | Optional | +| `xdm:hierarchies`| object | Optional | +| `xdm:listProps`| object | Optional | +| `xdm:lists`| object | Optional | +| `xdm:postalCode`| string | Optional | +| `xdm:props`| object | Optional | +| `xdm:stateProvince`| string | Optional | + + + +#### xdm:eVars +##### eVars + +undefined + +`xdm:eVars` +* is optional +* type: `object` + +##### xdm:eVars Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "eVars", + "properties": { + "xdm:eVar1": { + "title": "eVar1", + "type": "string", + "description": "Custom conversion variable 1." + }, + "xdm:eVar2": { + "title": "eVar2", + "type": "string", + "description": "Custom conversion variable 2." + }, + "xdm:eVar3": { + "title": "eVar3", + "type": "string", + "description": "Custom conversion variable 3." + }, + "xdm:eVar4": { + "title": "eVar4", + "type": "string", + "description": "Custom conversion variable 4." + }, + "xdm:eVar5": { + "title": "eVar5", + "type": "string", + "description": "Custom conversion variable 5." + }, + "xdm:eVar6": { + "title": "eVar6", + "type": "string", + "description": "Custom conversion variable 6." + }, + "xdm:eVar7": { + "title": "eVar7", + "type": "string", + "description": "Custom conversion variable 7." + }, + "xdm:eVar8": { + "title": "eVar8", + "type": "string", + "description": "Custom conversion variable 8." + }, + "xdm:eVar9": { + "title": "eVar9", + "type": "string", + "description": "Custom conversion variable 9." + }, + "xdm:eVar10": { + "title": "eVar10", + "type": "string", + "description": "Custom conversion variable 10." + }, + "xdm:eVar11": { + "title": "eVar11", + "type": "string", + "description": "Custom conversion variable 11." + }, + "xdm:eVar12": { + "title": "eVar12", + "type": "string", + "description": "Custom conversion variable 12." + }, + "xdm:eVar13": { + "title": "eVar13", + "type": "string", + "description": "Custom conversion variable 13." + }, + "xdm:eVar14": { + "title": "eVar14", + "type": "string", + "description": "Custom conversion variable 14." + }, + "xdm:eVar15": { + "title": "eVar15", + "type": "string", + "description": "Custom conversion variable 15." + }, + "xdm:eVar16": { + "title": "eVar16", + "type": "string", + "description": "Custom conversion variable 16." + }, + "xdm:eVar17": { + "title": "eVar17", + "type": "string", + "description": "Custom conversion variable 17." + }, + "xdm:eVar18": { + "title": "eVar18", + "type": "string", + "description": "Custom conversion variable 18." + }, + "xdm:eVar19": { + "title": "eVar19", + "type": "string", + "description": "Custom conversion variable 19." + }, + "xdm:eVar20": { + "title": "eVar20", + "type": "string", + "description": "Custom conversion variable 20." + }, + "xdm:eVar21": { + "title": "eVar21", + "type": "string", + "description": "Custom conversion variable 21." + }, + "xdm:eVar22": { + "title": "eVar22", + "type": "string", + "description": "Custom conversion variable 22." + }, + "xdm:eVar23": { + "title": "eVar23", + "type": "string", + "description": "Custom conversion variable 23." + }, + "xdm:eVar24": { + "title": "eVar24", + "type": "string", + "description": "Custom conversion variable 24." + }, + "xdm:eVar25": { + "title": "eVar25", + "type": "string", + "description": "Custom conversion variable 25." + }, + "xdm:eVar26": { + "title": "eVar26", + "type": "string", + "description": "Custom conversion variable 26." + }, + "xdm:eVar27": { + "title": "eVar27", + "type": "string", + "description": "Custom conversion variable 27." + }, + "xdm:eVar28": { + "title": "eVar28", + "type": "string", + "description": "Custom conversion variable 28." + }, + "xdm:eVar29": { + "title": "eVar29", + "type": "string", + "description": "Custom conversion variable 29." + }, + "xdm:eVar30": { + "title": "eVar30", + "type": "string", + "description": "Custom conversion variable 30." + }, + "xdm:eVar31": { + "title": "eVar31", + "type": "string", + "description": "Custom conversion variable 31." + }, + "xdm:eVar32": { + "title": "eVar32", + "type": "string", + "description": "Custom conversion variable 32." + }, + "xdm:eVar33": { + "title": "eVar33", + "type": "string", + "description": "Custom conversion variable 33." + }, + "xdm:eVar34": { + "title": "eVar34", + "type": "string", + "description": "Custom conversion variable 34." + }, + "xdm:eVar35": { + "title": "eVar35", + "type": "string", + "description": "Custom conversion variable 35." + }, + "xdm:eVar36": { + "title": "eVar36", + "type": "string", + "description": "Custom conversion variable 36." + }, + "xdm:eVar37": { + "title": "eVar37", + "type": "string", + "description": "Custom conversion variable 37." + }, + "xdm:eVar38": { + "title": "eVar38", + "type": "string", + "description": "Custom conversion variable 38." + }, + "xdm:eVar39": { + "title": "eVar39", + "type": "string", + "description": "Custom conversion variable 39." + }, + "xdm:eVar40": { + "title": "eVar40", + "type": "string", + "description": "Custom conversion variable 40." + }, + "xdm:eVar41": { + "title": "eVar41", + "type": "string", + "description": "Custom conversion variable 41." + }, + "xdm:eVar42": { + "title": "eVar42", + "type": "string", + "description": "Custom conversion variable 42." + }, + "xdm:eVar43": { + "title": "eVar43", + "type": "string", + "description": "Custom conversion variable 43." + }, + "xdm:eVar44": { + "title": "eVar44", + "type": "string", + "description": "Custom conversion variable 44." + }, + "xdm:eVar45": { + "title": "eVar45", + "type": "string", + "description": "Custom conversion variable 45." + }, + "xdm:eVar46": { + "title": "eVar46", + "type": "string", + "description": "Custom conversion variable 46." + }, + "xdm:eVar47": { + "title": "eVar47", + "type": "string", + "description": "Custom conversion variable 47." + }, + "xdm:eVar48": { + "title": "eVar48", + "type": "string", + "description": "Custom conversion variable 48." + }, + "xdm:eVar49": { + "title": "eVar49", + "type": "string", + "description": "Custom conversion variable 49." + }, + "xdm:eVar50": { + "title": "eVar50", + "type": "string", + "description": "Custom conversion variable 50." + }, + "xdm:eVar51": { + "title": "eVar51", + "type": "string", + "description": "Custom conversion variable 51." + }, + "xdm:eVar52": { + "title": "eVar52", + "type": "string", + "description": "Custom conversion variable 52." + }, + "xdm:eVar53": { + "title": "eVar53", + "type": "string", + "description": "Custom conversion variable 53." + }, + "xdm:eVar54": { + "title": "eVar54", + "type": "string", + "description": "Custom conversion variable 54." + }, + "xdm:eVar55": { + "title": "eVar55", + "type": "string", + "description": "Custom conversion variable 55." + }, + "xdm:eVar56": { + "title": "eVar56", + "type": "string", + "description": "Custom conversion variable 56." + }, + "xdm:eVar57": { + "title": "eVar57", + "type": "string", + "description": "Custom conversion variable 57." + }, + "xdm:eVar58": { + "title": "eVar58", + "type": "string", + "description": "Custom conversion variable 58." + }, + "xdm:eVar59": { + "title": "eVar59", + "type": "string", + "description": "Custom conversion variable 59." + }, + "xdm:eVar60": { + "title": "eVar60", + "type": "string", + "description": "Custom conversion variable 60." + }, + "xdm:eVar61": { + "title": "eVar61", + "type": "string", + "description": "Custom conversion variable 61." + }, + "xdm:eVar62": { + "title": "eVar62", + "type": "string", + "description": "Custom conversion variable 62." + }, + "xdm:eVar63": { + "title": "eVar63", + "type": "string", + "description": "Custom conversion variable 63." + }, + "xdm:eVar64": { + "title": "eVar64", + "type": "string", + "description": "Custom conversion variable 64." + }, + "xdm:eVar65": { + "title": "eVar65", + "type": "string", + "description": "Custom conversion variable 65." + }, + "xdm:eVar66": { + "title": "eVar66", + "type": "string", + "description": "Custom conversion variable 66." + }, + "xdm:eVar67": { + "title": "eVar67", + "type": "string", + "description": "Custom conversion variable 67." + }, + "xdm:eVar68": { + "title": "eVar68", + "type": "string", + "description": "Custom conversion variable 68." + }, + "xdm:eVar69": { + "title": "eVar69", + "type": "string", + "description": "Custom conversion variable 69." + }, + "xdm:eVar70": { + "title": "eVar70", + "type": "string", + "description": "Custom conversion variable 70." + }, + "xdm:eVar71": { + "title": "eVar71", + "type": "string", + "description": "Custom conversion variable 71." + }, + "xdm:eVar72": { + "title": "eVar72", + "type": "string", + "description": "Custom conversion variable 72." + }, + "xdm:eVar73": { + "title": "eVar73", + "type": "string", + "description": "Custom conversion variable 73." + }, + "xdm:eVar74": { + "title": "eVar74", + "type": "string", + "description": "Custom conversion variable 74." + }, + "xdm:eVar75": { + "title": "eVar75", + "type": "string", + "description": "Custom conversion variable 75." + }, + "xdm:eVar76": { + "title": "eVar76", + "type": "string", + "description": "Custom conversion variable 76." + }, + "xdm:eVar77": { + "title": "eVar77", + "type": "string", + "description": "Custom conversion variable 77." + }, + "xdm:eVar78": { + "title": "eVar78", + "type": "string", + "description": "Custom conversion variable 78." + }, + "xdm:eVar79": { + "title": "eVar79", + "type": "string", + "description": "Custom conversion variable 79." + }, + "xdm:eVar80": { + "title": "eVar80", + "type": "string", + "description": "Custom conversion variable 80." + }, + "xdm:eVar81": { + "title": "eVar81", + "type": "string", + "description": "Custom conversion variable 81." + }, + "xdm:eVar82": { + "title": "eVar82", + "type": "string", + "description": "Custom conversion variable 82." + }, + "xdm:eVar83": { + "title": "eVar83", + "type": "string", + "description": "Custom conversion variable 83." + }, + "xdm:eVar84": { + "title": "eVar84", + "type": "string", + "description": "Custom conversion variable 84." + }, + "xdm:eVar85": { + "title": "eVar85", + "type": "string", + "description": "Custom conversion variable 85." + }, + "xdm:eVar86": { + "title": "eVar86", + "type": "string", + "description": "Custom conversion variable 86." + }, + "xdm:eVar87": { + "title": "eVar87", + "type": "string", + "description": "Custom conversion variable 87." + }, + "xdm:eVar88": { + "title": "eVar88", + "type": "string", + "description": "Custom conversion variable 88." + }, + "xdm:eVar89": { + "title": "eVar89", + "type": "string", + "description": "Custom conversion variable 89." + }, + "xdm:eVar90": { + "title": "eVar90", + "type": "string", + "description": "Custom conversion variable 90." + }, + "xdm:eVar91": { + "title": "eVar91", + "type": "string", + "description": "Custom conversion variable 91." + }, + "xdm:eVar92": { + "title": "eVar92", + "type": "string", + "description": "Custom conversion variable 92." + }, + "xdm:eVar93": { + "title": "eVar93", + "type": "string", + "description": "Custom conversion variable 93." + }, + "xdm:eVar94": { + "title": "eVar94", + "type": "string", + "description": "Custom conversion variable 94." + }, + "xdm:eVar95": { + "title": "eVar95", + "type": "string", + "description": "Custom conversion variable 95." + }, + "xdm:eVar96": { + "title": "eVar96", + "type": "string", + "description": "Custom conversion variable 96." + }, + "xdm:eVar97": { + "title": "eVar97", + "type": "string", + "description": "Custom conversion variable 97." + }, + "xdm:eVar98": { + "title": "eVar98", + "type": "string", + "description": "Custom conversion variable 98." + }, + "xdm:eVar99": { + "title": "eVar99", + "type": "string", + "description": "Custom conversion variable 99." + }, + "xdm:eVar100": { + "title": "eVar100", + "type": "string", + "description": "Custom conversion variable 100." + }, + "xdm:eVar101": { + "title": "eVar101", + "type": "string", + "description": "Custom conversion variable 101." + }, + "xdm:eVar102": { + "title": "eVar102", + "type": "string", + "description": "Custom conversion variable 102." + }, + "xdm:eVar103": { + "title": "eVar103", + "type": "string", + "description": "Custom conversion variable 103." + }, + "xdm:eVar104": { + "title": "eVar104", + "type": "string", + "description": "Custom conversion variable 104." + }, + "xdm:eVar105": { + "title": "eVar105", + "type": "string", + "description": "Custom conversion variable 105." + }, + "xdm:eVar106": { + "title": "eVar106", + "type": "string", + "description": "Custom conversion variable 106." + }, + "xdm:eVar107": { + "title": "eVar107", + "type": "string", + "description": "Custom conversion variable 107." + }, + "xdm:eVar108": { + "title": "eVar108", + "type": "string", + "description": "Custom conversion variable 108." + }, + "xdm:eVar109": { + "title": "eVar109", + "type": "string", + "description": "Custom conversion variable 109." + }, + "xdm:eVar110": { + "title": "eVar110", + "type": "string", + "description": "Custom conversion variable 110." + }, + "xdm:eVar111": { + "title": "eVar111", + "type": "string", + "description": "Custom conversion variable 111." + }, + "xdm:eVar112": { + "title": "eVar112", + "type": "string", + "description": "Custom conversion variable 112." + }, + "xdm:eVar113": { + "title": "eVar113", + "type": "string", + "description": "Custom conversion variable 113." + }, + "xdm:eVar114": { + "title": "eVar114", + "type": "string", + "description": "Custom conversion variable 114." + }, + "xdm:eVar115": { + "title": "eVar115", + "type": "string", + "description": "Custom conversion variable 115." + }, + "xdm:eVar116": { + "title": "eVar116", + "type": "string", + "description": "Custom conversion variable 116." + }, + "xdm:eVar117": { + "title": "eVar117", + "type": "string", + "description": "Custom conversion variable 117." + }, + "xdm:eVar118": { + "title": "eVar118", + "type": "string", + "description": "Custom conversion variable 118." + }, + "xdm:eVar119": { + "title": "eVar119", + "type": "string", + "description": "Custom conversion variable 119." + }, + "xdm:eVar120": { + "title": "eVar120", + "type": "string", + "description": "Custom conversion variable 120." + }, + "xdm:eVar121": { + "title": "eVar121", + "type": "string", + "description": "Custom conversion variable 121." + }, + "xdm:eVar122": { + "title": "eVar122", + "type": "string", + "description": "Custom conversion variable 122." + }, + "xdm:eVar123": { + "title": "eVar123", + "type": "string", + "description": "Custom conversion variable 123." + }, + "xdm:eVar124": { + "title": "eVar124", + "type": "string", + "description": "Custom conversion variable 124." + }, + "xdm:eVar125": { + "title": "eVar125", + "type": "string", + "description": "Custom conversion variable 125." + }, + "xdm:eVar126": { + "title": "eVar126", + "type": "string", + "description": "Custom conversion variable 126." + }, + "xdm:eVar127": { + "title": "eVar127", + "type": "string", + "description": "Custom conversion variable 127." + }, + "xdm:eVar128": { + "title": "eVar128", + "type": "string", + "description": "Custom conversion variable 128." + }, + "xdm:eVar129": { + "title": "eVar129", + "type": "string", + "description": "Custom conversion variable 129." + }, + "xdm:eVar130": { + "title": "eVar130", + "type": "string", + "description": "Custom conversion variable 130." + }, + "xdm:eVar131": { + "title": "eVar131", + "type": "string", + "description": "Custom conversion variable 131." + }, + "xdm:eVar132": { + "title": "eVar132", + "type": "string", + "description": "Custom conversion variable 132." + }, + "xdm:eVar133": { + "title": "eVar133", + "type": "string", + "description": "Custom conversion variable 133." + }, + "xdm:eVar134": { + "title": "eVar134", + "type": "string", + "description": "Custom conversion variable 134." + }, + "xdm:eVar135": { + "title": "eVar135", + "type": "string", + "description": "Custom conversion variable 135." + }, + "xdm:eVar136": { + "title": "eVar136", + "type": "string", + "description": "Custom conversion variable 136." + }, + "xdm:eVar137": { + "title": "eVar137", + "type": "string", + "description": "Custom conversion variable 137." + }, + "xdm:eVar138": { + "title": "eVar138", + "type": "string", + "description": "Custom conversion variable 138." + }, + "xdm:eVar139": { + "title": "eVar139", + "type": "string", + "description": "Custom conversion variable 139." + }, + "xdm:eVar140": { + "title": "eVar140", + "type": "string", + "description": "Custom conversion variable 140." + }, + "xdm:eVar141": { + "title": "eVar141", + "type": "string", + "description": "Custom conversion variable 141." + }, + "xdm:eVar142": { + "title": "eVar142", + "type": "string", + "description": "Custom conversion variable 142." + }, + "xdm:eVar143": { + "title": "eVar143", + "type": "string", + "description": "Custom conversion variable 143." + }, + "xdm:eVar144": { + "title": "eVar144", + "type": "string", + "description": "Custom conversion variable 144." + }, + "xdm:eVar145": { + "title": "eVar145", + "type": "string", + "description": "Custom conversion variable 145." + }, + "xdm:eVar146": { + "title": "eVar146", + "type": "string", + "description": "Custom conversion variable 146." + }, + "xdm:eVar147": { + "title": "eVar147", + "type": "string", + "description": "Custom conversion variable 147." + }, + "xdm:eVar148": { + "title": "eVar148", + "type": "string", + "description": "Custom conversion variable 148." + }, + "xdm:eVar149": { + "title": "eVar149", + "type": "string", + "description": "Custom conversion variable 149." + }, + "xdm:eVar150": { + "title": "eVar150", + "type": "string", + "description": "Custom conversion variable 150." + }, + "xdm:eVar151": { + "title": "eVar151", + "type": "string", + "description": "Custom conversion variable 151." + }, + "xdm:eVar152": { + "title": "eVar152", + "type": "string", + "description": "Custom conversion variable 152." + }, + "xdm:eVar153": { + "title": "eVar153", + "type": "string", + "description": "Custom conversion variable 153." + }, + "xdm:eVar154": { + "title": "eVar154", + "type": "string", + "description": "Custom conversion variable 154." + }, + "xdm:eVar155": { + "title": "eVar155", + "type": "string", + "description": "Custom conversion variable 155." + }, + "xdm:eVar156": { + "title": "eVar156", + "type": "string", + "description": "Custom conversion variable 156." + }, + "xdm:eVar157": { + "title": "eVar157", + "type": "string", + "description": "Custom conversion variable 157." + }, + "xdm:eVar158": { + "title": "eVar158", + "type": "string", + "description": "Custom conversion variable 158." + }, + "xdm:eVar159": { + "title": "eVar159", + "type": "string", + "description": "Custom conversion variable 159." + }, + "xdm:eVar160": { + "title": "eVar160", + "type": "string", + "description": "Custom conversion variable 160." + }, + "xdm:eVar161": { + "title": "eVar161", + "type": "string", + "description": "Custom conversion variable 161." + }, + "xdm:eVar162": { + "title": "eVar162", + "type": "string", + "description": "Custom conversion variable 162." + }, + "xdm:eVar163": { + "title": "eVar163", + "type": "string", + "description": "Custom conversion variable 163." + }, + "xdm:eVar164": { + "title": "eVar164", + "type": "string", + "description": "Custom conversion variable 164." + }, + "xdm:eVar165": { + "title": "eVar165", + "type": "string", + "description": "Custom conversion variable 165." + }, + "xdm:eVar166": { + "title": "eVar166", + "type": "string", + "description": "Custom conversion variable 166." + }, + "xdm:eVar167": { + "title": "eVar167", + "type": "string", + "description": "Custom conversion variable 167." + }, + "xdm:eVar168": { + "title": "eVar168", + "type": "string", + "description": "Custom conversion variable 168." + }, + "xdm:eVar169": { + "title": "eVar169", + "type": "string", + "description": "Custom conversion variable 169." + }, + "xdm:eVar170": { + "title": "eVar170", + "type": "string", + "description": "Custom conversion variable 170." + }, + "xdm:eVar171": { + "title": "eVar171", + "type": "string", + "description": "Custom conversion variable 171." + }, + "xdm:eVar172": { + "title": "eVar172", + "type": "string", + "description": "Custom conversion variable 172." + }, + "xdm:eVar173": { + "title": "eVar173", + "type": "string", + "description": "Custom conversion variable 173." + }, + "xdm:eVar174": { + "title": "eVar174", + "type": "string", + "description": "Custom conversion variable 174." + }, + "xdm:eVar175": { + "title": "eVar175", + "type": "string", + "description": "Custom conversion variable 175." + }, + "xdm:eVar176": { + "title": "eVar176", + "type": "string", + "description": "Custom conversion variable 176." + }, + "xdm:eVar177": { + "title": "eVar177", + "type": "string", + "description": "Custom conversion variable 177." + }, + "xdm:eVar178": { + "title": "eVar178", + "type": "string", + "description": "Custom conversion variable 178." + }, + "xdm:eVar179": { + "title": "eVar179", + "type": "string", + "description": "Custom conversion variable 179." + }, + "xdm:eVar180": { + "title": "eVar180", + "type": "string", + "description": "Custom conversion variable 180." + }, + "xdm:eVar181": { + "title": "eVar181", + "type": "string", + "description": "Custom conversion variable 181." + }, + "xdm:eVar182": { + "title": "eVar182", + "type": "string", + "description": "Custom conversion variable 182." + }, + "xdm:eVar183": { + "title": "eVar183", + "type": "string", + "description": "Custom conversion variable 183." + }, + "xdm:eVar184": { + "title": "eVar184", + "type": "string", + "description": "Custom conversion variable 184." + }, + "xdm:eVar185": { + "title": "eVar185", + "type": "string", + "description": "Custom conversion variable 185." + }, + "xdm:eVar186": { + "title": "eVar186", + "type": "string", + "description": "Custom conversion variable 186." + }, + "xdm:eVar187": { + "title": "eVar187", + "type": "string", + "description": "Custom conversion variable 187." + }, + "xdm:eVar188": { + "title": "eVar188", + "type": "string", + "description": "Custom conversion variable 188." + }, + "xdm:eVar189": { + "title": "eVar189", + "type": "string", + "description": "Custom conversion variable 189." + }, + "xdm:eVar190": { + "title": "eVar190", + "type": "string", + "description": "Custom conversion variable 190." + }, + "xdm:eVar191": { + "title": "eVar191", + "type": "string", + "description": "Custom conversion variable 191." + }, + "xdm:eVar192": { + "title": "eVar192", + "type": "string", + "description": "Custom conversion variable 192." + }, + "xdm:eVar193": { + "title": "eVar193", + "type": "string", + "description": "Custom conversion variable 193." + }, + "xdm:eVar194": { + "title": "eVar194", + "type": "string", + "description": "Custom conversion variable 194." + }, + "xdm:eVar195": { + "title": "eVar195", + "type": "string", + "description": "Custom conversion variable 195." + }, + "xdm:eVar196": { + "title": "eVar196", + "type": "string", + "description": "Custom conversion variable 196." + }, + "xdm:eVar197": { + "title": "eVar197", + "type": "string", + "description": "Custom conversion variable 197." + }, + "xdm:eVar198": { + "title": "eVar198", + "type": "string", + "description": "Custom conversion variable 198." + }, + "xdm:eVar199": { + "title": "eVar199", + "type": "string", + "description": "Custom conversion variable 199." + }, + "xdm:eVar200": { + "title": "eVar200", + "type": "string", + "description": "Custom conversion variable 200." + }, + "xdm:eVar201": { + "title": "eVar201", + "type": "string", + "description": "Custom conversion variable 201." + }, + "xdm:eVar202": { + "title": "eVar202", + "type": "string", + "description": "Custom conversion variable 202." + }, + "xdm:eVar203": { + "title": "eVar203", + "type": "string", + "description": "Custom conversion variable 203." + }, + "xdm:eVar204": { + "title": "eVar204", + "type": "string", + "description": "Custom conversion variable 204." + }, + "xdm:eVar205": { + "title": "eVar205", + "type": "string", + "description": "Custom conversion variable 205." + }, + "xdm:eVar206": { + "title": "eVar206", + "type": "string", + "description": "Custom conversion variable 206." + }, + "xdm:eVar207": { + "title": "eVar207", + "type": "string", + "description": "Custom conversion variable 207." + }, + "xdm:eVar208": { + "title": "eVar208", + "type": "string", + "description": "Custom conversion variable 208." + }, + "xdm:eVar209": { + "title": "eVar209", + "type": "string", + "description": "Custom conversion variable 209." + }, + "xdm:eVar210": { + "title": "eVar210", + "type": "string", + "description": "Custom conversion variable 210." + }, + "xdm:eVar211": { + "title": "eVar211", + "type": "string", + "description": "Custom conversion variable 211." + }, + "xdm:eVar212": { + "title": "eVar212", + "type": "string", + "description": "Custom conversion variable 212." + }, + "xdm:eVar213": { + "title": "eVar213", + "type": "string", + "description": "Custom conversion variable 213." + }, + "xdm:eVar214": { + "title": "eVar214", + "type": "string", + "description": "Custom conversion variable 214." + }, + "xdm:eVar215": { + "title": "eVar215", + "type": "string", + "description": "Custom conversion variable 215." + }, + "xdm:eVar216": { + "title": "eVar216", + "type": "string", + "description": "Custom conversion variable 216." + }, + "xdm:eVar217": { + "title": "eVar217", + "type": "string", + "description": "Custom conversion variable 217." + }, + "xdm:eVar218": { + "title": "eVar218", + "type": "string", + "description": "Custom conversion variable 218." + }, + "xdm:eVar219": { + "title": "eVar219", + "type": "string", + "description": "Custom conversion variable 219." + }, + "xdm:eVar220": { + "title": "eVar220", + "type": "string", + "description": "Custom conversion variable 220." + }, + "xdm:eVar221": { + "title": "eVar221", + "type": "string", + "description": "Custom conversion variable 221." + }, + "xdm:eVar222": { + "title": "eVar222", + "type": "string", + "description": "Custom conversion variable 222." + }, + "xdm:eVar223": { + "title": "eVar223", + "type": "string", + "description": "Custom conversion variable 223." + }, + "xdm:eVar224": { + "title": "eVar224", + "type": "string", + "description": "Custom conversion variable 224." + }, + "xdm:eVar225": { + "title": "eVar225", + "type": "string", + "description": "Custom conversion variable 225." + }, + "xdm:eVar226": { + "title": "eVar226", + "type": "string", + "description": "Custom conversion variable 226." + }, + "xdm:eVar227": { + "title": "eVar227", + "type": "string", + "description": "Custom conversion variable 227." + }, + "xdm:eVar228": { + "title": "eVar228", + "type": "string", + "description": "Custom conversion variable 228." + }, + "xdm:eVar229": { + "title": "eVar229", + "type": "string", + "description": "Custom conversion variable 229." + }, + "xdm:eVar230": { + "title": "eVar230", + "type": "string", + "description": "Custom conversion variable 230." + }, + "xdm:eVar231": { + "title": "eVar231", + "type": "string", + "description": "Custom conversion variable 231." + }, + "xdm:eVar232": { + "title": "eVar232", + "type": "string", + "description": "Custom conversion variable 232." + }, + "xdm:eVar233": { + "title": "eVar233", + "type": "string", + "description": "Custom conversion variable 233." + }, + "xdm:eVar234": { + "title": "eVar234", + "type": "string", + "description": "Custom conversion variable 234." + }, + "xdm:eVar235": { + "title": "eVar235", + "type": "string", + "description": "Custom conversion variable 235." + }, + "xdm:eVar236": { + "title": "eVar236", + "type": "string", + "description": "Custom conversion variable 236." + }, + "xdm:eVar237": { + "title": "eVar237", + "type": "string", + "description": "Custom conversion variable 237." + }, + "xdm:eVar238": { + "title": "eVar238", + "type": "string", + "description": "Custom conversion variable 238." + }, + "xdm:eVar239": { + "title": "eVar239", + "type": "string", + "description": "Custom conversion variable 239." + }, + "xdm:eVar240": { + "title": "eVar240", + "type": "string", + "description": "Custom conversion variable 240." + }, + "xdm:eVar241": { + "title": "eVar241", + "type": "string", + "description": "Custom conversion variable 241." + }, + "xdm:eVar242": { + "title": "eVar242", + "type": "string", + "description": "Custom conversion variable 242." + }, + "xdm:eVar243": { + "title": "eVar243", + "type": "string", + "description": "Custom conversion variable 243." + }, + "xdm:eVar244": { + "title": "eVar244", + "type": "string", + "description": "Custom conversion variable 244." + }, + "xdm:eVar245": { + "title": "eVar245", + "type": "string", + "description": "Custom conversion variable 245." + }, + "xdm:eVar246": { + "title": "eVar246", + "type": "string", + "description": "Custom conversion variable 246." + }, + "xdm:eVar247": { + "title": "eVar247", + "type": "string", + "description": "Custom conversion variable 247." + }, + "xdm:eVar248": { + "title": "eVar248", + "type": "string", + "description": "Custom conversion variable 248." + }, + "xdm:eVar249": { + "title": "eVar249", + "type": "string", + "description": "Custom conversion variable 249." + }, + "xdm:eVar250": { + "title": "eVar250", + "type": "string", + "description": "Custom conversion variable 250." + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:hierarchies +##### Hierarchies + +undefined + +`xdm:hierarchies` +* is optional +* type: `object` + +##### xdm:hierarchies Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "Hierarchies", + "properties": { + "xdm:hier1": { + "title": "hier1", + "description": "Custom hierarchy variable 1.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:hier2": { + "title": "hier2", + "description": "Custom hierarchy variable 2.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:hier3": { + "title": "hier3", + "description": "Custom hierarchy variable 3.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:hier4": { + "title": "hier4", + "description": "Custom hierarchy variable 4.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:hier5": { + "title": "hier5", + "description": "Custom hierarchy variable 5.", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:listProps +##### List Props + +undefined + +`xdm:listProps` +* is optional +* type: `object` + +##### xdm:listProps Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "List Props", + "properties": { + "xdm:prop1": { + "title": "prop1", + "description": "Custom property variable1", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop2": { + "title": "prop2", + "description": "Custom property variable2", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop3": { + "title": "prop3", + "description": "Custom property variable3", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop4": { + "title": "prop4", + "description": "Custom property variable4", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop5": { + "title": "prop5", + "description": "Custom property variable5", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop6": { + "title": "prop6", + "description": "Custom property variable6", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop7": { + "title": "prop7", + "description": "Custom property variable7", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop8": { + "title": "prop8", + "description": "Custom property variable8", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop9": { + "title": "prop9", + "description": "Custom property variable9", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop10": { + "title": "prop10", + "description": "Custom property variable10", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop11": { + "title": "prop11", + "description": "Custom property variable11", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop12": { + "title": "prop12", + "description": "Custom property variable12", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop13": { + "title": "prop13", + "description": "Custom property variable13", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop14": { + "title": "prop14", + "description": "Custom property variable14", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop15": { + "title": "prop15", + "description": "Custom property variable15", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop16": { + "title": "prop16", + "description": "Custom property variable16", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop17": { + "title": "prop17", + "description": "Custom property variable17", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop18": { + "title": "prop18", + "description": "Custom property variable18", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop19": { + "title": "prop19", + "description": "Custom property variable19", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop20": { + "title": "prop20", + "description": "Custom property variable20", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop21": { + "title": "prop21", + "description": "Custom property variable21", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop22": { + "title": "prop22", + "description": "Custom property variable22", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop23": { + "title": "prop23", + "description": "Custom property variable23", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop24": { + "title": "prop24", + "description": "Custom property variable24", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop25": { + "title": "prop25", + "description": "Custom property variable25", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop26": { + "title": "prop26", + "description": "Custom property variable26", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop27": { + "title": "prop27", + "description": "Custom property variable27", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop28": { + "title": "prop28", + "description": "Custom property variable28", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop29": { + "title": "prop29", + "description": "Custom property variable29", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop30": { + "title": "prop30", + "description": "Custom property variable30", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop31": { + "title": "prop31", + "description": "Custom property variable31", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop32": { + "title": "prop32", + "description": "Custom property variable32", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop33": { + "title": "prop33", + "description": "Custom property variable33", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop34": { + "title": "prop34", + "description": "Custom property variable34", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop35": { + "title": "prop35", + "description": "Custom property variable35", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop36": { + "title": "prop36", + "description": "Custom property variable36", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop37": { + "title": "prop37", + "description": "Custom property variable37", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop38": { + "title": "prop38", + "description": "Custom property variable38", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop39": { + "title": "prop39", + "description": "Custom property variable39", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop40": { + "title": "prop40", + "description": "Custom property variable40", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop41": { + "title": "prop41", + "description": "Custom property variable41", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop42": { + "title": "prop42", + "description": "Custom property variable42", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop43": { + "title": "prop43", + "description": "Custom property variable43", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop44": { + "title": "prop44", + "description": "Custom property variable44", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop45": { + "title": "prop45", + "description": "Custom property variable45", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop46": { + "title": "prop46", + "description": "Custom property variable46", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop47": { + "title": "prop47", + "description": "Custom property variable47", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop48": { + "title": "prop48", + "description": "Custom property variable48", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop49": { + "title": "prop49", + "description": "Custom property variable49", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop50": { + "title": "prop50", + "description": "Custom property variable50", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop51": { + "title": "prop51", + "description": "Custom property variable51", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop52": { + "title": "prop52", + "description": "Custom property variable52", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop53": { + "title": "prop53", + "description": "Custom property variable53", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop54": { + "title": "prop54", + "description": "Custom property variable54", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop55": { + "title": "prop55", + "description": "Custom property variable55", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop56": { + "title": "prop56", + "description": "Custom property variable56", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop57": { + "title": "prop57", + "description": "Custom property variable57", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop58": { + "title": "prop58", + "description": "Custom property variable58", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop59": { + "title": "prop59", + "description": "Custom property variable59", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop60": { + "title": "prop60", + "description": "Custom property variable60", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop61": { + "title": "prop61", + "description": "Custom property variable61", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop62": { + "title": "prop62", + "description": "Custom property variable62", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop63": { + "title": "prop63", + "description": "Custom property variable63", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop64": { + "title": "prop64", + "description": "Custom property variable64", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop65": { + "title": "prop65", + "description": "Custom property variable65", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop66": { + "title": "prop66", + "description": "Custom property variable66", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop67": { + "title": "prop67", + "description": "Custom property variable67", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop68": { + "title": "prop68", + "description": "Custom property variable68", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop69": { + "title": "prop69", + "description": "Custom property variable69", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop70": { + "title": "prop70", + "description": "Custom property variable70", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop71": { + "title": "prop71", + "description": "Custom property variable71", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop72": { + "title": "prop72", + "description": "Custom property variable72", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop73": { + "title": "prop73", + "description": "Custom property variable73", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop74": { + "title": "prop74", + "description": "Custom property variable74", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + }, + "xdm:prop75": { + "title": "prop75", + "description": "Custom property variable75", + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:lists +##### Custom List Variables + +undefined + +`xdm:lists` +* is optional +* type: `object` + +##### xdm:lists Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "Custom List Variables", + "properties": { + "xdm:list1": { + "title": "List 1", + "description": "Custom list variable 1.", + "$ref": "https://ns.adobe.com/experience/analytics/keyedlist" + }, + "xdm:list2": { + "title": "List 2", + "description": "Custom list variable 2.", + "$ref": "https://ns.adobe.com/experience/analytics/keyedlist" + }, + "xdm:list3": { + "title": "List 3", + "description": "Custom list variable 3.", + "$ref": "https://ns.adobe.com/experience/analytics/keyedlist" + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:postalCode +##### zip + +Client supplied zip code/postal code. + +`xdm:postalCode` +* is optional +* type: `string` + +##### xdm:postalCode Type + + +`string` + + + + + + + + +#### xdm:props +##### Props + +undefined + +`xdm:props` +* is optional +* type: `object` + +##### xdm:props Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "Props", + "properties": { + "xdm:prop1": { + "title": "prop1", + "type": "string", + "description": "Custom property variable 1." + }, + "xdm:prop2": { + "title": "prop2", + "type": "string", + "description": "Custom property variable 2." + }, + "xdm:prop3": { + "title": "prop3", + "type": "string", + "description": "Custom property variable 3." + }, + "xdm:prop4": { + "title": "prop4", + "type": "string", + "description": "Custom property variable 4." + }, + "xdm:prop5": { + "title": "prop5", + "type": "string", + "description": "Custom property variable 5." + }, + "xdm:prop6": { + "title": "prop6", + "type": "string", + "description": "Custom property variable 6." + }, + "xdm:prop7": { + "title": "prop7", + "type": "string", + "description": "Custom property variable 7." + }, + "xdm:prop8": { + "title": "prop8", + "type": "string", + "description": "Custom property variable 8." + }, + "xdm:prop9": { + "title": "prop9", + "type": "string", + "description": "Custom property variable 9." + }, + "xdm:prop10": { + "title": "prop10", + "type": "string", + "description": "Custom property variable 10." + }, + "xdm:prop11": { + "title": "prop11", + "type": "string", + "description": "Custom property variable 11." + }, + "xdm:prop12": { + "title": "prop12", + "type": "string", + "description": "Custom property variable 12." + }, + "xdm:prop13": { + "title": "prop13", + "type": "string", + "description": "Custom property variable 13." + }, + "xdm:prop14": { + "title": "prop14", + "type": "string", + "description": "Custom property variable 14." + }, + "xdm:prop15": { + "title": "prop15", + "type": "string", + "description": "Custom property variable 15." + }, + "xdm:prop16": { + "title": "prop16", + "type": "string", + "description": "Custom property variable 16." + }, + "xdm:prop17": { + "title": "prop17", + "type": "string", + "description": "Custom property variable 17." + }, + "xdm:prop18": { + "title": "prop18", + "type": "string", + "description": "Custom property variable 18." + }, + "xdm:prop19": { + "title": "prop19", + "type": "string", + "description": "Custom property variable 19." + }, + "xdm:prop20": { + "title": "prop20", + "type": "string", + "description": "Custom property variable 20." + }, + "xdm:prop21": { + "title": "prop21", + "type": "string", + "description": "Custom property variable 21." + }, + "xdm:prop22": { + "title": "prop22", + "type": "string", + "description": "Custom property variable 22." + }, + "xdm:prop23": { + "title": "prop23", + "type": "string", + "description": "Custom property variable 23." + }, + "xdm:prop24": { + "title": "prop24", + "type": "string", + "description": "Custom property variable 24." + }, + "xdm:prop25": { + "title": "prop25", + "type": "string", + "description": "Custom property variable 25." + }, + "xdm:prop26": { + "title": "prop26", + "type": "string", + "description": "Custom property variable 26." + }, + "xdm:prop27": { + "title": "prop27", + "type": "string", + "description": "Custom property variable 27." + }, + "xdm:prop28": { + "title": "prop28", + "type": "string", + "description": "Custom property variable 28." + }, + "xdm:prop29": { + "title": "prop29", + "type": "string", + "description": "Custom property variable 29." + }, + "xdm:prop30": { + "title": "prop30", + "type": "string", + "description": "Custom property variable 30." + }, + "xdm:prop31": { + "title": "prop31", + "type": "string", + "description": "Custom property variable 31." + }, + "xdm:prop32": { + "title": "prop32", + "type": "string", + "description": "Custom property variable 32." + }, + "xdm:prop33": { + "title": "prop33", + "type": "string", + "description": "Custom property variable 33." + }, + "xdm:prop34": { + "title": "prop34", + "type": "string", + "description": "Custom property variable 34." + }, + "xdm:prop35": { + "title": "prop35", + "type": "string", + "description": "Custom property variable 35." + }, + "xdm:prop36": { + "title": "prop36", + "type": "string", + "description": "Custom property variable 36." + }, + "xdm:prop37": { + "title": "prop37", + "type": "string", + "description": "Custom property variable 37." + }, + "xdm:prop38": { + "title": "prop38", + "type": "string", + "description": "Custom property variable 38." + }, + "xdm:prop39": { + "title": "prop39", + "type": "string", + "description": "Custom property variable 39." + }, + "xdm:prop40": { + "title": "prop40", + "type": "string", + "description": "Custom property variable 40." + }, + "xdm:prop41": { + "title": "prop41", + "type": "string", + "description": "Custom property variable 41." + }, + "xdm:prop42": { + "title": "prop42", + "type": "string", + "description": "Custom property variable 42." + }, + "xdm:prop43": { + "title": "prop43", + "type": "string", + "description": "Custom property variable 43." + }, + "xdm:prop44": { + "title": "prop44", + "type": "string", + "description": "Custom property variable 44." + }, + "xdm:prop45": { + "title": "prop45", + "type": "string", + "description": "Custom property variable 45." + }, + "xdm:prop46": { + "title": "prop46", + "type": "string", + "description": "Custom property variable 46." + }, + "xdm:prop47": { + "title": "prop47", + "type": "string", + "description": "Custom property variable 47." + }, + "xdm:prop48": { + "title": "prop48", + "type": "string", + "description": "Custom property variable 48." + }, + "xdm:prop49": { + "title": "prop49", + "type": "string", + "description": "Custom property variable 49." + }, + "xdm:prop50": { + "title": "prop50", + "type": "string", + "description": "Custom property variable 50." + }, + "xdm:prop51": { + "title": "prop51", + "type": "string", + "description": "Custom property variable 51." + }, + "xdm:prop52": { + "title": "prop52", + "type": "string", + "description": "Custom property variable 52." + }, + "xdm:prop53": { + "title": "prop53", + "type": "string", + "description": "Custom property variable 53." + }, + "xdm:prop54": { + "title": "prop54", + "type": "string", + "description": "Custom property variable 54." + }, + "xdm:prop55": { + "title": "prop55", + "type": "string", + "description": "Custom property variable 55." + }, + "xdm:prop56": { + "title": "prop56", + "type": "string", + "description": "Custom property variable 56." + }, + "xdm:prop57": { + "title": "prop57", + "type": "string", + "description": "Custom property variable 57." + }, + "xdm:prop58": { + "title": "prop58", + "type": "string", + "description": "Custom property variable 58." + }, + "xdm:prop59": { + "title": "prop59", + "type": "string", + "description": "Custom property variable 59." + }, + "xdm:prop60": { + "title": "prop60", + "type": "string", + "description": "Custom property variable 60." + }, + "xdm:prop61": { + "title": "prop61", + "type": "string", + "description": "Custom property variable 61." + }, + "xdm:prop62": { + "title": "prop62", + "type": "string", + "description": "Custom property variable 62." + }, + "xdm:prop63": { + "title": "prop63", + "type": "string", + "description": "Custom property variable 63." + }, + "xdm:prop64": { + "title": "prop64", + "type": "string", + "description": "Custom property variable 64." + }, + "xdm:prop65": { + "title": "prop65", + "type": "string", + "description": "Custom property variable 65." + }, + "xdm:prop66": { + "title": "prop66", + "type": "string", + "description": "Custom property variable 66." + }, + "xdm:prop67": { + "title": "prop67", + "type": "string", + "description": "Custom property variable 67." + }, + "xdm:prop68": { + "title": "prop68", + "type": "string", + "description": "Custom property variable 68." + }, + "xdm:prop69": { + "title": "prop69", + "type": "string", + "description": "Custom property variable 69." + }, + "xdm:prop70": { + "title": "prop70", + "type": "string", + "description": "Custom property variable 70." + }, + "xdm:prop71": { + "title": "prop71", + "type": "string", + "description": "Custom property variable 71." + }, + "xdm:prop72": { + "title": "prop72", + "type": "string", + "description": "Custom property variable 72." + }, + "xdm:prop73": { + "title": "prop73", + "type": "string", + "description": "Custom property variable 73." + }, + "xdm:prop74": { + "title": "prop74", + "type": "string", + "description": "Custom property variable 74." + }, + "xdm:prop75": { + "title": "prop75", + "type": "string", + "description": "Custom property variable 75." + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:stateProvince +##### state + +Client supplied state or province location. + +`xdm:stateProvince` +* is optional +* type: `string` + +##### xdm:stateProvince Type + + +`string` + + + + + + + + + + + +## https://ns.adobe.com/experience/analytics/endUser +### End-User + +`https://ns.adobe.com/experience/analytics/endUser` +* is optional +* type: endUser.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/endUser Type + + +* [endUser.schema](endUser.schema.md) – `https://ns.adobe.com/experience/analytics/endUser` + + + + + +## https://ns.adobe.com/experience/analytics/environment +### Environment + +`https://ns.adobe.com/experience/analytics/environment` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/analytics/environment Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:browserID`| integer | Optional | +| `xdm:browserIDStr`| string | Optional | +| `xdm:operatingSystemID`| integer | Optional | +| `xdm:operatingSystemIDStr`| string | Optional | + + + +#### xdm:browserID +##### Browser ID + +The Adobe Analytics identifier for the browser used. Deprecated, use xdm:browserIDStr instead. + +`xdm:browserID` +* is optional +* type: `integer` + +##### xdm:browserID Type + + +`integer` + + + + + + + + +#### xdm:browserIDStr +##### Browser ID + +The Adobe Analytics identifier for the browser used. + +`xdm:browserIDStr` +* is optional +* type: `string` + +##### xdm:browserIDStr Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E%5B0-9%5D%2B)): +```regex +^[0-9]+ +``` + + + + + + + + +#### xdm:operatingSystemID +##### Operating System ID + +The Adobe Analytics identifier of the operating system used. Deprecated, use xdm:operatingSystemIDStr instead. + +`xdm:operatingSystemID` +* is optional +* type: `integer` + +##### xdm:operatingSystemID Type + + +`integer` + + + + + + + + +#### xdm:operatingSystemIDStr +##### Operating System ID + +The Adobe Analytics identifier of the operating system used. + +`xdm:operatingSystemIDStr` +* is optional +* type: `string` + +##### xdm:operatingSystemIDStr Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E%5B0-9%5D%2B)): +```regex +^[0-9]+ +``` + + + + + + + + + + + +## https://ns.adobe.com/experience/analytics/event101to200 +### Event 101 to 200 + +`https://ns.adobe.com/experience/analytics/event101to200` +* is optional +* type: event101to200.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event101to200 Type + + +* [event101to200.schema](event101to200.schema.md) – `https://ns.adobe.com/experience/analytics/event101to200` + + + + + +## https://ns.adobe.com/experience/analytics/event1to100 +### Event 1 to 100 + +`https://ns.adobe.com/experience/analytics/event1to100` +* is optional +* type: event1to100.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event1to100 Type + + +* [event1to100.schema](event1to100.schema.md) – `https://ns.adobe.com/experience/analytics/event1to100` + + + + + +## https://ns.adobe.com/experience/analytics/event201to300 +### Event 201 to 300 + +`https://ns.adobe.com/experience/analytics/event201to300` +* is optional +* type: event201to300.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event201to300 Type + + +* [event201to300.schema](event201to300.schema.md) – `https://ns.adobe.com/experience/analytics/event201to300` + + + + + +## https://ns.adobe.com/experience/analytics/event301to400 +### Event 301 to 400 + +`https://ns.adobe.com/experience/analytics/event301to400` +* is optional +* type: event301to400.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event301to400 Type + + +* [event301to400.schema](event301to400.schema.md) – `https://ns.adobe.com/experience/analytics/event301to400` + + + + + +## https://ns.adobe.com/experience/analytics/event401to500 +### Event 401 to 500 + +`https://ns.adobe.com/experience/analytics/event401to500` +* is optional +* type: event401to500.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event401to500 Type + + +* [event401to500.schema](event401to500.schema.md) – `https://ns.adobe.com/experience/analytics/event401to500` + + + + + +## https://ns.adobe.com/experience/analytics/event501to600 +### Event 501 to 600 + +`https://ns.adobe.com/experience/analytics/event501to600` +* is optional +* type: event501to600.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event501to600 Type + + +* [event501to600.schema](event501to600.schema.md) – `https://ns.adobe.com/experience/analytics/event501to600` + + + + + +## https://ns.adobe.com/experience/analytics/event601to700 +### Event 601 to 700 + +`https://ns.adobe.com/experience/analytics/event601to700` +* is optional +* type: event601to700.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event601to700 Type + + +* [event601to700.schema](event601to700.schema.md) – `https://ns.adobe.com/experience/analytics/event601to700` + + + + + +## https://ns.adobe.com/experience/analytics/event701to800 +### Event 701 to 800 + +`https://ns.adobe.com/experience/analytics/event701to800` +* is optional +* type: event701to800.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event701to800 Type + + +* [event701to800.schema](event701to800.schema.md) – `https://ns.adobe.com/experience/analytics/event701to800` + + + + + +## https://ns.adobe.com/experience/analytics/event801to900 +### Event 801 to 900 + +`https://ns.adobe.com/experience/analytics/event801to900` +* is optional +* type: event801to900.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event801to900 Type + + +* [event801to900.schema](event801to900.schema.md) – `https://ns.adobe.com/experience/analytics/event801to900` + + + + + +## https://ns.adobe.com/experience/analytics/event901to1000 +### Event 901 to 1000 + +`https://ns.adobe.com/experience/analytics/event901to1000` +* is optional +* type: event901to1000.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/event901to1000 Type + + +* [event901to1000.schema](event901to1000.schema.md) – `https://ns.adobe.com/experience/analytics/event901to1000` + + + + + +## https://ns.adobe.com/experience/analytics/session +### Session + +`https://ns.adobe.com/experience/analytics/session` +* is optional +* type: session.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/session Type + + +* [session.schema](session.schema.md) – `https://ns.adobe.com/experience/analytics/session` + + + + diff --git a/docs/reference/adobe/experience/analytics/keyedlist.schema.json b/docs/reference/adobe/experience/analytics/keyedlist.schema.json new file mode 100644 index 000000000..9a8f2f9ae --- /dev/null +++ b/docs/reference/adobe/experience/analytics/keyedlist.schema.json @@ -0,0 +1,32 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/analytics/keyedlist", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Keyed List", + "type": "object", + "description": "List of keyed values.", + "definitions": { + "keyedlist": { + "properties": { + "xdm:list": { + "title": "Keyed List", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/experience/analytics/keyvalue" + }, + "description": "List of keyed values." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/keyedlist" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/keyedlist.schema.md b/docs/reference/adobe/experience/analytics/keyedlist.schema.md new file mode 100644 index 000000000..c36fdb3b8 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/keyedlist.schema.md @@ -0,0 +1,45 @@ + +# Keyed List Schema + +``` +https://ns.adobe.com/experience/analytics/keyedlist +``` + +List of keyed values. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/keyedlist.schema.json](adobe/experience/analytics/keyedlist.schema.json) | + +# Keyed List Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:list](#xdmlist) | Key Value Pair | Optional | Keyed List (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:list +### Keyed List + +List of keyed values. + +`xdm:list` +* is optional +* type: Key Value Pair + +* defined in this schema + +### xdm:list Type + + +Array type: Key Value Pair + +All items must be of the type: +* [Key Value Pair](keyvalue.schema.md) – `https://ns.adobe.com/experience/analytics/keyvalue` + + + + + + + diff --git a/docs/reference/adobe/experience/analytics/keyvalue.schema.json b/docs/reference/adobe/experience/analytics/keyvalue.schema.json new file mode 100644 index 000000000..5a19e7aed --- /dev/null +++ b/docs/reference/adobe/experience/analytics/keyvalue.schema.json @@ -0,0 +1,34 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/analytics/keyvalue", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Key Value Pair", + "type": "object", + "description": "Key value pair.", + "definitions": { + "keyvalue": { + "properties": { + "xdm:key": { + "title": "Key", + "description": "Key", + "type": "string" + }, + "xdm:value": { + "title": "Value", + "description": "Value", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/keyvalue" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/keyvalue.schema.md b/docs/reference/adobe/experience/analytics/keyvalue.schema.md new file mode 100644 index 000000000..7290232f8 --- /dev/null +++ b/docs/reference/adobe/experience/analytics/keyvalue.schema.md @@ -0,0 +1,60 @@ + +# Key Value Pair Schema + +``` +https://ns.adobe.com/experience/analytics/keyvalue +``` + +Key value pair. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/keyvalue.schema.json](adobe/experience/analytics/keyvalue.schema.json) | + +# Key Value Pair Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:key](#xdmkey) | `string` | Optional | Key Value Pair (this schema) | +| [xdm:value](#xdmvalue) | `string` | Optional | Key Value Pair (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:key +### Key + +Key + +`xdm:key` +* is optional +* type: `string` +* defined in this schema + +### xdm:key Type + + +`string` + + + + + + +## xdm:value +### Value + +Value + +`xdm:value` +* is optional +* type: `string` +* defined in this schema + +### xdm:value Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/analytics/listdetails.schema.json b/docs/reference/adobe/experience/analytics/listdetails.schema.json new file mode 100644 index 000000000..b5c9f972a --- /dev/null +++ b/docs/reference/adobe/experience/analytics/listdetails.schema.json @@ -0,0 +1,37 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/analytics/listdetails", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "List Details", + "type": "object", + "description": "List of values with details.", + "definitions": { + "listdetails": { + "properties": { + "xdm:values": { + "title": "List Values", + "type": "array", + "items": { + "type": "string" + }, + "description": "List of values." + }, + "xdm:delimiter": { + "title": "Original List Delimiter", + "type": "string", + "description": "The original delimiter used to generate the list." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/listdetails" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/listdetails.schema.md b/docs/reference/adobe/experience/analytics/listdetails.schema.md new file mode 100644 index 000000000..37e5fe3aa --- /dev/null +++ b/docs/reference/adobe/experience/analytics/listdetails.schema.md @@ -0,0 +1,67 @@ + +# List Details Schema + +``` +https://ns.adobe.com/experience/analytics/listdetails +``` + +List of values with details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/listdetails.schema.json](adobe/experience/analytics/listdetails.schema.json) | + +# List Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:delimiter](#xdmdelimiter) | `string` | Optional | List Details (this schema) | +| [xdm:values](#xdmvalues) | `string[]` | Optional | List Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:delimiter +### Original List Delimiter + +The original delimiter used to generate the list. + +`xdm:delimiter` +* is optional +* type: `string` +* defined in this schema + +### xdm:delimiter Type + + +`string` + + + + + + +## xdm:values +### List Values + +List of values. + +`xdm:values` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:values Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + + + diff --git a/docs/reference/adobe/experience/analytics/productlistitem.schema.json b/docs/reference/adobe/experience/analytics/productlistitem.schema.json new file mode 100644 index 000000000..1b3992e7a --- /dev/null +++ b/docs/reference/adobe/experience/analytics/productlistitem.schema.json @@ -0,0 +1,36 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/analytics/productlistitem", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Analytics extension to XDM Product List Item", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "XDM Product List Item extension properties specific to Adobe Analytics that implements Merchandizing support.", + "definitions": { + "productlistitems": { + "properties": { + "https://ns.adobe.com/experience/analytics/customDimensions": { + "title": "Merchandizing Custom Dimensions", + "$ref": "https://ns.adobe.com/experience/analytics/customDimensions" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/productlistitems" + }, + { + "$ref": "https://ns.adobe.com/xdm/content/productlistitem" + }, + { + "$ref": "https://ns.adobe.com/experience/analytics/events" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/productlistitem.schema.md b/docs/reference/adobe/experience/analytics/productlistitem.schema.md new file mode 100644 index 000000000..f2ef45d1f --- /dev/null +++ b/docs/reference/adobe/experience/analytics/productlistitem.schema.md @@ -0,0 +1,412 @@ + +# Adobe Analytics extension to XDM Product List Item Schema + +``` +https://ns.adobe.com/experience/analytics/productlistitem +``` + +XDM Product List Item extension properties specific to Adobe Analytics that implements Merchandizing support. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/productlistitem.schema.json](adobe/experience/analytics/productlistitem.schema.json) | +## Schema Hierarchy + +* Adobe Analytics extension to XDM Product List Item `https://ns.adobe.com/experience/analytics/productlistitem` + * [customDimensions.schema](customDimensions.schema.md) `https://ns.adobe.com/experience/analytics/customDimensions` + * [Product list item](../../../datatypes/productlistitem.schema.md) `https://ns.adobe.com/xdm/content/productlistitem` + * [Adobe Analytics Custom Events](events.schema.md) `https://ns.adobe.com/experience/analytics/events` + + +# Adobe Analytics extension to XDM Product List Item Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Product list item](../../../datatypes/productlistitem.schema.md#id) | +| [https://ns.adobe.com/experience/analytics/customDimensions](#httpsnsadobecomexperienceanalyticscustomdimensions) | customDimensions.schema | Optional | Adobe Analytics extension to XDM Product List Item (this schema) | +| [https://ns.adobe.com/experience/analytics/event101to200](#httpsnsadobecomexperienceanalyticsevent101to200) | event101to200.schema | Optional | [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent101to200) | +| [https://ns.adobe.com/experience/analytics/event1to100](#httpsnsadobecomexperienceanalyticsevent1to100) | event1to100.schema | Optional | [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent1to100) | +| [https://ns.adobe.com/experience/analytics/event201to300](#httpsnsadobecomexperienceanalyticsevent201to300) | event201to300.schema | Optional | [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent201to300) | +| [https://ns.adobe.com/experience/analytics/event301to400](#httpsnsadobecomexperienceanalyticsevent301to400) | event301to400.schema | Optional | [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent301to400) | +| [https://ns.adobe.com/experience/analytics/event401to500](#httpsnsadobecomexperienceanalyticsevent401to500) | event401to500.schema | Optional | [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent401to500) | +| [https://ns.adobe.com/experience/analytics/event501to600](#httpsnsadobecomexperienceanalyticsevent501to600) | event501to600.schema | Optional | [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent501to600) | +| [https://ns.adobe.com/experience/analytics/event601to700](#httpsnsadobecomexperienceanalyticsevent601to700) | event601to700.schema | Optional | [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent601to700) | +| [https://ns.adobe.com/experience/analytics/event701to800](#httpsnsadobecomexperienceanalyticsevent701to800) | event701to800.schema | Optional | [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent701to800) | +| [https://ns.adobe.com/experience/analytics/event801to900](#httpsnsadobecomexperienceanalyticsevent801to900) | event801to900.schema | Optional | [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent801to900) | +| [https://ns.adobe.com/experience/analytics/event901to1000](#httpsnsadobecomexperienceanalyticsevent901to1000) | event901to1000.schema | Optional | [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent901to1000) | +| [xdm:SKU](#xdmsku) | `string` | Optional | [Product list item](../../../datatypes/productlistitem.schema.md#xdmsku) | +| [xdm:currencyCode](#xdmcurrencycode) | `string` | Optional | [Product list item](../../../datatypes/productlistitem.schema.md#xdmcurrencycode) | +| [xdm:name](#xdmname) | `string` | Optional | [Product list item](../../../datatypes/productlistitem.schema.md#xdmname) | +| [xdm:priceTotal](#xdmpricetotal) | `number` | Optional | [Product list item](../../../datatypes/productlistitem.schema.md#xdmpricetotal) | +| [xdm:product](#xdmproduct) | `string` | Optional | [Product list item](../../../datatypes/productlistitem.schema.md#xdmproduct) | +| [xdm:productAddMethod](#xdmproductaddmethod) | `string` | Optional | [Product list item](../../../datatypes/productlistitem.schema.md#xdmproductaddmethod) | +| [xdm:quantity](#xdmquantity) | `integer` | Optional | [Product list item](../../../datatypes/productlistitem.schema.md#xdmquantity) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Line item ID. + +The line item identifier for this product entry. The product itself is identified through `xdm:product`. + +`@id` +* is optional +* type: `string` +* defined in [Product list item](../../../datatypes/productlistitem.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## https://ns.adobe.com/experience/analytics/customDimensions +### Merchandizing Custom Dimensions + +`https://ns.adobe.com/experience/analytics/customDimensions` +* is optional +* type: customDimensions.schema +* defined in this schema + +### https://ns.adobe.com/experience/analytics/customDimensions Type + + +* [customDimensions.schema](customDimensions.schema.md) – `https://ns.adobe.com/experience/analytics/customDimensions` + + + + + +## https://ns.adobe.com/experience/analytics/event101to200 +### Event 101 to 200 + +`https://ns.adobe.com/experience/analytics/event101to200` +* is optional +* type: event101to200.schema +* defined in [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent101to200) + +### https://ns.adobe.com/experience/analytics/event101to200 Type + + +* [event101to200.schema](event101to200.schema.md) – `https://ns.adobe.com/experience/analytics/event101to200` + + + + + +## https://ns.adobe.com/experience/analytics/event1to100 +### Event 1 to 100 + +`https://ns.adobe.com/experience/analytics/event1to100` +* is optional +* type: event1to100.schema +* defined in [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent1to100) + +### https://ns.adobe.com/experience/analytics/event1to100 Type + + +* [event1to100.schema](event1to100.schema.md) – `https://ns.adobe.com/experience/analytics/event1to100` + + + + + +## https://ns.adobe.com/experience/analytics/event201to300 +### Event 201 to 300 + +`https://ns.adobe.com/experience/analytics/event201to300` +* is optional +* type: event201to300.schema +* defined in [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent201to300) + +### https://ns.adobe.com/experience/analytics/event201to300 Type + + +* [event201to300.schema](event201to300.schema.md) – `https://ns.adobe.com/experience/analytics/event201to300` + + + + + +## https://ns.adobe.com/experience/analytics/event301to400 +### Event 301 to 400 + +`https://ns.adobe.com/experience/analytics/event301to400` +* is optional +* type: event301to400.schema +* defined in [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent301to400) + +### https://ns.adobe.com/experience/analytics/event301to400 Type + + +* [event301to400.schema](event301to400.schema.md) – `https://ns.adobe.com/experience/analytics/event301to400` + + + + + +## https://ns.adobe.com/experience/analytics/event401to500 +### Event 401 to 500 + +`https://ns.adobe.com/experience/analytics/event401to500` +* is optional +* type: event401to500.schema +* defined in [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent401to500) + +### https://ns.adobe.com/experience/analytics/event401to500 Type + + +* [event401to500.schema](event401to500.schema.md) – `https://ns.adobe.com/experience/analytics/event401to500` + + + + + +## https://ns.adobe.com/experience/analytics/event501to600 +### Event 501 to 600 + +`https://ns.adobe.com/experience/analytics/event501to600` +* is optional +* type: event501to600.schema +* defined in [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent501to600) + +### https://ns.adobe.com/experience/analytics/event501to600 Type + + +* [event501to600.schema](event501to600.schema.md) – `https://ns.adobe.com/experience/analytics/event501to600` + + + + + +## https://ns.adobe.com/experience/analytics/event601to700 +### Event 601 to 700 + +`https://ns.adobe.com/experience/analytics/event601to700` +* is optional +* type: event601to700.schema +* defined in [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent601to700) + +### https://ns.adobe.com/experience/analytics/event601to700 Type + + +* [event601to700.schema](event601to700.schema.md) – `https://ns.adobe.com/experience/analytics/event601to700` + + + + + +## https://ns.adobe.com/experience/analytics/event701to800 +### Event 701 to 800 + +`https://ns.adobe.com/experience/analytics/event701to800` +* is optional +* type: event701to800.schema +* defined in [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent701to800) + +### https://ns.adobe.com/experience/analytics/event701to800 Type + + +* [event701to800.schema](event701to800.schema.md) – `https://ns.adobe.com/experience/analytics/event701to800` + + + + + +## https://ns.adobe.com/experience/analytics/event801to900 +### Event 801 to 900 + +`https://ns.adobe.com/experience/analytics/event801to900` +* is optional +* type: event801to900.schema +* defined in [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent801to900) + +### https://ns.adobe.com/experience/analytics/event801to900 Type + + +* [event801to900.schema](event801to900.schema.md) – `https://ns.adobe.com/experience/analytics/event801to900` + + + + + +## https://ns.adobe.com/experience/analytics/event901to1000 +### Event 901 to 1000 + +`https://ns.adobe.com/experience/analytics/event901to1000` +* is optional +* type: event901to1000.schema +* defined in [Adobe Analytics Custom Events](events.schema.md#httpsnsadobecomexperienceanalyticsevent901to1000) + +### https://ns.adobe.com/experience/analytics/event901to1000 Type + + +* [event901to1000.schema](event901to1000.schema.md) – `https://ns.adobe.com/experience/analytics/event901to1000` + + + + + +## xdm:SKU +### SKU + +Stock keeping unit (SKU), the unique identifier for a product defined by the vendor. + +`xdm:SKU` +* is optional +* type: `string` +* defined in [Product list item](../../../datatypes/productlistitem.schema.md#xdmsku) + +### xdm:SKU Type + + +`string` + + + + + + +## xdm:currencyCode +### Currency code + +The ISO 4217 alphabetic currency code used for pricing the product. + +`xdm:currencyCode` +* is optional +* type: `string` +* defined in [Product list item](../../../datatypes/productlistitem.schema.md#xdmcurrencycode) + +### xdm:currencyCode Type + + +`string` + + +All instances must conform to this regular expression +```regex +^[A-Z]{3}$ +``` + +* test example: [USD](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=USD) +* test example: [EUR](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=EUR) + + + + +### xdm:currencyCode Examples + +```json +"USD" +``` + +```json +"EUR" +``` + + + +## xdm:name +### Name + +The display name for the product as presented to the user for this product view. + +`xdm:name` +* is optional +* type: `string` +* defined in [Product list item](../../../datatypes/productlistitem.schema.md#xdmname) + +### xdm:name Type + + +`string` + + + + + + +## xdm:priceTotal +### Price total + +The total price for the product line item. + +`xdm:priceTotal` +* is optional +* type: `number` +* defined in [Product list item](../../../datatypes/productlistitem.schema.md#xdmpricetotal) + +### xdm:priceTotal Type + + +`number` + + + + + + +## xdm:product +### Product + +The XDM identifier of the product itself. + +`xdm:product` +* is optional +* type: `string` +* defined in [Product list item](../../../datatypes/productlistitem.schema.md#xdmproduct) + +### xdm:product Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:productAddMethod +### Product add method + +The method that was used to add a product item to the list by the visitor. Set with product list add metrics. + +`xdm:productAddMethod` +* is optional +* type: `string` +* defined in [Product list item](../../../datatypes/productlistitem.schema.md#xdmproductaddmethod) + +### xdm:productAddMethod Type + + +`string` + + + + + + +## xdm:quantity +### Quantity + +The number of units the customer has indicated they require of the product. + +`xdm:quantity` +* is optional +* type: `integer` +* defined in [Product list item](../../../datatypes/productlistitem.schema.md#xdmquantity) + +### xdm:quantity Type + + +`integer` + + + + + diff --git a/docs/reference/adobe/experience/analytics/session.schema.json b/docs/reference/adobe/experience/analytics/session.schema.json new file mode 100644 index 000000000..08a73177f --- /dev/null +++ b/docs/reference/adobe/experience/analytics/session.schema.json @@ -0,0 +1,31 @@ +{ + "xdm:num": { + "title": "Session Number", + "type": "integer", + "description": "Current session number for the end-user." + }, + "xdm:depth": { + "title": "Session Depth", + "type": "integer", + "description": "Current session depth (eg page number) for the end-user." + }, + "xdm:timestamp": { + "title": "Session Entry Timestamp", + "type": "integer", + "description": "The timestamp at the entry into this session. Milliseconds since midnight of January 1, 1970.", + "minimum": 1, + "maximum": 9223372036854770000 + }, + "xdm:search": { + "title": "Session Entry Search", + "$ref": "https://ns.adobe.com/xdm/context/search", + "description": "The information related to web or mobile search at the entry of this session." + }, + "xdm:web": { + "title": "Session Entry Web", + "$ref": "https://ns.adobe.com/xdm/context/webinfo", + "description": "The information related to web page, link, and referrer at the entry of this session." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/analytics/session" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/analytics/session.schema.md b/docs/reference/adobe/experience/analytics/session.schema.md new file mode 100644 index 000000000..bd6b8ba8e --- /dev/null +++ b/docs/reference/adobe/experience/analytics/session.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/analytics/session +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/analytics/session.schema.json](adobe/experience/analytics/session.schema.json) | diff --git a/docs/reference/adobe/experience/audiencemanager/experienceevent-all.schema.json b/docs/reference/adobe/experience/audiencemanager/experienceevent-all.schema.json new file mode 100644 index 000000000..2c6f06064 --- /dev/null +++ b/docs/reference/adobe/experience/audiencemanager/experienceevent-all.schema.json @@ -0,0 +1,60 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/audiencemanager/experienceevent-all", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Audience Manager ExperienceEvent Full Extension", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Audience Manager ExperienceEvent full extension. Contains all Solution added fields.", + "definitions": { + "experienceevent": { + "properties": { + "xdm:signals": { + "title": "Signals", + "description": "Additional frequently changing properties captured with an event via request parameters or other means.", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "Value of the parameter" + } + } + }, + "xdm:overwriteTraits": { + "title": "Overwrite Traits", + "type": "boolean", + "description": "Flag highlighting that all the traits realized before this for this id and data source, need to be discarded." + }, + "xdm:derivedSignals": { + "title": "Derived Signals", + "description": "Derived properties from event data", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "Value of the parameter" + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/experienceevent" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/audiencemanager/experienceevent-all.schema.md b/docs/reference/adobe/experience/audiencemanager/experienceevent-all.schema.md new file mode 100644 index 000000000..a9654fc8c --- /dev/null +++ b/docs/reference/adobe/experience/audiencemanager/experienceevent-all.schema.md @@ -0,0 +1,88 @@ + +# Adobe Audience Manager ExperienceEvent Full Extension Schema + +``` +https://ns.adobe.com/experience/audiencemanager/experienceevent-all +``` + +Adobe Audience Manager ExperienceEvent full extension. Contains all Solution added fields. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/audiencemanager/experienceevent-all.schema.json](adobe/experience/audiencemanager/experienceevent-all.schema.json) | + +# Adobe Audience Manager ExperienceEvent Full Extension Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:derivedSignals](#xdmderivedsignals) | `object` | Optional | Adobe Audience Manager ExperienceEvent Full Extension (this schema) | +| [xdm:overwriteTraits](#xdmoverwritetraits) | `boolean` | Optional | Adobe Audience Manager ExperienceEvent Full Extension (this schema) | +| [xdm:signals](#xdmsignals) | `object` | Optional | Adobe Audience Manager ExperienceEvent Full Extension (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:derivedSignals +### Derived Signals + +Derived properties from event data + +`xdm:derivedSignals` +* is optional +* type: `object` +* defined in this schema + +### xdm:derivedSignals Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:overwriteTraits +### Overwrite Traits + +Flag highlighting that all the traits realized before this for this id and data source, need to be discarded. + +`xdm:overwriteTraits` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:overwriteTraits Type + + +`boolean` + + + + + +## xdm:signals +### Signals + +Additional frequently changing properties captured with an event via request parameters or other means. + +`xdm:signals` +* is optional +* type: `object` +* defined in this schema + +### xdm:signals Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + diff --git a/docs/reference/adobe/experience/audiencemanager/segmentdefinition.schema.json b/docs/reference/adobe/experience/audiencemanager/segmentdefinition.schema.json new file mode 100644 index 000000000..7c684e4c1 --- /dev/null +++ b/docs/reference/adobe/experience/audiencemanager/segmentdefinition.schema.json @@ -0,0 +1,78 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/audiencemanager/segmentdefinition", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Audience Manager Segment Definition Mixin", + "type": "object", + "description": "This mixin captures Adobe Audience Manager-specific segment definition fields like the identity of the folder this segment belongs to and Audience Manager type for the segment.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/segmentdefinition" + ], + "definitions": { + "segmentdefinition": { + "properties": { + "xdm:segmentFolderId": { + "title": "Folder Id", + "type": "string", + "description": "id of parent folder if present", + "meta:status": "deprecated" + }, + "xdm:segmentSubType": { + "title": "Sub Type", + "type": "string", + "description": "Further classification of AAM Entity", + "meta:enum": [ + "FOLDER", + "FOLDER_TRAIT", + "SEGMENT", + "UNDEFINED", + "RULE_BASED_TRAIT", + "NON_ALGO_TRAIT", + "TEST_SEGMENT", + "COMPANY_ACTIVITY_TRAIT", + "ALGO_TRAIT", + "ON_BOARDED_TRAIT" + ] + }, + "https://ns.adobe.com/experience/audiencemanager/segmentFolderIdentity": { + "title": "Parent folder identity", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Identity of the parent folder of current folder" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/segmentdefinition-expression" + }, + { + "$ref": "#/definitions/segmentdefinition" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:segmentExpression": { + "xdm:expressionType": "AAM", + "xdm:mimeType": "text/plain", + "xdm:value": "c_contextdata.catname matchesregex \"\"^sony -.+\"\"" + }, + "xdm:segmentFolderId": "1123", + "xdm:segmentSubType": "SEGMENT", + "https://ns.adobe.com/experience/audiencemanager/segmentFolderIdentity": { + "xdm:id": "1123", + "xdm:namespace": { + "xdm:code": "AAMSegments" + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/audiencemanager/segmentdefinition.schema.md b/docs/reference/adobe/experience/audiencemanager/segmentdefinition.schema.md new file mode 100644 index 000000000..a45e252d2 --- /dev/null +++ b/docs/reference/adobe/experience/audiencemanager/segmentdefinition.schema.md @@ -0,0 +1,222 @@ + +# Adobe Audience Manager Segment Definition Mixin Schema + +``` +https://ns.adobe.com/experience/audiencemanager/segmentdefinition +``` + +This mixin captures Adobe Audience Manager-specific segment definition fields like the identity of the folder this segment belongs to and Audience Manager type for the segment. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/audiencemanager/segmentdefinition.schema.json](adobe/experience/audiencemanager/segmentdefinition.schema.json) | +## Schema Hierarchy + +* Adobe Audience Manager Segment Definition Mixin `https://ns.adobe.com/experience/audiencemanager/segmentdefinition` + * [Segment expression](../../../mixins/segment-definition/segmentdefinition-expression.schema.md) `https://ns.adobe.com/xdm/context/segmentdefinition-expression` + * [Identity](../../../datatypes/identity.schema.md) `https://ns.adobe.com/xdm/context/identity` + + +## Adobe Audience Manager Segment Definition Mixin Example +```json +{ + "xdm:segmentExpression": { + "xdm:expressionType": "AAM", + "xdm:mimeType": "text/plain", + "xdm:value": "c_contextdata.catname matchesregex \"\"^sony -.+\"\"" + }, + "xdm:segmentFolderId": "1123", + "xdm:segmentSubType": "SEGMENT", + "https://ns.adobe.com/experience/audiencemanager/segmentFolderIdentity": { + "xdm:id": "1123", + "xdm:namespace": { + "xdm:code": "AAMSegments" + } + } +} +``` + +# Adobe Audience Manager Segment Definition Mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/audiencemanager/segmentFolderIdentity](#httpsnsadobecomexperienceaudiencemanagersegmentfolderidentity) | Identity | Optional | Adobe Audience Manager Segment Definition Mixin (this schema) | +| [xdm:segmentExpression](#xdmsegmentexpression) | `object` | Optional | [Segment expression](../../../mixins/segment-definition/segmentdefinition-expression.schema.md#xdmsegmentexpression) | +| [xdm:segmentFolderId](#xdmsegmentfolderid) | `string` | Optional | Adobe Audience Manager Segment Definition Mixin (this schema) | +| [xdm:segmentSubType](#xdmsegmentsubtype) | `string` | Optional | Adobe Audience Manager Segment Definition Mixin (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/audiencemanager/segmentFolderIdentity +### Parent folder identity + +Identity of the parent folder of current folder + +`https://ns.adobe.com/experience/audiencemanager/segmentFolderIdentity` +* is optional +* type: Identity +* defined in this schema + +### https://ns.adobe.com/experience/audiencemanager/segmentFolderIdentity Type + + +* [Identity](../../../datatypes/identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + + +## xdm:segmentExpression +### Segment expression + +`xdm:segmentExpression` +* is optional +* type: `object` +* defined in [Segment expression](../../../mixins/segment-definition/segmentdefinition-expression.schema.md#xdmsegmentexpression) + +### xdm:segmentExpression Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:expressionType`| string | Optional | +| `xdm:mimeType`| string | Optional | +| `xdm:value`| string | Optional | + + + +#### xdm:expressionType +##### Type + +Type of expression, for example, PQL, Query Service, or Adobe Audience Manager. + +`xdm:expressionType` +* is optional +* type: `string` + +##### xdm:expressionType Type + + +`string` + + + +##### xdm:expressionType Known Values +| Value | Description | +|-------|-------------| +| `0` | PQL | +| `1` | AAM | +| `2` | QUERYSERVICE | + + + + + + +#### xdm:mimeType +##### Expression mime type + +Mime type of the expression. For example, pql/text or application/sql. + +`xdm:mimeType` +* is optional +* type: `string` + +##### xdm:mimeType Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5Cw%2B%2F%5B-.%5Cw%5D%2B(%3F%3A%5C%2B%5B-.%5Cw%5D%2B)%3F)): +```regex +\w+/[-.\w]+(?:\+[-.\w]+)? +``` + + + + + + + + +#### xdm:value +##### Value + +Actual expression string. The syntax of expression will depend upon specified mime type. + +`xdm:value` +* is optional +* type: `string` + +##### xdm:value Type + + +`string` + + + + + + + + + + + +## xdm:segmentFolderId +### Folder Id + +id of parent folder if present + +`xdm:segmentFolderId` +* is optional +* type: `string` +* defined in this schema + +### xdm:segmentFolderId Type + + +`string` + + + + + + +## xdm:segmentSubType +### Sub Type + +Further classification of AAM Entity + +`xdm:segmentSubType` +* is optional +* type: `string` +* defined in this schema + +### xdm:segmentSubType Type + + +`string` + + + +### xdm:segmentSubType Known Values +| Value | Description | +|-------|-------------| +| `0` | FOLDER | +| `1` | FOLDER_TRAIT | +| `2` | SEGMENT | +| `3` | UNDEFINED | +| `4` | RULE_BASED_TRAIT | +| `5` | NON_ALGO_TRAIT | +| `6` | TEST_SEGMENT | +| `7` | COMPANY_ACTIVITY_TRAIT | +| `8` | ALGO_TRAIT | +| `9` | ON_BOARDED_TRAIT | + + + diff --git a/docs/reference/adobe/experience/audiencemanager/segmentfolder.schema.json b/docs/reference/adobe/experience/audiencemanager/segmentfolder.schema.json new file mode 100644 index 000000000..22e87d332 --- /dev/null +++ b/docs/reference/adobe/experience/audiencemanager/segmentfolder.schema.json @@ -0,0 +1,80 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/audiencemanager/segmentfolder", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Audience Manager Segment Folder Class", + "type": "object", + "description": "This Adobe Audience Manager-specific folder definition helps organize segment definitions into a hierarchy. This includes required fields like folder identity and folder name. The segment definition class requires use of the 'Adobe Audience Manager Segment Definition Mixin' in order to point to the parent folder, which is an instance of this class.", + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record" + ], + "definitions": { + "segmentfolder": { + "properties": { + "https://ns.adobe.com/experience/audiencemanager/segmentFolderName": { + "title": "Segment folder name", + "type": "string", + "description": "Name of the segment folder" + }, + "https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus": { + "type": "string", + "title": "Segment folder status", + "description": "Current status of segment folder", + "meta:enum": { + "ACTIVE": "Active", + "INACTIVE": "Inactive", + "DELETED": "Deleted" + } + }, + "https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity": { + "title": "Parent folder identity", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Identity of the parent folder of current folder" + } + } + } + }, + "required": [ + "xdm:identityMap", + "https://ns.adobe.com/experience/audiencemanager/segmentFolderName" + ], + "allOf": [ + { + "$ref": "#/definitions/segmentfolder" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:identityMap": { + "AAMSegments": [ + { + "xdm:id": "id123", + "xdm:primary": true + } + ] + }, + "https://ns.adobe.com/experience/audiencemanager/segmentFolderName": "User Folder", + "https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus": "ACTIVE", + "https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity": { + "xdm:id": "id1111", + "xdm:namespace": { + "xdm:code": "AAMSegments" + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/audiencemanager/segmentfolder.schema.md b/docs/reference/adobe/experience/audiencemanager/segmentfolder.schema.md new file mode 100644 index 000000000..0232f51d5 --- /dev/null +++ b/docs/reference/adobe/experience/audiencemanager/segmentfolder.schema.md @@ -0,0 +1,161 @@ + +# Adobe Audience Manager Segment Folder Class Schema + +``` +https://ns.adobe.com/experience/audiencemanager/segmentfolder +``` + +This Adobe Audience Manager-specific folder definition helps organize segment definitions into a hierarchy. This includes required fields like folder identity and folder name. The segment definition class requires use of the 'Adobe Audience Manager Segment Definition Mixin' in order to point to the parent folder, which is an instance of this class. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/audiencemanager/segmentfolder.schema.json](adobe/experience/audiencemanager/segmentfolder.schema.json) | +## Schema Hierarchy + +* Adobe Audience Manager Segment Folder Class `https://ns.adobe.com/experience/audiencemanager/segmentfolder` + * [Identity](../../../datatypes/identity.schema.md) `https://ns.adobe.com/xdm/context/identity` + * [IdentityMap](../../../mixins/shared/identitymap.schema.md) `https://ns.adobe.com/xdm/context/identitymap` + * [Record Schema](../../../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + + +## Adobe Audience Manager Segment Folder Class Example +```json +{ + "xdm:identityMap": { + "AAMSegments": [ + { + "xdm:id": "id123", + "xdm:primary": true + } + ] + }, + "https://ns.adobe.com/experience/audiencemanager/segmentFolderName": "User Folder", + "https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus": "ACTIVE", + "https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity": { + "xdm:id": "id1111", + "xdm:namespace": { + "xdm:code": "AAMSegments" + } + } +} +``` + +# Adobe Audience Manager Segment Folder Class Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../../../behaviors/record.schema.md#id) | +| [https://ns.adobe.com/experience/audiencemanager/segmentFolderName](#httpsnsadobecomexperienceaudiencemanagersegmentfoldername) | `string` | **Required** | Adobe Audience Manager Segment Folder Class (this schema) | +| [https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus](#httpsnsadobecomexperienceaudiencemanagersegmentfolderstatus) | `string` | Optional | Adobe Audience Manager Segment Folder Class (this schema) | +| [https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity](#httpsnsadobecomexperienceaudiencemanagersegmentparentfolderidentity) | Identity | Optional | Adobe Audience Manager Segment Folder Class (this schema) | +| [xdm:identityMap](#xdmidentitymap) | `object` | **Required** | [IdentityMap](../../../mixins/shared/identitymap.schema.md#xdmidentitymap) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../../../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## https://ns.adobe.com/experience/audiencemanager/segmentFolderName +### Segment folder name + +Name of the segment folder + +`https://ns.adobe.com/experience/audiencemanager/segmentFolderName` +* is **required** +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/audiencemanager/segmentFolderName Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus +### Segment folder status + +Current status of segment folder + +`https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus Type + + +`string` + + + +### https://ns.adobe.com/experience/audiencemanager/segmentFolderStatus Known Values +| Value | Description | +|-------|-------------| +| `ACTIVE` | Active | +| `INACTIVE` | Inactive | +| `DELETED` | Deleted | + + + + +## https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity +### Parent folder identity + +Identity of the parent folder of current folder + +`https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity` +* is optional +* type: Identity +* defined in this schema + +### https://ns.adobe.com/experience/audiencemanager/segmentParentFolderIdentity Type + + +* [Identity](../../../datatypes/identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + + +## xdm:identityMap + + +`xdm:identityMap` +* is **required** +* type: `object` +* defined in [IdentityMap](../../../mixins/shared/identitymap.schema.md#xdmidentitymap) + +### xdm:identityMap Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + diff --git a/docs/reference/adobe/experience/campaign-experienceevent.schema.json b/docs/reference/adobe/experience/campaign-experienceevent.schema.json new file mode 100644 index 000000000..8b6786a99 --- /dev/null +++ b/docs/reference/adobe/experience/campaign-experienceevent.schema.json @@ -0,0 +1,193 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign-experienceevent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Campaign ExperienceEvent Template Mixin", + "type": "object", + "description": "Campaign ExperienceEvent mixin for use with schemas for Solution data ingestion. Includes the core/standard ExperienceEvent as well as the required Adobe Campaign ExperienceEvent mixins.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent", + "https://ns.adobe.com/experience/decisioning/decisionevent" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/experienceevent-advertising", + "https://ns.adobe.com/xdm/context/experienceevent-application", + "https://ns.adobe.com/xdm/context/experienceevent-channel", + "https://ns.adobe.com/xdm/context/experienceevent-commerce", + "https://ns.adobe.com/xdm/context/experienceevent-directmarketing", + "https://ns.adobe.com/xdm/context/experienceevent-environment-details", + "https://ns.adobe.com/xdm/context/experienceevent-marketing", + "https://ns.adobe.com/xdm/context/experienceevent-media", + "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch", + "https://ns.adobe.com/xdm/context/experienceevent-search", + "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership", + "https://ns.adobe.com/xdm/context/experienceevent-technical-details", + "https://ns.adobe.com/xdm/context/experienceevent-web", + "https://ns.adobe.com/experience/campaign/experienceevent-all", + "https://ns.adobe.com/experience/decisioning/proposition", + "https://ns.adobe.com/experience/target/experienceevent-shared", + "https://ns.adobe.com/experience/profile/experienceevent-shared", + "https://ns.adobe.com/experience/implementations-ext", + "https://ns.adobe.com/xdm/context/experienceevent-enduserids" + ], + "definitions": { + "campaign-experienceevent": { + "properties": {} + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-advertising" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-application" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-channel" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-commerce" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-directmarketing" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-marketing" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-media" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-search" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-technical-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-web" + }, + { + "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all" + }, + { + "$ref": "https://ns.adobe.com/experience/decisioning/proposition" + }, + { + "$ref": "https://ns.adobe.com/experience/target/experienceevent-shared" + }, + { + "$ref": "https://ns.adobe.com/experience/profile/experienceevent-shared" + }, + { + "$ref": "https://ns.adobe.com/experience/implementations-ext" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-enduserids" + }, + { + "$ref": "#/definitions/campaign-experienceevent" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/experienceid-1234567", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-124", + "xdm:code": "DataSourceIntegrationCode-124" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "68519882713298129995549973016107434638", + "xdm:primary": true + } + ], + "CPGN": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/1234567", + "xdm:primary": true + } + ] + }, + "xdm:directMarketing": { + "xdm:sends": { + "xdm:value": 1 + } + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/email" + }, + "https://ns.adobe.com/experience/campaign/message": { + "xdm:id": 10000, + "xdm:profile": { + "xdm:person": { + "xdm:birthMonth": 1, + "xdm:birthDay": 3, + "xdm:birthYear": 1996, + "xdm:gender": "female" + }, + "xdm:workAddress": { + "@id": "https://ns.adobe.com/entities/address/123", + "xdm:primary": true, + "xdm:city": "San Jose", + "xdm:stateProvinceISO": "CA", + "xdm:postalCode": "95110", + "xdm:countryCode": "US" + }, + "xdm:workEmail": { + "xdm:primary": true, + "xdm:address": "jsmith@xyzinc.com" + } + }, + "xdm:variant": "English", + "xdm:seedMember": false, + "xdm:quarantine": false, + "xdm:proofMember": false, + "xdm:controlGroupMember": false, + "xdm:testMember": true, + "xdm:size": 421, + "xdm:outboundIP": "10.20.30.40", + "xdm:externalID": "uuid:00112233-4455-6677-8899-AABBCCDDEEFF" + }, + "https://ns.adobe.com/experience/campaign/delivery": { + "xdm:id": 1001, + "xdm:from": "no-reply@adobe.com", + "xdm:testEnabled": true, + "xdm:messageClass": "continuous", + "xdm:templateID": 1000, + "xdm:deliveryName": "DM200", + "xdm:deliveryLabel": "Birthday Wishes" + }, + "https://ns.adobe.com/experience/campaign/marketingCampaign": { + "xdm:id": 100, + "xdm:campaignName": "CAMP2010" + }, + "https://ns.adobe.com/experience/campaign/orchestration": { + "xdm:eventID": "onJourneyEnter" + }, + "https://ns.adobe.com/experience/campaign/containerID": "customer-stage", + "https://ns.adobe.com/experience/campaign/eventSource": "pipelined-mta" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign-experienceevent.schema.md b/docs/reference/adobe/experience/campaign-experienceevent.schema.md new file mode 100644 index 000000000..5c1022e95 --- /dev/null +++ b/docs/reference/adobe/experience/campaign-experienceevent.schema.md @@ -0,0 +1,1300 @@ + +# Adobe Campaign ExperienceEvent Template Mixin Schema + +``` +https://ns.adobe.com/experience/campaign-experienceevent +``` + +Campaign ExperienceEvent mixin for use with schemas for Solution data ingestion. Includes the core/standard ExperienceEvent as well as the required Adobe Campaign ExperienceEvent mixins. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign-experienceevent.schema.json](adobe/experience/campaign-experienceevent.schema.json) | +## Schema Hierarchy + +* Adobe Campaign ExperienceEvent Template Mixin `https://ns.adobe.com/experience/campaign-experienceevent` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [ExperienceEvent details for advertising](../../mixins/experience-event/experienceevent-advertising.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-advertising` + * [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-application` + * [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-channel` + * [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-commerce` + * [ExperienceEvent direct marketing details](../../mixins/experience-event/experienceevent-directmarketing.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-directmarketing` + * [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-environment-details` + * [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-marketing` + * [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-media` + * [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-profile-stitch` + * [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-search` + * [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-segmentmembership` + * [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-technical-details` + * [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-web` + * [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md) `https://ns.adobe.com/experience/campaign/experienceevent-all` + * [Decision Proposition Reference](decisioning/proposition.schema.md) `https://ns.adobe.com/experience/decisioning/proposition` + * [Adobe Target ExperienceEvent Shared Extension](target/experienceevent-shared.schema.md) `https://ns.adobe.com/experience/target/experienceevent-shared` + * [Adobe Unified Profile Service ExperienceEvent Shared Extension](profile/experienceevent-shared.schema.md) `https://ns.adobe.com/experience/profile/experienceevent-shared` + * [Adobe Experience Platform Implementation Details Mixin](implementations-ext.schema.md) `https://ns.adobe.com/experience/implementations-ext` + * [ExperienceEvent EndUserIDs](../../mixins/experience-event/experienceevent-enduserids.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-enduserids` + + +## Adobe Campaign ExperienceEvent Template Mixin Example +```json +{ + "@id": "https://data.adobe.io/experienceid-1234567", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-124", + "xdm:code": "DataSourceIntegrationCode-124" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "68519882713298129995549973016107434638", + "xdm:primary": true + } + ], + "CPGN": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/1234567", + "xdm:primary": true + } + ] + }, + "xdm:directMarketing": { + "xdm:sends": { + "xdm:value": 1 + } + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/email" + }, + "https://ns.adobe.com/experience/campaign/message": { + "xdm:id": 10000, + "xdm:profile": { + "xdm:person": { + "xdm:birthMonth": 1, + "xdm:birthDay": 3, + "xdm:birthYear": 1996, + "xdm:gender": "female" + }, + "xdm:workAddress": { + "@id": "https://ns.adobe.com/entities/address/123", + "xdm:primary": true, + "xdm:city": "San Jose", + "xdm:stateProvinceISO": "CA", + "xdm:postalCode": "95110", + "xdm:countryCode": "US" + }, + "xdm:workEmail": { + "xdm:primary": true, + "xdm:address": "jsmith@xyzinc.com" + } + }, + "xdm:variant": "English", + "xdm:seedMember": false, + "xdm:quarantine": false, + "xdm:proofMember": false, + "xdm:controlGroupMember": false, + "xdm:testMember": true, + "xdm:size": 421, + "xdm:outboundIP": "10.20.30.40", + "xdm:externalID": "uuid:00112233-4455-6677-8899-AABBCCDDEEFF" + }, + "https://ns.adobe.com/experience/campaign/delivery": { + "xdm:id": 1001, + "xdm:from": "no-reply@adobe.com", + "xdm:testEnabled": true, + "xdm:messageClass": "continuous", + "xdm:templateID": 1000, + "xdm:deliveryName": "DM200", + "xdm:deliveryLabel": "Birthday Wishes" + }, + "https://ns.adobe.com/experience/campaign/marketingCampaign": { + "xdm:id": 100, + "xdm:campaignName": "CAMP2010" + }, + "https://ns.adobe.com/experience/campaign/orchestration": { + "xdm:eventID": "onJourneyEnter" + }, + "https://ns.adobe.com/experience/campaign/containerID": "customer-stage", + "https://ns.adobe.com/experience/campaign/eventSource": "pipelined-mta" +} +``` + +# Adobe Campaign ExperienceEvent Template Mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/containerID](#httpsnsadobecomexperiencecampaigncontainerid) | `string` | Optional | [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaigncontainerid) | +| [https://ns.adobe.com/experience/campaign/delivery](#httpsnsadobecomexperiencecampaigndelivery) | `object` | Optional | [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaigndelivery) | +| [https://ns.adobe.com/experience/campaign/eventSource](#httpsnsadobecomexperiencecampaigneventsource) | `string` | Optional | [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaigneventsource) | +| [https://ns.adobe.com/experience/campaign/link](#httpsnsadobecomexperiencecampaignlink) | `object` | Optional | [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignlink) | +| [https://ns.adobe.com/experience/campaign/marketingCampaign](#httpsnsadobecomexperiencecampaignmarketingcampaign) | `object` | Optional | [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignmarketingcampaign) | +| [https://ns.adobe.com/experience/campaign/medium](#httpsnsadobecomexperiencecampaignmedium) | `string` | Optional | [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignmedium) | +| [https://ns.adobe.com/experience/campaign/message](#httpsnsadobecomexperiencecampaignmessage) | message.schema | Optional | [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignmessage) | +| [https://ns.adobe.com/experience/campaign/mutation](#httpsnsadobecomexperiencecampaignmutation) | Adobe Campaign Mutation Event | Optional | [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignmutation) | +| [https://ns.adobe.com/experience/campaign/offerOpened](#httpsnsadobecomexperiencecampaignofferopened) | Campaign Offer Response Detail | Optional | [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignofferopened) | +| [https://ns.adobe.com/experience/campaign/offersProposed](#httpsnsadobecomexperiencecampaignoffersproposed) | Campaign Offer Proposition Detail | Optional | [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignoffersproposed) | +| [https://ns.adobe.com/experience/campaign/orchestration](#httpsnsadobecomexperiencecampaignorchestration) | orchestration.schema | Optional | [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignorchestration) | +| [https://ns.adobe.com/experience/decisioning/propositionID](#httpsnsadobecomexperiencedecisioningpropositionid) | `string` | Optional | [Decision Proposition Reference](decisioning/proposition.schema.md#httpsnsadobecomexperiencedecisioningpropositionid) | +| [https://ns.adobe.com/experience/implementations](#httpsnsadobecomexperienceimplementations) | Adobe Experience Platform Implementation Details | Optional | [Adobe Experience Platform Implementation Details Mixin](implementations-ext.schema.md#httpsnsadobecomexperienceimplementations) | +| [https://ns.adobe.com/experience/profile/originDatasetID](#httpsnsadobecomexperienceprofileorigindatasetid) | `string` | Optional | [Adobe Unified Profile Service ExperienceEvent Shared Extension](profile/experienceevent-shared.schema.md#httpsnsadobecomexperienceprofileorigindatasetid) | +| [https://ns.adobe.com/experience/target/supplementalDataID](#httpsnsadobecomexperiencetargetsupplementaldataid) | `string` | Optional | [Adobe Target ExperienceEvent Shared Extension](target/experienceevent-shared.schema.md#httpsnsadobecomexperiencetargetsupplementaldataid) | +| [xdm:advertising](#xdmadvertising) | Advertising | Optional | [ExperienceEvent details for advertising](../../mixins/experience-event/experienceevent-advertising.schema.md#xdmadvertising) | +| [xdm:application](#xdmapplication) | Application | Optional | [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md#xdmapplication) | +| [xdm:channel](#xdmchannel) | Experience Channel | Optional | [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md#xdmchannel) | +| [xdm:commerce](#xdmcommerce) | Commerce | Optional | [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmcommerce) | +| [xdm:dataSource](#xdmdatasource) | Data Source | Optional | [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmdatasource) | +| [xdm:device](#xdmdevice) | Device | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) | +| [xdm:directMarketing](#xdmdirectmarketing) | Direct marketing | Optional | [ExperienceEvent direct marketing details](../../mixins/experience-event/experienceevent-directmarketing.schema.md#xdmdirectmarketing) | +| [xdm:endUserIDs](#xdmenduserids) | End user IDs | Optional | [ExperienceEvent EndUserIDs](../../mixins/experience-event/experienceevent-enduserids.schema.md#xdmenduserids) | +| [xdm:environment](#xdmenvironment) | Environment | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) | +| [xdm:marketing](#xdmmarketing) | Marketing | Optional | [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md#xdmmarketing) | +| [xdm:media](#xdmmedia) | Media information | Optional | [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md#xdmmedia) | +| [xdm:placeContext](#xdmplacecontext) | Place context | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) | +| [xdm:productListItems](#xdmproductlistitems) | Product list item | Optional | [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmproductlistitems) | +| [xdm:profileStitch](#xdmprofilestitch) | Profile stitch | Optional | [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md#xdmprofilestitch) | +| [xdm:receivedTimestamp](#xdmreceivedtimestamp) | `string` | Optional | [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmreceivedtimestamp) | +| [xdm:search](#xdmsearch) | Search | Optional | [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md#xdmsearch) | +| [xdm:segmentMembership](#xdmsegmentmembership) | `object` | Optional | [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmembership) | +| [xdm:segmentMemberships](#xdmsegmentmemberships) | Segment membership item | Optional | [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) | +| [xdm:web](#xdmweb) | Web information | Optional | [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md#xdmweb) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/containerID +### Container Identifier + +The identifier denoting the container with which Campaign ExperienceEvent is associated. + +`https://ns.adobe.com/experience/campaign/containerID` +* is optional +* type: `string` +* defined in [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaigncontainerid) + +### https://ns.adobe.com/experience/campaign/containerID Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/campaign/delivery +### The campaign activity originating a message to a recipient. + +`https://ns.adobe.com/experience/campaign/delivery` +* is optional +* type: `object` +* defined in [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaigndelivery) + +### https://ns.adobe.com/experience/campaign/delivery Type + + +`object` with following properties: + + +| Property | Type | Required | Default | +|----------|------|----------|---------| +| `xdm:deliveryLabel`| string | Optional | | +| `xdm:deliveryName`| string | Optional | | +| `xdm:from`| string | Optional | | +| `xdm:id`| integer | Optional | | +| `xdm:messageClass`| string | Optional | `"one_time"` | +| `xdm:templateID`| integer | Optional | | +| `xdm:templateName`| string | Optional | | +| `xdm:testEnabled`| boolean | Optional | `false` | + + + +#### xdm:deliveryLabel +##### Delivery Label + +A human-friendly name of the campaign activity which is originating this message. + +`xdm:deliveryLabel` +* is optional +* type: `string` + +##### xdm:deliveryLabel Type + + +`string` + + + + + + + + +#### xdm:deliveryName +##### Delivery Internal Name + +A human-friendly identifier of the campaign activity which is originating this message. + +`xdm:deliveryName` +* is optional +* type: `string` + +##### xdm:deliveryName Type + + +`string` + + + + + + + + +#### xdm:from +##### From + +Address used as a from/sender/caller address. Depending on the communication channel, the `address` has a different format. + + * `email`: an email address. + * `textMessage` or `phone`: a shortcode or phone number. + +`xdm:from` +* is optional +* type: `string` + +##### xdm:from Type + + +`string` + + + + + + + + +#### xdm:id +##### Delivery ID + +The campaign activity originating this message. + +`xdm:id` +* is optional +* type: `integer` + +##### xdm:id Type + + +`integer` + + + + + + + + +#### xdm:messageClass +##### Message Class + +Mode of delivery for the messages sent. + + +`xdm:messageClass` +* is optional +* type: `string` +* default: `"one_time"` + + +##### xdm:messageClass Type + + +`string` + + + +##### xdm:messageClass Known Values +| Value | Description | +|-------|-------------| +| `one_time` | Marketing (One Time) | +| `continuous` | Recurring | +| `event_based` | Transactional (Event-based) | + + + + + + +#### xdm:templateID +##### Identifier of the Template + +The delivery template's ID used to initialize this delivery. + +The type the template used in Adobe Campaign can be identified using the `messageClass`. + +* `messageClass` = `oneTime`: the template is standard delivery template. +* `messageClass` = `continuous`: the template is a recurring delivery. +* `messageClass` = `transactional`: the template is a transactional message template. + + +`xdm:templateID` +* is optional +* type: `integer` + +##### xdm:templateID Type + + +`integer` + + + + + + + + +#### xdm:templateName +##### Delivery Template's Internal Name + +A human-friendly identifier of the the parent entity (in case of event_based or continuous message Class) of the campaign activity originating this message. + +`xdm:templateName` +* is optional +* type: `string` + +##### xdm:templateName Type + + +`string` + + + + + + + + +#### xdm:testEnabled +##### Test Enabled + +Specify whether campaign activity is of type A/B testing. + +`xdm:testEnabled` +* is optional +* type: `boolean` +* default: `false` + + +##### xdm:testEnabled Type + + +`boolean` + + + + + + + + + + +## https://ns.adobe.com/experience/campaign/eventSource +### Event Source + +A human-friendly name of the campaign activity which is originating this message. + +`https://ns.adobe.com/experience/campaign/eventSource` +* is optional +* type: `string` +* defined in [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaigneventsource) + +### https://ns.adobe.com/experience/campaign/eventSource Type + + +`string` + + + +### https://ns.adobe.com/experience/campaign/eventSource Known Values +| Value | Description | +|-------|-------------| +| `replay-pipelined-mta` | This event was generated via Replay Utility tool generated from Pipelined | +| `replay-pipelined-inMail` | This event was generated via Replay Utility tool generated from Pipelined | +| `replay-pipelined-trackinglogd` | This event was generated via Replay Utility tool generated from Pipelined | +| `replay-pipelined-pipelined` | This event was generated via Replay Utility tool generated from Pipelined | +| `pipelined-mta` | This event was generated via Pipelined generated from mta | +| `pipelined-inMail` | This event was generated via Pipelined generated from inMail | +| `pipelined-trackinglogd` | This event was generated via Pipelined generated from trackinglogd | +| `pipelined-pipelined` | This event was generated via Pipelined generated from Pipelined | +| `replay` | This event was generated via Replay Utility tool which did not have any event source | +| `pipelined-tracker` | This event was generated via Pipelined generated from TrackeR | + + + + +## https://ns.adobe.com/experience/campaign/link +### The campaign activity originating a message to a recipient. + +`https://ns.adobe.com/experience/campaign/link` +* is optional +* type: `object` +* defined in [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignlink) + +### https://ns.adobe.com/experience/campaign/link Type + + +`object` with following properties: + + +| Property | Type | Required | Default | +|----------|------|----------|---------| +| `xdm:category`| string | Optional | | +| `xdm:description`| string | Optional | | +| `xdm:id`| string | Optional | | +| `xdm:inAppMessageAction`| string | Optional | | +| `xdm:inAppMessageButtonText`| string | Optional | | +| `xdm:label`| string | Optional | | +| `xdm:occurrence`| integer | Optional | `1` | +| `xdm:url`| string | Optional | | + + + +#### xdm:category +##### URL Category + +The category of the link. It may be `subscription`, or a user-defined category. + +`xdm:category` +* is optional +* type: `string` + +##### xdm:category Type + + +`string` + + + + + + + + +#### xdm:description +##### Tracking URL Description + +A human-friendly description of the link. + +`xdm:description` +* is optional +* type: `string` + +##### xdm:description Type + + +`string` + + + + + + + + +#### xdm:id +##### Tracking URL ID + +Unique Identifier of the Link + +`xdm:id` +* is optional +* type: `string` + +##### xdm:id Type + + +`string` + + + + + + + + +#### xdm:inAppMessageAction +##### In-App Message Action + +Actions on the In-App message delivered, e.g. action on primary button, secondary button or close button. + +`xdm:inAppMessageAction` +* is optional +* type: `string` + +##### xdm:inAppMessageAction Type + + +`string` + + + +##### xdm:inAppMessageAction Known Values +| Value | Description | +|-------|-------------| +| `primary` | Primary action | +| `secondary` | Secondary action | +| `dismiss` | Dismiss action | + + + + + + +#### xdm:inAppMessageButtonText +##### In-App Message Button Text + +The user-friendly text on the button. + +`xdm:inAppMessageButtonText` +* is optional +* type: `string` + +##### xdm:inAppMessageButtonText Type + + +`string` + + + + + + + + +#### xdm:label +##### URL Label + +The user-friendly label clicking on which the link opens. + +`xdm:label` +* is optional +* type: `string` + +##### xdm:label Type + + +`string` + + + + + + + + +#### xdm:occurrence +##### Occurrence + +URL occurrence index in the content (first is 1). When the same URL is available several times in the same content, its is necessary to track which occurrence of the URL has been clicked on. + +`xdm:occurrence` +* is optional +* type: `integer` +* default: `1` + + +##### xdm:occurrence Type + + +`integer` +* minimum value: `1` +* maximum value: `32767` + + + + + + + +#### xdm:url +##### URL + +URL of the Link. + +`xdm:url` +* is optional +* type: `string` + +##### xdm:url Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + + + + + + +## https://ns.adobe.com/experience/campaign/marketingCampaign +### The campaign activity originating a message to a recipient. + +`https://ns.adobe.com/experience/campaign/marketingCampaign` +* is optional +* type: `object` +* defined in [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignmarketingcampaign) + +### https://ns.adobe.com/experience/campaign/marketingCampaign Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:campaignName`| string | Optional | +| `xdm:id`| integer | Optional | + + + +#### xdm:campaignName +##### Campaign Internal Name + +A human-friendly identifier of the marketing campaign which is originating this message. + +`xdm:campaignName` +* is optional +* type: `string` + +##### xdm:campaignName Type + + +`string` + + + + + + + + +#### xdm:id +##### Campaign ID + +Identifier of the marketing campaign to which activity originating this message belongs to. + +`xdm:id` +* is optional +* type: `integer` + +##### xdm:id Type + + +`integer` + + + + + + + + + + + +## https://ns.adobe.com/experience/campaign/medium +### Medium + +The medium is a combination of the source of the event (message, web, ...) and its format if applicable. + +`https://ns.adobe.com/experience/campaign/medium` +* is optional +* type: `string` +* defined in [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignmedium) + +### https://ns.adobe.com/experience/campaign/medium Type + + +`string` + + + +### https://ns.adobe.com/experience/campaign/medium Known Values +| Value | Description | +|-------|-------------| +| `message_text` | The source of the event is message in a text format. | +| `message_html` | The source of the event is message in a html format. | +| `message_line` | The source of the event is a line message. | +| `web` | The source of the event is web tracking tag in a web page. | +| `offer` | The source of the event is an offer. | + + + + +## https://ns.adobe.com/experience/campaign/message +### A single message sent to a recipient. + +`https://ns.adobe.com/experience/campaign/message` +* is optional +* type: message.schema +* defined in [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignmessage) + +### https://ns.adobe.com/experience/campaign/message Type + + +* [message.schema](campaign/message.schema.md) – `https://ns.adobe.com/experience/campaign/message` + + + + + +## https://ns.adobe.com/experience/campaign/mutation +### Mutated Fields from Previous ExperienceEvent. + +Information of the fields that have changed since the previous ExperienceEvent to keep track of the state changes across events. For e.g. if when an email gets sent, an ExperienceEvent with metric `sends` will be sent. This may get bounced and an ExperienceEvent with metric `bounces` will be sent then. It may be important for a downstream application to know that the previous ExperienceEvent with metric `sends` is now to be invalidated. This field will contain the values from the previous ExperienceEvent that have a different value in the current ExperienceEvent. + +`https://ns.adobe.com/experience/campaign/mutation` +* is optional +* type: Adobe Campaign Mutation Event +* defined in [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignmutation) + +### https://ns.adobe.com/experience/campaign/mutation Type + + +* [Adobe Campaign Mutation Event](campaign/mutationevent.schema.md) – `https://ns.adobe.com/experience/campaign/mutationevent` + + + + + +## https://ns.adobe.com/experience/campaign/offerOpened +### Offer Opened + +The offer in the message for an 'offer opened' event. + +`https://ns.adobe.com/experience/campaign/offerOpened` +* is optional +* type: Campaign Offer Response Detail +* defined in [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignofferopened) + +### https://ns.adobe.com/experience/campaign/offerOpened Type + + +* [Campaign Offer Response Detail](campaign/offer-response-detail.schema.md) – `https://ns.adobe.com/experience/campaign/offer-response-detail` + + + + + +## https://ns.adobe.com/experience/campaign/offersProposed +### Offer Propositions + +The offers in the message of a 'email-send' event. + +`https://ns.adobe.com/experience/campaign/offersProposed` +* is optional +* type: Campaign Offer Proposition Detail + +* defined in [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignoffersproposed) + +### https://ns.adobe.com/experience/campaign/offersProposed Type + + +Array type: Campaign Offer Proposition Detail + +All items must be of the type: +* [Campaign Offer Proposition Detail](campaign/offer-proposition-detail.schema.md) – `https://ns.adobe.com/experience/campaign/offer-proposition-detail` + + + + + + + + +## https://ns.adobe.com/experience/campaign/orchestration +### Campaign Orchestration for creating user journey. + +`https://ns.adobe.com/experience/campaign/orchestration` +* is optional +* type: orchestration.schema +* defined in [Adobe Campaign ExperienceEvent Full Extension](campaign/experienceevent-all.schema.md#httpsnsadobecomexperiencecampaignorchestration) + +### https://ns.adobe.com/experience/campaign/orchestration Type + + +* [orchestration.schema](campaign/orchestration.schema.md) – `https://ns.adobe.com/experience/campaign/orchestration` + + + + + +## https://ns.adobe.com/experience/decisioning/propositionID +### Proposition Identifier + +A unique identifier for the proposition event referenced by an "XDM ExperienceEvent". It is the expectation that applications use this "propositionID" in every experience event that was influenced by the set of propositions. An individual profile's proposition-response history is maintained with these proposition identifiers. + +`https://ns.adobe.com/experience/decisioning/propositionID` +* is optional +* type: `string` +* defined in [Decision Proposition Reference](decisioning/proposition.schema.md#httpsnsadobecomexperiencedecisioningpropositionid) + +### https://ns.adobe.com/experience/decisioning/propositionID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## https://ns.adobe.com/experience/implementations + + +`https://ns.adobe.com/experience/implementations` +* is optional +* type: Adobe Experience Platform Implementation Details +* defined in [Adobe Experience Platform Implementation Details Mixin](implementations-ext.schema.md#httpsnsadobecomexperienceimplementations) + +### https://ns.adobe.com/experience/implementations Type + + +* [Adobe Experience Platform Implementation Details](implementations.schema.md) – `https://ns.adobe.com/experience/implementations` + + + + + +## https://ns.adobe.com/experience/profile/originDatasetID +### Origin Dataset ID + +Identity of the dataset that the Unified Profile Service ingested the data from. Usage is reserved for the Unified Profile Service. + +`https://ns.adobe.com/experience/profile/originDatasetID` +* is optional +* type: `string` +* defined in [Adobe Unified Profile Service ExperienceEvent Shared Extension](profile/experienceevent-shared.schema.md#httpsnsadobecomexperienceprofileorigindatasetid) + +### https://ns.adobe.com/experience/profile/originDatasetID Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/supplementalDataID +### Supplemental Data Identifier + +Identifier used to stitch Target events with Analytics events + +`https://ns.adobe.com/experience/target/supplementalDataID` +* is optional +* type: `string` +* defined in [Adobe Target ExperienceEvent Shared Extension](target/experienceevent-shared.schema.md#httpsnsadobecomexperiencetargetsupplementaldataid) + +### https://ns.adobe.com/experience/target/supplementalDataID Type + + +`string` + + + + + + +## xdm:advertising +### Advertising + +Information related to advertising activity in ExperienceEvents. + +`xdm:advertising` +* is optional +* type: Advertising +* defined in [ExperienceEvent details for advertising](../../mixins/experience-event/experienceevent-advertising.schema.md#xdmadvertising) + +### xdm:advertising Type + + +* [Advertising](../../datatypes/advertising.schema.md) – `https://ns.adobe.com/xdm/context/advertising` + + + + + +## xdm:application +### Application + +This mixin is used to capture application information related to an ExperienceEvent, including the name of the application, app version, installs, launches, crashes, and closures. It could be either the application targeted by the event like the send of a push notification or the application originating the event such as a click, or a login. + +`xdm:application` +* is optional +* type: Application +* defined in [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md#xdmapplication) + +### xdm:application Type + + +* [Application](../../datatypes/application.schema.md) – `https://ns.adobe.com/xdm/context/application` + + + + + +## xdm:channel +### Experience channel + +Experience channel related to the ExperienceEvent. + +`xdm:channel` +* is optional +* type: Experience Channel +* defined in [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md#xdmchannel) + +### xdm:channel Type + + +* [Experience Channel](../../datatypes/channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel` + + + + + +## xdm:commerce +### Commerce + +Commerce specific data related to this event. + +`xdm:commerce` +* is optional +* type: Commerce +* defined in [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmcommerce) + +### xdm:commerce Type + + +* [Commerce](../../datatypes/commerce.schema.md) – `https://ns.adobe.com/xdm/context/commerce` + + + + + +## xdm:dataSource +### Data source + +Globally unique identification of a data source. + +`xdm:dataSource` +* is optional +* type: Data Source +* defined in [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmdatasource) + +### xdm:dataSource Type + + +* [Data Source](../../datatypes/data/datasource.schema.md) – `https://ns.adobe.com/xdm/data/datasource` + + + + + +## xdm:device +### Device + +An identified device, application or device browser instance that is trackable across sessions, normally by cookies. + +`xdm:device` +* is optional +* type: Device +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) + +### xdm:device Type + + +* [Device](../../datatypes/device.schema.md) – `https://ns.adobe.com/xdm/context/device` + + + + + +## xdm:directMarketing +### Direct marketing + +Events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications. + +`xdm:directMarketing` +* is optional +* type: Direct marketing +* defined in [ExperienceEvent direct marketing details](../../mixins/experience-event/experienceevent-directmarketing.schema.md#xdmdirectmarketing) + +### xdm:directMarketing Type + + +* [Direct marketing](../../datatypes/direct-marketing.schema.md) – `https://ns.adobe.com/xdm/context/direct-marketing` + + + + + +## xdm:endUserIDs +### EndUserIDs + +Condensed, normalized encapsulation of end user identifiers asserted for this ExperienceEvent. + +`xdm:endUserIDs` +* is optional +* type: End user IDs +* defined in [ExperienceEvent EndUserIDs](../../mixins/experience-event/experienceevent-enduserids.schema.md#xdmenduserids) + +### xdm:endUserIDs Type + + +* [End user IDs](../../datatypes/enduserids.schema.md) – `https://ns.adobe.com/xdm/context/enduserids` + + + + + +## xdm:environment +### Environment + +Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions. + +`xdm:environment` +* is optional +* type: Environment +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) + +### xdm:environment Type + + +* [Environment](../../datatypes/environment.schema.md) – `https://ns.adobe.com/xdm/context/environment` + + + + + +## xdm:marketing +### Marketing + +The information related to marketing activities that are active with the touchpoint. + +`xdm:marketing` +* is optional +* type: Marketing +* defined in [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md#xdmmarketing) + +### xdm:marketing Type + + +* [Marketing](../../datatypes/marketing.schema.md) – `https://ns.adobe.com/xdm/context/marketing` + + + + + +## xdm:media +### Media + +Media activity information related to the experience event. + +`xdm:media` +* is optional +* type: Media information +* defined in [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md#xdmmedia) + +### xdm:media Type + + +* [Media information](../../datatypes/media.schema.md) – `https://ns.adobe.com/xdm/context/media` + + + + + +## xdm:placeContext +### Place context + +The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, and working hours. + +`xdm:placeContext` +* is optional +* type: Place context +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) + +### xdm:placeContext Type + + +* [Place context](../../datatypes/placecontext.schema.md) – `https://ns.adobe.com/xdm/context/placecontext` + + + + + +## xdm:productListItems +### Product list items + +A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record. + +`xdm:productListItems` +* is optional +* type: Product list item + +* defined in [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmproductlistitems) + +### xdm:productListItems Type + + +Array type: Product list item + +All items must be of the type: +* [Product list item](../../datatypes/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem` + + + + + + + + +## xdm:profileStitch +### Profile stitch + +Details about the IDs that were joined by profile stitching. + +`xdm:profileStitch` +* is optional +* type: Profile stitch + +* defined in [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md#xdmprofilestitch) + +### xdm:profileStitch Type + + +Array type: Profile stitch + +All items must be of the type: +* [Profile stitch](../../datatypes/profilestitch.schema.md) – `https://ns.adobe.com/xdm/context/profileStitch` + + + + + + + + +## xdm:receivedTimestamp +### Received time stamp + +The time at which this interaction was received by a server. + +`xdm:receivedTimestamp` +* is optional +* type: `string` +* defined in [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmreceivedtimestamp) + +### xdm:receivedTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:search +### Search + +The information related to web or mobile search. + +`xdm:search` +* is optional +* type: Search +* defined in [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md#xdmsearch) + +### xdm:search Type + + +* [Search](../../datatypes/search.schema.md) – `https://ns.adobe.com/xdm/context/search` + + + + + +## xdm:segmentMembership +### Segment Membership Map + +`xdm:segmentMembership` +* is optional +* type: `object` +* defined in [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmembership) + +### xdm:segmentMembership Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:segmentMemberships +### Segment Memberships + +The segments associated with this ExperienceEvent. Deprecated, use `xdm:segmentMembership` instead. + +`xdm:segmentMemberships` +* is optional +* type: Segment membership item + +* defined in [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) + +### xdm:segmentMemberships Type + + +Array type: Segment membership item + +All items must be of the type: +* [Segment membership item](../../datatypes/segmentmembershipitem.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembershipitem` + + + + + + + + +## xdm:web +### Web + +The information related to web page and link of the ExperienceEvent. + +`xdm:web` +* is optional +* type: Web information +* defined in [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md#xdmweb) + +### xdm:web Type + + +* [Web information](../../datatypes/webinfo.schema.md) – `https://ns.adobe.com/xdm/context/webinfo` + + + + diff --git a/docs/reference/adobe/experience/campaign/address.schema.json b/docs/reference/adobe/experience/campaign/address.schema.json new file mode 100644 index 000000000..bd4cdd1bd --- /dev/null +++ b/docs/reference/adobe/experience/campaign/address.schema.json @@ -0,0 +1,45 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/address", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Address Extensions for Adobe Campaign", + "type": "object", + "meta:extends": [ + "https://ns.adobe.com/xdm/common/address" + ], + "description": "Address extension properties specific to Adobe Campaign.", + "definitions": { + "address": { + "properties": { + "https://ns.adobe.com/experience/campaign/addressErrorCount": { + "title": "Address Error Count", + "type": "integer", + "description": "Number of consecutive errors when sending to this address." + }, + "https://ns.adobe.com/experience/campaign/addressQuality": { + "title": "Address Quality", + "type": "string", + "description": "Address quality rating.", + "meta:enum": { + "incomplete_address": "Incomplete address", + "unknown_town_postal_code": "Unknown Town-Postal Code", + "empty_street": "Empty street", + "unknown_street": "Unknown street", + "partially_recognized_street": "Partially-recognized street", + "fully_recognized_street": "Fully-recognized street" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/address" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/address.schema.md b/docs/reference/adobe/experience/campaign/address.schema.md new file mode 100644 index 000000000..7e197f061 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/address.schema.md @@ -0,0 +1,70 @@ + +# Address Extensions for Adobe Campaign Schema + +``` +https://ns.adobe.com/experience/campaign/address +``` + +Address extension properties specific to Adobe Campaign. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/campaign/address.schema.json](adobe/experience/campaign/address.schema.json) | + +# Address Extensions for Adobe Campaign Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/addressErrorCount](#httpsnsadobecomexperiencecampaignaddresserrorcount) | `integer` | Optional | Address Extensions for Adobe Campaign (this schema) | +| [https://ns.adobe.com/experience/campaign/addressQuality](#httpsnsadobecomexperiencecampaignaddressquality) | `string` | Optional | Address Extensions for Adobe Campaign (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/addressErrorCount +### Address Error Count + +Number of consecutive errors when sending to this address. + +`https://ns.adobe.com/experience/campaign/addressErrorCount` +* is optional +* type: `integer` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/addressErrorCount Type + + +`integer` + + + + + + +## https://ns.adobe.com/experience/campaign/addressQuality +### Address Quality + +Address quality rating. + +`https://ns.adobe.com/experience/campaign/addressQuality` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/addressQuality Type + + +`string` + + + +### https://ns.adobe.com/experience/campaign/addressQuality Known Values +| Value | Description | +|-------|-------------| +| `incomplete_address` | Incomplete address | +| `unknown_town_postal_code` | Unknown Town-Postal Code | +| `empty_street` | Empty street | +| `unknown_street` | Unknown street | +| `partially_recognized_street` | Partially-recognized street | +| `fully_recognized_street` | Fully-recognized street | + + + diff --git a/docs/reference/adobe/experience/campaign/experienceevent-all.schema.json b/docs/reference/adobe/experience/campaign/experienceevent-all.schema.json new file mode 100644 index 000000000..92716a6de --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-all.schema.json @@ -0,0 +1,221 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/experienceevent-all", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Campaign ExperienceEvent Full Extension", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Campaign ExperienceEvent full extension. Contains all Solution added fields.", + "definitions": { + "campaign-experienceevent-all": { + "properties": { + "https://ns.adobe.com/experience/campaign/message": { + "title": "A single message sent to a recipient.", + "$ref": "https://ns.adobe.com/experience/campaign/message" + }, + "https://ns.adobe.com/experience/campaign/delivery": { + "title": "The campaign activity originating a message to a recipient.", + "type": "object", + "properties": { + "xdm:id": { + "title": "Delivery ID", + "type": "integer", + "description": "The campaign activity originating this message." + }, + "xdm:from": { + "title": "From", + "type": "string", + "description": "Address used as a from/sender/caller address. Depending on the communication channel, the `address` has a different format.\n\n * `email`: an email address.\n * `textMessage` or `phone`: a shortcode or phone number." + }, + "xdm:testEnabled": { + "title": "Test Enabled", + "type": "boolean", + "description": "Specify whether campaign activity is of type A/B testing.", + "default": false + }, + "xdm:messageClass": { + "title": "Message Class", + "type": "string", + "meta:enum": { + "one_time": "Marketing (One Time)", + "continuous": "Recurring", + "event_based": "Transactional (Event-based)" + }, + "description": "Mode of delivery for the messages sent.\n", + "default": "one_time" + }, + "xdm:templateName": { + "title": "Delivery Template's Internal Name", + "type": "string", + "description": "A human-friendly identifier of the the parent entity (in case of event_based or continuous message Class) of the campaign activity originating this message." + }, + "xdm:templateID": { + "title": "Identifier of the Template", + "type": "integer", + "description": "The delivery template's ID used to initialize this delivery.\n\nThe type the template used in Adobe Campaign can be identified using the `messageClass`.\n\n* `messageClass` = `oneTime`: the template is standard delivery template.\n* `messageClass` = `continuous`: the template is a recurring delivery.\n* `messageClass` = `transactional`: the template is a transactional message template.\n" + }, + "xdm:deliveryLabel": { + "title": "Delivery Label", + "type": "string", + "description": "A human-friendly name of the campaign activity which is originating this message." + }, + "xdm:deliveryName": { + "title": "Delivery Internal Name", + "type": "string", + "description": "A human-friendly identifier of the campaign activity which is originating this message." + } + } + }, + "https://ns.adobe.com/experience/campaign/marketingCampaign": { + "title": "The campaign activity originating a message to a recipient.", + "type": "object", + "properties": { + "xdm:id": { + "title": "Campaign ID", + "type": "integer", + "description": "Identifier of the marketing campaign to which activity originating this message belongs to." + }, + "xdm:campaignName": { + "title": "Campaign Internal Name", + "type": "string", + "description": "A human-friendly identifier of the marketing campaign which is originating this message." + } + } + }, + "https://ns.adobe.com/experience/campaign/link": { + "title": "The campaign activity originating a message to a recipient.", + "type": "object", + "properties": { + "xdm:id": { + "title": "Tracking URL ID", + "type": "string", + "description": "Unique Identifier of the Link" + }, + "xdm:description": { + "title": "Tracking URL Description", + "type": "string", + "description": "A human-friendly description of the link." + }, + "xdm:url": { + "title": "URL", + "format": "uri", + "type": "string", + "description": "URL of the Link." + }, + "xdm:occurrence": { + "title": "Occurrence", + "type": "integer", + "description": "URL occurrence index in the content (first is 1). When the same URL is available several times in the same content, its is necessary to track which occurrence of the URL has been clicked on.", + "default": 1, + "minimum": 1, + "maximum": 32767 + }, + "xdm:label": { + "title": "URL Label", + "type": "string", + "description": "The user-friendly label clicking on which the link opens." + }, + "xdm:category": { + "title": "URL Category", + "type": "string", + "description": "The category of the link. It may be `subscription`, or a user-defined category." + }, + "xdm:inAppMessageAction": { + "title": "In-App Message Action", + "type": "string", + "meta:enum": { + "primary": "Primary action", + "secondary": "Secondary action", + "dismiss": "Dismiss action" + }, + "description": "Actions on the In-App message delivered, e.g. action on primary button, secondary button or close button." + }, + "xdm:inAppMessageButtonText": { + "title": "In-App Message Button Text", + "type": "string", + "description": "The user-friendly text on the button." + } + } + }, + "https://ns.adobe.com/experience/campaign/orchestration": { + "title": "Campaign Orchestration for creating user journey.", + "$ref": "https://ns.adobe.com/experience/campaign/orchestration" + }, + "https://ns.adobe.com/experience/campaign/containerID": { + "title": "Container Identifier", + "type": "string", + "description": "The identifier denoting the container with which Campaign ExperienceEvent is associated." + }, + "https://ns.adobe.com/experience/campaign/eventSource": { + "title": "Event Source", + "type": "string", + "meta:enum": { + "replay-pipelined-mta": "This event was generated via Replay Utility tool generated from Pipelined", + "replay-pipelined-inMail": "This event was generated via Replay Utility tool generated from Pipelined", + "replay-pipelined-trackinglogd": "This event was generated via Replay Utility tool generated from Pipelined", + "replay-pipelined-pipelined": "This event was generated via Replay Utility tool generated from Pipelined", + "pipelined-mta": "This event was generated via Pipelined generated from mta", + "pipelined-inMail": "This event was generated via Pipelined generated from inMail", + "pipelined-trackinglogd": "This event was generated via Pipelined generated from trackinglogd", + "pipelined-pipelined": "This event was generated via Pipelined generated from Pipelined", + "replay": "This event was generated via Replay Utility tool which did not have any event source", + "pipelined-tracker": "This event was generated via Pipelined generated from TrackeR" + }, + "description": "A human-friendly name of the campaign activity which is originating this message." + }, + "https://ns.adobe.com/experience/campaign/offerOpened": { + "title": "Offer Opened", + "description": "The offer in the message for an 'offer opened' event.", + "$ref": "https://ns.adobe.com/experience/campaign/offer-response-detail" + }, + "https://ns.adobe.com/experience/campaign/offersProposed": { + "title": "Offer Propositions", + "description": "The offers in the message of a 'email-send' event.", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/experience/campaign/offer-proposition-detail" + } + }, + "https://ns.adobe.com/experience/campaign/medium": { + "title": "Medium", + "type": "string", + "description": "The medium is a combination of the source of the event (message, web, ...) and its format if applicable.", + "meta:enum": { + "message_text": "The source of the event is message in a text format.", + "message_html": "The source of the event is message in a html format.", + "message_line": "The source of the event is a line message.", + "web": "The source of the event is web tracking tag in a web page.", + "offer": "The source of the event is an offer." + } + } + } + }, + "mutation": { + "properties": { + "https://ns.adobe.com/experience/campaign/mutation": { + "title": "Mutated Fields from Previous ExperienceEvent.", + "description": "Information of the fields that have changed since the previous ExperienceEvent to keep track of the state changes across events. For e.g. if when an email gets sent, an ExperienceEvent with metric `sends` will be sent. This may get bounced and an ExperienceEvent with metric `bounces` will be sent then. It may be important for a downstream application to know that the previous ExperienceEvent with metric `sends` is now to be invalidated. This field will contain the values from the previous ExperienceEvent that have a different value in the current ExperienceEvent.", + "$ref": "https://ns.adobe.com/experience/campaign/mutationevent" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/campaign-experienceevent-all" + }, + { + "$ref": "#/definitions/mutation" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/experienceevent-all.schema.md b/docs/reference/adobe/experience/campaign/experienceevent-all.schema.md new file mode 100644 index 000000000..916ec8603 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-all.schema.md @@ -0,0 +1,712 @@ + +# Adobe Campaign ExperienceEvent Full Extension Schema + +``` +https://ns.adobe.com/experience/campaign/experienceevent-all +``` + +Adobe Campaign ExperienceEvent full extension. Contains all Solution added fields. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/experienceevent-all.schema.json](adobe/experience/campaign/experienceevent-all.schema.json) | +## Schema Hierarchy + +* Adobe Campaign ExperienceEvent Full Extension `https://ns.adobe.com/experience/campaign/experienceevent-all` + * [message.schema](message.schema.md) `https://ns.adobe.com/experience/campaign/message` + * [orchestration.schema](orchestration.schema.md) `https://ns.adobe.com/experience/campaign/orchestration` + * [Campaign Offer Response Detail](offer-response-detail.schema.md) `https://ns.adobe.com/experience/campaign/offer-response-detail` + * [Adobe Campaign Mutation Event](mutationevent.schema.md) `https://ns.adobe.com/experience/campaign/mutationevent` + + +# Adobe Campaign ExperienceEvent Full Extension Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/containerID](#httpsnsadobecomexperiencecampaigncontainerid) | `string` | Optional | Adobe Campaign ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/campaign/delivery](#httpsnsadobecomexperiencecampaigndelivery) | `object` | Optional | Adobe Campaign ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/campaign/eventSource](#httpsnsadobecomexperiencecampaigneventsource) | `string` | Optional | Adobe Campaign ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/campaign/link](#httpsnsadobecomexperiencecampaignlink) | `object` | Optional | Adobe Campaign ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/campaign/marketingCampaign](#httpsnsadobecomexperiencecampaignmarketingcampaign) | `object` | Optional | Adobe Campaign ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/campaign/medium](#httpsnsadobecomexperiencecampaignmedium) | `string` | Optional | Adobe Campaign ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/campaign/message](#httpsnsadobecomexperiencecampaignmessage) | message.schema | Optional | Adobe Campaign ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/campaign/mutation](#httpsnsadobecomexperiencecampaignmutation) | Adobe Campaign Mutation Event | Optional | Adobe Campaign ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/campaign/offerOpened](#httpsnsadobecomexperiencecampaignofferopened) | Campaign Offer Response Detail | Optional | Adobe Campaign ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/campaign/offersProposed](#httpsnsadobecomexperiencecampaignoffersproposed) | Campaign Offer Proposition Detail | Optional | Adobe Campaign ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/campaign/orchestration](#httpsnsadobecomexperiencecampaignorchestration) | orchestration.schema | Optional | Adobe Campaign ExperienceEvent Full Extension (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/containerID +### Container Identifier + +The identifier denoting the container with which Campaign ExperienceEvent is associated. + +`https://ns.adobe.com/experience/campaign/containerID` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/containerID Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/campaign/delivery +### The campaign activity originating a message to a recipient. + +`https://ns.adobe.com/experience/campaign/delivery` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/delivery Type + + +`object` with following properties: + + +| Property | Type | Required | Default | +|----------|------|----------|---------| +| `xdm:deliveryLabel`| string | Optional | | +| `xdm:deliveryName`| string | Optional | | +| `xdm:from`| string | Optional | | +| `xdm:id`| integer | Optional | | +| `xdm:messageClass`| string | Optional | `"one_time"` | +| `xdm:templateID`| integer | Optional | | +| `xdm:templateName`| string | Optional | | +| `xdm:testEnabled`| boolean | Optional | `false` | + + + +#### xdm:deliveryLabel +##### Delivery Label + +A human-friendly name of the campaign activity which is originating this message. + +`xdm:deliveryLabel` +* is optional +* type: `string` + +##### xdm:deliveryLabel Type + + +`string` + + + + + + + + +#### xdm:deliveryName +##### Delivery Internal Name + +A human-friendly identifier of the campaign activity which is originating this message. + +`xdm:deliveryName` +* is optional +* type: `string` + +##### xdm:deliveryName Type + + +`string` + + + + + + + + +#### xdm:from +##### From + +Address used as a from/sender/caller address. Depending on the communication channel, the `address` has a different format. + + * `email`: an email address. + * `textMessage` or `phone`: a shortcode or phone number. + +`xdm:from` +* is optional +* type: `string` + +##### xdm:from Type + + +`string` + + + + + + + + +#### xdm:id +##### Delivery ID + +The campaign activity originating this message. + +`xdm:id` +* is optional +* type: `integer` + +##### xdm:id Type + + +`integer` + + + + + + + + +#### xdm:messageClass +##### Message Class + +Mode of delivery for the messages sent. + + +`xdm:messageClass` +* is optional +* type: `string` +* default: `"one_time"` + + +##### xdm:messageClass Type + + +`string` + + + +##### xdm:messageClass Known Values +| Value | Description | +|-------|-------------| +| `one_time` | Marketing (One Time) | +| `continuous` | Recurring | +| `event_based` | Transactional (Event-based) | + + + + + + +#### xdm:templateID +##### Identifier of the Template + +The delivery template's ID used to initialize this delivery. + +The type the template used in Adobe Campaign can be identified using the `messageClass`. + +* `messageClass` = `oneTime`: the template is standard delivery template. +* `messageClass` = `continuous`: the template is a recurring delivery. +* `messageClass` = `transactional`: the template is a transactional message template. + + +`xdm:templateID` +* is optional +* type: `integer` + +##### xdm:templateID Type + + +`integer` + + + + + + + + +#### xdm:templateName +##### Delivery Template's Internal Name + +A human-friendly identifier of the the parent entity (in case of event_based or continuous message Class) of the campaign activity originating this message. + +`xdm:templateName` +* is optional +* type: `string` + +##### xdm:templateName Type + + +`string` + + + + + + + + +#### xdm:testEnabled +##### Test Enabled + +Specify whether campaign activity is of type A/B testing. + +`xdm:testEnabled` +* is optional +* type: `boolean` +* default: `false` + + +##### xdm:testEnabled Type + + +`boolean` + + + + + + + + + + +## https://ns.adobe.com/experience/campaign/eventSource +### Event Source + +A human-friendly name of the campaign activity which is originating this message. + +`https://ns.adobe.com/experience/campaign/eventSource` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/eventSource Type + + +`string` + + + +### https://ns.adobe.com/experience/campaign/eventSource Known Values +| Value | Description | +|-------|-------------| +| `replay-pipelined-mta` | This event was generated via Replay Utility tool generated from Pipelined | +| `replay-pipelined-inMail` | This event was generated via Replay Utility tool generated from Pipelined | +| `replay-pipelined-trackinglogd` | This event was generated via Replay Utility tool generated from Pipelined | +| `replay-pipelined-pipelined` | This event was generated via Replay Utility tool generated from Pipelined | +| `pipelined-mta` | This event was generated via Pipelined generated from mta | +| `pipelined-inMail` | This event was generated via Pipelined generated from inMail | +| `pipelined-trackinglogd` | This event was generated via Pipelined generated from trackinglogd | +| `pipelined-pipelined` | This event was generated via Pipelined generated from Pipelined | +| `replay` | This event was generated via Replay Utility tool which did not have any event source | +| `pipelined-tracker` | This event was generated via Pipelined generated from TrackeR | + + + + +## https://ns.adobe.com/experience/campaign/link +### The campaign activity originating a message to a recipient. + +`https://ns.adobe.com/experience/campaign/link` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/link Type + + +`object` with following properties: + + +| Property | Type | Required | Default | +|----------|------|----------|---------| +| `xdm:category`| string | Optional | | +| `xdm:description`| string | Optional | | +| `xdm:id`| string | Optional | | +| `xdm:inAppMessageAction`| string | Optional | | +| `xdm:inAppMessageButtonText`| string | Optional | | +| `xdm:label`| string | Optional | | +| `xdm:occurrence`| integer | Optional | `1` | +| `xdm:url`| string | Optional | | + + + +#### xdm:category +##### URL Category + +The category of the link. It may be `subscription`, or a user-defined category. + +`xdm:category` +* is optional +* type: `string` + +##### xdm:category Type + + +`string` + + + + + + + + +#### xdm:description +##### Tracking URL Description + +A human-friendly description of the link. + +`xdm:description` +* is optional +* type: `string` + +##### xdm:description Type + + +`string` + + + + + + + + +#### xdm:id +##### Tracking URL ID + +Unique Identifier of the Link + +`xdm:id` +* is optional +* type: `string` + +##### xdm:id Type + + +`string` + + + + + + + + +#### xdm:inAppMessageAction +##### In-App Message Action + +Actions on the In-App message delivered, e.g. action on primary button, secondary button or close button. + +`xdm:inAppMessageAction` +* is optional +* type: `string` + +##### xdm:inAppMessageAction Type + + +`string` + + + +##### xdm:inAppMessageAction Known Values +| Value | Description | +|-------|-------------| +| `primary` | Primary action | +| `secondary` | Secondary action | +| `dismiss` | Dismiss action | + + + + + + +#### xdm:inAppMessageButtonText +##### In-App Message Button Text + +The user-friendly text on the button. + +`xdm:inAppMessageButtonText` +* is optional +* type: `string` + +##### xdm:inAppMessageButtonText Type + + +`string` + + + + + + + + +#### xdm:label +##### URL Label + +The user-friendly label clicking on which the link opens. + +`xdm:label` +* is optional +* type: `string` + +##### xdm:label Type + + +`string` + + + + + + + + +#### xdm:occurrence +##### Occurrence + +URL occurrence index in the content (first is 1). When the same URL is available several times in the same content, its is necessary to track which occurrence of the URL has been clicked on. + +`xdm:occurrence` +* is optional +* type: `integer` +* default: `1` + + +##### xdm:occurrence Type + + +`integer` +* minimum value: `1` +* maximum value: `32767` + + + + + + + +#### xdm:url +##### URL + +URL of the Link. + +`xdm:url` +* is optional +* type: `string` + +##### xdm:url Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + + + + + + +## https://ns.adobe.com/experience/campaign/marketingCampaign +### The campaign activity originating a message to a recipient. + +`https://ns.adobe.com/experience/campaign/marketingCampaign` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/marketingCampaign Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:campaignName`| string | Optional | +| `xdm:id`| integer | Optional | + + + +#### xdm:campaignName +##### Campaign Internal Name + +A human-friendly identifier of the marketing campaign which is originating this message. + +`xdm:campaignName` +* is optional +* type: `string` + +##### xdm:campaignName Type + + +`string` + + + + + + + + +#### xdm:id +##### Campaign ID + +Identifier of the marketing campaign to which activity originating this message belongs to. + +`xdm:id` +* is optional +* type: `integer` + +##### xdm:id Type + + +`integer` + + + + + + + + + + + +## https://ns.adobe.com/experience/campaign/medium +### Medium + +The medium is a combination of the source of the event (message, web, ...) and its format if applicable. + +`https://ns.adobe.com/experience/campaign/medium` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/medium Type + + +`string` + + + +### https://ns.adobe.com/experience/campaign/medium Known Values +| Value | Description | +|-------|-------------| +| `message_text` | The source of the event is message in a text format. | +| `message_html` | The source of the event is message in a html format. | +| `message_line` | The source of the event is a line message. | +| `web` | The source of the event is web tracking tag in a web page. | +| `offer` | The source of the event is an offer. | + + + + +## https://ns.adobe.com/experience/campaign/message +### A single message sent to a recipient. + +`https://ns.adobe.com/experience/campaign/message` +* is optional +* type: message.schema +* defined in this schema + +### https://ns.adobe.com/experience/campaign/message Type + + +* [message.schema](message.schema.md) – `https://ns.adobe.com/experience/campaign/message` + + + + + +## https://ns.adobe.com/experience/campaign/mutation +### Mutated Fields from Previous ExperienceEvent. + +Information of the fields that have changed since the previous ExperienceEvent to keep track of the state changes across events. For e.g. if when an email gets sent, an ExperienceEvent with metric `sends` will be sent. This may get bounced and an ExperienceEvent with metric `bounces` will be sent then. It may be important for a downstream application to know that the previous ExperienceEvent with metric `sends` is now to be invalidated. This field will contain the values from the previous ExperienceEvent that have a different value in the current ExperienceEvent. + +`https://ns.adobe.com/experience/campaign/mutation` +* is optional +* type: Adobe Campaign Mutation Event +* defined in this schema + +### https://ns.adobe.com/experience/campaign/mutation Type + + +* [Adobe Campaign Mutation Event](mutationevent.schema.md) – `https://ns.adobe.com/experience/campaign/mutationevent` + + + + + +## https://ns.adobe.com/experience/campaign/offerOpened +### Offer Opened + +The offer in the message for an 'offer opened' event. + +`https://ns.adobe.com/experience/campaign/offerOpened` +* is optional +* type: Campaign Offer Response Detail +* defined in this schema + +### https://ns.adobe.com/experience/campaign/offerOpened Type + + +* [Campaign Offer Response Detail](offer-response-detail.schema.md) – `https://ns.adobe.com/experience/campaign/offer-response-detail` + + + + + +## https://ns.adobe.com/experience/campaign/offersProposed +### Offer Propositions + +The offers in the message of a 'email-send' event. + +`https://ns.adobe.com/experience/campaign/offersProposed` +* is optional +* type: Campaign Offer Proposition Detail + +* defined in this schema + +### https://ns.adobe.com/experience/campaign/offersProposed Type + + +Array type: Campaign Offer Proposition Detail + +All items must be of the type: +* [Campaign Offer Proposition Detail](offer-proposition-detail.schema.md) – `https://ns.adobe.com/experience/campaign/offer-proposition-detail` + + + + + + + + +## https://ns.adobe.com/experience/campaign/orchestration +### Campaign Orchestration for creating user journey. + +`https://ns.adobe.com/experience/campaign/orchestration` +* is optional +* type: orchestration.schema +* defined in this schema + +### https://ns.adobe.com/experience/campaign/orchestration Type + + +* [orchestration.schema](orchestration.schema.md) – `https://ns.adobe.com/experience/campaign/orchestration` + + + + diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-owning-entities.schema.json b/docs/reference/adobe/experience/campaign/experienceevent-profile-owning-entities.schema.json new file mode 100644 index 000000000..8da9e2f95 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-owning-entities.schema.json @@ -0,0 +1,53 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/experienceevent-profile-owning-entities", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Campaign ExperienceEvent - Profile Snapshot Owning Entities", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Campaign ExperienceEvent optional snapshot of Profile owning entities.", + "definitions": { + "campaign-experienceevent-profile-owning-entities": { + "properties": { + "https://ns.adobe.com/experience/campaign/message": { + "title": "A single message sent to a recipient.", + "type": "object", + "properties": { + "xdm:profileSnapshot": { + "title": "Profile Snapshot", + "description": "Profile Snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:orgUnit": { + "title": "Organizational Unit", + "$ref": "https://ns.adobe.com/xdm/common/orgunit", + "description": "The unit within the organization owning the profile. This can be used to reference the organization details maintained in another dataset." + }, + "xdm:geoUnit": { + "title": "Geographical Unit", + "$ref": "https://ns.adobe.com/xdm/common/geounit", + "description": "The geographical unit within the organization owning the profile. This can be used to reference the geographical information maintained in another dataset." + } + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/campaign-experienceevent-profile-owning-entities" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-owning-entities.schema.md b/docs/reference/adobe/experience/campaign/experienceevent-profile-owning-entities.schema.md new file mode 100644 index 000000000..ceb20b64a --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-owning-entities.schema.md @@ -0,0 +1,82 @@ + +# Adobe Campaign ExperienceEvent - Profile Snapshot Owning Entities Schema + +``` +https://ns.adobe.com/experience/campaign/experienceevent-profile-owning-entities +``` + +Adobe Campaign ExperienceEvent optional snapshot of Profile owning entities. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/experienceevent-profile-owning-entities.schema.json](adobe/experience/campaign/experienceevent-profile-owning-entities.schema.json) | + +# Adobe Campaign ExperienceEvent - Profile Snapshot Owning Entities Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/message](#httpsnsadobecomexperiencecampaignmessage) | `object` | Optional | Adobe Campaign ExperienceEvent - Profile Snapshot Owning Entities (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/message +### A single message sent to a recipient. + +`https://ns.adobe.com/experience/campaign/message` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/message Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:profileSnapshot`| object | Optional | + + + +#### xdm:profileSnapshot +##### Profile Snapshot + +Profile Snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent. + +`xdm:profileSnapshot` +* is optional +* type: `object` + +##### xdm:profileSnapshot Type + +Unknown type `object`. + +```json +{ + "title": "Profile Snapshot", + "description": "Profile Snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:orgUnit": { + "title": "Organizational Unit", + "$ref": "https://ns.adobe.com/xdm/common/orgunit", + "description": "The unit within the organization owning the profile. This can be used to reference the organization details maintained in another dataset." + }, + "xdm:geoUnit": { + "title": "Geographical Unit", + "$ref": "https://ns.adobe.com/xdm/common/geounit", + "description": "The geographical unit within the organization owning the profile. This can be used to reference the geographical information maintained in another dataset." + } + }, + "simpletype": "`object`" +} +``` + + + + + + + + + diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-personal-details.schema.json b/docs/reference/adobe/experience/campaign/experienceevent-profile-personal-details.schema.json new file mode 100644 index 000000000..022840ee3 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-personal-details.schema.json @@ -0,0 +1,68 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/experienceevent-profile-personal-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Campaign ExperienceEvent - Profile Snapshot Personal Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Campaign ExperienceEvent optional snapshot of Profile personal details.", + "definitions": { + "campaign-experienceevent-profile-personal-details": { + "properties": { + "https://ns.adobe.com/experience/campaign/message": { + "title": "A single message sent to a recipient.", + "type": "object", + "properties": { + "xdm:profileSnapshot": { + "title": "Profile Snapshot", + "description": "Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:homeAddress": { + "title": "Home Address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "A home postal address." + }, + "xdm:personalEmail": { + "title": "Personal Email", + "$ref": "https://ns.adobe.com/xdm/context/emailaddress", + "description": "A personal email address." + }, + "xdm:homePhone": { + "title": "Home Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Home phone number." + }, + "xdm:mobilePhone": { + "title": "Mobile Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Mobile phone number." + }, + "xdm:faxPhone": { + "title": "Fax Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Fax phone number." + } + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/campaign-experienceevent-profile-personal-details" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-personal-details.schema.md b/docs/reference/adobe/experience/campaign/experienceevent-profile-personal-details.schema.md new file mode 100644 index 000000000..43aa443b8 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-personal-details.schema.md @@ -0,0 +1,97 @@ + +# Adobe Campaign ExperienceEvent - Profile Snapshot Personal Details Schema + +``` +https://ns.adobe.com/experience/campaign/experienceevent-profile-personal-details +``` + +Adobe Campaign ExperienceEvent optional snapshot of Profile personal details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/experienceevent-profile-personal-details.schema.json](adobe/experience/campaign/experienceevent-profile-personal-details.schema.json) | + +# Adobe Campaign ExperienceEvent - Profile Snapshot Personal Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/message](#httpsnsadobecomexperiencecampaignmessage) | `object` | Optional | Adobe Campaign ExperienceEvent - Profile Snapshot Personal Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/message +### A single message sent to a recipient. + +`https://ns.adobe.com/experience/campaign/message` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/message Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:profileSnapshot`| object | Optional | + + + +#### xdm:profileSnapshot +##### Profile Snapshot + +Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent. + +`xdm:profileSnapshot` +* is optional +* type: `object` + +##### xdm:profileSnapshot Type + +Unknown type `object`. + +```json +{ + "title": "Profile Snapshot", + "description": "Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:homeAddress": { + "title": "Home Address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "A home postal address." + }, + "xdm:personalEmail": { + "title": "Personal Email", + "$ref": "https://ns.adobe.com/xdm/context/emailaddress", + "description": "A personal email address." + }, + "xdm:homePhone": { + "title": "Home Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Home phone number." + }, + "xdm:mobilePhone": { + "title": "Mobile Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Mobile phone number." + }, + "xdm:faxPhone": { + "title": "Fax Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Fax phone number." + } + }, + "simpletype": "`object`" +} +``` + + + + + + + + + diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-preferences-details.schema.json b/docs/reference/adobe/experience/campaign/experienceevent-profile-preferences-details.schema.json new file mode 100644 index 000000000..5cd09dfce --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-preferences-details.schema.json @@ -0,0 +1,83 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/experienceevent-profile-preferences-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Campaign ExperienceEvent - Profile Snapshot Preferences Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Campaign ExperienceEvent optional snapshot of Profile preferences details.", + "definitions": { + "campaign-experienceevent-profile-preferences-details": { + "properties": { + "https://ns.adobe.com/experience/campaign/message": { + "title": "A single message sent to a recipient.", + "type": "object", + "properties": { + "xdm:profileSnapshot": { + "title": "Profile Snapshot", + "description": "Profile Snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:preferredLanguage": { + "title": "Preferred Language", + "type": "string", + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "examples": [ + "en-GB", + "de-DE", + "yue-HK" + ], + "description": "Describes the preferred system of communication used by the profile. Language codes are expressed in BCP 47 format." + }, + "xdm:profilePictureLink": { + "title": "Profile Picture Link", + "type": "string", + "description": "Link to profile's picture" + }, + "xdm:emailFormat": { + "title": "Email Format", + "type": "string", + "description": "Email format preferred by the profile. This can be rich text/plain text", + "meta:enum": { + "html": "Rich text", + "plaintext": "Plain text" + } + }, + "xdm:timeZone": { + "title": "Time Zone", + "type": "string", + "examples": [ + "America/Barbados", + "Antarctica/Davis", + "Asia/Calcutta" + ], + "description": "Describes which time zone the profile is present in, most frequently/the time zone preferred by the profile. Time zones are expressed according to the IETF tz database: https://www.ietf.org/timezones/tzdb-2016i/tz-link.htm" + }, + "xdm:optInOut": { + "title": "OptInOut", + "$ref": "https://ns.adobe.com/xdm/context/optinout", + "description": "Describes a users opting in and out preferences for communication by medium and communication type." + } + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/campaign-experienceevent-profile-preferences-details" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-preferences-details.schema.md b/docs/reference/adobe/experience/campaign/experienceevent-profile-preferences-details.schema.md new file mode 100644 index 000000000..8d2dded25 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-preferences-details.schema.md @@ -0,0 +1,112 @@ + +# Adobe Campaign ExperienceEvent - Profile Snapshot Preferences Details Schema + +``` +https://ns.adobe.com/experience/campaign/experienceevent-profile-preferences-details +``` + +Adobe Campaign ExperienceEvent optional snapshot of Profile preferences details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/experienceevent-profile-preferences-details.schema.json](adobe/experience/campaign/experienceevent-profile-preferences-details.schema.json) | + +# Adobe Campaign ExperienceEvent - Profile Snapshot Preferences Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/message](#httpsnsadobecomexperiencecampaignmessage) | `object` | Optional | Adobe Campaign ExperienceEvent - Profile Snapshot Preferences Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/message +### A single message sent to a recipient. + +`https://ns.adobe.com/experience/campaign/message` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/message Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:profileSnapshot`| object | Optional | + + + +#### xdm:profileSnapshot +##### Profile Snapshot + +Profile Snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent. + +`xdm:profileSnapshot` +* is optional +* type: `object` + +##### xdm:profileSnapshot Type + +Unknown type `object`. + +```json +{ + "title": "Profile Snapshot", + "description": "Profile Snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:preferredLanguage": { + "title": "Preferred Language", + "type": "string", + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "examples": [ + "en-GB", + "de-DE", + "yue-HK" + ], + "description": "Describes the preferred system of communication used by the profile. Language codes are expressed in BCP 47 format." + }, + "xdm:profilePictureLink": { + "title": "Profile Picture Link", + "type": "string", + "description": "Link to profile's picture" + }, + "xdm:emailFormat": { + "title": "Email Format", + "type": "string", + "description": "Email format preferred by the profile. This can be rich text/plain text", + "meta:enum": { + "html": "Rich text", + "plaintext": "Plain text" + } + }, + "xdm:timeZone": { + "title": "Time Zone", + "type": "string", + "examples": [ + "America/Barbados", + "Antarctica/Davis", + "Asia/Calcutta" + ], + "description": "Describes which time zone the profile is present in, most frequently/the time zone preferred by the profile. Time zones are expressed according to the IETF tz database: https://www.ietf.org/timezones/tzdb-2016i/tz-link.htm" + }, + "xdm:optInOut": { + "title": "OptInOut", + "$ref": "https://ns.adobe.com/xdm/context/optinout", + "description": "Describes a users opting in and out preferences for communication by medium and communication type." + } + }, + "simpletype": "`object`" +} +``` + + + + + + + + + diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-push-details.schema.json b/docs/reference/adobe/experience/campaign/experienceevent-profile-push-details.schema.json new file mode 100644 index 000000000..1d6227093 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-push-details.schema.json @@ -0,0 +1,51 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/experienceevent-profile-push-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Campaign ExperienceEvent - Profile Snapshot Push Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Campaign ExperienceEvent optional snapshot of profile push details.", + "definitions": { + "campaign-experienceevent-profile-push-details": { + "properties": { + "https://ns.adobe.com/experience/campaign/message": { + "title": "A single message sent to a recipient.", + "type": "object", + "properties": { + "xdm:profileSnapshot": { + "title": "Profile Snapshot", + "description": "Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:pushNotificationTokens": { + "title": "Push Notification Tokens", + "type": "array", + "description": "Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts.", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/pushnotificationtoken" + } + } + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/campaign-experienceevent-profile-push-details" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-push-details.schema.md b/docs/reference/adobe/experience/campaign/experienceevent-profile-push-details.schema.md new file mode 100644 index 000000000..2d56d9c08 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-push-details.schema.md @@ -0,0 +1,80 @@ + +# Adobe Campaign ExperienceEvent - Profile Snapshot Push Details Schema + +``` +https://ns.adobe.com/experience/campaign/experienceevent-profile-push-details +``` + +Adobe Campaign ExperienceEvent optional snapshot of profile push details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/experienceevent-profile-push-details.schema.json](adobe/experience/campaign/experienceevent-profile-push-details.schema.json) | + +# Adobe Campaign ExperienceEvent - Profile Snapshot Push Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/message](#httpsnsadobecomexperiencecampaignmessage) | `object` | Optional | Adobe Campaign ExperienceEvent - Profile Snapshot Push Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/message +### A single message sent to a recipient. + +`https://ns.adobe.com/experience/campaign/message` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/message Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:profileSnapshot`| object | Optional | + + + +#### xdm:profileSnapshot +##### Profile Snapshot + +Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent. + +`xdm:profileSnapshot` +* is optional +* type: `object` + +##### xdm:profileSnapshot Type + +Unknown type `object`. + +```json +{ + "title": "Profile Snapshot", + "description": "Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:pushNotificationTokens": { + "title": "Push Notification Tokens", + "type": "array", + "description": "Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts.", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/pushnotificationtoken" + } + } + }, + "simpletype": "`object`" +} +``` + + + + + + + + + diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-segmentation.schema.json b/docs/reference/adobe/experience/campaign/experienceevent-profile-segmentation.schema.json new file mode 100644 index 000000000..150770369 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-segmentation.schema.json @@ -0,0 +1,56 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/experienceevent-profile-segmentation", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Campaign ExperienceEvent - Profile Snapshot Profile Segmentation", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Campaign ExperienceEvent optional snapshot of profile segmentation.", + "definitions": { + "campaign-experienceevent-profile-segmentation": { + "properties": { + "https://ns.adobe.com/experience/campaign/message": { + "title": "A single message sent to a recipient.", + "type": "object", + "properties": { + "xdm:profileSnapshot": { + "title": "Profile Snapshot", + "description": "Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:segmentMembership": { + "title": "Segment Membership Map", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "title": "Segment Membership per Namespace", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "$ref": "https://ns.adobe.com/xdm/context/segmentmembership" + } + } + } + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/campaign-experienceevent-profile-segmentation" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-segmentation.schema.md b/docs/reference/adobe/experience/campaign/experienceevent-profile-segmentation.schema.md new file mode 100644 index 000000000..c284c27a7 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-segmentation.schema.md @@ -0,0 +1,85 @@ + +# Adobe Campaign ExperienceEvent - Profile Snapshot Profile Segmentation Schema + +``` +https://ns.adobe.com/experience/campaign/experienceevent-profile-segmentation +``` + +Adobe Campaign ExperienceEvent optional snapshot of profile segmentation. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/experienceevent-profile-segmentation.schema.json](adobe/experience/campaign/experienceevent-profile-segmentation.schema.json) | + +# Adobe Campaign ExperienceEvent - Profile Snapshot Profile Segmentation Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/message](#httpsnsadobecomexperiencecampaignmessage) | `object` | Optional | Adobe Campaign ExperienceEvent - Profile Snapshot Profile Segmentation (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/message +### A single message sent to a recipient. + +`https://ns.adobe.com/experience/campaign/message` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/message Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:profileSnapshot`| object | Optional | + + + +#### xdm:profileSnapshot +##### Profile Snapshot + +Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent. + +`xdm:profileSnapshot` +* is optional +* type: `object` + +##### xdm:profileSnapshot Type + +Unknown type `object`. + +```json +{ + "title": "Profile Snapshot", + "description": "Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:segmentMembership": { + "title": "Segment Membership Map", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "title": "Segment Membership per Namespace", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "$ref": "https://ns.adobe.com/xdm/context/segmentmembership" + } + } + } + }, + "simpletype": "`object`" +} +``` + + + + + + + + + diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-subscriptions.schema.json b/docs/reference/adobe/experience/campaign/experienceevent-profile-subscriptions.schema.json new file mode 100644 index 000000000..d2fde7332 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-subscriptions.schema.json @@ -0,0 +1,51 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/experienceevent-profile-subscriptions", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Campaign ExperienceEvent - Profile Snapshot Profile Subscriptions", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Campaign ExperienceEvent optional snapshot of profile subscriptions.", + "definitions": { + "campaign-experienceevent-profile-subscriptions": { + "properties": { + "https://ns.adobe.com/experience/campaign/message": { + "title": "A single message sent to a recipient.", + "type": "object", + "properties": { + "xdm:profileSnapshot": { + "title": "Profile Snapshot", + "description": "Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:subscriptions": { + "title": "Subscriptions", + "type": "array", + "description": "Subscriptions that this profile is entitled to including terminated, expired or exhausted subscriptions.", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/subscription" + } + } + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/campaign-experienceevent-profile-subscriptions" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-subscriptions.schema.md b/docs/reference/adobe/experience/campaign/experienceevent-profile-subscriptions.schema.md new file mode 100644 index 000000000..ee03d805f --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-subscriptions.schema.md @@ -0,0 +1,80 @@ + +# Adobe Campaign ExperienceEvent - Profile Snapshot Profile Subscriptions Schema + +``` +https://ns.adobe.com/experience/campaign/experienceevent-profile-subscriptions +``` + +Adobe Campaign ExperienceEvent optional snapshot of profile subscriptions. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/experienceevent-profile-subscriptions.schema.json](adobe/experience/campaign/experienceevent-profile-subscriptions.schema.json) | + +# Adobe Campaign ExperienceEvent - Profile Snapshot Profile Subscriptions Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/message](#httpsnsadobecomexperiencecampaignmessage) | `object` | Optional | Adobe Campaign ExperienceEvent - Profile Snapshot Profile Subscriptions (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/message +### A single message sent to a recipient. + +`https://ns.adobe.com/experience/campaign/message` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/message Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:profileSnapshot`| object | Optional | + + + +#### xdm:profileSnapshot +##### Profile Snapshot + +Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent. + +`xdm:profileSnapshot` +* is optional +* type: `object` + +##### xdm:profileSnapshot Type + +Unknown type `object`. + +```json +{ + "title": "Profile Snapshot", + "description": "Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:subscriptions": { + "title": "Subscriptions", + "type": "array", + "description": "Subscriptions that this profile is entitled to including terminated, expired or exhausted subscriptions.", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/subscription" + } + } + }, + "simpletype": "`object`" +} +``` + + + + + + + + + diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-test-profile.schema.json b/docs/reference/adobe/experience/campaign/experienceevent-profile-test-profile.schema.json new file mode 100644 index 000000000..028ba5d7b --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-test-profile.schema.json @@ -0,0 +1,49 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/experienceevent-profile-test-profile", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Campaign ExperienceEvent - Profile Snapshot Test Profile", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Campaign ExperienceEvent optional snapshot of profile personal details.", + "definitions": { + "campaign-experienceevent-profile-test-profile": { + "properties": { + "https://ns.adobe.com/experience/campaign/message": { + "title": "A single message sent to a recipient.", + "type": "object", + "properties": { + "xdm:profileSnapshot": { + "title": "Profile Snapshot", + "description": "Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:testProfile": { + "title": "Test Profile", + "type": "boolean", + "description": "Indicates the `profile` record is for use in testing/verification purposes and should not be automatically included in normal operation(s).", + "default": false + } + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/campaign-experienceevent-profile-test-profile" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-test-profile.schema.md b/docs/reference/adobe/experience/campaign/experienceevent-profile-test-profile.schema.md new file mode 100644 index 000000000..0e0c99f79 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-test-profile.schema.md @@ -0,0 +1,78 @@ + +# Adobe Campaign ExperienceEvent - Profile Snapshot Test Profile Schema + +``` +https://ns.adobe.com/experience/campaign/experienceevent-profile-test-profile +``` + +Adobe Campaign ExperienceEvent optional snapshot of profile personal details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/experienceevent-profile-test-profile.schema.json](adobe/experience/campaign/experienceevent-profile-test-profile.schema.json) | + +# Adobe Campaign ExperienceEvent - Profile Snapshot Test Profile Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/message](#httpsnsadobecomexperiencecampaignmessage) | `object` | Optional | Adobe Campaign ExperienceEvent - Profile Snapshot Test Profile (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/message +### A single message sent to a recipient. + +`https://ns.adobe.com/experience/campaign/message` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/message Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:profileSnapshot`| object | Optional | + + + +#### xdm:profileSnapshot +##### Profile Snapshot + +Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent. + +`xdm:profileSnapshot` +* is optional +* type: `object` + +##### xdm:profileSnapshot Type + +Unknown type `object`. + +```json +{ + "title": "Profile Snapshot", + "description": "Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:testProfile": { + "title": "Test Profile", + "type": "boolean", + "description": "Indicates the `profile` record is for use in testing/verification purposes and should not be automatically included in normal operation(s).", + "default": false + } + }, + "simpletype": "`object`" +} +``` + + + + + + + + + diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-work-details.schema.json b/docs/reference/adobe/experience/campaign/experienceevent-profile-work-details.schema.json new file mode 100644 index 000000000..d8d03a6d6 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-work-details.schema.json @@ -0,0 +1,65 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/experienceevent-profile-work-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Campaign ExperienceEvent - Profile Snapshot Work Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Campaign ExperienceEvent optional snapshot of profile work details.", + "definitions": { + "campaign-experienceevent-profile-work-details": { + "properties": { + "https://ns.adobe.com/experience/campaign/message": { + "title": "A single message sent to a recipient.", + "type": "object", + "properties": { + "xdm:profileSnapshot": { + "title": "Profile Snapshot", + "description": "Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:workAddress": { + "title": "Work Address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "A work postal address." + }, + "xdm:workEmail": { + "title": "Work Email", + "$ref": "https://ns.adobe.com/xdm/context/emailaddress", + "description": "A work email address." + }, + "xdm:workPhone": { + "title": "Work Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Work phone number." + }, + "xdm:organizations": { + "title": "Organizations", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/campaign-experienceevent-profile-work-details" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/experienceevent-profile-work-details.schema.md b/docs/reference/adobe/experience/campaign/experienceevent-profile-work-details.schema.md new file mode 100644 index 000000000..24b5d057c --- /dev/null +++ b/docs/reference/adobe/experience/campaign/experienceevent-profile-work-details.schema.md @@ -0,0 +1,94 @@ + +# Adobe Campaign ExperienceEvent - Profile Snapshot Work Details Schema + +``` +https://ns.adobe.com/experience/campaign/experienceevent-profile-work-details +``` + +Adobe Campaign ExperienceEvent optional snapshot of profile work details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/experienceevent-profile-work-details.schema.json](adobe/experience/campaign/experienceevent-profile-work-details.schema.json) | + +# Adobe Campaign ExperienceEvent - Profile Snapshot Work Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/message](#httpsnsadobecomexperiencecampaignmessage) | `object` | Optional | Adobe Campaign ExperienceEvent - Profile Snapshot Work Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/message +### A single message sent to a recipient. + +`https://ns.adobe.com/experience/campaign/message` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/message Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:profileSnapshot`| object | Optional | + + + +#### xdm:profileSnapshot +##### Profile Snapshot + +Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent. + +`xdm:profileSnapshot` +* is optional +* type: `object` + +##### xdm:profileSnapshot Type + +Unknown type `object`. + +```json +{ + "title": "Profile Snapshot", + "description": "Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "type": "object", + "properties": { + "xdm:workAddress": { + "title": "Work Address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "A work postal address." + }, + "xdm:workEmail": { + "title": "Work Email", + "$ref": "https://ns.adobe.com/xdm/context/emailaddress", + "description": "A work email address." + }, + "xdm:workPhone": { + "title": "Work Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Work phone number." + }, + "xdm:organizations": { + "title": "Organizations", + "type": "array", + "items": { + "type": "string" + } + } + }, + "simpletype": "`object`" +} +``` + + + + + + + + + diff --git a/docs/reference/adobe/experience/campaign/feedbackevent.schema.json b/docs/reference/adobe/experience/campaign/feedbackevent.schema.json new file mode 100644 index 000000000..6161ef9b5 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/feedbackevent.schema.json @@ -0,0 +1,246 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/feedbackevent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Delivery Feedback Events", + "type": "object", + "meta:extensible": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Contains all delivery event fields.", + "definitions": { + "feedbackevent": { + "properties": { + "https://ns.adobe.com/experience/campaign/feedback/type": { + "title": "Feedback Type", + "type": "string", + "description": "The type of message event." + }, + "xdm:retryCount": { + "title": "Retry Count", + "type": "integer", + "description": "Number of failed attempts before the current event." + }, + "https://ns.adobe.com/experience/campaign/feedback/delivery": { + "title": "The campaign activity originating a message to a recipient.", + "type": "object", + "properties": { + "xdm:id": { + "title": "Delivery ID", + "type": "string", + "description": "The campaign activity originating this message." + }, + "xdm:campaignId": { + "title": "Campaign Id", + "type": "string", + "description": "Campaign of which this delivery was a part." + }, + "xdm:from": { + "title": "From", + "type": "string", + "description": "Address used as a from/sender/caller address. Depending on the communication channel, the `address` has a different format.\n\n * `email`: an email address.\n * `textMessage` or `phone`: a shortcode or phone number." + }, + "xdm:type": { + "title": "Delivery Type", + "type": "string", + "description": "Mode of delivery for the messages sent." + }, + "xdm:label": { + "title": "Delivery Label", + "type": "string", + "description": "A human-friendly name of the campaign activity which is originating this message." + }, + "xdm:name": { + "title": "Delivery Internal Name", + "type": "string", + "description": "A human-friendly identifier of the campaign activity which is originating this message." + } + } + }, + "https://ns.adobe.com/experience/campaign/feedback/message": { + "title": "A single message sent to a recipient.", + "type": "object", + "properties": { + "xdm:id": { + "title": "Message Identifier", + "type": "string", + "description": "Identifier of the message." + }, + "subject": { + "title": "Message Subject", + "type": "string", + "description": "Subject line of the message." + }, + "size": { + "title": "Message Size", + "type": "integer", + "description": "Size in bytes of the message." + }, + "recipient": { + "title": "The recipient of this message", + "type": "object", + "properties": { + "xdm:to": { + "title": "To", + "type": "string", + "description": "Address used as a to/callee address. Depending on the communication channel, the `address` has a different format.\n\n * `email`: an email address.\n * `textMessage` or `phone`: a shortcode or phone number." + }, + "xdm:type": { + "title": "Type", + "type": "string", + "description": "Whether this message message event describes the BCC, CC or To recipient." + } + } + } + } + }, + "https://ns.adobe.com/experience/campaign/feedback/messageFailure": { + "title": "Message Failure", + "type": "object", + "properties": { + "xdm:canonicalReason": { + "title": "Canonical Reason", + "type": "string", + "description": "Canonicalized text of the response returned by the remote server due to a failed delivery attempt." + }, + "xdm:reason": { + "title": "Reason", + "type": "string", + "description": "Unmodified, exact response returned by the remote server due to a failed delivery attempt." + }, + "xdm:errorCode": { + "title": "Error Code", + "type": "string", + "description": "Error code by which the remote server described a failed delivery attempt." + }, + "xdm:bounceType": { + "title": "Bounce Type", + "type": "string", + "description": "Classifies whether it is a soft bounce or hard bounce." + }, + "xdm:bounceClass": { + "title": "Bounce Class", + "type": "string", + "description": "Classification code for a given message." + } + } + }, + "https://ns.adobe.com/experience/campaign/feedback/solutionContext": { + "title": "Solution Context", + "type": "array", + "description": "List of solution specific key value pairs.", + "items": { + "$ref": "https://ns.adobe.com/experience/analytics/keyvalue" + } + }, + "https://ns.adobe.com/experience/campaign/feedback/channel": { + "title": "Delivery channel", + "type": "object", + "properties": { + "xdm:type": { + "title": "Channel Type", + "type": "string", + "description": "Classifies whether the channel is email, push, sms." + }, + "email": { + "title": "E-mail Channel", + "type": "object", + "properties": { + "interactions": { + "title": "User Interactions", + "type": "object", + "properties": { + "xdm:spamType": { + "title": "Spam Type", + "type": "string", + "description": "Type of spam report entered against this message (see RFC 5965 § 7.3)." + }, + "xdm:reportedBy": { + "title": "Reported By", + "type": "string", + "description": "E-mail Address of the entity reporting this message as spam." + }, + "xdm:reportTo": { + "title": "Report To", + "type": "string", + "description": "E-mail Address to which this spam report is to be delivered." + }, + "xdm:userAgent": { + "title": "User Agent", + "type": "string", + "description": "Value of the browser's User-Agent header." + } + } + }, + "operationalContext": { + "title": "Operational Context", + "type": "object", + "properties": { + "xdm:outboundIP": { + "title": "IP Address", + "type": "string", + "description": "Outbound IP address of the customer used to deliver the message." + }, + "xdm:sendProtocol": { + "title": "Send Protocol", + "type": "string", + "description": "Protocol by which the message is delivered." + }, + "xdm:remoteIp": { + "title": "IP Address", + "type": "string", + "oneOf": [ + { + "format": "ipv4" + }, + { + "format": "ipv6" + } + ], + "description": "IP address of the host to which this message is delivered." + }, + "xdm:mtaHost": { + "title": "Node Name", + "type": "string", + "description": "Name of the MTA Instance originating the events." + }, + "xdm:mtaIp": { + "title": "Sending IP Address", + "type": "string", + "oneOf": [ + { + "format": "ipv4" + }, + { + "format": "ipv6" + } + ], + "description": "IP address through which this message was sent." + }, + "xdm:queueTime": { + "title": "Queue time", + "type": "number", + "description": "Delay, expressed in milliseconds, between this message's injection into SparkPost and its delivery to the receiving domain; that is, the length of time this message spent in the outgoing queue." + } + } + } + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/feedbackevent" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/feedbackevent.schema.md b/docs/reference/adobe/experience/campaign/feedbackevent.schema.md new file mode 100644 index 000000000..114f4d3fc --- /dev/null +++ b/docs/reference/adobe/experience/campaign/feedbackevent.schema.md @@ -0,0 +1,660 @@ + +# Adobe Delivery Feedback Events Schema + +``` +https://ns.adobe.com/experience/campaign/feedbackevent +``` + +Contains all delivery event fields. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/feedbackevent.schema.json](adobe/experience/campaign/feedbackevent.schema.json) | + +# Adobe Delivery Feedback Events Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/feedback/channel](#httpsnsadobecomexperiencecampaignfeedbackchannel) | `object` | Optional | Adobe Delivery Feedback Events (this schema) | +| [https://ns.adobe.com/experience/campaign/feedback/delivery](#httpsnsadobecomexperiencecampaignfeedbackdelivery) | `object` | Optional | Adobe Delivery Feedback Events (this schema) | +| [https://ns.adobe.com/experience/campaign/feedback/message](#httpsnsadobecomexperiencecampaignfeedbackmessage) | `object` | Optional | Adobe Delivery Feedback Events (this schema) | +| [https://ns.adobe.com/experience/campaign/feedback/messageFailure](#httpsnsadobecomexperiencecampaignfeedbackmessagefailure) | `object` | Optional | Adobe Delivery Feedback Events (this schema) | +| [https://ns.adobe.com/experience/campaign/feedback/solutionContext](#httpsnsadobecomexperiencecampaignfeedbacksolutioncontext) | Key Value Pair | Optional | Adobe Delivery Feedback Events (this schema) | +| [https://ns.adobe.com/experience/campaign/feedback/type](#httpsnsadobecomexperiencecampaignfeedbacktype) | `string` | Optional | Adobe Delivery Feedback Events (this schema) | +| [xdm:retryCount](#xdmretrycount) | `integer` | Optional | Adobe Delivery Feedback Events (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/feedback/channel +### Delivery channel + +`https://ns.adobe.com/experience/campaign/feedback/channel` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/feedback/channel Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `email`| object | Optional | +| `xdm:type`| string | Optional | + + + +#### email +##### E-mail Channel + +undefined + +`email` +* is optional +* type: `object` + +##### email Type + +Unknown type `object`. + +```json +{ + "title": "E-mail Channel", + "type": "object", + "properties": { + "interactions": { + "title": "User Interactions", + "type": "object", + "properties": { + "xdm:spamType": { + "title": "Spam Type", + "type": "string", + "description": "Type of spam report entered against this message (see RFC 5965 § 7.3)." + }, + "xdm:reportedBy": { + "title": "Reported By", + "type": "string", + "description": "E-mail Address of the entity reporting this message as spam." + }, + "xdm:reportTo": { + "title": "Report To", + "type": "string", + "description": "E-mail Address to which this spam report is to be delivered." + }, + "xdm:userAgent": { + "title": "User Agent", + "type": "string", + "description": "Value of the browser's User-Agent header." + } + } + }, + "operationalContext": { + "title": "Operational Context", + "type": "object", + "properties": { + "xdm:outboundIP": { + "title": "IP Address", + "type": "string", + "description": "Outbound IP address of the customer used to deliver the message." + }, + "xdm:sendProtocol": { + "title": "Send Protocol", + "type": "string", + "description": "Protocol by which the message is delivered." + }, + "xdm:remoteIp": { + "title": "IP Address", + "type": "string", + "oneOf": [ + { + "format": "ipv4" + }, + { + "format": "ipv6" + } + ], + "description": "IP address of the host to which this message is delivered." + }, + "xdm:mtaHost": { + "title": "Node Name", + "type": "string", + "description": "Name of the MTA Instance originating the events." + }, + "xdm:mtaIp": { + "title": "Sending IP Address", + "type": "string", + "oneOf": [ + { + "format": "ipv4" + }, + { + "format": "ipv6" + } + ], + "description": "IP address through which this message was sent." + }, + "xdm:queueTime": { + "title": "Queue time", + "type": "number", + "description": "Delay, expressed in milliseconds, between this message's injection into SparkPost and its delivery to the receiving domain; that is, the length of time this message spent in the outgoing queue." + } + } + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:type +##### Channel Type + +Classifies whether the channel is email, push, sms. + +`xdm:type` +* is optional +* type: `string` + +##### xdm:type Type + + +`string` + + + + + + + + + + + +## https://ns.adobe.com/experience/campaign/feedback/delivery +### The campaign activity originating a message to a recipient. + +`https://ns.adobe.com/experience/campaign/feedback/delivery` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/feedback/delivery Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:campaignId`| string | Optional | +| `xdm:from`| string | Optional | +| `xdm:id`| string | Optional | +| `xdm:label`| string | Optional | +| `xdm:name`| string | Optional | +| `xdm:type`| string | Optional | + + + +#### xdm:campaignId +##### Campaign Id + +Campaign of which this delivery was a part. + +`xdm:campaignId` +* is optional +* type: `string` + +##### xdm:campaignId Type + + +`string` + + + + + + + + +#### xdm:from +##### From + +Address used as a from/sender/caller address. Depending on the communication channel, the `address` has a different format. + + * `email`: an email address. + * `textMessage` or `phone`: a shortcode or phone number. + +`xdm:from` +* is optional +* type: `string` + +##### xdm:from Type + + +`string` + + + + + + + + +#### xdm:id +##### Delivery ID + +The campaign activity originating this message. + +`xdm:id` +* is optional +* type: `string` + +##### xdm:id Type + + +`string` + + + + + + + + +#### xdm:label +##### Delivery Label + +A human-friendly name of the campaign activity which is originating this message. + +`xdm:label` +* is optional +* type: `string` + +##### xdm:label Type + + +`string` + + + + + + + + +#### xdm:name +##### Delivery Internal Name + +A human-friendly identifier of the campaign activity which is originating this message. + +`xdm:name` +* is optional +* type: `string` + +##### xdm:name Type + + +`string` + + + + + + + + +#### xdm:type +##### Delivery Type + +Mode of delivery for the messages sent. + +`xdm:type` +* is optional +* type: `string` + +##### xdm:type Type + + +`string` + + + + + + + + + + + +## https://ns.adobe.com/experience/campaign/feedback/message +### A single message sent to a recipient. + +`https://ns.adobe.com/experience/campaign/feedback/message` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/feedback/message Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `recipient`| object | Optional | +| `size`| integer | Optional | +| `subject`| string | Optional | +| `xdm:id`| string | Optional | + + + +#### recipient +##### The recipient of this message + +undefined + +`recipient` +* is optional +* type: `object` + +##### recipient Type + +Unknown type `object`. + +```json +{ + "title": "The recipient of this message", + "type": "object", + "properties": { + "xdm:to": { + "title": "To", + "type": "string", + "description": "Address used as a to/callee address. Depending on the communication channel, the `address` has a different format.\n\n * `email`: an email address.\n * `textMessage` or `phone`: a shortcode or phone number." + }, + "xdm:type": { + "title": "Type", + "type": "string", + "description": "Whether this message message event describes the BCC, CC or To recipient." + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### size +##### Message Size + +Size in bytes of the message. + +`size` +* is optional +* type: `integer` + +##### size Type + + +`integer` + + + + + + + + +#### subject +##### Message Subject + +Subject line of the message. + +`subject` +* is optional +* type: `string` + +##### subject Type + + +`string` + + + + + + + + +#### xdm:id +##### Message Identifier + +Identifier of the message. + +`xdm:id` +* is optional +* type: `string` + +##### xdm:id Type + + +`string` + + + + + + + + + + + +## https://ns.adobe.com/experience/campaign/feedback/messageFailure +### Message Failure + +`https://ns.adobe.com/experience/campaign/feedback/messageFailure` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/feedback/messageFailure Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:bounceClass`| string | Optional | +| `xdm:bounceType`| string | Optional | +| `xdm:canonicalReason`| string | Optional | +| `xdm:errorCode`| string | Optional | +| `xdm:reason`| string | Optional | + + + +#### xdm:bounceClass +##### Bounce Class + +Classification code for a given message. + +`xdm:bounceClass` +* is optional +* type: `string` + +##### xdm:bounceClass Type + + +`string` + + + + + + + + +#### xdm:bounceType +##### Bounce Type + +Classifies whether it is a soft bounce or hard bounce. + +`xdm:bounceType` +* is optional +* type: `string` + +##### xdm:bounceType Type + + +`string` + + + + + + + + +#### xdm:canonicalReason +##### Canonical Reason + +Canonicalized text of the response returned by the remote server due to a failed delivery attempt. + +`xdm:canonicalReason` +* is optional +* type: `string` + +##### xdm:canonicalReason Type + + +`string` + + + + + + + + +#### xdm:errorCode +##### Error Code + +Error code by which the remote server described a failed delivery attempt. + +`xdm:errorCode` +* is optional +* type: `string` + +##### xdm:errorCode Type + + +`string` + + + + + + + + +#### xdm:reason +##### Reason + +Unmodified, exact response returned by the remote server due to a failed delivery attempt. + +`xdm:reason` +* is optional +* type: `string` + +##### xdm:reason Type + + +`string` + + + + + + + + + + + +## https://ns.adobe.com/experience/campaign/feedback/solutionContext +### Solution Context + +List of solution specific key value pairs. + +`https://ns.adobe.com/experience/campaign/feedback/solutionContext` +* is optional +* type: Key Value Pair + +* defined in this schema + +### https://ns.adobe.com/experience/campaign/feedback/solutionContext Type + + +Array type: Key Value Pair + +All items must be of the type: +* [Key Value Pair](../analytics/keyvalue.schema.md) – `https://ns.adobe.com/experience/analytics/keyvalue` + + + + + + + + +## https://ns.adobe.com/experience/campaign/feedback/type +### Feedback Type + +The type of message event. + +`https://ns.adobe.com/experience/campaign/feedback/type` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/feedback/type Type + + +`string` + + + + + + +## xdm:retryCount +### Retry Count + +Number of failed attempts before the current event. + +`xdm:retryCount` +* is optional +* type: `integer` +* defined in this schema + +### xdm:retryCount Type + + +`integer` + + + + + diff --git a/docs/reference/adobe/experience/campaign/journeyaifatigue.schema.json b/docs/reference/adobe/experience/campaign/journeyaifatigue.schema.json new file mode 100644 index 000000000..e111f72ec --- /dev/null +++ b/docs/reference/adobe/experience/campaign/journeyaifatigue.schema.json @@ -0,0 +1,52 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/journeyaifatigue", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Fatigue Score and Level", + "type": "object", + "description": "Fatigue score and fatigue level from Journey AI.", + "definitions": { + "journeyaifatigue": { + "properties": { + "xdm:fatigueScore": { + "title": "Fatigue Score", + "description": "Fatigue score for the profile.", + "type": "number", + "exclusiveMinimum": 0, + "maximum": 1 + }, + "xdm:fatigueLevel": { + "title": "Fatigue Level", + "description": "Classification of profile into different buckets, based on fatigue score.", + "type": "string", + "enum": [ + "low", + "medium", + "high" + ], + "meta:enum": { + "low": "Low", + "medium": "Medium", + "high": "High" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/journeyaifatigue" + } + ], + "examples": [ + { + "xdm:fatigueScore": 0.53, + "xdm:fatigueLevel": "medium" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/journeyaifatigue.schema.md b/docs/reference/adobe/experience/campaign/journeyaifatigue.schema.md new file mode 100644 index 000000000..c8678cc4a --- /dev/null +++ b/docs/reference/adobe/experience/campaign/journeyaifatigue.schema.md @@ -0,0 +1,70 @@ + +# Fatigue Score and Level Schema + +``` +https://ns.adobe.com/experience/campaign/journeyaifatigue +``` + +Fatigue score and fatigue level from Journey AI. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/campaign/journeyaifatigue.schema.json](adobe/experience/campaign/journeyaifatigue.schema.json) | + +## Fatigue Score and Level Example +```json +{ + "xdm:fatigueScore": 0.53, + "xdm:fatigueLevel": "medium" +} +``` + +# Fatigue Score and Level Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:fatigueLevel](#xdmfatiguelevel) | `enum` | Optional | Fatigue Score and Level (this schema) | +| [xdm:fatigueScore](#xdmfatiguescore) | `number` | Optional | Fatigue Score and Level (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:fatigueLevel +### Fatigue Level + +Classification of profile into different buckets, based on fatigue score. + +`xdm:fatigueLevel` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmfatiguelevel-known-values). + +### xdm:fatigueLevel Known Values +| Value | Description | +|-------|-------------| +| `low` | Low | +| `medium` | Medium | +| `high` | High | + + + + +## xdm:fatigueScore +### Fatigue Score + +Fatigue score for the profile. + +`xdm:fatigueScore` +* is optional +* type: `number` +* defined in this schema + +### xdm:fatigueScore Type + + +`number` +* maximum value: `1` + + + + diff --git a/docs/reference/adobe/experience/campaign/journeyaiscores.schema.json b/docs/reference/adobe/experience/campaign/journeyaiscores.schema.json new file mode 100644 index 000000000..47238d487 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/journeyaiscores.schema.json @@ -0,0 +1,397 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/journeyaiscores", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Journey AI Scores", + "type": "object", + "description": "Journey AI scores for one channel.", + "definitions": { + "journeyaiscores": { + "properties": { + "xdm:fatigue": { + "title": "Fatigue", + "description": "Fatigue score for the profile.", + "$ref": "https://ns.adobe.com/experience/campaign/journeyaifatigue" + }, + "xdm:openScores": { + "title": "Open Scores by send hour for week", + "description": "Probability/score to open a message, assuming we send a message at that hour.", + "type": "array", + "minItems": 168, + "maxItems": 168, + "items": { + "type": "number" + } + }, + "xdm:clickScores": { + "title": "Click Scores by send hour for week", + "description": "Probability/score to click on a link in the message, assuming we send a message at that hour.", + "type": "array", + "minItems": 168, + "maxItems": 168, + "items": { + "type": "number" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/journeyaiscores" + } + ], + "examples": [ + { + "xdm:fatigue": { + "xdm:fatigueScore": 0.53, + "xdm:fatigueLevel": "medium" + }, + "xdm:openScores": [ + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1 + ], + "xdm:clickScores": [ + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1 + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/journeyaiscores.schema.md b/docs/reference/adobe/experience/campaign/journeyaiscores.schema.md new file mode 100644 index 000000000..30b60b4f0 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/journeyaiscores.schema.md @@ -0,0 +1,449 @@ + +# Journey AI Scores Schema + +``` +https://ns.adobe.com/experience/campaign/journeyaiscores +``` + +Journey AI scores for one channel. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/campaign/journeyaiscores.schema.json](adobe/experience/campaign/journeyaiscores.schema.json) | +## Schema Hierarchy + +* Journey AI Scores `https://ns.adobe.com/experience/campaign/journeyaiscores` + * [Fatigue Score and Level](journeyaifatigue.schema.md) `https://ns.adobe.com/experience/campaign/journeyaifatigue` + + +## Journey AI Scores Example +```json +{ + "xdm:fatigue": { + "xdm:fatigueScore": 0.53, + "xdm:fatigueLevel": "medium" + }, + "xdm:openScores": [ + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1 + ], + "xdm:clickScores": [ + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1, + 0.1 + ] +} +``` + +# Journey AI Scores Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:clickScores](#xdmclickscores) | `number[]` | Optional | Journey AI Scores (this schema) | +| [xdm:fatigue](#xdmfatigue) | Fatigue Score and Level | Optional | Journey AI Scores (this schema) | +| [xdm:openScores](#xdmopenscores) | `number[]` | Optional | Journey AI Scores (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:clickScores +### Click Scores by send hour for week + +Probability/score to click on a link in the message, assuming we send a message at that hour. + +`xdm:clickScores` +* is optional +* type: `number[]` +* between `168` and `168` items in the array +* defined in this schema + +### xdm:clickScores Type + + +Array type: `number[]` + +All items must be of the type: +`number` + + + + + + + + + +## xdm:fatigue +### Fatigue + +Fatigue score for the profile. + +`xdm:fatigue` +* is optional +* type: Fatigue Score and Level +* defined in this schema + +### xdm:fatigue Type + + +* [Fatigue Score and Level](journeyaifatigue.schema.md) – `https://ns.adobe.com/experience/campaign/journeyaifatigue` + + + + + +## xdm:openScores +### Open Scores by send hour for week + +Probability/score to open a message, assuming we send a message at that hour. + +`xdm:openScores` +* is optional +* type: `number[]` +* between `168` and `168` items in the array +* defined in this schema + +### xdm:openScores Type + + +Array type: `number[]` + +All items must be of the type: +`number` + + + + + + + + diff --git a/docs/reference/adobe/experience/campaign/message.schema.json b/docs/reference/adobe/experience/campaign/message.schema.json new file mode 100644 index 000000000..249fcb7db --- /dev/null +++ b/docs/reference/adobe/experience/campaign/message.schema.json @@ -0,0 +1,116 @@ +{ + "xdm:id": { + "title": "Message Identifier", + "type": "number", + "description": "Identifier of the message." + }, + "xdm:profileSnapshot": { + "title": "Profile Snapshot", + "$ref": "https://ns.adobe.com/experience/campaign/profile-snapshot", + "description": "Profile Snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent." + }, + "xdm:variant": { + "title": "Content Variant", + "type": "string", + "description": "A campaign activity can have multiple variants e.g. Multilingual (translated variants for the same content) or A/B testing (different content to test what works better) but a message delivered to a recipient always contains one of them.\n> IMPORTANT: In case of multilingual, the mirror page, the recipient can switch from one variant to another (ex: switch of the language)." + }, + "xdm:seedMember": { + "title": "Seed Member", + "type": "boolean", + "default": false, + "description": "The recipient of this message is a member of a seed list for this campaign activity. Seed addresses are used to include recipients who do not match the defined target criteria. Seed members could be your marketing team or other stakeholders who are interested in tracking/measuring the quality of the campaign. SeedMembers get the actual message, at the same time with regular recipients, even when the seedMember does not qualify to be a regular recipient." + }, + "xdm:quarantine": { + "title": "Quarantine", + "type": "boolean", + "default": false, + "description": "Address moved to quarantine. The quarantine is set to `true` when the message failed to deliver in a way that indicates that no future messages will be deliverable either to this address." + }, + "xdm:proofMember": { + "title": "Proof Member", + "type": "boolean", + "description": "The recipient of this message is a member of the proof group for this campaign activity. The proof is a special message that lets you test a delivery before sending to the main target. Proof recipients are responsible for approving both the form and content of the message. It is a pre-delivery target.", + "default": false + }, + "xdm:controlGroupMember": { + "title": "Control Group Member", + "type": "boolean", + "description": "The recipient of this message is a member of a control group for this campaign activity. A control group is a population which will not receive the delivery; it is used to track post-delivery behavior and campaign impact by making a comparison between the control group (or hold out group) with the behavior of target population, which has received the delivery.", + "default": false + }, + "xdm:testMember": { + "title": "A/B Test Member", + "type": "boolean", + "description": "The recipient of this message is a member of a test group for this campaign activity. This is primarily used for identifying the initial population of an A/B Test. After sending different variants to the testMembers, the winner Variant is decided to be sent to the remaining population based on behavioral changes in testMembers.", + "default": false + }, + "xdm:size": { + "title": "Size (Bytes)", + "type": "integer", + "description": "Size in bytes of the message.\n* For email, the `size` reflects the all MIME envelope of the message, including the encoded attachments if any.\n* For SMS, the `size` reflects the number of bytes necessary to deliver the message.\nIf that number is over 160 the message will be delivered over more than one SMS.", + "minimum": 0, + "maximum": 2147483647 + }, + "xdm:reason": { + "title": "Reason", + "type": "string", + "meta:enum": { + "undefined": "Not defined", + "unknown_user": "The address does not exist. There is no use sending deliveries to this address.", + "invalid_domain": "The domain of the email address is incorrect or no longer exists.", + "unreachable": "An error has occurred in the message delivery chain.These addresses can be removed from the quarantine list to make another attempt.", + "disabled": "The user uses a messaging service which is accessible from the web. When the Internet Access Provider (IAP) detects a lengthy period of inactivity, it can close the user's account. Deliveries to the user's address will then be impossible.", + "mailbox_full": "The recipient's mailbox contains too many messages. This address can be removed from the quarantine list to make another attempt.", + "not_connected": "The recipient's mobile phone is switched off or not connected to the network when the message is sent.", + "refused": "The address was rejected following the application of a security rule (e.g. by an anti-spam program)", + "error_ignored": "The address is whitelisted and the message ignored.", + "address_undefined": "No address is given for the recipient.", + "blacklisted": "The address was blacklisted at the time of sending.", + "quarantine": "The address was in quarantine at the time of sending.", + "duplicate": "The address of the recipient was already in this campaign activity.", + "typology_rule": "The recipient was excluded by a 'SQL' type campaign typology rule.", + "business_ranking": "The recipient was excluded by an 'arbitration' type campaign typology rule", + "cancelled": "Delivery cancelled", + "quality": "The quality rating for this address is too low", + "unchecked": "Unqualified address", + "offer_missing": "Not eligible for the offers", + "over_delivery_limit": "The campaign activity had more than allowed number of target profiles.", + "expired": "The campaign activity exceeded the time duration to complete.", + "too_long": "Text too long", + "untranslatable": "Character not supported by encoding", + "control_group": "Control address" + }, + "description": "The reason why the message could/would not be delivered.", + "default": "undefined" + }, + "xdm:reasonMessage": { + "title": "Reason Message", + "type": "string", + "description": "Reason of message delivery failure." + }, + "xdm:outboundIP": { + "title": "IP Address", + "type": "string", + "oneOf": [ + { + "format": "ipv4" + }, + { + "format": "ipv6" + } + ], + "description": "Outbound IP address used to deliver the message." + }, + "xdm:externalID": { + "title": "External ID", + "type": "string", + "description": "An ID generated by the parent activity invoking service to check later if the incoming experienceEvent was generated using this ID." + }, + "xdm:segmentID": { + "title": "Segment ID", + "type": "string", + "description": "A code or ID assigned to the segment population generated by a segmentation workflow. This can identify the population as part of a result set based on a criteria." + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/campaign/message" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/message.schema.md b/docs/reference/adobe/experience/campaign/message.schema.md new file mode 100644 index 000000000..2db19b0c7 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/message.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/campaign/message +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/campaign/message.schema.json](adobe/experience/campaign/message.schema.json) | diff --git a/docs/reference/adobe/experience/campaign/mutationevent.schema.json b/docs/reference/adobe/experience/campaign/mutationevent.schema.json new file mode 100644 index 000000000..7ccc40035 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/mutationevent.schema.json @@ -0,0 +1,85 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/mutationevent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Campaign Mutation Event", + "type": "object", + "description": "Adobe Campaign mutation event.", + "definitions": { + "mutationevent": { + "properties": { + "xdm:timestamp": { + "title": "Timestamp", + "type": "string", + "format": "date-time", + "description": "The time when the first event of the interaction occurred." + }, + "xdm:web": { + "title": "Web", + "$ref": "https://ns.adobe.com/xdm/context/webinfo", + "description": "The information related to web page and link of the ExperienceEvent." + }, + "xdm:directMarketing": { + "title": "Direct Marketing", + "$ref": "https://ns.adobe.com/xdm/context/direct-marketing", + "description": "The events and properties related to direct/outbound marketing such as email, direct mail, texts and in-app notifications." + }, + "https://ns.adobe.com/experience/campaign/message": { + "title": "A single message sent to a recipient.", + "type": "object", + "properties": { + "xdm:quarantine": { + "title": "Quarantine", + "type": "boolean", + "default": false, + "description": "Address moved to quarantine. The quarantine is set to `true` when the message failed to deliver in a way that indicates that no future messages will be deliverable either to this address." + }, + "xdm:reason": { + "title": "Reason", + "type": "string", + "meta:enum": { + "undefined": "Not defined", + "unknown_user": "The address does not exist. There is no use sending deliveries to this address.", + "invalid_domain": "The domain of the email address is incorrect or no longer exists.", + "unreachable": "An error has occurred in the message delivery chain.These addresses can be removed from the quarantine list to make another attempt.", + "disabled": "The user uses a messaging service which is accessible from the web. When the Internet Access Provider (IAP) detects a lengthy period of inactivity, it can close the user's account. Deliveries to the user's address will then be impossible.", + "mailbox_full": "The recipient's mailbox contains too many messages. This address can be removed from the quarantine list to make another attempt.", + "not_connected": "The recipient's mobile phone is switched off or not connected to the network when the message is sent.", + "refused": "The address was rejected following the application of a security rule (e.g. by an anti-spam program)", + "error_ignored": "The address is whitelisted and the message ignored.", + "address_undefined": "No address is given for the recipient.", + "blacklisted": "The address was blacklisted at the time of sending.", + "quarantine": "The address was in quarantine at the time of sending.", + "duplicate": "The address of the recipient was already in this campaign activity.", + "typology_rule": "The recipient was excluded by a 'SQL' type campaign typology rule.", + "business_ranking": "The recipient was excluded by an 'arbitration' type campaign typology rule", + "cancelled": "Delivery cancelled", + "quality": "The quality rating for this address is too low", + "unchecked": "Unqualified address", + "offer_missing": "Not eligible for the offers", + "over_delivery_limit": "The campaign activity had more than allowed number of target profiles.", + "expired": "The campaign activity exceeded the time duration to complete.", + "too_long": "Text too long", + "untranslatable": "Character not supported by encoding", + "control_group": "Control address" + }, + "description": "The reason why the message could/would not be delivered.", + "default": "undefined" + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/mutationevent" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/mutationevent.schema.md b/docs/reference/adobe/experience/campaign/mutationevent.schema.md new file mode 100644 index 000000000..36c2eb4a0 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/mutationevent.schema.md @@ -0,0 +1,184 @@ + +# Adobe Campaign Mutation Event Schema + +``` +https://ns.adobe.com/experience/campaign/mutationevent +``` + +Adobe Campaign mutation event. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/mutationevent.schema.json](adobe/experience/campaign/mutationevent.schema.json) | +## Schema Hierarchy + +* Adobe Campaign Mutation Event `https://ns.adobe.com/experience/campaign/mutationevent` + * [Web information](../../../datatypes/webinfo.schema.md) `https://ns.adobe.com/xdm/context/webinfo` + * [Direct marketing](../../../datatypes/direct-marketing.schema.md) `https://ns.adobe.com/xdm/context/direct-marketing` + + +# Adobe Campaign Mutation Event Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/campaign/message](#httpsnsadobecomexperiencecampaignmessage) | `object` | Optional | Adobe Campaign Mutation Event (this schema) | +| [xdm:directMarketing](#xdmdirectmarketing) | Direct marketing | Optional | Adobe Campaign Mutation Event (this schema) | +| [xdm:timestamp](#xdmtimestamp) | `string` | Optional | Adobe Campaign Mutation Event (this schema) | +| [xdm:web](#xdmweb) | Web information | Optional | Adobe Campaign Mutation Event (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/campaign/message +### A single message sent to a recipient. + +`https://ns.adobe.com/experience/campaign/message` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/campaign/message Type + + +`object` with following properties: + + +| Property | Type | Required | Default | +|----------|------|----------|---------| +| `xdm:quarantine`| boolean | Optional | `false` | +| `xdm:reason`| string | Optional | `"undefined"` | + + + +#### xdm:quarantine +##### Quarantine + +Address moved to quarantine. The quarantine is set to `true` when the message failed to deliver in a way that indicates that no future messages will be deliverable either to this address. + +`xdm:quarantine` +* is optional +* type: `boolean` +* default: `false` + + +##### xdm:quarantine Type + + +`boolean` + + + + + + + +#### xdm:reason +##### Reason + +The reason why the message could/would not be delivered. + +`xdm:reason` +* is optional +* type: `string` +* default: `"undefined"` + + +##### xdm:reason Type + + +`string` + + + +##### xdm:reason Known Values +| Value | Description | +|-------|-------------| +| `undefined` | Not defined | +| `unknown_user` | The address does not exist. There is no use sending deliveries to this address. | +| `invalid_domain` | The domain of the email address is incorrect or no longer exists. | +| `unreachable` | An error has occurred in the message delivery chain.These addresses can be removed from the quarantine list to make another attempt. | +| `disabled` | The user uses a messaging service which is accessible from the web. When the Internet Access Provider (IAP) detects a lengthy period of inactivity, it can close the user's account. Deliveries to the user's address will then be impossible. | +| `mailbox_full` | The recipient's mailbox contains too many messages. This address can be removed from the quarantine list to make another attempt. | +| `not_connected` | The recipient's mobile phone is switched off or not connected to the network when the message is sent. | +| `refused` | The address was rejected following the application of a security rule (e.g. by an anti-spam program) | +| `error_ignored` | The address is whitelisted and the message ignored. | +| `address_undefined` | No address is given for the recipient. | +| `blacklisted` | The address was blacklisted at the time of sending. | +| `quarantine` | The address was in quarantine at the time of sending. | +| `duplicate` | The address of the recipient was already in this campaign activity. | +| `typology_rule` | The recipient was excluded by a 'SQL' type campaign typology rule. | +| `business_ranking` | The recipient was excluded by an 'arbitration' type campaign typology rule | +| `cancelled` | Delivery cancelled | +| `quality` | The quality rating for this address is too low | +| `unchecked` | Unqualified address | +| `offer_missing` | Not eligible for the offers | +| `over_delivery_limit` | The campaign activity had more than allowed number of target profiles. | +| `expired` | The campaign activity exceeded the time duration to complete. | +| `too_long` | Text too long | +| `untranslatable` | Character not supported by encoding | +| `control_group` | Control address | + + + + + + + + + +## xdm:directMarketing +### Direct Marketing + +The events and properties related to direct/outbound marketing such as email, direct mail, texts and in-app notifications. + +`xdm:directMarketing` +* is optional +* type: Direct marketing +* defined in this schema + +### xdm:directMarketing Type + + +* [Direct marketing](../../../datatypes/direct-marketing.schema.md) – `https://ns.adobe.com/xdm/context/direct-marketing` + + + + + +## xdm:timestamp +### Timestamp + +The time when the first event of the interaction occurred. + +`xdm:timestamp` +* is optional +* type: `string` +* defined in this schema + +### xdm:timestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:web +### Web + +The information related to web page and link of the ExperienceEvent. + +`xdm:web` +* is optional +* type: Web information +* defined in this schema + +### xdm:web Type + + +* [Web information](../../../datatypes/webinfo.schema.md) – `https://ns.adobe.com/xdm/context/webinfo` + + + + diff --git a/docs/reference/adobe/experience/campaign/notificationsubscription.schema.json b/docs/reference/adobe/experience/campaign/notificationsubscription.schema.json new file mode 100644 index 000000000..a401ebc9e --- /dev/null +++ b/docs/reference/adobe/experience/campaign/notificationsubscription.schema.json @@ -0,0 +1,79 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/notificationsubscription", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Notification Subscription", + "type": "object", + "meta:extensible": true, + "description": "Adobe Campaign notification subscriptions allow end-users opt into topics that can be used for communication such as marketing subscription lists.", + "definitions": { + "notificationSubscription": { + "properties": { + "xdm:topicID": { + "title": "Topic Identifier", + "type": "string", + "description": "The topic that the end-user has subscribed to and opted into notifications for." + }, + "xdm:type": { + "title": "Subscription type", + "type": "string", + "description": "The type of notification/subscription." + }, + "xdm:subscriptionDate": { + "title": "Subscription Date", + "type": "string", + "format": "date-time", + "description": "Date and time when the end-user has subscribed to a notification topic. An end-user is subscribed if they have a Subscription Date and the `unsubscriptiondetails/unsubscriptionDate` is empty." + }, + "xdm:notificationTarget": { + "title": "Target/destination for the notification", + "description": "Target/destination for where to send/receive the notification.", + "$ref": "https://ns.adobe.com/experience/campaign/notificationsubscriptiontarget" + }, + "xdm:unsubscriptionDetails": { + "title": "Adobe Campaign Notification Unsubscription details", + "description": "Adobe Campaign notification unsubscription details.", + "$ref": "https://ns.adobe.com/experience/campaign/notificationunsubscriptiondetails" + } + }, + "required": [ + "xdm:topicID", + "xdm:type", + "xdm:subscriptionDate" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/notificationSubscription" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf", + "xdm:type": "Campaign/SubscriptionList", + "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00", + "xdm:emailAddress": "johnDoe@adobe.com" + }, + { + "xdm:topicID": "50ac9bf9-721d-44ac-8cf3-fb04c089f3bf", + "xdm:type": "Campaign/SubscriptionList", + "xdm:subscriptionDate": "2017-02-26T15:52:25+00:00", + "xdm:emailAddress": "johnDoe@adobe.com", + "xdm:unsubscriptionDetails": { + "xdm:unsubscriptionDate": "2017-09-26T15:52:25+00:00", + "xdm:remarkID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3be", + "xdm:remarkText": "Sorry, leave me alone. These are my personal comments" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/notificationsubscription.schema.md b/docs/reference/adobe/experience/campaign/notificationsubscription.schema.md new file mode 100644 index 000000000..5394e8f0e --- /dev/null +++ b/docs/reference/adobe/experience/campaign/notificationsubscription.schema.md @@ -0,0 +1,155 @@ + +# Notification Subscription Schema + +``` +https://ns.adobe.com/experience/campaign/notificationsubscription +``` + +Adobe Campaign notification subscriptions allow end-users opt into topics that can be used for communication such as marketing subscription lists. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/notificationsubscription.schema.json](adobe/experience/campaign/notificationsubscription.schema.json) | +## Schema Hierarchy + +* Notification Subscription `https://ns.adobe.com/experience/campaign/notificationsubscription` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Notification Subscription Target](notificationsubscriptiontarget.schema.md) `https://ns.adobe.com/experience/campaign/notificationsubscriptiontarget` + * [Notification Unsubscription Details](notificationunsubscriptiondetails.schema.md) `https://ns.adobe.com/experience/campaign/notificationunsubscriptiondetails` + + +## Notification Subscription Examples + +```json +{ + "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf", + "xdm:type": "Campaign/SubscriptionList", + "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00", + "xdm:emailAddress": "johnDoe@adobe.com" +} +``` + +```json +{ + "xdm:topicID": "50ac9bf9-721d-44ac-8cf3-fb04c089f3bf", + "xdm:type": "Campaign/SubscriptionList", + "xdm:subscriptionDate": "2017-02-26T15:52:25+00:00", + "xdm:emailAddress": "johnDoe@adobe.com", + "xdm:unsubscriptionDetails": { + "xdm:unsubscriptionDate": "2017-09-26T15:52:25+00:00", + "xdm:remarkID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3be", + "xdm:remarkText": "Sorry, leave me alone. These are my personal comments" + } +} +``` + + +# Notification Subscription Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:notificationTarget](#xdmnotificationtarget) | Notification Subscription Target | Optional | Notification Subscription (this schema) | +| [xdm:subscriptionDate](#xdmsubscriptiondate) | `string` | Optional | Notification Subscription (this schema) | +| [xdm:topicID](#xdmtopicid) | `string` | Optional | Notification Subscription (this schema) | +| [xdm:type](#xdmtype) | `string` | Optional | Notification Subscription (this schema) | +| [xdm:unsubscriptionDetails](#xdmunsubscriptiondetails) | Notification Unsubscription Details | Optional | Notification Subscription (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:notificationTarget +### Target/destination for the notification + +Target/destination for where to send/receive the notification. + +`xdm:notificationTarget` +* is optional +* type: Notification Subscription Target +* defined in this schema + +### xdm:notificationTarget Type + + +* [Notification Subscription Target](notificationsubscriptiontarget.schema.md) – `https://ns.adobe.com/experience/campaign/notificationsubscriptiontarget` + + + + + +## xdm:subscriptionDate +### Subscription Date + +Date and time when the end-user has subscribed to a notification topic. An end-user is subscribed if they have a Subscription Date and the `unsubscriptiondetails/unsubscriptionDate` is empty. + +`xdm:subscriptionDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:subscriptionDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:topicID +### Topic Identifier + +The topic that the end-user has subscribed to and opted into notifications for. + +`xdm:topicID` +* is optional +* type: `string` +* defined in this schema + +### xdm:topicID Type + + +`string` + + + + + + +## xdm:type +### Subscription type + +The type of notification/subscription. + +`xdm:type` +* is optional +* type: `string` +* defined in this schema + +### xdm:type Type + + +`string` + + + + + + +## xdm:unsubscriptionDetails +### Adobe Campaign Notification Unsubscription details + +Adobe Campaign notification unsubscription details. + +`xdm:unsubscriptionDetails` +* is optional +* type: Notification Unsubscription Details +* defined in this schema + +### xdm:unsubscriptionDetails Type + + +* [Notification Unsubscription Details](notificationunsubscriptiondetails.schema.md) – `https://ns.adobe.com/experience/campaign/notificationunsubscriptiondetails` + + + + diff --git a/docs/reference/adobe/experience/campaign/notificationsubscriptiontarget.schema.json b/docs/reference/adobe/experience/campaign/notificationsubscriptiontarget.schema.json new file mode 100644 index 000000000..f0e4d2bb0 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/notificationsubscriptiontarget.schema.json @@ -0,0 +1,35 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/notificationsubscriptiontarget", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Notification Subscription Target", + "type": "object", + "meta:extensible": true, + "description": "Target/destination for where to send/receive the notification.", + "definitions": { + "notificationSubscriptionTarget": { + "properties": { + "xdm:emailAddress": { + "title": "Address", + "type": "string", + "format": "email", + "description": "The technical address, e.g 'name@domain.com' as commonly defined in RFC2822 and subsequent standards." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/notificationSubscriptionTarget" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/notificationsubscriptiontarget.schema.md b/docs/reference/adobe/experience/campaign/notificationsubscriptiontarget.schema.md new file mode 100644 index 000000000..654df47e4 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/notificationsubscriptiontarget.schema.md @@ -0,0 +1,45 @@ + +# Notification Subscription Target Schema + +``` +https://ns.adobe.com/experience/campaign/notificationsubscriptiontarget +``` + +Target/destination for where to send/receive the notification. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/notificationsubscriptiontarget.schema.json](adobe/experience/campaign/notificationsubscriptiontarget.schema.json) | +## Schema Hierarchy + +* Notification Subscription Target `https://ns.adobe.com/experience/campaign/notificationsubscriptiontarget` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +# Notification Subscription Target Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:emailAddress](#xdmemailaddress) | `string` | Optional | Notification Subscription Target (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:emailAddress +### Address + +The technical address, e.g 'name@domain.com' as commonly defined in RFC2822 and subsequent standards. + +`xdm:emailAddress` +* is optional +* type: `string` +* defined in this schema + +### xdm:emailAddress Type + + +`string` +* format: `email` – email address (according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322)) + + + + + diff --git a/docs/reference/adobe/experience/campaign/notificationunsubscriptiondetails.schema.json b/docs/reference/adobe/experience/campaign/notificationunsubscriptiondetails.schema.json new file mode 100644 index 000000000..b5dccb970 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/notificationunsubscriptiondetails.schema.json @@ -0,0 +1,48 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/notificationunsubscriptiondetails", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Notification Unsubscription Details", + "type": "object", + "meta:extensible": true, + "description": "Adobe Campaign notification unsubscriptions allow end-users opt out after opting into topics that can be used for communication such as marketing subscription lists.", + "definitions": { + "notificationUnSubscriptionDetails": { + "properties": { + "xdm:unsubscriptionDate": { + "title": "Unsubscription Date", + "type": "string", + "format": "date-time", + "description": "Date and time when the end-user has unsubscribed from a notification topic. When the subscription is registered the xdm:unsubscriptionDate must be empty." + }, + "xdm:remarkID": { + "title": "Remark Identifier", + "type": "string", + "description": "The pre defined remark that the end-user identified when unsubscribing." + }, + "xdm:remarkText": { + "title": "Remark text", + "type": "string", + "description": "A customer comment/remark that the end-user provided when unsubscribing." + } + }, + "required": [ + "xdm:unsubscriptionDate" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/notificationUnSubscriptionDetails" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/notificationunsubscriptiondetails.schema.md b/docs/reference/adobe/experience/campaign/notificationunsubscriptiondetails.schema.md new file mode 100644 index 000000000..e9ec6d0fa --- /dev/null +++ b/docs/reference/adobe/experience/campaign/notificationunsubscriptiondetails.schema.md @@ -0,0 +1,87 @@ + +# Notification Unsubscription Details Schema + +``` +https://ns.adobe.com/experience/campaign/notificationunsubscriptiondetails +``` + +Adobe Campaign notification unsubscriptions allow end-users opt out after opting into topics that can be used for communication such as marketing subscription lists. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/notificationunsubscriptiondetails.schema.json](adobe/experience/campaign/notificationunsubscriptiondetails.schema.json) | +## Schema Hierarchy + +* Notification Unsubscription Details `https://ns.adobe.com/experience/campaign/notificationunsubscriptiondetails` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +# Notification Unsubscription Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:remarkID](#xdmremarkid) | `string` | Optional | Notification Unsubscription Details (this schema) | +| [xdm:remarkText](#xdmremarktext) | `string` | Optional | Notification Unsubscription Details (this schema) | +| [xdm:unsubscriptionDate](#xdmunsubscriptiondate) | `string` | Optional | Notification Unsubscription Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:remarkID +### Remark Identifier + +The pre defined remark that the end-user identified when unsubscribing. + +`xdm:remarkID` +* is optional +* type: `string` +* defined in this schema + +### xdm:remarkID Type + + +`string` + + + + + + +## xdm:remarkText +### Remark text + +A customer comment/remark that the end-user provided when unsubscribing. + +`xdm:remarkText` +* is optional +* type: `string` +* defined in this schema + +### xdm:remarkText Type + + +`string` + + + + + + +## xdm:unsubscriptionDate +### Unsubscription Date + +Date and time when the end-user has unsubscribed from a notification topic. When the subscription is registered the xdm:unsubscriptionDate must be empty. + +`xdm:unsubscriptionDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:unsubscriptionDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + diff --git a/docs/reference/adobe/experience/campaign/offer-detail.schema.json b/docs/reference/adobe/experience/campaign/offer-detail.schema.json new file mode 100644 index 000000000..eb6f252c7 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/offer-detail.schema.json @@ -0,0 +1,38 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/campaign/offer-detail", + "meta:abstract": true, + "meta:extensible": true, + "type": "object", + "title": "Campaign Offer Detail", + "meta:extends": [ + "https://ns.adobe.com/experience/offer-management/offer-detail" + ], + "description": "Campaign offer detail is used to capture the attributes of a Campaign offer in a proposition or response. Offers are the decision options in the Offer Management domain and the Campaign offer detail datatype extends the option detail datatype.", + "definitions": { + "offer-detail": { + "properties": { + "xdm:eligibilityRule": { + "type": "string", + "format": "uri", + "title": "Eligibility Rule", + "description": "The reference to an eligibility rule that tests a condition using the profile and/or other contextual XDM instances. The value is the URI (@id) of the eligibility rule that is referenced. See schema https://ns.adobe.com/experience/offer-management/eligibility-rule" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/offer-detail" + }, + { + "$ref": "https://ns.adobe.com/experience/offer-management/offer-detail" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/offer-detail.schema.md b/docs/reference/adobe/experience/campaign/offer-detail.schema.md new file mode 100644 index 000000000..6c9f4b8af --- /dev/null +++ b/docs/reference/adobe/experience/campaign/offer-detail.schema.md @@ -0,0 +1,76 @@ + +# Campaign Offer Detail Schema + +``` +https://ns.adobe.com/experience/campaign/offer-detail +``` + +Campaign offer detail is used to capture the attributes of a Campaign offer in a proposition or response. Offers are the decision options in the Offer Management domain and the Campaign offer detail datatype extends the option detail datatype. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/campaign/offer-detail.schema.json](adobe/experience/campaign/offer-detail.schema.json) | +## Schema Hierarchy + +* Campaign Offer Detail `https://ns.adobe.com/experience/campaign/offer-detail` + * [Offer Detail](../offer-management/offer-detail.schema.md) `https://ns.adobe.com/experience/offer-management/offer-detail` + + +# Campaign Offer Detail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:eligibilityRule](#xdmeligibilityrule) | `string` | Optional | Campaign Offer Detail (this schema) | +| [xdm:tags](#xdmtags) | `string[]` | Optional | [Offer Detail](../offer-management/offer-detail.schema.md#xdmtags) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:eligibilityRule +### Eligibility Rule + +The reference to an eligibility rule that tests a condition using the profile and/or other contextual XDM instances. The value is the URI (@id) of the eligibility rule that is referenced. See schema https://ns.adobe.com/experience/offer-management/eligibility-rule + +`xdm:eligibilityRule` +* is optional +* type: `string` +* defined in this schema + +### xdm:eligibilityRule Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:tags +### Tags + +The set of tags associated with this offer. The tags are used in offer filter expressions to constrain the overall offer inventory to a topical sub set (category). + +`xdm:tags` +* is optional +* type: `string[]` + +* defined in [Offer Detail](../offer-management/offer-detail.schema.md#xdmtags) + +### xdm:tags Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + +An identifier of a tag object. The value is the @id of the tag that is referenced. See tag schema: https://ns.adobe.com/experience/offer-management/tag + + + + + + diff --git a/docs/reference/adobe/experience/campaign/offer-proposition-detail.schema.json b/docs/reference/adobe/experience/campaign/offer-proposition-detail.schema.json new file mode 100644 index 000000000..dd88a255b --- /dev/null +++ b/docs/reference/adobe/experience/campaign/offer-proposition-detail.schema.json @@ -0,0 +1,40 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/offer-proposition-detail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Campaign Offer Proposition Detail", + "type": "object", + "meta:abstract": true, + "meta:extensible": true, + "description": "An offer proposition detail is used to capture the details about an offer proposition.", + "definitions": { + "proposition-detail-datatype": { + "properties": { + "xdm:activity": { + "title": "Offer Activity Detail", + "description": "Snapshot of the Activity for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the decision activity.", + "$ref": "https://ns.adobe.com/experience/offer-management/offer-activity-detail" + }, + "xdm:offer": { + "title": "Campaign Offer Detail", + "description": "Snapshot of the Offer that the recipient responded to. The object contains a at least the xdm:id property value which is the identifier of an Offer.", + "$ref": "https://ns.adobe.com/experience/campaign/offer-detail" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/proposition-detail-datatype" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/offer-proposition-detail.schema.md b/docs/reference/adobe/experience/campaign/offer-proposition-detail.schema.md new file mode 100644 index 000000000..35f2a42db --- /dev/null +++ b/docs/reference/adobe/experience/campaign/offer-proposition-detail.schema.md @@ -0,0 +1,65 @@ + +# Campaign Offer Proposition Detail Schema + +``` +https://ns.adobe.com/experience/campaign/offer-proposition-detail +``` + +An offer proposition detail is used to capture the details about an offer proposition. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/offer-proposition-detail.schema.json](adobe/experience/campaign/offer-proposition-detail.schema.json) | +## Schema Hierarchy + +* Campaign Offer Proposition Detail `https://ns.adobe.com/experience/campaign/offer-proposition-detail` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Offer Activity Detail](../offer-management/offer-activity-detail.schema.md) `https://ns.adobe.com/experience/offer-management/offer-activity-detail` + * [Campaign Offer Detail](offer-detail.schema.md) `https://ns.adobe.com/experience/campaign/offer-detail` + + +# Campaign Offer Proposition Detail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:activity](#xdmactivity) | Offer Activity Detail | Optional | Campaign Offer Proposition Detail (this schema) | +| [xdm:offer](#xdmoffer) | Campaign Offer Detail | Optional | Campaign Offer Proposition Detail (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:activity +### Offer Activity Detail + +Snapshot of the Activity for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the decision activity. + +`xdm:activity` +* is optional +* type: Offer Activity Detail +* defined in this schema + +### xdm:activity Type + + +* [Offer Activity Detail](../offer-management/offer-activity-detail.schema.md) – `https://ns.adobe.com/experience/offer-management/offer-activity-detail` + + + + + +## xdm:offer +### Campaign Offer Detail + +Snapshot of the Offer that the recipient responded to. The object contains a at least the xdm:id property value which is the identifier of an Offer. + +`xdm:offer` +* is optional +* type: Campaign Offer Detail +* defined in this schema + +### xdm:offer Type + + +* [Campaign Offer Detail](offer-detail.schema.md) – `https://ns.adobe.com/experience/campaign/offer-detail` + + + + diff --git a/docs/reference/adobe/experience/campaign/offer-response-detail.schema.json b/docs/reference/adobe/experience/campaign/offer-response-detail.schema.json new file mode 100644 index 000000000..7d7676515 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/offer-response-detail.schema.json @@ -0,0 +1,48 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/offer-response-detail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Campaign Offer Response Detail", + "type": "object", + "meta:abstract": true, + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/experience/offer-management/proposition-response-detail" + ], + "description": "An Offer Proposition Detail is used to capture the details about an Offer Proposition.", + "definitions": { + "response-detail-datatype": { + "properties": { + "xdm:offer": { + "title": "Campaign Offer Detail", + "description": "Snapshot of the Offer that the recipient responded to. The object contains a at least the xdm:id property value which is the identifier of an Offer.", + "properties": { + "xdm:eligibilityRule": { + "type": "string", + "format": "uri", + "title": "Eligibility Rule", + "description": "The reference to an eligibility rule that tests a condition using the profile and/or other contextual XDM instances. The value is the URI (@id) of the eligibility rule that is referenced. See schema https://ns.adobe.com/experience/offer-management/eligibility-rule" + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/experience/offer-management/proposition-response-detail" + }, + { + "$ref": "#/definitions/response-detail-datatype" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/offer-response-detail.schema.md b/docs/reference/adobe/experience/campaign/offer-response-detail.schema.md new file mode 100644 index 000000000..6c95da089 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/offer-response-detail.schema.md @@ -0,0 +1,64 @@ + +# Campaign Offer Response Detail Schema + +``` +https://ns.adobe.com/experience/campaign/offer-response-detail +``` + +An Offer Proposition Detail is used to capture the details about an Offer Proposition. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/offer-response-detail.schema.json](adobe/experience/campaign/offer-response-detail.schema.json) | +## Schema Hierarchy + +* Campaign Offer Response Detail `https://ns.adobe.com/experience/campaign/offer-response-detail` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Offer Response Detail](../offer-management/proposition-response-detail.schema.md) `https://ns.adobe.com/experience/offer-management/proposition-response-detail` + + +# Campaign Offer Response Detail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:activity](#xdmactivity) | Offer Activity Detail | Optional | [Offer Response Detail](../offer-management/proposition-response-detail.schema.md#xdmactivity) | +| [xdm:offer](#xdmoffer) | Offer Detail | Optional | [Offer Response Detail](../offer-management/proposition-response-detail.schema.md#xdmoffer) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:activity +### Offer Activity + +Snapshot of the activity for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the decision activity. + +`xdm:activity` +* is optional +* type: Offer Activity Detail +* defined in [Offer Response Detail](../offer-management/proposition-response-detail.schema.md#xdmactivity) + +### xdm:activity Type + + +* [Offer Activity Detail](../offer-management/offer-activity-detail.schema.md) – `https://ns.adobe.com/experience/offer-management/offer-activity-detail` + + + + + +## xdm:offer +### Offer + +Snapshot of the offer that the recipient responded to. The object contains a at least the xdm:id property value which is the identifier of an offer. + +`xdm:offer` +* is optional +* type: Offer Detail +* defined in [Offer Response Detail](../offer-management/proposition-response-detail.schema.md#xdmoffer) + +### xdm:offer Type + + +* [Offer Detail](../offer-management/offer-detail.schema.md) – `https://ns.adobe.com/experience/offer-management/offer-detail` + + + + diff --git a/docs/reference/adobe/experience/campaign/orchestration.schema.json b/docs/reference/adobe/experience/campaign/orchestration.schema.json new file mode 100644 index 000000000..f00d6b1bf --- /dev/null +++ b/docs/reference/adobe/experience/campaign/orchestration.schema.json @@ -0,0 +1,14 @@ +{ + "xdm:eventID": { + "title": "Event ID", + "type": "string", + "description": "ID that identifies the event sent by the data source. This is used by Campaign orchestration to identify the event without inspecting its payload to determine which action should be triggered when the event is received. The value is automatically generated in Campaign at event creation time, it is globally unique across organizations." + }, + "xdm:orchestrationDetails": { + "title": "Orchestration Details", + "description": "Set of attributes that are associated with every orchestration.", + "$ref": "https://ns.adobe.com/experience/campaign/orchestration/orchestrationdetails" + }, + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/campaign/orchestration" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/orchestration.schema.md b/docs/reference/adobe/experience/campaign/orchestration.schema.md new file mode 100644 index 000000000..c06c50a13 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/orchestration.schema.md @@ -0,0 +1,11 @@ + +# Schema + +``` +https://ns.adobe.com/experience/campaign/orchestration +``` + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | No | Experimental | No | Forbidden | Permitted | [adobe/experience/campaign/orchestration.schema.json](adobe/experience/campaign/orchestration.schema.json) | diff --git a/docs/reference/adobe/experience/campaign/profile-all.schema.json b/docs/reference/adobe/experience/campaign/profile-all.schema.json new file mode 100644 index 000000000..d143d4b48 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/profile-all.schema.json @@ -0,0 +1,50 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/campaign/profile-all", + "title": "Adobe Campaign Profile Full Extension", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "Adobe Campaign full extension for Profile", + "definitions": { + "profile": { + "properties": { + "xdm:journeyAI": { + "title": "Journey AI Scores", + "type": "object", + "description": "Journey AI scores for all channels.", + "properties": { + "xdm:emailScore": { + "title": "Journey AI scores for Email Channel", + "$ref": "https://ns.adobe.com/experience/campaign/journeyaiscores", + "description": "Journey AI open, click and fatigue scores for email channel." + } + } + }, + "xdm:notificationSubscriptions": { + "title": "Adobe Campaign Notification Subscriptions", + "type": "array", + "description": "Adobe Campaign notification subscriptions are used to communicate with endusers that have enrolled for specific notifications.", + "items": { + "$ref": "https://ns.adobe.com/experience/campaign/notificationsubscription" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/profile" + } + ], + "examples": [] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/profile-all.schema.md b/docs/reference/adobe/experience/campaign/profile-all.schema.md new file mode 100644 index 000000000..b4f81cb2b --- /dev/null +++ b/docs/reference/adobe/experience/campaign/profile-all.schema.md @@ -0,0 +1,91 @@ + +# Adobe Campaign Profile Full Extension Schema + +``` +https://ns.adobe.com/experience/campaign/profile-all +``` + +Adobe Campaign full extension for Profile + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/campaign/profile-all.schema.json](adobe/experience/campaign/profile-all.schema.json) | + +# Adobe Campaign Profile Full Extension Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:journeyAI](#xdmjourneyai) | `object` | Optional | Adobe Campaign Profile Full Extension (this schema) | +| [xdm:notificationSubscriptions](#xdmnotificationsubscriptions) | Notification Subscription | Optional | Adobe Campaign Profile Full Extension (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:journeyAI +### Journey AI Scores + +Journey AI scores for all channels. + +`xdm:journeyAI` +* is optional +* type: `object` +* defined in this schema + +### xdm:journeyAI Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:emailScore`| | Optional | + + + +#### xdm:emailScore +##### Journey AI scores for Email Channel + +Journey AI open, click and fatigue scores for email channel. + +`xdm:emailScore` +* is optional +* type: reference + +##### xdm:emailScore Type + + +* []() – `https://ns.adobe.com/experience/campaign/journeyaiscores` + + + + + + + + + + +## xdm:notificationSubscriptions +### Adobe Campaign Notification Subscriptions + +Adobe Campaign notification subscriptions are used to communicate with endusers that have enrolled for specific notifications. + +`xdm:notificationSubscriptions` +* is optional +* type: Notification Subscription + +* defined in this schema + +### xdm:notificationSubscriptions Type + + +Array type: Notification Subscription + +All items must be of the type: +* [Notification Subscription](notificationsubscription.schema.md) – `https://ns.adobe.com/experience/campaign/notificationsubscription` + + + + + + + diff --git a/docs/reference/adobe/experience/campaign/profile-snapshot.schema.json b/docs/reference/adobe/experience/campaign/profile-snapshot.schema.json new file mode 100644 index 000000000..ec81ba12f --- /dev/null +++ b/docs/reference/adobe/experience/campaign/profile-snapshot.schema.json @@ -0,0 +1,141 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/campaign/profile-snapshot", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Campaign Profile Snapshot", + "type": "object", + "description": "Adobe Campaign Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent.", + "definitions": { + "profile-snapshot": { + "properties": { + "xdm:person": { + "title": "Person", + "$ref": "https://ns.adobe.com/xdm/context/person", + "description": "An individual actor, contact, or owner." + }, + "xdm:directMarketingAddress": { + "title": "Direct Marketing Address", + "$ref": "https://ns.adobe.com/xdm/context/directmarketing-address", + "description": "Direct Marketing postal address." + }, + "xdm:directMarketingEmail": { + "title": "Direct Marketing Email", + "$ref": "https://ns.adobe.com/xdm/context/directmarketing-emailaddress", + "description": "Direct Marketing email address." + }, + "xdm:directMarketingPhone": { + "title": "Direct Marketing Phone", + "$ref": "https://ns.adobe.com/xdm/context/directmarketing-phonenumber", + "description": "Direct Marketing phone number." + }, + "xdm:pushNotificationTokens": { + "title": "Push Notification Tokens", + "type": "array", + "description": "Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts.", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/pushnotificationtoken" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/profile-snapshot" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:person": { + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDayAndMonth": "01-03", + "xdm:gender": "female" + }, + "xdm:directMarketingPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active", + "xdm:errorCount": 0 + }, + "xdm:directMarketingAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02", + "xdm:errorCount": 0, + "xdm:quality": "Fully-recognized street" + }, + "xdm:directMarketingEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active", + "xdm:errorCount": 0 + }, + "xdm:pushNotificationTokens": [ + { + "xdm:token": "ABC123DEFG", + "xdm:registrationDate": "2017-09-26T15:52:25+00:00", + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 600, + "xdm:viewportWidth": 300 + }, + "xdm:operatingSystem": "iOS", + "xdm:operatingSystemVersion": "11.2.1", + "xdm:connectionType": "mobile" + }, + "xdm:device": { + "xdm:typeId": "TypeIdentifier-111", + "xdm:typeIdService": "deviceAtlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216 + }, + "xdm:application": { + "xdm:id": "Abc123", + "xdm:name": "facebook", + "xdm:version": "153.0" + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/facebook-feed", + "@type": "https://ns.adobe.com/xdm/channel-types/social" + } + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/campaign/profile-snapshot.schema.md b/docs/reference/adobe/experience/campaign/profile-snapshot.schema.md new file mode 100644 index 000000000..641000d23 --- /dev/null +++ b/docs/reference/adobe/experience/campaign/profile-snapshot.schema.md @@ -0,0 +1,223 @@ + +# Adobe Campaign Profile Snapshot Schema + +``` +https://ns.adobe.com/experience/campaign/profile-snapshot +``` + +Adobe Campaign Profile snapshot contains the recipient of the message. This property is primarily used to link the message to a Profile using the `IdentityMap` but it can also be used to freeze some properties of the profile at the time the message was sent. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/campaign/profile-snapshot.schema.json](adobe/experience/campaign/profile-snapshot.schema.json) | +## Schema Hierarchy + +* Adobe Campaign Profile Snapshot `https://ns.adobe.com/experience/campaign/profile-snapshot` + * [Person](../../../datatypes/person.schema.md) `https://ns.adobe.com/xdm/context/person` + * [Direct marketing postal address](../../../datatypes/directmarketing-address.schema.md) `https://ns.adobe.com/xdm/context/directmarketing-address` + * [Direct marketing email address](../../../datatypes/directmarketing-emailaddress.schema.md) `https://ns.adobe.com/xdm/context/directmarketing-emailaddress` + * [Direct marketing phone number](../../../datatypes/directmarketing-phonenumber.schema.md) `https://ns.adobe.com/xdm/context/directmarketing-phonenumber` + + +## Adobe Campaign Profile Snapshot Example +```json +{ + "xdm:person": { + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDayAndMonth": "01-03", + "xdm:gender": "female" + }, + "xdm:directMarketingPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active", + "xdm:errorCount": 0 + }, + "xdm:directMarketingAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02", + "xdm:errorCount": 0, + "xdm:quality": "Fully-recognized street" + }, + "xdm:directMarketingEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active", + "xdm:errorCount": 0 + }, + "xdm:pushNotificationTokens": [ + { + "xdm:token": "ABC123DEFG", + "xdm:registrationDate": "2017-09-26T15:52:25+00:00", + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 600, + "xdm:viewportWidth": 300 + }, + "xdm:operatingSystem": "iOS", + "xdm:operatingSystemVersion": "11.2.1", + "xdm:connectionType": "mobile" + }, + "xdm:device": { + "xdm:typeId": "TypeIdentifier-111", + "xdm:typeIdService": "deviceAtlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216 + }, + "xdm:application": { + "xdm:id": "Abc123", + "xdm:name": "facebook", + "xdm:version": "153.0" + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/facebook-feed", + "@type": "https://ns.adobe.com/xdm/channel-types/social" + } + } + ] +} +``` + +# Adobe Campaign Profile Snapshot Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:directMarketingAddress](#xdmdirectmarketingaddress) | Direct marketing postal address | Optional | Adobe Campaign Profile Snapshot (this schema) | +| [xdm:directMarketingEmail](#xdmdirectmarketingemail) | Direct marketing email address | Optional | Adobe Campaign Profile Snapshot (this schema) | +| [xdm:directMarketingPhone](#xdmdirectmarketingphone) | Direct marketing phone number | Optional | Adobe Campaign Profile Snapshot (this schema) | +| [xdm:person](#xdmperson) | Person | Optional | Adobe Campaign Profile Snapshot (this schema) | +| [xdm:pushNotificationTokens](#xdmpushnotificationtokens) | Push notification token | Optional | Adobe Campaign Profile Snapshot (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:directMarketingAddress +### Direct Marketing Address + +Direct Marketing postal address. + +`xdm:directMarketingAddress` +* is optional +* type: Direct marketing postal address +* defined in this schema + +### xdm:directMarketingAddress Type + + +* [Direct marketing postal address](../../../datatypes/directmarketing-address.schema.md) – `https://ns.adobe.com/xdm/context/directmarketing-address` + + + + + +## xdm:directMarketingEmail +### Direct Marketing Email + +Direct Marketing email address. + +`xdm:directMarketingEmail` +* is optional +* type: Direct marketing email address +* defined in this schema + +### xdm:directMarketingEmail Type + + +* [Direct marketing email address](../../../datatypes/directmarketing-emailaddress.schema.md) – `https://ns.adobe.com/xdm/context/directmarketing-emailaddress` + + + + + +## xdm:directMarketingPhone +### Direct Marketing Phone + +Direct Marketing phone number. + +`xdm:directMarketingPhone` +* is optional +* type: Direct marketing phone number +* defined in this schema + +### xdm:directMarketingPhone Type + + +* [Direct marketing phone number](../../../datatypes/directmarketing-phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/directmarketing-phonenumber` + + + + + +## xdm:person +### Person + +An individual actor, contact, or owner. + +`xdm:person` +* is optional +* type: Person +* defined in this schema + +### xdm:person Type + + +* [Person](../../../datatypes/person.schema.md) – `https://ns.adobe.com/xdm/context/person` + + + + + +## xdm:pushNotificationTokens +### Push Notification Tokens + +Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts. + +`xdm:pushNotificationTokens` +* is optional +* type: Push notification token + +* defined in this schema + +### xdm:pushNotificationTokens Type + + +Array type: Push notification token + +All items must be of the type: +* [Push notification token](../../../datatypes/pushnotificationtoken.schema.md) – `https://ns.adobe.com/xdm/context/pushnotificationtoken` + + + + + + + diff --git a/docs/reference/adobe/experience/consumer-experienceevent.schema.json b/docs/reference/adobe/experience/consumer-experienceevent.schema.json new file mode 100644 index 000000000..2ea6d6349 --- /dev/null +++ b/docs/reference/adobe/experience/consumer-experienceevent.schema.json @@ -0,0 +1,177 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/consumer-experienceevent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Consumer ExperienceEvent Mixin", + "type": "object", + "description": "This mixin groups a set of standard fields to describe the behavior of an individual. This mixin can be used to express behavior of a consumer related to digital content consumption (web, mobile app), online or off-line purchases. The use of this standard represention allows for a single representation for data producers and consumers of consumer behavior in Experience Platform", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/experienceevent-application", + "https://ns.adobe.com/xdm/context/experienceevent-channel", + "https://ns.adobe.com/xdm/context/experienceevent-environment-details", + "https://ns.adobe.com/xdm/context/experienceevent-marketing", + "https://ns.adobe.com/xdm/context/experienceevent-media", + "https://ns.adobe.com/xdm/context/experienceevent-search", + "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership", + "https://ns.adobe.com/xdm/context/experienceevent-technical-details", + "https://ns.adobe.com/xdm/context/experienceevent-web", + "https://ns.adobe.com/xdm/context/experienceevent-commerce" + ], + "definitions": {}, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-application" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-channel" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-marketing" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-media" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-search" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-technical-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-web" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-commerce" + } + ], + "meta:status": "deprecated", + "examples": [ + { + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "id": "68519882713298129995549973016107434638", + "primary": true + } + ], + "AVID": [ + { + "id": "2dfb7d8e00003ba4-056de00000000085", + "primary": false + } + ] + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + }, + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/consumer-experienceevent.schema.md b/docs/reference/adobe/experience/consumer-experienceevent.schema.md new file mode 100644 index 000000000..a7123bac9 --- /dev/null +++ b/docs/reference/adobe/experience/consumer-experienceevent.schema.md @@ -0,0 +1,466 @@ + +# Consumer ExperienceEvent Mixin Schema + +``` +https://ns.adobe.com/experience/consumer-experienceevent +``` + +This mixin groups a set of standard fields to describe the behavior of an individual. This mixin can be used to express behavior of a consumer related to digital content consumption (web, mobile app), online or off-line purchases. The use of this standard represention allows for a single representation for data producers and consumers of consumer behavior in Experience Platform + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Deprecated | No | Forbidden | Permitted | [adobe/experience/consumer-experienceevent.schema.json](adobe/experience/consumer-experienceevent.schema.json) | +## Schema Hierarchy + +* Consumer ExperienceEvent Mixin `https://ns.adobe.com/experience/consumer-experienceevent` + * [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-application` + * [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-channel` + * [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-environment-details` + * [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-marketing` + * [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-media` + * [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-search` + * [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-segmentmembership` + * [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-technical-details` + * [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-web` + * [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-commerce` + + +## Consumer ExperienceEvent Mixin Example +```json +{ + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "id": "68519882713298129995549973016107434638", + "primary": true + } + ], + "AVID": [ + { + "id": "2dfb7d8e00003ba4-056de00000000085", + "primary": false + } + ] + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + }, + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + } +} +``` + +# Consumer ExperienceEvent Mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:application](#xdmapplication) | Application | Optional | [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md#xdmapplication) | +| [xdm:channel](#xdmchannel) | Experience Channel | Optional | [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md#xdmchannel) | +| [xdm:commerce](#xdmcommerce) | Commerce | Optional | [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmcommerce) | +| [xdm:dataSource](#xdmdatasource) | Data Source | Optional | [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmdatasource) | +| [xdm:device](#xdmdevice) | Device | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) | +| [xdm:environment](#xdmenvironment) | Environment | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) | +| [xdm:marketing](#xdmmarketing) | Marketing | Optional | [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md#xdmmarketing) | +| [xdm:media](#xdmmedia) | Media information | Optional | [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md#xdmmedia) | +| [xdm:placeContext](#xdmplacecontext) | Place context | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) | +| [xdm:productListItems](#xdmproductlistitems) | Product list item | Optional | [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmproductlistitems) | +| [xdm:receivedTimestamp](#xdmreceivedtimestamp) | `string` | Optional | [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmreceivedtimestamp) | +| [xdm:search](#xdmsearch) | Search | Optional | [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md#xdmsearch) | +| [xdm:segmentMembership](#xdmsegmentmembership) | `object` | Optional | [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmembership) | +| [xdm:segmentMemberships](#xdmsegmentmemberships) | Segment membership item | Optional | [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) | +| [xdm:web](#xdmweb) | Web information | Optional | [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md#xdmweb) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:application +### Application + +This mixin is used to capture application information related to an ExperienceEvent, including the name of the application, app version, installs, launches, crashes, and closures. It could be either the application targeted by the event like the send of a push notification or the application originating the event such as a click, or a login. + +`xdm:application` +* is optional +* type: Application +* defined in [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md#xdmapplication) + +### xdm:application Type + + +* [Application](../../datatypes/application.schema.md) – `https://ns.adobe.com/xdm/context/application` + + + + + +## xdm:channel +### Experience channel + +Experience channel related to the ExperienceEvent. + +`xdm:channel` +* is optional +* type: Experience Channel +* defined in [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md#xdmchannel) + +### xdm:channel Type + + +* [Experience Channel](../../datatypes/channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel` + + + + + +## xdm:commerce +### Commerce + +Commerce specific data related to this event. + +`xdm:commerce` +* is optional +* type: Commerce +* defined in [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmcommerce) + +### xdm:commerce Type + + +* [Commerce](../../datatypes/commerce.schema.md) – `https://ns.adobe.com/xdm/context/commerce` + + + + + +## xdm:dataSource +### Data source + +Globally unique identification of a data source. + +`xdm:dataSource` +* is optional +* type: Data Source +* defined in [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmdatasource) + +### xdm:dataSource Type + + +* [Data Source](../../datatypes/data/datasource.schema.md) – `https://ns.adobe.com/xdm/data/datasource` + + + + + +## xdm:device +### Device + +An identified device, application or device browser instance that is trackable across sessions, normally by cookies. + +`xdm:device` +* is optional +* type: Device +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) + +### xdm:device Type + + +* [Device](../../datatypes/device.schema.md) – `https://ns.adobe.com/xdm/context/device` + + + + + +## xdm:environment +### Environment + +Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions. + +`xdm:environment` +* is optional +* type: Environment +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) + +### xdm:environment Type + + +* [Environment](../../datatypes/environment.schema.md) – `https://ns.adobe.com/xdm/context/environment` + + + + + +## xdm:marketing +### Marketing + +The information related to marketing activities that are active with the touchpoint. + +`xdm:marketing` +* is optional +* type: Marketing +* defined in [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md#xdmmarketing) + +### xdm:marketing Type + + +* [Marketing](../../datatypes/marketing.schema.md) – `https://ns.adobe.com/xdm/context/marketing` + + + + + +## xdm:media +### Media + +Media activity information related to the experience event. + +`xdm:media` +* is optional +* type: Media information +* defined in [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md#xdmmedia) + +### xdm:media Type + + +* [Media information](../../datatypes/media.schema.md) – `https://ns.adobe.com/xdm/context/media` + + + + + +## xdm:placeContext +### Place context + +The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, and working hours. + +`xdm:placeContext` +* is optional +* type: Place context +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) + +### xdm:placeContext Type + + +* [Place context](../../datatypes/placecontext.schema.md) – `https://ns.adobe.com/xdm/context/placecontext` + + + + + +## xdm:productListItems +### Product list items + +A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record. + +`xdm:productListItems` +* is optional +* type: Product list item + +* defined in [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmproductlistitems) + +### xdm:productListItems Type + + +Array type: Product list item + +All items must be of the type: +* [Product list item](../../datatypes/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem` + + + + + + + + +## xdm:receivedTimestamp +### Received time stamp + +The time at which this interaction was received by a server. + +`xdm:receivedTimestamp` +* is optional +* type: `string` +* defined in [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmreceivedtimestamp) + +### xdm:receivedTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:search +### Search + +The information related to web or mobile search. + +`xdm:search` +* is optional +* type: Search +* defined in [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md#xdmsearch) + +### xdm:search Type + + +* [Search](../../datatypes/search.schema.md) – `https://ns.adobe.com/xdm/context/search` + + + + + +## xdm:segmentMembership +### Segment Membership Map + +`xdm:segmentMembership` +* is optional +* type: `object` +* defined in [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmembership) + +### xdm:segmentMembership Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:segmentMemberships +### Segment Memberships + +The segments associated with this ExperienceEvent. Deprecated, use `xdm:segmentMembership` instead. + +`xdm:segmentMemberships` +* is optional +* type: Segment membership item + +* defined in [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) + +### xdm:segmentMemberships Type + + +Array type: Segment membership item + +All items must be of the type: +* [Segment membership item](../../datatypes/segmentmembershipitem.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembershipitem` + + + + + + + + +## xdm:web +### Web + +The information related to web page and link of the ExperienceEvent. + +`xdm:web` +* is optional +* type: Web information +* defined in [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md#xdmweb) + +### xdm:web Type + + +* [Web information](../../datatypes/webinfo.schema.md) – `https://ns.adobe.com/xdm/context/webinfo` + + + + diff --git a/docs/reference/adobe/experience/decisioning/activity-detail.schema.json b/docs/reference/adobe/experience/decisioning/activity-detail.schema.json new file mode 100644 index 000000000..4ef34cec9 --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/activity-detail.schema.json @@ -0,0 +1,76 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/decisioning/activity-detail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Decision Activity Snapshot", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "Snapshot of the properties of the decision activity. A decision activity is an entity that controls a decisioning process. Decisions are made in the context of an activity. See definition of decision activty for more details.", + "definitions": { + "activity-detail-datatype": { + "properties": { + "xdm:id": { + "title": "Activity Identifier", + "type": "string", + "format": "uri-reference", + "description": "A unique, immutable identifier for the decision activity." + }, + "repo:etag": { + "title": "Activity ETag", + "type": "string", + "description": "The revision that the decision activity object was at when the snapshot was taken." + }, + "xdm:name": { + "title": "Activity Name", + "type": "string", + "description": "Activity name. The name is displayed in various user interfaces." + }, + "xdm:startTime": { + "title": "Activity Start Date and Time", + "type": "string", + "format": "date-time", + "description": "Activity start date and end time. Property has the semantic of schema.org's 'startTime' property defined on http://schema.org/Action" + }, + "xdm:endTime": { + "title": "Activity End Date and Time", + "type": "string", + "format": "date-time", + "description": "Activity end date and end time. Property has the semantic of schema.org's 'endTime' property defined on http://schema.org/Action" + }, + "xdm:fallback": { + "title": "Fallback Option", + "type": "string", + "format": "uri-reference", + "description": "The reference to a fallback option that is used when decisioning in the context of this activity does not qualify any of the regular options (this typically happens when hard constraints are applied). The value is the URI (@id) of the fallback option that is referenced." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/activity-detail-datatype" + }, + { + "required": [ + "xdm:id" + ] + } + ], + "examples": [ + { + "xdm:id": "xcore:offer-activity:ebc48132c26ccfc", + "xdm:name": "Tutorial videos to watch", + "xdm:startTime": "2018-10-13T05:59:18.914Z", + "xdm:endTime": "2018-12-27T05:59:18.914Z" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/decisioning/activity-detail.schema.md b/docs/reference/adobe/experience/decisioning/activity-detail.schema.md new file mode 100644 index 000000000..b863a1ec6 --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/activity-detail.schema.md @@ -0,0 +1,163 @@ + +# Decision Activity Snapshot Schema + +``` +https://ns.adobe.com/experience/decisioning/activity-detail +``` + +Snapshot of the properties of the decision activity. A decision activity is an entity that controls a decisioning process. Decisions are made in the context of an activity. See definition of decision activty for more details. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/decisioning/activity-detail.schema.json](adobe/experience/decisioning/activity-detail.schema.json) | +## Schema Hierarchy + +* Decision Activity Snapshot `https://ns.adobe.com/experience/decisioning/activity-detail` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Decision Activity Snapshot Example +```json +{ + "xdm:id": "xcore:offer-activity:ebc48132c26ccfc", + "xdm:name": "Tutorial videos to watch", + "xdm:startTime": "2018-10-13T05:59:18.914Z", + "xdm:endTime": "2018-12-27T05:59:18.914Z" +} +``` + +# Decision Activity Snapshot Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [repo:etag](#repoetag) | `string` | Optional | Decision Activity Snapshot (this schema) | +| [xdm:endTime](#xdmendtime) | `string` | Optional | Decision Activity Snapshot (this schema) | +| [xdm:fallback](#xdmfallback) | `string` | Optional | Decision Activity Snapshot (this schema) | +| [xdm:id](#xdmid) | `string` | **Required** | Decision Activity Snapshot (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | Decision Activity Snapshot (this schema) | +| [xdm:startTime](#xdmstarttime) | `string` | Optional | Decision Activity Snapshot (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## repo:etag +### Activity ETag + +The revision that the decision activity object was at when the snapshot was taken. + +`repo:etag` +* is optional +* type: `string` +* defined in this schema + +### repo:etag Type + + +`string` + + + + + + +## xdm:endTime +### Activity End Date and Time + +Activity end date and end time. Property has the semantic of schema.org's 'endTime' property defined on http://schema.org/Action + +`xdm:endTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:endTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:fallback +### Fallback Option + +The reference to a fallback option that is used when decisioning in the context of this activity does not qualify any of the regular options (this typically happens when hard constraints are applied). The value is the URI (@id) of the fallback option that is referenced. + +`xdm:fallback` +* is optional +* type: `string` +* defined in this schema + +### xdm:fallback Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:id +### Activity Identifier + +A unique, immutable identifier for the decision activity. + +`xdm:id` +* is **required** +* type: `string` +* defined in this schema + +### xdm:id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:name +### Activity Name + +Activity name. The name is displayed in various user interfaces. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:startTime +### Activity Start Date and Time + +Activity start date and end time. Property has the semantic of schema.org's 'startTime' property defined on http://schema.org/Action + +`xdm:startTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:startTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + diff --git a/docs/reference/adobe/experience/decisioning/decisionevent-all.schema.json b/docs/reference/adobe/experience/decisioning/decisionevent-all.schema.json new file mode 100644 index 000000000..b258aafa5 --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/decisionevent-all.schema.json @@ -0,0 +1,58 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/decisioning/decisionevent-all", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Decision Reporting Dimensions", + "type": "object", + "meta:abstract": true, + "meta:extensible": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/experience/decisioning/decisionevent" + ], + "description": "Mixin for Decision Events that adds dimensions for rollup by organization, container, batch job and request.", + "definitions": { + "decisioning-mixin": { + "properties": { + "https://ns.adobe.com/adobecloudplatform/ims/organizationID": { + "title": "IMS Organization Identifier", + "type": "string", + "description": "An identity associated with the organization that maintains the library of business objects and rules for this decision." + }, + "https://ns.adobe.com/experience/decisioning/containerID": { + "title": "Container Identifier", + "type": "string", + "description": "An identity associated with the library of business objects and rules for this decision." + }, + "https://ns.adobe.com/experience/decisioning/batchID": { + "title": "Batch Identifier", + "type": "string", + "description": "A workflow identity associated with the decision event, if the request was made in batch mode. This property will be absent if the decision leading to this event was made individually for a single profile identity." + }, + "https://ns.adobe.com/experience/decisioning/decisionRequestID": { + "title": "Request Identifier", + "type": "string", + "description": "An optional identifier that was provided by the client, unique per profile and request. It is used to track the decision request in the dataset of propositions. If a request was processed more than once for any reason there will be more than one event with the same decision request identifier in the dataset and those events can be de-duplicated." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/decisioning-mixin" + } + ], + "examples": [ + { + "https://ns.adobe.com/adobecloudplatform/ims/organizationID": "0D8E32C65A8A91520A494008@AdobeOrg", + "https://ns.adobe.com/experience/decisioning/containerID": "c75afa32-371f-4895-8f43-b853dd9fe740" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/decisioning/decisionevent-all.schema.md b/docs/reference/adobe/experience/decisioning/decisionevent-all.schema.md new file mode 100644 index 000000000..df322c832 --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/decisionevent-all.schema.md @@ -0,0 +1,115 @@ + +# Decision Reporting Dimensions Schema + +``` +https://ns.adobe.com/experience/decisioning/decisionevent-all +``` + +Mixin for Decision Events that adds dimensions for rollup by organization, container, batch job and request. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/decisioning/decisionevent-all.schema.json](adobe/experience/decisioning/decisionevent-all.schema.json) | +## Schema Hierarchy + +* Decision Reporting Dimensions `https://ns.adobe.com/experience/decisioning/decisionevent-all` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Decision Reporting Dimensions Example +```json +{ + "https://ns.adobe.com/adobecloudplatform/ims/organizationID": "0D8E32C65A8A91520A494008@AdobeOrg", + "https://ns.adobe.com/experience/decisioning/containerID": "c75afa32-371f-4895-8f43-b853dd9fe740" +} +``` + +# Decision Reporting Dimensions Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/adobecloudplatform/ims/organizationID](#httpsnsadobecomadobecloudplatformimsorganizationid) | `string` | Optional | Decision Reporting Dimensions (this schema) | +| [https://ns.adobe.com/experience/decisioning/batchID](#httpsnsadobecomexperiencedecisioningbatchid) | `string` | Optional | Decision Reporting Dimensions (this schema) | +| [https://ns.adobe.com/experience/decisioning/containerID](#httpsnsadobecomexperiencedecisioningcontainerid) | `string` | Optional | Decision Reporting Dimensions (this schema) | +| [https://ns.adobe.com/experience/decisioning/decisionRequestID](#httpsnsadobecomexperiencedecisioningdecisionrequestid) | `string` | Optional | Decision Reporting Dimensions (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/adobecloudplatform/ims/organizationID +### IMS Organization Identifier + +An identity associated with the organization that maintains the library of business objects and rules for this decision. + +`https://ns.adobe.com/adobecloudplatform/ims/organizationID` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/adobecloudplatform/ims/organizationID Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/decisioning/batchID +### Batch Identifier + +A workflow identity associated with the decision event, if the request was made in batch mode. This property will be absent if the decision leading to this event was made individually for a single profile identity. + +`https://ns.adobe.com/experience/decisioning/batchID` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/decisioning/batchID Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/decisioning/containerID +### Container Identifier + +An identity associated with the library of business objects and rules for this decision. + +`https://ns.adobe.com/experience/decisioning/containerID` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/decisioning/containerID Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/decisioning/decisionRequestID +### Request Identifier + +An optional identifier that was provided by the client, unique per profile and request. It is used to track the decision request in the dataset of propositions. If a request was processed more than once for any reason there will be more than one event with the same decision request identifier in the dataset and those events can be de-duplicated. + +`https://ns.adobe.com/experience/decisioning/decisionRequestID` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/decisioning/decisionRequestID Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/decisioning/decisionevent.schema.json b/docs/reference/adobe/experience/decisioning/decisionevent.schema.json new file mode 100644 index 000000000..e87452f4c --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/decisionevent.schema.json @@ -0,0 +1,122 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/decisioning/decisionevent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Decision Event", + "type": "object", + "meta:abstract": true, + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/time-series", + "https://ns.adobe.com/xdm/context/identitymap", + "https://ns.adobe.com/experience/decisioning/proposition", + "https://ns.adobe.com/experience/decisioning/proposition-details" + ], + "description": "A decision event is used to capture observations about the outcome and context of a decision activity. The decision event captures information about how the decision made, when it was occurring, what options were proposed (chosen) and what contextual state existed that either influenced the decision or could be observed during the decision process. The decision event also captures the proposition ID, a globally unique identifier that can be used to correlate the decision to other events. DecisionEvents are not only relatable to Experience Events that impacted a decision but also to ExperienceEvents that are a direct response to a proposition. It is the expectation that applications reference the proposition ID in every experience event that was influenced by the propositions. A user profile's proposition-response history is maintained with these proposition IDs.", + "definitions": { + "decisionevent": { + "properties": {} + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/time-series" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "https://ns.adobe.com/experience/decisioning/proposition" + }, + { + "$ref": "https://ns.adobe.com/experience/decisioning/proposition-details" + }, + { + "$ref": "#/definitions/decisionevent" + }, + { + "required": [ + "@id", + "xdm:timestamp", + "https://ns.adobe.com/experience/decisioning/propositionID" + ] + } + ], + "examples": [ + { + "@id": "https://data.adobe.io/entities/propositions/3cc33a7e-13ca-4b19-b25d-c816eff9a70a", + "xdm:timestamp": "2019-01-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" + } + ] + }, + "xdm:device": { + "xdm:typeID": "IMac", + "xdm:typeIDService": "https://ns.adobe.com/xdm/external/adobecampaign", + "xdm:type": "desktop", + "xdm:manufacturer": "Apple" + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageView": { + "xdm:URL": "https://www.example.com" + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.examplereferrer.com/", + "xdm:domain": "examplereferrer.com" + } + }, + "https://ns.adobe.com/experience/decisioning/propositionID": "3cc33a7e-13ca-4b19-b25d-c816eff9a70a", + "https://ns.adobe.com/experience/decisioning/propositionDetails": [ + { + "xdm:activity": { + "xdm:id": "xcore:offer-activity:ebc48132c26ccfc" + }, + "xdm:selections": [ + { + "xdm:id": "xcore:personalized-offer:e526a1503bf29e9", + "https://ns.adobe.com/experience/decisioning/propositionsTotal": { + "xdm:value": 948 + }, + "https://ns.adobe.com/experience/decisioning/propositionsProfile": { + "xdm:value": 2 + } + } + ] + }, + { + "xdm:activity": { + "xdm:id": "xcore:offer-activity:f203512e02542b5" + }, + "xdm:fallback": { + "xdm:id": "xcore:fallback-offer:e91ce7243fd8c2a" + } + } + ], + "https://ns.adobe.com/adobecloudplatform/ims/organizationID": "0D8E32C65A8A91520A494008@AdobeOrg", + "https://ns.adobe.com/experience/decisioning/containerID": "c75afa32-371f-4895-8f43-b853dd9fe740" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/decisioning/decisionevent.schema.md b/docs/reference/adobe/experience/decisioning/decisionevent.schema.md new file mode 100644 index 000000000..af9fb5b21 --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/decisionevent.schema.md @@ -0,0 +1,282 @@ + +# XDM Decision Event Schema + +``` +https://ns.adobe.com/experience/decisioning/decisionevent +``` + +A decision event is used to capture observations about the outcome and context of a decision activity. The decision event captures information about how the decision made, when it was occurring, what options were proposed (chosen) and what contextual state existed that either influenced the decision or could be observed during the decision process. The decision event also captures the proposition ID, a globally unique identifier that can be used to correlate the decision to other events. DecisionEvents are not only relatable to Experience Events that impacted a decision but also to ExperienceEvents that are a direct response to a proposition. It is the expectation that applications reference the proposition ID in every experience event that was influenced by the propositions. A user profile's proposition-response history is maintained with these proposition IDs. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/decisioning/decisionevent.schema.json](adobe/experience/decisioning/decisionevent.schema.json) | +## Schema Hierarchy + +* XDM Decision Event `https://ns.adobe.com/experience/decisioning/decisionevent` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Time-series Schema](../../../behaviors/time-series.schema.md) `https://ns.adobe.com/xdm/data/time-series` + * [IdentityMap](../../../mixins/shared/identitymap.schema.md) `https://ns.adobe.com/xdm/context/identitymap` + * [Decision Proposition Reference](proposition.schema.md) `https://ns.adobe.com/experience/decisioning/proposition` + * [Decision Proposition Details](proposition-details.schema.md) `https://ns.adobe.com/experience/decisioning/proposition-details` + + +## XDM Decision Event Example +```json +{ + "@id": "https://data.adobe.io/entities/propositions/3cc33a7e-13ca-4b19-b25d-c816eff9a70a", + "xdm:timestamp": "2019-01-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" + } + ] + }, + "xdm:device": { + "xdm:typeID": "IMac", + "xdm:typeIDService": "https://ns.adobe.com/xdm/external/adobecampaign", + "xdm:type": "desktop", + "xdm:manufacturer": "Apple" + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageView": { + "xdm:URL": "https://www.example.com" + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.examplereferrer.com/", + "xdm:domain": "examplereferrer.com" + } + }, + "https://ns.adobe.com/experience/decisioning/propositionID": "3cc33a7e-13ca-4b19-b25d-c816eff9a70a", + "https://ns.adobe.com/experience/decisioning/propositionDetails": [ + { + "xdm:activity": { + "xdm:id": "xcore:offer-activity:ebc48132c26ccfc" + }, + "xdm:selections": [ + { + "xdm:id": "xcore:personalized-offer:e526a1503bf29e9", + "https://ns.adobe.com/experience/decisioning/propositionsTotal": { + "xdm:value": 948 + }, + "https://ns.adobe.com/experience/decisioning/propositionsProfile": { + "xdm:value": 2 + } + } + ] + }, + { + "xdm:activity": { + "xdm:id": "xcore:offer-activity:f203512e02542b5" + }, + "xdm:fallback": { + "xdm:id": "xcore:fallback-offer:e91ce7243fd8c2a" + } + } + ], + "https://ns.adobe.com/adobecloudplatform/ims/organizationID": "0D8E32C65A8A91520A494008@AdobeOrg", + "https://ns.adobe.com/experience/decisioning/containerID": "c75afa32-371f-4895-8f43-b853dd9fe740" +} +``` + +# XDM Decision Event Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Time-series Schema](../../../behaviors/time-series.schema.md#id) | +| [https://ns.adobe.com/experience/decisioning/propositionContentKey](#httpsnsadobecomexperiencedecisioningpropositioncontentkey) | `string` | Optional | [Decision Proposition Details](proposition-details.schema.md#httpsnsadobecomexperiencedecisioningpropositioncontentkey) | +| [https://ns.adobe.com/experience/decisioning/propositionDetails](#httpsnsadobecomexperiencedecisioningpropositiondetails) | Decision Proposition Detail | Optional | [Decision Proposition Details](proposition-details.schema.md#httpsnsadobecomexperiencedecisioningpropositiondetails) | +| [https://ns.adobe.com/experience/decisioning/propositionID](#httpsnsadobecomexperiencedecisioningpropositionid) | `string` | **Required** | [Decision Proposition Reference](proposition.schema.md#httpsnsadobecomexperiencedecisioningpropositionid) | +| [xdm:eventType](#xdmeventtype) | `string` | Optional | [Time-series Schema](../../../behaviors/time-series.schema.md#xdmeventtype) | +| [xdm:identityMap](#xdmidentitymap) | `object` | Optional | [IdentityMap](../../../mixins/shared/identitymap.schema.md#xdmidentitymap) | +| [xdm:timestamp](#xdmtimestamp) | `string` | **Required** | [Time-series Schema](../../../behaviors/time-series.schema.md#xdmtimestamp) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the time-series event. + +`@id` +* is **required** +* type: `string` +* defined in [Time-series Schema](../../../behaviors/time-series.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## https://ns.adobe.com/experience/decisioning/propositionContentKey +### Proposition Content Key + +Digest or unique hash key (generated automatically) for the proposition content. Recipients of propositions with the same value will receive the same content selections in the targeted placements. Moreover, propositions with the same value to the same user mean that the content of the propositions has not changed. Propositions with different digests or hash values indicate that the decision selections are different. Note that adding a placement to the decision always change digest value. + +`https://ns.adobe.com/experience/decisioning/propositionContentKey` +* is optional +* type: `string` +* defined in [Decision Proposition Details](proposition-details.schema.md#httpsnsadobecomexperiencedecisioningpropositioncontentkey) + +### https://ns.adobe.com/experience/decisioning/propositionContentKey Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/decisioning/propositionDetails +### Proposition Details + +Details about the results of the decision. An array providing the output of a single decision event, one proposition per activity parameter in the request. + +`https://ns.adobe.com/experience/decisioning/propositionDetails` +* is optional +* type: Decision Proposition Detail + +* defined in [Decision Proposition Details](proposition-details.schema.md#httpsnsadobecomexperiencedecisioningpropositiondetails) + +### https://ns.adobe.com/experience/decisioning/propositionDetails Type + + +Array type: Decision Proposition Detail + +All items must be of the type: +* [Decision Proposition Detail](proposition-detail.schema.md) – `https://ns.adobe.com/experience/decisioning/proposition-detail` + + + + + + + + +## https://ns.adobe.com/experience/decisioning/propositionID +### Proposition Identifier + +A unique identifier for the proposition event referenced by an "XDM ExperienceEvent". It is the expectation that applications use this "propositionID" in every experience event that was influenced by the set of propositions. An individual profile's proposition-response history is maintained with these proposition identifiers. + +`https://ns.adobe.com/experience/decisioning/propositionID` +* is **required** +* type: `string` +* defined in [Decision Proposition Reference](proposition.schema.md#httpsnsadobecomexperiencedecisioningpropositionid) + +### https://ns.adobe.com/experience/decisioning/propositionID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:eventType +### Event Type + +The primary event type for this time-series record. + +`xdm:eventType` +* is optional +* type: `string` +* defined in [Time-series Schema](../../../behaviors/time-series.schema.md#xdmeventtype) + +### xdm:eventType Type + + +`string` + + + +### xdm:eventType Known Values +| Value | Description | +|-------|-------------| +| `advertising.completes` | Indicates if a timed media asset was watched to completion - this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead. | +| `advertising.timePlayed` | Describes the amount of time spent by a user on a specific timed media asset. | +| `advertising.federated` | Indicates if an experience event was created through data federation (data sharing between customers). | +| `advertising.clicks` | Click(s) actions on an advertisement. | +| `advertising.conversions` | A customer pre-defined action(s) which triggers an event for performance evaluation. | +| `advertising.firstQuartiles` | A digital video ad has played through 25% of its duration at normal speed. | +| `advertising.impressions` | Impression(s) of an advertisement to an end-user with the potential of being viewed. | +| `advertising.midpoints` | A digital video ad has played through 50% of its duration at normal speed. | +| `advertising.starts` | A digital video ad has started playing. | +| `advertising.thirdQuartiles` | A digital video ad has played through 75% of its duration at normal speed. | +| `web.webpagedetails.pageViews` | View(s) of a webpage has occurred. | +| `web.webinteraction.linkClicks` | Click of a web-link has occurred. | +| `commerce.checkouts` | An action during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order. | +| `commerce.productListAdds` | Addition of a product to the product list. Example a product is added to a shopping cart. | +| `commerce.productListOpens` | Initializations of a new product list. Example a shopping cart is created. | +| `commerce.productListRemovals` | Removal(s) of a product entry from a product list. Example a product is removed from a shopping cart. | +| `commerce.productListReopens` | A product list that was no longer accessible(abandoned) has been re-activated by the user. Example via a re-marketing activity. | +| `commerce.productListViews` | View(s) of a product-list has occurred. | +| `commerce.productViews` | View(s) of a product have occurred. | +| `commerce.purchases` | An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced. | +| `commerce.saveForLaters` | Product list is saved for future use. Example a product wish list. | +| `delivery.feedback` | Feedback events for a delivery. Example feedback events for an email delivery. | + + + + +## xdm:identityMap + + +`xdm:identityMap` +* is optional +* type: `object` +* defined in [IdentityMap](../../../mixins/shared/identitymap.schema.md#xdmidentitymap) + +### xdm:identityMap Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:timestamp +### Timestamp + +The time when an event or observation occurred. + +`xdm:timestamp` +* is **required** +* type: `string` +* defined in [Time-series Schema](../../../behaviors/time-series.schema.md#xdmtimestamp) + +### xdm:timestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + diff --git a/docs/reference/adobe/experience/decisioning/option-detail.schema.json b/docs/reference/adobe/experience/decisioning/option-detail.schema.json new file mode 100644 index 000000000..874d2f935 --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/option-detail.schema.json @@ -0,0 +1,95 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/decisioning/option-detail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Decision Option Detail", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "Detail about the entity that represents one of the possible selections or choices for a decision. When referenced in propositions, options are enriched with the observed metrics that applied to them, i.e. they are measurable.", + "definitions": { + "option-detail-datatype": { + "properties": { + "xdm:id": { + "title": "Decision Option Identifier", + "type": "string", + "format": "uri-reference", + "description": "A unique identifier for the decision option." + }, + "repo:etag": { + "title": "Decision Option ETag", + "type": "string", + "description": "The revision that the decision option object was at when the snapshot was taken." + }, + "xdm:name": { + "type": "string", + "title": "Decision Option Name", + "description": "Option name. The name is displayed in various user interfaces." + }, + "xdm:tags": { + "type": "array", + "title": "Decision Option Tags", + "description": "The set of tags associated with this option. The tags are used indicate catetoegies (dimensions) that the option belonged to at the time the proposition was made.", + "items": { + "type": "string", + "format": "uri-reference", + "description": "An identifier of a Tag object. The value is the @id of the Tag that is referenced. See Tag schema https://ns.adobe.com/experience/decisioning/tag" + } + }, + "xdm:characteristics": { + "title": "Decision Option Characteristics", + "description": "Additional properties or attributes belonging to this particular decision option. Different instances can have different characteristics (keys in the map). The characteristics are name value pairs used to distinguish one decision option from others. Characteristics are used as values in content that represents this decision option and as features to analyze and optimize the performance of an option. When every instance has the same attribute or property, that aspect should be modeled as an extension schema that derives from decision option detail.", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "type": "string", + "description": "Value of the property." + } + }, + "https://ns.adobe.com/experience/decisioning/propositionsTotal": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The total number a particular option was proposed so far across all profiles." + }, + "https://ns.adobe.com/experience/decisioning/propositionsProfile": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of times a particular option was proposed so far to a particular profile. When this metric is present the record or time-series entity must include an IdentityMap the profile." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/option-detail-datatype" + }, + { + "required": [ + "xdm:id" + ] + } + ], + "examples": [ + { + "xdm:id": "xcore:personalized-offer:e91ee850a0bb7d9", + "xdm:name": "Introduction to machine learning", + "xdm:characteristics": { + "duration": "14", + "level": "intermediate", + "format": "Syllable" + }, + "https://ns.adobe.com/experience/decisioning/propositionsTotal": { + "xdm:value": 4948 + }, + "https://ns.adobe.com/experience/decisioning/propositionsProfile": { + "xdm:value": 2 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/decisioning/option-detail.schema.md b/docs/reference/adobe/experience/decisioning/option-detail.schema.md new file mode 100644 index 000000000..a5e4053cb --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/option-detail.schema.md @@ -0,0 +1,201 @@ + +# Decision Option Detail Schema + +``` +https://ns.adobe.com/experience/decisioning/option-detail +``` + +Detail about the entity that represents one of the possible selections or choices for a decision. When referenced in propositions, options are enriched with the observed metrics that applied to them, i.e. they are measurable. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/decisioning/option-detail.schema.json](adobe/experience/decisioning/option-detail.schema.json) | +## Schema Hierarchy + +* Decision Option Detail `https://ns.adobe.com/experience/decisioning/option-detail` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Measure](../../../datatypes/data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## Decision Option Detail Example +```json +{ + "xdm:id": "xcore:personalized-offer:e91ee850a0bb7d9", + "xdm:name": "Introduction to machine learning", + "xdm:characteristics": { + "duration": "14", + "level": "intermediate", + "format": "Syllable" + }, + "https://ns.adobe.com/experience/decisioning/propositionsTotal": { + "xdm:value": 4948 + }, + "https://ns.adobe.com/experience/decisioning/propositionsProfile": { + "xdm:value": 2 + } +} +``` + +# Decision Option Detail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/decisioning/propositionsProfile](#httpsnsadobecomexperiencedecisioningpropositionsprofile) | Measure | Optional | Decision Option Detail (this schema) | +| [https://ns.adobe.com/experience/decisioning/propositionsTotal](#httpsnsadobecomexperiencedecisioningpropositionstotal) | Measure | Optional | Decision Option Detail (this schema) | +| [repo:etag](#repoetag) | `string` | Optional | Decision Option Detail (this schema) | +| [xdm:characteristics](#xdmcharacteristics) | `object` | Optional | Decision Option Detail (this schema) | +| [xdm:id](#xdmid) | `string` | **Required** | Decision Option Detail (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | Decision Option Detail (this schema) | +| [xdm:tags](#xdmtags) | `string[]` | Optional | Decision Option Detail (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/decisioning/propositionsProfile + +The number of times a particular option was proposed so far to a particular profile. When this metric is present the record or time-series entity must include an IdentityMap the profile. + +`https://ns.adobe.com/experience/decisioning/propositionsProfile` +* is optional +* type: Measure +* defined in this schema + +### https://ns.adobe.com/experience/decisioning/propositionsProfile Type + + +* [Measure](../../../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## https://ns.adobe.com/experience/decisioning/propositionsTotal + +The total number a particular option was proposed so far across all profiles. + +`https://ns.adobe.com/experience/decisioning/propositionsTotal` +* is optional +* type: Measure +* defined in this schema + +### https://ns.adobe.com/experience/decisioning/propositionsTotal Type + + +* [Measure](../../../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## repo:etag +### Decision Option ETag + +The revision that the decision option object was at when the snapshot was taken. + +`repo:etag` +* is optional +* type: `string` +* defined in this schema + +### repo:etag Type + + +`string` + + + + + + +## xdm:characteristics +### Decision Option Characteristics + +Additional properties or attributes belonging to this particular decision option. Different instances can have different characteristics (keys in the map). The characteristics are name value pairs used to distinguish one decision option from others. Characteristics are used as values in content that represents this decision option and as features to analyze and optimize the performance of an option. When every instance has the same attribute or property, that aspect should be modeled as an extension schema that derives from decision option detail. + +`xdm:characteristics` +* is optional +* type: `object` +* defined in this schema + +### xdm:characteristics Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:id +### Decision Option Identifier + +A unique identifier for the decision option. + +`xdm:id` +* is **required** +* type: `string` +* defined in this schema + +### xdm:id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:name +### Decision Option Name + +Option name. The name is displayed in various user interfaces. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:tags +### Decision Option Tags + +The set of tags associated with this option. The tags are used indicate catetoegies (dimensions) that the option belonged to at the time the proposition was made. + +`xdm:tags` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:tags Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + +An identifier of a Tag object. The value is the @id of the Tag that is referenced. See Tag schema https://ns.adobe.com/experience/decisioning/tag + + + + + + diff --git a/docs/reference/adobe/experience/decisioning/placement-detail.schema.json b/docs/reference/adobe/experience/decisioning/placement-detail.schema.json new file mode 100644 index 000000000..e0e32208e --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/placement-detail.schema.json @@ -0,0 +1,53 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/decisioning/placement-detail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Decision Placement Detail", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "Detail about the entity defining and controlling the decisioning process. Decisions are made in the context of a placement. At any given time, the best option is re-evaluated, or ranked, based on the most current set of context variables, rules and constraints applicable for this placement.", + "definitions": { + "placement-detail-datatype": { + "properties": { + "xdm:id": { + "title": "Placement Identifier", + "type": "string", + "format": "uri-reference", + "description": "A unique identifier for the decision placement." + }, + "repo:etag": { + "title": "Placement ETag", + "type": "string", + "description": "The revision that the placement object was at when the snapshot was taken." + }, + "xdm:name": { + "title": "Placement Name", + "type": "string", + "description": "Placement name. The name is displayed in various user interfaces." + }, + "xdm:channelID": { + "title": "Placement's Channel Identifier", + "type": "string", + "format": "uri-reference", + "description": "The channel in which proposition was made. The value is a valid Channel URI. See 'https://ns.adobe.com/xdm/channels/channel'" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/placement-detail-datatype" + }, + { + "required": [ + "xdm:id" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/decisioning/placement-detail.schema.md b/docs/reference/adobe/experience/decisioning/placement-detail.schema.md new file mode 100644 index 000000000..b6ea0613b --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/placement-detail.schema.md @@ -0,0 +1,104 @@ + +# Decision Placement Detail Schema + +``` +https://ns.adobe.com/experience/decisioning/placement-detail +``` + +Detail about the entity defining and controlling the decisioning process. Decisions are made in the context of a placement. At any given time, the best option is re-evaluated, or ranked, based on the most current set of context variables, rules and constraints applicable for this placement. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/decisioning/placement-detail.schema.json](adobe/experience/decisioning/placement-detail.schema.json) | + +# Decision Placement Detail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [repo:etag](#repoetag) | `string` | Optional | Decision Placement Detail (this schema) | +| [xdm:channelID](#xdmchannelid) | `string` | Optional | Decision Placement Detail (this schema) | +| [xdm:id](#xdmid) | `string` | **Required** | Decision Placement Detail (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | Decision Placement Detail (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## repo:etag +### Placement ETag + +The revision that the placement object was at when the snapshot was taken. + +`repo:etag` +* is optional +* type: `string` +* defined in this schema + +### repo:etag Type + + +`string` + + + + + + +## xdm:channelID +### Placement's Channel Identifier + +The channel in which proposition was made. The value is a valid Channel URI. See 'https://ns.adobe.com/xdm/channels/channel' + +`xdm:channelID` +* is optional +* type: `string` +* defined in this schema + +### xdm:channelID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:id +### Placement Identifier + +A unique identifier for the decision placement. + +`xdm:id` +* is **required** +* type: `string` +* defined in this schema + +### xdm:id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:name +### Placement Name + +Placement name. The name is displayed in various user interfaces. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/decisioning/proposition-detail.schema.json b/docs/reference/adobe/experience/decisioning/proposition-detail.schema.json new file mode 100644 index 000000000..d789e7f67 --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/proposition-detail.schema.json @@ -0,0 +1,117 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/decisioning/proposition-detail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Decision Proposition Detail", + "type": "object", + "meta:abstract": true, + "meta:extensible": true, + "description": "A decision proposition detail is used to capture the output of a decisioning activity. Propositions are enriched with the observed metrics that applied to the selected options at the time the decision was made.", + "definitions": { + "proposition-detail-datatype": { + "properties": { + "xdm:activity": { + "title": "Decision Activity Snapshot", + "description": "Snapshot of the activity for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the decision activity.", + "$ref": "https://ns.adobe.com/experience/decisioning/activity-detail" + }, + "xdm:channel": { + "title": "DEPRECATED - Channel", + "type": "string", + "format": "uri-reference", + "meta:status": "deprecated", + "description": "DEPRECATED, use placement.channel instead. The channel in which proposition was made. The value is a valid Channel URI. See 'https://ns.adobe.com/xdm/channels/channel'" + }, + "xdm:placement": { + "title": "Placement Snapshot", + "description": "Snapshot of the placement for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the placement.", + "$ref": "https://ns.adobe.com/experience/decisioning/placement-detail" + }, + "xdm:selections": { + "title": "Selected Options' Snapshot", + "description": "Snapshot of the options that were selected by this activity. The objects contain a at least the xdm:id property value which is the identifier of an option. The intention is that either the selections or the fallback property is required.", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/experience/decisioning/option-detail" + }, + "minItems": 1, + "uniqueItems": true + }, + "xdm:fallback": { + "title": "Fallback Option Snapshot", + "description": "Snapshot of the fixed fallback option that was selected because no available option satisfied all constraints. The object contains at least the xdm:id property value which is the identifier of the fallback action. Note that the intention is that either the selections or the fallback property is required.", + "$ref": "https://ns.adobe.com/experience/decisioning/option-detail" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/proposition-detail-datatype" + } + ], + "examples": [ + { + "xdm:activity": { + "xdm:id": "xcore:offer-activity:f203512e02542b5" + }, + "xdm:fallback": { + "xdm:id": "xcore:fallback-offer:e91ce7243fd8c2a" + } + }, + { + "xdm:activity": { + "xdm:id": "xcore:offer-activity:ebc48132c26ccfc", + "xdm:name": "Online College Counseler", + "xdm:startDate": "2018-10-13T05:59:18.914Z", + "xdm:endDate": "2018-12-27T05:59:18.914Z", + "xdm:fallback": "xcore:fallback-offer:e91ce7243fd8c2a" + }, + "xdm:placement": { + "xdm:id": "xcore:offer-placement:c652463157c2aa1", + "xdm:name": "Top Banner", + "xdm:channel": "https://ns.adobe.com/xdm/channels/email" + }, + "xdm:selections": [ + { + "xdm:id": "xcore:personalized-offer:e91ee850a0bb7d9", + "xdm:name": "Introduction to machine learning", + "xdm:characteristics": { + "duration": "14", + "level": "intermediate", + "format": "Syllable" + }, + "https://ns.adobe.com/experience/decisioning/propositionsTotal": { + "xdm:value": 4948 + }, + "https://ns.adobe.com/experience/decisioning/propositionsProfile": { + "xdm:value": 2 + } + }, + { + "xdm:id": "xcore:personalized-offer:f67bab756ed6ee4", + "xdm:name": "Summer Camp", + "xdm:characteristics": { + "cost": "$2400", + "inventoryId": "BORA04", + "country": "French Polynesia" + }, + "https://ns.adobe.com/experience/decisioning/propositionsTotal": { + "xdm:value": 3813 + }, + "https://ns.adobe.com/experience/decisioning/propositionsProfile": { + "xdm:value": 1 + } + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/decisioning/proposition-detail.schema.md b/docs/reference/adobe/experience/decisioning/proposition-detail.schema.md new file mode 100644 index 000000000..9cf344b59 --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/proposition-detail.schema.md @@ -0,0 +1,198 @@ + +# Decision Proposition Detail Schema + +``` +https://ns.adobe.com/experience/decisioning/proposition-detail +``` + +A decision proposition detail is used to capture the output of a decisioning activity. Propositions are enriched with the observed metrics that applied to the selected options at the time the decision was made. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/decisioning/proposition-detail.schema.json](adobe/experience/decisioning/proposition-detail.schema.json) | +## Schema Hierarchy + +* Decision Proposition Detail `https://ns.adobe.com/experience/decisioning/proposition-detail` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Decision Activity Snapshot](activity-detail.schema.md) `https://ns.adobe.com/experience/decisioning/activity-detail` + * [Decision Placement Detail](placement-detail.schema.md) `https://ns.adobe.com/experience/decisioning/placement-detail` + * [Decision Option Detail](option-detail.schema.md) `https://ns.adobe.com/experience/decisioning/option-detail` + + +## Decision Proposition Detail Examples + +```json +{ + "xdm:activity": { + "xdm:id": "xcore:offer-activity:f203512e02542b5" + }, + "xdm:fallback": { + "xdm:id": "xcore:fallback-offer:e91ce7243fd8c2a" + } +} +``` + +```json +{ + "xdm:activity": { + "xdm:id": "xcore:offer-activity:ebc48132c26ccfc", + "xdm:name": "Online College Counseler", + "xdm:startDate": "2018-10-13T05:59:18.914Z", + "xdm:endDate": "2018-12-27T05:59:18.914Z", + "xdm:fallback": "xcore:fallback-offer:e91ce7243fd8c2a" + }, + "xdm:placement": { + "xdm:id": "xcore:offer-placement:c652463157c2aa1", + "xdm:name": "Top Banner", + "xdm:channel": "https://ns.adobe.com/xdm/channels/email" + }, + "xdm:selections": [ + { + "xdm:id": "xcore:personalized-offer:e91ee850a0bb7d9", + "xdm:name": "Introduction to machine learning", + "xdm:characteristics": { + "duration": "14", + "level": "intermediate", + "format": "Syllable" + }, + "https://ns.adobe.com/experience/decisioning/propositionsTotal": { + "xdm:value": 4948 + }, + "https://ns.adobe.com/experience/decisioning/propositionsProfile": { + "xdm:value": 2 + } + }, + { + "xdm:id": "xcore:personalized-offer:f67bab756ed6ee4", + "xdm:name": "Summer Camp", + "xdm:characteristics": { + "cost": "$2400", + "inventoryId": "BORA04", + "country": "French Polynesia" + }, + "https://ns.adobe.com/experience/decisioning/propositionsTotal": { + "xdm:value": 3813 + }, + "https://ns.adobe.com/experience/decisioning/propositionsProfile": { + "xdm:value": 1 + } + } + ] +} +``` + + +# Decision Proposition Detail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:activity](#xdmactivity) | Decision Activity Snapshot | Optional | Decision Proposition Detail (this schema) | +| [xdm:channel](#xdmchannel) | `string` | Optional | Decision Proposition Detail (this schema) | +| [xdm:fallback](#xdmfallback) | Decision Option Detail | Optional | Decision Proposition Detail (this schema) | +| [xdm:placement](#xdmplacement) | Decision Placement Detail | Optional | Decision Proposition Detail (this schema) | +| [xdm:selections](#xdmselections) | Decision Option Detail | Optional | Decision Proposition Detail (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:activity +### Decision Activity Snapshot + +Snapshot of the activity for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the decision activity. + +`xdm:activity` +* is optional +* type: Decision Activity Snapshot +* defined in this schema + +### xdm:activity Type + + +* [Decision Activity Snapshot](activity-detail.schema.md) – `https://ns.adobe.com/experience/decisioning/activity-detail` + + + + + +## xdm:channel +### DEPRECATED - Channel + +DEPRECATED, use placement.channel instead. The channel in which proposition was made. The value is a valid Channel URI. See 'https://ns.adobe.com/xdm/channels/channel' + +`xdm:channel` +* is optional +* type: `string` +* defined in this schema + +### xdm:channel Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:fallback +### Fallback Option Snapshot + +Snapshot of the fixed fallback option that was selected because no available option satisfied all constraints. The object contains at least the xdm:id property value which is the identifier of the fallback action. Note that the intention is that either the selections or the fallback property is required. + +`xdm:fallback` +* is optional +* type: Decision Option Detail +* defined in this schema + +### xdm:fallback Type + + +* [Decision Option Detail](option-detail.schema.md) – `https://ns.adobe.com/experience/decisioning/option-detail` + + + + + +## xdm:placement +### Placement Snapshot + +Snapshot of the placement for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the placement. + +`xdm:placement` +* is optional +* type: Decision Placement Detail +* defined in this schema + +### xdm:placement Type + + +* [Decision Placement Detail](placement-detail.schema.md) – `https://ns.adobe.com/experience/decisioning/placement-detail` + + + + + +## xdm:selections +### Selected Options' Snapshot + +Snapshot of the options that were selected by this activity. The objects contain a at least the xdm:id property value which is the identifier of an option. The intention is that either the selections or the fallback property is required. + +`xdm:selections` +* is optional +* type: Decision Option Detail +* at least `1` items in the array +* defined in this schema + +### xdm:selections Type + + +Array type: Decision Option Detail + +All items must be of the type: +* [Decision Option Detail](option-detail.schema.md) – `https://ns.adobe.com/experience/decisioning/option-detail` + + + + + + + diff --git a/docs/reference/adobe/experience/decisioning/proposition-details.schema.json b/docs/reference/adobe/experience/decisioning/proposition-details.schema.json new file mode 100644 index 000000000..f39070f7d --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/proposition-details.schema.json @@ -0,0 +1,46 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/decisioning/proposition-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Decision Proposition Details", + "type": "object", + "meta:abstract": true, + "meta:extensible": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent", + "https://ns.adobe.com/experience/decisioning/decisionevent" + ], + "description": "Decision proposition is used to capture the results of a decisioning process.", + "definitions": { + "proposition-details-mixin": { + "properties": { + "https://ns.adobe.com/experience/decisioning/propositionDetails": { + "title": "Proposition Details", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/experience/decisioning/proposition-detail" + }, + "description": "Details about the results of the decision. An array providing the output of a single decision event, one proposition per activity parameter in the request." + }, + "https://ns.adobe.com/experience/decisioning/propositionContentKey": { + "title": "Proposition Content Key", + "type": "string", + "description": "Digest or unique hash key (generated automatically) for the proposition content. Recipients of propositions with the same value will receive the same content selections in the targeted placements. Moreover, propositions with the same value to the same user mean that the content of the propositions has not changed. Propositions with different digests or hash values indicate that the decision selections are different. Note that adding a placement to the decision always change digest value." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/proposition-details-mixin" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/decisioning/proposition-details.schema.md b/docs/reference/adobe/experience/decisioning/proposition-details.schema.md new file mode 100644 index 000000000..a99dcd2ad --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/proposition-details.schema.md @@ -0,0 +1,71 @@ + +# Decision Proposition Details Schema + +``` +https://ns.adobe.com/experience/decisioning/proposition-details +``` + +Decision proposition is used to capture the results of a decisioning process. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/decisioning/proposition-details.schema.json](adobe/experience/decisioning/proposition-details.schema.json) | +## Schema Hierarchy + +* Decision Proposition Details `https://ns.adobe.com/experience/decisioning/proposition-details` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +# Decision Proposition Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/decisioning/propositionContentKey](#httpsnsadobecomexperiencedecisioningpropositioncontentkey) | `string` | Optional | Decision Proposition Details (this schema) | +| [https://ns.adobe.com/experience/decisioning/propositionDetails](#httpsnsadobecomexperiencedecisioningpropositiondetails) | Decision Proposition Detail | Optional | Decision Proposition Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/decisioning/propositionContentKey +### Proposition Content Key + +Digest or unique hash key (generated automatically) for the proposition content. Recipients of propositions with the same value will receive the same content selections in the targeted placements. Moreover, propositions with the same value to the same user mean that the content of the propositions has not changed. Propositions with different digests or hash values indicate that the decision selections are different. Note that adding a placement to the decision always change digest value. + +`https://ns.adobe.com/experience/decisioning/propositionContentKey` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/decisioning/propositionContentKey Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/decisioning/propositionDetails +### Proposition Details + +Details about the results of the decision. An array providing the output of a single decision event, one proposition per activity parameter in the request. + +`https://ns.adobe.com/experience/decisioning/propositionDetails` +* is optional +* type: Decision Proposition Detail + +* defined in this schema + +### https://ns.adobe.com/experience/decisioning/propositionDetails Type + + +Array type: Decision Proposition Detail + +All items must be of the type: +* [Decision Proposition Detail](proposition-detail.schema.md) – `https://ns.adobe.com/experience/decisioning/proposition-detail` + + + + + + + diff --git a/docs/reference/adobe/experience/decisioning/proposition-metric-profile.schema.json b/docs/reference/adobe/experience/decisioning/proposition-metric-profile.schema.json new file mode 100644 index 000000000..65e35be44 --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/proposition-metric-profile.schema.json @@ -0,0 +1,56 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/decisioning/proposition-metric-profile", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Option propositions to a Profile", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The number of times a particular option was proposed so far to a particular profile.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "https://ns.adobe.com/experience/decisioning/propositionsProfile", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "option metric: per profile propositions", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/decisioning/proposition-metric-profile.schema.md b/docs/reference/adobe/experience/decisioning/proposition-metric-profile.schema.md new file mode 100644 index 000000000..67ca5e1f3 --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/proposition-metric-profile.schema.md @@ -0,0 +1,142 @@ + +# Option propositions to a Profile Schema + +``` +https://ns.adobe.com/experience/decisioning/proposition-metric-profile +``` + +The number of times a particular option was proposed so far to a particular profile. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/decisioning/proposition-metric-profile.schema.json](adobe/experience/decisioning/proposition-metric-profile.schema.json) | +## Schema Hierarchy + +* Option propositions to a Profile `https://ns.adobe.com/experience/decisioning/proposition-metric-profile` + * [Metric Definition](../../../datatypes/data/metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +# Option propositions to a Profile Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/adobe/experience/decisioning/proposition-metric-total.schema.json b/docs/reference/adobe/experience/decisioning/proposition-metric-total.schema.json new file mode 100644 index 000000000..1f5d12f1a --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/proposition-metric-total.schema.json @@ -0,0 +1,56 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/decisioning/proposition-metric-total", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Option Propositions Total", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The total number a particular option was proposed so far across all profiles.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "https://ns.adobe.com/experience/decisioning/propositionsTotal", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "option metric: total propositions", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": null + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/decisioning/proposition-metric-total.schema.md b/docs/reference/adobe/experience/decisioning/proposition-metric-total.schema.md new file mode 100644 index 000000000..933410b7c --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/proposition-metric-total.schema.md @@ -0,0 +1,142 @@ + +# Option Propositions Total Schema + +``` +https://ns.adobe.com/experience/decisioning/proposition-metric-total +``` + +The total number a particular option was proposed so far across all profiles. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/decisioning/proposition-metric-total.schema.json](adobe/experience/decisioning/proposition-metric-total.schema.json) | +## Schema Hierarchy + +* Option Propositions Total `https://ns.adobe.com/experience/decisioning/proposition-metric-total` + * [Metric Definition](../../../datatypes/data/metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +# Option Propositions Total Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](../../../datatypes/data/metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/adobe/experience/decisioning/proposition.schema.json b/docs/reference/adobe/experience/decisioning/proposition.schema.json new file mode 100644 index 000000000..f533a4649 --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/proposition.schema.json @@ -0,0 +1,42 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/decisioning/proposition", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Decision Proposition Reference", + "type": "object", + "meta:abstract": true, + "meta:extensible": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent", + "https://ns.adobe.com/experience/decisioning/decisionevent" + ], + "description": "A decision proposition reference is used to link an experience event that is a response to a particular proposition event.", + "definitions": { + "proposition-mixin": { + "properties": { + "https://ns.adobe.com/experience/decisioning/propositionID": { + "title": "Proposition Identifier", + "type": "string", + "format": "uri-reference", + "description": "A unique identifier for the proposition event referenced by an \"XDM ExperienceEvent\". It is the expectation that applications use this \"propositionID\" in every experience event that was influenced by the set of propositions. An individual profile's proposition-response history is maintained with these proposition identifiers." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "#/definitions/proposition-mixin" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/decisioning/proposition.schema.md b/docs/reference/adobe/experience/decisioning/proposition.schema.md new file mode 100644 index 000000000..a5e377d1a --- /dev/null +++ b/docs/reference/adobe/experience/decisioning/proposition.schema.md @@ -0,0 +1,69 @@ + +# Decision Proposition Reference Schema + +``` +https://ns.adobe.com/experience/decisioning/proposition +``` + +A decision proposition reference is used to link an experience event that is a response to a particular proposition event. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/decisioning/proposition.schema.json](adobe/experience/decisioning/proposition.schema.json) | +## Schema Hierarchy + +* Decision Proposition Reference `https://ns.adobe.com/experience/decisioning/proposition` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [IdentityMap](../../../mixins/shared/identitymap.schema.md) `https://ns.adobe.com/xdm/context/identitymap` + + +# Decision Proposition Reference Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/decisioning/propositionID](#httpsnsadobecomexperiencedecisioningpropositionid) | `string` | Optional | Decision Proposition Reference (this schema) | +| [xdm:identityMap](#xdmidentitymap) | `object` | Optional | [IdentityMap](../../../mixins/shared/identitymap.schema.md#xdmidentitymap) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/decisioning/propositionID +### Proposition Identifier + +A unique identifier for the proposition event referenced by an "XDM ExperienceEvent". It is the expectation that applications use this "propositionID" in every experience event that was influenced by the set of propositions. An individual profile's proposition-response history is maintained with these proposition identifiers. + +`https://ns.adobe.com/experience/decisioning/propositionID` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/decisioning/propositionID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:identityMap + + +`xdm:identityMap` +* is optional +* type: `object` +* defined in [IdentityMap](../../../mixins/shared/identitymap.schema.md#xdmidentitymap) + +### xdm:identityMap Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + diff --git a/docs/reference/adobe/experience/experienceevent-edgeregion.schema.json b/docs/reference/adobe/experience/experienceevent-edgeregion.schema.json new file mode 100644 index 000000000..43b2a3f45 --- /dev/null +++ b/docs/reference/adobe/experience/experienceevent-edgeregion.schema.json @@ -0,0 +1,201 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/experienceevent-edgeregion", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Data capture region for Experience Events", + "description": "", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "definitions": { + "experienceevent-edgeregion": { + "properties": { + "xdm:userActivityRegion": { + "title": "User activity region", + "description": "Region info where event is captured.", + "type": "object", + "properties": { + "xdm:dataCenterLocation": { + "title": "Location of Data Center where data was captured", + "type": "string", + "meta:enum": { + "ARE1": "ARE1", + "ARE2": "ARE2", + "AUS1": "AUS1", + "AUS10": "AUS10", + "AUS2": "AUS2", + "AUS3": "AUS3", + "AUS4": "AUS4", + "AUS5": "AUS5", + "AUS6": "AUS6", + "AUS7": "AUS7", + "AUS8": "AUS8", + "AUS9": "AUS9", + "BEL1": "BEL1", + "BHR1": "BHR1", + "BRA2": "BRA2", + "BRA3": "BRA3", + "BRA4": "BRA4", + "CA1": "CA1", + "CA10": "CA10", + "CA12": "CA12", + "CA13": "CA13", + "CA14": "CA14", + "CA3": "CA3", + "CA4": "CA4", + "CA5": "CA5", + "CA6": "CA6", + "CA7": "CA7", + "CAN1": "CAN1", + "CAN2": "CAN2", + "CAN4": "CAN4", + "CAN5": "CAN5", + "CAN6": "CAN6", + "CAN7": "CAN7", + "CHE1": "CHE1", + "CHE2": "CHE2", + "CHE3": "CHE3", + "CHN1": "CHN1", + "CHN2": "CHN2", + "CHN3": "CHN3", + "CHN4": "CHN4", + "CHN5": "CHN5", + "CHN6": "CHN6", + "DEU1": "DEU1", + "DEU2": "DEU2", + "DEU4": "DEU4", + "DEU5": "DEU5", + "DEU6": "DEU6", + "DEU7": "DEU7", + "DNK1": "DNK1", + "FIN1": "FIN1", + "FRA10": "FRA10", + "FRA2": "FRA2", + "FRA3": "FRA3", + "FRA4": "FRA4", + "FRA5": "FRA5", + "FRA6": "FRA6", + "FRA7": "FRA7", + "FRA8": "FRA8", + "FRA9": "FRA9", + "GBR1": "GBR1", + "GBR10": "GBR10", + "GBR11": "GBR11", + "GBR12": "GBR12", + "GBR13": "GBR13", + "GBR5": "GBR5", + "GBR7": "GBR7", + "GBR8": "GBR8", + "GBR9": "GBR9", + "HKG1": "HKG1", + "HKG2": "HKG2", + "HKG3": "HKG3", + "HKG4": "HKG4", + "HKG5": "HKG5", + "IA1": "IA1", + "IA2": "IA2", + "IA3": "IA3", + "IA4": "IA4", + "IL1": "IL1", + "IND1": "IND1", + "IND2": "IND2", + "IND3": "IND3", + "IND4": "IND4", + "IND5": "IND5", + "IND6": "IND6", + "IRL1": "IRL1", + "IRL2": "IRL2", + "IRL3": "IRL3", + "JPN2": "JPN2", + "JPN3": "JPN3", + "JPN4": "JPN4", + "JPN5": "JPN5", + "JPN6": "JPN6", + "JPN7": "JPN7", + "JPN8": "JPN8", + "KOR1": "KOR1", + "KOR2": "KOR2", + "KOR3": "KOR3", + "MA1": "MA1", + "MA2": "MA2", + "MA3": "MA3", + "MDA1": "MDA1", + "NLD1": "NLD1", + "NLD2": "NLD2", + "NLD3": "NLD3", + "NLD4": "NLD4", + "NOR1": "NOR1", + "NOR2": "NOR2", + "NY7": "NY7", + "OH2": "OH2", + "OR1": "OR1", + "OR2": "OR2", + "OR3": "OR3", + "OR4": "OR4", + "ROU1": "ROU1", + "SC1": "SC1", + "SGP2": "SGP2", + "SGP3": "SGP3", + "SGP4": "SGP4", + "SGP5": "SGP5", + "SGP6": "SGP6", + "SGP7": "SGP7", + "SWE1": "SWE1", + "TWN1": "TWN1", + "TX3": "TX3", + "UT1": "UT1", + "UT2": "UT2", + "VA1": "VA1", + "VA10": "VA10", + "VA11": "VA11", + "VA12": "VA12", + "VA13": "VA13", + "VA14": "VA14", + "VA5": "VA5", + "VA6": "VA6", + "VA7": "VA7", + "VA8": "VA8", + "VA9": "VA9", + "WA1": "WA1", + "WA2": "WA2", + "WY1": "WY1", + "ZAF1": "ZAF1", + "ZAF2": "ZAF2" + } + }, + "xdm:captureTimestamp": { + "title": "Data Capture Timestamp", + "type": "string", + "format": "date-time", + "description": "The time when data was captured on data center node." + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-edgeregion" + } + ], + "examples": [ + { + "xdm:userActivityRegion": { + "xdm:dataCenterLocation": "VA6", + "xdm:captureTimestamp": "2017-09-26T15:52:25+00:00" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/experienceevent-edgeregion.schema.md b/docs/reference/adobe/experience/experienceevent-edgeregion.schema.md new file mode 100644 index 000000000..2ba4b0a8c --- /dev/null +++ b/docs/reference/adobe/experience/experienceevent-edgeregion.schema.md @@ -0,0 +1,249 @@ + +# Data capture region for Experience Events Schema + +``` +https://ns.adobe.com/experience/experienceevent-edgeregion +``` + + + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/experienceevent-edgeregion.schema.json](adobe/experience/experienceevent-edgeregion.schema.json) | +## Schema Hierarchy + +* Data capture region for Experience Events `https://ns.adobe.com/experience/experienceevent-edgeregion` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Data capture region for Experience Events Example +```json +{ + "xdm:userActivityRegion": { + "xdm:dataCenterLocation": "VA6", + "xdm:captureTimestamp": "2017-09-26T15:52:25+00:00" + } +} +``` + +# Data capture region for Experience Events Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:userActivityRegion](#xdmuseractivityregion) | `object` | Optional | Data capture region for Experience Events (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:userActivityRegion +### User activity region + +Region info where event is captured. + +`xdm:userActivityRegion` +* is optional +* type: `object` +* defined in this schema + +### xdm:userActivityRegion Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:captureTimestamp`| string | Optional | +| `xdm:dataCenterLocation`| string | Optional | + + + +#### xdm:captureTimestamp +##### Data Capture Timestamp + +The time when data was captured on data center node. + +`xdm:captureTimestamp` +* is optional +* type: `string` + +##### xdm:captureTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + +#### xdm:dataCenterLocation +##### Location of Data Center where data was captured + +undefined + +`xdm:dataCenterLocation` +* is optional +* type: `string` + +##### xdm:dataCenterLocation Type + + +`string` + + + +##### xdm:dataCenterLocation Known Values +| Value | Description | +|-------|-------------| +| `ARE1` | ARE1 | +| `ARE2` | ARE2 | +| `AUS1` | AUS1 | +| `AUS10` | AUS10 | +| `AUS2` | AUS2 | +| `AUS3` | AUS3 | +| `AUS4` | AUS4 | +| `AUS5` | AUS5 | +| `AUS6` | AUS6 | +| `AUS7` | AUS7 | +| `AUS8` | AUS8 | +| `AUS9` | AUS9 | +| `BEL1` | BEL1 | +| `BHR1` | BHR1 | +| `BRA2` | BRA2 | +| `BRA3` | BRA3 | +| `BRA4` | BRA4 | +| `CA1` | CA1 | +| `CA10` | CA10 | +| `CA12` | CA12 | +| `CA13` | CA13 | +| `CA14` | CA14 | +| `CA3` | CA3 | +| `CA4` | CA4 | +| `CA5` | CA5 | +| `CA6` | CA6 | +| `CA7` | CA7 | +| `CAN1` | CAN1 | +| `CAN2` | CAN2 | +| `CAN4` | CAN4 | +| `CAN5` | CAN5 | +| `CAN6` | CAN6 | +| `CAN7` | CAN7 | +| `CHE1` | CHE1 | +| `CHE2` | CHE2 | +| `CHE3` | CHE3 | +| `CHN1` | CHN1 | +| `CHN2` | CHN2 | +| `CHN3` | CHN3 | +| `CHN4` | CHN4 | +| `CHN5` | CHN5 | +| `CHN6` | CHN6 | +| `DEU1` | DEU1 | +| `DEU2` | DEU2 | +| `DEU4` | DEU4 | +| `DEU5` | DEU5 | +| `DEU6` | DEU6 | +| `DEU7` | DEU7 | +| `DNK1` | DNK1 | +| `FIN1` | FIN1 | +| `FRA10` | FRA10 | +| `FRA2` | FRA2 | +| `FRA3` | FRA3 | +| `FRA4` | FRA4 | +| `FRA5` | FRA5 | +| `FRA6` | FRA6 | +| `FRA7` | FRA7 | +| `FRA8` | FRA8 | +| `FRA9` | FRA9 | +| `GBR1` | GBR1 | +| `GBR10` | GBR10 | +| `GBR11` | GBR11 | +| `GBR12` | GBR12 | +| `GBR13` | GBR13 | +| `GBR5` | GBR5 | +| `GBR7` | GBR7 | +| `GBR8` | GBR8 | +| `GBR9` | GBR9 | +| `HKG1` | HKG1 | +| `HKG2` | HKG2 | +| `HKG3` | HKG3 | +| `HKG4` | HKG4 | +| `HKG5` | HKG5 | +| `IA1` | IA1 | +| `IA2` | IA2 | +| `IA3` | IA3 | +| `IA4` | IA4 | +| `IL1` | IL1 | +| `IND1` | IND1 | +| `IND2` | IND2 | +| `IND3` | IND3 | +| `IND4` | IND4 | +| `IND5` | IND5 | +| `IND6` | IND6 | +| `IRL1` | IRL1 | +| `IRL2` | IRL2 | +| `IRL3` | IRL3 | +| `JPN2` | JPN2 | +| `JPN3` | JPN3 | +| `JPN4` | JPN4 | +| `JPN5` | JPN5 | +| `JPN6` | JPN6 | +| `JPN7` | JPN7 | +| `JPN8` | JPN8 | +| `KOR1` | KOR1 | +| `KOR2` | KOR2 | +| `KOR3` | KOR3 | +| `MA1` | MA1 | +| `MA2` | MA2 | +| `MA3` | MA3 | +| `MDA1` | MDA1 | +| `NLD1` | NLD1 | +| `NLD2` | NLD2 | +| `NLD3` | NLD3 | +| `NLD4` | NLD4 | +| `NOR1` | NOR1 | +| `NOR2` | NOR2 | +| `NY7` | NY7 | +| `OH2` | OH2 | +| `OR1` | OR1 | +| `OR2` | OR2 | +| `OR3` | OR3 | +| `OR4` | OR4 | +| `ROU1` | ROU1 | +| `SC1` | SC1 | +| `SGP2` | SGP2 | +| `SGP3` | SGP3 | +| `SGP4` | SGP4 | +| `SGP5` | SGP5 | +| `SGP6` | SGP6 | +| `SGP7` | SGP7 | +| `SWE1` | SWE1 | +| `TWN1` | TWN1 | +| `TX3` | TX3 | +| `UT1` | UT1 | +| `UT2` | UT2 | +| `VA1` | VA1 | +| `VA10` | VA10 | +| `VA11` | VA11 | +| `VA12` | VA12 | +| `VA13` | VA13 | +| `VA14` | VA14 | +| `VA5` | VA5 | +| `VA6` | VA6 | +| `VA7` | VA7 | +| `VA8` | VA8 | +| `VA9` | VA9 | +| `WA1` | WA1 | +| `WA2` | WA2 | +| `WY1` | WY1 | +| `ZAF1` | ZAF1 | +| `ZAF2` | ZAF2 | + + + + + + + + diff --git a/docs/reference/adobe/experience/implementations-ext.schema.json b/docs/reference/adobe/experience/implementations-ext.schema.json new file mode 100644 index 000000000..ae0c185f8 --- /dev/null +++ b/docs/reference/adobe/experience/implementations-ext.schema.json @@ -0,0 +1,36 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/implementations-ext", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Experience Platform Implementation Details Mixin", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Details the type and version of client implementations in ExperienceEvents for data collection interacting with Adobe Experience Cloud services. Used for debugging and usage analysis.", + "definitions": { + "implementations-ext": { + "properties": { + "https://ns.adobe.com/experience/implementations": { + "$ref": "https://ns.adobe.com/experience/implementations" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/implementations-ext" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/implementations-ext.schema.md b/docs/reference/adobe/experience/implementations-ext.schema.md new file mode 100644 index 000000000..4e0c3a793 --- /dev/null +++ b/docs/reference/adobe/experience/implementations-ext.schema.md @@ -0,0 +1,42 @@ + +# Adobe Experience Platform Implementation Details Mixin Schema + +``` +https://ns.adobe.com/experience/implementations-ext +``` + +Details the type and version of client implementations in ExperienceEvents for data collection interacting with Adobe Experience Cloud services. Used for debugging and usage analysis. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/implementations-ext.schema.json](adobe/experience/implementations-ext.schema.json) | +## Schema Hierarchy + +* Adobe Experience Platform Implementation Details Mixin `https://ns.adobe.com/experience/implementations-ext` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Adobe Experience Platform Implementation Details](implementations.schema.md) `https://ns.adobe.com/experience/implementations` + + +# Adobe Experience Platform Implementation Details Mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/implementations](#httpsnsadobecomexperienceimplementations) | Adobe Experience Platform Implementation Details | Optional | Adobe Experience Platform Implementation Details Mixin (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/implementations + + +`https://ns.adobe.com/experience/implementations` +* is optional +* type: Adobe Experience Platform Implementation Details +* defined in this schema + +### https://ns.adobe.com/experience/implementations Type + + +* [Adobe Experience Platform Implementation Details](implementations.schema.md) – `https://ns.adobe.com/experience/implementations` + + + + diff --git a/docs/reference/adobe/experience/implementations.schema.json b/docs/reference/adobe/experience/implementations.schema.json new file mode 100644 index 000000000..d38538716 --- /dev/null +++ b/docs/reference/adobe/experience/implementations.schema.json @@ -0,0 +1,48 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/implementations", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Experience Platform Implementation Details", + "type": "object", + "description": "Details the type and version of client implementations for data collection interacting with Adobe Experience Cloud services. Used for debugging and usage analysis.", + "definitions": { + "implementations": { + "properties": { + "https://ns.adobe.com/experience/analytics/implementation": { + "title": "Client Implementation for Adobe Analytics", + "$ref": "https://ns.adobe.com/xdm/context/implementationdetails", + "description": "Client details interacting with Adobe Analytics." + }, + "https://ns.adobe.com/xdm/experience/target/implementation": { + "title": "Client Implementation for Adobe Target", + "$ref": "https://ns.adobe.com/xdm/context/implementationdetails", + "description": "Client details interacting with Adobe Target." + }, + "https://ns.adobe.com/experience/idservice/implementation": { + "title": "Client Implementation for Adobe Visitor Service", + "$ref": "https://ns.adobe.com/xdm/context/implementationdetails", + "description": "Client details interacting with Adobe Experience Cloud ID Service." + }, + "https://ns.adobe.com/experience/adcloud/implementation": { + "title": "Client Implementation for Adobe Advertising Cloud", + "$ref": "https://ns.adobe.com/xdm/context/implementationdetails", + "description": "Client details interacting with Adobe Advertising Cloud." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/implementations" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/implementations.schema.md b/docs/reference/adobe/experience/implementations.schema.md new file mode 100644 index 000000000..40641f3b8 --- /dev/null +++ b/docs/reference/adobe/experience/implementations.schema.md @@ -0,0 +1,104 @@ + +# Adobe Experience Platform Implementation Details Schema + +``` +https://ns.adobe.com/experience/implementations +``` + +Details the type and version of client implementations for data collection interacting with Adobe Experience Cloud services. Used for debugging and usage analysis. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/implementations.schema.json](adobe/experience/implementations.schema.json) | +## Schema Hierarchy + +* Adobe Experience Platform Implementation Details `https://ns.adobe.com/experience/implementations` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Implementation details](../../datatypes/implementationdetails.schema.md) `https://ns.adobe.com/xdm/context/implementationdetails` + + +# Adobe Experience Platform Implementation Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/adcloud/implementation](#httpsnsadobecomexperienceadcloudimplementation) | Implementation details | Optional | Adobe Experience Platform Implementation Details (this schema) | +| [https://ns.adobe.com/experience/analytics/implementation](#httpsnsadobecomexperienceanalyticsimplementation) | Implementation details | Optional | Adobe Experience Platform Implementation Details (this schema) | +| [https://ns.adobe.com/experience/idservice/implementation](#httpsnsadobecomexperienceidserviceimplementation) | Implementation details | Optional | Adobe Experience Platform Implementation Details (this schema) | +| [https://ns.adobe.com/xdm/experience/target/implementation](#httpsnsadobecomxdmexperiencetargetimplementation) | Implementation details | Optional | Adobe Experience Platform Implementation Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/adcloud/implementation +### Client Implementation for Adobe Advertising Cloud + +Client details interacting with Adobe Advertising Cloud. + +`https://ns.adobe.com/experience/adcloud/implementation` +* is optional +* type: Implementation details +* defined in this schema + +### https://ns.adobe.com/experience/adcloud/implementation Type + + +* [Implementation details](../../datatypes/implementationdetails.schema.md) – `https://ns.adobe.com/xdm/context/implementationdetails` + + + + + +## https://ns.adobe.com/experience/analytics/implementation +### Client Implementation for Adobe Analytics + +Client details interacting with Adobe Analytics. + +`https://ns.adobe.com/experience/analytics/implementation` +* is optional +* type: Implementation details +* defined in this schema + +### https://ns.adobe.com/experience/analytics/implementation Type + + +* [Implementation details](../../datatypes/implementationdetails.schema.md) – `https://ns.adobe.com/xdm/context/implementationdetails` + + + + + +## https://ns.adobe.com/experience/idservice/implementation +### Client Implementation for Adobe Visitor Service + +Client details interacting with Adobe Experience Cloud ID Service. + +`https://ns.adobe.com/experience/idservice/implementation` +* is optional +* type: Implementation details +* defined in this schema + +### https://ns.adobe.com/experience/idservice/implementation Type + + +* [Implementation details](../../datatypes/implementationdetails.schema.md) – `https://ns.adobe.com/xdm/context/implementationdetails` + + + + + +## https://ns.adobe.com/xdm/experience/target/implementation +### Client Implementation for Adobe Target + +Client details interacting with Adobe Target. + +`https://ns.adobe.com/xdm/experience/target/implementation` +* is optional +* type: Implementation details +* defined in this schema + +### https://ns.adobe.com/xdm/experience/target/implementation Type + + +* [Implementation details](../../datatypes/implementationdetails.schema.md) – `https://ns.adobe.com/xdm/context/implementationdetails` + + + + diff --git a/docs/reference/adobe/experience/marketo/account-marketo.schema.json b/docs/reference/adobe/experience/marketo/account-marketo.schema.json new file mode 100644 index 000000000..cc73e6984 --- /dev/null +++ b/docs/reference/adobe/experience/marketo/account-marketo.schema.json @@ -0,0 +1,252 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/marketo/account-marketo", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Marketo Account", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/account" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/account-crm" + ], + "description": "Marketo specific Account fields.", + "definitions": { + "account-marketo": { + "properties": { + "marketo:accountID": { + "title": "Marketo Account Identifier", + "description": "Unique identifier for an account in the Marketo instance.", + "type": "string" + }, + "marketo:instanceID": { + "title": "Instance Identifier", + "description": "Instance identifier of Marketo where the record originated from.", + "type": "string" + }, + "marketo:org": { + "type": "object", + "properties": { + "marketo:notes": { + "title": "Account Notes", + "type": "string" + }, + "marketo:accountType": { + "title": "Account Type", + "description": "Type of Account.", + "type": "string" + }, + "marketo:primaryInterestID": { + "title": "Primary Interest Id", + "type": "string" + }, + "marketo:isPrivate": { + "title": "Private Flag", + "type": "boolean" + } + } + }, + "marketo:namedAccount": { + "type": "object", + "properties": { + "marketo:opportunityAmount": { + "title": "Opportunity Amount", + "type": "number" + }, + "marketo:opportunityCount": { + "title": "Opportunity Count", + "type": "integer" + }, + "marketo:percentiles": { + "title": "Percentile Measures", + "type": "array", + "items": { + "type": "number" + } + }, + "marketo:scores": { + "title": "Score Measures", + "type": "array", + "items": { + "type": "number" + } + }, + "marketo:membershipCount": { + "title": "Membership Count", + "type": "integer" + }, + "marketo:crmOrgID": { + "title": "CRM Organization Id", + "description": "Organization Id of the account from the CRM system.", + "type": "string" + }, + "marketo:domainName": { + "title": "Domain Name", + "description": "Organization Domain name.", + "type": "string" + }, + "marketo:isTargeted": { + "title": "Account targeted Indicator", + "description": "Indicator whether the Account is targeted.", + "type": "boolean" + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/account-marketo" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/account-crm" + } + ], + "meta:status": "experimental", + "examples": [ + { + "marketo:accountID": "MKTO1111", + "marketo:instanceID": "AAABBB", + "marketo:org": { + "marketo:notes": "Account Notes", + "marketo:accountType": "Business", + "marketo:primaryInterestID": "ABC111", + "marketo:isPrivate": true + }, + "marketo:namedAccount": { + "marketo:opportunityAmount": 10000, + "marketo:opportunityCount": 2, + "marketo:percentiles": [ + 10, + 15, + 20, + 20, + 15 + ], + "marketo:scores": [ + 1, + 0.9, + 0.8, + 0.75, + 0.5 + ], + "marketo:membershipCount": 3, + "marketo:crmOrgID": "crmorg111", + "marketo:domainName": "Retail", + "marketo:isTargeted": true + }, + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-20T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-20T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:ownerID": "OWNER111", + "xdm:parentID": "ACC000", + "xdm:partnerAccountID": "PRTNR1111", + "xdm:territoryID": "Terr1", + "xdm:accountSite": "Additional account site details", + "xdm:currencyCode": "USD", + "xdm:annualRevenue": 10000000, + "xdm:fax": [ + { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + } + ], + "xdm:accountOrganization": { + "@id": "https://data.adobe.io/entities/org/orgid111", + "xdm:legalName": "ABC Stores", + "xdm:numberOfEmployees": 200, + "xdm:industry": "Retail", + "xdm:website": "http://www.abcstores.com", + "rating": 1, + "xdm:marketSegment": "apparel for kids", + "xdm:location": { + "@id": "https://data.adobe.io/entities/places/locid123", + "schema:description": "ABC Store location", + "xdm:address": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": true, + "xdm:type": "work", + "xdm:street1": "100 Lincoln Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95125", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-23" + }, + "schema:telephone": "1-408-800-0000", + "xdm:identifier": { + "https://ns.adobe.com/xdm/external/dnb": "1234", + "https://ns.adobe.com/xdm/external/angellist": "https://angel.co/adobe" + }, + "xdm:classifier": { + "https://ns.adobe.com/xdm/external/sic": "1234", + "https://ns.adobe.com/xdm/external/naics": "1234" + } + } + }, + "xdm:naicsDescription": "Naics Description Here", + "xdm:sicDescription": "SIC Description Here", + "xdm:accountName": "Account 123", + "xdm:accountDescription": "Account Description", + "xdm:ownership": "Public", + "xdm:logoUrl": "https://sampleaccount.com/logo.png", + "xdm:tradeStyle": "Trade style here", + "xdm:tickerSymbol": "Ticker Symbol Here", + "xdm:deleted": false, + "xdm:billingAddress": [ + { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": true, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + } + ], + "xdm:shippingAddress": [ + { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": true, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/marketo/account-marketo.schema.md b/docs/reference/adobe/experience/marketo/account-marketo.schema.md new file mode 100644 index 000000000..0a2d3b26f --- /dev/null +++ b/docs/reference/adobe/experience/marketo/account-marketo.schema.md @@ -0,0 +1,1002 @@ + +# Marketo Account Schema + +``` +https://ns.adobe.com/experience/marketo/account-marketo +``` + +Marketo specific Account fields. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/marketo/account-marketo.schema.json](adobe/experience/marketo/account-marketo.schema.json) | +## Schema Hierarchy + +* Marketo Account `https://ns.adobe.com/experience/marketo/account-marketo` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [XDM Business Account](../../../mixins/account/account-crm.schema.md) `https://ns.adobe.com/xdm/context/account-crm` + + +## Marketo Account Example +```json +{ + "marketo:accountID": "MKTO1111", + "marketo:instanceID": "AAABBB", + "marketo:org": { + "marketo:notes": "Account Notes", + "marketo:accountType": "Business", + "marketo:primaryInterestID": "ABC111", + "marketo:isPrivate": true + }, + "marketo:namedAccount": { + "marketo:opportunityAmount": 10000, + "marketo:opportunityCount": 2, + "marketo:percentiles": [ + 10, + 15, + 20, + 20, + 15 + ], + "marketo:scores": [ + 1, + 0.9, + 0.8, + 0.75, + 0.5 + ], + "marketo:membershipCount": 3, + "marketo:crmOrgID": "crmorg111", + "marketo:domainName": "Retail", + "marketo:isTargeted": true + }, + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-20T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-20T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:ownerID": "OWNER111", + "xdm:parentID": "ACC000", + "xdm:partnerAccountID": "PRTNR1111", + "xdm:territoryID": "Terr1", + "xdm:accountSite": "Additional account site details", + "xdm:currencyCode": "USD", + "xdm:annualRevenue": 10000000, + "xdm:fax": [ + { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + } + ], + "xdm:accountOrganization": { + "@id": "https://data.adobe.io/entities/org/orgid111", + "xdm:legalName": "ABC Stores", + "xdm:numberOfEmployees": 200, + "xdm:industry": "Retail", + "xdm:website": "http://www.abcstores.com", + "rating": 1, + "xdm:marketSegment": "apparel for kids", + "xdm:location": { + "@id": "https://data.adobe.io/entities/places/locid123", + "schema:description": "ABC Store location", + "xdm:address": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": true, + "xdm:type": "work", + "xdm:street1": "100 Lincoln Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95125", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-23" + }, + "schema:telephone": "1-408-800-0000", + "xdm:identifier": { + "https://ns.adobe.com/xdm/external/dnb": "1234", + "https://ns.adobe.com/xdm/external/angellist": "https://angel.co/adobe" + }, + "xdm:classifier": { + "https://ns.adobe.com/xdm/external/sic": "1234", + "https://ns.adobe.com/xdm/external/naics": "1234" + } + } + }, + "xdm:naicsDescription": "Naics Description Here", + "xdm:sicDescription": "SIC Description Here", + "xdm:accountName": "Account 123", + "xdm:accountDescription": "Account Description", + "xdm:ownership": "Public", + "xdm:logoUrl": "https://sampleaccount.com/logo.png", + "xdm:tradeStyle": "Trade style here", + "xdm:tickerSymbol": "Ticker Symbol Here", + "xdm:deleted": false, + "xdm:billingAddress": [ + { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": true, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + } + ], + "xdm:shippingAddress": [ + { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": true, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + } + ] +} +``` + +# Marketo Account Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [marketo:accountID](#marketoaccountid) | `string` | Optional | Marketo Account (this schema) | +| [marketo:instanceID](#marketoinstanceid) | `string` | Optional | Marketo Account (this schema) | +| [marketo:namedAccount](#marketonamedaccount) | `object` | Optional | Marketo Account (this schema) | +| [marketo:org](#marketoorg) | `object` | Optional | Marketo Account (this schema) | +| [xdm:accountDescription](#xdmaccountdescription) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmaccountdescription) | +| [xdm:accountName](#xdmaccountname) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmaccountname) | +| [xdm:accountOrganization](#xdmaccountorganization) | Organization | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmaccountorganization) | +| [xdm:accountSite](#xdmaccountsite) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmaccountsite) | +| [xdm:annualRevenue](#xdmannualrevenue) | `number` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmannualrevenue) | +| [xdm:billingAddress](#xdmbillingaddress) | Postal address | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmbillingaddress) | +| [xdm:currencyCode](#xdmcurrencycode) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmcurrencycode) | +| [xdm:fax](#xdmfax) | Phone number | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmfax) | +| [xdm:isDeleted](#xdmisdeleted) | `boolean` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmisdeleted) | +| [xdm:logoUrl](#xdmlogourl) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmlogourl) | +| [xdm:naicsDescription](#xdmnaicsdescription) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmnaicsdescription) | +| [xdm:ownerID](#xdmownerid) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmownerid) | +| [xdm:ownership](#xdmownership) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmownership) | +| [xdm:parentID](#xdmparentid) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmparentid) | +| [xdm:partnerAccountID](#xdmpartneraccountid) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmpartneraccountid) | +| [xdm:shippingAddress](#xdmshippingaddress) | Postal address | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmshippingaddress) | +| [xdm:sicDescription](#xdmsicdescription) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmsicdescription) | +| [xdm:sourceType](#xdmsourcetype) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmsourcetype) | +| [xdm:territoryID](#xdmterritoryid) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmterritoryid) | +| [xdm:tickerSymbol](#xdmtickersymbol) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmtickersymbol) | +| [xdm:tradeStyle](#xdmtradestyle) | `string` | Optional | [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmtradestyle) | +| `*` | any | Additional | this schema *allows* additional properties | + +## marketo:accountID +### Marketo Account Identifier + +Unique identifier for an account in the Marketo instance. + +`marketo:accountID` +* is optional +* type: `string` +* defined in this schema + +### marketo:accountID Type + + +`string` + + + + + + +## marketo:instanceID +### Instance Identifier + +Instance identifier of Marketo where the record originated from. + +`marketo:instanceID` +* is optional +* type: `string` +* defined in this schema + +### marketo:instanceID Type + + +`string` + + + + + + +## marketo:namedAccount + + +`marketo:namedAccount` +* is optional +* type: `object` +* defined in this schema + +### marketo:namedAccount Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `marketo:crmOrgID`| string | Optional | +| `marketo:domainName`| string | Optional | +| `marketo:isTargeted`| boolean | Optional | +| `marketo:membershipCount`| integer | Optional | +| `marketo:opportunityAmount`| number | Optional | +| `marketo:opportunityCount`| integer | Optional | +| `marketo:percentiles`| array | Optional | +| `marketo:scores`| array | Optional | + + + +#### marketo:crmOrgID +##### CRM Organization Id + +Organization Id of the account from the CRM system. + +`marketo:crmOrgID` +* is optional +* type: `string` + +##### marketo:crmOrgID Type + + +`string` + + + + + + + + +#### marketo:domainName +##### Domain Name + +Organization Domain name. + +`marketo:domainName` +* is optional +* type: `string` + +##### marketo:domainName Type + + +`string` + + + + + + + + +#### marketo:isTargeted +##### Account targeted Indicator + +Indicator whether the Account is targeted. + +`marketo:isTargeted` +* is optional +* type: `boolean` + +##### marketo:isTargeted Type + + +`boolean` + + + + + + + +#### marketo:membershipCount +##### Membership Count + +undefined + +`marketo:membershipCount` +* is optional +* type: `integer` + +##### marketo:membershipCount Type + + +`integer` + + + + + + + + +#### marketo:opportunityAmount +##### Opportunity Amount + +undefined + +`marketo:opportunityAmount` +* is optional +* type: `number` + +##### marketo:opportunityAmount Type + + +`number` + + + + + + + + +#### marketo:opportunityCount +##### Opportunity Count + +undefined + +`marketo:opportunityCount` +* is optional +* type: `integer` + +##### marketo:opportunityCount Type + + +`integer` + + + + + + + + +#### marketo:percentiles +##### Percentile Measures + +undefined + +`marketo:percentiles` +* is optional +* type: `number[]` + + +##### marketo:percentiles Type + + +Array type: `number[]` + +All items must be of the type: +`number` + + + + + + + + + + + +#### marketo:scores +##### Score Measures + +undefined + +`marketo:scores` +* is optional +* type: `number[]` + + +##### marketo:scores Type + + +Array type: `number[]` + +All items must be of the type: +`number` + + + + + + + + + + + + + + +## marketo:org + + +`marketo:org` +* is optional +* type: `object` +* defined in this schema + +### marketo:org Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `marketo:accountType`| string | Optional | +| `marketo:isPrivate`| boolean | Optional | +| `marketo:notes`| string | Optional | +| `marketo:primaryInterestID`| string | Optional | + + + +#### marketo:accountType +##### Account Type + +Type of Account. + +`marketo:accountType` +* is optional +* type: `string` + +##### marketo:accountType Type + + +`string` + + + + + + + + +#### marketo:isPrivate +##### Private Flag + +undefined + +`marketo:isPrivate` +* is optional +* type: `boolean` + +##### marketo:isPrivate Type + + +`boolean` + + + + + + + +#### marketo:notes +##### Account Notes + +undefined + +`marketo:notes` +* is optional +* type: `string` + +##### marketo:notes Type + + +`string` + + + + + + + + +#### marketo:primaryInterestID +##### Primary Interest Id + +undefined + +`marketo:primaryInterestID` +* is optional +* type: `string` + +##### marketo:primaryInterestID Type + + +`string` + + + + + + + + + + + +## xdm:accountDescription +### Account Description + +Text description of the account. + +`xdm:accountDescription` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmaccountdescription) + +### xdm:accountDescription Type + + +`string` + + + + + + +## xdm:accountName +### Account Name + +name of company. Up to 255 characters are allowed in this field. + +`xdm:accountName` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmaccountname) + +### xdm:accountName Type + + +`string` + + + + + + +## xdm:accountOrganization +### Account Details + +Account details like number of employees, market segment, industry, and location. + +`xdm:accountOrganization` +* is optional +* type: Organization +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmaccountorganization) + +### xdm:accountOrganization Type + + +* [Organization](../../../datatypes/organization.schema.md) – `https://ns.adobe.com/xdm/common/organization` + + + + + +## xdm:accountSite +### Account Site Details + +Information about the account’s location, such as single location, headquarters, or branch. Up to 80 characters are allowed in this field. + +`xdm:accountSite` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmaccountsite) + +### xdm:accountSite Type + + +`string` + + + + + + +## xdm:annualRevenue +### Annual Revenue + +Estimated annual revenue of the account. + +`xdm:annualRevenue` +* is optional +* type: `number` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmannualrevenue) + +### xdm:annualRevenue Type + + +`number` + + + + + + +## xdm:billingAddress +### Account Billing Address + +Billing address(es) for the account. + +`xdm:billingAddress` +* is optional +* type: Postal address + +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmbillingaddress) + +### xdm:billingAddress Type + + +Array type: Postal address + +All items must be of the type: +* [Postal address](../../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + + + + +## xdm:currencyCode +### Currency Code + +The ISO 4217 currency code. + +`xdm:currencyCode` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmcurrencycode) + +### xdm:currencyCode Type + + +`string` + + +All instances must conform to this regular expression +```regex +^[A-Z]{3}$ +``` + +* test example: [USD](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=USD) +* test example: [EUR](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=EUR) + + + + +### xdm:currencyCode Examples + +```json +"USD" +``` + +```json +"EUR" +``` + + + +## xdm:fax +### Fax Number + +Fax number for the account. + +`xdm:fax` +* is optional +* type: Phone number + +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmfax) + +### xdm:fax Type + + +Array type: Phone number + +All items must be of the type: +* [Phone number](../../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + + + + +## xdm:isDeleted +### Account Record Deleted Indicator + +Indicator whether the Account record is deleted or not. + +`xdm:isDeleted` +* is optional +* type: `boolean` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmisdeleted) + +### xdm:isDeleted Type + + +`boolean` + + + + + +## xdm:logoUrl +### Logo URL + +Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the account. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the account. + +`xdm:logoUrl` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmlogourl) + +### xdm:logoUrl Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:naicsDescription +### NAICS Description + +A brief description of an organization’s line of business, based on its NAICS code. + +`xdm:naicsDescription` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmnaicsdescription) + +### xdm:naicsDescription Type + + +`string` + + + + + + +## xdm:ownerID +### Account Owner + +assigned owner of account. Not available in personal edition. + +`xdm:ownerID` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmownerid) + +### xdm:ownerID Type + + +`string` + + + + + + +## xdm:ownership +### Ownership + +Ownership of company, for example, public or private. Entry is selected from a picklist of available values, which a salesforce admin sets. Each picklist value can have up to 40 characters. + +`xdm:ownership` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmownership) + +### xdm:ownership Type + + +`string` + + + + + + +## xdm:parentID +### Parent Account + +Parent company for companies that are subsidiaries of a larger company or organization. The parent account must be an existing account in salesforce. You can enter the account name, or select (or optionally, create) the account using the lookup icon. + +`xdm:parentID` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmparentid) + +### xdm:parentID Type + + +`string` + + + + + + +## xdm:partnerAccountID +### Partner Account Id + +Partner accounts are accounts that a channel manager uses to manage partner organizations, partner users, and activities when using a partner community or partner portal. + +`xdm:partnerAccountID` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmpartneraccountid) + +### xdm:partnerAccountID Type + + +`string` + + + + + + +## xdm:shippingAddress +### Account Shipping Address + +Shipping address(es) for the account. + +`xdm:shippingAddress` +* is optional +* type: Postal address + +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmshippingaddress) + +### xdm:shippingAddress Type + + +Array type: Postal address + +All items must be of the type: +* [Postal address](../../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + + + + +## xdm:sicDescription +### SIC Description + +A brief description of an organization’s line of business, based on its SIC code. + +`xdm:sicDescription` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmsicdescription) + +### xdm:sicDescription Type + + +`string` + + + + + + +## xdm:sourceType +### Account Source Type + +Source type for the account. + +`xdm:sourceType` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmsourcetype) + +### xdm:sourceType Type + + +`string` + + + + + + +## xdm:territoryID +### Territory Id + +The territory to which the account has been assigned. + +`xdm:territoryID` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmterritoryid) + +### xdm:territoryID Type + + +`string` + + + + + + +## xdm:tickerSymbol +### Ticker Symbol + +The stock market symbol for this account. Maximum of 20 characters. + +`xdm:tickerSymbol` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmtickersymbol) + +### xdm:tickerSymbol Type + + +`string` + + + + + + +## xdm:tradeStyle +### Account Trade Style + +A name, different from its legal name, that an organization may use for conducting business. Similar to (Doing business as) or (DBA). + +`xdm:tradeStyle` +* is optional +* type: `string` +* defined in [XDM Business Account](../../../mixins/account/account-crm.schema.md#xdmtradestyle) + +### xdm:tradeStyle Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/marketo/marketo-activity.schema.json b/docs/reference/adobe/experience/marketo/marketo-activity.schema.json new file mode 100644 index 000000000..31a7c1c9b --- /dev/null +++ b/docs/reference/adobe/experience/marketo/marketo-activity.schema.json @@ -0,0 +1,65 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/marketo/activity-marketo-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Marketo Activity Log", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/activity-log" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/activity-log-details" + ], + "description": "Marketo specific Activity Log Details", + "definitions": { + "activity-marketo-details": { + "properties": { + "marketo:activityLog": { + "type": "object", + "properties": { + "marketo:activityID": { + "title": "Marketo Activity Unique Identifier", + "description": "Marketo Activity Unique identifier.", + "type": "string" + }, + "marketo:attributeValues": { + "title": "Attribute Values", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "title": "Value defined for each Key", + "description": "Map describing open set of key value pairs which are not composed semantically", + "type": "string" + } + }, + "marketo:bypassTrigger": { + "title": "Bypass Trigger", + "description": "Bypass Trigger", + "type": "integer" + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/activity-marketo-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/activity-log-details" + } + ], + "meta:status": "experimental", + "examples": [] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/marketo/marketo-activity.schema.md b/docs/reference/adobe/experience/marketo/marketo-activity.schema.md new file mode 100644 index 000000000..eeb95a0a1 --- /dev/null +++ b/docs/reference/adobe/experience/marketo/marketo-activity.schema.md @@ -0,0 +1,698 @@ + +# Marketo Activity Log Schema + +``` +https://ns.adobe.com/experience/marketo/activity-marketo-details +``` + +Marketo specific Activity Log Details + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/marketo/marketo-activity.schema.json](adobe/experience/marketo/marketo-activity.schema.json) | +## Schema Hierarchy + +* Marketo Activity Log `https://ns.adobe.com/experience/marketo/activity-marketo-details` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md) `https://ns.adobe.com/xdm/context/activity-log-details` + + +# Marketo Activity Log Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [marketo:activityLog](#marketoactivitylog) | `object` | Optional | Marketo Activity Log (this schema) | +| [xdm:accountID](#xdmaccountid) | `string` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmaccountid) | +| [xdm:activityDescription](#xdmactivitydescription) | `string` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivitydescription) | +| [xdm:activityDueDateTime](#xdmactivityduedatetime) | `string` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivityduedatetime) | +| [xdm:activityEndDateTime](#xdmactivityenddatetime) | `string` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivityenddatetime) | +| [xdm:activityPriority](#xdmactivitypriority) | `string` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivitypriority) | +| [xdm:activityStartDateTime](#xdmactivitystartdatetime) | `string` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivitystartdatetime) | +| [xdm:activityStatus](#xdmactivitystatus) | `string` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivitystatus) | +| [xdm:activitySubject](#xdmactivitysubject) | `string` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivitysubject) | +| [xdm:asset](#xdmasset) | complex | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmasset) | +| [xdm:campaign](#xdmcampaign) | complex | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmcampaign) | +| [xdm:division](#xdmdivision) | `string` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmdivision) | +| [xdm:entity](#xdmentity) | complex | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmentity) | +| [xdm:highPriority](#xdmhighpriority) | `boolean` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmhighpriority) | +| [xdm:interactionEvents](#xdminteractionevents) | complex | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdminteractionevents) | +| [xdm:isCompleted](#xdmiscompleted) | `boolean` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmiscompleted) | +| [xdm:isDeleted](#xdmisdeleted) | `boolean` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmisdeleted) | +| [xdm:isTask](#xdmistask) | `boolean` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmistask) | +| [xdm:ownerID](#xdmownerid) | `string` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmownerid) | +| [xdm:sourceType](#xdmsourcetype) | `string` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmsourcetype) | +| [xdm:userID](#xdmuserid) | `string` | Optional | [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmuserid) | +| `*` | any | Additional | this schema *allows* additional properties | + +## marketo:activityLog + + +`marketo:activityLog` +* is optional +* type: `object` +* defined in this schema + +### marketo:activityLog Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `marketo:activityID`| string | Optional | +| `marketo:attributeValues`| object | Optional | +| `marketo:bypassTrigger`| integer | Optional | + + + +#### marketo:activityID +##### Marketo Activity Unique Identifier + +Marketo Activity Unique identifier. + +`marketo:activityID` +* is optional +* type: `string` + +##### marketo:activityID Type + + +`string` + + + + + + + + +#### marketo:attributeValues +##### Attribute Values + +undefined + +`marketo:attributeValues` +* is optional +* type: `object` + +##### marketo:attributeValues Type + +Unknown type `object`. + +```json +{ + "title": "Attribute Values", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "title": "Value defined for each Key", + "description": "Map describing open set of key value pairs which are not composed semantically", + "type": "string" + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### marketo:bypassTrigger +##### Bypass Trigger + +Bypass Trigger + +`marketo:bypassTrigger` +* is optional +* type: `integer` + +##### marketo:bypassTrigger Type + + +`integer` + + + + + + + + + + + +## xdm:accountID +### Business Account + +Business Account Unique Identifier + +`xdm:accountID` +* is optional +* type: `string` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmaccountid) + +### xdm:accountID Type + + +`string` + + + + + + +## xdm:activityDescription +### Activity description + +Activity self detailed description + +`xdm:activityDescription` +* is optional +* type: `string` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivitydescription) + +### xdm:activityDescription Type + + +`string` + + + + + + +## xdm:activityDueDateTime +### Activity Due date time + +Due date and time by which the activity should complete + +`xdm:activityDueDateTime` +* is optional +* type: `string` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivityduedatetime) + +### xdm:activityDueDateTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:activityEndDateTime +### Activity end date time + +The date and time when the activity in the form of task/business event got completed + +`xdm:activityEndDateTime` +* is optional +* type: `string` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivityenddatetime) + +### xdm:activityEndDateTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:activityPriority +### Activity priority + +Current priority of the activity + +`xdm:activityPriority` +* is optional +* type: `string` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivitypriority) + +### xdm:activityPriority Type + + +`string` + + + + + + +## xdm:activityStartDateTime +### Activity Start date time + +The date and time when the activity in the form of task/business event got started + +`xdm:activityStartDateTime` +* is optional +* type: `string` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivitystartdatetime) + +### xdm:activityStartDateTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:activityStatus +### Activity Status + +Current Status of the activity + +`xdm:activityStatus` +* is optional +* type: `string` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivitystatus) + +### xdm:activityStatus Type + + +`string` + + + + + + +## xdm:activitySubject +### Subject of the activity + +Shortened version of the activityDescription + +`xdm:activitySubject` +* is optional +* type: `string` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmactivitysubject) + +### xdm:activitySubject Type + + +`string` + + + + + + +## xdm:asset +### Object asset + +Asset details for its type and ID + +`xdm:asset` +* is optional +* type: complex +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmasset) + +### xdm:asset Type + +Unknown type ``. + +```json +{ + "title": "Object asset", + "description": "Asset details for its type and ID", + "properties": { + "xdm:type": { + "title": "Asset Type", + "description": "Holds Asset Type", + "type": "string" + }, + "xdm:ID": { + "title": "Asset ID", + "description": "Holds Asset Identifier", + "type": "string" + } + }, + "required": [ + "xdm:type", + "xdm:ID" + ], + "$oSchema": { + "$linkVal": "XDM Business Activity Log details", + "$linkPath": "../../../mixins/activity-log/activity-log-details.schema.md" + }, + "simpletype": "complex" +} +``` + + + + + +## xdm:campaign +### Campaign details + +Campaign amd its relevant associated details + +`xdm:campaign` +* is optional +* type: complex +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmcampaign) + +### xdm:campaign Type + +Unknown type ``. + +```json +{ + "title": "Campaign details", + "description": "Campaign amd its relevant associated details", + "properties": { + "xdm:ID": { + "title": "Campaign ID", + "description": "Unique identifer for Campaign.", + "type": "string" + }, + "xdm:type": { + "title": "Campaign Type", + "description": "The type of campaign for which audience is invited", + "type": "string" + }, + "xdm:member": { + "properties": { + "xdm:type": { + "title": "Member type", + "description": "Whether the Member is a lead or a contact", + "type": "string" + }, + "xdm:ID": { + "title": "ID of the Member", + "description": "Member's ID", + "type": "string" + } + } + }, + "xdm:program": { + "properties": { + "xdm:ID": { + "title": "Program ID associated with the campaign", + "description": "Unique identifer for Campaign.", + "type": "string" + }, + "xdm:type": { + "title": "Program Type", + "description": "The type of program which is associated with the campaign", + "type": "string" + }, + "xdm:step": { + "properties": { + "xdm:number": { + "title": "Workflow step number", + "description": "Program's Workflow Step Number", + "type": "integer" + }, + "xdm:status": { + "title": "Program Workflow Step Status", + "description": "Program's workflow name of the step status", + "type": "string" + } + } + } + } + } + }, + "$oSchema": { + "$linkVal": "XDM Business Activity Log details", + "$linkPath": "../../../mixins/activity-log/activity-log-details.schema.md" + }, + "simpletype": "complex" +} +``` + + + + + +## xdm:division +### Division of Account Enterprise + +name of division of the account + +`xdm:division` +* is optional +* type: `string` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmdivision) + +### xdm:division Type + + +`string` + + + + + + +## xdm:entity +### Entity + +Holds Entity Name and its ID on which activity action is based upon. + +`xdm:entity` +* is optional +* type: complex +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmentity) + +### xdm:entity Type + +Unknown type ``. + +```json +{ + "title": "Entity", + "description": "Holds Entity Name and its ID on which activity action is based upon.", + "properties": { + "xdm:name": { + "title": "Entity Name", + "description": "Holds Entity Name", + "type": "string" + }, + "xdm:ID": { + "title": "Entity tuple ID", + "description": "Holds Entity Tuple's Primary Identifier", + "type": "string" + } + }, + "required": [ + "xdm:name", + "xdm:ID" + ], + "$oSchema": { + "$linkVal": "XDM Business Activity Log details", + "$linkPath": "../../../mixins/activity-log/activity-log-details.schema.md" + }, + "simpletype": "complex" +} +``` + + + + + +## xdm:highPriority +### Activity is a high priority task + +A boolean flag to indicate whether the activity is of high priority + +`xdm:highPriority` +* is optional +* type: `boolean` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmhighpriority) + +### xdm:highPriority Type + + +`boolean` + + + + + +## xdm:interactionEvents +### Interaction Events + +collection of various forms of interactions + +`xdm:interactionEvents` +* is optional +* type: complex +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdminteractionevents) + +### xdm:interactionEvents Type + +Unknown type ``. + +```json +{ + "title": "Interaction Events", + "description": "collection of various forms of interactions", + "properties": { + "xdm:phoneCall": { + "title": "Phone interaction", + "$ref": "https://ns.adobe.com/xdm/common/phoneinteraction", + "description": "Contextual information captured during a given phone conversation" + }, + "xdm:meeting": { + "title": "Meeting", + "description": "Meeting details with location co-ordinates", + "properties": { + "xdm:meetingDetails": { + "title": "Meeting interaction", + "$ref": "https://ns.adobe.com/xdm/common/meetinginteraction", + "description": "Contextual information captured for a online/offline meeting" + }, + "xdm:location": { + "title": "Physical location of the event management if meeting is offline ", + "$ref": "https://ns.adobe.com/xdm/context/place", + "description": "Physical location where the meeting is taking place" + } + } + }, + "xdm:email": { + "title": "Email interaction", + "$ref": "https://ns.adobe.com/xdm/common/emailinteraction", + "description": "Contextual information captured during any given email message" + } + }, + "$oSchema": { + "$linkVal": "XDM Business Activity Log details", + "$linkPath": "../../../mixins/activity-log/activity-log-details.schema.md" + }, + "simpletype": "complex" +} +``` + + + + + +## xdm:isCompleted +### Activity completed or still open to work on + +A boolean flag to indicate whether the activity is completed + +`xdm:isCompleted` +* is optional +* type: `boolean` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmiscompleted) + +### xdm:isCompleted Type + + +`boolean` + + + + + +## xdm:isDeleted +### Activity soft deletion + +A boolean flag to indicate whether the activity is soft deleted + +`xdm:isDeleted` +* is optional +* type: `boolean` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmisdeleted) + +### xdm:isDeleted Type + + +`boolean` + + + + + +## xdm:isTask +### Activity is task or business event + +A boolean flag to represent whether the activity is a task of Event Management + +`xdm:isTask` +* is optional +* type: `boolean` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmistask) + +### xdm:isTask Type + + +`boolean` + + + + + +## xdm:ownerID +### Ownership of the Activity + +The owner which is responsible for completing the task or event management + +`xdm:ownerID` +* is optional +* type: `string` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmownerid) + +### xdm:ownerID Type + + +`string` + + + + + + +## xdm:sourceType +### Activity Source Type + +The upstream source from where the activity record has been syncronized + +`xdm:sourceType` +* is optional +* type: `string` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmsourcetype) + +### xdm:sourceType Type + + +`string` + + + + + + +## xdm:userID +### User who is performing the activity + +The user initiating the activity + +`xdm:userID` +* is optional +* type: `string` +* defined in [XDM Business Activity Log details](../../../mixins/activity-log/activity-log-details.schema.md#xdmuserid) + +### xdm:userID Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/marketo/marketo-contact-lead-person.schema.json b/docs/reference/adobe/experience/marketo/marketo-contact-lead-person.schema.json new file mode 100644 index 000000000..c2c6b7650 --- /dev/null +++ b/docs/reference/adobe/experience/marketo/marketo-contact-lead-person.schema.json @@ -0,0 +1,218 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/marketo/marketo-contact-lead-person", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Marketo Contact/Lead Person Schema", + "type": "object", + "description": "Marketo Person schema for use within B2B space. Includes other Profile mixins like person/work details, opt in/out etc.", + "meta:extensible": true, + "meta:abstract": true, + "definitions": { + "marketo-contact-lead-person": { + "properties": { + "marketo:marketoIntegrationLogID": { + "title": "Marketo Integration Log Id", + "description": "Marketo integration log id.", + "type": "string" + }, + "marketo:anonymousHostname": { + "title": "Anonymous Hostname", + "type": "string" + }, + "marketo:isBlocked": { + "title": "Blocked Indicator", + "type": "boolean" + }, + "marketo:blockedCause": { + "title": "Blocked Cause", + "type": "string" + }, + "marketo:isEmailInvalid": { + "title": "Invalid Email Indicator", + "description": "Indicator whether the email is valid or not.", + "type": "boolean" + }, + "marketo:emailInvalidCause": { + "title": "Email Invalid Cause", + "description": "Reason for invalidity of email.", + "type": "string" + }, + "marketo:employeePositionID": { + "title": "Employee Position Id", + "type": "string" + }, + "marketo:inferredAddress": { + "title": "Inferred Address", + "description": "Address details inferred by reverse IP lookup of the lead’s first recorded web visit.", + "$ref": "https://ns.adobe.com/xdm/common/address" + }, + "marketo:inferredCompany": { + "title": "Inferred Company", + "description": "Company name inferred by reverse IP lookup of the lead’s first recorded web visit.", + "type": "string" + }, + "marketo:inferredCompanyStatus": { + "title": "Inferred Company Status", + "description": "Status of the company name inferred by reverse IP lookup of the lead’s first recorded web visit.", + "type": "string" + }, + "marketo:inferredMetropolitanArea": { + "title": "Inferred Metropolitan Area", + "description": "Metropolitan area inferred by reverse IP lookup of lead’s first recorded web visit.", + "type": "string" + }, + "marketo:inferredPhoneAreaCode": { + "title": "Inferred Phone Area Code", + "description": "Phone area code inferred by reverse IP lookup of lead’s first recorded web visit.", + "type": "string" + }, + "marketo:isAnonymous": { + "title": "Anonymous Indicator", + "description": "Anonymous status of lead record. System managed.", + "type": "boolean" + }, + "marketo:isCustomer": { + "title": "Customer Indicator", + "type": "boolean" + }, + "marketo:isEmployee": { + "title": "Employee Indicator", + "description": "Indicator if the contact/lead is an employee or not.", + "type": "boolean" + }, + "marketo:isPartner": { + "title": "Partner Indicator", + "description": "Indicator if the contact/lead is a partner or not.", + "type": "boolean" + }, + "marketo:isPrivate": { + "title": "Private Indicator", + "type": "boolean" + }, + "marketo:accountID": { + "title": "Marketo Account id", + "description": "Unique indentier for Marketo account.", + "type": "string" + }, + "marketo:marketingSuspended": { + "title": "Marketing Suspended", + "type": "boolean" + }, + "marketo:marketingSuspendedCause": { + "title": "Marketing Suspended Cause", + "type": "string" + }, + "marketo:notes": { + "title": "Notes", + "type": "string" + }, + "marketo:orgID": { + "title": "Organization ID", + "description": "Identifier of the Organization.", + "type": "string" + }, + "marketo:primaryLeadInterestID": { + "title": "Primary Lead Interest Id", + "type": "boolean" + }, + "marketo:registerSourceInfo": { + "title": "Register Source Info", + "type": "string" + }, + "marketo:registerSourceType": { + "title": "Register Source Type", + "type": "string" + }, + "marketo:salesContactOwnerID": { + "title": "Sales Contact Owner Id", + "type": "string" + }, + "marketo:originalReferrer": { + "title": "Original Referrer", + "description": "The original referrer is typically the page that leads to a form fill out.", + "type": "string" + }, + "marketo:originalSearchEngine": { + "title": "Original Search Engine", + "description": "Search engine that the original referrer used.", + "type": "string" + }, + "marketo:originalSearchPhrase": { + "title": "Original Search Phrase", + "description": "Search phrase used by the original referrer.", + "type": "string" + }, + "marketo:originalSourceInfo": { + "title": "Original Source Info", + "type": "string" + }, + "marketo:originalSourceType": { + "title": "Original Source Type", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/marketo-contact-lead-person" + } + ], + "meta:status": "experimental", + "examples": [ + { + "marketo:marketoIntegrationLogID": "ABC1111", + "marketo:anonymousHostname": "", + "marketo:isBlocked": false, + "marketo:blockedCause": "", + "marketo:isEmailInvalid": false, + "marketo:emailInvalidCause": "", + "marketo:employeePositionID": "", + "marketo:inferredAddress": { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": true, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + }, + "marketo:inferredCompany": "", + "marketo:inferredCompanyStatus": "", + "marketo:inferredMetropolitanArea": "", + "marketo:inferredPhoneAreaCode": "", + "marketo:isAnonymous": false, + "marketo:isCustomer": false, + "marketo:isEmployee": false, + "marketo:isPartner": true, + "marketo:isPrivate": false, + "marketo:accountID": "", + "marketo:marketingSuspended": false, + "marketo:marketingSuspendedCause": "", + "marketo:notes": "", + "marketo:orgID": "", + "marketo:primaryLeadInterestID": false, + "marketo:registerSourceInfo": "", + "marketo:registerSourceType": "", + "marketo:salesContactOwnerID": "", + "marketo:originalReferrer": "", + "marketo:originalSearchEngine": "", + "marketo:originalSearchPhrase": "", + "marketo:originalSourceInfo": "", + "marketo:originalSourceType": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/marketo/marketo-contact-lead-person.schema.md b/docs/reference/adobe/experience/marketo/marketo-contact-lead-person.schema.md new file mode 100644 index 000000000..1c4ea1d29 --- /dev/null +++ b/docs/reference/adobe/experience/marketo/marketo-contact-lead-person.schema.md @@ -0,0 +1,685 @@ + +# Marketo Contact/Lead Person Schema Schema + +``` +https://ns.adobe.com/experience/marketo/marketo-contact-lead-person +``` + +Marketo Person schema for use within B2B space. Includes other Profile mixins like person/work details, opt in/out etc. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/marketo/marketo-contact-lead-person.schema.json](adobe/experience/marketo/marketo-contact-lead-person.schema.json) | +## Schema Hierarchy + +* Marketo Contact/Lead Person Schema `https://ns.adobe.com/experience/marketo/marketo-contact-lead-person` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Postal address](../../../datatypes/address.schema.md) `https://ns.adobe.com/xdm/common/address` + + +## Marketo Contact/Lead Person Schema Example +```json +{ + "marketo:marketoIntegrationLogID": "ABC1111", + "marketo:anonymousHostname": "", + "marketo:isBlocked": false, + "marketo:blockedCause": "", + "marketo:isEmailInvalid": false, + "marketo:emailInvalidCause": "", + "marketo:employeePositionID": "", + "marketo:inferredAddress": { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": true, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + }, + "marketo:inferredCompany": "", + "marketo:inferredCompanyStatus": "", + "marketo:inferredMetropolitanArea": "", + "marketo:inferredPhoneAreaCode": "", + "marketo:isAnonymous": false, + "marketo:isCustomer": false, + "marketo:isEmployee": false, + "marketo:isPartner": true, + "marketo:isPrivate": false, + "marketo:accountID": "", + "marketo:marketingSuspended": false, + "marketo:marketingSuspendedCause": "", + "marketo:notes": "", + "marketo:orgID": "", + "marketo:primaryLeadInterestID": false, + "marketo:registerSourceInfo": "", + "marketo:registerSourceType": "", + "marketo:salesContactOwnerID": "", + "marketo:originalReferrer": "", + "marketo:originalSearchEngine": "", + "marketo:originalSearchPhrase": "", + "marketo:originalSourceInfo": "", + "marketo:originalSourceType": "" +} +``` + +# Marketo Contact/Lead Person Schema Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [marketo:accountID](#marketoaccountid) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:anonymousHostname](#marketoanonymoushostname) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:blockedCause](#marketoblockedcause) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:emailInvalidCause](#marketoemailinvalidcause) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:employeePositionID](#marketoemployeepositionid) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:inferredAddress](#marketoinferredaddress) | Postal address | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:inferredCompany](#marketoinferredcompany) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:inferredCompanyStatus](#marketoinferredcompanystatus) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:inferredMetropolitanArea](#marketoinferredmetropolitanarea) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:inferredPhoneAreaCode](#marketoinferredphoneareacode) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:isAnonymous](#marketoisanonymous) | `boolean` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:isBlocked](#marketoisblocked) | `boolean` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:isCustomer](#marketoiscustomer) | `boolean` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:isEmailInvalid](#marketoisemailinvalid) | `boolean` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:isEmployee](#marketoisemployee) | `boolean` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:isPartner](#marketoispartner) | `boolean` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:isPrivate](#marketoisprivate) | `boolean` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:marketingSuspended](#marketomarketingsuspended) | `boolean` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:marketingSuspendedCause](#marketomarketingsuspendedcause) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:marketoIntegrationLogID](#marketomarketointegrationlogid) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:notes](#marketonotes) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:orgID](#marketoorgid) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:originalReferrer](#marketooriginalreferrer) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:originalSearchEngine](#marketooriginalsearchengine) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:originalSearchPhrase](#marketooriginalsearchphrase) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:originalSourceInfo](#marketooriginalsourceinfo) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:originalSourceType](#marketooriginalsourcetype) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:primaryLeadInterestID](#marketoprimaryleadinterestid) | `boolean` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:registerSourceInfo](#marketoregistersourceinfo) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:registerSourceType](#marketoregistersourcetype) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| [marketo:salesContactOwnerID](#marketosalescontactownerid) | `string` | Optional | Marketo Contact/Lead Person Schema (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## marketo:accountID +### Marketo Account id + +Unique indentier for Marketo account. + +`marketo:accountID` +* is optional +* type: `string` +* defined in this schema + +### marketo:accountID Type + + +`string` + + + + + + +## marketo:anonymousHostname +### Anonymous Hostname + +`marketo:anonymousHostname` +* is optional +* type: `string` +* defined in this schema + +### marketo:anonymousHostname Type + + +`string` + + + + + + +## marketo:blockedCause +### Blocked Cause + +`marketo:blockedCause` +* is optional +* type: `string` +* defined in this schema + +### marketo:blockedCause Type + + +`string` + + + + + + +## marketo:emailInvalidCause +### Email Invalid Cause + +Reason for invalidity of email. + +`marketo:emailInvalidCause` +* is optional +* type: `string` +* defined in this schema + +### marketo:emailInvalidCause Type + + +`string` + + + + + + +## marketo:employeePositionID +### Employee Position Id + +`marketo:employeePositionID` +* is optional +* type: `string` +* defined in this schema + +### marketo:employeePositionID Type + + +`string` + + + + + + +## marketo:inferredAddress +### Inferred Address + +Address details inferred by reverse IP lookup of the lead’s first recorded web visit. + +`marketo:inferredAddress` +* is optional +* type: Postal address +* defined in this schema + +### marketo:inferredAddress Type + + +* [Postal address](../../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + +## marketo:inferredCompany +### Inferred Company + +Company name inferred by reverse IP lookup of the lead’s first recorded web visit. + +`marketo:inferredCompany` +* is optional +* type: `string` +* defined in this schema + +### marketo:inferredCompany Type + + +`string` + + + + + + +## marketo:inferredCompanyStatus +### Inferred Company Status + +Status of the company name inferred by reverse IP lookup of the lead’s first recorded web visit. + +`marketo:inferredCompanyStatus` +* is optional +* type: `string` +* defined in this schema + +### marketo:inferredCompanyStatus Type + + +`string` + + + + + + +## marketo:inferredMetropolitanArea +### Inferred Metropolitan Area + +Metropolitan area inferred by reverse IP lookup of lead’s first recorded web visit. + +`marketo:inferredMetropolitanArea` +* is optional +* type: `string` +* defined in this schema + +### marketo:inferredMetropolitanArea Type + + +`string` + + + + + + +## marketo:inferredPhoneAreaCode +### Inferred Phone Area Code + +Phone area code inferred by reverse IP lookup of lead’s first recorded web visit. + +`marketo:inferredPhoneAreaCode` +* is optional +* type: `string` +* defined in this schema + +### marketo:inferredPhoneAreaCode Type + + +`string` + + + + + + +## marketo:isAnonymous +### Anonymous Indicator + +Anonymous status of lead record. System managed. + +`marketo:isAnonymous` +* is optional +* type: `boolean` +* defined in this schema + +### marketo:isAnonymous Type + + +`boolean` + + + + + +## marketo:isBlocked +### Blocked Indicator + +`marketo:isBlocked` +* is optional +* type: `boolean` +* defined in this schema + +### marketo:isBlocked Type + + +`boolean` + + + + + +## marketo:isCustomer +### Customer Indicator + +`marketo:isCustomer` +* is optional +* type: `boolean` +* defined in this schema + +### marketo:isCustomer Type + + +`boolean` + + + + + +## marketo:isEmailInvalid +### Invalid Email Indicator + +Indicator whether the email is valid or not. + +`marketo:isEmailInvalid` +* is optional +* type: `boolean` +* defined in this schema + +### marketo:isEmailInvalid Type + + +`boolean` + + + + + +## marketo:isEmployee +### Employee Indicator + +Indicator if the contact/lead is an employee or not. + +`marketo:isEmployee` +* is optional +* type: `boolean` +* defined in this schema + +### marketo:isEmployee Type + + +`boolean` + + + + + +## marketo:isPartner +### Partner Indicator + +Indicator if the contact/lead is a partner or not. + +`marketo:isPartner` +* is optional +* type: `boolean` +* defined in this schema + +### marketo:isPartner Type + + +`boolean` + + + + + +## marketo:isPrivate +### Private Indicator + +`marketo:isPrivate` +* is optional +* type: `boolean` +* defined in this schema + +### marketo:isPrivate Type + + +`boolean` + + + + + +## marketo:marketingSuspended +### Marketing Suspended + +`marketo:marketingSuspended` +* is optional +* type: `boolean` +* defined in this schema + +### marketo:marketingSuspended Type + + +`boolean` + + + + + +## marketo:marketingSuspendedCause +### Marketing Suspended Cause + +`marketo:marketingSuspendedCause` +* is optional +* type: `string` +* defined in this schema + +### marketo:marketingSuspendedCause Type + + +`string` + + + + + + +## marketo:marketoIntegrationLogID +### Marketo Integration Log Id + +Marketo integration log id. + +`marketo:marketoIntegrationLogID` +* is optional +* type: `string` +* defined in this schema + +### marketo:marketoIntegrationLogID Type + + +`string` + + + + + + +## marketo:notes +### Notes + +`marketo:notes` +* is optional +* type: `string` +* defined in this schema + +### marketo:notes Type + + +`string` + + + + + + +## marketo:orgID +### Organization ID + +Identifier of the Organization. + +`marketo:orgID` +* is optional +* type: `string` +* defined in this schema + +### marketo:orgID Type + + +`string` + + + + + + +## marketo:originalReferrer +### Original Referrer + +The original referrer is typically the page that leads to a form fill out. + +`marketo:originalReferrer` +* is optional +* type: `string` +* defined in this schema + +### marketo:originalReferrer Type + + +`string` + + + + + + +## marketo:originalSearchEngine +### Original Search Engine + +Search engine that the original referrer used. + +`marketo:originalSearchEngine` +* is optional +* type: `string` +* defined in this schema + +### marketo:originalSearchEngine Type + + +`string` + + + + + + +## marketo:originalSearchPhrase +### Original Search Phrase + +Search phrase used by the original referrer. + +`marketo:originalSearchPhrase` +* is optional +* type: `string` +* defined in this schema + +### marketo:originalSearchPhrase Type + + +`string` + + + + + + +## marketo:originalSourceInfo +### Original Source Info + +`marketo:originalSourceInfo` +* is optional +* type: `string` +* defined in this schema + +### marketo:originalSourceInfo Type + + +`string` + + + + + + +## marketo:originalSourceType +### Original Source Type + +`marketo:originalSourceType` +* is optional +* type: `string` +* defined in this schema + +### marketo:originalSourceType Type + + +`string` + + + + + + +## marketo:primaryLeadInterestID +### Primary Lead Interest Id + +`marketo:primaryLeadInterestID` +* is optional +* type: `boolean` +* defined in this schema + +### marketo:primaryLeadInterestID Type + + +`boolean` + + + + + +## marketo:registerSourceInfo +### Register Source Info + +`marketo:registerSourceInfo` +* is optional +* type: `string` +* defined in this schema + +### marketo:registerSourceInfo Type + + +`string` + + + + + + +## marketo:registerSourceType +### Register Source Type + +`marketo:registerSourceType` +* is optional +* type: `string` +* defined in this schema + +### marketo:registerSourceType Type + + +`string` + + + + + + +## marketo:salesContactOwnerID +### Sales Contact Owner Id + +`marketo:salesContactOwnerID` +* is optional +* type: `string` +* defined in this schema + +### marketo:salesContactOwnerID Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/marketo/marketo-contact.schema.json b/docs/reference/adobe/experience/marketo/marketo-contact.schema.json new file mode 100644 index 000000000..488a48cd8 --- /dev/null +++ b/docs/reference/adobe/experience/marketo/marketo-contact.schema.json @@ -0,0 +1,241 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/marketo/marketo-contact", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Marketo Contact", + "type": "object", + "description": "Marketo Contact schema for use with B2B Accounts and Opportunities. Includes other Profile mixins like person/work details, opt in/out etc.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/profile-contact-crm" + ], + "definitions": { + "marketo-contact": { + "properties": { + "marketo:contactID": { + "title": "Marketo Contact/Lead Id", + "description": "Unique identifier for Marketo contact/lead.", + "type": "string" + }, + "marketo:instanceID": { + "title": "Instance Id", + "description": "Identifier for the Source Marketo Instance.", + "type": "string" + }, + "marketo:extendedContact": { + "title": "Extended Marketo Contact Attributes", + "$ref": "https://ns.adobe.com/experience/marketo/marketo-contact-lead-person" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/profile-contact-crm" + }, + { + "$ref": "#/definitions/marketo-contact" + } + ], + "required": [ + "marketo:contactID" + ], + "meta:status": "experimental", + "examples": [ + { + "marketo:contactID": "MKTCNTCT1111", + "marketo:instanceID": "111222333", + "marketo:marketoIntegrationLogID": "ABC1111", + "marketo:anonymousHostname": "", + "marketo:isBlocked": false, + "marketo:blockedCause": "", + "marketo:isEmailInvalid": false, + "marketo:emailInvalidCause": "", + "marketo:employeePositionID": "", + "marketo:inferredAddress": { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": true, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + }, + "marketo:inferredCompany": "", + "marketo:inferredCompanyStatus": "", + "marketo:inferredMetropolitanArea": "", + "marketo:inferredPhoneAreaCode": "", + "marketo:isAnonymous": false, + "marketo:isCustomer": false, + "marketo:isEmployee": false, + "marketo:isPartner": true, + "marketo:isPrivate": false, + "marketo:accountID": "", + "marketo:marketingSuspended": false, + "marketo:marketingSuspendedCause": "", + "marketo:notes": "", + "marketo:orgID": "", + "marketo:primaryLeadInterestID": false, + "marketo:registerSourceInfo": "", + "marketo:registerSourceType": "", + "marketo:salesContactOwnerID": "", + "marketo:originalReferrer": "", + "marketo:originalSearchEngine": "", + "marketo:originalSearchPhrase": "", + "marketo:originalSourceInfo": "", + "marketo:originalSourceType": "", + "xdm:contact": { + "xdm:ID": "11110000", + "xdm:accountID": "", + "xdm:leadSource": "Lead Source", + "xdm:extendedContact": { + "xdm:type": "", + "xdm:ownerID": "", + "xdm:isDeleted": false, + "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00", + "xdm:emailBouncedReason": "Bounced Reason Here", + "xdm:isEmailBounced": true, + "xdm:description": "Contact/Lead description here", + "xdm:status": "Status", + "xdm:timezone": "", + "xdm:jigsaw": "12345" + }, + "xdm:identityMap": { + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:preferences": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false, + "xdm:optOutDetails": { + "xdm:email": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:phone": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + } + } + }, + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-20T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-20T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDate": "1996-10-28", + "xdm:homePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:workAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + }, + "xdm:workEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active" + }, + "xdm:workPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:otherAddress": { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": false, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "xdm:otherPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + }, + "xdm:extendedWorkDetails": { + "xdm:assistantDetails": { + "xdm:name": { + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" + }, + "xdm:phone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + } + }, + "xdm:reportsToID": "RPT10000", + "xdm:departments": [ + "Finance", + "Marketing" + ], + "xdm:jobTitle": "", + "xdm:photoUrl": "https://PersonOrg.com/personPhoto.jpg" + }, + "xdm:photoUrl": "https://PersonOrg.com/personPhoto.jpg", + "xdm:orgUnit": { + "@id": "https://data.adobe.io/org-apparals-men" + }, + "xdm:geoUnit": { + "@id": "https://data.adobe.io/geo-france" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/marketo/marketo-contact.schema.md b/docs/reference/adobe/experience/marketo/marketo-contact.schema.md new file mode 100644 index 000000000..1680af260 --- /dev/null +++ b/docs/reference/adobe/experience/marketo/marketo-contact.schema.md @@ -0,0 +1,294 @@ + +# Marketo Contact Schema + +``` +https://ns.adobe.com/experience/marketo/marketo-contact +``` + +Marketo Contact schema for use with B2B Accounts and Opportunities. Includes other Profile mixins like person/work details, opt in/out etc. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/marketo/marketo-contact.schema.json](adobe/experience/marketo/marketo-contact.schema.json) | +## Schema Hierarchy + +* Marketo Contact `https://ns.adobe.com/experience/marketo/marketo-contact` + * [XDM Business Contact](../../../mixins/profile/profile-contact-crm.schema.md) `https://ns.adobe.com/xdm/context/profile-contact-crm` + * [Marketo Contact/Lead Person Schema](marketo-contact-lead-person.schema.md) `https://ns.adobe.com/experience/marketo/marketo-contact-lead-person` + + +## Marketo Contact Example +```json +{ + "marketo:contactID": "MKTCNTCT1111", + "marketo:instanceID": "111222333", + "marketo:marketoIntegrationLogID": "ABC1111", + "marketo:anonymousHostname": "", + "marketo:isBlocked": false, + "marketo:blockedCause": "", + "marketo:isEmailInvalid": false, + "marketo:emailInvalidCause": "", + "marketo:employeePositionID": "", + "marketo:inferredAddress": { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": true, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + }, + "marketo:inferredCompany": "", + "marketo:inferredCompanyStatus": "", + "marketo:inferredMetropolitanArea": "", + "marketo:inferredPhoneAreaCode": "", + "marketo:isAnonymous": false, + "marketo:isCustomer": false, + "marketo:isEmployee": false, + "marketo:isPartner": true, + "marketo:isPrivate": false, + "marketo:accountID": "", + "marketo:marketingSuspended": false, + "marketo:marketingSuspendedCause": "", + "marketo:notes": "", + "marketo:orgID": "", + "marketo:primaryLeadInterestID": false, + "marketo:registerSourceInfo": "", + "marketo:registerSourceType": "", + "marketo:salesContactOwnerID": "", + "marketo:originalReferrer": "", + "marketo:originalSearchEngine": "", + "marketo:originalSearchPhrase": "", + "marketo:originalSourceInfo": "", + "marketo:originalSourceType": "", + "xdm:contact": { + "xdm:ID": "11110000", + "xdm:accountID": "", + "xdm:leadSource": "Lead Source", + "xdm:extendedContact": { + "xdm:type": "", + "xdm:ownerID": "", + "xdm:isDeleted": false, + "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00", + "xdm:emailBouncedReason": "Bounced Reason Here", + "xdm:isEmailBounced": true, + "xdm:description": "Contact/Lead description here", + "xdm:status": "Status", + "xdm:timezone": "", + "xdm:jigsaw": "12345" + }, + "xdm:identityMap": { + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:preferences": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false, + "xdm:optOutDetails": { + "xdm:email": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:phone": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + } + } + }, + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-20T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-20T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDate": "1996-10-28", + "xdm:homePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:workAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + }, + "xdm:workEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active" + }, + "xdm:workPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:otherAddress": { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": false, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "xdm:otherPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + }, + "xdm:extendedWorkDetails": { + "xdm:assistantDetails": { + "xdm:name": { + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" + }, + "xdm:phone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + } + }, + "xdm:reportsToID": "RPT10000", + "xdm:departments": [ + "Finance", + "Marketing" + ], + "xdm:jobTitle": "", + "xdm:photoUrl": "https://PersonOrg.com/personPhoto.jpg" + }, + "xdm:photoUrl": "https://PersonOrg.com/personPhoto.jpg", + "xdm:orgUnit": { + "@id": "https://data.adobe.io/org-apparals-men" + }, + "xdm:geoUnit": { + "@id": "https://data.adobe.io/geo-france" + } +} +``` + +# Marketo Contact Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [marketo:contactID](#marketocontactid) | `string` | **Required** | Marketo Contact (this schema) | +| [marketo:extendedContact](#marketoextendedcontact) | Marketo Contact/Lead Person Schema | Optional | Marketo Contact (this schema) | +| [marketo:instanceID](#marketoinstanceid) | `string` | Optional | Marketo Contact (this schema) | +| [xdm:contact](#xdmcontact) | B2B Contact | Optional | [XDM Business Contact](../../../mixins/profile/profile-contact-crm.schema.md#xdmcontact) | +| `*` | any | Additional | this schema *allows* additional properties | + +## marketo:contactID +### Marketo Contact/Lead Id + +Unique identifier for Marketo contact/lead. + +`marketo:contactID` +* is **required** +* type: `string` +* defined in this schema + +### marketo:contactID Type + + +`string` + + + + + + +## marketo:extendedContact +### Extended Marketo Contact Attributes + +`marketo:extendedContact` +* is optional +* type: Marketo Contact/Lead Person Schema +* defined in this schema + +### marketo:extendedContact Type + + +* [Marketo Contact/Lead Person Schema](marketo-contact-lead-person.schema.md) – `https://ns.adobe.com/experience/marketo/marketo-contact-lead-person` + + + + + +## marketo:instanceID +### Instance Id + +Identifier for the Source Marketo Instance. + +`marketo:instanceID` +* is optional +* type: `string` +* defined in this schema + +### marketo:instanceID Type + + +`string` + + + + + + +## xdm:contact +### Contact Details + +Holds properties for a person to be recognized as a contact in the business-to-business space. + +`xdm:contact` +* is optional +* type: B2B Contact +* defined in [XDM Business Contact](../../../mixins/profile/profile-contact-crm.schema.md#xdmcontact) + +### xdm:contact Type + + +* [B2B Contact](../../../datatypes/b2b-contact.schema.md) – `https://ns.adobe.com/xdm/common/b2b-contact` + + + + diff --git a/docs/reference/adobe/experience/marketo/marketo-lead.schema.json b/docs/reference/adobe/experience/marketo/marketo-lead.schema.json new file mode 100644 index 000000000..b4d77dc64 --- /dev/null +++ b/docs/reference/adobe/experience/marketo/marketo-lead.schema.json @@ -0,0 +1,82 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/marketo/marketo-lead", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Marketo Lead", + "type": "object", + "description": "Marketo Lead schema. Includes other Profile mixins like person/work details, opt in/out etc.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/profile-lead-crm" + ], + "definitions": { + "marketo-lead": { + "properties": { + "marketo:leadID": { + "title": "Marketo Lead ID", + "description": "Unique identifier for Marketo lead.", + "type": "string" + }, + "marketo:instanceID": { + "title": "Instance Id", + "description": "Identifier of the Marketo instance.", + "type": "string" + }, + "marketo:contactID": { + "title": "Marketo Contact Id", + "description": "Unique identifier for Marketo contact.", + "type": "string" + }, + "marketo:accountID": { + "title": "Marketo Account Id", + "description": "Unique identifier for Marketo account.", + "type": "string" + }, + "marketo:abmProposedNameID": { + "title": "ABM Proposed Name Id", + "description": "Account based marketing proposed name id.", + "type": "string" + }, + "marketo:count": { + "title": "Count", + "type": "integer" + }, + "marketo:totalProposedNameCount": { + "title": "Total Proposed Name Count", + "type": "integer" + }, + "marketo:leadScore": { + "title": "Lead Score", + "description": "Computed score associated with the lead.", + "type": "number" + }, + "marketo:extendedLead": { + "title": "Extended Marketo Lead Attributes", + "$ref": "https://ns.adobe.com/experience/marketo/marketo-contact-lead-person" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/profile-lead-crm" + }, + { + "$ref": "#/definitions/marketo-lead" + } + ], + "required": [ + "marketo:leadID" + ], + "meta:status": "experimental", + "examples": [] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/marketo/marketo-lead.schema.md b/docs/reference/adobe/experience/marketo/marketo-lead.schema.md new file mode 100644 index 000000000..7a3362b7f --- /dev/null +++ b/docs/reference/adobe/experience/marketo/marketo-lead.schema.md @@ -0,0 +1,226 @@ + +# Marketo Lead Schema + +``` +https://ns.adobe.com/experience/marketo/marketo-lead +``` + +Marketo Lead schema. Includes other Profile mixins like person/work details, opt in/out etc. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/marketo/marketo-lead.schema.json](adobe/experience/marketo/marketo-lead.schema.json) | +## Schema Hierarchy + +* Marketo Lead `https://ns.adobe.com/experience/marketo/marketo-lead` + * [XDM Business Lead ](../../../mixins/profile/profile-lead-crm.schema.md) `https://ns.adobe.com/xdm/context/profile-lead-crm` + * [Marketo Contact/Lead Person Schema](marketo-contact-lead-person.schema.md) `https://ns.adobe.com/experience/marketo/marketo-contact-lead-person` + + +# Marketo Lead Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [marketo:abmProposedNameID](#marketoabmproposednameid) | `string` | Optional | Marketo Lead (this schema) | +| [marketo:accountID](#marketoaccountid) | `string` | Optional | Marketo Lead (this schema) | +| [marketo:contactID](#marketocontactid) | `string` | Optional | Marketo Lead (this schema) | +| [marketo:count](#marketocount) | `integer` | Optional | Marketo Lead (this schema) | +| [marketo:extendedLead](#marketoextendedlead) | Marketo Contact/Lead Person Schema | Optional | Marketo Lead (this schema) | +| [marketo:instanceID](#marketoinstanceid) | `string` | Optional | Marketo Lead (this schema) | +| [marketo:leadID](#marketoleadid) | `string` | **Required** | Marketo Lead (this schema) | +| [marketo:leadScore](#marketoleadscore) | `number` | Optional | Marketo Lead (this schema) | +| [marketo:totalProposedNameCount](#marketototalproposednamecount) | `integer` | Optional | Marketo Lead (this schema) | +| [xdm:lead](#xdmlead) | B2B Lead | Optional | [XDM Business Lead ](../../../mixins/profile/profile-lead-crm.schema.md#xdmlead) | +| `*` | any | Additional | this schema *allows* additional properties | + +## marketo:abmProposedNameID +### ABM Proposed Name Id + +Account based marketing proposed name id. + +`marketo:abmProposedNameID` +* is optional +* type: `string` +* defined in this schema + +### marketo:abmProposedNameID Type + + +`string` + + + + + + +## marketo:accountID +### Marketo Account Id + +Unique identifier for Marketo account. + +`marketo:accountID` +* is optional +* type: `string` +* defined in this schema + +### marketo:accountID Type + + +`string` + + + + + + +## marketo:contactID +### Marketo Contact Id + +Unique identifier for Marketo contact. + +`marketo:contactID` +* is optional +* type: `string` +* defined in this schema + +### marketo:contactID Type + + +`string` + + + + + + +## marketo:count +### Count + +`marketo:count` +* is optional +* type: `integer` +* defined in this schema + +### marketo:count Type + + +`integer` + + + + + + +## marketo:extendedLead +### Extended Marketo Lead Attributes + +`marketo:extendedLead` +* is optional +* type: Marketo Contact/Lead Person Schema +* defined in this schema + +### marketo:extendedLead Type + + +* [Marketo Contact/Lead Person Schema](marketo-contact-lead-person.schema.md) – `https://ns.adobe.com/experience/marketo/marketo-contact-lead-person` + + + + + +## marketo:instanceID +### Instance Id + +Identifier of the Marketo instance. + +`marketo:instanceID` +* is optional +* type: `string` +* defined in this schema + +### marketo:instanceID Type + + +`string` + + + + + + +## marketo:leadID +### Marketo Lead ID + +Unique identifier for Marketo lead. + +`marketo:leadID` +* is **required** +* type: `string` +* defined in this schema + +### marketo:leadID Type + + +`string` + + + + + + +## marketo:leadScore +### Lead Score + +Computed score associated with the lead. + +`marketo:leadScore` +* is optional +* type: `number` +* defined in this schema + +### marketo:leadScore Type + + +`number` + + + + + + +## marketo:totalProposedNameCount +### Total Proposed Name Count + +`marketo:totalProposedNameCount` +* is optional +* type: `integer` +* defined in this schema + +### marketo:totalProposedNameCount Type + + +`integer` + + + + + + +## xdm:lead +### Lead Details + +Holds properties for a person to be recognized as a lead in the business-to-business space. + +`xdm:lead` +* is optional +* type: B2B Lead +* defined in [XDM Business Lead ](../../../mixins/profile/profile-lead-crm.schema.md#xdmlead) + +### xdm:lead Type + + +* [B2B Lead](../../../datatypes/b2b-lead.schema.md) – `https://ns.adobe.com/xdm/common/b2b-lead` + + + + diff --git a/docs/reference/adobe/experience/marketo/opportunity-marketo.schema.json b/docs/reference/adobe/experience/marketo/opportunity-marketo.schema.json new file mode 100644 index 000000000..0d8c79ef1 --- /dev/null +++ b/docs/reference/adobe/experience/marketo/opportunity-marketo.schema.json @@ -0,0 +1,52 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/marketo/opportunity-marketo", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Marketo Opportunity", + "type": "object", + "meta:extensible": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/opportunity" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/opportunity-crm" + ], + "description": "Marketo specific Opportunity properties.", + "definitions": { + "opportunity-marketo": { + "properties": { + "marketo:opportunityID": { + "title": "Marketo Opportunity ID", + "description": "Marketo opportunity ID.", + "type": "string" + }, + "marketo:instanceID": { + "title": "Instance ID", + "description": "Instance identifier.", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/opportunity-crm" + }, + { + "$ref": "#/definitions/opportunity-marketo" + } + ], + "required": [ + "marketo:opportunityID" + ], + "meta:status": "experimental", + "examples": [] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/marketo/opportunity-marketo.schema.md b/docs/reference/adobe/experience/marketo/opportunity-marketo.schema.md new file mode 100644 index 000000000..d1ae3e526 --- /dev/null +++ b/docs/reference/adobe/experience/marketo/opportunity-marketo.schema.md @@ -0,0 +1,566 @@ + +# Marketo Opportunity Schema + +``` +https://ns.adobe.com/experience/marketo/opportunity-marketo +``` + +Marketo specific Opportunity properties. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/marketo/opportunity-marketo.schema.json](adobe/experience/marketo/opportunity-marketo.schema.json) | +## Schema Hierarchy + +* Marketo Opportunity `https://ns.adobe.com/experience/marketo/opportunity-marketo` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md) `https://ns.adobe.com/xdm/context/opportunity-crm` + + +# Marketo Opportunity Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [marketo:instanceID](#marketoinstanceid) | `string` | Optional | | Marketo Opportunity (this schema) | +| [marketo:opportunityID](#marketoopportunityid) | `string` | **Required** | | Marketo Opportunity (this schema) | +| [xdm:amount](#xdmamount) | `number` | Optional | `0` | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmamount) | +| [xdm:closeDate](#xdmclosedate) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmclosedate) | +| [xdm:contractID](#xdmcontractid) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmcontractid) | +| [xdm:currencyCode](#xdmcurrencycode) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmcurrencycode) | +| [xdm:expectedRevenue](#xdmexpectedrevenue) | `number` | Optional | `0` | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmexpectedrevenue) | +| [xdm:fiscalQuarter](#xdmfiscalquarter) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmfiscalquarter) | +| [xdm:fiscalYear](#xdmfiscalyear) | `integer` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmfiscalyear) | +| [xdm:forecastCategory](#xdmforecastcategory) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmforecastcategory) | +| [xdm:forecastCategoryName](#xdmforecastcategoryname) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmforecastcategoryname) | +| [xdm:hasOpportunityLineItem](#xdmhasopportunitylineitem) | `boolean` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmhasopportunitylineitem) | +| [xdm:isClosed](#xdmisclosed) | `boolean` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmisclosed) | +| [xdm:isDeleted](#xdmisdeleted) | `boolean` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmisdeleted) | +| [xdm:isPrivate](#xdmisprivate) | `boolean` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmisprivate) | +| [xdm:isWon](#xdmiswon) | `boolean` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmiswon) | +| [xdm:leadSource](#xdmleadsource) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmleadsource) | +| [xdm:nextStep](#xdmnextstep) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmnextstep) | +| [xdm:opportunityDescription](#xdmopportunitydescription) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmopportunitydescription) | +| [xdm:opportunityName](#xdmopportunityname) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmopportunityname) | +| [xdm:ownerID](#xdmownerid) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmownerid) | +| [xdm:probabilityPercentage](#xdmprobabilitypercentage) | `integer` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmprobabilitypercentage) | +| [xdm:quantity](#xdmquantity) | `integer` | Optional | `0` | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmquantity) | +| [xdm:sourceType](#xdmsourcetype) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmsourcetype) | +| [xdm:stage](#xdmstage) | `string` | Optional | | [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmstage) | +| `*` | any | Additional | this schema *allows* additional properties | + +## marketo:instanceID +### Instance ID + +Instance identifier. + +`marketo:instanceID` +* is optional +* type: `string` +* defined in this schema + +### marketo:instanceID Type + + +`string` + + + + + + +## marketo:opportunityID +### Marketo Opportunity ID + +Marketo opportunity ID. + +`marketo:opportunityID` +* is **required** +* type: `string` +* defined in this schema + +### marketo:opportunityID Type + + +`string` + + + + + + +## xdm:amount +### Opportunity Amount + +Estimated total sale amount. + +`xdm:amount` +* is optional +* type: `number` +* default: `0` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmamount) + +### xdm:amount Type + + +`number` +* minimum value: `0` + + + + + + +## xdm:closeDate +### Close Date + +Date of closure for this opportunity. + +`xdm:closeDate` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmclosedate) + +### xdm:closeDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:contractID +### Contract ID + +Contract unique Identifier reference that this opportunity is linked to. + +`xdm:contractID` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmcontractid) + +### xdm:contractID Type + + +`string` + + + + + + +## xdm:currencyCode +### Currency Code + +Standard ISO code(ISO 4217) for currency. + +`xdm:currencyCode` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmcurrencycode) + +### xdm:currencyCode Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E(%5BA-Z%5D%7B3%7D)%24)): +```regex +^([A-Z]{3})$ +``` + + + + + + +## xdm:expectedRevenue +### Expected Revenue + +Calculated revenue based on the Amount and Probability. + +`xdm:expectedRevenue` +* is optional +* type: `number` +* default: `0` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmexpectedrevenue) + +### xdm:expectedRevenue Type + + +`number` +* minimum value: `0` + + + + + + +## xdm:fiscalQuarter +### Fiscal Quarter + +The fiscal quarter this opportunity is targeted.. + +`xdm:fiscalQuarter` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmfiscalquarter) + +### xdm:fiscalQuarter Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E(%5B1-4%5D%7B1%7D)%24%7C%5E(%5BQq%5D%5B1-4%5D%7B1%7D)%24)): +```regex +^([1-4]{1})$|^([Qq][1-4]{1})$ +``` + + + + + + +## xdm:fiscalYear +### Fiscal Year + +The fiscal year this opportunity is targeted. + +`xdm:fiscalYear` +* is optional +* type: `integer` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmfiscalyear) + +### xdm:fiscalYear Type + + +`integer` + + + + + + +## xdm:forecastCategory +### Forecast Category + +Forecast Category determined by the opportunity Stage value eg: omitted,pipeline,bestcase,commit,closed. + +`xdm:forecastCategory` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmforecastcategory) + +### xdm:forecastCategory Type + + +`string` + + + + + + +## xdm:forecastCategoryName +### Forecast Category Name + +Forecast category name that is displayed in reports for a perticular forecast category. + +`xdm:forecastCategoryName` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmforecastcategoryname) + +### xdm:forecastCategoryName Type + + +`string` + + + + + + +## xdm:hasOpportunityLineItem +### Has Opportunity Line Item Flag + +Flag to indicate whether this opportunity have more line items. + +`xdm:hasOpportunityLineItem` +* is optional +* type: `boolean` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmhasopportunitylineitem) + +### xdm:hasOpportunityLineItem Type + + +`boolean` + + + + + +## xdm:isClosed +### Closed Flag + +Flag indicating if this opportunity is closed. + +`xdm:isClosed` +* is optional +* type: `boolean` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmisclosed) + +### xdm:isClosed Type + + +`boolean` + + + + + +## xdm:isDeleted +### Deleted Flag + +Flag indicating if this opportunity is deleted. + +`xdm:isDeleted` +* is optional +* type: `boolean` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmisdeleted) + +### xdm:isDeleted Type + + +`boolean` + + + + + +## xdm:isPrivate +### Private Flag + +Indicates that the opportunity is private. + +`xdm:isPrivate` +* is optional +* type: `boolean` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmisprivate) + +### xdm:isPrivate Type + + +`boolean` + + + + + +## xdm:isWon +### Won Flag + +Flag indicating if this opportunity is Won. + +`xdm:isWon` +* is optional +* type: `boolean` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmiswon) + +### xdm:isWon Type + + +`boolean` + + + + + +## xdm:leadSource +### Lead Source + +Source of the opportunity such as Advertisement, Partner, or Web. + +`xdm:leadSource` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmleadsource) + +### xdm:leadSource Type + + +`string` + + + + + + +## xdm:nextStep +### Next Step + +Description of next task in closing opportunity. + +`xdm:nextStep` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmnextstep) + +### xdm:nextStep Type + + +`string` + + + + + + +## xdm:opportunityDescription +### Opportunity Description + +Additional information to describe the opportunity, such as possible products to sell or past purchases from the customer. + +`xdm:opportunityDescription` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmopportunitydescription) + +### xdm:opportunityDescription Type + + +`string` + + + + + + +## xdm:opportunityName +### Opportunity Name + +Subject or descriptive name, such as the expected order or company name, for the opportunity. + +`xdm:opportunityName` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmopportunityname) + +### xdm:opportunityName Type + + +`string` + + + + + + +## xdm:ownerID +### Opportunity Owner + +Assigned owner for this opportunity. + +`xdm:ownerID` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmownerid) + +### xdm:ownerID Type + + +`string` + + + + + + +## xdm:probabilityPercentage +### Probability Percentage + +Likelihood that opportunity will close, stated as a percentage. + +`xdm:probabilityPercentage` +* is optional +* type: `integer` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmprobabilitypercentage) + +### xdm:probabilityPercentage Type + + +`integer` +* minimum value: `0` +* maximum value: `100` + + + + + +## xdm:quantity +### Opportunity Quantity + +Total of all quantity field values for all products in the Products related list for this opportunity. + +`xdm:quantity` +* is optional +* type: `integer` +* default: `0` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmquantity) + +### xdm:quantity Type + + +`integer` +* minimum value: `0` + + + + + + +## xdm:sourceType +### Opportunity Source Type + +Opportunity source type such as Existing Business or New Business + +`xdm:sourceType` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmsourcetype) + +### xdm:sourceType Type + + +`string` + + + + + + +## xdm:stage +### Opportunity Stage + +Sales stage of this opportunity to aid the sales team in their efforts to win this opportunity. + +`xdm:stage` +* is optional +* type: `string` +* defined in [B2B Opportunity Additional Properties](../../../mixins/opportunity/opportunity-crm.schema.md#xdmstage) + +### xdm:stage Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/offer-management/capping-constraint.schema.json b/docs/reference/adobe/experience/offer-management/capping-constraint.schema.json new file mode 100644 index 000000000..75de0c1af --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/capping-constraint.schema.json @@ -0,0 +1,39 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/capping-constraint", + "meta:abstract": false, + "meta:extensible": true, + "type": "object", + "title": "Capping Constraint", + "description": "A capping constraint is a way of restricting how many times an offer is proposed. These restrictions can be applied in two ways.\n\nOne of the ways is by setting a cap globally. This means that the offer won't be proposed more than the set cap. This is also referred to as volume-based capping.\n\nAnother way is by setting a cap per profile. An offer is always proposed to some profile. A marketer may want to limit the number of times the same profile sees the offer. This is also referred to as user-fatigue capping.\n\nA marketer can set both these caps on an offer at the same time.\n", + "definitions": { + "capping-constraint": { + "type": "object", + "properties": { + "xdm:globalCap": { + "type": "integer", + "title": "Global Cap", + "description": "Global cap is a constraint on how many times an offer can be proposed in totality.", + "minimum": 1 + }, + "xdm:profileCap": { + "type": "integer", + "title": "Profile Cap", + "description": "Profile cap is a constraint on how many times an offer can be proposed to a certain profile.", + "minimum": 1 + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/capping-constraint" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/capping-constraint.schema.md b/docs/reference/adobe/experience/offer-management/capping-constraint.schema.md new file mode 100644 index 000000000..7b109284d --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/capping-constraint.schema.md @@ -0,0 +1,69 @@ + +# Capping Constraint Schema + +``` +https://ns.adobe.com/experience/offer-management/capping-constraint +``` + +A capping constraint is a way of restricting how many times an offer is proposed. These restrictions can be applied in two ways. + +One of the ways is by setting a cap globally. This means that the offer won't be proposed more than the set cap. This is also referred to as volume-based capping. + +Another way is by setting a cap per profile. An offer is always proposed to some profile. A marketer may want to limit the number of times the same profile sees the offer. This is also referred to as user-fatigue capping. + +A marketer can set both these caps on an offer at the same time. + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/capping-constraint.schema.json](adobe/experience/offer-management/capping-constraint.schema.json) | + +# Capping Constraint Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:globalCap](#xdmglobalcap) | `integer` | Optional | Capping Constraint (this schema) | +| [xdm:profileCap](#xdmprofilecap) | `integer` | Optional | Capping Constraint (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:globalCap +### Global Cap + +Global cap is a constraint on how many times an offer can be proposed in totality. + +`xdm:globalCap` +* is optional +* type: `integer` +* defined in this schema + +### xdm:globalCap Type + + +`integer` +* minimum value: `1` + + + + + + +## xdm:profileCap +### Profile Cap + +Profile cap is a constraint on how many times an offer can be proposed to a certain profile. + +`xdm:profileCap` +* is optional +* type: `integer` +* defined in this schema + +### xdm:profileCap Type + + +`integer` +* minimum value: `1` + + + + + diff --git a/docs/reference/adobe/experience/offer-management/eligibility-rule.schema.json b/docs/reference/adobe/experience/offer-management/eligibility-rule.schema.json new file mode 100644 index 000000000..0356f2b79 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/eligibility-rule.schema.json @@ -0,0 +1,234 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/eligibility-rule", + "meta:abstract": false, + "meta:extensible": true, + "type": "object", + "title": "Eligibility Rule", + "description": "An eligibility rule is a named reusable predicate used in the domain of audience segmentation and message personalization. The profile query language forms the foundation of those predicates. The predicate operates not only over profile fields but also over contextual data objects provided at the time of decisioning.", + "definitions": { + "eligibility-rule": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "title": "ID", + "description": "The unique identifier of the eligibility rule. This identifier is assigned by clients or services that use the repository and is not generated by the repository itself. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object. The @id is used in link relationships. For example an offer's selection constraint object references an eligibility rule object." + }, + "xdm:name": { + "type": "string", + "title": "Name", + "description": "Eligibility rule name that is used to locate this object in a search operation." + }, + "xdm:valueAsText": { + "type": "string", + "title": "Expression over XDM Instances in an Alternate Query Syntax", + "description": "Contains the expression over a collection of context XDM instances as a serialized string." + }, + "xdm:value": { + "$ref": "https://ns.adobe.com/experience/offer-management/filter-expression", + "title": "Expression over XDM Instances", + "description": "Contains the expression tree over a collection of context XDM instances. When the expression evaluates to true the offer referring to this eligibility rule will be included in the decisioning otherwise included. Central context instances include the profile and the experience events associated with the profile." + }, + "xdm:modelUsage": { + "title": "Used Properties", + "description": "A list of \"model usage\" objects, one per model, that lists the fully qualified path to every used property from the model.", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/experience/offer-management/model-usage" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/eligibility-rule" + }, + { + "required": [ + "xdm:name", + "xdm:value", + "xdm:modelUsage" + ] + } + ], + "examples": [ + { + "@id": "https://www.example.com/offers/eligibility-rule/rule-0001", + "xdm:name": "Californians with one or more purchases of more than $1000", + "xdm:valueAsText": "homeAddress.stateOrProvince = \"CA\" AND (some x FROM xEvent WHERE commerce.order.priceTotal > 1000 AND x.commerce.order.currencyCode = \"USD\")", + "xdm:value": { + "nodeType": "fnApply", + "fnName": "and", + "params": [ + { + "nodeType": "fnApply", + "fnName": "=", + "params": [ + { + "nodeType": "fieldLookup", + "fieldName": "xdm:stateOrProvince", + "object": { + "nodeType": "fieldLookup", + "fieldName": "xdm:homeAddress", + "object": { + "nodeType": "literal", + "literalType": "XDMObject", + "value": "profile" + } + } + }, + { + "literalType": "String", + "nodeType": "literal", + "value": "CA" + } + ] + }, + { + "nodeType": "quantification", + "quantifier": "some", + "variables": [ + { + "nodeType": "varDecl", + "varName": "x", + "from": { + "nodeType": "fnApply", + "fnName": "modelInstances", + "params": [ + { + "nodeType": "literal", + "literalType": "String", + "value": "https://ns.adobe.com/xdm/context/experienceevent" + } + ] + }, + "where": { + "nodeType": "fnApply", + "fnName": "and", + "params": [ + { + "nodeType": "quantification", + "quantifier": "some", + "variables": [ + { + "nodeType": "varDecl", + "varName": "id", + "from": { + "nodeType": "fieldLookup", + "fieldName": "xdm:endUserIDs", + "object": { + "nodeType": "varRef", + "varName": "x" + } + }, + "where": { + "nodeType": "fnApply", + "fnName": "in", + "params": [ + { + "nodeType": "varRef", + "varName": "id" + }, + { + "nodeType": "fieldLookup", + "fieldName": "xdm:identities", + "object": { + "nodeType": "literal", + "literalType": "XDMObject", + "value": "profile" + } + } + ] + } + } + ] + }, + { + "nodeType": "fnApply", + "fnName": ">", + "params": [ + { + "nodeType": "fieldLookup", + "fieldName": "xdm:priceTotal", + "object": { + "nodeType": "fieldLookup", + "fieldName": "xdm:order", + "object": { + "nodeType": "fieldLookup", + "fieldName": "xdm:commerce", + "object": { + "nodeType": "varRef", + "varName": "x" + } + } + } + }, + { + "nodeType": "literal", + "literalType": "Integer", + "value": 1000 + } + ] + }, + { + "nodeType": "fnApply", + "fnName": "=", + "params": [ + { + "nodeType": "fieldLookup", + "fieldName": "xdm:currencyCode", + "object": { + "nodeType": "fieldLookup", + "fieldName": "xdm:order", + "object": { + "nodeType": "fieldLookup", + "fieldName": "xdm:commerce", + "object": { + "nodeType": "varRef", + "varName": "x" + } + } + } + }, + { + "nodeType": "literal", + "literalType": "String", + "value": "USD" + } + ] + } + ] + } + } + ] + } + ] + }, + "xdm:modelUsage": [ + { + "xdm:modelReference": "https://ns.adobe.com/xdm/context/profile", + "xdm:modelPropertyPaths": [ + "xdm:identities", + "xdm:homeAddress.xdm:stateProvince" + ] + }, + { + "xdm:modelReference": "https://ns.adobe.com/xdm/context/experienceevent", + "xdm:modelPropertyPaths": [ + "xdm:endUserIDs", + "xdm:commerce.xdm:order.xdm:priceTotal", + "xdm:commerce.xdm:order.xdm:currencyCode" + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/eligibility-rule.schema.md b/docs/reference/adobe/experience/offer-management/eligibility-rule.schema.md new file mode 100644 index 000000000..a05836f9e --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/eligibility-rule.schema.md @@ -0,0 +1,308 @@ + +# Eligibility Rule Schema + +``` +https://ns.adobe.com/experience/offer-management/eligibility-rule +``` + +An eligibility rule is a named reusable predicate used in the domain of audience segmentation and message personalization. The profile query language forms the foundation of those predicates. The predicate operates not only over profile fields but also over contextual data objects provided at the time of decisioning. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/eligibility-rule.schema.json](adobe/experience/offer-management/eligibility-rule.schema.json) | +## Schema Hierarchy + +* Eligibility Rule `https://ns.adobe.com/experience/offer-management/eligibility-rule` + * [Filter Expression Tree](filter-expression/filter-expression.schema.md) `https://ns.adobe.com/experience/offer-management/filter-expression` + + +## Eligibility Rule Example +```json +{ + "@id": "https://www.example.com/offers/eligibility-rule/rule-0001", + "xdm:name": "Californians with one or more purchases of more than $1000", + "xdm:valueAsText": "homeAddress.stateOrProvince = \"CA\" AND (some x FROM xEvent WHERE commerce.order.priceTotal > 1000 AND x.commerce.order.currencyCode = \"USD\")", + "xdm:value": { + "nodeType": "fnApply", + "fnName": "and", + "params": [ + { + "nodeType": "fnApply", + "fnName": "=", + "params": [ + { + "nodeType": "fieldLookup", + "fieldName": "xdm:stateOrProvince", + "object": { + "nodeType": "fieldLookup", + "fieldName": "xdm:homeAddress", + "object": { + "nodeType": "literal", + "literalType": "XDMObject", + "value": "profile" + } + } + }, + { + "literalType": "String", + "nodeType": "literal", + "value": "CA" + } + ] + }, + { + "nodeType": "quantification", + "quantifier": "some", + "variables": [ + { + "nodeType": "varDecl", + "varName": "x", + "from": { + "nodeType": "fnApply", + "fnName": "modelInstances", + "params": [ + { + "nodeType": "literal", + "literalType": "String", + "value": "https://ns.adobe.com/xdm/context/experienceevent" + } + ] + }, + "where": { + "nodeType": "fnApply", + "fnName": "and", + "params": [ + { + "nodeType": "quantification", + "quantifier": "some", + "variables": [ + { + "nodeType": "varDecl", + "varName": "id", + "from": { + "nodeType": "fieldLookup", + "fieldName": "xdm:endUserIDs", + "object": { + "nodeType": "varRef", + "varName": "x" + } + }, + "where": { + "nodeType": "fnApply", + "fnName": "in", + "params": [ + { + "nodeType": "varRef", + "varName": "id" + }, + { + "nodeType": "fieldLookup", + "fieldName": "xdm:identities", + "object": { + "nodeType": "literal", + "literalType": "XDMObject", + "value": "profile" + } + } + ] + } + } + ] + }, + { + "nodeType": "fnApply", + "fnName": ">", + "params": [ + { + "nodeType": "fieldLookup", + "fieldName": "xdm:priceTotal", + "object": { + "nodeType": "fieldLookup", + "fieldName": "xdm:order", + "object": { + "nodeType": "fieldLookup", + "fieldName": "xdm:commerce", + "object": { + "nodeType": "varRef", + "varName": "x" + } + } + } + }, + { + "nodeType": "literal", + "literalType": "Integer", + "value": 1000 + } + ] + }, + { + "nodeType": "fnApply", + "fnName": "=", + "params": [ + { + "nodeType": "fieldLookup", + "fieldName": "xdm:currencyCode", + "object": { + "nodeType": "fieldLookup", + "fieldName": "xdm:order", + "object": { + "nodeType": "fieldLookup", + "fieldName": "xdm:commerce", + "object": { + "nodeType": "varRef", + "varName": "x" + } + } + } + }, + { + "nodeType": "literal", + "literalType": "String", + "value": "USD" + } + ] + } + ] + } + } + ] + } + ] + }, + "xdm:modelUsage": [ + { + "xdm:modelReference": "https://ns.adobe.com/xdm/context/profile", + "xdm:modelPropertyPaths": [ + "xdm:identities", + "xdm:homeAddress.xdm:stateProvince" + ] + }, + { + "xdm:modelReference": "https://ns.adobe.com/xdm/context/experienceevent", + "xdm:modelPropertyPaths": [ + "xdm:endUserIDs", + "xdm:commerce.xdm:order.xdm:priceTotal", + "xdm:commerce.xdm:order.xdm:currencyCode" + ] + } + ] +} +``` + +# Eligibility Rule Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Eligibility Rule (this schema) | +| [xdm:modelUsage](#xdmmodelusage) | Used XDM Models and Properties from those Models | **Required** | Eligibility Rule (this schema) | +| [xdm:name](#xdmname) | `string` | **Required** | Eligibility Rule (this schema) | +| [xdm:value](#xdmvalue) | Filter Expression Tree | **Required** | Eligibility Rule (this schema) | +| [xdm:valueAsText](#xdmvalueastext) | `string` | Optional | Eligibility Rule (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### ID + +The unique identifier of the eligibility rule. This identifier is assigned by clients or services that use the repository and is not generated by the repository itself. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object. The @id is used in link relationships. For example an offer's selection constraint object references an eligibility rule object. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:modelUsage +### Used Properties + +A list of "model usage" objects, one per model, that lists the fully qualified path to every used property from the model. + +`xdm:modelUsage` +* is **required** +* type: Used XDM Models and Properties from those Models + +* defined in this schema + +### xdm:modelUsage Type + + +Array type: Used XDM Models and Properties from those Models + +All items must be of the type: +* [Used XDM Models and Properties from those Models](model-usage.schema.md) – `https://ns.adobe.com/experience/offer-management/model-usage` + + + + + + + + +## xdm:name +### Name + +Eligibility rule name that is used to locate this object in a search operation. + +`xdm:name` +* is **required** +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:value +### Expression over XDM Instances + +Contains the expression tree over a collection of context XDM instances. When the expression evaluates to true the offer referring to this eligibility rule will be included in the decisioning otherwise included. Central context instances include the profile and the experience events associated with the profile. + +`xdm:value` +* is **required** +* type: Filter Expression Tree +* defined in this schema + +### xdm:value Type + + +* [Filter Expression Tree](filter-expression/filter-expression.schema.md) – `https://ns.adobe.com/experience/offer-management/filter-expression` + + + + + +## xdm:valueAsText +### Expression over XDM Instances in an Alternate Query Syntax + +Contains the expression over a collection of context XDM instances as a serialized string. + +`xdm:valueAsText` +* is optional +* type: `string` +* defined in this schema + +### xdm:valueAsText Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/offer-management/fallback-offer.schema.json b/docs/reference/adobe/experience/offer-management/fallback-offer.schema.json new file mode 100644 index 000000000..c02bdf125 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/fallback-offer.schema.json @@ -0,0 +1,35 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/fallback-offer", + "meta:extends": [ + "https://ns.adobe.com/experience/offer-management/offer" + ], + "meta:abstract": false, + "meta:extensible": true, + "type": "object", + "title": "Fallback Offer", + "description": "Fallback offer is a default offer used when there is no personalization offer left that satisfies all constraints.", + "definitions": { + "fallback-offer": { + "allOf": [ + { + "$ref": "https://ns.adobe.com/experience/offer-management/offer#/definitions/offer" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/fallback-offer" + }, + { + "$ref": "https://ns.adobe.com/experience/offer-management/offer" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/fallback-offer.schema.md b/docs/reference/adobe/experience/offer-management/fallback-offer.schema.md new file mode 100644 index 000000000..db608303b --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/fallback-offer.schema.md @@ -0,0 +1,174 @@ + +# Fallback Offer Schema + +``` +https://ns.adobe.com/experience/offer-management/fallback-offer +``` + +Fallback offer is a default offer used when there is no personalization offer left that satisfies all constraints. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/fallback-offer.schema.json](adobe/experience/offer-management/fallback-offer.schema.json) | +## Schema Hierarchy + +* Fallback Offer `https://ns.adobe.com/experience/offer-management/fallback-offer` + * [Offer](offer.schema.md) `https://ns.adobe.com/experience/offer-management/offer` + + +# Fallback Offer Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Offer](offer.schema.md#id) | +| [xdm:customMetadata](#xdmcustommetadata) | `object` | Optional | [Offer](offer.schema.md#xdmcustommetadata) | +| [xdm:name](#xdmname) | `string` | Optional | [Offer](offer.schema.md#xdmname) | +| [xdm:representations](#xdmrepresentations) | Representation | Optional | [Offer](offer.schema.md#xdmrepresentations) | +| [xdm:status](#xdmstatus) | `enum` | Optional | [Offer](offer.schema.md#xdmstatus) | +| [xdm:tags](#xdmtags) | `string[]` | Optional | [Offer](offer.schema.md#xdmtags) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### ID + +The unique identifier of the offer. It must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object. + +`@id` +* is optional +* type: `string` +* defined in [Offer](offer.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:customMetadata +### Custom Properties + +Custom metadata is a key-value map that allows the end-users to attach properties to individual offer instances. Any string can be used as a key name, the values are also strings. + +`xdm:customMetadata` +* is optional +* type: `object` +* defined in [Offer](offer.schema.md#xdmcustommetadata) + +### xdm:customMetadata Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:name +### Name + +The offer's name. A human readable string to find one or more offers. + +`xdm:name` +* is optional +* type: `string` +* defined in [Offer](offer.schema.md#xdmname) + +### xdm:name Type + + +`string` + + + + + + +## xdm:representations +### Representations + +Offer representations for different content variants. A single offer can have multiple contents variants. An offer representation is the object that connects offers to content. Content is information that is directed towards an audience for consumption in a (digital) experience. Content is delivered through channels (or a particular medium). + +`xdm:representations` +* is optional +* type: Representation + +* defined in [Offer](offer.schema.md#xdmrepresentations) + +### xdm:representations Type + + +Array type: Representation + +All items must be of the type: +* [Representation](offer-representation.schema.md) – `https://ns.adobe.com/experience/offer-management/offer-representation` + + + + + + + + +## xdm:status +### Status + +Offer Status allows user workflows to be conducted with offers. The status may affect where an offer is visible or considered relevant. Status changes are driven by the clients or services that use offers. + +`xdm:status` +* is optional +* type: `enum` +* defined in [Offer](offer.schema.md#xdmstatus) + +The value of this property **must** be equal to one of the [known values below](#xdmstatus-known-values). + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `draft` | Draft | +| `pending` | Pending | +| `rejected` | Rejected | +| `approved` | Approved | +| `archived` | Archived | + + + + +## xdm:tags +### Tags + +The set of tags associated with this offer. The tags are used in offer filter expressions to constrain the overall offer inventory to a topical sub set (category). + +`xdm:tags` +* is optional +* type: `string[]` + +* defined in [Offer](offer.schema.md#xdmtags) + +### xdm:tags Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + +An identifier of a tag object. The value is the @id of the tag that is referenced. See tag schema: https://ns.adobe.com/experience/offer-management/tag + + + + + + diff --git a/docs/reference/adobe/experience/offer-management/model-usage.schema.json b/docs/reference/adobe/experience/offer-management/model-usage.schema.json new file mode 100644 index 000000000..c0c489989 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/model-usage.schema.json @@ -0,0 +1,47 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/model-usage", + "meta:abstract": false, + "meta:extensible": true, + "type": "object", + "title": "Used XDM Models and Properties from those Models", + "description": "ModelUsage is a type that is used as part of the EligibilityRules schema. It serves the purpose of extracting all usages of XDM models and their properties (fields in XDM language) from an expression stored in an Eligibility Rule. \nThose expressions are a JSON formatted representation of a Profile Query Language (PQL) expression. A Schema for the JSON serialization of a PQL expression is provided in https://ns.adobe.com/experience/offer-management/filter-expression \nThe information is factored out so that clients that cannot or don't want to parse and reason about the PQL/json syntax can still process aspects of the EligibilityRule. For instance, a client that wants to know what XDM data or objects are used as input values can quickly assemble that information or aggregare it over a number of Eligibility Rules that are applied at once.\n", + "definitions": { + "model-usage": { + "type": "object", + "title": "Model and Used Properties", + "description": "A key-value pair whose key is reference to the model, i.e. the model's $id property. The value is an array of strings, each string representing a fully qualified path to an XDM field with dots used as the path delimiter.", + "properties": { + "xdm:modelReference": { + "type": "string", + "format": "uri", + "description": "Reference to the model, i.e. its schema $id property. " + }, + "xdm:modelPropertyPaths": { + "type": "array", + "items": { + "type": "string", + "description": "A fully qualified JSON path to an XDM field with dots used as the path delimiter." + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/model-usage" + }, + { + "required": [ + "xdm:modelReference", + "xdm:modelPropertyPaths" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/model-usage.schema.md b/docs/reference/adobe/experience/offer-management/model-usage.schema.md new file mode 100644 index 000000000..c28caf4c3 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/model-usage.schema.md @@ -0,0 +1,71 @@ + +# Used XDM Models and Properties from those Models Schema + +``` +https://ns.adobe.com/experience/offer-management/model-usage +``` + +ModelUsage is a type that is used as part of the EligibilityRules schema. It serves the purpose of extracting all usages of XDM models and their properties (fields in XDM language) from an expression stored in an Eligibility Rule. +Those expressions are a JSON formatted representation of a Profile Query Language (PQL) expression. A Schema for the JSON serialization of a PQL expression is provided in https://ns.adobe.com/experience/offer-management/filter-expression +The information is factored out so that clients that cannot or don't want to parse and reason about the PQL/json syntax can still process aspects of the EligibilityRule. For instance, a client that wants to know what XDM data or objects are used as input values can quickly assemble that information or aggregare it over a number of Eligibility Rules that are applied at once. + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/model-usage.schema.json](adobe/experience/offer-management/model-usage.schema.json) | + +# Used XDM Models and Properties from those Models Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:modelPropertyPaths](#xdmmodelpropertypaths) | `string[]` | **Required** | Used XDM Models and Properties from those Models (this schema) | +| [xdm:modelReference](#xdmmodelreference) | `string` | **Required** | Used XDM Models and Properties from those Models (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:modelPropertyPaths + + +`xdm:modelPropertyPaths` +* is **required** +* type: `string[]` + +* defined in this schema + +### xdm:modelPropertyPaths Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + +A fully qualified JSON path to an XDM field with dots used as the path delimiter. + + + + + + + +## xdm:modelReference + +Reference to the model, i.e. its schema $id property. + +`xdm:modelReference` +* is **required** +* type: `string` +* defined in this schema + +### xdm:modelReference Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + diff --git a/docs/reference/adobe/experience/offer-management/offer-activity-detail.schema.json b/docs/reference/adobe/experience/offer-management/offer-activity-detail.schema.json new file mode 100644 index 000000000..4a29c97bf --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer-activity-detail.schema.json @@ -0,0 +1,59 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/offer-management/offer-activity-detail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Offer Activity Detail", + "type": "object", + "meta:abstract": true, + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/experience/decisioning/activity-detail" + ], + "description": "Offer activity detail is used to capture the attributes of an offer activity in a proposition or response.", + "definitions": { + "offer-activity-detail": { + "properties": { + "xdm:placement": { + "title": "Offer Placement", + "type": "string", + "format": "uri-reference", + "description": "The reference to an offer placement instance. Offer placements are used by offer activities to limit the offer selection to those offers that have a representation that complies with the offer placement restrictions. 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:filter": { + "title": "Offer Filter", + "type": "string", + "format": "uri-reference", + "description": "The reference to a filter that is applied to the inventory when a decisioning is made the context of this activity. The value is the URI (@id) of the offer filter that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-filter" + }, + "xdm:fallback": { + "title": "Fallback Offer", + "type": "string", + "format": "uri-reference", + "description": "The reference to a fallback offer that is used when decisioning in the context of this activity does not qualify any of the offers specified in the fallback offer. The value is the URI (@id) of the fallback offer that is referenced. See schema https://ns.adobe.com/experience/offer-management/fallback-offer" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/offer-activity-detail" + }, + { + "$ref": "https://ns.adobe.com/experience/decisioning/activity-detail" + } + ], + "examples": [ + { + "xdm:id": "xcore:offer-activity:f66f792de3c0ba9", + "xdm:name": "Email - Next Best Offer", + "xdm:placement": "xcore:offer-placement:f6524d27c2d6edd", + "xdm:filter": "xcore:offer-filter:f66f792de3c0ba9", + "xdm:fallback": "xcore:fallback-offer:f6529b31b3c0ba6" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/offer-activity-detail.schema.md b/docs/reference/adobe/experience/offer-management/offer-activity-detail.schema.md new file mode 100644 index 000000000..3c15ada85 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer-activity-detail.schema.md @@ -0,0 +1,208 @@ + +# Offer Activity Detail Schema + +``` +https://ns.adobe.com/experience/offer-management/offer-activity-detail +``` + +Offer activity detail is used to capture the attributes of an offer activity in a proposition or response. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/offer-activity-detail.schema.json](adobe/experience/offer-management/offer-activity-detail.schema.json) | +## Schema Hierarchy + +* Offer Activity Detail `https://ns.adobe.com/experience/offer-management/offer-activity-detail` + * [Decision Activity Snapshot](../decisioning/activity-detail.schema.md) `https://ns.adobe.com/experience/decisioning/activity-detail` + + +## Offer Activity Detail Example +```json +{ + "xdm:id": "xcore:offer-activity:f66f792de3c0ba9", + "xdm:name": "Email - Next Best Offer", + "xdm:placement": "xcore:offer-placement:f6524d27c2d6edd", + "xdm:filter": "xcore:offer-filter:f66f792de3c0ba9", + "xdm:fallback": "xcore:fallback-offer:f6529b31b3c0ba6" +} +``` + +# Offer Activity Detail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [repo:etag](#repoetag) | `string` | Optional | [Decision Activity Snapshot](../decisioning/activity-detail.schema.md#repoetag) | +| [xdm:endTime](#xdmendtime) | `string` | Optional | [Decision Activity Snapshot](../decisioning/activity-detail.schema.md#xdmendtime) | +| [xdm:fallback](#xdmfallback) | `string` | Optional | [Decision Activity Snapshot](../decisioning/activity-detail.schema.md#xdmfallback) | +| [xdm:filter](#xdmfilter) | `string` | Optional | Offer Activity Detail (this schema) | +| [xdm:id](#xdmid) | `string` | Optional | [Decision Activity Snapshot](../decisioning/activity-detail.schema.md#xdmid) | +| [xdm:name](#xdmname) | `string` | Optional | [Decision Activity Snapshot](../decisioning/activity-detail.schema.md#xdmname) | +| [xdm:placement](#xdmplacement) | `string` | Optional | Offer Activity Detail (this schema) | +| [xdm:startTime](#xdmstarttime) | `string` | Optional | [Decision Activity Snapshot](../decisioning/activity-detail.schema.md#xdmstarttime) | +| `*` | any | Additional | this schema *allows* additional properties | + +## repo:etag +### Activity ETag + +The revision that the decision activity object was at when the snapshot was taken. + +`repo:etag` +* is optional +* type: `string` +* defined in [Decision Activity Snapshot](../decisioning/activity-detail.schema.md#repoetag) + +### repo:etag Type + + +`string` + + + + + + +## xdm:endTime +### Activity End Date and Time + +Activity end date and end time. Property has the semantic of schema.org's 'endTime' property defined on http://schema.org/Action + +`xdm:endTime` +* is optional +* type: `string` +* defined in [Decision Activity Snapshot](../decisioning/activity-detail.schema.md#xdmendtime) + +### xdm:endTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:fallback +### Fallback Option + +The reference to a fallback option that is used when decisioning in the context of this activity does not qualify any of the regular options (this typically happens when hard constraints are applied). The value is the URI (@id) of the fallback option that is referenced. + +`xdm:fallback` +* is optional +* type: `string` +* defined in [Decision Activity Snapshot](../decisioning/activity-detail.schema.md#xdmfallback) + +### xdm:fallback Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:filter +### Offer Filter + +The reference to a filter that is applied to the inventory when a decisioning is made the context of this activity. The value is the URI (@id) of the offer filter that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-filter + +`xdm:filter` +* is optional +* type: `string` +* defined in this schema + +### xdm:filter Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:id +### Activity Identifier + +A unique, immutable identifier for the decision activity. + +`xdm:id` +* is optional +* type: `string` +* defined in [Decision Activity Snapshot](../decisioning/activity-detail.schema.md#xdmid) + +### xdm:id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:name +### Activity Name + +Activity name. The name is displayed in various user interfaces. + +`xdm:name` +* is optional +* type: `string` +* defined in [Decision Activity Snapshot](../decisioning/activity-detail.schema.md#xdmname) + +### xdm:name Type + + +`string` + + + + + + +## xdm:placement +### Offer Placement + +The reference to an offer placement instance. Offer placements are used by offer activities to limit the offer selection to those offers that have a representation that complies with the offer placement restrictions. 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 optional +* type: `string` +* defined in this schema + +### xdm:placement Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:startTime +### Activity Start Date and Time + +Activity start date and end time. Property has the semantic of schema.org's 'startTime' property defined on http://schema.org/Action + +`xdm:startTime` +* is optional +* type: `string` +* defined in [Decision Activity Snapshot](../decisioning/activity-detail.schema.md#xdmstarttime) + +### xdm:startTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + diff --git a/docs/reference/adobe/experience/offer-management/offer-activity.schema.json b/docs/reference/adobe/experience/offer-management/offer-activity.schema.json new file mode 100644 index 000000000..9bddca75c --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer-activity.schema.json @@ -0,0 +1,93 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/offer-activity", + "meta:abstract": false, + "meta:extensible": true, + "type": "object", + "title": "Activity", + "description": "An offer activity is used to control the decisioning process. It specifies the filter applied to the total inventory to narrow down offers by topic/category, the placement to narrow down the inventory to those offers that technically fit into the reserved space for the offer and specifies a fall back option should the combined constraints disqualify all available personalization options (offers).", + "definitions": { + "offer-activity": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "title": "ID", + "description": "The unique identifier of the offer activity. This @id must be unique across for objects that are not semantically the same, otherwise it is interpreted as referring to the same object. " + }, + "xdm:name": { + "type": "string", + "title": "Name", + "description": "Activity name. The name is displayed in various user interfaces." + }, + "xdm:status": { + "type": "string", + "title": "Status", + "description": "Activity Status", + "enum": [ + "draft", + "live", + "complete", + "archived" + ], + "meta:enum": { + "draft": "Draft", + "live": "Live", + "complete": "Complete", + "archived": "Archived" + } + }, + "xdm:startDate": { + "type": "string", + "format": "date-time", + "title": "Start Date", + "description": "Activity Start Date" + }, + "xdm:endDate": { + "type": "string", + "format": "date-time", + "title": "End Date", + "description": "Activity End Date" + }, + "xdm:placement": { + "type": "string", + "format": "uri", + "title": "Offer Placement", + "description": "The reference to an offer placement instance. Offer placements are used by offer activities to limit the offer selection to those offers that have a representation that complies with the offer placement restrictions. 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:filter": { + "type": "string", + "format": "uri", + "title": "Offer Filter", + "description": "The reference to a filter that is applied to the inventory when a decisioning is made the context of this activity. The value is the URI (@id) of the offer filter that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-filter" + }, + "xdm:fallback": { + "type": "string", + "format": "uri", + "title": "Fallback Offer", + "description": "The reference to a fallback offer that is used when decisioning in the context of this activity does not qualify any of the offers specified in the fallback offer. The value is the URI (@id) of the fallback offer that is referenced. See schema https://ns.adobe.com/experience/offer-management/fallback-offer" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/offer-activity" + }, + { + "required": [ + "xdm:name", + "xdm:status", + "xdm:placement", + "xdm:filter", + "xdm:fallback" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/offer-activity.schema.md b/docs/reference/adobe/experience/offer-management/offer-activity.schema.md new file mode 100644 index 000000000..fbfa19d1e --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer-activity.schema.md @@ -0,0 +1,195 @@ + +# Activity Schema + +``` +https://ns.adobe.com/experience/offer-management/offer-activity +``` + +An offer activity is used to control the decisioning process. It specifies the filter applied to the total inventory to narrow down offers by topic/category, the placement to narrow down the inventory to those offers that technically fit into the reserved space for the offer and specifies a fall back option should the combined constraints disqualify all available personalization options (offers). + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/offer-activity.schema.json](adobe/experience/offer-management/offer-activity.schema.json) | + +# Activity Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Activity (this schema) | +| [xdm:endDate](#xdmenddate) | `string` | Optional | Activity (this schema) | +| [xdm:fallback](#xdmfallback) | `string` | **Required** | Activity (this schema) | +| [xdm:filter](#xdmfilter) | `string` | **Required** | Activity (this schema) | +| [xdm:name](#xdmname) | `string` | **Required** | Activity (this schema) | +| [xdm:placement](#xdmplacement) | `string` | **Required** | Activity (this schema) | +| [xdm:startDate](#xdmstartdate) | `string` | Optional | Activity (this schema) | +| [xdm:status](#xdmstatus) | `enum` | **Required** | Activity (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### ID + +The unique identifier of the offer activity. This @id must be unique across for objects that are not semantically the same, otherwise it is interpreted as referring to the same object. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:endDate +### End Date + +Activity End Date + +`xdm:endDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:endDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:fallback +### Fallback Offer + +The reference to a fallback offer that is used when decisioning in the context of this activity does not qualify any of the offers specified in the fallback offer. The value is the URI (@id) of the fallback offer that is referenced. See schema https://ns.adobe.com/experience/offer-management/fallback-offer + +`xdm:fallback` +* is **required** +* type: `string` +* defined in this schema + +### xdm:fallback Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:filter +### Offer Filter + +The reference to a filter that is applied to the inventory when a decisioning is made the context of this activity. The value is the URI (@id) of the offer filter that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-filter + +`xdm:filter` +* is **required** +* type: `string` +* defined in this schema + +### xdm:filter Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:name +### Name + +Activity name. The name is displayed in various user interfaces. + +`xdm:name` +* is **required** +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:placement +### Offer Placement + +The reference to an offer placement instance. Offer placements are used by offer activities to limit the offer selection to those offers that have a representation that complies with the offer placement restrictions. 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](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:startDate +### Start Date + +Activity Start Date + +`xdm:startDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:startDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:status +### Status + +Activity Status + +`xdm:status` +* is **required** +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmstatus-known-values). + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `draft` | Draft | +| `live` | Live | +| `complete` | Complete | +| `archived` | Archived | + + + diff --git a/docs/reference/adobe/experience/offer-management/offer-detail.schema.json b/docs/reference/adobe/experience/offer-management/offer-detail.schema.json new file mode 100644 index 000000000..726cd8f32 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer-detail.schema.json @@ -0,0 +1,57 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/offer-management/offer-detail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Offer Detail", + "type": "object", + "meta:abstract": true, + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/experience/decisioning/option-detail" + ], + "description": "Offer detail is used to capture the attributes of an offer in a proposition or response. Offers are the decision options in the offer management domain and the offer detail datatype extends the option detail datatype.", + "definitions": { + "offer-detail": { + "properties": { + "xdm:tags": { + "type": "array", + "title": "Tags", + "description": "The set of tags associated with this offer. The tags are used in offer filter expressions to constrain the overall offer inventory to a topical sub set (category).", + "items": { + "type": "string", + "format": "uri-reference", + "description": "An identifier of a tag object. The value is the @id of the tag that is referenced. See tag schema: https://ns.adobe.com/experience/offer-management/tag" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/offer-detail" + }, + { + "$ref": "https://ns.adobe.com/experience/decisioning/option-detail" + } + ], + "examples": [ + { + "xdm:id": "xcore:personalized-offer:f67bab756ed6ee4", + "xdm:name": "Beach Vacations", + "xdm:tags": [ + "xcore:tag:f68535bc217322e", + "xcore:tag:f66f67dbe6d6ee1" + ], + "xdm:characteristics": { + "cost": "$2400", + "inventoryId": "BORA04", + "country": "French Polynesia" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/offer-detail.schema.md b/docs/reference/adobe/experience/offer-management/offer-detail.schema.md new file mode 100644 index 000000000..e3712a706 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer-detail.schema.md @@ -0,0 +1,198 @@ + +# Offer Detail Schema + +``` +https://ns.adobe.com/experience/offer-management/offer-detail +``` + +Offer detail is used to capture the attributes of an offer in a proposition or response. Offers are the decision options in the offer management domain and the offer detail datatype extends the option detail datatype. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/offer-detail.schema.json](adobe/experience/offer-management/offer-detail.schema.json) | +## Schema Hierarchy + +* Offer Detail `https://ns.adobe.com/experience/offer-management/offer-detail` + * [Decision Option Detail](../decisioning/option-detail.schema.md) `https://ns.adobe.com/experience/decisioning/option-detail` + + +## Offer Detail Example +```json +{ + "xdm:id": "xcore:personalized-offer:f67bab756ed6ee4", + "xdm:name": "Beach Vacations", + "xdm:tags": [ + "xcore:tag:f68535bc217322e", + "xcore:tag:f66f67dbe6d6ee1" + ], + "xdm:characteristics": { + "cost": "$2400", + "inventoryId": "BORA04", + "country": "French Polynesia" + } +} +``` + +# Offer Detail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/decisioning/propositionsProfile](#httpsnsadobecomexperiencedecisioningpropositionsprofile) | Measure | Optional | [Decision Option Detail](../decisioning/option-detail.schema.md#httpsnsadobecomexperiencedecisioningpropositionsprofile) | +| [https://ns.adobe.com/experience/decisioning/propositionsTotal](#httpsnsadobecomexperiencedecisioningpropositionstotal) | Measure | Optional | [Decision Option Detail](../decisioning/option-detail.schema.md#httpsnsadobecomexperiencedecisioningpropositionstotal) | +| [repo:etag](#repoetag) | `string` | Optional | [Decision Option Detail](../decisioning/option-detail.schema.md#repoetag) | +| [xdm:characteristics](#xdmcharacteristics) | `object` | Optional | [Decision Option Detail](../decisioning/option-detail.schema.md#xdmcharacteristics) | +| [xdm:id](#xdmid) | `string` | Optional | [Decision Option Detail](../decisioning/option-detail.schema.md#xdmid) | +| [xdm:name](#xdmname) | `string` | Optional | [Decision Option Detail](../decisioning/option-detail.schema.md#xdmname) | +| [xdm:tags](#xdmtags) | `string[]` | Optional | [Decision Option Detail](../decisioning/option-detail.schema.md#xdmtags) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/decisioning/propositionsProfile + +The number of times a particular option was proposed so far to a particular profile. When this metric is present the record or time-series entity must include an IdentityMap the profile. + +`https://ns.adobe.com/experience/decisioning/propositionsProfile` +* is optional +* type: Measure +* defined in [Decision Option Detail](../decisioning/option-detail.schema.md#httpsnsadobecomexperiencedecisioningpropositionsprofile) + +### https://ns.adobe.com/experience/decisioning/propositionsProfile Type + + +* [Measure](../../../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## https://ns.adobe.com/experience/decisioning/propositionsTotal + +The total number a particular option was proposed so far across all profiles. + +`https://ns.adobe.com/experience/decisioning/propositionsTotal` +* is optional +* type: Measure +* defined in [Decision Option Detail](../decisioning/option-detail.schema.md#httpsnsadobecomexperiencedecisioningpropositionstotal) + +### https://ns.adobe.com/experience/decisioning/propositionsTotal Type + + +* [Measure](../../../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## repo:etag +### Decision Option ETag + +The revision that the decision option object was at when the snapshot was taken. + +`repo:etag` +* is optional +* type: `string` +* defined in [Decision Option Detail](../decisioning/option-detail.schema.md#repoetag) + +### repo:etag Type + + +`string` + + + + + + +## xdm:characteristics +### Decision Option Characteristics + +Additional properties or attributes belonging to this particular decision option. Different instances can have different characteristics (keys in the map). The characteristics are name value pairs used to distinguish one decision option from others. Characteristics are used as values in content that represents this decision option and as features to analyze and optimize the performance of an option. When every instance has the same attribute or property, that aspect should be modeled as an extension schema that derives from decision option detail. + +`xdm:characteristics` +* is optional +* type: `object` +* defined in [Decision Option Detail](../decisioning/option-detail.schema.md#xdmcharacteristics) + +### xdm:characteristics Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:id +### Decision Option Identifier + +A unique identifier for the decision option. + +`xdm:id` +* is optional +* type: `string` +* defined in [Decision Option Detail](../decisioning/option-detail.schema.md#xdmid) + +### xdm:id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:name +### Decision Option Name + +Option name. The name is displayed in various user interfaces. + +`xdm:name` +* is optional +* type: `string` +* defined in [Decision Option Detail](../decisioning/option-detail.schema.md#xdmname) + +### xdm:name Type + + +`string` + + + + + + +## xdm:tags +### Decision Option Tags + +The set of tags associated with this option. The tags are used indicate catetoegies (dimensions) that the option belonged to at the time the proposition was made. + +`xdm:tags` +* is optional +* type: `string[]` + +* defined in [Decision Option Detail](../decisioning/option-detail.schema.md#xdmtags) + +### xdm:tags Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + +An identifier of a Tag object. The value is the @id of the Tag that is referenced. See Tag schema https://ns.adobe.com/experience/decisioning/tag + + + + + + diff --git a/docs/reference/adobe/experience/offer-management/offer-filter.schema.json b/docs/reference/adobe/experience/offer-management/offer-filter.schema.json new file mode 100644 index 000000000..846ab186e --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer-filter.schema.json @@ -0,0 +1,48 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/offer-filter", + "meta:abstract": false, + "meta:extensible": true, + "type": "object", + "title": "Offer Filter", + "description": "Filters are used to specify criteria for offer selection by topic or theme. The most common filter mechanism is by the tags that are associated with an offer. In general the offer filter selects a subset of offers from the overall inventory, not based on the use case for the decisioning.", + "definitions": { + "offer-filter": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "title": "ID", + "description": "The unique identifier of the filter. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object." + }, + "xdm:name": { + "type": "string", + "title": "Name", + "description": "Filter name" + }, + "xdm:value": { + "$ref": "https://ns.adobe.com/experience/offer-management/filter-expression", + "title": "Expression taking offer XDM instances (list of trees) as input", + "description": "Contains the condition that is used to select offers based on a combination of tags or, directly, using the @id of offers." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/offer-filter" + }, + { + "required": [ + "xdm:name", + "xdm:value" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/offer-filter.schema.md b/docs/reference/adobe/experience/offer-management/offer-filter.schema.md new file mode 100644 index 000000000..cbf4bd67b --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer-filter.schema.md @@ -0,0 +1,86 @@ + +# Offer Filter Schema + +``` +https://ns.adobe.com/experience/offer-management/offer-filter +``` + +Filters are used to specify criteria for offer selection by topic or theme. The most common filter mechanism is by the tags that are associated with an offer. In general the offer filter selects a subset of offers from the overall inventory, not based on the use case for the decisioning. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/offer-filter.schema.json](adobe/experience/offer-management/offer-filter.schema.json) | +## Schema Hierarchy + +* Offer Filter `https://ns.adobe.com/experience/offer-management/offer-filter` + * [Filter Expression Tree](filter-expression/filter-expression.schema.md) `https://ns.adobe.com/experience/offer-management/filter-expression` + + +# Offer Filter Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Offer Filter (this schema) | +| [xdm:name](#xdmname) | `string` | **Required** | Offer Filter (this schema) | +| [xdm:value](#xdmvalue) | Filter Expression Tree | **Required** | Offer Filter (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### ID + +The unique identifier of the filter. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:name +### Name + +Filter name + +`xdm:name` +* is **required** +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:value +### Expression taking offer XDM instances (list of trees) as input + +Contains the condition that is used to select offers based on a combination of tags or, directly, using the @id of offers. + +`xdm:value` +* is **required** +* type: Filter Expression Tree +* defined in this schema + +### xdm:value Type + + +* [Filter Expression Tree](filter-expression/filter-expression.schema.md) – `https://ns.adobe.com/experience/offer-management/filter-expression` + + + + diff --git a/docs/reference/adobe/experience/offer-management/offer-placement.schema.json b/docs/reference/adobe/experience/offer-management/offer-placement.schema.json new file mode 100644 index 000000000..fc72c8f88 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer-placement.schema.json @@ -0,0 +1,69 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/offer-placement", + "meta:abstract": false, + "meta:extensible": true, + "type": "object", + "title": "Placement", + "description": "An *offer placement* is a location or place in a personalized message or content experience. It is used to set technical constraints for content selected during personalization. Technical constraints include the content component type that is expected from the personalization (offer representation) and the channel that indicates the context for consuming the content. The channel imposes further constraints on the media type. For instance, html content used in an email is often structured differently than html content used on the web. The placement also represents a request to produce certain types of metrics when an experience event is produced where this placemement is involved. For instance the placement facilitates a personalized clickable image inside an email shown to an end user. The placement may for instance request from the assembled experience that the click on its image gets reported in an experience event with a metric `https://ns.adobe.com/xdm/data/metrics/web/linkclicks` and a reference to this placement. \nAn *offer* with its content representations refers to an offer placement object by the placement's @id. This is important that the constraints are not enumerated in the offer or the placement. The placement can be thought to represent the contract between the offer's content and the place where the content needs to be embedded. Any number of constraints can be agreed upon and outside of the repository and can be thought to be represented by a particular offer placement object.\nAn *offer activity* referencing a particular offer placement means the activity seeks to select content items that comply with the \"virtual contract\". An offer with its representation pointing to the same offer placement means the offer has a representation that complies with that particular \"virtual contract\". \nBy extending the offer placement schema more structure could be imposed finding the particular placement object. For example, in addition to the media type \"image\" a custom placement could add a field `aspectRatio` that holds the aspect ratio. What an aspect ratio is does not need to be understood by the offer decisioning process but creating or finding and attaching content to the offer representation needs to make sure the contract is respected and only images with a perticular aspect ratio are used for the offer when the representation makes the reference to the offer placement object.\nThe mutual contract does not need to rely on physical properties of the content. One can also express an intent what the content should be. An offer placement with a 'video' media type file could be called upon to represent a pre-roll ad or another offer placement might represent that an image is a banner image on a web page.\n", + "definitions": { + "offer-placement": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "title": "ID", + "description": "The unique identifier of the placement. This identifier is assigned by clients or services that use the repository and is not generated by the repository itself. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object." + }, + "xdm:name": { + "type": "string", + "title": "Name", + "description": "An assigned name for the placement to refer to it in human interactions" + }, + "xdm:description": { + "type": "string", + "title": "Description", + "description": "Placement description. It is used to convey human readable intentions on how dynamic content is used in the overall message delivery. That a certain space is a \"Banner\" in a web page is often conveyed via the description and not by a formal method." + }, + "xdm:channel": { + "type": "string", + "format": "uri", + "title": "Communication Channel", + "description": "A reference to the channel entity. The channel indicates where the dynamic content is intended to be delivered. The channel constraint is used to convey not only where the offer will be used but also to determine the content editor or validator that is used for the experience. See 'https://ns.adobe.com/xdm/channels/channel'" + }, + "xdm:componentType": { + "$ref": "https://ns.adobe.com/experience/offer-management/offer-representation#/definitions/content-component-type", + "title": "Content Type", + "description": "A constraint for the content that can be shown in the place described by this placement. Component Types are: image, html or plain text." + }, + "xdm:contentTypes": { + "type": "array", + "items": { + "type": "string", + "title": "MIME Media Type", + "description": "A constraint for the media type of the components that is expected in that placement. There could be more than one media type possible for one component such as different image format.", + "pattern": "\\w+\\/[-.\\w]+(?:\\+[-.\\w]+)?" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/offer-placement" + }, + { + "required": [ + "xdm:name", + "xdm:channel", + "xdm:componentType" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/offer-placement.schema.md b/docs/reference/adobe/experience/offer-management/offer-placement.schema.md new file mode 100644 index 000000000..515876ae7 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer-placement.schema.md @@ -0,0 +1,173 @@ + +# Placement Schema + +``` +https://ns.adobe.com/experience/offer-management/offer-placement +``` + +An *offer placement* is a location or place in a personalized message or content experience. It is used to set technical constraints for content selected during personalization. Technical constraints include the content component type that is expected from the personalization (offer representation) and the channel that indicates the context for consuming the content. The channel imposes further constraints on the media type. For instance, html content used in an email is often structured differently than html content used on the web. The placement also represents a request to produce certain types of metrics when an experience event is produced where this placemement is involved. For instance the placement facilitates a personalized clickable image inside an email shown to an end user. The placement may for instance request from the assembled experience that the click on its image gets reported in an experience event with a metric `https://ns.adobe.com/xdm/data/metrics/web/linkclicks` and a reference to this placement. +An *offer* with its content representations refers to an offer placement object by the placement's @id. This is important that the constraints are not enumerated in the offer or the placement. The placement can be thought to represent the contract between the offer's content and the place where the content needs to be embedded. Any number of constraints can be agreed upon and outside of the repository and can be thought to be represented by a particular offer placement object. +An *offer activity* referencing a particular offer placement means the activity seeks to select content items that comply with the "virtual contract". An offer with its representation pointing to the same offer placement means the offer has a representation that complies with that particular "virtual contract". +By extending the offer placement schema more structure could be imposed finding the particular placement object. For example, in addition to the media type "image" a custom placement could add a field `aspectRatio` that holds the aspect ratio. What an aspect ratio is does not need to be understood by the offer decisioning process but creating or finding and attaching content to the offer representation needs to make sure the contract is respected and only images with a perticular aspect ratio are used for the offer when the representation makes the reference to the offer placement object. +The mutual contract does not need to rely on physical properties of the content. One can also express an intent what the content should be. An offer placement with a 'video' media type file could be called upon to represent a pre-roll ad or another offer placement might represent that an image is a banner image on a web page. + + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/offer-placement.schema.json](adobe/experience/offer-management/offer-placement.schema.json) | +## Schema Hierarchy + +* Placement `https://ns.adobe.com/experience/offer-management/offer-placement` + * [Representation](offer-representation.schema.md) `https://ns.adobe.com/experience/offer-management/offer-representation` + + +# Placement Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Placement (this schema) | +| [xdm:channel](#xdmchannel) | `string` | **Required** | Placement (this schema) | +| [xdm:componentType](#xdmcomponenttype) | `enum` | **Required** | Placement (this schema) | +| [xdm:contentTypes](#xdmcontenttypes) | `string[]` | Optional | Placement (this schema) | +| [xdm:description](#xdmdescription) | `string` | Optional | Placement (this schema) | +| [xdm:name](#xdmname) | `string` | **Required** | Placement (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### ID + +The unique identifier of the placement. This identifier is assigned by clients or services that use the repository and is not generated by the repository itself. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:channel +### Communication Channel + +A reference to the channel entity. The channel indicates where the dynamic content is intended to be delivered. The channel constraint is used to convey not only where the offer will be used but also to determine the content editor or validator that is used for the experience. 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](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:componentType +### Content Type + +A constraint for the content that can be shown in the place described by this placement. Component Types are: image, html or plain text. + +`xdm:componentType` +* is **required** +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmcomponenttype-known-values). + +### xdm:componentType Known Values +| Value | Description | +|-------|-------------| +| `https://ns.adobe.com/experience/offer-management/content-component-text` | Text component | +| `https://ns.adobe.com/experience/offer-management/content-component-html` | HTML component | +| `https://ns.adobe.com/experience/offer-management/content-component-imagelink` | Image and click link component | + + + + +## xdm:contentTypes + + +`xdm:contentTypes` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:contentTypes Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5Cw%2B%5C%2F%5B-.%5Cw%5D%2B(%3F%3A%5C%2B%5B-.%5Cw%5D%2B)%3F)): +```regex +\w+\/[-.\w]+(?:\+[-.\w]+)? +``` + + + + +A constraint for the media type of the components that is expected in that placement. There could be more than one media type possible for one component such as different image format. + + + + + + + +## xdm:description +### Description + +Placement description. It is used to convey human readable intentions on how dynamic content is used in the overall message delivery. That a certain space is a "Banner" in a web page is often conveyed via the description and not by a formal method. + +`xdm:description` +* is optional +* type: `string` +* defined in this schema + +### xdm:description Type + + +`string` + + + + + + +## xdm:name +### Name + +An assigned name for the placement to refer to it in human interactions + +`xdm:name` +* is **required** +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/offer-management/offer-representation.schema.json b/docs/reference/adobe/experience/offer-management/offer-representation.schema.json new file mode 100644 index 000000000..2f5e98ccb --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer-representation.schema.json @@ -0,0 +1,222 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/offer-representation", + "meta:abstract": false, + "meta:extensible": true, + "type": "object", + "title": "Representation", + "description": "Offer representation.", + "definitions": { + "offer-representation": { + "properties": { + "xdm:components": { + "type": "array", + "description": "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.", + "items": { + "$ref": "#/definitions/content-component" + } + }, + "xdm:channel": { + "type": "string", + "format": "uri", + "title": "Channel", + "description": "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:placement": { + "type": "string", + "format": "uri", + "title": "Placement", + "description": "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" + } + } + }, + "content-component-type": { + "type": "string", + "format": "uri", + "title": "Content Component Type", + "description": "Content component type: imagelink, html or text.", + "enum": [ + "https://ns.adobe.com/experience/offer-management/content-component-text", + "https://ns.adobe.com/experience/offer-management/content-component-html", + "https://ns.adobe.com/experience/offer-management/content-component-imagelink" + ], + "meta:enum": { + "https://ns.adobe.com/experience/offer-management/content-component-text": "Text component", + "https://ns.adobe.com/experience/offer-management/content-component-html": "HTML component", + "https://ns.adobe.com/experience/offer-management/content-component-imagelink": "Image and click link component" + } + }, + "content-component": { + "allOf": [ + { + "type": "object", + "description": "Content components are the fragments associated with the a particular offer representation. Those fragments are used to compose the end-user experience. The content resource has optional HAL links to the file resource.", + "meta:extends": [ + "https://ns.adobe.com/xdm/external/hal/resource#/definitions/hal" + ], + "properties": { + "@type": { + "$ref": "#/definitions/content-component-type", + "description": "Type of the component. Acts as processing hint for the client. When the experience is assembled the composer will look for the component(s) that have a specific type." + }, + "dc:format": { + "meta:usereditable": false, + "type": "string", + "title": "Format", + "pattern": "\\w+\\/[-.\\w]+(?:\\+[-.\\w]+)?", + "examples": [ + "application/vnd.adobe.photoshop" + ], + "description": "The physical or digital manifestation of the resource. Typically, Format should include the media-type of the resource. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource. Recommended best practice is to select a value from a controlled vocabulary (for example, the list of [Internet Media Types](http://www.iana.org/ assignments/media-types/) defining computer media formats)." + }, + "dc:language": { + "meta:usereditable": false, + "type": "array", + "title": "Language", + "items": { + "type": "string", + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$" + }, + "description": "The language or languages of the resource.\nLanguages are specified in language code as defined in [IETF RFC 3066](https://www.ietf.org/rfc/rfc3066.txt), which is part of BCP 47, which is used elsewhere in XDM.", + "examples": [ + "\n", + "pt-BR", + "es-ES" + ] + }, + "repo:name": { + "type": "string", + "description": "Some hint about where to locate the repository that stores the external asset by the \"repo:id\"." + }, + "repo:id": { + "type": "string", + "meta:immutable": true, + "meta:usereditable": false, + "description": "An optional unique identifier to reference the asset in a content repository. When Platform APIs are used to retrieve the representation the client can expect an additional property \"repo:resolveUrl\" to retrieve the asset.", + "examples": [ + "urn:aaid:sc:US:6dc33479-13ca-4b19-b25d-c805eff8a69e" + ] + }, + "repo:resolveURL": { + "type": "string", + "format": "uri", + "meta:immutable": true, + "meta:usereditable": false, + "description": "An optional unique resource locator to read the asset in a content repository. This will make it easier to obtain the asset without the client understanding where the asset is manages and what APIs to call. This is similar to a HAL link but the semantic is simpler and more purposeful.", + "examples": [ + "https://plaftform.adobe.io/resolveByPath?path="/mycorp/content/projectx/fragment/prod/herobanners/banner14.html3"" + ] + } + } + }, + { + "required": [ + "@type", + "dc:format" + ] + } + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/offer-representation" + }, + { + "required": [ + "xdm:components", + "xdm:channel", + "xdm:placement" + ] + } + ], + "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-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" + }, + { + "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" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/offer-representation.schema.md b/docs/reference/adobe/experience/offer-management/offer-representation.schema.md new file mode 100644 index 000000000..959b01f87 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer-representation.schema.md @@ -0,0 +1,181 @@ + +# Representation Schema + +``` +https://ns.adobe.com/experience/offer-management/offer-representation +``` + +Offer representation. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/offer-representation.schema.json](adobe/experience/offer-management/offer-representation.schema.json) | + +## Representation Examples + +```json +{ + "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" +} +``` + +```json +{ + "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" +} +``` + +```json +{ + "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" +} +``` + + +# Representation Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:channel](#xdmchannel) | `string` | **Required** | Representation (this schema) | +| [xdm:components](#xdmcomponents) | reference | **Required** | Representation (this schema) | +| [xdm:placement](#xdmplacement) | `string` | **Required** | Representation (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](http://tools.ietf.org/html/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](http://tools.ietf.org/html/rfc3986)) + + + + + diff --git a/docs/reference/adobe/experience/offer-management/offer.schema.json b/docs/reference/adobe/experience/offer-management/offer.schema.json new file mode 100644 index 000000000..77cd87b7a --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer.schema.json @@ -0,0 +1,113 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/offer", + "meta:abstract": true, + "meta:extensible": true, + "type": "object", + "title": "Offer", + "description": "This is the base concept for offers that are used for personalization and those that serve as fallback choices when none of offers for personalization qualify at within the given context.", + "definitions": { + "offer": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "title": "ID", + "description": "The unique identifier of the offer. It must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object." + }, + "xdm:name": { + "type": "string", + "title": "Name", + "description": "The offer's name. A human readable string to find one or more offers." + }, + "xdm:status": { + "type": "string", + "title": "Status", + "description": "Offer Status allows user workflows to be conducted with offers. The status may affect where an offer is visible or considered relevant. Status changes are driven by the clients or services that use offers.", + "enum": [ + "draft", + "pending", + "rejected", + "approved", + "archived" + ], + "meta:enum": { + "draft": "Draft", + "pending": "Pending", + "rejected": "Rejected", + "approved": "Approved", + "archived": "Archived" + } + }, + "xdm:tags": { + "type": "array", + "title": "Tags", + "description": "The set of tags associated with this offer. The tags are used in offer filter expressions to constrain the overall offer inventory to a topical sub set (category).", + "items": { + "type": "string", + "format": "uri", + "description": "An identifier of a tag object. The value is the @id of the tag that is referenced. See tag schema: https://ns.adobe.com/experience/offer-management/tag" + } + }, + "xdm:representations": { + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/experience/offer-management/offer-representation" + }, + "title": "Representations", + "description": "Offer representations for different content variants. A single offer can have multiple contents variants. An offer representation is the object that connects offers to content. Content is information that is directed towards an audience for consumption in a (digital) experience. Content is delivered through channels (or a particular medium). " + }, + "xdm:customMetadata": { + "type": "object", + "patternProperties": { + ".+": { + "type": "string" + } + }, + "title": "Custom Properties", + "description": "Custom metadata is a key-value map that allows the end-users to attach properties to individual offer instances. Any string can be used as a key name, the values are also strings." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/offer" + }, + { + "required": [ + "xdm:name", + "xdm:status" + ] + } + ], + "examples": [ + { + "@id": "xcore:personalized-offer:e526a1503bf29e9", + "xdm:name": "Personalized Offer 1", + "xdm:status": "approved", + "xdm:representations": [ + { + "xdm:components": [ + { + "xdm:text": "You can always get what you want!", + "@type": "https://ns.adobe.com/experience/offer-management/content-component-text", + "dc:format": "text/template" + } + ], + "xdm:channel": "https://ns.adobe.com/xdm/channels/email", + "xdm:placement": "xcore:offer-placement:e51944a87919861" + } + ], + "xdm:tags": [ + "xcore:tag:e5196f1d9119862" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/offer.schema.md b/docs/reference/adobe/experience/offer-management/offer.schema.md new file mode 100644 index 000000000..f6907be56 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/offer.schema.md @@ -0,0 +1,194 @@ + +# Offer Schema + +``` +https://ns.adobe.com/experience/offer-management/offer +``` + +This is the base concept for offers that are used for personalization and those that serve as fallback choices when none of offers for personalization qualify at within the given context. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/offer.schema.json](adobe/experience/offer-management/offer.schema.json) | + +## Offer Example +```json +{ + "@id": "xcore:personalized-offer:e526a1503bf29e9", + "xdm:name": "Personalized Offer 1", + "xdm:status": "approved", + "xdm:representations": [ + { + "xdm:components": [ + { + "xdm:text": "You can always get what you want!", + "@type": "https://ns.adobe.com/experience/offer-management/content-component-text", + "dc:format": "text/template" + } + ], + "xdm:channel": "https://ns.adobe.com/xdm/channels/email", + "xdm:placement": "xcore:offer-placement:e51944a87919861" + } + ], + "xdm:tags": [ + "xcore:tag:e5196f1d9119862" + ] +} +``` + +# Offer Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Offer (this schema) | +| [xdm:customMetadata](#xdmcustommetadata) | `object` | Optional | Offer (this schema) | +| [xdm:name](#xdmname) | `string` | **Required** | Offer (this schema) | +| [xdm:representations](#xdmrepresentations) | Representation | Optional | Offer (this schema) | +| [xdm:status](#xdmstatus) | `enum` | **Required** | Offer (this schema) | +| [xdm:tags](#xdmtags) | `string[]` | Optional | Offer (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### ID + +The unique identifier of the offer. It must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:customMetadata +### Custom Properties + +Custom metadata is a key-value map that allows the end-users to attach properties to individual offer instances. Any string can be used as a key name, the values are also strings. + +`xdm:customMetadata` +* is optional +* type: `object` +* defined in this schema + +### xdm:customMetadata Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:name +### Name + +The offer's name. A human readable string to find one or more offers. + +`xdm:name` +* is **required** +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:representations +### Representations + +Offer representations for different content variants. A single offer can have multiple contents variants. An offer representation is the object that connects offers to content. Content is information that is directed towards an audience for consumption in a (digital) experience. Content is delivered through channels (or a particular medium). + +`xdm:representations` +* is optional +* type: Representation + +* defined in this schema + +### xdm:representations Type + + +Array type: Representation + +All items must be of the type: +* [Representation](offer-representation.schema.md) – `https://ns.adobe.com/experience/offer-management/offer-representation` + + + + + + + + +## xdm:status +### Status + +Offer Status allows user workflows to be conducted with offers. The status may affect where an offer is visible or considered relevant. Status changes are driven by the clients or services that use offers. + +`xdm:status` +* is **required** +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmstatus-known-values). + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `draft` | Draft | +| `pending` | Pending | +| `rejected` | Rejected | +| `approved` | Approved | +| `archived` | Archived | + + + + +## xdm:tags +### Tags + +The set of tags associated with this offer. The tags are used in offer filter expressions to constrain the overall offer inventory to a topical sub set (category). + +`xdm:tags` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:tags Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + +An identifier of a tag object. The value is the @id of the tag that is referenced. See tag schema: https://ns.adobe.com/experience/offer-management/tag + + + + + + diff --git a/docs/reference/adobe/experience/offer-management/personalized-offer.schema.json b/docs/reference/adobe/experience/offer-management/personalized-offer.schema.json new file mode 100644 index 000000000..f4d58ccae --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/personalized-offer.schema.json @@ -0,0 +1,95 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/personalized-offer", + "meta:extends": [ + "https://ns.adobe.com/experience/offer-management/offer" + ], + "meta:abstract": false, + "meta:extensible": true, + "type": "object", + "title": "Adobe Experience Cloud Personalized Offer", + "description": "A personalized offer is the conceptual entity that is chosen during the decisioning process. The objective for decisioning is to take a large inventory of content items and apply numerous constraint rules to that inventory to first narrow it down and then rank the qualifying options. The outcome modifies the overall experience to accommodate specific individuals, sometimes tied to groups or segments of individuals.", + "definitions": { + "personalized-offer": { + "allOf": [ + { + "properties": { + "xdm:rank": { + "$ref": "https://ns.adobe.com/experience/offer-management/rank", + "title": "Rank", + "description": "Offer rank (priority). Defines what is considered the \"best offer\" given the context of the decision. Among all the offers that have not been disqualified due other constraints, the ranking will decide top (or top N) offers to be proposed." + }, + "xdm:selectionConstraint": { + "$ref": "https://ns.adobe.com/experience/offer-management/selection-constraint", + "title": "Selection Constraints", + "description": "Selection constraints define all rules that decide if an offer disqualifies from the set of eligible offers at this moment, for this context and/or for this profile identity. For example, offers typically have a start and end date before and after they are not eligible for consideration anymore" + }, + "xdm:cappingConstraint": { + "$ref": "https://ns.adobe.com/experience/offer-management/capping-constraint", + "title": "Capping Constraints", + "description": "Capping constraint define additional rules based on prior offer proposition, either across all audiences or for a particular profile identity." + } + } + }, + { + "$ref": "https://ns.adobe.com/experience/offer-management/offer#/definitions/offer" + } + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/experience/offer-management/offer" + }, + { + "$ref": "#/definitions/personalized-offer" + }, + { + "required": [ + "xdm:rank", + "xdm:selectionConstraint" + ] + } + ], + "examples": [ + { + "@id": "xcore:personalized-offer:e526a1503bf29e9", + "xdm:name": "Personalized Offer 1", + "xdm:status": "approved", + "xdm:representations": [ + { + "xdm:components": [ + { + "xdm:text": "You can always get what you want!", + "@type": "https://ns.adobe.com/experience/offer-management/content-component-text", + "dc:format": "text/template" + } + ], + "xdm:channel": "https://ns.adobe.com/xdm/channels/email", + "xdm:placement": "xcore:offer-placement:e51944a87919861" + } + ], + "xdm:tags": [ + "xcore:tag:e5196f1d9119862" + ], + "xdm:selectionConstraint": { + "xdm:startDate": "2018-03-13T05:59:18.914Z", + "xdm:endDate": "2018-12-27T05:59:18.914Z", + "xdm:eligibilityRule": "xcore:eligibility-rule:e5244c22eff29e8" + }, + "xdm:cappingConstraint": { + "xdm:frequency": 2, + "xdm:volume": 10 + }, + "xdm:rank": { + "xdm:priority": 1 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/personalized-offer.schema.md b/docs/reference/adobe/experience/offer-management/personalized-offer.schema.md new file mode 100644 index 000000000..b583fd906 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/personalized-offer.schema.md @@ -0,0 +1,211 @@ + +# Adobe Experience Cloud Personalized Offer Schema + +``` +https://ns.adobe.com/experience/offer-management/personalized-offer +``` + +A personalized offer is the conceptual entity that is chosen during the decisioning process. The objective for decisioning is to take a large inventory of content items and apply numerous constraint rules to that inventory to first narrow it down and then rank the qualifying options. The outcome modifies the overall experience to accommodate specific individuals, sometimes tied to groups or segments of individuals. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/personalized-offer.schema.json](adobe/experience/offer-management/personalized-offer.schema.json) | +## Schema Hierarchy + +* Adobe Experience Cloud Personalized Offer `https://ns.adobe.com/experience/offer-management/personalized-offer` + * [Offer](offer.schema.md) `https://ns.adobe.com/experience/offer-management/offer` + + +## Adobe Experience Cloud Personalized Offer Example +```json +{ + "@id": "xcore:personalized-offer:e526a1503bf29e9", + "xdm:name": "Personalized Offer 1", + "xdm:status": "approved", + "xdm:representations": [ + { + "xdm:components": [ + { + "xdm:text": "You can always get what you want!", + "@type": "https://ns.adobe.com/experience/offer-management/content-component-text", + "dc:format": "text/template" + } + ], + "xdm:channel": "https://ns.adobe.com/xdm/channels/email", + "xdm:placement": "xcore:offer-placement:e51944a87919861" + } + ], + "xdm:tags": [ + "xcore:tag:e5196f1d9119862" + ], + "xdm:selectionConstraint": { + "xdm:startDate": "2018-03-13T05:59:18.914Z", + "xdm:endDate": "2018-12-27T05:59:18.914Z", + "xdm:eligibilityRule": "xcore:eligibility-rule:e5244c22eff29e8" + }, + "xdm:cappingConstraint": { + "xdm:frequency": 2, + "xdm:volume": 10 + }, + "xdm:rank": { + "xdm:priority": 1 + } +} +``` + +# Adobe Experience Cloud Personalized Offer Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Offer](offer.schema.md#id) | +| [xdm:customMetadata](#xdmcustommetadata) | `object` | Optional | [Offer](offer.schema.md#xdmcustommetadata) | +| [xdm:name](#xdmname) | `string` | Optional | [Offer](offer.schema.md#xdmname) | +| [xdm:representations](#xdmrepresentations) | Representation | Optional | [Offer](offer.schema.md#xdmrepresentations) | +| [xdm:status](#xdmstatus) | `enum` | Optional | [Offer](offer.schema.md#xdmstatus) | +| [xdm:tags](#xdmtags) | `string[]` | Optional | [Offer](offer.schema.md#xdmtags) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### ID + +The unique identifier of the offer. It must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object. + +`@id` +* is optional +* type: `string` +* defined in [Offer](offer.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:customMetadata +### Custom Properties + +Custom metadata is a key-value map that allows the end-users to attach properties to individual offer instances. Any string can be used as a key name, the values are also strings. + +`xdm:customMetadata` +* is optional +* type: `object` +* defined in [Offer](offer.schema.md#xdmcustommetadata) + +### xdm:customMetadata Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:name +### Name + +The offer's name. A human readable string to find one or more offers. + +`xdm:name` +* is optional +* type: `string` +* defined in [Offer](offer.schema.md#xdmname) + +### xdm:name Type + + +`string` + + + + + + +## xdm:representations +### Representations + +Offer representations for different content variants. A single offer can have multiple contents variants. An offer representation is the object that connects offers to content. Content is information that is directed towards an audience for consumption in a (digital) experience. Content is delivered through channels (or a particular medium). + +`xdm:representations` +* is optional +* type: Representation + +* defined in [Offer](offer.schema.md#xdmrepresentations) + +### xdm:representations Type + + +Array type: Representation + +All items must be of the type: +* [Representation](offer-representation.schema.md) – `https://ns.adobe.com/experience/offer-management/offer-representation` + + + + + + + + +## xdm:status +### Status + +Offer Status allows user workflows to be conducted with offers. The status may affect where an offer is visible or considered relevant. Status changes are driven by the clients or services that use offers. + +`xdm:status` +* is optional +* type: `enum` +* defined in [Offer](offer.schema.md#xdmstatus) + +The value of this property **must** be equal to one of the [known values below](#xdmstatus-known-values). + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `draft` | Draft | +| `pending` | Pending | +| `rejected` | Rejected | +| `approved` | Approved | +| `archived` | Archived | + + + + +## xdm:tags +### Tags + +The set of tags associated with this offer. The tags are used in offer filter expressions to constrain the overall offer inventory to a topical sub set (category). + +`xdm:tags` +* is optional +* type: `string[]` + +* defined in [Offer](offer.schema.md#xdmtags) + +### xdm:tags Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + +An identifier of a tag object. The value is the @id of the tag that is referenced. See tag schema: https://ns.adobe.com/experience/offer-management/tag + + + + + + diff --git a/docs/reference/adobe/experience/offer-management/proposition-response-detail.schema.json b/docs/reference/adobe/experience/offer-management/proposition-response-detail.schema.json new file mode 100644 index 000000000..b3a05f782 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/proposition-response-detail.schema.json @@ -0,0 +1,63 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/offer-management/proposition-response-detail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Offer Response Detail", + "type": "object", + "meta:abstract": true, + "meta:extensible": true, + "description": "A proposition response detail is used to capture the Response to an offer proposition. Proposition responses are enriched with the properties of the activity and offer at the time the decision was made.", + "definitions": { + "response-detail-datatype": { + "properties": { + "xdm:activity": { + "title": "Offer Activity", + "description": "Snapshot of the activity for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the decision activity.", + "$ref": "https://ns.adobe.com/experience/offer-management/offer-activity-detail" + }, + "xdm:offer": { + "title": "Offer", + "description": "Snapshot of the offer that the recipient responded to. The object contains a at least the xdm:id property value which is the identifier of an offer.", + "$ref": "https://ns.adobe.com/experience/offer-management/offer-detail" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/response-detail-datatype" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:activity": { + "xdm:id": "xcore:offer-activity:f66f792de3c0ba9", + "xdm:name": "Email - Next Best Offer", + "xdm:placement": "xcore:offer-placement:f6524d27c2d6edd", + "xdm:filter": "xcore:offer-filter:f66f792de3c0ba9" + }, + "xdm:offer": { + "xdm:id": "xcore:personalized-offer:f67bab756ed6ee4", + "xdm:name": "Beach Vacations", + "xdm:tags": [ + "xcore:tag:f68535bc217322e", + "xcore:tag:f66f67dbe6d6ee1" + ], + "xdm:characteristics": { + "cost": "$2400", + "inventoryId": "BORA04", + "country": "French Polynesia" + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/proposition-response-detail.schema.md b/docs/reference/adobe/experience/offer-management/proposition-response-detail.schema.md new file mode 100644 index 000000000..0b9ca2478 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/proposition-response-detail.schema.md @@ -0,0 +1,90 @@ + +# Offer Response Detail Schema + +``` +https://ns.adobe.com/experience/offer-management/proposition-response-detail +``` + +A proposition response detail is used to capture the Response to an offer proposition. Proposition responses are enriched with the properties of the activity and offer at the time the decision was made. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/offer-management/proposition-response-detail.schema.json](adobe/experience/offer-management/proposition-response-detail.schema.json) | +## Schema Hierarchy + +* Offer Response Detail `https://ns.adobe.com/experience/offer-management/proposition-response-detail` + * [Extensibility base schema](../../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Offer Activity Detail](offer-activity-detail.schema.md) `https://ns.adobe.com/experience/offer-management/offer-activity-detail` + * [Offer Detail](offer-detail.schema.md) `https://ns.adobe.com/experience/offer-management/offer-detail` + + +## Offer Response Detail Example +```json +{ + "xdm:activity": { + "xdm:id": "xcore:offer-activity:f66f792de3c0ba9", + "xdm:name": "Email - Next Best Offer", + "xdm:placement": "xcore:offer-placement:f6524d27c2d6edd", + "xdm:filter": "xcore:offer-filter:f66f792de3c0ba9" + }, + "xdm:offer": { + "xdm:id": "xcore:personalized-offer:f67bab756ed6ee4", + "xdm:name": "Beach Vacations", + "xdm:tags": [ + "xcore:tag:f68535bc217322e", + "xcore:tag:f66f67dbe6d6ee1" + ], + "xdm:characteristics": { + "cost": "$2400", + "inventoryId": "BORA04", + "country": "French Polynesia" + } + } +} +``` + +# Offer Response Detail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:activity](#xdmactivity) | Offer Activity Detail | Optional | Offer Response Detail (this schema) | +| [xdm:offer](#xdmoffer) | Offer Detail | Optional | Offer Response Detail (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:activity +### Offer Activity + +Snapshot of the activity for which the proposition was made. The object contains at least the xdm:id property value which is the identifier of the decision activity. + +`xdm:activity` +* is optional +* type: Offer Activity Detail +* defined in this schema + +### xdm:activity Type + + +* [Offer Activity Detail](offer-activity-detail.schema.md) – `https://ns.adobe.com/experience/offer-management/offer-activity-detail` + + + + + +## xdm:offer +### Offer + +Snapshot of the offer that the recipient responded to. The object contains a at least the xdm:id property value which is the identifier of an offer. + +`xdm:offer` +* is optional +* type: Offer Detail +* defined in this schema + +### xdm:offer Type + + +* [Offer Detail](offer-detail.schema.md) – `https://ns.adobe.com/experience/offer-management/offer-detail` + + + + diff --git a/docs/reference/adobe/experience/offer-management/rank.schema.json b/docs/reference/adobe/experience/offer-management/rank.schema.json new file mode 100644 index 000000000..a1bb9133a --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/rank.schema.json @@ -0,0 +1,37 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/rank", + "meta:abstract": false, + "meta:extensible": true, + "type": "object", + "title": "Offer Rank", + "description": "Offer rank (priority) represents the default order in which one offer is selected over another in case there is no profile specific ranking order known. If after comparing the priority value two or more offers are still tied one is chosen at random and used in the offer proposition.", + "definitions": { + "rank": { + "properties": { + "xdm:priority": { + "type": "integer", + "title": "Priority", + "description": "Offer priority", + "minimum": 0 + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/rank" + }, + { + "required": [ + "xdm:priority" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/rank.schema.md b/docs/reference/adobe/experience/offer-management/rank.schema.md new file mode 100644 index 000000000..6794d8121 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/rank.schema.md @@ -0,0 +1,40 @@ + +# Offer Rank Schema + +``` +https://ns.adobe.com/experience/offer-management/rank +``` + +Offer rank (priority) represents the default order in which one offer is selected over another in case there is no profile specific ranking order known. If after comparing the priority value two or more offers are still tied one is chosen at random and used in the offer proposition. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/rank.schema.json](adobe/experience/offer-management/rank.schema.json) | + +# Offer Rank Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:priority](#xdmpriority) | `integer` | **Required** | Offer Rank (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:priority +### Priority + +Offer priority + +`xdm:priority` +* is **required** +* type: `integer` +* defined in this schema + +### xdm:priority Type + + +`integer` +* minimum value: `0` + + + + + diff --git a/docs/reference/adobe/experience/offer-management/selection-constraint.schema.json b/docs/reference/adobe/experience/offer-management/selection-constraint.schema.json new file mode 100644 index 000000000..f38109220 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/selection-constraint.schema.json @@ -0,0 +1,50 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/selection-constraint", + "meta:abstract": false, + "meta:extensible": true, + "type": "object", + "title": "Offer Selection Constraint", + "description": "Offer selection constraint specify conditions that have to be met in order for an offer to be included in weighing the best offer. Those constraints can have many aspects, ranging from date constraints over rules applied to the user profile fields to rules checked against contextual data available at decision time.", + "definitions": { + "selection-constraint": { + "properties": { + "xdm:startDate": { + "type": "string", + "format": "date-time", + "title": "Start Date", + "description": "Offer start date. Offers that have not reached their start date are not yet considered eligible in the decisioning." + }, + "xdm:endDate": { + "type": "string", + "format": "date-time", + "title": "End Date", + "description": "Offer end date. Offers that have passed their end date are no longer considered eligible in the decisioning process." + }, + "xdm:eligibilityRule": { + "type": "string", + "format": "uri", + "title": "Eligibility Rule", + "description": "The reference to an eligibility rule that tests a condition using the profile and/or other contextual XDM instances. The value is the URI (@id) of the eligibility rule that is referenced. See schema https://ns.adobe.com/experience/offer-management/eligibility-rule" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/selection-constraint" + }, + { + "required": [ + "xdm:startDate", + "xdm:endDate" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/selection-constraint.schema.md b/docs/reference/adobe/experience/offer-management/selection-constraint.schema.md new file mode 100644 index 000000000..b07e4223b --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/selection-constraint.schema.md @@ -0,0 +1,84 @@ + +# Offer Selection Constraint Schema + +``` +https://ns.adobe.com/experience/offer-management/selection-constraint +``` + +Offer selection constraint specify conditions that have to be met in order for an offer to be included in weighing the best offer. Those constraints can have many aspects, ranging from date constraints over rules applied to the user profile fields to rules checked against contextual data available at decision time. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/selection-constraint.schema.json](adobe/experience/offer-management/selection-constraint.schema.json) | + +# Offer Selection Constraint Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:eligibilityRule](#xdmeligibilityrule) | `string` | Optional | Offer Selection Constraint (this schema) | +| [xdm:endDate](#xdmenddate) | `string` | **Required** | Offer Selection Constraint (this schema) | +| [xdm:startDate](#xdmstartdate) | `string` | **Required** | Offer Selection Constraint (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:eligibilityRule +### Eligibility Rule + +The reference to an eligibility rule that tests a condition using the profile and/or other contextual XDM instances. The value is the URI (@id) of the eligibility rule that is referenced. See schema https://ns.adobe.com/experience/offer-management/eligibility-rule + +`xdm:eligibilityRule` +* is optional +* type: `string` +* defined in this schema + +### xdm:eligibilityRule Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:endDate +### End Date + +Offer end date. Offers that have passed their end date are no longer considered eligible in the decisioning process. + +`xdm:endDate` +* is **required** +* type: `string` +* defined in this schema + +### xdm:endDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:startDate +### Start Date + +Offer start date. Offers that have not reached their start date are not yet considered eligible in the decisioning. + +`xdm:startDate` +* is **required** +* type: `string` +* defined in this schema + +### xdm:startDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + diff --git a/docs/reference/adobe/experience/offer-management/tag.schema.json b/docs/reference/adobe/experience/offer-management/tag.schema.json new file mode 100644 index 000000000..e49d34960 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/tag.schema.json @@ -0,0 +1,42 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/offer-management/tag", + "meta:abstract": false, + "meta:extensible": true, + "type": "object", + "title": "Tag", + "description": "A tag is a keyword or term assigned to a piece of information. Tags in this domain are reusable, searchable and identifiable keywords, i.e. their identity gets attached to other objects not simply the string that is used for human consumption. Therefore the same tag could have multiple, human readable representations. Tags can also be classified or arranged in an order that conveys additional semantics. This semantics is, however, not specified in this domain.", + "definitions": { + "tag": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "title": "ID", + "description": "The unique identifier of the tag. This identifier is assigned by clients or services that use the repository and is not generated by the repository itself. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object." + }, + "xdm:name": { + "type": "string", + "title": "Tag Name", + "description": "The tag's external human-readable representation to the clients." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/tag" + }, + { + "required": [ + "xdm:name" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/offer-management/tag.schema.md b/docs/reference/adobe/experience/offer-management/tag.schema.md new file mode 100644 index 000000000..46243d9c5 --- /dev/null +++ b/docs/reference/adobe/experience/offer-management/tag.schema.md @@ -0,0 +1,61 @@ + +# Tag Schema + +``` +https://ns.adobe.com/experience/offer-management/tag +``` + +A tag is a keyword or term assigned to a piece of information. Tags in this domain are reusable, searchable and identifiable keywords, i.e. their identity gets attached to other objects not simply the string that is used for human consumption. Therefore the same tag could have multiple, human readable representations. Tags can also be classified or arranged in an order that conveys additional semantics. This semantics is, however, not specified in this domain. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/offer-management/tag.schema.json](adobe/experience/offer-management/tag.schema.json) | + +# Tag Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Tag (this schema) | +| [xdm:name](#xdmname) | `string` | **Required** | Tag (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### ID + +The unique identifier of the tag. This identifier is assigned by clients or services that use the repository and is not generated by the repository itself. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:name +### Tag Name + +The tag's external human-readable representation to the clients. + +`xdm:name` +* is **required** +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/profile-edgeregion.schema.json b/docs/reference/adobe/experience/profile-edgeregion.schema.json new file mode 100644 index 000000000..e34750959 --- /dev/null +++ b/docs/reference/adobe/experience/profile-edgeregion.schema.json @@ -0,0 +1,63 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/profile-edgeregion", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Data capture region for Profile", + "description": "Edge region locations and timestamps where the profile data is captured", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "definitions": { + "profile-edgeregion": { + "properties": { + "xdm:userActivityRegions": { + "title": "Data capture region information", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "type": "object", + "meta:xdmType": "object", + "properties": { + "xdm:captureTimestamp": { + "title": "Edge data capture timestamp", + "type": "string", + "format": "date-time", + "description": "The time when data was captured on region node." + } + } + }, + "description": "Map of Location and timestamp of regions where this profile was captured." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-edgeregion" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:userActivityRegions": { + "VA6": { + "xdm:captureTimestamp": "2017-09-26T15:52:20+00:00" + }, + "OR2": { + "xdm:captureTimestamp": "2017-09-26T15:52:20+00:00" + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/profile-edgeregion.schema.md b/docs/reference/adobe/experience/profile-edgeregion.schema.md new file mode 100644 index 000000000..13d03d883 --- /dev/null +++ b/docs/reference/adobe/experience/profile-edgeregion.schema.md @@ -0,0 +1,62 @@ + +# Data capture region for Profile Schema + +``` +https://ns.adobe.com/experience/profile-edgeregion +``` + +Edge region locations and timestamps where the profile data is captured + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/profile-edgeregion.schema.json](adobe/experience/profile-edgeregion.schema.json) | +## Schema Hierarchy + +* Data capture region for Profile `https://ns.adobe.com/experience/profile-edgeregion` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Data capture region for Profile Example +```json +{ + "xdm:userActivityRegions": { + "VA6": { + "xdm:captureTimestamp": "2017-09-26T15:52:20+00:00" + }, + "OR2": { + "xdm:captureTimestamp": "2017-09-26T15:52:20+00:00" + } + } +} +``` + +# Data capture region for Profile Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:userActivityRegions](#xdmuseractivityregions) | `object` | Optional | Data capture region for Profile (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:userActivityRegions +### Data capture region information + +Map of Location and timestamp of regions where this profile was captured. + +`xdm:userActivityRegions` +* is optional +* type: `object` +* defined in this schema + +### xdm:userActivityRegions Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + diff --git a/docs/reference/adobe/experience/profile/experienceevent-shared.schema.json b/docs/reference/adobe/experience/profile/experienceevent-shared.schema.json new file mode 100644 index 000000000..3010c58de --- /dev/null +++ b/docs/reference/adobe/experience/profile/experienceevent-shared.schema.json @@ -0,0 +1,40 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/profile/experienceevent-shared", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Unified Profile Service ExperienceEvent Shared Extension", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Unified Profile Service shared extension. Contains Solution fields shared with other Solutions.", + "definitions": { + "profile-experienceevent-shared": { + "properties": { + "https://ns.adobe.com/experience/profile/originDatasetID": { + "title": "Origin Dataset ID", + "type": "string", + "description": "Identity of the dataset that the Unified Profile Service ingested the data from. Usage is reserved for the Unified Profile Service." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/profile-experienceevent-shared" + } + ], + "meta:status": "stable", + "examples": [ + { + "https://ns.adobe.com/experience/profile/originDatasetID": "1299124-12-1" + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/profile/experienceevent-shared.schema.md b/docs/reference/adobe/experience/profile/experienceevent-shared.schema.md new file mode 100644 index 000000000..57f6906a8 --- /dev/null +++ b/docs/reference/adobe/experience/profile/experienceevent-shared.schema.md @@ -0,0 +1,46 @@ + +# Adobe Unified Profile Service ExperienceEvent Shared Extension Schema + +``` +https://ns.adobe.com/experience/profile/experienceevent-shared +``` + +Adobe Unified Profile Service shared extension. Contains Solution fields shared with other Solutions. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/profile/experienceevent-shared.schema.json](adobe/experience/profile/experienceevent-shared.schema.json) | + +## Adobe Unified Profile Service ExperienceEvent Shared Extension Example +```json +{ + "https://ns.adobe.com/experience/profile/originDatasetID": "1299124-12-1" +} +``` + +# Adobe Unified Profile Service ExperienceEvent Shared Extension Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/profile/originDatasetID](#httpsnsadobecomexperienceprofileorigindatasetid) | `string` | Optional | Adobe Unified Profile Service ExperienceEvent Shared Extension (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/profile/originDatasetID +### Origin Dataset ID + +Identity of the dataset that the Unified Profile Service ingested the data from. Usage is reserved for the Unified Profile Service. + +`https://ns.adobe.com/experience/profile/originDatasetID` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/profile/originDatasetID Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/profile/profile-all.schema.json b/docs/reference/adobe/experience/profile/profile-all.schema.json new file mode 100644 index 000000000..2f6b7045b --- /dev/null +++ b/docs/reference/adobe/experience/profile/profile-all.schema.json @@ -0,0 +1,108 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/experience/profile/profile-all", + "title": "Adobe Unified Profile Service Profile Union Extension", + "description": "Adobe Unified Profile Service required fields for the Profile Union.", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record-timeseries-events", + "https://ns.adobe.com/xdm/context/identitymap", + "https://ns.adobe.com/xdm/context/profile-segmentation", + "https://ns.adobe.com/xdm/context/profile-privacy" + ], + "definitions": { + "unified-profile-union": { + "properties": { + "https://ns.adobe.com/experience/profile/identityNamespaces": { + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "$ref": "https://ns.adobe.com/xdm/context/namespace" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/unified-profile-union" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record-timeseries-events" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-segmentation" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-privacy" + } + ], + "examples": [ + { + "xdm:timeSeriesEvents": [ + { + "@id": "49069bba-3014-420b-a887-3959f87d474a" + } + ], + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + }, + { + "xdm:id": "92312748749239" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2394509340-30453470347", + "xdm:authenticatedState": "authenticated" + } + ], + "https://data.adobe.io/entities/namespace/9": [ + { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" + } + ] + }, + "xdm:segmentMembership": { + "AAM": { + "04a81716-43d6-4e7a-a49c-f1d8b3129ba9": { + "xdm:version": "15", + "xdm:timestamp": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2019-04-26T15:52:25+00:00", + "xdm:status": "existing" + }, + "53cba6b2-a23b-454a-8069-fc41308f1c0f": { + "xdm:version": "3", + "xdm:lastQualificationTime": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2018-04-27T15:52:25+00:00", + "xdm:status": "realized" + } + }, + "Email": { + "abcd@adobe.com": { + "xdm:version": "1", + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "exited" + } + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/profile/profile-all.schema.md b/docs/reference/adobe/experience/profile/profile-all.schema.md new file mode 100644 index 000000000..616d07570 --- /dev/null +++ b/docs/reference/adobe/experience/profile/profile-all.schema.md @@ -0,0 +1,356 @@ + +# Adobe Unified Profile Service Profile Union Extension Schema + +``` +https://ns.adobe.com/experience/profile/profile-all +``` + +Adobe Unified Profile Service required fields for the Profile Union. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [adobe/experience/profile/profile-all.schema.json](adobe/experience/profile/profile-all.schema.json) | +## Schema Hierarchy + +* Adobe Unified Profile Service Profile Union Extension `https://ns.adobe.com/experience/profile/profile-all` + * [Time-series Extension for Record Data](../../../datatypes/data/record-timeseries-events.schema.md) `https://ns.adobe.com/xdm/data/record-timeseries-events` + * [IdentityMap](../../../mixins/shared/identitymap.schema.md) `https://ns.adobe.com/xdm/context/identitymap` + * [Profile segmentation](../../../mixins/profile/profile-segmentation.schema.md) `https://ns.adobe.com/xdm/context/profile-segmentation` + * [Profile privacy](../../../mixins/profile/profile-privacy.schema.md) `https://ns.adobe.com/xdm/context/profile-privacy` + + +## Adobe Unified Profile Service Profile Union Extension Example +```json +{ + "xdm:timeSeriesEvents": [ + { + "@id": "49069bba-3014-420b-a887-3959f87d474a" + } + ], + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + }, + { + "xdm:id": "92312748749239" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2394509340-30453470347", + "xdm:authenticatedState": "authenticated" + } + ], + "https://data.adobe.io/entities/namespace/9": [ + { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" + } + ] + }, + "xdm:segmentMembership": { + "AAM": { + "04a81716-43d6-4e7a-a49c-f1d8b3129ba9": { + "xdm:version": "15", + "xdm:timestamp": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2019-04-26T15:52:25+00:00", + "xdm:status": "existing" + }, + "53cba6b2-a23b-454a-8069-fc41308f1c0f": { + "xdm:version": "3", + "xdm:lastQualificationTime": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2018-04-27T15:52:25+00:00", + "xdm:status": "realized" + } + }, + "Email": { + "abcd@adobe.com": { + "xdm:version": "1", + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "exited" + } + } + } +} +``` + +# Adobe Unified Profile Service Profile Union Extension Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/profile/identityNamespaces](#httpsnsadobecomexperienceprofileidentitynamespaces) | `object` | Optional | Adobe Unified Profile Service Profile Union Extension (this schema) | +| [xdm:identityMap](#xdmidentitymap) | `object` | Optional | [IdentityMap](../../../mixins/shared/identitymap.schema.md#xdmidentitymap) | +| [xdm:identityPrivacyInfo](#xdmidentityprivacyinfo) | `object` | Optional | [Profile privacy](../../../mixins/profile/profile-privacy.schema.md#xdmidentityprivacyinfo) | +| [xdm:optOutConsentLevel](#xdmoptoutconsentlevel) | `object` | Optional | [Profile privacy](../../../mixins/profile/profile-privacy.schema.md#xdmoptoutconsentlevel) | +| [xdm:segmentMembership](#xdmsegmentmembership) | `object` | Optional | [Profile segmentation](../../../mixins/profile/profile-segmentation.schema.md#xdmsegmentmembership) | +| [xdm:segments](#xdmsegments) | Segment membership | Optional | [Profile segmentation](../../../mixins/profile/profile-segmentation.schema.md#xdmsegments) | +| [xdm:timeSeriesEvents](#xdmtimeseriesevents) | Time-series Schema | Optional | [Time-series Extension for Record Data](../../../datatypes/data/record-timeseries-events.schema.md#xdmtimeseriesevents) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/profile/identityNamespaces + + +`https://ns.adobe.com/experience/profile/identityNamespaces` +* is optional +* type: `object` +* defined in this schema + +### https://ns.adobe.com/experience/profile/identityNamespaces Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:identityMap + + +`xdm:identityMap` +* is optional +* type: `object` +* defined in [IdentityMap](../../../mixins/shared/identitymap.schema.md#xdmidentitymap) + +### xdm:identityMap Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:identityPrivacyInfo +### Identity level privacy information + +Captured privacy information for identities in profile. + +`xdm:identityPrivacyInfo` +* is optional +* type: `object` +* defined in [Profile privacy](../../../mixins/profile/profile-privacy.schema.md#xdmidentityprivacyinfo) + +### xdm:identityPrivacyInfo Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:optOutConsentLevel +### Opt-out consent level + +Opt-out consent level. + +`xdm:optOutConsentLevel` +* is optional +* type: `object` +* defined in [Profile privacy](../../../mixins/profile/profile-privacy.schema.md#xdmoptoutconsentlevel) + +### xdm:optOutConsentLevel Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:privacyOptOuts`| array | Optional | + + + +#### xdm:privacyOptOuts +##### Privacy opt-outs + +Encapsulates different opt-out types for data privacy. + +`xdm:privacyOptOuts` +* is optional +* type: `object[]` + + +##### xdm:privacyOptOuts Type + + +Array type: `object[]` + +All items must be of the type: +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:optOutType`| string | Optional | +| `xdm:optOutValue`| string | Optional | +| `xdm:timestamp`| string | Optional | + + + +#### xdm:optOutType +##### Opt-out type + +The type of opt-out. + +`xdm:optOutType` +* is optional +* type: `enum` + +The value of this property **must** be equal to one of the [known values below](#xdmoptoutconsentlevel-known-values). + +##### xdm:optOutType Known Values +| Value | Description | +|-------|-------------| +| `general_opt_out` | General opt-out | +| `sales_sharing_opt_out` | Sales sharing opt-out | + + + + + + +#### xdm:optOutValue +##### Opt-out value + +The value of opt-out signal. + +`xdm:optOutValue` +* is optional +* type: `enum` + +The value of this property **must** be equal to one of the [known values below](#xdmoptoutconsentlevel-known-values). + +##### xdm:optOutValue Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in | +| `out` | Opt-out | + + + + + + +#### xdm:timestamp +##### Opt-out timestamp + +Timestamp of the received opt-out signal. + +`xdm:timestamp` +* is optional +* type: `string` + +##### xdm:timestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + + + + + + + + + + + +## xdm:segmentMembership +### Segment membership map + +`xdm:segmentMembership` +* is optional +* type: `object` +* defined in [Profile segmentation](../../../mixins/profile/profile-segmentation.schema.md#xdmsegmentmembership) + +### xdm:segmentMembership Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:segments +### Segment membership + +`xdm:segments` +* is optional +* type: Segment membership + +* defined in [Profile segmentation](../../../mixins/profile/profile-segmentation.schema.md#xdmsegments) + +### xdm:segments Type + + +Array type: Segment membership + +All items must be of the type: +* [Segment membership](../../../datatypes/segmentmembership.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembership` + + + + + + + + +## xdm:timeSeriesEvents +### Time-series Events + +List of time-series based events that relate to schemas based on record. + +`xdm:timeSeriesEvents` +* is optional +* type: Time-series Schema + +* defined in [Time-series Extension for Record Data](../../../datatypes/data/record-timeseries-events.schema.md#xdmtimeseriesevents) + +### xdm:timeSeriesEvents Type + + +Array type: Time-series Schema + +All items must be of the type: +* [Time-series Schema](../../../behaviors/time-series.schema.md) – `https://ns.adobe.com/xdm/data/time-series` + + + + + + + diff --git a/docs/reference/adobe/experience/target-experienceevent.schema.json b/docs/reference/adobe/experience/target-experienceevent.schema.json new file mode 100644 index 000000000..7ae137e2b --- /dev/null +++ b/docs/reference/adobe/experience/target-experienceevent.schema.json @@ -0,0 +1,126 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/target-experienceevent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Target ExperienceEvent Template Mixin", + "type": "object", + "description": "Target ExperienceEvent mixin for use with schemas for Solution data ingestion. Includes the core/standard ExperienceEvent as well as the required Adobe Target ExperienceEvent mixins.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/experienceevent-advertising", + "https://ns.adobe.com/xdm/context/experienceevent-application", + "https://ns.adobe.com/xdm/context/experienceevent-channel", + "https://ns.adobe.com/xdm/context/experienceevent-commerce", + "https://ns.adobe.com/xdm/context/experienceevent-directmarketing", + "https://ns.adobe.com/xdm/context/experienceevent-environment-details", + "https://ns.adobe.com/xdm/context/experienceevent-marketing", + "https://ns.adobe.com/xdm/context/experienceevent-media", + "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch", + "https://ns.adobe.com/xdm/context/experienceevent-search", + "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership", + "https://ns.adobe.com/xdm/context/experienceevent-technical-details", + "https://ns.adobe.com/xdm/context/experienceevent-web", + "https://ns.adobe.com/experience/target/experienceevent-all", + "https://ns.adobe.com/experience/profile/experienceevent-shared", + "https://ns.adobe.com/experience/implementations-ext", + "https://ns.adobe.com/xdm/context/experienceevent-enduserids" + ], + "definitions": { + "target-experienceevent": { + "properties": {} + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-advertising" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-application" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-channel" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-commerce" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-directmarketing" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-marketing" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-media" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-search" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-technical-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-web" + }, + { + "$ref": "https://ns.adobe.com/experience/target/experienceevent-all" + }, + { + "$ref": "https://ns.adobe.com/experience/profile/experienceevent-shared" + }, + { + "$ref": "https://ns.adobe.com/experience/implementations-ext" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-enduserids" + }, + { + "$ref": "#/definitions/target-experienceevent" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "id": "68519882713298129995549973016107434638", + "primary": true + } + ] + }, + "https://ns.adobe.com/experience/target/clientcode": "773baa41-4afd-4c4e-9178-1547f58e07bd", + "https://ns.adobe.com/experience/target/mboxname": "orderConfirmPage", + "https://ns.adobe.com/experience/target/mboxversion": "v60", + "https://ns.adobe.com/experience/target/sessionid": "94ef199f-85e6-4e33-9a58-0e4162486714", + "https://ns.adobe.com/experience/target/pagedetail/pageid": "http://data.adobe.com/experience/target/pagedetail/pageid/b1ba48aa-291f-4f94-bc65-a260150648a1", + "https://ns.adobe.com/experience/target/pagedetail/pagescore": 100 + } + ] +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/target-experienceevent.schema.md b/docs/reference/adobe/experience/target-experienceevent.schema.md new file mode 100644 index 000000000..7e0d21251 --- /dev/null +++ b/docs/reference/adobe/experience/target-experienceevent.schema.md @@ -0,0 +1,686 @@ + +# Adobe Target ExperienceEvent Template Mixin Schema + +``` +https://ns.adobe.com/experience/target-experienceevent +``` + +Target ExperienceEvent mixin for use with schemas for Solution data ingestion. Includes the core/standard ExperienceEvent as well as the required Adobe Target ExperienceEvent mixins. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/target-experienceevent.schema.json](adobe/experience/target-experienceevent.schema.json) | +## Schema Hierarchy + +* Adobe Target ExperienceEvent Template Mixin `https://ns.adobe.com/experience/target-experienceevent` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [ExperienceEvent details for advertising](../../mixins/experience-event/experienceevent-advertising.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-advertising` + * [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-application` + * [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-channel` + * [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-commerce` + * [ExperienceEvent direct marketing details](../../mixins/experience-event/experienceevent-directmarketing.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-directmarketing` + * [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-environment-details` + * [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-marketing` + * [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-media` + * [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-profile-stitch` + * [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-search` + * [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-segmentmembership` + * [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-technical-details` + * [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-web` + * [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md) `https://ns.adobe.com/experience/target/experienceevent-all` + * [Adobe Unified Profile Service ExperienceEvent Shared Extension](profile/experienceevent-shared.schema.md) `https://ns.adobe.com/experience/profile/experienceevent-shared` + * [Adobe Experience Platform Implementation Details Mixin](implementations-ext.schema.md) `https://ns.adobe.com/experience/implementations-ext` + * [ExperienceEvent EndUserIDs](../../mixins/experience-event/experienceevent-enduserids.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-enduserids` + + +## Adobe Target ExperienceEvent Template Mixin Example +```json +{ + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "id": "68519882713298129995549973016107434638", + "primary": true + } + ] + }, + "https://ns.adobe.com/experience/target/clientcode": "773baa41-4afd-4c4e-9178-1547f58e07bd", + "https://ns.adobe.com/experience/target/mboxname": "orderConfirmPage", + "https://ns.adobe.com/experience/target/mboxversion": "v60", + "https://ns.adobe.com/experience/target/sessionid": "94ef199f-85e6-4e33-9a58-0e4162486714", + "https://ns.adobe.com/experience/target/pagedetail/pageid": "http://data.adobe.com/experience/target/pagedetail/pageid/b1ba48aa-291f-4f94-bc65-a260150648a1", + "https://ns.adobe.com/experience/target/pagedetail/pagescore": 100 +} +``` + +# Adobe Target ExperienceEvent Template Mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/implementations](#httpsnsadobecomexperienceimplementations) | Adobe Experience Platform Implementation Details | Optional | [Adobe Experience Platform Implementation Details Mixin](implementations-ext.schema.md#httpsnsadobecomexperienceimplementations) | +| [https://ns.adobe.com/experience/profile/originDatasetID](#httpsnsadobecomexperienceprofileorigindatasetid) | `string` | Optional | [Adobe Unified Profile Service ExperienceEvent Shared Extension](profile/experienceevent-shared.schema.md#httpsnsadobecomexperienceprofileorigindatasetid) | +| [https://ns.adobe.com/experience/target/activities](#httpsnsadobecomexperiencetargetactivities) | Adobe Target Activity | Optional | [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetactivities) | +| [https://ns.adobe.com/experience/target/clientcode](#httpsnsadobecomexperiencetargetclientcode) | `string` | Optional | [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetclientcode) | +| [https://ns.adobe.com/experience/target/environmentID](#httpsnsadobecomexperiencetargetenvironmentid) | `string` | Optional | [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetenvironmentid) | +| [https://ns.adobe.com/experience/target/mboxname](#httpsnsadobecomexperiencetargetmboxname) | `string` | Optional | [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetmboxname) | +| [https://ns.adobe.com/experience/target/mboxversion](#httpsnsadobecomexperiencetargetmboxversion) | `string` | Optional | [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetmboxversion) | +| [https://ns.adobe.com/experience/target/pagedetail/pageid](#httpsnsadobecomexperiencetargetpagedetailpageid) | `string` | Optional | [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetpagedetailpageid) | +| [https://ns.adobe.com/experience/target/pagedetail/pagescore](#httpsnsadobecomexperiencetargetpagedetailpagescore) | `number` | Optional | [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetpagedetailpagescore) | +| [https://ns.adobe.com/experience/target/sessionid](#httpsnsadobecomexperiencetargetsessionid) | `string` | Optional | [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetsessionid) | +| [xdm:advertising](#xdmadvertising) | Advertising | Optional | [ExperienceEvent details for advertising](../../mixins/experience-event/experienceevent-advertising.schema.md#xdmadvertising) | +| [xdm:application](#xdmapplication) | Application | Optional | [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md#xdmapplication) | +| [xdm:channel](#xdmchannel) | Experience Channel | Optional | [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md#xdmchannel) | +| [xdm:commerce](#xdmcommerce) | Commerce | Optional | [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmcommerce) | +| [xdm:dataSource](#xdmdatasource) | Data Source | Optional | [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmdatasource) | +| [xdm:device](#xdmdevice) | Device | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) | +| [xdm:directMarketing](#xdmdirectmarketing) | Direct marketing | Optional | [ExperienceEvent direct marketing details](../../mixins/experience-event/experienceevent-directmarketing.schema.md#xdmdirectmarketing) | +| [xdm:endUserIDs](#xdmenduserids) | End user IDs | Optional | [ExperienceEvent EndUserIDs](../../mixins/experience-event/experienceevent-enduserids.schema.md#xdmenduserids) | +| [xdm:environment](#xdmenvironment) | Environment | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) | +| [xdm:marketing](#xdmmarketing) | Marketing | Optional | [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md#xdmmarketing) | +| [xdm:media](#xdmmedia) | Media information | Optional | [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md#xdmmedia) | +| [xdm:placeContext](#xdmplacecontext) | Place context | Optional | [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) | +| [xdm:productListItems](#xdmproductlistitems) | Product list item | Optional | [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmproductlistitems) | +| [xdm:profileStitch](#xdmprofilestitch) | Profile stitch | Optional | [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md#xdmprofilestitch) | +| [xdm:receivedTimestamp](#xdmreceivedtimestamp) | `string` | Optional | [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmreceivedtimestamp) | +| [xdm:search](#xdmsearch) | Search | Optional | [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md#xdmsearch) | +| [xdm:segmentMembership](#xdmsegmentmembership) | `object` | Optional | [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmembership) | +| [xdm:segmentMemberships](#xdmsegmentmemberships) | Segment membership item | Optional | [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) | +| [xdm:web](#xdmweb) | Web information | Optional | [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md#xdmweb) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/implementations + + +`https://ns.adobe.com/experience/implementations` +* is optional +* type: Adobe Experience Platform Implementation Details +* defined in [Adobe Experience Platform Implementation Details Mixin](implementations-ext.schema.md#httpsnsadobecomexperienceimplementations) + +### https://ns.adobe.com/experience/implementations Type + + +* [Adobe Experience Platform Implementation Details](implementations.schema.md) – `https://ns.adobe.com/experience/implementations` + + + + + +## https://ns.adobe.com/experience/profile/originDatasetID +### Origin Dataset ID + +Identity of the dataset that the Unified Profile Service ingested the data from. Usage is reserved for the Unified Profile Service. + +`https://ns.adobe.com/experience/profile/originDatasetID` +* is optional +* type: `string` +* defined in [Adobe Unified Profile Service ExperienceEvent Shared Extension](profile/experienceevent-shared.schema.md#httpsnsadobecomexperienceprofileorigindatasetid) + +### https://ns.adobe.com/experience/profile/originDatasetID Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/activities +### Activities + +A list of items representing executed activities. + +`https://ns.adobe.com/experience/target/activities` +* is optional +* type: Adobe Target Activity + +* defined in [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetactivities) + +### https://ns.adobe.com/experience/target/activities Type + + +Array type: Adobe Target Activity + +All items must be of the type: +* [Adobe Target Activity](target/activity.schema.md) – `https://ns.adobe.com/experience/target/activity` + + + + + + + + +## https://ns.adobe.com/experience/target/clientcode +### Adobe Target Client Code + +Adobe Target client code. + +`https://ns.adobe.com/experience/target/clientcode` +* is optional +* type: `string` +* defined in [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetclientcode) + +### https://ns.adobe.com/experience/target/clientcode Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/environmentID +### Environment Identifier + +Identifier of the environment on which the event was processed. + +`https://ns.adobe.com/experience/target/environmentID` +* is optional +* type: `string` +* defined in [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetenvironmentid) + +### https://ns.adobe.com/experience/target/environmentID Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/mboxname +### Adobe Target Mbox Name + +Adobe Target mbox name. + +`https://ns.adobe.com/experience/target/mboxname` +* is optional +* type: `string` +* defined in [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetmboxname) + +### https://ns.adobe.com/experience/target/mboxname Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/mboxversion +### Adobe Target Mbox Version + +Adobe Target mbox version. + +`https://ns.adobe.com/experience/target/mboxversion` +* is optional +* type: `string` +* defined in [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetmboxversion) + +### https://ns.adobe.com/experience/target/mboxversion Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/pagedetail/pageid +### Target Unique Page Identifier + +Target generated page identifier for current event. + +`https://ns.adobe.com/experience/target/pagedetail/pageid` +* is optional +* type: `string` +* defined in [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetpagedetailpageid) + +### https://ns.adobe.com/experience/target/pagedetail/pageid Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## https://ns.adobe.com/experience/target/pagedetail/pagescore +### Page Score + +Customer assigned score to visited page. + +`https://ns.adobe.com/experience/target/pagedetail/pagescore` +* is optional +* type: `number` +* defined in [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetpagedetailpagescore) + +### https://ns.adobe.com/experience/target/pagedetail/pagescore Type + + +`number` + + + + + + +## https://ns.adobe.com/experience/target/sessionid +### Adobe Target Session Identifier + +Adobe Target session identifier. + +`https://ns.adobe.com/experience/target/sessionid` +* is optional +* type: `string` +* defined in [Adobe Target ExperienceEvent Full Extension](target/experienceevent-all.schema.md#httpsnsadobecomexperiencetargetsessionid) + +### https://ns.adobe.com/experience/target/sessionid Type + + +`string` + + + + + + +## xdm:advertising +### Advertising + +Information related to advertising activity in ExperienceEvents. + +`xdm:advertising` +* is optional +* type: Advertising +* defined in [ExperienceEvent details for advertising](../../mixins/experience-event/experienceevent-advertising.schema.md#xdmadvertising) + +### xdm:advertising Type + + +* [Advertising](../../datatypes/advertising.schema.md) – `https://ns.adobe.com/xdm/context/advertising` + + + + + +## xdm:application +### Application + +This mixin is used to capture application information related to an ExperienceEvent, including the name of the application, app version, installs, launches, crashes, and closures. It could be either the application targeted by the event like the send of a push notification or the application originating the event such as a click, or a login. + +`xdm:application` +* is optional +* type: Application +* defined in [ExperienceEvent application details](../../mixins/experience-event/experienceevent-application.schema.md#xdmapplication) + +### xdm:application Type + + +* [Application](../../datatypes/application.schema.md) – `https://ns.adobe.com/xdm/context/application` + + + + + +## xdm:channel +### Experience channel + +Experience channel related to the ExperienceEvent. + +`xdm:channel` +* is optional +* type: Experience Channel +* defined in [ExperienceEvent channel details](../../mixins/experience-event/experienceevent-channel.schema.md#xdmchannel) + +### xdm:channel Type + + +* [Experience Channel](../../datatypes/channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel` + + + + + +## xdm:commerce +### Commerce + +Commerce specific data related to this event. + +`xdm:commerce` +* is optional +* type: Commerce +* defined in [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmcommerce) + +### xdm:commerce Type + + +* [Commerce](../../datatypes/commerce.schema.md) – `https://ns.adobe.com/xdm/context/commerce` + + + + + +## xdm:dataSource +### Data source + +Globally unique identification of a data source. + +`xdm:dataSource` +* is optional +* type: Data Source +* defined in [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmdatasource) + +### xdm:dataSource Type + + +* [Data Source](../../datatypes/data/datasource.schema.md) – `https://ns.adobe.com/xdm/data/datasource` + + + + + +## xdm:device +### Device + +An identified device, application or device browser instance that is trackable across sessions, normally by cookies. + +`xdm:device` +* is optional +* type: Device +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmdevice) + +### xdm:device Type + + +* [Device](../../datatypes/device.schema.md) – `https://ns.adobe.com/xdm/context/device` + + + + + +## xdm:directMarketing +### Direct marketing + +Events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications. + +`xdm:directMarketing` +* is optional +* type: Direct marketing +* defined in [ExperienceEvent direct marketing details](../../mixins/experience-event/experienceevent-directmarketing.schema.md#xdmdirectmarketing) + +### xdm:directMarketing Type + + +* [Direct marketing](../../datatypes/direct-marketing.schema.md) – `https://ns.adobe.com/xdm/context/direct-marketing` + + + + + +## xdm:endUserIDs +### EndUserIDs + +Condensed, normalized encapsulation of end user identifiers asserted for this ExperienceEvent. + +`xdm:endUserIDs` +* is optional +* type: End user IDs +* defined in [ExperienceEvent EndUserIDs](../../mixins/experience-event/experienceevent-enduserids.schema.md#xdmenduserids) + +### xdm:endUserIDs Type + + +* [End user IDs](../../datatypes/enduserids.schema.md) – `https://ns.adobe.com/xdm/context/enduserids` + + + + + +## xdm:environment +### Environment + +Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions. + +`xdm:environment` +* is optional +* type: Environment +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmenvironment) + +### xdm:environment Type + + +* [Environment](../../datatypes/environment.schema.md) – `https://ns.adobe.com/xdm/context/environment` + + + + + +## xdm:marketing +### Marketing + +The information related to marketing activities that are active with the touchpoint. + +`xdm:marketing` +* is optional +* type: Marketing +* defined in [ExperienceEvent details for marketing](../../mixins/experience-event/experienceevent-marketing.schema.md#xdmmarketing) + +### xdm:marketing Type + + +* [Marketing](../../datatypes/marketing.schema.md) – `https://ns.adobe.com/xdm/context/marketing` + + + + + +## xdm:media +### Media + +Media activity information related to the experience event. + +`xdm:media` +* is optional +* type: Media information +* defined in [ExperienceEvent details for media](../../mixins/experience-event/experienceevent-media.schema.md#xdmmedia) + +### xdm:media Type + + +* [Media information](../../datatypes/media.schema.md) – `https://ns.adobe.com/xdm/context/media` + + + + + +## xdm:placeContext +### Place context + +The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, and working hours. + +`xdm:placeContext` +* is optional +* type: Place context +* defined in [ExperienceEvent environment details](../../mixins/experience-event/experienceevent-environment-details.schema.md#xdmplacecontext) + +### xdm:placeContext Type + + +* [Place context](../../datatypes/placecontext.schema.md) – `https://ns.adobe.com/xdm/context/placecontext` + + + + + +## xdm:productListItems +### Product list items + +A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record. + +`xdm:productListItems` +* is optional +* type: Product list item + +* defined in [ExperienceEvent commerce details](../../mixins/experience-event/experienceevent-commerce.schema.md#xdmproductlistitems) + +### xdm:productListItems Type + + +Array type: Product list item + +All items must be of the type: +* [Product list item](../../datatypes/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem` + + + + + + + + +## xdm:profileStitch +### Profile stitch + +Details about the IDs that were joined by profile stitching. + +`xdm:profileStitch` +* is optional +* type: Profile stitch + +* defined in [ExperienceEvent profile stitch details](../../mixins/experience-event/experienceevent-profile-stitch.schema.md#xdmprofilestitch) + +### xdm:profileStitch Type + + +Array type: Profile stitch + +All items must be of the type: +* [Profile stitch](../../datatypes/profilestitch.schema.md) – `https://ns.adobe.com/xdm/context/profileStitch` + + + + + + + + +## xdm:receivedTimestamp +### Received time stamp + +The time at which this interaction was received by a server. + +`xdm:receivedTimestamp` +* is optional +* type: `string` +* defined in [ExperienceEvent technical details](../../mixins/experience-event/experienceevent-technical-details.schema.md#xdmreceivedtimestamp) + +### xdm:receivedTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:search +### Search + +The information related to web or mobile search. + +`xdm:search` +* is optional +* type: Search +* defined in [ExperienceEvent details for search](../../mixins/experience-event/experienceevent-search.schema.md#xdmsearch) + +### xdm:search Type + + +* [Search](../../datatypes/search.schema.md) – `https://ns.adobe.com/xdm/context/search` + + + + + +## xdm:segmentMembership +### Segment Membership Map + +`xdm:segmentMembership` +* is optional +* type: `object` +* defined in [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmembership) + +### xdm:segmentMembership Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:segmentMemberships +### Segment Memberships + +The segments associated with this ExperienceEvent. Deprecated, use `xdm:segmentMembership` instead. + +`xdm:segmentMemberships` +* is optional +* type: Segment membership item + +* defined in [ExperienceEvent Segment Membership Details](../../mixins/experience-event/experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) + +### xdm:segmentMemberships Type + + +Array type: Segment membership item + +All items must be of the type: +* [Segment membership item](../../datatypes/segmentmembershipitem.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembershipitem` + + + + + + + + +## xdm:web +### Web + +The information related to web page and link of the ExperienceEvent. + +`xdm:web` +* is optional +* type: Web information +* defined in [ExperienceEvent web details](../../mixins/experience-event/experienceevent-web.schema.md#xdmweb) + +### xdm:web Type + + +* [Web information](../../datatypes/webinfo.schema.md) – `https://ns.adobe.com/xdm/context/webinfo` + + + + diff --git a/docs/reference/adobe/experience/target/activity.schema.json b/docs/reference/adobe/experience/target/activity.schema.json new file mode 100644 index 000000000..e28b846b4 --- /dev/null +++ b/docs/reference/adobe/experience/target/activity.schema.json @@ -0,0 +1,48 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/target/activity", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Target Activity", + "type": "object", + "description": "An Adobe Target activity compares two or more experiences against the success metrics that are specified for choosing the experience that is most likely to provide the optimal results.", + "definitions": { + "activity": { + "properties": { + "xdm:activityID": { + "title": "Activity Identifier", + "type": "string", + "description": "Unique identity of an Adobe Target activity. This identifier can be used in activity APIs offered by Adobe Target." + }, + "xdm:version": { + "title": "Activity Version", + "type": "string", + "description": "Version of the activity that processed this given experience event." + }, + "https://ns.adobe.com/experience/target/activity/preview": { + "$ref": "https://ns.adobe.com/experience/target/activity/preview" + }, + "xdm:activityEvents": { + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/experience/target/activity/activityevent" + } + } + }, + "required": [ + "activityID", + "version" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/activity" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/target/activity.schema.md b/docs/reference/adobe/experience/target/activity.schema.md new file mode 100644 index 000000000..0875a9f96 --- /dev/null +++ b/docs/reference/adobe/experience/target/activity.schema.md @@ -0,0 +1,108 @@ + +# Adobe Target Activity Schema + +``` +https://ns.adobe.com/experience/target/activity +``` + +An Adobe Target activity compares two or more experiences against the success metrics that are specified for choosing the experience that is most likely to provide the optimal results. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/target/activity.schema.json](adobe/experience/target/activity.schema.json) | +## Schema Hierarchy + +* Adobe Target Activity `https://ns.adobe.com/experience/target/activity` + * [Activity Preview Parameters](activity/preview.schema.md) `https://ns.adobe.com/experience/target/activity/preview` + + +# Adobe Target Activity Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/target/activity/preview](#httpsnsadobecomexperiencetargetactivitypreview) | Activity Preview Parameters | Optional | Adobe Target Activity (this schema) | +| [xdm:activityEvents](#xdmactivityevents) | Adobe Target Activity Event | Optional | Adobe Target Activity (this schema) | +| [xdm:activityID](#xdmactivityid) | `string` | Optional | Adobe Target Activity (this schema) | +| [xdm:version](#xdmversion) | `string` | Optional | Adobe Target Activity (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/target/activity/preview + + +`https://ns.adobe.com/experience/target/activity/preview` +* is optional +* type: Activity Preview Parameters +* defined in this schema + +### https://ns.adobe.com/experience/target/activity/preview Type + + +* [Activity Preview Parameters](activity/preview.schema.md) – `https://ns.adobe.com/experience/target/activity/preview` + + + + + +## xdm:activityEvents + + +`xdm:activityEvents` +* is optional +* type: Adobe Target Activity Event + +* defined in this schema + +### xdm:activityEvents Type + + +Array type: Adobe Target Activity Event + +All items must be of the type: +* [Adobe Target Activity Event](activity/activityevent.schema.md) – `https://ns.adobe.com/experience/target/activity/activityevent` + + + + + + + + +## xdm:activityID +### Activity Identifier + +Unique identity of an Adobe Target activity. This identifier can be used in activity APIs offered by Adobe Target. + +`xdm:activityID` +* is optional +* type: `string` +* defined in this schema + +### xdm:activityID Type + + +`string` + + + + + + +## xdm:version +### Activity Version + +Version of the activity that processed this given experience event. + +`xdm:version` +* is optional +* type: `string` +* defined in this schema + +### xdm:version Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/target/experienceevent-all.schema.json b/docs/reference/adobe/experience/target/experienceevent-all.schema.json new file mode 100644 index 000000000..de5f7a8dd --- /dev/null +++ b/docs/reference/adobe/experience/target/experienceevent-all.schema.json @@ -0,0 +1,80 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/target/experienceevent-all", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Target ExperienceEvent Full Extension", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "meta:extends": [ + "https://ns.adobe.com/experience/target/experienceevent-shared" + ], + "description": "Adobe Target ExperienceEvent full extension. Contains all Solution added fields.", + "definitions": { + "target-experienceevent-all": { + "properties": { + "https://ns.adobe.com/experience/target/clientcode": { + "title": "Adobe Target Client Code", + "type": "string", + "description": "Adobe Target client code." + }, + "https://ns.adobe.com/experience/target/mboxname": { + "title": "Adobe Target Mbox Name", + "type": "string", + "description": "Adobe Target mbox name." + }, + "https://ns.adobe.com/experience/target/mboxversion": { + "title": "Adobe Target Mbox Version", + "type": "string", + "description": "Adobe Target mbox version." + }, + "https://ns.adobe.com/experience/target/sessionid": { + "title": "Adobe Target Session Identifier", + "type": "string", + "description": "Adobe Target session identifier." + }, + "https://ns.adobe.com/experience/target/pagedetail/pageid": { + "title": "Target Unique Page Identifier", + "type": "string", + "format": "uri", + "description": "Target generated page identifier for current event." + }, + "https://ns.adobe.com/experience/target/pagedetail/pagescore": { + "title": "Page Score", + "type": "number", + "description": "Customer assigned score to visited page." + }, + "https://ns.adobe.com/experience/target/environmentID": { + "title": "Environment Identifier", + "type": "string", + "description": "Identifier of the environment on which the event was processed." + }, + "https://ns.adobe.com/experience/target/activities": { + "title": "Activities", + "type": "array", + "description": "A list of items representing executed activities.", + "items": { + "$ref": "https://ns.adobe.com/experience/target/activity" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/target-experienceevent-all" + }, + { + "$ref": "https://ns.adobe.com/experience/target/experienceevent-shared" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/target/experienceevent-all.schema.md b/docs/reference/adobe/experience/target/experienceevent-all.schema.md new file mode 100644 index 000000000..4fced7776 --- /dev/null +++ b/docs/reference/adobe/experience/target/experienceevent-all.schema.md @@ -0,0 +1,219 @@ + +# Adobe Target ExperienceEvent Full Extension Schema + +``` +https://ns.adobe.com/experience/target/experienceevent-all +``` + +Adobe Target ExperienceEvent full extension. Contains all Solution added fields. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/target/experienceevent-all.schema.json](adobe/experience/target/experienceevent-all.schema.json) | +## Schema Hierarchy + +* Adobe Target ExperienceEvent Full Extension `https://ns.adobe.com/experience/target/experienceevent-all` + * [Adobe Target ExperienceEvent Shared Extension](experienceevent-shared.schema.md) `https://ns.adobe.com/experience/target/experienceevent-shared` + + +# Adobe Target ExperienceEvent Full Extension Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/target/activities](#httpsnsadobecomexperiencetargetactivities) | Adobe Target Activity | Optional | Adobe Target ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/target/clientcode](#httpsnsadobecomexperiencetargetclientcode) | `string` | Optional | Adobe Target ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/target/environmentID](#httpsnsadobecomexperiencetargetenvironmentid) | `string` | Optional | Adobe Target ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/target/mboxname](#httpsnsadobecomexperiencetargetmboxname) | `string` | Optional | Adobe Target ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/target/mboxversion](#httpsnsadobecomexperiencetargetmboxversion) | `string` | Optional | Adobe Target ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/target/pagedetail/pageid](#httpsnsadobecomexperiencetargetpagedetailpageid) | `string` | Optional | Adobe Target ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/target/pagedetail/pagescore](#httpsnsadobecomexperiencetargetpagedetailpagescore) | `number` | Optional | Adobe Target ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/target/sessionid](#httpsnsadobecomexperiencetargetsessionid) | `string` | Optional | Adobe Target ExperienceEvent Full Extension (this schema) | +| [https://ns.adobe.com/experience/target/supplementalDataID](#httpsnsadobecomexperiencetargetsupplementaldataid) | `string` | Optional | [Adobe Target ExperienceEvent Shared Extension](experienceevent-shared.schema.md#httpsnsadobecomexperiencetargetsupplementaldataid) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/target/activities +### Activities + +A list of items representing executed activities. + +`https://ns.adobe.com/experience/target/activities` +* is optional +* type: Adobe Target Activity + +* defined in this schema + +### https://ns.adobe.com/experience/target/activities Type + + +Array type: Adobe Target Activity + +All items must be of the type: +* [Adobe Target Activity](activity.schema.md) – `https://ns.adobe.com/experience/target/activity` + + + + + + + + +## https://ns.adobe.com/experience/target/clientcode +### Adobe Target Client Code + +Adobe Target client code. + +`https://ns.adobe.com/experience/target/clientcode` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/target/clientcode Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/environmentID +### Environment Identifier + +Identifier of the environment on which the event was processed. + +`https://ns.adobe.com/experience/target/environmentID` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/target/environmentID Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/mboxname +### Adobe Target Mbox Name + +Adobe Target mbox name. + +`https://ns.adobe.com/experience/target/mboxname` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/target/mboxname Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/mboxversion +### Adobe Target Mbox Version + +Adobe Target mbox version. + +`https://ns.adobe.com/experience/target/mboxversion` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/target/mboxversion Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/pagedetail/pageid +### Target Unique Page Identifier + +Target generated page identifier for current event. + +`https://ns.adobe.com/experience/target/pagedetail/pageid` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/target/pagedetail/pageid Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## https://ns.adobe.com/experience/target/pagedetail/pagescore +### Page Score + +Customer assigned score to visited page. + +`https://ns.adobe.com/experience/target/pagedetail/pagescore` +* is optional +* type: `number` +* defined in this schema + +### https://ns.adobe.com/experience/target/pagedetail/pagescore Type + + +`number` + + + + + + +## https://ns.adobe.com/experience/target/sessionid +### Adobe Target Session Identifier + +Adobe Target session identifier. + +`https://ns.adobe.com/experience/target/sessionid` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/target/sessionid Type + + +`string` + + + + + + +## https://ns.adobe.com/experience/target/supplementalDataID +### Supplemental Data Identifier + +Identifier used to stitch Target events with Analytics events + +`https://ns.adobe.com/experience/target/supplementalDataID` +* is optional +* type: `string` +* defined in [Adobe Target ExperienceEvent Shared Extension](experienceevent-shared.schema.md#httpsnsadobecomexperiencetargetsupplementaldataid) + +### https://ns.adobe.com/experience/target/supplementalDataID Type + + +`string` + + + + + diff --git a/docs/reference/adobe/experience/target/experienceevent-shared.schema.json b/docs/reference/adobe/experience/target/experienceevent-shared.schema.json new file mode 100644 index 000000000..cef4d3340 --- /dev/null +++ b/docs/reference/adobe/experience/target/experienceevent-shared.schema.json @@ -0,0 +1,35 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/experience/target/experienceevent-shared", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Adobe Target ExperienceEvent Shared Extension", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Adobe Target shared extension. Contains Solution fields shared with other Solutions.", + "definitions": { + "target-experienceevent-shared": { + "properties": { + "https://ns.adobe.com/experience/target/supplementalDataID": { + "title": "Supplemental Data Identifier", + "description": "Identifier used to stitch Target events with Analytics events", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/target-experienceevent-shared" + } + ], + "meta:status": "stable" +} \ No newline at end of file diff --git a/docs/reference/adobe/experience/target/experienceevent-shared.schema.md b/docs/reference/adobe/experience/target/experienceevent-shared.schema.md new file mode 100644 index 000000000..e601f6a0a --- /dev/null +++ b/docs/reference/adobe/experience/target/experienceevent-shared.schema.md @@ -0,0 +1,39 @@ + +# Adobe Target ExperienceEvent Shared Extension Schema + +``` +https://ns.adobe.com/experience/target/experienceevent-shared +``` + +Adobe Target shared extension. Contains Solution fields shared with other Solutions. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [adobe/experience/target/experienceevent-shared.schema.json](adobe/experience/target/experienceevent-shared.schema.json) | + +# Adobe Target ExperienceEvent Shared Extension Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/target/supplementalDataID](#httpsnsadobecomexperiencetargetsupplementaldataid) | `string` | Optional | Adobe Target ExperienceEvent Shared Extension (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/target/supplementalDataID +### Supplemental Data Identifier + +Identifier used to stitch Target events with Analytics events + +`https://ns.adobe.com/experience/target/supplementalDataID` +* is optional +* type: `string` +* defined in this schema + +### https://ns.adobe.com/experience/target/supplementalDataID Type + + +`string` + + + + + diff --git a/docs/reference/behaviors/adhoc.schema.json b/docs/reference/behaviors/adhoc.schema.json new file mode 100644 index 000000000..0e5fcfbd0 --- /dev/null +++ b/docs/reference/behaviors/adhoc.schema.json @@ -0,0 +1,32 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/adhoc", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Ad Hoc Schema", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "Used to indicate the behavior of the Ad hoc data semantic when composed into data Schemas. The Ad hoc semantic scope is limited to just the local schema, and no compatibility can be assumed between schemas.", + "definitions": { + "adhoc": { + "properties": {} + } + }, + "allOf": [ + { + "$ref": "#/definitions/adhoc" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + } + ], + "meta:status": "stable", + "examples": [ + {} + ] +} \ No newline at end of file diff --git a/docs/reference/behaviors/adhoc.schema.md b/docs/reference/behaviors/adhoc.schema.md new file mode 100644 index 000000000..7ccff94b6 --- /dev/null +++ b/docs/reference/behaviors/adhoc.schema.md @@ -0,0 +1,22 @@ + +# Ad Hoc Schema Schema + +``` +https://ns.adobe.com/xdm/data/adhoc +``` + +Used to indicate the behavior of the Ad hoc data semantic when composed into data Schemas. The Ad hoc semantic scope is limited to just the local schema, and no compatibility can be assumed between schemas. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Cannot be instantiated | Yes | Stable | No | Forbidden | Permitted | [behaviors/adhoc.schema.json](behaviors/adhoc.schema.json) | +## Schema Hierarchy + +* Ad Hoc Schema `https://ns.adobe.com/xdm/data/adhoc` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Ad Hoc Schema Example +```json +{} +``` diff --git a/docs/reference/behaviors/record.schema.json b/docs/reference/behaviors/record.schema.json new file mode 100644 index 000000000..410da3cfb --- /dev/null +++ b/docs/reference/behaviors/record.schema.json @@ -0,0 +1,41 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/record", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Record Schema", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "Used to indicate the behavior of record data semantic when composed into data schemas.", + "definitions": { + "record": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "A unique identifier for the record." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/record" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "49069bba-3014-420b-a887-3959f87d474a" + } + ] +} \ No newline at end of file diff --git a/docs/reference/behaviors/record.schema.md b/docs/reference/behaviors/record.schema.md new file mode 100644 index 000000000..2e48b553b --- /dev/null +++ b/docs/reference/behaviors/record.schema.md @@ -0,0 +1,52 @@ + +# Record Schema Schema + +``` +https://ns.adobe.com/xdm/data/record +``` + +Used to indicate the behavior of record data semantic when composed into data schemas. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [behaviors/record.schema.json](behaviors/record.schema.json) | +## Schema Hierarchy + +* Record Schema `https://ns.adobe.com/xdm/data/record` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Record Schema Example +```json +{ + "@id": "49069bba-3014-420b-a887-3959f87d474a" +} +``` + +# Record Schema Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Record Schema (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + diff --git a/docs/reference/behaviors/time-series.schema.json b/docs/reference/behaviors/time-series.schema.json new file mode 100644 index 000000000..17ce7ac92 --- /dev/null +++ b/docs/reference/behaviors/time-series.schema.json @@ -0,0 +1,78 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/time-series", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Time-series Schema", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "Used to indicate the behavior of time partitioned semantics when composed into data schemas.", + "definitions": { + "time-series": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "A unique identifier for the time-series event." + }, + "xdm:timestamp": { + "title": "Timestamp", + "type": "string", + "format": "date-time", + "description": "The time when an event or observation occurred." + }, + "xdm:eventType": { + "title": "Event Type", + "type": "string", + "description": "The primary event type for this time-series record.", + "meta:enum": { + "advertising.completes": "Indicates if a timed media asset was watched to completion - this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead.", + "advertising.timePlayed": "Describes the amount of time spent by a user on a specific timed media asset.", + "advertising.federated": "Indicates if an experience event was created through data federation (data sharing between customers).", + "advertising.clicks": "Click(s) actions on an advertisement.", + "advertising.conversions": "A customer pre-defined action(s) which triggers an event for performance evaluation.", + "advertising.firstQuartiles": "A digital video ad has played through 25% of its duration at normal speed.", + "advertising.impressions": "Impression(s) of an advertisement to an end-user with the potential of being viewed.", + "advertising.midpoints": "A digital video ad has played through 50% of its duration at normal speed.", + "advertising.starts": "A digital video ad has started playing.", + "advertising.thirdQuartiles": "A digital video ad has played through 75% of its duration at normal speed.", + "web.webpagedetails.pageViews": "View(s) of a webpage has occurred.", + "web.webinteraction.linkClicks": "Click of a web-link has occurred.", + "commerce.checkouts": "An action during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order.", + "commerce.productListAdds": "Addition of a product to the product list. Example a product is added to a shopping cart.", + "commerce.productListOpens": "Initializations of a new product list. Example a shopping cart is created.", + "commerce.productListRemovals": "Removal(s) of a product entry from a product list. Example a product is removed from a shopping cart.", + "commerce.productListReopens": "A product list that was no longer accessible(abandoned) has been re-activated by the user. Example via a re-marketing activity.", + "commerce.productListViews": "View(s) of a product-list has occurred.", + "commerce.productViews": "View(s) of a product have occurred.", + "commerce.purchases": "An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced.", + "commerce.saveForLaters": "Product list is saved for future use. Example a product wish list.", + "delivery.feedback": "Feedback events for a delivery. Example feedback events for an email delivery." + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/time-series" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:eventType": "advertising.impressions" + } + ] +} \ No newline at end of file diff --git a/docs/reference/behaviors/time-series.schema.md b/docs/reference/behaviors/time-series.schema.md new file mode 100644 index 000000000..ad0e2233f --- /dev/null +++ b/docs/reference/behaviors/time-series.schema.md @@ -0,0 +1,123 @@ + +# Time-series Schema Schema + +``` +https://ns.adobe.com/xdm/data/time-series +``` + +Used to indicate the behavior of time partitioned semantics when composed into data schemas. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [behaviors/time-series.schema.json](behaviors/time-series.schema.json) | +## Schema Hierarchy + +* Time-series Schema `https://ns.adobe.com/xdm/data/time-series` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Time-series Schema Example +```json +{ + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:eventType": "advertising.impressions" +} +``` + +# Time-series Schema Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Time-series Schema (this schema) | +| [xdm:eventType](#xdmeventtype) | `string` | Optional | Time-series Schema (this schema) | +| [xdm:timestamp](#xdmtimestamp) | `string` | Optional | Time-series Schema (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the time-series event. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:eventType +### Event Type + +The primary event type for this time-series record. + +`xdm:eventType` +* is optional +* type: `string` +* defined in this schema + +### xdm:eventType Type + + +`string` + + + +### xdm:eventType Known Values +| Value | Description | +|-------|-------------| +| `advertising.completes` | Indicates if a timed media asset was watched to completion - this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead. | +| `advertising.timePlayed` | Describes the amount of time spent by a user on a specific timed media asset. | +| `advertising.federated` | Indicates if an experience event was created through data federation (data sharing between customers). | +| `advertising.clicks` | Click(s) actions on an advertisement. | +| `advertising.conversions` | A customer pre-defined action(s) which triggers an event for performance evaluation. | +| `advertising.firstQuartiles` | A digital video ad has played through 25% of its duration at normal speed. | +| `advertising.impressions` | Impression(s) of an advertisement to an end-user with the potential of being viewed. | +| `advertising.midpoints` | A digital video ad has played through 50% of its duration at normal speed. | +| `advertising.starts` | A digital video ad has started playing. | +| `advertising.thirdQuartiles` | A digital video ad has played through 75% of its duration at normal speed. | +| `web.webpagedetails.pageViews` | View(s) of a webpage has occurred. | +| `web.webinteraction.linkClicks` | Click of a web-link has occurred. | +| `commerce.checkouts` | An action during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order. | +| `commerce.productListAdds` | Addition of a product to the product list. Example a product is added to a shopping cart. | +| `commerce.productListOpens` | Initializations of a new product list. Example a shopping cart is created. | +| `commerce.productListRemovals` | Removal(s) of a product entry from a product list. Example a product is removed from a shopping cart. | +| `commerce.productListReopens` | A product list that was no longer accessible(abandoned) has been re-activated by the user. Example via a re-marketing activity. | +| `commerce.productListViews` | View(s) of a product-list has occurred. | +| `commerce.productViews` | View(s) of a product have occurred. | +| `commerce.purchases` | An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced. | +| `commerce.saveForLaters` | Product list is saved for future use. Example a product wish list. | +| `delivery.feedback` | Feedback events for a delivery. Example feedback events for an email delivery. | + + + + +## xdm:timestamp +### Timestamp + +The time when an event or observation occurred. + +`xdm:timestamp` +* is optional +* type: `string` +* defined in this schema + +### xdm:timestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + diff --git a/docs/reference/classes/account.schema.json b/docs/reference/classes/account.schema.json new file mode 100644 index 000000000..694a41b79 --- /dev/null +++ b/docs/reference/classes/account.schema.json @@ -0,0 +1,65 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/account", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Account", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record" + ], + "description": "An XDM Business Account.", + "definitions": { + "account": { + "properties": { + "xdm:accountID": { + "title": "Account ID", + "description": "Account identifer", + "type": "string" + }, + "xdm:accountNumber": { + "title": "Account Number", + "description": "Tracking or reference number for account. Up to 40 characters are allowed in this field.", + "type": "string" + }, + "xdm:accountType": { + "title": "Account Type", + "description": "Type of account, for example, customer, competitor, or partner. Entry is selected from a picklist of available values, which a salesforce admin sets. Each picklist value can have up to 40 characters.", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit-details" + }, + { + "$ref": "#/definitions/account" + } + ], + "required": [ + "xdm:accountID" + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:accountID": "1234567890", + "xdm:accountNumber": "ACC111", + "xdm:accountType": "Business" + } + ] +} \ No newline at end of file diff --git a/docs/reference/classes/account.schema.md b/docs/reference/classes/account.schema.md new file mode 100644 index 000000000..4613bc66a --- /dev/null +++ b/docs/reference/classes/account.schema.md @@ -0,0 +1,139 @@ + +# XDM Business Account Schema + +``` +https://ns.adobe.com/xdm/context/account +``` + +An XDM Business Account. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [classes/account.schema.json](classes/account.schema.json) | +## Schema Hierarchy + +* XDM Business Account `https://ns.adobe.com/xdm/context/account` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + * [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md) `https://ns.adobe.com/xdm/common/external-source-system-audit-details` + + +## XDM Business Account Example +```json +{ + "xdm:accountID": "1234567890", + "xdm:accountNumber": "ACC111", + "xdm:accountType": "Business" +} +``` + +# XDM Business Account Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [xdm:accountID](#xdmaccountid) | `string` | **Required** | XDM Business Account (this schema) | +| [xdm:accountNumber](#xdmaccountnumber) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:accountType](#xdmaccounttype) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:extSourceSystemAudit](#xdmextsourcesystemaudit) | External Source System Audit Attributes | Optional | [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:accountID +### Account ID + +Account identifer + +`xdm:accountID` +* is **required** +* type: `string` +* defined in this schema + +### xdm:accountID Type + + +`string` + + + + + + +## xdm:accountNumber +### Account Number + +Tracking or reference number for account. Up to 40 characters are allowed in this field. + +`xdm:accountNumber` +* is optional +* type: `string` +* defined in this schema + +### xdm:accountNumber Type + + +`string` + + + + + + +## xdm:accountType +### Account Type + +Type of account, for example, customer, competitor, or partner. Entry is selected from a picklist of available values, which a salesforce admin sets. Each picklist value can have up to 40 characters. + +`xdm:accountType` +* is optional +* type: `string` +* defined in this schema + +### xdm:accountType Type + + +`string` + + + + + + +## xdm:extSourceSystemAudit +### External Source System Audit Properties + +Audit attributes for external sources. + +`xdm:extSourceSystemAudit` +* is optional +* type: External Source System Audit Attributes +* defined in [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) + +### xdm:extSourceSystemAudit Type + + +* [External Source System Audit Attributes](../datatypes/external-source-system-audit.schema.md) – `https://ns.adobe.com/xdm/common/external-source-system-audit` + + + + diff --git a/docs/reference/classes/activity-log.schema.json b/docs/reference/classes/activity-log.schema.json new file mode 100644 index 000000000..fc693c097 --- /dev/null +++ b/docs/reference/classes/activity-log.schema.json @@ -0,0 +1,88 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/activity-log", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Activity Log", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/time-series" + ], + "description": "An XDM Activity in the form of a task or a business event.", + "definitions": { + "activity": { + "properties": { + "xdm:activityID": { + "title": "Activity ID", + "description": "Activity log unique identifer", + "type": "string" + }, + "xdm:activityType": { + "title": "Activity Type", + "description": "The tacking type of the activity in the form of a task or a business planned event", + "properties": { + "xdm:ID": { + "title": "ID of the Activity Type", + "description": "The tacking type of the activity in the form of a task or a business planned event", + "type": "string" + }, + "xdm:type": { + "title": "Type of the Activity Type", + "description": "The tacking type of the activity in the form of a task or a business planned event", + "type": "string" + } + }, + "required": [ + "xdm:ID", + "xdm:type" + ] + } + }, + "required": [ + "xdm:activityID" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/time-series" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit-details" + }, + { + "$ref": "#/definitions/activity" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:activityID": "1", + "xdm:activityType": { + "xdm:ID": "6", + "xdm:type": "Event" + }, + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:timestamp": "2020-05-19T09:05:25+00:00", + "xdm:eventType": "", + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-19T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-19T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-19T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-26T15:52:25+00:00" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/classes/activity-log.schema.md b/docs/reference/classes/activity-log.schema.md new file mode 100644 index 000000000..53e88f9f4 --- /dev/null +++ b/docs/reference/classes/activity-log.schema.md @@ -0,0 +1,223 @@ + +# XDM Business Activity Log Schema + +``` +https://ns.adobe.com/xdm/context/activity-log +``` + +An XDM Activity in the form of a task or a business event. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [classes/activity-log.schema.json](classes/activity-log.schema.json) | +## Schema Hierarchy + +* XDM Business Activity Log `https://ns.adobe.com/xdm/context/activity-log` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Time-series Schema](../behaviors/time-series.schema.md) `https://ns.adobe.com/xdm/data/time-series` + * [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md) `https://ns.adobe.com/xdm/common/external-source-system-audit-details` + + +## XDM Business Activity Log Example +```json +{ + "xdm:activityID": "1", + "xdm:activityType": { + "xdm:ID": "6", + "xdm:type": "Event" + }, + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:timestamp": "2020-05-19T09:05:25+00:00", + "xdm:eventType": "", + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-19T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-19T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-19T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-26T15:52:25+00:00" + } +} +``` + +# XDM Business Activity Log Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Time-series Schema](../behaviors/time-series.schema.md#id) | +| [xdm:activityID](#xdmactivityid) | `string` | Optional | XDM Business Activity Log (this schema) | +| [xdm:activityType](#xdmactivitytype) | complex | Optional | XDM Business Activity Log (this schema) | +| [xdm:eventType](#xdmeventtype) | `string` | Optional | [Time-series Schema](../behaviors/time-series.schema.md#xdmeventtype) | +| [xdm:extSourceSystemAudit](#xdmextsourcesystemaudit) | External Source System Audit Attributes | Optional | [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) | +| [xdm:timestamp](#xdmtimestamp) | `string` | Optional | [Time-series Schema](../behaviors/time-series.schema.md#xdmtimestamp) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the time-series event. + +`@id` +* is optional +* type: `string` +* defined in [Time-series Schema](../behaviors/time-series.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:activityID +### Activity ID + +Activity log unique identifer + +`xdm:activityID` +* is optional +* type: `string` +* defined in this schema + +### xdm:activityID Type + + +`string` + + + + + + +## xdm:activityType +### Activity Type + +The tacking type of the activity in the form of a task or a business planned event + +`xdm:activityType` +* is optional +* type: complex +* defined in this schema + +### xdm:activityType Type + +Unknown type ``. + +```json +{ + "title": "Activity Type", + "description": "The tacking type of the activity in the form of a task or a business planned event", + "properties": { + "xdm:ID": { + "title": "ID of the Activity Type", + "description": "The tacking type of the activity in the form of a task or a business planned event", + "type": "string" + }, + "xdm:type": { + "title": "Type of the Activity Type", + "description": "The tacking type of the activity in the form of a task or a business planned event", + "type": "string" + } + }, + "required": [ + "xdm:ID", + "xdm:type" + ], + "simpletype": "complex" +} +``` + + + + + +## xdm:eventType +### Event Type + +The primary event type for this time-series record. + +`xdm:eventType` +* is optional +* type: `string` +* defined in [Time-series Schema](../behaviors/time-series.schema.md#xdmeventtype) + +### xdm:eventType Type + + +`string` + + + +### xdm:eventType Known Values +| Value | Description | +|-------|-------------| +| `advertising.completes` | Indicates if a timed media asset was watched to completion - this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead. | +| `advertising.timePlayed` | Describes the amount of time spent by a user on a specific timed media asset. | +| `advertising.federated` | Indicates if an experience event was created through data federation (data sharing between customers). | +| `advertising.clicks` | Click(s) actions on an advertisement. | +| `advertising.conversions` | A customer pre-defined action(s) which triggers an event for performance evaluation. | +| `advertising.firstQuartiles` | A digital video ad has played through 25% of its duration at normal speed. | +| `advertising.impressions` | Impression(s) of an advertisement to an end-user with the potential of being viewed. | +| `advertising.midpoints` | A digital video ad has played through 50% of its duration at normal speed. | +| `advertising.starts` | A digital video ad has started playing. | +| `advertising.thirdQuartiles` | A digital video ad has played through 75% of its duration at normal speed. | +| `web.webpagedetails.pageViews` | View(s) of a webpage has occurred. | +| `web.webinteraction.linkClicks` | Click of a web-link has occurred. | +| `commerce.checkouts` | An action during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order. | +| `commerce.productListAdds` | Addition of a product to the product list. Example a product is added to a shopping cart. | +| `commerce.productListOpens` | Initializations of a new product list. Example a shopping cart is created. | +| `commerce.productListRemovals` | Removal(s) of a product entry from a product list. Example a product is removed from a shopping cart. | +| `commerce.productListReopens` | A product list that was no longer accessible(abandoned) has been re-activated by the user. Example via a re-marketing activity. | +| `commerce.productListViews` | View(s) of a product-list has occurred. | +| `commerce.productViews` | View(s) of a product have occurred. | +| `commerce.purchases` | An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced. | +| `commerce.saveForLaters` | Product list is saved for future use. Example a product wish list. | +| `delivery.feedback` | Feedback events for a delivery. Example feedback events for an email delivery. | + + + + +## xdm:extSourceSystemAudit +### External Source System Audit Properties + +Audit attributes for external sources. + +`xdm:extSourceSystemAudit` +* is optional +* type: External Source System Audit Attributes +* defined in [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) + +### xdm:extSourceSystemAudit Type + + +* [External Source System Audit Attributes](../datatypes/external-source-system-audit.schema.md) – `https://ns.adobe.com/xdm/common/external-source-system-audit` + + + + + +## xdm:timestamp +### Timestamp + +The time when an event or observation occurred. + +`xdm:timestamp` +* is optional +* type: `string` +* defined in [Time-series Schema](../behaviors/time-series.schema.md#xdmtimestamp) + +### xdm:timestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + diff --git a/docs/reference/classes/activity-type.schema.json b/docs/reference/classes/activity-type.schema.json new file mode 100644 index 000000000..d717d13bb --- /dev/null +++ b/docs/reference/classes/activity-type.schema.json @@ -0,0 +1,67 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/activity-type", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Activity Type", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record" + ], + "description": "An XDM Activity type in the form of a task or a business event", + "definitions": { + "activity-type": { + "properties": { + "xdm:activityType": { + "properties": { + "xdm:ID": { + "title": "Activity type ID", + "description": "Activity Type unique identifer for a given task or a business event", + "type": "string" + } + }, + "required": [ + "xdm:ID" + ] + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit-details" + }, + { + "$ref": "#/definitions/activity-type" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:activityType": { + "xdm:ID": "34934" + }, + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-19T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-19T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-19T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-26T15:52:25+00:00" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/classes/activity-type.schema.md b/docs/reference/classes/activity-type.schema.md new file mode 100644 index 000000000..0068b90be --- /dev/null +++ b/docs/reference/classes/activity-type.schema.md @@ -0,0 +1,118 @@ + +# XDM Activity Type Schema + +``` +https://ns.adobe.com/xdm/context/activity-type +``` + +An XDM Activity type in the form of a task or a business event + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [classes/activity-type.schema.json](classes/activity-type.schema.json) | +## Schema Hierarchy + +* XDM Activity Type `https://ns.adobe.com/xdm/context/activity-type` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + * [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md) `https://ns.adobe.com/xdm/common/external-source-system-audit-details` + + +## XDM Activity Type Example +```json +{ + "xdm:activityType": { + "xdm:ID": "34934" + }, + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-19T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-19T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-19T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-26T15:52:25+00:00" + } +} +``` + +# XDM Activity Type Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [xdm:activityType](#xdmactivitytype) | complex | Optional | XDM Activity Type (this schema) | +| [xdm:extSourceSystemAudit](#xdmextsourcesystemaudit) | External Source System Audit Attributes | Optional | [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:activityType + + +`xdm:activityType` +* is optional +* type: complex +* defined in this schema + +### xdm:activityType Type + +Unknown type ``. + +```json +{ + "properties": { + "xdm:ID": { + "title": "Activity type ID", + "description": "Activity Type unique identifer for a given task or a business event", + "type": "string" + } + }, + "required": [ + "xdm:ID" + ], + "simpletype": "complex" +} +``` + + + + + +## xdm:extSourceSystemAudit +### External Source System Audit Properties + +Audit attributes for external sources. + +`xdm:extSourceSystemAudit` +* is optional +* type: External Source System Audit Attributes +* defined in [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) + +### xdm:extSourceSystemAudit Type + + +* [External Source System Audit Attributes](../datatypes/external-source-system-audit.schema.md) – `https://ns.adobe.com/xdm/common/external-source-system-audit` + + + + diff --git a/docs/reference/classes/campaign-member.schema.json b/docs/reference/classes/campaign-member.schema.json new file mode 100644 index 000000000..b2fa0427c --- /dev/null +++ b/docs/reference/classes/campaign-member.schema.json @@ -0,0 +1,86 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/campaign-member", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Campaign Member", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record" + ], + "description": "An XDM Business Campaign Member,which relates members such as contact/lead to a campaign", + "definitions": { + "campaign-member": { + "properties": { + "xdm:campaignMemberID": { + "title": "Campaign Member ID", + "description": "Campaign Member unique identifer", + "type": "string" + }, + "xdm:campaign": { + "title": "Campaign", + "description": "Campaign ID and Type associated as a key-value pair", + "properties": { + "xdm:ID": { + "title": "Campaign ID", + "description": "Campaign Unique Identifer", + "type": "string" + }, + "xdm:type": { + "title": "Campaign Type", + "description": "Campaign Type", + "type": "string" + } + }, + "required": [ + "xdm:ID", + "xdm:type" + ] + } + }, + "required": [ + "xdm:campaignMemberID" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit-details" + }, + { + "$ref": "#/definitions/campaign-member" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:campaignMemberID": "1", + "xdm:campaign": { + "xdm:ID": "1003", + "xdm:type": "Direct Mail" + }, + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-19T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-19T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-19T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-26T15:52:25+00:00" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/classes/campaign-member.schema.md b/docs/reference/classes/campaign-member.schema.md new file mode 100644 index 000000000..bd5c80a84 --- /dev/null +++ b/docs/reference/classes/campaign-member.schema.md @@ -0,0 +1,151 @@ + +# XDM Business Campaign Member Schema + +``` +https://ns.adobe.com/xdm/context/campaign-member +``` + +An XDM Business Campaign Member,which relates members such as contact/lead to a campaign + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [classes/campaign-member.schema.json](classes/campaign-member.schema.json) | +## Schema Hierarchy + +* XDM Business Campaign Member `https://ns.adobe.com/xdm/context/campaign-member` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + * [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md) `https://ns.adobe.com/xdm/common/external-source-system-audit-details` + + +## XDM Business Campaign Member Example +```json +{ + "xdm:campaignMemberID": "1", + "xdm:campaign": { + "xdm:ID": "1003", + "xdm:type": "Direct Mail" + }, + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-19T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-19T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-19T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-26T15:52:25+00:00" + } +} +``` + +# XDM Business Campaign Member Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [xdm:campaign](#xdmcampaign) | complex | Optional | XDM Business Campaign Member (this schema) | +| [xdm:campaignMemberID](#xdmcampaignmemberid) | `string` | Optional | XDM Business Campaign Member (this schema) | +| [xdm:extSourceSystemAudit](#xdmextsourcesystemaudit) | External Source System Audit Attributes | Optional | [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:campaign +### Campaign + +Campaign ID and Type associated as a key-value pair + +`xdm:campaign` +* is optional +* type: complex +* defined in this schema + +### xdm:campaign Type + +Unknown type ``. + +```json +{ + "title": "Campaign", + "description": "Campaign ID and Type associated as a key-value pair", + "properties": { + "xdm:ID": { + "title": "Campaign ID", + "description": "Campaign Unique Identifer", + "type": "string" + }, + "xdm:type": { + "title": "Campaign Type", + "description": "Campaign Type", + "type": "string" + } + }, + "required": [ + "xdm:ID", + "xdm:type" + ], + "simpletype": "complex" +} +``` + + + + + +## xdm:campaignMemberID +### Campaign Member ID + +Campaign Member unique identifer + +`xdm:campaignMemberID` +* is optional +* type: `string` +* defined in this schema + +### xdm:campaignMemberID Type + + +`string` + + + + + + +## xdm:extSourceSystemAudit +### External Source System Audit Properties + +Audit attributes for external sources. + +`xdm:extSourceSystemAudit` +* is optional +* type: External Source System Audit Attributes +* defined in [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) + +### xdm:extSourceSystemAudit Type + + +* [External Source System Audit Attributes](../datatypes/external-source-system-audit.schema.md) – `https://ns.adobe.com/xdm/common/external-source-system-audit` + + + + diff --git a/docs/reference/classes/campaign-workflow.schema.json b/docs/reference/classes/campaign-workflow.schema.json new file mode 100644 index 000000000..3a4edb720 --- /dev/null +++ b/docs/reference/classes/campaign-workflow.schema.json @@ -0,0 +1,69 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/campaign-workflow", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Campaign Workflow", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record" + ], + "description": "An XDM Business Campaign workflow", + "definitions": { + "campaign-workflow": { + "properties": { + "xdm:campaignID": { + "title": "Campaign ID", + "description": "Unique identifer for Campaign.", + "type": "string" + }, + "xdm:campaignType": { + "title": "Campaign Type", + "description": "The type of campaign for which audience gets selected", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit-details" + }, + { + "$ref": "#/definitions/campaign-workflow" + } + ], + "required": [ + "xdm:campaignID", + "xdm:campaignType" + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:campaignID": "1", + "xdm:campaignType": "Direct Mail Campaign", + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-19T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-19T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-19T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-26T15:52:25+00:00" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/classes/campaign-workflow.schema.md b/docs/reference/classes/campaign-workflow.schema.md new file mode 100644 index 000000000..17730408f --- /dev/null +++ b/docs/reference/classes/campaign-workflow.schema.md @@ -0,0 +1,126 @@ + +# XDM Business Campaign Workflow Schema + +``` +https://ns.adobe.com/xdm/context/campaign-workflow +``` + +An XDM Business Campaign workflow + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [classes/campaign-workflow.schema.json](classes/campaign-workflow.schema.json) | +## Schema Hierarchy + +* XDM Business Campaign Workflow `https://ns.adobe.com/xdm/context/campaign-workflow` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + * [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md) `https://ns.adobe.com/xdm/common/external-source-system-audit-details` + + +## XDM Business Campaign Workflow Example +```json +{ + "xdm:campaignID": "1", + "xdm:campaignType": "Direct Mail Campaign", + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-19T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-19T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-19T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-26T15:52:25+00:00" + } +} +``` + +# XDM Business Campaign Workflow Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [xdm:campaignID](#xdmcampaignid) | `string` | **Required** | XDM Business Campaign Workflow (this schema) | +| [xdm:campaignType](#xdmcampaigntype) | `string` | **Required** | XDM Business Campaign Workflow (this schema) | +| [xdm:extSourceSystemAudit](#xdmextsourcesystemaudit) | External Source System Audit Attributes | Optional | [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:campaignID +### Campaign ID + +Unique identifer for Campaign. + +`xdm:campaignID` +* is **required** +* type: `string` +* defined in this schema + +### xdm:campaignID Type + + +`string` + + + + + + +## xdm:campaignType +### Campaign Type + +The type of campaign for which audience gets selected + +`xdm:campaignType` +* is **required** +* type: `string` +* defined in this schema + +### xdm:campaignType Type + + +`string` + + + + + + +## xdm:extSourceSystemAudit +### External Source System Audit Properties + +Audit attributes for external sources. + +`xdm:extSourceSystemAudit` +* is optional +* type: External Source System Audit Attributes +* defined in [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) + +### xdm:extSourceSystemAudit Type + + +* [External Source System Audit Attributes](../datatypes/external-source-system-audit.schema.md) – `https://ns.adobe.com/xdm/common/external-source-system-audit` + + + + diff --git a/docs/reference/classes/experienceevent.schema.json b/docs/reference/classes/experienceevent.schema.json new file mode 100644 index 000000000..c9b6fb715 --- /dev/null +++ b/docs/reference/classes/experienceevent.schema.json @@ -0,0 +1,861 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM ExperienceEvent", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/time-series", + "https://ns.adobe.com/xdm/context/identitymap" + ], + "description": "An ExperienceEvent is a fact record of what occurred, including the point in time and identity of the individual involved. ExperienceEvents can be either explicit (directly observable human actions) or implicit (raised without a direct human action) and are recorded without aggregation or interpretation. They are critical for time-domain analytics as they allow for observation and analysis of changes that occur in a given window of time and the comparison between multiple windows of time to track trends.", + "definitions": { + "experienceevent": { + "properties": { + "xdm:eventMergeId": { + "title": "ExperienceEvent merge ID", + "type": "string", + "description": "An ID to correlate or merge multiple Experience events together that are essentially the same event or should be merged. This is intended to be populated by the data producer prior to ingestion." + } + } + } + }, + "required": [ + "@id", + "xdm:timestamp" + ], + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/time-series" + }, + { + "$ref": "#/definitions/experienceevent" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2394509340-30453470347" + } + ], + "https://data.adobe.io/entities/namespace/9": [ + { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" + } + ] + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + }, + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + }, + "xdm:profileStitch": [ + { + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "1.0", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/92312748749128" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/62312748749321" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" + } + ] + } + } + ], + "xdm:segmentMemberships": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + }, + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:version": "1.0", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "realized" + } + } + ] + }, + { + "@id": "https://data.adobe.io/experienceid-123457", + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2394509340-30453470347" + } + ] + }, + "xdm:environment": { + "xdm:browserDetails": { + "xdm:userAgent": "AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30" + }, + "xdm:ipV4": "97.73.140.5" + }, + "xdm:media": { + "xdm:mediaTimed": { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "show_highlights", + "iptc4xmpExt:Identifier": "http://myChannel.com/series-identifiers/2692753" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "TVGuru", + "iptc4xmpExt:RatingSourceLink": "http://www.mytvexample.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "SportTV" + } + ] + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchsport", + "xdm:broadcastChannel": "WatchSportTV", + "xdm:broadcastContentType": "VCT", + "xdm:videoSegment": "3-10", + "xdm:path": "id:show:episode:abcd.com:d9263ej-4ce7", + "xdm:streamFormat": "short", + "xdm:vhlVersion": "js-2.0.1.88-c8c0b1", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "ntwu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.link.org%2Fhls%2Fvu%2F9083406%2FVUBX0288374528402980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:QOE": { + "xdm:errors": { + "xdm:value": 0 + }, + "xdm:errorImpactedStreams": { + "xdm:value": 0 + }, + "xdm:buffers": { + "xdm:value": 4 + }, + "xdm:bufferTime": { + "xdm:value": 5 + }, + "xdm:bufferImpactedStreams": { + "xdm:value": 2 + }, + "xdm:stalls": { + "xdm:value": 0 + }, + "xdm:stallTime": { + "xdm:value": 0 + }, + "xdm:stallingImpactedStreams": { + "xdm:value": 0 + }, + "xdm:bitrateChanges": { + "xdm:value": 0 + }, + "xdm:bitrateAverage": { + "xdm:value": 320 + }, + "xdm:bitrateAverageBucket": "800-899", + "xdm:bitrateChangeImpactedStreams": { + "xdm:value": 0 + }, + "xdm:dropBeforeStart": { + "xdm:value": 0 + }, + "xdm:droppedFrames": { + "xdm:value": 2 + }, + "xdm:droppedFrameImpactedStreams": { + "xdm:value": 2 + }, + "xdm:timeToStart": { + "xdm:value": 3 + }, + "xdm:mediaSdkErrors": [ + "300", + "500.300.200" + ], + "xdm:playerSdkErrors": [ + "custom.error.code" + ], + "xdm:externalSdkErrors": [ + "100-5", + "11.12" + ] + }, + "xdm:downloadedPlayback": false + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 0 + }, + "xdm:timePlayed": { + "xdm:value": 80 + }, + "xdm:federated": { + "xdm:value": 0 + }, + "xdm:starts": { + "xdm:value": 1 + }, + "xdm:mediaSegmentView": { + "xdm:value": 1 + }, + "xdm:totalTimePlayed": { + "xdm:value": 190 + }, + "xdm:uniqueTimePlayed": { + "xdm:value": 80 + }, + "xdm:averageMinuteAudience": { + "xdm:value": 0.89 + }, + "xdm:adCount": { + "xdm:value": 3 + }, + "xdm:chapterCount": { + "xdm:value": 1 + }, + "xdm:progress10": { + "xdm:value": 1 + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + }, + "xdm:midpoints": { + "xdm:value": 1 + }, + "xdm:thirdQuartiles": { + "xdm:value": 1 + }, + "xdm:progress95": { + "xdm:value": 0 + }, + "xdm:resumes": { + "xdm:value": 0 + }, + "xdm:estimatedStreams": { + "xdm:value": 2 + }, + "xdm:pauseImpactedStreams": { + "xdm:value": 3 + }, + "xdm:pauses": { + "xdm:value": 0 + }, + "xdm:pauseTime": { + "xdm:value": 0 + }, + "xdm:idp": "TVChannel", + "xdm:mediaAuth": "true", + "xdm:dayPart": "daytime" + } + } + }, + { + "@id": "https://data.adobe.io/experienceid-23456782", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + } + ] + }, + "xdm:environment": { + "xdm:type": "application", + "xdm:operatingSystem": "iOS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "mobile_lte" + }, + "xdm:placeContext": { + "xdm:localTime": "2001-07-04T12:08:56+01:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + }, + "xdm:POIinteraction": { + "xdm:poiEntries": { + "xdm:value": 1 + }, + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Acme Hotel Tokyo Lobby", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", + "xdm:beaconMajor": 300, + "xdm:beaconMinor": 34 + } + }, + "xdm:activePOIs": [ + { + "xdm:POIID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", + "xdm:name": "Acme Hotel Tokyo", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", + "xdm:beaconMajor": 100, + "xdm:beaconMinor": 23 + } + }, + { + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Acme Hotel Tokyo Lobby", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", + "xdm:beaconMajor": 300, + "xdm:beaconMinor": 34 + } + }, + { + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Tokyo City", + "xdm:locatingType": "gps", + "xdm:geoInteractionDetails": { + "xdm:distanceToCenter": 320, + "xdm:accuracy": 30, + "xdm:geoShape": { + "@id": "https://data.adobe.io/entities/geoShape/shapeid123", + "schema:circle": { + "@id": "https://data.adobe.io/entities/geo/circleid123", + "schema:description": "Tokyo Metro", + "schema:coordinates": { + "@id": "https://data.adobe.io/entities/geo/111", + "schema:description": "Tokyo", + "schema:latitude": 37.3308953, + "schema:longitude": -121.8939894, + "schema:elevation": 31.0896 + }, + "schema:radius": 80000 + } + } + } + } + ], + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:locationContext": { + "xdm:geo": { + "xdm:countryCode": "US", + "xdm:stateProvince": "CA", + "xdm:city": "Emeryville", + "xdm:dmaid": "99" + } + }, + "xdm:web": { + "xdm:webPageView": { + "xdm:URL": "https://www.example.com" + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.examplereferrer.com/", + "xdm:domain": "examplereferrer.com" + } + }, + "xdm:device": { + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6" + }, + "xdm:advertising": { + "xdm:adViewability": { + "xdm:adUnitDepth": 0, + "xdm:viewportHeight": 1250, + "xdm:viewportWidth": 1600, + "xdm:adHeight": 250, + "xdm:adWidth": 300, + "xdm:playerVolume": 85, + "xdm:measurementEligible": true, + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", + "xdm:version": "1" + }, + "xdm:viewable": true, + "xdm:activeWindow": true, + "xdm:percentViewable": 89, + "xdm:viewableFirstQuartile": { + "xdm:value": 1 + } + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + } + } + }, + { + "@id": "https://data.adobe.io/experienceid-123458", + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92318731249128" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "5492309340-35430470347" + } + ] + }, + "xdm:environment": { + "xdm:browserDetails": { + "xdm:userAgent": "AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30" + }, + "xdm:ipV4": "97.27.143.5" + }, + "xdm:media": { + "xdm:mediaTimed": { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "tv_highlights", + "iptc4xmpExt:Identifier": "http://sporttv.com/series-identifiers/2613953" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "TV100", + "iptc4xmpExt:RatingSourceLink": "http://www.mytvguide.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "SportTV" + } + ], + "xdm:firstAirDate": "2016-01-05", + "xmpDM:releaseDate": "2016-01-25" + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchsport", + "xdm:broadcastChannel": "WatchSportTV", + "xdm:broadcastContentType": "VOD", + "xdm:videoSegment": "3-10", + "xdm:path": "id:arg:episode:ntvr.com:dfb53-4ce7", + "xdm:streamFormat": "short", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "ntwu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.link.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890243544980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:downloadedPlayback": false + } + } + }, + "xdm:advertising": { + "xdm:adAssetReference": { + "@id": "https://data.adobe.io/entities/ad-id/AD1", + "xdm:creativeID": "00da07e-1264-30de-grgg-24ndf4fe456", + "dc:title": "adNumber1", + "xdm:advertiser": "AdCompany", + "xdm:campaign": "731123", + "xmpDM:duration": 10 + }, + "xdm:adAssetViewDetails": { + "xdm:playerName": "miniTestApp", + "xdm:index": 0, + "xdm:adBreak": { + "@id": "https://data.adobe.io/entities/ad-break/f40353618c5c11311f584e53c78654b9_0", + "dc:title": "Mid-Roll", + "xdm:offset": 44 + } + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 1 + }, + "xdm:timePlayed": { + "xdm:value": 10 + }, + "xdm:federated": { + "xdm:value": 0 + } + } + }, + { + "@id": "https://data.adobe.io/experienceid-2345678", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:eventMergeId": "9fb4e78d-b0bf-4d99-b987-cb37abdbcd15", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "92312748749128" + } + ], + "AVID": [ + { + "xdm:id": "2394509340-30453470347" + } + ] + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:locationContext": { + "xdm:geo": { + "xdm:countryCode": "US", + "xdm:stateProvince": "CA", + "xdm:city": "Emeryville", + "xdm:dmaid": "99" + } + }, + "xdm:web": { + "xdm:webPageView": { + "xdm:URL": "https://www.example.com" + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.examplereferrer.com/", + "xdm:domain": "examplereferrer.com" + } + }, + "xdm:device": { + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6" + }, + "xdm:advertising": { + "xdm:adViewability": { + "xdm:adUnitDepth": 0, + "xdm:viewportHeight": 1250, + "xdm:viewportWidth": 1600, + "xdm:adHeight": 250, + "xdm:adWidth": 300, + "xdm:playerVolume": 85, + "xdm:measurementEligible": true, + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", + "xdm:version": "1" + }, + "xdm:viewable": true, + "xdm:activeWindow": true, + "xdm:percentViewable": 89, + "xdm:viewableFirstQuartile": { + "xdm:value": 1 + } + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + } + } + }, + { + "@id": "https://data.adobe.io/experienceid-123459", + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312743856228" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2392846240-30285628347" + } + ] + }, + "xdm:environment": { + "xdm:browserDetails": { + "xdm:userAgent": "AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30" + }, + "xdm:ipV4": "97.27.143.5" + }, + "xdm:media": { + "xdm:mediaTimed": { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "tv_highlights", + "iptc4xmpExt:Identifier": "http://mychannel.com/series-identifiers/2613953" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "TV100", + "iptc4xmpExt:RatingSourceLink": "http://www.tvguide.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "MyChannel" + } + ], + "xdm:firstAirDate": "2016-01-05", + "xmpDM:releaseDate": "2016-01-25" + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchmytv", + "xdm:videoSegment": "3-10", + "xdm:path": "mid:show:episode:cnl.com:12345-4ce7", + "xdm:broadcastChannel": "WatchMyTV", + "xdm:broadcastContentType": "VOD", + "xdm:streamFormat": "short", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "ntwu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.comFhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:downloadedPlayback": false + }, + "xdm:mediaChapter": { + "xdm:chapterAssetReference": { + "@id": "https://data.adobe.io/entities/media-chapter-asset-reference/2144511", + "dc:title": "Chapter1", + "xmpDM:duration": 44 + }, + "xdm:chapterAssetViewDetails": { + "xdm:index": 0, + "xdm:offset": 0 + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 1 + }, + "xdm:timePlayed": { + "xdm:value": 44 + }, + "xdm:federated": { + "xdm:value": 0 + } + } + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/classes/experienceevent.schema.md b/docs/reference/classes/experienceevent.schema.md new file mode 100644 index 000000000..36961ef68 --- /dev/null +++ b/docs/reference/classes/experienceevent.schema.md @@ -0,0 +1,991 @@ + +# XDM ExperienceEvent Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent +``` + +An ExperienceEvent is a fact record of what occurred, including the point in time and identity of the individual involved. ExperienceEvents can be either explicit (directly observable human actions) or implicit (raised without a direct human action) and are recorded without aggregation or interpretation. They are critical for time-domain analytics as they allow for observation and analysis of changes that occur in a given window of time and the comparison between multiple windows of time to track trends. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [classes/experienceevent.schema.json](classes/experienceevent.schema.json) | +## Schema Hierarchy + +* XDM ExperienceEvent `https://ns.adobe.com/xdm/context/experienceevent` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [IdentityMap](../mixins/shared/identitymap.schema.md) `https://ns.adobe.com/xdm/context/identitymap` + * [Time-series Schema](../behaviors/time-series.schema.md) `https://ns.adobe.com/xdm/data/time-series` + + +## XDM ExperienceEvent Examples + +```json +{ + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2394509340-30453470347" + } + ], + "https://data.adobe.io/entities/namespace/9": [ + { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" + } + ] + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + }, + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + }, + "xdm:profileStitch": [ + { + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "1.0", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/92312748749128" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/62312748749321" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" + } + ] + } + } + ], + "xdm:segmentMemberships": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + }, + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:version": "1.0", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "realized" + } + } + ] +} +``` + +```json +{ + "@id": "https://data.adobe.io/experienceid-123457", + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2394509340-30453470347" + } + ] + }, + "xdm:environment": { + "xdm:browserDetails": { + "xdm:userAgent": "AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30" + }, + "xdm:ipV4": "97.73.140.5" + }, + "xdm:media": { + "xdm:mediaTimed": { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "show_highlights", + "iptc4xmpExt:Identifier": "http://myChannel.com/series-identifiers/2692753" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "TVGuru", + "iptc4xmpExt:RatingSourceLink": "http://www.mytvexample.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "SportTV" + } + ] + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchsport", + "xdm:broadcastChannel": "WatchSportTV", + "xdm:broadcastContentType": "VCT", + "xdm:videoSegment": "3-10", + "xdm:path": "id:show:episode:abcd.com:d9263ej-4ce7", + "xdm:streamFormat": "short", + "xdm:vhlVersion": "js-2.0.1.88-c8c0b1", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "ntwu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.link.org%2Fhls%2Fvu%2F9083406%2FVUBX0288374528402980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:QOE": { + "xdm:errors": { + "xdm:value": 0 + }, + "xdm:errorImpactedStreams": { + "xdm:value": 0 + }, + "xdm:buffers": { + "xdm:value": 4 + }, + "xdm:bufferTime": { + "xdm:value": 5 + }, + "xdm:bufferImpactedStreams": { + "xdm:value": 2 + }, + "xdm:stalls": { + "xdm:value": 0 + }, + "xdm:stallTime": { + "xdm:value": 0 + }, + "xdm:stallingImpactedStreams": { + "xdm:value": 0 + }, + "xdm:bitrateChanges": { + "xdm:value": 0 + }, + "xdm:bitrateAverage": { + "xdm:value": 320 + }, + "xdm:bitrateAverageBucket": "800-899", + "xdm:bitrateChangeImpactedStreams": { + "xdm:value": 0 + }, + "xdm:dropBeforeStart": { + "xdm:value": 0 + }, + "xdm:droppedFrames": { + "xdm:value": 2 + }, + "xdm:droppedFrameImpactedStreams": { + "xdm:value": 2 + }, + "xdm:timeToStart": { + "xdm:value": 3 + }, + "xdm:mediaSdkErrors": [ + "300", + "500.300.200" + ], + "xdm:playerSdkErrors": [ + "custom.error.code" + ], + "xdm:externalSdkErrors": [ + "100-5", + "11.12" + ] + }, + "xdm:downloadedPlayback": false + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 0 + }, + "xdm:timePlayed": { + "xdm:value": 80 + }, + "xdm:federated": { + "xdm:value": 0 + }, + "xdm:starts": { + "xdm:value": 1 + }, + "xdm:mediaSegmentView": { + "xdm:value": 1 + }, + "xdm:totalTimePlayed": { + "xdm:value": 190 + }, + "xdm:uniqueTimePlayed": { + "xdm:value": 80 + }, + "xdm:averageMinuteAudience": { + "xdm:value": 0.89 + }, + "xdm:adCount": { + "xdm:value": 3 + }, + "xdm:chapterCount": { + "xdm:value": 1 + }, + "xdm:progress10": { + "xdm:value": 1 + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + }, + "xdm:midpoints": { + "xdm:value": 1 + }, + "xdm:thirdQuartiles": { + "xdm:value": 1 + }, + "xdm:progress95": { + "xdm:value": 0 + }, + "xdm:resumes": { + "xdm:value": 0 + }, + "xdm:estimatedStreams": { + "xdm:value": 2 + }, + "xdm:pauseImpactedStreams": { + "xdm:value": 3 + }, + "xdm:pauses": { + "xdm:value": 0 + }, + "xdm:pauseTime": { + "xdm:value": 0 + }, + "xdm:idp": "TVChannel", + "xdm:mediaAuth": "true", + "xdm:dayPart": "daytime" + } + } +} +``` + +```json +{ + "@id": "https://data.adobe.io/experienceid-23456782", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + } + ] + }, + "xdm:environment": { + "xdm:type": "application", + "xdm:operatingSystem": "iOS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "mobile_lte" + }, + "xdm:placeContext": { + "xdm:localTime": "2001-07-04T12:08:56+01:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + }, + "xdm:POIinteraction": { + "xdm:poiEntries": { + "xdm:value": 1 + }, + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Acme Hotel Tokyo Lobby", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", + "xdm:beaconMajor": 300, + "xdm:beaconMinor": 34 + } + }, + "xdm:activePOIs": [ + { + "xdm:POIID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", + "xdm:name": "Acme Hotel Tokyo", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", + "xdm:beaconMajor": 100, + "xdm:beaconMinor": 23 + } + }, + { + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Acme Hotel Tokyo Lobby", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", + "xdm:beaconMajor": 300, + "xdm:beaconMinor": 34 + } + }, + { + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Tokyo City", + "xdm:locatingType": "gps", + "xdm:geoInteractionDetails": { + "xdm:distanceToCenter": 320, + "xdm:accuracy": 30, + "xdm:geoShape": { + "@id": "https://data.adobe.io/entities/geoShape/shapeid123", + "schema:circle": { + "@id": "https://data.adobe.io/entities/geo/circleid123", + "schema:description": "Tokyo Metro", + "schema:coordinates": { + "@id": "https://data.adobe.io/entities/geo/111", + "schema:description": "Tokyo", + "schema:latitude": 37.3308953, + "schema:longitude": -121.8939894, + "schema:elevation": 31.0896 + }, + "schema:radius": 80000 + } + } + } + } + ], + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:locationContext": { + "xdm:geo": { + "xdm:countryCode": "US", + "xdm:stateProvince": "CA", + "xdm:city": "Emeryville", + "xdm:dmaid": "99" + } + }, + "xdm:web": { + "xdm:webPageView": { + "xdm:URL": "https://www.example.com" + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.examplereferrer.com/", + "xdm:domain": "examplereferrer.com" + } + }, + "xdm:device": { + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6" + }, + "xdm:advertising": { + "xdm:adViewability": { + "xdm:adUnitDepth": 0, + "xdm:viewportHeight": 1250, + "xdm:viewportWidth": 1600, + "xdm:adHeight": 250, + "xdm:adWidth": 300, + "xdm:playerVolume": 85, + "xdm:measurementEligible": true, + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", + "xdm:version": "1" + }, + "xdm:viewable": true, + "xdm:activeWindow": true, + "xdm:percentViewable": 89, + "xdm:viewableFirstQuartile": { + "xdm:value": 1 + } + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + } + } +} +``` + +```json +{ + "@id": "https://data.adobe.io/experienceid-123458", + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92318731249128" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "5492309340-35430470347" + } + ] + }, + "xdm:environment": { + "xdm:browserDetails": { + "xdm:userAgent": "AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30" + }, + "xdm:ipV4": "97.27.143.5" + }, + "xdm:media": { + "xdm:mediaTimed": { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "tv_highlights", + "iptc4xmpExt:Identifier": "http://sporttv.com/series-identifiers/2613953" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "TV100", + "iptc4xmpExt:RatingSourceLink": "http://www.mytvguide.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "SportTV" + } + ], + "xdm:firstAirDate": "2016-01-05", + "xmpDM:releaseDate": "2016-01-25" + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchsport", + "xdm:broadcastChannel": "WatchSportTV", + "xdm:broadcastContentType": "VOD", + "xdm:videoSegment": "3-10", + "xdm:path": "id:arg:episode:ntvr.com:dfb53-4ce7", + "xdm:streamFormat": "short", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "ntwu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.link.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890243544980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:downloadedPlayback": false + } + } + }, + "xdm:advertising": { + "xdm:adAssetReference": { + "@id": "https://data.adobe.io/entities/ad-id/AD1", + "xdm:creativeID": "00da07e-1264-30de-grgg-24ndf4fe456", + "dc:title": "adNumber1", + "xdm:advertiser": "AdCompany", + "xdm:campaign": "731123", + "xmpDM:duration": 10 + }, + "xdm:adAssetViewDetails": { + "xdm:playerName": "miniTestApp", + "xdm:index": 0, + "xdm:adBreak": { + "@id": "https://data.adobe.io/entities/ad-break/f40353618c5c11311f584e53c78654b9_0", + "dc:title": "Mid-Roll", + "xdm:offset": 44 + } + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 1 + }, + "xdm:timePlayed": { + "xdm:value": 10 + }, + "xdm:federated": { + "xdm:value": 0 + } + } +} +``` + +```json +{ + "@id": "https://data.adobe.io/experienceid-2345678", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:eventMergeId": "9fb4e78d-b0bf-4d99-b987-cb37abdbcd15", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "92312748749128" + } + ], + "AVID": [ + { + "xdm:id": "2394509340-30453470347" + } + ] + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:locationContext": { + "xdm:geo": { + "xdm:countryCode": "US", + "xdm:stateProvince": "CA", + "xdm:city": "Emeryville", + "xdm:dmaid": "99" + } + }, + "xdm:web": { + "xdm:webPageView": { + "xdm:URL": "https://www.example.com" + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.examplereferrer.com/", + "xdm:domain": "examplereferrer.com" + } + }, + "xdm:device": { + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6" + }, + "xdm:advertising": { + "xdm:adViewability": { + "xdm:adUnitDepth": 0, + "xdm:viewportHeight": 1250, + "xdm:viewportWidth": 1600, + "xdm:adHeight": 250, + "xdm:adWidth": 300, + "xdm:playerVolume": 85, + "xdm:measurementEligible": true, + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", + "xdm:version": "1" + }, + "xdm:viewable": true, + "xdm:activeWindow": true, + "xdm:percentViewable": 89, + "xdm:viewableFirstQuartile": { + "xdm:value": 1 + } + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + } + } +} +``` + +```json +{ + "@id": "https://data.adobe.io/experienceid-123459", + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312743856228" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2392846240-30285628347" + } + ] + }, + "xdm:environment": { + "xdm:browserDetails": { + "xdm:userAgent": "AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30" + }, + "xdm:ipV4": "97.27.143.5" + }, + "xdm:media": { + "xdm:mediaTimed": { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "tv_highlights", + "iptc4xmpExt:Identifier": "http://mychannel.com/series-identifiers/2613953" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "TV100", + "iptc4xmpExt:RatingSourceLink": "http://www.tvguide.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "MyChannel" + } + ], + "xdm:firstAirDate": "2016-01-05", + "xmpDM:releaseDate": "2016-01-25" + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchmytv", + "xdm:videoSegment": "3-10", + "xdm:path": "mid:show:episode:cnl.com:12345-4ce7", + "xdm:broadcastChannel": "WatchMyTV", + "xdm:broadcastContentType": "VOD", + "xdm:streamFormat": "short", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "ntwu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.comFhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:downloadedPlayback": false + }, + "xdm:mediaChapter": { + "xdm:chapterAssetReference": { + "@id": "https://data.adobe.io/entities/media-chapter-asset-reference/2144511", + "dc:title": "Chapter1", + "xmpDM:duration": 44 + }, + "xdm:chapterAssetViewDetails": { + "xdm:index": 0, + "xdm:offset": 0 + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 1 + }, + "xdm:timePlayed": { + "xdm:value": 44 + }, + "xdm:federated": { + "xdm:value": 0 + } + } + } + } +} +``` + + +# XDM ExperienceEvent Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Time-series Schema](../behaviors/time-series.schema.md#id) | +| [xdm:eventMergeId](#xdmeventmergeid) | `string` | Optional | XDM ExperienceEvent (this schema) | +| [xdm:eventType](#xdmeventtype) | `string` | Optional | [Time-series Schema](../behaviors/time-series.schema.md#xdmeventtype) | +| [xdm:identityMap](#xdmidentitymap) | `object` | Optional | [IdentityMap](../mixins/shared/identitymap.schema.md#xdmidentitymap) | +| [xdm:timestamp](#xdmtimestamp) | `string` | **Required** | [Time-series Schema](../behaviors/time-series.schema.md#xdmtimestamp) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the time-series event. + +`@id` +* is **required** +* type: `string` +* defined in [Time-series Schema](../behaviors/time-series.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:eventMergeId +### ExperienceEvent merge ID + +An ID to correlate or merge multiple Experience events together that are essentially the same event or should be merged. This is intended to be populated by the data producer prior to ingestion. + +`xdm:eventMergeId` +* is optional +* type: `string` +* defined in this schema + +### xdm:eventMergeId Type + + +`string` + + + + + + +## xdm:eventType +### Event Type + +The primary event type for this time-series record. + +`xdm:eventType` +* is optional +* type: `string` +* defined in [Time-series Schema](../behaviors/time-series.schema.md#xdmeventtype) + +### xdm:eventType Type + + +`string` + + + +### xdm:eventType Known Values +| Value | Description | +|-------|-------------| +| `advertising.completes` | Indicates if a timed media asset was watched to completion - this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead. | +| `advertising.timePlayed` | Describes the amount of time spent by a user on a specific timed media asset. | +| `advertising.federated` | Indicates if an experience event was created through data federation (data sharing between customers). | +| `advertising.clicks` | Click(s) actions on an advertisement. | +| `advertising.conversions` | A customer pre-defined action(s) which triggers an event for performance evaluation. | +| `advertising.firstQuartiles` | A digital video ad has played through 25% of its duration at normal speed. | +| `advertising.impressions` | Impression(s) of an advertisement to an end-user with the potential of being viewed. | +| `advertising.midpoints` | A digital video ad has played through 50% of its duration at normal speed. | +| `advertising.starts` | A digital video ad has started playing. | +| `advertising.thirdQuartiles` | A digital video ad has played through 75% of its duration at normal speed. | +| `web.webpagedetails.pageViews` | View(s) of a webpage has occurred. | +| `web.webinteraction.linkClicks` | Click of a web-link has occurred. | +| `commerce.checkouts` | An action during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order. | +| `commerce.productListAdds` | Addition of a product to the product list. Example a product is added to a shopping cart. | +| `commerce.productListOpens` | Initializations of a new product list. Example a shopping cart is created. | +| `commerce.productListRemovals` | Removal(s) of a product entry from a product list. Example a product is removed from a shopping cart. | +| `commerce.productListReopens` | A product list that was no longer accessible(abandoned) has been re-activated by the user. Example via a re-marketing activity. | +| `commerce.productListViews` | View(s) of a product-list has occurred. | +| `commerce.productViews` | View(s) of a product have occurred. | +| `commerce.purchases` | An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced. | +| `commerce.saveForLaters` | Product list is saved for future use. Example a product wish list. | +| `delivery.feedback` | Feedback events for a delivery. Example feedback events for an email delivery. | + + + + +## xdm:identityMap + + +`xdm:identityMap` +* is optional +* type: `object` +* defined in [IdentityMap](../mixins/shared/identitymap.schema.md#xdmidentitymap) + +### xdm:identityMap Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:timestamp +### Timestamp + +The time when an event or observation occurred. + +`xdm:timestamp` +* is **required** +* type: `string` +* defined in [Time-series Schema](../behaviors/time-series.schema.md#xdmtimestamp) + +### xdm:timestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + diff --git a/docs/reference/classes/graphs.schema.json b/docs/reference/classes/graphs.schema.json new file mode 100644 index 000000000..af8e8e949 --- /dev/null +++ b/docs/reference/classes/graphs.schema.json @@ -0,0 +1,84 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/graphs", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Graphs", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record" + ], + "description": "An XDM Graph. A Graph represents a set of related nodes and their relationships (often called as edges). These graphs could also be a set of nodes only without relationships. For example, person graph where each node is a device which the person uses.", + "definitions": { + "graphs": { + "properties": {} + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/graphs" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:graphId": "96698daa-d44a-4960-bb7e-588bfc928ea3", + "xdm:directed": false, + "xdm:graphType": "Person Graph", + "xdm:graphCreateTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:firstCreatedTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:lastModifiedTimestamp": "2019-03-10T15:52:25+00:00", + "xdm:nodes": [ + { + "xdm:nodeId": "aam_1|0", + "xdm:nodeType": "Identity", + "xdm:firstSeenTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:lastSeenTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:firstCreateTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:lastModifiedTimestamp": "2019-01-01T15:52:25+00:00" + }, + { + "xdm:nodeId": "dpuuid_1|10", + "xdm:nodeType": "Identity", + "xdm:firstSeenTimestamp": "2019-03-01T15:52:25+00:00", + "xdm:lastSeenTimestamp": "2019-03-01T15:52:25+00:00", + "xdm:firstCreateTimestamp": "2019-03-01T15:52:25+00:00", + "xdm:lastModifiedTimestamp": "2019-03-01T15:52:25+00:00" + } + ], + "xdm:edges": [ + { + "xdm:sourceNodeId": "aam_1|0", + "xdm:targetNodeId": "dpuuid_1|10", + "xdm:dataProvider": [ + { + "xdm:dataProviderId": 5, + "xdm:firstSeenTimestamp": "2019-02-01T15:52:25+00:00", + "xdm:lastSeenTimestamp": "2019-02-01T15:52:25+00:00", + "xdm:trusted": true, + "xdm:directed": false, + "xdm:relationType": "online_deterministic", + "xdm:frequency": 1, + "xdm:lastCalculatedTimestamp": "2019-02-01T15:52:25+00:00" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/classes/graphs.schema.md b/docs/reference/classes/graphs.schema.md new file mode 100644 index 000000000..aa62de567 --- /dev/null +++ b/docs/reference/classes/graphs.schema.md @@ -0,0 +1,233 @@ + +# XDM Graphs Schema + +``` +https://ns.adobe.com/xdm/context/graphs +``` + +An XDM Graph. A Graph represents a set of related nodes and their relationships (often called as edges). These graphs could also be a set of nodes only without relationships. For example, person graph where each node is a device which the person uses. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [classes/graphs.schema.json](classes/graphs.schema.json) | +## Schema Hierarchy + +* XDM Graphs `https://ns.adobe.com/xdm/context/graphs` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Audit trail](../datatypes/auditable.schema.md) `https://ns.adobe.com/xdm/common/auditable` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + + +## XDM Graphs Example +```json +{ + "xdm:graphId": "96698daa-d44a-4960-bb7e-588bfc928ea3", + "xdm:directed": false, + "xdm:graphType": "Person Graph", + "xdm:graphCreateTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:firstCreatedTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:lastModifiedTimestamp": "2019-03-10T15:52:25+00:00", + "xdm:nodes": [ + { + "xdm:nodeId": "aam_1|0", + "xdm:nodeType": "Identity", + "xdm:firstSeenTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:lastSeenTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:firstCreateTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:lastModifiedTimestamp": "2019-01-01T15:52:25+00:00" + }, + { + "xdm:nodeId": "dpuuid_1|10", + "xdm:nodeType": "Identity", + "xdm:firstSeenTimestamp": "2019-03-01T15:52:25+00:00", + "xdm:lastSeenTimestamp": "2019-03-01T15:52:25+00:00", + "xdm:firstCreateTimestamp": "2019-03-01T15:52:25+00:00", + "xdm:lastModifiedTimestamp": "2019-03-01T15:52:25+00:00" + } + ], + "xdm:edges": [ + { + "xdm:sourceNodeId": "aam_1|0", + "xdm:targetNodeId": "dpuuid_1|10", + "xdm:dataProvider": [ + { + "xdm:dataProviderId": 5, + "xdm:firstSeenTimestamp": "2019-02-01T15:52:25+00:00", + "xdm:lastSeenTimestamp": "2019-02-01T15:52:25+00:00", + "xdm:trusted": true, + "xdm:directed": false, + "xdm:relationType": "online_deterministic", + "xdm:frequency": 1, + "xdm:lastCalculatedTimestamp": "2019-02-01T15:52:25+00:00" + } + ] + } + ] +} +``` + +# XDM Graphs Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [repo:createDate](#repocreatedate) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#repocreatedate) | +| [repo:modifyDate](#repomodifydate) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#repomodifydate) | +| [xdm:createdByBatchID](#xdmcreatedbybatchid) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#xdmcreatedbybatchid) | +| [xdm:modifiedByBatchID](#xdmmodifiedbybatchid) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#xdmmodifiedbybatchid) | +| [xdm:repositoryCreatedBy](#xdmrepositorycreatedby) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#xdmrepositorycreatedby) | +| [xdm:repositoryLastModifiedBy](#xdmrepositorylastmodifiedby) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#xdmrepositorylastmodifiedby) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## repo:createDate + +The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:createDate` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#repocreatedate) + +### repo:createDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:createDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## repo:modifyDate + +The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:modifyDate` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#repomodifydate) + +### repo:modifyDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:modifyDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## xdm:createdByBatchID +### Created by batch identifier + +The dataset files in Catalog which has been originating the creation of the record. + +`xdm:createdByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#xdmcreatedbybatchid) + +### xdm:createdByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:modifiedByBatchID +### Modified by batch identifier + +The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`. + +`xdm:modifiedByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#xdmmodifiedbybatchid) + +### xdm:modifiedByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:repositoryCreatedBy +### Created by user identifier + +User ID of who created the record. + +`xdm:repositoryCreatedBy` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#xdmrepositorycreatedby) + +### xdm:repositoryCreatedBy Type + + +`string` + + + + + + +## xdm:repositoryLastModifiedBy +### Modified by user identifier + +User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`. + +`xdm:repositoryLastModifiedBy` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#xdmrepositorylastmodifiedby) + +### xdm:repositoryLastModifiedBy Type + + +`string` + + + + + diff --git a/docs/reference/classes/opportunity-contact-role.schema.json b/docs/reference/classes/opportunity-contact-role.schema.json new file mode 100644 index 000000000..6433d54a0 --- /dev/null +++ b/docs/reference/classes/opportunity-contact-role.schema.json @@ -0,0 +1,75 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/opportunity-contact-role", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Buying Group", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record" + ], + "description": "Opportunity Contact Role", + "definitions": { + "opportunity-contact-role": { + "properties": { + "xdm:opportunityContactID": { + "title": "opportunity ContactID", + "description": "A Unique Key describing a combination of OpportunityID and contactID.", + "type": "string" + }, + "xdm:opportunityID": { + "title": "Opportunity ID", + "description": "Opportunity ID unique identifier.", + "type": "string" + }, + "xdm:contactID": { + "title": "Contact ID", + "description": "Contact ID unique identifier.", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/opportunity-contact-role" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit-details" + } + ], + "required": [ + "xdm:opportunityContactID", + "xdm:opportunityID", + "xdm:contactID" + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:opportunityContactID": "123456", + "xdm:opportunityID": "123", + "xdm:contactID": "456", + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-20T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-20T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-20T15:52:25+00:00" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/classes/opportunity-contact-role.schema.md b/docs/reference/classes/opportunity-contact-role.schema.md new file mode 100644 index 000000000..09a7f0809 --- /dev/null +++ b/docs/reference/classes/opportunity-contact-role.schema.md @@ -0,0 +1,148 @@ + +# XDM Buying Group Schema + +``` +https://ns.adobe.com/xdm/context/opportunity-contact-role +``` + +Opportunity Contact Role + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [classes/opportunity-contact-role.schema.json](classes/opportunity-contact-role.schema.json) | +## Schema Hierarchy + +* XDM Buying Group `https://ns.adobe.com/xdm/context/opportunity-contact-role` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + * [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md) `https://ns.adobe.com/xdm/common/external-source-system-audit-details` + + +## XDM Buying Group Example +```json +{ + "xdm:opportunityContactID": "123456", + "xdm:opportunityID": "123", + "xdm:contactID": "456", + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-20T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-20T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-20T15:52:25+00:00" + } +} +``` + +# XDM Buying Group Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [xdm:contactID](#xdmcontactid) | `string` | **Required** | XDM Buying Group (this schema) | +| [xdm:extSourceSystemAudit](#xdmextsourcesystemaudit) | External Source System Audit Attributes | Optional | [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) | +| [xdm:opportunityContactID](#xdmopportunitycontactid) | `string` | **Required** | XDM Buying Group (this schema) | +| [xdm:opportunityID](#xdmopportunityid) | `string` | **Required** | XDM Buying Group (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:contactID +### Contact ID + +Contact ID unique identifier. + +`xdm:contactID` +* is **required** +* type: `string` +* defined in this schema + +### xdm:contactID Type + + +`string` + + + + + + +## xdm:extSourceSystemAudit +### External Source System Audit Properties + +Audit attributes for external sources. + +`xdm:extSourceSystemAudit` +* is optional +* type: External Source System Audit Attributes +* defined in [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) + +### xdm:extSourceSystemAudit Type + + +* [External Source System Audit Attributes](../datatypes/external-source-system-audit.schema.md) – `https://ns.adobe.com/xdm/common/external-source-system-audit` + + + + + +## xdm:opportunityContactID +### opportunity ContactID + +A Unique Key describing a combination of OpportunityID and contactID. + +`xdm:opportunityContactID` +* is **required** +* type: `string` +* defined in this schema + +### xdm:opportunityContactID Type + + +`string` + + + + + + +## xdm:opportunityID +### Opportunity ID + +Opportunity ID unique identifier. + +`xdm:opportunityID` +* is **required** +* type: `string` +* defined in this schema + +### xdm:opportunityID Type + + +`string` + + + + + diff --git a/docs/reference/classes/opportunity.schema.json b/docs/reference/classes/opportunity.schema.json new file mode 100644 index 000000000..2e4a97199 --- /dev/null +++ b/docs/reference/classes/opportunity.schema.json @@ -0,0 +1,72 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/opportunity", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Opportunity", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record" + ], + "description": "An XDM Business Opportunity.", + "definitions": { + "opportunity": { + "properties": { + "xdm:opportuntyID": { + "title": "Opportunity ID", + "description": "Unique identifer of the opportunity", + "type": "string" + }, + "xdm:opportunityType": { + "title": "Opportunity Type", + "description": "Type of Opportunity.", + "type": "string" + }, + "xdm:accountID": { + "title": "Account ID", + "description": "Account identifer reference", + "type": "string" + }, + "xdm:campaignID": { + "title": "Campaign ID", + "description": "Campaign unique identifer reference", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/opportunity" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit-details" + } + ], + "required": [ + "xdm:opportunityID", + "xdm:opportunityType", + "xdm:accountID" + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:opportunityID": "12345", + "xdm:opportunityType": "business", + "xdm:accountID": "89765", + "xdm:campaignID": "95678" + } + ] +} \ No newline at end of file diff --git a/docs/reference/classes/opportunity.schema.md b/docs/reference/classes/opportunity.schema.md new file mode 100644 index 000000000..ad59e529d --- /dev/null +++ b/docs/reference/classes/opportunity.schema.md @@ -0,0 +1,161 @@ + +# XDM Business Opportunity Schema + +``` +https://ns.adobe.com/xdm/context/opportunity +``` + +An XDM Business Opportunity. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [classes/opportunity.schema.json](classes/opportunity.schema.json) | +## Schema Hierarchy + +* XDM Business Opportunity `https://ns.adobe.com/xdm/context/opportunity` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + * [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md) `https://ns.adobe.com/xdm/common/external-source-system-audit-details` + + +## XDM Business Opportunity Example +```json +{ + "xdm:opportunityID": "12345", + "xdm:opportunityType": "business", + "xdm:accountID": "89765", + "xdm:campaignID": "95678" +} +``` + +# XDM Business Opportunity Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [xdm:accountID](#xdmaccountid) | `string` | **Required** | XDM Business Opportunity (this schema) | +| [xdm:campaignID](#xdmcampaignid) | `string` | Optional | XDM Business Opportunity (this schema) | +| [xdm:extSourceSystemAudit](#xdmextsourcesystemaudit) | External Source System Audit Attributes | Optional | [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) | +| [xdm:opportunityType](#xdmopportunitytype) | `string` | **Required** | XDM Business Opportunity (this schema) | +| [xdm:opportuntyID](#xdmopportuntyid) | `string` | Optional | XDM Business Opportunity (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:accountID +### Account ID + +Account identifer reference + +`xdm:accountID` +* is **required** +* type: `string` +* defined in this schema + +### xdm:accountID Type + + +`string` + + + + + + +## xdm:campaignID +### Campaign ID + +Campaign unique identifer reference + +`xdm:campaignID` +* is optional +* type: `string` +* defined in this schema + +### xdm:campaignID Type + + +`string` + + + + + + +## xdm:extSourceSystemAudit +### External Source System Audit Properties + +Audit attributes for external sources. + +`xdm:extSourceSystemAudit` +* is optional +* type: External Source System Audit Attributes +* defined in [External Source System Audit Details Mixin](../mixins/shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) + +### xdm:extSourceSystemAudit Type + + +* [External Source System Audit Attributes](../datatypes/external-source-system-audit.schema.md) – `https://ns.adobe.com/xdm/common/external-source-system-audit` + + + + + +## xdm:opportunityType +### Opportunity Type + +Type of Opportunity. + +`xdm:opportunityType` +* is **required** +* type: `string` +* defined in this schema + +### xdm:opportunityType Type + + +`string` + + + + + + +## xdm:opportuntyID +### Opportunity ID + +Unique identifer of the opportunity + +`xdm:opportuntyID` +* is optional +* type: `string` +* defined in this schema + +### xdm:opportuntyID Type + + +`string` + + + + + diff --git a/docs/reference/classes/profile.schema.json b/docs/reference/classes/profile.schema.json new file mode 100644 index 000000000..074eac082 --- /dev/null +++ b/docs/reference/classes/profile.schema.json @@ -0,0 +1,133 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Individual Profile", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record", + "https://ns.adobe.com/xdm/common/auditable" + ], + "description": "An XDM Individual Profile forms a singular representation of the attributes and interests of both identified and partially-identified individuals. Less-identified profiles may contain only anonymous behavioral signals, such as browser cookies, while highly-identified profiles may contain detailed personal information such as name, date of birth, location, and email address. As a profile grows, it becomes a robust repository of personal information, identification information, contact details, and communication preferences for an individual.", + "definitions": { + "profile": { + "properties": {} + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/profile" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "92312748749128" + } + ], + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:person": { + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDayAndMonth": "01-03", + "xdm:gender": "female" + }, + "xdm:workAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "xdm:workEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active" + }, + "xdm:mobilePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:optInOut": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false + }, + "xdm:orgUnit": { + "@id": "https://data.adobe.io/org-apparals-men" + }, + "xdm:geoUnit": { + "@id": "https://data.adobe.io/geo-france" + }, + "xdm:segments": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "15", + "xdm:timestamp": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2019-04-26T15:52:25+00:00", + "xdm:status": "existing" + }, + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/53cba6b2-a23b-454a-8069-fc41308f1c0f", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "3", + "xdm:lastQualificationTime": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2018-04-27T15:52:25+00:00", + "xdm:status": "realized" + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/classes/profile.schema.md b/docs/reference/classes/profile.schema.md new file mode 100644 index 000000000..c8df4dbc6 --- /dev/null +++ b/docs/reference/classes/profile.schema.md @@ -0,0 +1,280 @@ + +# XDM Individual Profile Schema + +``` +https://ns.adobe.com/xdm/context/profile +``` + +An XDM Individual Profile forms a singular representation of the attributes and interests of both identified and partially-identified individuals. Less-identified profiles may contain only anonymous behavioral signals, such as browser cookies, while highly-identified profiles may contain detailed personal information such as name, date of birth, location, and email address. As a profile grows, it becomes a robust repository of personal information, identification information, contact details, and communication preferences for an individual. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [classes/profile.schema.json](classes/profile.schema.json) | +## Schema Hierarchy + +* XDM Individual Profile `https://ns.adobe.com/xdm/context/profile` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Audit trail](../datatypes/auditable.schema.md) `https://ns.adobe.com/xdm/common/auditable` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + + +## XDM Individual Profile Example +```json +{ + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "92312748749128" + } + ], + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:person": { + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDayAndMonth": "01-03", + "xdm:gender": "female" + }, + "xdm:workAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "xdm:workEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active" + }, + "xdm:mobilePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:optInOut": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false + }, + "xdm:orgUnit": { + "@id": "https://data.adobe.io/org-apparals-men" + }, + "xdm:geoUnit": { + "@id": "https://data.adobe.io/geo-france" + }, + "xdm:segments": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "15", + "xdm:timestamp": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2019-04-26T15:52:25+00:00", + "xdm:status": "existing" + }, + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/53cba6b2-a23b-454a-8069-fc41308f1c0f", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "3", + "xdm:lastQualificationTime": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2018-04-27T15:52:25+00:00", + "xdm:status": "realized" + } + ] +} +``` + +# XDM Individual Profile Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [repo:createDate](#repocreatedate) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#repocreatedate) | +| [repo:modifyDate](#repomodifydate) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#repomodifydate) | +| [xdm:createdByBatchID](#xdmcreatedbybatchid) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#xdmcreatedbybatchid) | +| [xdm:modifiedByBatchID](#xdmmodifiedbybatchid) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#xdmmodifiedbybatchid) | +| [xdm:repositoryCreatedBy](#xdmrepositorycreatedby) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#xdmrepositorycreatedby) | +| [xdm:repositoryLastModifiedBy](#xdmrepositorylastmodifiedby) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#xdmrepositorylastmodifiedby) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## repo:createDate + +The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:createDate` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#repocreatedate) + +### repo:createDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:createDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## repo:modifyDate + +The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:modifyDate` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#repomodifydate) + +### repo:modifyDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:modifyDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## xdm:createdByBatchID +### Created by batch identifier + +The dataset files in Catalog which has been originating the creation of the record. + +`xdm:createdByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#xdmcreatedbybatchid) + +### xdm:createdByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:modifiedByBatchID +### Modified by batch identifier + +The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`. + +`xdm:modifiedByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#xdmmodifiedbybatchid) + +### xdm:modifiedByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:repositoryCreatedBy +### Created by user identifier + +User ID of who created the record. + +`xdm:repositoryCreatedBy` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#xdmrepositorycreatedby) + +### xdm:repositoryCreatedBy Type + + +`string` + + + + + + +## xdm:repositoryLastModifiedBy +### Modified by user identifier + +User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`. + +`xdm:repositoryLastModifiedBy` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#xdmrepositorylastmodifiedby) + +### xdm:repositoryLastModifiedBy Type + + +`string` + + + + + diff --git a/docs/reference/classes/segmentdefinition.schema.json b/docs/reference/classes/segmentdefinition.schema.json new file mode 100644 index 000000000..c24866905 --- /dev/null +++ b/docs/reference/classes/segmentdefinition.schema.json @@ -0,0 +1,95 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/segmentdefinition", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment definition", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "This is the base class for a segment definition which includes required fields like identity of a segment and name of segment. Segment definitions coming from various system can use this class to build Segment Definition XDM schema.", + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record", + "https://ns.adobe.com/xdm/common/auditable" + ], + "definitions": { + "segmentdefinition": { + "properties": { + "xdm:segmentIdentity": { + "title": "Segment identity", + "$ref": "https://ns.adobe.com/xdm/context/segmentidentity", + "description": "Identity of the segment.", + "meta:status": "deprecated" + }, + "xdm:segmentName": { + "title": "Segment name", + "type": "string", + "description": "Name of the segment." + }, + "xdm:description": { + "title": "Segment description", + "type": "string", + "description": "Description of the segment." + }, + "xdm:version": { + "title": "Segment version", + "type": "string", + "description": "Version of the segment." + }, + "xdm:segmentStatus": { + "type": "string", + "title": "Segment status", + "description": "Current status of segment from external system normalized to active or inactive.", + "enum": [ + "ACTIVE", + "INACTIVE", + "DELETED" + ] + } + } + } + }, + "required": [ + "xdm:identityMap", + "xdm:segmentName" + ], + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/segmentdefinition" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:identityMap": { + "AAMSegments": [ + { + "xdm:id": "112233", + "xdm:primary": true + } + ] + }, + "xdm:segmentName": "Users with TV segment", + "xdm:description": "Segment is about users who have TV", + "xdm:segmentStatus": "ACTIVE", + "repo:createDate": "2018-10-23T12:00:00-06:00", + "repo:modifyDate": "2019-03-21T12:00:00-06:00" + } + ] +} \ No newline at end of file diff --git a/docs/reference/classes/segmentdefinition.schema.md b/docs/reference/classes/segmentdefinition.schema.md new file mode 100644 index 000000000..f45ebedbc --- /dev/null +++ b/docs/reference/classes/segmentdefinition.schema.md @@ -0,0 +1,335 @@ + +# Segment definition Schema + +``` +https://ns.adobe.com/xdm/context/segmentdefinition +``` + +This is the base class for a segment definition which includes required fields like identity of a segment and name of segment. Segment definitions coming from various system can use this class to build Segment Definition XDM schema. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [classes/segmentdefinition.schema.json](classes/segmentdefinition.schema.json) | +## Schema Hierarchy + +* Segment definition `https://ns.adobe.com/xdm/context/segmentdefinition` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [IdentityMap](../mixins/shared/identitymap.schema.md) `https://ns.adobe.com/xdm/context/identitymap` + * [Audit trail](../datatypes/auditable.schema.md) `https://ns.adobe.com/xdm/common/auditable` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + * [Segment identity](../datatypes/segmentidentity.schema.md) `https://ns.adobe.com/xdm/context/segmentidentity` + + +## Segment definition Example +```json +{ + "xdm:identityMap": { + "AAMSegments": [ + { + "xdm:id": "112233", + "xdm:primary": true + } + ] + }, + "xdm:segmentName": "Users with TV segment", + "xdm:description": "Segment is about users who have TV", + "xdm:segmentStatus": "ACTIVE", + "repo:createDate": "2018-10-23T12:00:00-06:00", + "repo:modifyDate": "2019-03-21T12:00:00-06:00" +} +``` + +# Segment definition Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [repo:createDate](#repocreatedate) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#repocreatedate) | +| [repo:modifyDate](#repomodifydate) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#repomodifydate) | +| [xdm:createdByBatchID](#xdmcreatedbybatchid) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#xdmcreatedbybatchid) | +| [xdm:description](#xdmdescription) | `string` | Optional | Segment definition (this schema) | +| [xdm:identityMap](#xdmidentitymap) | `object` | **Required** | [IdentityMap](../mixins/shared/identitymap.schema.md#xdmidentitymap) | +| [xdm:modifiedByBatchID](#xdmmodifiedbybatchid) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#xdmmodifiedbybatchid) | +| [xdm:repositoryCreatedBy](#xdmrepositorycreatedby) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#xdmrepositorycreatedby) | +| [xdm:repositoryLastModifiedBy](#xdmrepositorylastmodifiedby) | `string` | Optional | [Audit trail](../datatypes/auditable.schema.md#xdmrepositorylastmodifiedby) | +| [xdm:segmentIdentity](#xdmsegmentidentity) | Segment identity | Optional | Segment definition (this schema) | +| [xdm:segmentName](#xdmsegmentname) | `string` | **Required** | Segment definition (this schema) | +| [xdm:segmentStatus](#xdmsegmentstatus) | `enum` | Optional | Segment definition (this schema) | +| [xdm:version](#xdmversion) | `string` | Optional | Segment definition (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## repo:createDate + +The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:createDate` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#repocreatedate) + +### repo:createDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:createDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## repo:modifyDate + +The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:modifyDate` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#repomodifydate) + +### repo:modifyDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:modifyDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## xdm:createdByBatchID +### Created by batch identifier + +The dataset files in Catalog which has been originating the creation of the record. + +`xdm:createdByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#xdmcreatedbybatchid) + +### xdm:createdByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:description +### Segment description + +Description of the segment. + +`xdm:description` +* is optional +* type: `string` +* defined in this schema + +### xdm:description Type + + +`string` + + + + + + +## xdm:identityMap + + +`xdm:identityMap` +* is **required** +* type: `object` +* defined in [IdentityMap](../mixins/shared/identitymap.schema.md#xdmidentitymap) + +### xdm:identityMap Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:modifiedByBatchID +### Modified by batch identifier + +The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`. + +`xdm:modifiedByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#xdmmodifiedbybatchid) + +### xdm:modifiedByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:repositoryCreatedBy +### Created by user identifier + +User ID of who created the record. + +`xdm:repositoryCreatedBy` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#xdmrepositorycreatedby) + +### xdm:repositoryCreatedBy Type + + +`string` + + + + + + +## xdm:repositoryLastModifiedBy +### Modified by user identifier + +User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`. + +`xdm:repositoryLastModifiedBy` +* is optional +* type: `string` +* defined in [Audit trail](../datatypes/auditable.schema.md#xdmrepositorylastmodifiedby) + +### xdm:repositoryLastModifiedBy Type + + +`string` + + + + + + +## xdm:segmentIdentity +### Segment identity + +Identity of the segment. + +`xdm:segmentIdentity` +* is optional +* type: Segment identity +* defined in this schema + +### xdm:segmentIdentity Type + + +* [Segment identity](../datatypes/segmentidentity.schema.md) – `https://ns.adobe.com/xdm/context/segmentidentity` + + + + + +## xdm:segmentName +### Segment name + +Name of the segment. + +`xdm:segmentName` +* is **required** +* type: `string` +* defined in this schema + +### xdm:segmentName Type + + +`string` + + + + + + +## xdm:segmentStatus +### Segment status + +Current status of segment from external system normalized to active or inactive. + +`xdm:segmentStatus` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmsegmentstatus-known-values). + +### xdm:segmentStatus Known Values +| Value | Description | +|-------|-------------| +| `ACTIVE` | | +| `INACTIVE` | | +| `DELETED` | | + + + + +## xdm:version +### Segment version + +Version of the segment. + +`xdm:version` +* is optional +* type: `string` +* defined in this schema + +### xdm:version Type + + +`string` + + + + + diff --git a/docs/reference/common/identity.schema.json b/docs/reference/common/identity.schema.json new file mode 100644 index 000000000..b0d7bdb13 --- /dev/null +++ b/docs/reference/common/identity.schema.json @@ -0,0 +1,87 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/common/identity", + "title": "User identity", + "type": "object", + "meta:extensible": true, + "description": "This model represents an authenticated IMS user. The IMS user principal is a user account under Adobe's identity management system (IMS).", + "definitions": { + "identity": { + "type": "object", + "properties": { + "xdm:identityProvider": { + "description": "The identity provider that manages this principal.", + "type": "string", + "meta:enum": [ + "ims" + ] + }, + "xdm:id": { + "description": "Principal ID identifies a user account in IMS. Its value is equivalent to the standard claim, `sub` as mentioned in the [openid connect 1.0 standard claims](http://openid.net/specs/openid-connect-core-1_0.html#StandardClaim). This value can be obtained by fetching the [userinfo resource](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo) for a particular user [in IMS](https://wiki.corp.adobe.com/display/ims/IMS+API+-+userinfo).", + "type": "string" + }, + "xdm:type": { + "type": "string", + "meta:enum": [ + "https://ns.adobe.com/xdm/common/user" + ], + "format": "uri", + "description": "The type of the identity. Acts as a processing hint to the client. Ideally, each value should be identified as a [URI](https://tools.ietf.org/html/rfc3986)." + } + } + }, + "publicprofile": { + "xdm:displayName": { + "title": "Name", + "type": "string", + "description": "Display name." + }, + "xdm:profileImage": { + "title": "Image", + "format": "uri", + "type": "string", + "description": "Profile avatar or picture of the person." + }, + "xdm:profileLink": { + "title": "Image", + "format": "uri", + "type": "string", + "description": "Link to the public profile of the person, for example linking to the users Adobe Behance public profile." + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/identity" + }, + { + "$ref": "#/definitions/publicprofile" + } + ], + "required": [ + "xdm:identityProvider", + "xdm:id", + "xdm:type" + ], + "meta:status": "deprecated", + "examples": [ + { + "xdm:identityProvider": "ims", + "xdm:id": "C0B648DE57D701277F000101@AdobeID", + "xdm:type": "https://ns.adobe.com/xdm/common/user" + }, + { + "xdm:identityProvider": "ims", + "xdm:id": "C0B648DE57D701277F000101@AdobeID", + "xdm:type": "https://ns.adobe.com/xdm/common/user", + "xdm:displayName": "The users name", + "xdm:profileImage": "https://mir-s3-cdn-cf.behance.net/user/276/b9c11633104347.57a9c2152b78e.jpg" + } + ] +} \ No newline at end of file diff --git a/docs/reference/common/identity.schema.md b/docs/reference/common/identity.schema.md new file mode 100644 index 000000000..331ef36fd --- /dev/null +++ b/docs/reference/common/identity.schema.md @@ -0,0 +1,110 @@ + +# User identity Schema + +``` +https://ns.adobe.com/xdm/common/identity +``` + +This model represents an authenticated IMS user. The IMS user principal is a user account under Adobe's identity management system (IMS). + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Deprecated | No | Forbidden | Permitted | [common/identity.schema.json](common/identity.schema.json) | + +## User identity Examples + +```json +{ + "xdm:identityProvider": "ims", + "xdm:id": "C0B648DE57D701277F000101@AdobeID", + "xdm:type": "https://ns.adobe.com/xdm/common/user" +} +``` + +```json +{ + "xdm:identityProvider": "ims", + "xdm:id": "C0B648DE57D701277F000101@AdobeID", + "xdm:type": "https://ns.adobe.com/xdm/common/user", + "xdm:displayName": "The users name", + "xdm:profileImage": "https://mir-s3-cdn-cf.behance.net/user/276/b9c11633104347.57a9c2152b78e.jpg" +} +``` + + +# User identity Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:id](#xdmid) | `string` | **Required** | User identity (this schema) | +| [xdm:identityProvider](#xdmidentityprovider) | `string` | **Required** | User identity (this schema) | +| [xdm:type](#xdmtype) | `string` | **Required** | User identity (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:id + +Principal ID identifies a user account in IMS. Its value is equivalent to the standard claim, `sub` as mentioned in the [openid connect 1.0 standard claims](http://openid.net/specs/openid-connect-core-1_0.html#StandardClaim). This value can be obtained by fetching the [userinfo resource](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo) for a particular user [in IMS](https://wiki.corp.adobe.com/display/ims/IMS+API+-+userinfo). + +`xdm:id` +* is **required** +* type: `string` +* defined in this schema + +### xdm:id Type + + +`string` + + + + + + +## xdm:identityProvider + +The identity provider that manages this principal. + +`xdm:identityProvider` +* is **required** +* type: `string` +* defined in this schema + +### xdm:identityProvider Type + + +`string` + + + +### xdm:identityProvider Known Values +| Value | Description | +|-------|-------------| +| `0` | ims | + + + + +## xdm:type + +The type of the identity. Acts as a processing hint to the client. Ideally, each value should be identified as a [URI](https://tools.ietf.org/html/rfc3986). + +`xdm:type` +* is **required** +* type: `string` +* defined in this schema + +### xdm:type Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + +### xdm:type Known Values +| Value | Description | +|-------|-------------| +| `0` | https://ns.adobe.com/xdm/common/user | + + + diff --git a/docs/reference/datatypes/activity-type-reference-details.schema.json b/docs/reference/datatypes/activity-type-reference-details.schema.json new file mode 100644 index 000000000..30a3e9206 --- /dev/null +++ b/docs/reference/datatypes/activity-type-reference-details.schema.json @@ -0,0 +1,72 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/activity-type-reference-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Activity", + "type": "object", + "meta:auditable": true, + "description": "A form of a task or a business event which is alinged to a given activity type", + "definitions": { + "activity-type-reference-details": { + "properties": { + "xdm:name": { + "title": "Name", + "type": "string", + "description": "Name of the activity, such as 'open email','click email' etc." + }, + "xdm:description": { + "title": "Description", + "type": "string", + "description": "Detailed description of the activity name." + }, + "xdm:type": { + "title": "Type of Activity", + "type": "string", + "description": "Describing the nature of activity, in the form of a 'task' or a 'business event'." + }, + "xdm:area": { + "title": "Area of activity", + "type": "string", + "description": "Optional alingned area of the activity type, such as 'Mail' if the name is 'click email' etc." + }, + "xdm:category": { + "title": "Activity type Category", + "type": "string", + "description": "Category of the activity type. 'Marketing email', futher categorisation of activity area" + }, + "xdm:isDeleted": { + "title": "Deleted flag", + "type": "boolean", + "description": "A boolean flag to depict if the corresponding activity type has been soft deleted" + }, + "xdm:isActive": { + "title": "Status of the activity type", + "type": "boolean", + "description": "A boolean flag to depict if the activity type can be used by the business system,or has been discontinued." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/activity-type-reference-details" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:name": "Send Email", + "xdm:description": "Send Marketo Email to a person", + "xdm:type": "task", + "xdm:area": "Email", + "xdm:category": "Marketing Mail", + "xdm:isDeleted": false, + "xdm:isActive": true + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/activity-type-reference-details.schema.md b/docs/reference/datatypes/activity-type-reference-details.schema.md new file mode 100644 index 000000000..f20506ca1 --- /dev/null +++ b/docs/reference/datatypes/activity-type-reference-details.schema.md @@ -0,0 +1,176 @@ + +# XDM Activity Schema + +``` +https://ns.adobe.com/xdm/common/activity-type-reference-details +``` + +A form of a task or a business event which is alinged to a given activity type + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [datatypes/activity-type-reference-details.schema.json](datatypes/activity-type-reference-details.schema.json) | + +## XDM Activity Example +```json +{ + "xdm:name": "Send Email", + "xdm:description": "Send Marketo Email to a person", + "xdm:type": "task", + "xdm:area": "Email", + "xdm:category": "Marketing Mail", + "xdm:isDeleted": false, + "xdm:isActive": true +} +``` + +# XDM Activity Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:area](#xdmarea) | `string` | Optional | XDM Activity (this schema) | +| [xdm:category](#xdmcategory) | `string` | Optional | XDM Activity (this schema) | +| [xdm:description](#xdmdescription) | `string` | Optional | XDM Activity (this schema) | +| [xdm:isActive](#xdmisactive) | `boolean` | Optional | XDM Activity (this schema) | +| [xdm:isDeleted](#xdmisdeleted) | `boolean` | Optional | XDM Activity (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | XDM Activity (this schema) | +| [xdm:type](#xdmtype) | `string` | Optional | XDM Activity (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:area +### Area of activity + +Optional alingned area of the activity type, such as 'Mail' if the name is 'click email' etc. + +`xdm:area` +* is optional +* type: `string` +* defined in this schema + +### xdm:area Type + + +`string` + + + + + + +## xdm:category +### Activity type Category + +Category of the activity type. 'Marketing email', futher categorisation of activity area + +`xdm:category` +* is optional +* type: `string` +* defined in this schema + +### xdm:category Type + + +`string` + + + + + + +## xdm:description +### Description + +Detailed description of the activity name. + +`xdm:description` +* is optional +* type: `string` +* defined in this schema + +### xdm:description Type + + +`string` + + + + + + +## xdm:isActive +### Status of the activity type + +A boolean flag to depict if the activity type can be used by the business system,or has been discontinued. + +`xdm:isActive` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isActive Type + + +`boolean` + + + + + +## xdm:isDeleted +### Deleted flag + +A boolean flag to depict if the corresponding activity type has been soft deleted + +`xdm:isDeleted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isDeleted Type + + +`boolean` + + + + + +## xdm:name +### Name + +Name of the activity, such as 'open email','click email' etc. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:type +### Type of Activity + +Describing the nature of activity, in the form of a 'task' or a 'business event'. + +`xdm:type` +* is optional +* type: `string` +* defined in this schema + +### xdm:type Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/address.schema.json b/docs/reference/datatypes/address.schema.json new file mode 100644 index 000000000..af7e8038e --- /dev/null +++ b/docs/reference/datatypes/address.schema.json @@ -0,0 +1,125 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/address", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Postal address", + "type": "object", + "meta:auditable": true, + "meta:extends": [ + "http://schema.org/GeoCoordinates", + "https://ns.adobe.com/xdm/common/geo" + ], + "description": "A postal address. Address could relate to a person's home, work, or preferred store location.", + "definitions": { + "address": { + "properties": { + "xdm:primary": { + "title": "Primary", + "type": "boolean", + "description": "Primary address indicator. A profile can have only one `primary` address at a given point of time." + }, + "xdm:label": { + "title": "Label", + "type": "string", + "description": "Free form name of the address." + }, + "xdm:street1": { + "title": "Street 1", + "type": "string", + "description": "Primary street level information, apartment number, street number, and street name." + }, + "xdm:street2": { + "title": "Street 2", + "type": "string", + "description": "Optional street information second line." + }, + "xdm:street3": { + "title": "Street 3", + "type": "string", + "description": "Optional street information third line." + }, + "xdm:street4": { + "title": "Street 4", + "type": "string", + "description": "Optional street information fourth line." + }, + "xdm:region": { + "title": "Region", + "type": "string", + "description": "The region, county, or district portion of the address." + }, + "xdm:postOfficeBox": { + "title": "Post office box", + "type": "string", + "description": "Post office box of the address.", + "maxLength": 20 + }, + "xdm:country": { + "title": "Country", + "type": "string", + "description": "The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language." + }, + "xdm:status": { + "title": "Status", + "type": "string", + "description": "An indication as to the ability to use the address.", + "default": "active", + "meta:enum": { + "active": "Active", + "incomplete": "Incomplete", + "pending_verification": "Pending verification", + "blacklisted": "Blacklisted", + "blocked": "Blocked" + } + }, + "xdm:statusReason": { + "title": "Status reason", + "type": "string", + "description": "A description of the current status." + }, + "xdm:lastVerifiedDate": { + "title": "Last verified date", + "type": "string", + "format": "date", + "description": "The date that the address was last verified as still associated to the person." + } + } + } + }, + "allOf": [ + { + "$ref": "http://schema.org/GeoCoordinates" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/geo" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + }, + { + "$ref": "#/definitions/address" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/address.schema.md b/docs/reference/datatypes/address.schema.md new file mode 100644 index 000000000..c382a3cdf --- /dev/null +++ b/docs/reference/datatypes/address.schema.md @@ -0,0 +1,709 @@ + +# Postal address Schema + +``` +https://ns.adobe.com/xdm/common/address +``` + +A postal address. Address could relate to a person's home, work, or preferred store location. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/address.schema.json](datatypes/address.schema.json) | +## Schema Hierarchy + +* Postal address `https://ns.adobe.com/xdm/common/address` + * [Geo Coordinates](external/schema/geocoordinates.schema.md) `http://schema.org/GeoCoordinates` + * [Geo](geo.schema.md) `https://ns.adobe.com/xdm/common/geo` + * [Audit trail](auditable.schema.md) `https://ns.adobe.com/xdm/common/auditable` + + +## Postal address Example +```json +{ + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" +} +``` + +# Postal address Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [@id](#id) | `string` | Optional | | [Geo Coordinates](external/schema/geocoordinates.schema.md#id) | +| [repo:createDate](#repocreatedate) | `string` | Optional | | [Audit trail](auditable.schema.md#repocreatedate) | +| [repo:modifyDate](#repomodifydate) | `string` | Optional | | [Audit trail](auditable.schema.md#repomodifydate) | +| [schema:description](#schemadescription) | `string` | Optional | | [Geo Coordinates](external/schema/geocoordinates.schema.md#schemadescription) | +| [schema:elevation](#schemaelevation) | `number` | Optional | | [Geo Coordinates](external/schema/geocoordinates.schema.md#schemaelevation) | +| [schema:latitude](#schemalatitude) | `number` | Optional | | [Geo Coordinates](external/schema/geocoordinates.schema.md#schemalatitude) | +| [schema:longitude](#schemalongitude) | `number` | Optional | | [Geo Coordinates](external/schema/geocoordinates.schema.md#schemalongitude) | +| [xdm:city](#xdmcity) | `string` | Optional | | [Geo](geo.schema.md#xdmcity) | +| [xdm:country](#xdmcountry) | `string` | Optional | | Postal address (this schema) | +| [xdm:countryCode](#xdmcountrycode) | `string` | Optional | | [Geo](geo.schema.md#xdmcountrycode) | +| [xdm:createdByBatchID](#xdmcreatedbybatchid) | `string` | Optional | | [Audit trail](auditable.schema.md#xdmcreatedbybatchid) | +| [xdm:dmaID](#xdmdmaid) | `integer` | Optional | | [Geo](geo.schema.md#xdmdmaid) | +| [xdm:label](#xdmlabel) | `string` | Optional | | Postal address (this schema) | +| [xdm:lastVerifiedDate](#xdmlastverifieddate) | `string` | Optional | | Postal address (this schema) | +| [xdm:modifiedByBatchID](#xdmmodifiedbybatchid) | `string` | Optional | | [Audit trail](auditable.schema.md#xdmmodifiedbybatchid) | +| [xdm:msaID](#xdmmsaid) | `integer` | Optional | | [Geo](geo.schema.md#xdmmsaid) | +| [xdm:postOfficeBox](#xdmpostofficebox) | `string` | Optional | | Postal address (this schema) | +| [xdm:postalCode](#xdmpostalcode) | `string` | Optional | | [Geo](geo.schema.md#xdmpostalcode) | +| [xdm:primary](#xdmprimary) | `boolean` | Optional | | Postal address (this schema) | +| [xdm:region](#xdmregion) | `string` | Optional | | Postal address (this schema) | +| [xdm:repositoryCreatedBy](#xdmrepositorycreatedby) | `string` | Optional | | [Audit trail](auditable.schema.md#xdmrepositorycreatedby) | +| [xdm:repositoryLastModifiedBy](#xdmrepositorylastmodifiedby) | `string` | Optional | | [Audit trail](auditable.schema.md#xdmrepositorylastmodifiedby) | +| [xdm:stateProvince](#xdmstateprovince) | `string` | Optional | | [Geo](geo.schema.md#xdmstateprovince) | +| [xdm:status](#xdmstatus) | `string` | Optional | `"active"` | Postal address (this schema) | +| [xdm:statusReason](#xdmstatusreason) | `string` | Optional | | Postal address (this schema) | +| [xdm:street1](#xdmstreet1) | `string` | Optional | | Postal address (this schema) | +| [xdm:street2](#xdmstreet2) | `string` | Optional | | Postal address (this schema) | +| [xdm:street3](#xdmstreet3) | `string` | Optional | | Postal address (this schema) | +| [xdm:street4](#xdmstreet4) | `string` | Optional | | Postal address (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Coordinates ID + +The unique identifier of the coordinates. + +`@id` +* is optional +* type: `string` +* defined in [Geo Coordinates](external/schema/geocoordinates.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## repo:createDate + +The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:createDate` +* is optional +* type: `string` +* defined in [Audit trail](auditable.schema.md#repocreatedate) + +### repo:createDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:createDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## repo:modifyDate + +The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:modifyDate` +* is optional +* type: `string` +* defined in [Audit trail](auditable.schema.md#repomodifydate) + +### repo:modifyDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:modifyDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## schema:description +### Description + +A description of what the coordinates identify. + +`schema:description` +* is optional +* type: `string` +* defined in [Geo Coordinates](external/schema/geocoordinates.schema.md#schemadescription) + +### schema:description Type + + +`string` + + + + + + +## schema:elevation +### Elevation + +The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters. + +`schema:elevation` +* is optional +* type: `number` +* defined in [Geo Coordinates](external/schema/geocoordinates.schema.md#schemaelevation) + +### schema:elevation Type + + +`number` + + + + + + +## schema:latitude +### Latitude + +The signed vertical coordinate of a geographic point. + +`schema:latitude` +* is optional +* type: `number` +* defined in [Geo Coordinates](external/schema/geocoordinates.schema.md#schemalatitude) + +### schema:latitude Type + + +`number` +* minimum value: `-90` +* maximum value: `90` + + + + + +## schema:longitude +### Longitude + +The signed horizontal coordinate of a geographic point. + +`schema:longitude` +* is optional +* type: `number` +* defined in [Geo Coordinates](external/schema/geocoordinates.schema.md#schemalongitude) + +### schema:longitude Type + + +`number` +* minimum value: `-180` +* maximum value: `180` + + + + + +## xdm:city +### City + +The name of the city. + +`xdm:city` +* is optional +* type: `string` +* defined in [Geo](geo.schema.md#xdmcity) + +### xdm:city Type + + +`string` + + + + + + +## xdm:country +### Country + +The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language. + +`xdm:country` +* is optional +* type: `string` +* defined in this schema + +### xdm:country Type + + +`string` + + + + + + +## xdm:countryCode +### Country code + +The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country. + +`xdm:countryCode` +* is optional +* type: `string` +* defined in [Geo](geo.schema.md#xdmcountrycode) + +### xdm:countryCode Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E%5BA-Z%5D%7B2%7D%24)): +```regex +^[A-Z]{2}$ +``` + + + + + + +## xdm:createdByBatchID +### Created by batch identifier + +The dataset files in Catalog which has been originating the creation of the record. + +`xdm:createdByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](auditable.schema.md#xdmcreatedbybatchid) + +### xdm:createdByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:dmaID +### Designated market area + +The Nielsen media research designated market area. + +`xdm:dmaID` +* is optional +* type: `integer` +* defined in [Geo](geo.schema.md#xdmdmaid) + +### xdm:dmaID Type + + +`integer` + + + + + + +## xdm:label +### Label + +Free form name of the address. + +`xdm:label` +* is optional +* type: `string` +* defined in this schema + +### xdm:label Type + + +`string` + + + + + + +## xdm:lastVerifiedDate +### Last verified date + +The date that the address was last verified as still associated to the person. + +`xdm:lastVerifiedDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:lastVerifiedDate Type + + +`string` +* format: `date` – date, without time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:modifiedByBatchID +### Modified by batch identifier + +The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`. + +`xdm:modifiedByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](auditable.schema.md#xdmmodifiedbybatchid) + +### xdm:modifiedByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:msaID +### Metropolitan statistical area + +The metropolitan statistical area in the United States where the observation occurred. + +`xdm:msaID` +* is optional +* type: `integer` +* defined in [Geo](geo.schema.md#xdmmsaid) + +### xdm:msaID Type + + +`integer` + + + + + + +## xdm:postOfficeBox +### Post office box + +Post office box of the address. + +`xdm:postOfficeBox` +* is optional +* type: `string` +* defined in this schema + +### xdm:postOfficeBox Type + + +`string` + +* maximum length: 20 characters + + + + + +## xdm:postalCode +### Postal code + +The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code. + +`xdm:postalCode` +* is optional +* type: `string` +* defined in [Geo](geo.schema.md#xdmpostalcode) + +### xdm:postalCode Type + + +`string` + + + + + + +## xdm:primary +### Primary + +Primary address indicator. A profile can have only one `primary` address at a given point of time. + +`xdm:primary` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:primary Type + + +`boolean` + + + + + +## xdm:region +### Region + +The region, county, or district portion of the address. + +`xdm:region` +* is optional +* type: `string` +* defined in this schema + +### xdm:region Type + + +`string` + + + + + + +## xdm:repositoryCreatedBy +### Created by user identifier + +User ID of who created the record. + +`xdm:repositoryCreatedBy` +* is optional +* type: `string` +* defined in [Audit trail](auditable.schema.md#xdmrepositorycreatedby) + +### xdm:repositoryCreatedBy Type + + +`string` + + + + + + +## xdm:repositoryLastModifiedBy +### Modified by user identifier + +User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`. + +`xdm:repositoryLastModifiedBy` +* is optional +* type: `string` +* defined in [Audit trail](auditable.schema.md#xdmrepositorylastmodifiedby) + +### xdm:repositoryLastModifiedBy Type + + +`string` + + + + + + +## xdm:stateProvince +### State or province + +The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard. + +`xdm:stateProvince` +* is optional +* type: `string` +* defined in [Geo](geo.schema.md#xdmstateprovince) + +### xdm:stateProvince Type + + +`string` + + +All instances must conform to this regular expression +```regex +([A-Z]{2}-[A-Z0-9]{1,3}|) +``` + +* test example: [US-CA](https://regexr.com/?expression=(%5BA-Z%5D%7B2%7D-%5BA-Z0-9%5D%7B1%2C3%7D%7C)&text=US-CA) +* test example: [DE-BB](https://regexr.com/?expression=(%5BA-Z%5D%7B2%7D-%5BA-Z0-9%5D%7B1%2C3%7D%7C)&text=DE-BB) +* test example: [JP-13](https://regexr.com/?expression=(%5BA-Z%5D%7B2%7D-%5BA-Z0-9%5D%7B1%2C3%7D%7C)&text=JP-13) + + + + +### xdm:stateProvince Examples + +```json +"US-CA" +``` + +```json +"DE-BB" +``` + +```json +"JP-13" +``` + + + +## xdm:status +### Status + +An indication as to the ability to use the address. + +`xdm:status` +* is optional +* type: `string` +* default: `"active"` +* defined in this schema + +### xdm:status Type + + +`string` + + + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `active` | Active | +| `incomplete` | Incomplete | +| `pending_verification` | Pending verification | +| `blacklisted` | Blacklisted | +| `blocked` | Blocked | + + + + +## xdm:statusReason +### Status reason + +A description of the current status. + +`xdm:statusReason` +* is optional +* type: `string` +* defined in this schema + +### xdm:statusReason Type + + +`string` + + + + + + +## xdm:street1 +### Street 1 + +Primary street level information, apartment number, street number, and street name. + +`xdm:street1` +* is optional +* type: `string` +* defined in this schema + +### xdm:street1 Type + + +`string` + + + + + + +## xdm:street2 +### Street 2 + +Optional street information second line. + +`xdm:street2` +* is optional +* type: `string` +* defined in this schema + +### xdm:street2 Type + + +`string` + + + + + + +## xdm:street3 +### Street 3 + +Optional street information third line. + +`xdm:street3` +* is optional +* type: `string` +* defined in this schema + +### xdm:street3 Type + + +`string` + + + + + + +## xdm:street4 +### Street 4 + +Optional street information fourth line. + +`xdm:street4` +* is optional +* type: `string` +* defined in this schema + +### xdm:street4 Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/advertising-break.schema.json b/docs/reference/datatypes/advertising-break.schema.json new file mode 100644 index 000000000..9ef7dfd27 --- /dev/null +++ b/docs/reference/datatypes/advertising-break.schema.json @@ -0,0 +1,52 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/advertising-break", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Ad break", + "type": "object", + "description": "An ad break is an advertisement inserted into media content. Ad break describes how a timed advertising is inserted into a timed media.", + "meta:extensible": true, + "definitions": { + "adBreak": { + "properties": { + "@id": { + "title": "Ad Pod ID", + "format": "uri-reference", + "type": "string", + "description": "Identifier of the ad break." + }, + "dc:title": { + "title": "Pod name", + "type": "string", + "description": "The friendly name of the ad break." + }, + "xdm:offset": { + "title": "Pod position", + "type": "integer", + "description": "The offset, in seconds, of the ad break from the start of the primary content." + } + }, + "required": [ + "@id" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/adBreak" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/entities/ad-break/2394509340-30453470347", + "dc:title": "My Pod", + "xdm:offset": 3 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/advertising-break.schema.md b/docs/reference/datatypes/advertising-break.schema.md new file mode 100644 index 000000000..b53bdb9c4 --- /dev/null +++ b/docs/reference/datatypes/advertising-break.schema.md @@ -0,0 +1,91 @@ + +# Ad break Schema + +``` +https://ns.adobe.com/xdm/context/advertising-break +``` + +An ad break is an advertisement inserted into media content. Ad break describes how a timed advertising is inserted into a timed media. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/advertising-break.schema.json](datatypes/advertising-break.schema.json) | + +## Ad break Example +```json +{ + "@id": "https://data.adobe.io/entities/ad-break/2394509340-30453470347", + "dc:title": "My Pod", + "xdm:offset": 3 +} +``` + +# Ad break Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Ad break (this schema) | +| [dc:title](#dctitle) | `string` | Optional | Ad break (this schema) | +| [xdm:offset](#xdmoffset) | `integer` | Optional | Ad break (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Ad Pod ID + +Identifier of the ad break. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## dc:title +### Pod name + +The friendly name of the ad break. + +`dc:title` +* is optional +* type: `string` +* defined in this schema + +### dc:title Type + + +`string` + + + + + + +## xdm:offset +### Pod position + +The offset, in seconds, of the ad break from the start of the primary content. + +`xdm:offset` +* is optional +* type: `integer` +* defined in this schema + +### xdm:offset Type + + +`integer` + + + + + diff --git a/docs/reference/datatypes/advertising-timed-asset-reference.schema.json b/docs/reference/datatypes/advertising-timed-asset-reference.schema.json new file mode 100644 index 000000000..710227439 --- /dev/null +++ b/docs/reference/datatypes/advertising-timed-asset-reference.schema.json @@ -0,0 +1,86 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/advertising-timed-asset-reference", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Ad asset reference", + "type": "object", + "description": "Ad asset reference is info about the ad captured by the experience event.", + "meta:extensible": true, + "definitions": { + "adAssetReference": { + "properties": { + "@id": { + "title": "Ad ID", + "type": "string", + "format": "uri-reference", + "description": "Identifier of the ad asset provided by media analytics customers. Following the Ad-ID standard [https://www.ad-id.org]." + }, + "xdm:creativeID": { + "title": "Ad creative ID", + "type": "string", + "description": "The ID of the ad creative." + }, + "xdm:creativeURL": { + "title": "Ad creative URL", + "type": "string", + "description": "The URL of the ad creative." + }, + "xdm:siteID": { + "title": "Ad site ID", + "type": "string", + "description": "ID of the ad site." + }, + "xdm:placementID": { + "title": "Ad placement ID", + "type": "string", + "description": "Placement ID of the ad." + }, + "dc:title": { + "title": "Ad name", + "type": "string", + "description": "The friendly and human-readable name of the ad asset." + }, + "xdm:advertiser": { + "title": "Ad advertiser", + "type": "string", + "description": "Company/Brand whose product is featured in the ad." + }, + "xdm:campaign": { + "title": "Ad campaign", + "type": "string", + "description": "ID of the ad campaign." + }, + "xmpDM:duration": { + "title": "Ad length or duration", + "type": "integer", + "description": "Length or duration of ad asset in seconds." + } + }, + "required": [ + "@id" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/adAssetReference" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/entities/asser-reference/23423", + "xdm:creativeID": "6738737", + "dc:title": "Acme offer 21", + "xmpDM:duration": 23 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/advertising-timed-asset-reference.schema.md b/docs/reference/datatypes/advertising-timed-asset-reference.schema.md new file mode 100644 index 000000000..2cec08cda --- /dev/null +++ b/docs/reference/datatypes/advertising-timed-asset-reference.schema.md @@ -0,0 +1,223 @@ + +# Ad asset reference Schema + +``` +https://ns.adobe.com/xdm/context/advertising-timed-asset-reference +``` + +Ad asset reference is info about the ad captured by the experience event. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/advertising-timed-asset-reference.schema.json](datatypes/advertising-timed-asset-reference.schema.json) | +## Schema Hierarchy + +* Ad asset reference `https://ns.adobe.com/xdm/context/advertising-timed-asset-reference` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Ad asset reference Example +```json +{ + "@id": "https://data.adobe.io/entities/asser-reference/23423", + "xdm:creativeID": "6738737", + "dc:title": "Acme offer 21", + "xmpDM:duration": 23 +} +``` + +# Ad asset reference Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Ad asset reference (this schema) | +| [dc:title](#dctitle) | `string` | Optional | Ad asset reference (this schema) | +| [xdm:advertiser](#xdmadvertiser) | `string` | Optional | Ad asset reference (this schema) | +| [xdm:campaign](#xdmcampaign) | `string` | Optional | Ad asset reference (this schema) | +| [xdm:creativeID](#xdmcreativeid) | `string` | Optional | Ad asset reference (this schema) | +| [xdm:creativeURL](#xdmcreativeurl) | `string` | Optional | Ad asset reference (this schema) | +| [xdm:placementID](#xdmplacementid) | `string` | Optional | Ad asset reference (this schema) | +| [xdm:siteID](#xdmsiteid) | `string` | Optional | Ad asset reference (this schema) | +| [xmpDM:duration](#xmpdmduration) | `integer` | Optional | Ad asset reference (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Ad ID + +Identifier of the ad asset provided by media analytics customers. Following the Ad-ID standard [https://www.ad-id.org]. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## dc:title +### Ad name + +The friendly and human-readable name of the ad asset. + +`dc:title` +* is optional +* type: `string` +* defined in this schema + +### dc:title Type + + +`string` + + + + + + +## xdm:advertiser +### Ad advertiser + +Company/Brand whose product is featured in the ad. + +`xdm:advertiser` +* is optional +* type: `string` +* defined in this schema + +### xdm:advertiser Type + + +`string` + + + + + + +## xdm:campaign +### Ad campaign + +ID of the ad campaign. + +`xdm:campaign` +* is optional +* type: `string` +* defined in this schema + +### xdm:campaign Type + + +`string` + + + + + + +## xdm:creativeID +### Ad creative ID + +The ID of the ad creative. + +`xdm:creativeID` +* is optional +* type: `string` +* defined in this schema + +### xdm:creativeID Type + + +`string` + + + + + + +## xdm:creativeURL +### Ad creative URL + +The URL of the ad creative. + +`xdm:creativeURL` +* is optional +* type: `string` +* defined in this schema + +### xdm:creativeURL Type + + +`string` + + + + + + +## xdm:placementID +### Ad placement ID + +Placement ID of the ad. + +`xdm:placementID` +* is optional +* type: `string` +* defined in this schema + +### xdm:placementID Type + + +`string` + + + + + + +## xdm:siteID +### Ad site ID + +ID of the ad site. + +`xdm:siteID` +* is optional +* type: `string` +* defined in this schema + +### xdm:siteID Type + + +`string` + + + + + + +## xmpDM:duration +### Ad length or duration + +Length or duration of ad asset in seconds. + +`xmpDM:duration` +* is optional +* type: `integer` +* defined in this schema + +### xmpDM:duration Type + + +`integer` + + + + + diff --git a/docs/reference/datatypes/advertising-timed-asset-view-details.schema.json b/docs/reference/datatypes/advertising-timed-asset-view-details.schema.json new file mode 100644 index 000000000..4d817c1fc --- /dev/null +++ b/docs/reference/datatypes/advertising-timed-asset-view-details.schema.json @@ -0,0 +1,55 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Ad asset view details", + "type": "object", + "description": "View details for the ad playback captured by the experience event.", + "meta:extensible": true, + "definitions": { + "adAssetViewDetails": { + "properties": { + "xdm:playerName": { + "title": "Ad player name", + "type": "string", + "description": "The name of the player responsible for rendering the ad." + }, + "xdm:index": { + "title": "Ad In Pod Position", + "type": "integer", + "description": "The index of the ad inside the parent ad break, for example, the first ad has index 0 and the second ad has index 1." + }, + "xdm:adBreak": { + "title": "Ad break", + "description": "Details about how a timed advertising is inserted into a timed media.", + "$ref": "https://ns.adobe.com/xdm/context/advertising-break" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/adAssetViewDetails" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:playerName": "Acme Ad Player", + "xdm:index": 1, + "xdm:adBreak": { + "@id": "https://data.adobe.io/entities/adbreak/2394509340-30453470347", + "dc:title": "My Pod", + "xdm:offset": 3 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/advertising-timed-asset-view-details.schema.md b/docs/reference/datatypes/advertising-timed-asset-view-details.schema.md new file mode 100644 index 000000000..4d0252330 --- /dev/null +++ b/docs/reference/datatypes/advertising-timed-asset-view-details.schema.md @@ -0,0 +1,99 @@ + +# Ad asset view details Schema + +``` +https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details +``` + +View details for the ad playback captured by the experience event. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/advertising-timed-asset-view-details.schema.json](datatypes/advertising-timed-asset-view-details.schema.json) | +## Schema Hierarchy + +* Ad asset view details `https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Ad break](advertising-break.schema.md) `https://ns.adobe.com/xdm/context/advertising-break` + + +## Ad asset view details Example +```json +{ + "xdm:playerName": "Acme Ad Player", + "xdm:index": 1, + "xdm:adBreak": { + "@id": "https://data.adobe.io/entities/adbreak/2394509340-30453470347", + "dc:title": "My Pod", + "xdm:offset": 3 + } +} +``` + +# Ad asset view details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:adBreak](#xdmadbreak) | Ad break | Optional | Ad asset view details (this schema) | +| [xdm:index](#xdmindex) | `integer` | Optional | Ad asset view details (this schema) | +| [xdm:playerName](#xdmplayername) | `string` | Optional | Ad asset view details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:adBreak +### Ad break + +Details about how a timed advertising is inserted into a timed media. + +`xdm:adBreak` +* is optional +* type: Ad break +* defined in this schema + +### xdm:adBreak Type + + +* [Ad break](advertising-break.schema.md) – `https://ns.adobe.com/xdm/context/advertising-break` + + + + + +## xdm:index +### Ad In Pod Position + +The index of the ad inside the parent ad break, for example, the first ad has index 0 and the second ad has index 1. + +`xdm:index` +* is optional +* type: `integer` +* defined in this schema + +### xdm:index Type + + +`integer` + + + + + + +## xdm:playerName +### Ad player name + +The name of the player responsible for rendering the ad. + +`xdm:playerName` +* is optional +* type: `string` +* defined in this schema + +### xdm:playerName Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/advertising.schema.json b/docs/reference/datatypes/advertising.schema.json new file mode 100644 index 000000000..8c973f8ec --- /dev/null +++ b/docs/reference/datatypes/advertising.schema.json @@ -0,0 +1,130 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/advertising", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Advertising", + "type": "object", + "description": "The information related to advertising activity in relationship to the experience event.", + "meta:extensible": true, + "definitions": { + "advertising": { + "properties": { + "xdm:adViewability": { + "title": "MRC viewability", + "$ref": "https://ns.adobe.com/xdm/context/adviewability", + "description": "Media Rating Council (MRC) defines viewability as an online advertising metric that indicates the number of impressions that are actually “seen” by end-users. Viewability captures specific details such as player volume, library version, window status, and viewport ad measured dimensions." + }, + "xdm:adAssetReference": { + "title": "Ad asset reference", + "description": "Asset information about the ad captured by the experience event.", + "$ref": "https://ns.adobe.com/xdm/context/advertising-timed-asset-reference" + }, + "xdm:adAssetViewDetails": { + "title": "Ad asset view details", + "description": "View details for the ad playback captured by the experience event.", + "$ref": "https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details" + }, + "xdm:completes": { + "title": "Ad completes", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates if a timed media asset was watched to completion but doesn't necessarily mean the end-user watched the whole video as the they could have skipped ahead." + }, + "xdm:timePlayed": { + "title": "Ad time spent", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the amount of time spent by an end-user on a specific timed media asset." + }, + "xdm:federated": { + "title": "Ad federated", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates if an experience event was created through data federation such as data sharing between customers." + }, + "xdm:downloadedPlayback": { + "title": "Ad downloaded flag", + "type": "boolean", + "description": "Set to true when the hit is generated due to playing a downloaded ad session." + }, + "xdm:clicks": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Click actions on an advertisement." + }, + "xdm:conversions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A customer pre-defined action or actions which triggers an event for performance evaluation." + }, + "xdm:firstQuartiles": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A digital video ad that has played through 25% of its duration at normal speed." + }, + "xdm:impressions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Impression of an advertisement to a end-user with the potential of being viewed." + }, + "xdm:midpoints": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A digital video ad has played through 50% of its duration at normal speed." + }, + "xdm:starts": { + "title": "Ad starts", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A digital video ad has started playing." + }, + "xdm:thirdQuartiles": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A digital video ad has played through 75% of its duration at normal speed." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/advertising" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:adViewability": { + "xdm:adUnitDepth": 0, + "xdm:viewportHeight": 1250, + "xdm:viewportWidth": 1600, + "xdm:adHeight": 250, + "xdm:adWidth": 300, + "xdm:playerVolume": 85, + "xdm:measurementEligible": true, + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", + "xdm:version": "1" + }, + "xdm:viewable": true, + "xdm:activeWindow": true, + "xdm:percentViewable": 89, + "xdm:viewableFirstQuartile": { + "xdm:value": 1 + } + }, + "xdm:adAssetReference": { + "@id": "https://data.adobe.io/entities/ad-id/AD1", + "xdm:creativeID": "6738737", + "dc:title": "adNumber2", + "xdm:advertiser": "Sample advertiser", + "xdm:campaign": "Sample campaign", + "xmpDM:duration": 10, + "xdm:creativeURL": "www.creative.com", + "xdm:siteID": "www.ad-site.com", + "xdm:placementID": "www.place.org" + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/advertising.schema.md b/docs/reference/datatypes/advertising.schema.md new file mode 100644 index 000000000..4fde83171 --- /dev/null +++ b/docs/reference/datatypes/advertising.schema.md @@ -0,0 +1,340 @@ + +# Advertising Schema + +``` +https://ns.adobe.com/xdm/context/advertising +``` + +The information related to advertising activity in relationship to the experience event. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/advertising.schema.json](datatypes/advertising.schema.json) | +## Schema Hierarchy + +* Advertising `https://ns.adobe.com/xdm/context/advertising` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [MRC Viewability](adviewability.schema.md) `https://ns.adobe.com/xdm/context/adviewability` + * [Ad asset reference](advertising-timed-asset-reference.schema.md) `https://ns.adobe.com/xdm/context/advertising-timed-asset-reference` + * [Ad asset view details](advertising-timed-asset-view-details.schema.md) `https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details` + * [Measure](data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## Advertising Example +```json +{ + "xdm:adViewability": { + "xdm:adUnitDepth": 0, + "xdm:viewportHeight": 1250, + "xdm:viewportWidth": 1600, + "xdm:adHeight": 250, + "xdm:adWidth": 300, + "xdm:playerVolume": 85, + "xdm:measurementEligible": true, + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", + "xdm:version": "1" + }, + "xdm:viewable": true, + "xdm:activeWindow": true, + "xdm:percentViewable": 89, + "xdm:viewableFirstQuartile": { + "xdm:value": 1 + } + }, + "xdm:adAssetReference": { + "@id": "https://data.adobe.io/entities/ad-id/AD1", + "xdm:creativeID": "6738737", + "dc:title": "adNumber2", + "xdm:advertiser": "Sample advertiser", + "xdm:campaign": "Sample campaign", + "xmpDM:duration": 10, + "xdm:creativeURL": "www.creative.com", + "xdm:siteID": "www.ad-site.com", + "xdm:placementID": "www.place.org" + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + } +} +``` + +# Advertising Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:adAssetReference](#xdmadassetreference) | Ad asset reference | Optional | Advertising (this schema) | +| [xdm:adAssetViewDetails](#xdmadassetviewdetails) | Ad asset view details | Optional | Advertising (this schema) | +| [xdm:adViewability](#xdmadviewability) | MRC Viewability | Optional | Advertising (this schema) | +| [xdm:clicks](#xdmclicks) | Measure | Optional | Advertising (this schema) | +| [xdm:completes](#xdmcompletes) | Measure | Optional | Advertising (this schema) | +| [xdm:conversions](#xdmconversions) | Measure | Optional | Advertising (this schema) | +| [xdm:downloadedPlayback](#xdmdownloadedplayback) | `boolean` | Optional | Advertising (this schema) | +| [xdm:federated](#xdmfederated) | Measure | Optional | Advertising (this schema) | +| [xdm:firstQuartiles](#xdmfirstquartiles) | Measure | Optional | Advertising (this schema) | +| [xdm:impressions](#xdmimpressions) | Measure | Optional | Advertising (this schema) | +| [xdm:midpoints](#xdmmidpoints) | Measure | Optional | Advertising (this schema) | +| [xdm:starts](#xdmstarts) | Measure | Optional | Advertising (this schema) | +| [xdm:thirdQuartiles](#xdmthirdquartiles) | Measure | Optional | Advertising (this schema) | +| [xdm:timePlayed](#xdmtimeplayed) | Measure | Optional | Advertising (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:adAssetReference +### Ad asset reference + +Asset information about the ad captured by the experience event. + +`xdm:adAssetReference` +* is optional +* type: Ad asset reference +* defined in this schema + +### xdm:adAssetReference Type + + +* [Ad asset reference](advertising-timed-asset-reference.schema.md) – `https://ns.adobe.com/xdm/context/advertising-timed-asset-reference` + + + + + +## xdm:adAssetViewDetails +### Ad asset view details + +View details for the ad playback captured by the experience event. + +`xdm:adAssetViewDetails` +* is optional +* type: Ad asset view details +* defined in this schema + +### xdm:adAssetViewDetails Type + + +* [Ad asset view details](advertising-timed-asset-view-details.schema.md) – `https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details` + + + + + +## xdm:adViewability +### MRC viewability + +Media Rating Council (MRC) defines viewability as an online advertising metric that indicates the number of impressions that are actually “seen” by end-users. Viewability captures specific details such as player volume, library version, window status, and viewport ad measured dimensions. + +`xdm:adViewability` +* is optional +* type: MRC Viewability +* defined in this schema + +### xdm:adViewability Type + + +* [MRC Viewability](adviewability.schema.md) – `https://ns.adobe.com/xdm/context/adviewability` + + + + + +## xdm:clicks + +Click actions on an advertisement. + +`xdm:clicks` +* is optional +* type: Measure +* defined in this schema + +### xdm:clicks Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:completes +### Ad completes + +Indicates if a timed media asset was watched to completion but doesn't necessarily mean the end-user watched the whole video as the they could have skipped ahead. + +`xdm:completes` +* is optional +* type: Measure +* defined in this schema + +### xdm:completes Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:conversions + +A customer pre-defined action or actions which triggers an event for performance evaluation. + +`xdm:conversions` +* is optional +* type: Measure +* defined in this schema + +### xdm:conversions Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:downloadedPlayback +### Ad downloaded flag + +Set to true when the hit is generated due to playing a downloaded ad session. + +`xdm:downloadedPlayback` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:downloadedPlayback Type + + +`boolean` + + + + + +## xdm:federated +### Ad federated + +Indicates if an experience event was created through data federation such as data sharing between customers. + +`xdm:federated` +* is optional +* type: Measure +* defined in this schema + +### xdm:federated Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:firstQuartiles + +A digital video ad that has played through 25% of its duration at normal speed. + +`xdm:firstQuartiles` +* is optional +* type: Measure +* defined in this schema + +### xdm:firstQuartiles Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:impressions + +Impression of an advertisement to a end-user with the potential of being viewed. + +`xdm:impressions` +* is optional +* type: Measure +* defined in this schema + +### xdm:impressions Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:midpoints + +A digital video ad has played through 50% of its duration at normal speed. + +`xdm:midpoints` +* is optional +* type: Measure +* defined in this schema + +### xdm:midpoints Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:starts +### Ad starts + +A digital video ad has started playing. + +`xdm:starts` +* is optional +* type: Measure +* defined in this schema + +### xdm:starts Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:thirdQuartiles + +A digital video ad has played through 75% of its duration at normal speed. + +`xdm:thirdQuartiles` +* is optional +* type: Measure +* defined in this schema + +### xdm:thirdQuartiles Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:timePlayed +### Ad time spent + +Describes the amount of time spent by an end-user on a specific timed media asset. + +`xdm:timePlayed` +* is optional +* type: Measure +* defined in this schema + +### xdm:timePlayed Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + diff --git a/docs/reference/datatypes/adviewability.schema.json b/docs/reference/datatypes/adviewability.schema.json new file mode 100644 index 000000000..d483eab6f --- /dev/null +++ b/docs/reference/datatypes/adviewability.schema.json @@ -0,0 +1,158 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/adviewability", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "MRC Viewability", + "type": "object", + "meta:extensible": true, + "description": "Browser environment measured at runtime describing the viewability of an advertisement or content associated with each page load.\n\nAccording to [IAB/MRC definition](https://www.iab.com/wp-content/uploads/2015/06/MRC-Viewable-Ad-Impression-Measurement-Guideline.pdf) of Viewable Browser Space is defined as: \n\n> Advertisements and content associated with each\npage load can appear either within or outside the viewable space of the browser\non a user’s screen—i.e., that part of the page within the browser that a user can\nsee. This is similar to the concepts once referred to as “Above the Fold” (i.e.,\nwithin the viewable browser space) and “Below the Fold” (i.e., outside the\nviewable browser space). The “fold” was traditionally considered to be where the\ninitially-loaded viewable space of the page ends – so advertisements and content\nabove the fold were considered likely to be viewable upon load, and for content\nbelow the fold, it was considered necessary to scroll to in order for that content to\nbe viewable. In reality, the location of the fold, and consequently the viewable\nstatus of advertising and content, is variable based on the browser settings of the\nuser (resolution, font size, window size, etc.) and there are generally four\nlocations (top, bottom, left and right sides) where advertising and content may be\ncut-off from being viewable based on user actions and settings. Upon initial page\nload, advertising or content placed at the top and left side of the page is most \nlikely to be viewable, however this can change if content or ads are obscured by\noverlays or with further user action (scrolling) coupled with latency; therefore,\nplacement and viewable status are separate attributes to be assessed.\n\nViewability details are always measured fields during runtime.\n\n>Note regarding the applicability of these guidelines for mobile viewable ad\n impression measurement: While these viewability guidelines are primarily\n designed for desktop browser-based advertising rather than mobile advertising,\n the following points should be noted: 1) measurers of viewability of mobile\n browser-based web ads are encouraged to consider these guidelines in\n measurements until such time as guidance specifically designed for the\n measurement of viewability in mobile web based ads is created; and 2) as noted\n in the [Mobile Application Advertising Measurement Guidelines issued by IAB,\n MMA and MRC in July 2013](http://www.iab.net/inappguidelines), ad impressions\n served in an in-application environment are currently generally assumed to be\n viewable.\n\n\n\n", + "definitions": { + "adviewability": { + "properties": { + "xdm:adUnitDepth": { + "title": "Ad Unit Depth", + "type": "integer", + "description": "Publishers may embed ad units inside containers/iFrames in order limit the ad's access solely to the code of the page. This describes how many 'containers' or iFrames the ad unit is displayed inside of.", + "minimum": 0 + }, + "xdm:viewportHeight": { + "title": "Viewport Height", + "type": "integer", + "description": "The vertical size (in pixels) of the window the experience was displayed inside measured at runtime. For a web view event, the browser viewport height.", + "minimum": 0 + }, + "xdm:viewportWidth": { + "title": "Viewport Width", + "type": "integer", + "description": "The horizontal size (in pixels) of the window the experience was displayed inside measured at runtime. For a web view event, the browser viewport width.", + "minimum": 0 + }, + "xdm:adHeight": { + "title": "Ad Height", + "type": "integer", + "description": "The number of vertical pixels of the player, measured at runtime. This can be larger than the size of the ad if the player has extra controls or thumbnails.", + "minimum": 0 + }, + "xdm:adWidth": { + "title": "Ad Width", + "type": "integer", + "description": "The number of horizontal pixels of the player, measured at runtime. This can be larger than the size of the ad if the player has extra controls or thumbnails.", + "minimum": 0 + }, + "xdm:playerVolume": { + "title": "Player Volume Percentage", + "type": "integer", + "description": "The player volume percentage, measured at runtime where 0 is muted and 100 is maximum volume.", + "minimum": 0, + "maximum": 100 + }, + "xdm:measurementEligible": { + "title": "Viewability Measurement Eligible", + "type": "boolean", + "description": "Whether or not the ad was eligible to viewability measurement. An ad is eligible if the unit has a supported creative format and tag type." + }, + "xdm:implementationDetails": { + "title": "Viewabiltity Implementation Details", + "$ref": "https://ns.adobe.com/xdm/context/implementationdetails", + "description": "The name and version of the library instrumented to measure viewability metrics." + }, + "xdm:viewable": { + "title": "Viewable Ad", + "type": "boolean", + "description": "Display ads are considered viewable when at least 50% of the ad is visible for at least 1 second. Video ads are considered viewable when at least 50% of the ad is visible while the video is playing for at least 2 consecutive seconds. All viewable ads are measurable, because you can't confirm that an ad has met the criteria for viewability unless it can be measured." + }, + "xdm:activeWindow": { + "title": "Active Window", + "type": "boolean", + "description": "Indicates whether ad was shown on active window on users' device." + }, + "xdm:percentViewable": { + "title": "Percent Viewable", + "type": "integer", + "description": "Percent of pixels in the ad deemed viewable at measurement time.", + "minimum": 0, + "maximum": 100 + }, + "xdm:viewabilityEligibleImpressions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Impression(s) of an advertisement to an end-user with viewablility library instrumented." + }, + "xdm:measuredAdNotVisible": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicator of ad not being visible as measured by a viewability library at impression time." + }, + "xdm:measuredMuted": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicator of ad being muted as measured by a viewability library at impression time." + }, + "xdm:measuredWindowInactive": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicator of ad being displayed in an inactive window as measured by a viewability library at impression time." + }, + "xdm:unmeasurableIframe": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicator of viewability library not being able to properly execute measurements due to ad being displayed inside an iframe." + }, + "xdm:unmeasurableOther": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicator of viewability library not being able to properly execute measurements due to non-predefined error." + }, + "xdm:viewableCompletes": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Completion(s) of an advertisement to an end-user deemed viewable at completion time by a viewability library." + }, + "xdm:viewableFirstQuartiles": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "First quartile(s) of an advertisement to an end-user deemed viewable at first quartile of play by a viewability library." + }, + "xdm:viewableImpressions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Impressions of an advertisement to an end-user deemed viewable after two seconds of play by a viewability library." + }, + "xdm:viewableMidpoints": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Midpoint(s) of an advertisement to an end-user deemed viewable at midpoint of play by a viewability library." + }, + "xdm:viewableThirdQuartiles": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Third quartile(s) of an advertisement to an end-user deemed viewable at third quartile of play by a viewability library." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/adviewability" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:adUnitDepth": 0, + "xdm:viewportHeight": 1250, + "xdm:viewportWidth": 1600, + "xdm:adHeight": 250, + "xdm:adWidth": 300, + "xdm:playerVolume": 85, + "xdm:measurementEligible": true, + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", + "xdm:version": "1" + }, + "xdm:viewable": true, + "xdm:activeWindow": true, + "xdm:percentViewable": 89, + "xdm:viewableImpressions": { + "xdm:value": 1 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/adviewability.schema.md b/docs/reference/datatypes/adviewability.schema.md new file mode 100644 index 000000000..653d9ae8e --- /dev/null +++ b/docs/reference/datatypes/adviewability.schema.md @@ -0,0 +1,530 @@ + +# MRC Viewability Schema + +``` +https://ns.adobe.com/xdm/context/adviewability +``` + +Browser environment measured at runtime describing the viewability of an advertisement or content associated with each page load. + +According to [IAB/MRC definition](https://www.iab.com/wp-content/uploads/2015/06/MRC-Viewable-Ad-Impression-Measurement-Guideline.pdf) of Viewable Browser Space is defined as: + +> Advertisements and content associated with each +page load can appear either within or outside the viewable space of the browser +on a user’s screen—i.e., that part of the page within the browser that a user can +see. This is similar to the concepts once referred to as “Above the Fold” (i.e., +within the viewable browser space) and “Below the Fold” (i.e., outside the +viewable browser space). The “fold” was traditionally considered to be where the +initially-loaded viewable space of the page ends – so advertisements and content +above the fold were considered likely to be viewable upon load, and for content +below the fold, it was considered necessary to scroll to in order for that content to +be viewable. In reality, the location of the fold, and consequently the viewable +status of advertising and content, is variable based on the browser settings of the +user (resolution, font size, window size, etc.) and there are generally four +locations (top, bottom, left and right sides) where advertising and content may be +cut-off from being viewable based on user actions and settings. Upon initial page +load, advertising or content placed at the top and left side of the page is most +likely to be viewable, however this can change if content or ads are obscured by +overlays or with further user action (scrolling) coupled with latency; therefore, +placement and viewable status are separate attributes to be assessed. + +Viewability details are always measured fields during runtime. + +>Note regarding the applicability of these guidelines for mobile viewable ad + impression measurement: While these viewability guidelines are primarily + designed for desktop browser-based advertising rather than mobile advertising, + the following points should be noted: 1) measurers of viewability of mobile + browser-based web ads are encouraged to consider these guidelines in + measurements until such time as guidance specifically designed for the + measurement of viewability in mobile web based ads is created; and 2) as noted + in the [Mobile Application Advertising Measurement Guidelines issued by IAB, + MMA and MRC in July 2013](http://www.iab.net/inappguidelines), ad impressions + served in an in-application environment are currently generally assumed to be + viewable. + + + + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/adviewability.schema.json](datatypes/adviewability.schema.json) | +## Schema Hierarchy + +* MRC Viewability `https://ns.adobe.com/xdm/context/adviewability` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Implementation details](implementationdetails.schema.md) `https://ns.adobe.com/xdm/context/implementationdetails` + * [Measure](data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## MRC Viewability Example +```json +{ + "xdm:adUnitDepth": 0, + "xdm:viewportHeight": 1250, + "xdm:viewportWidth": 1600, + "xdm:adHeight": 250, + "xdm:adWidth": 300, + "xdm:playerVolume": 85, + "xdm:measurementEligible": true, + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", + "xdm:version": "1" + }, + "xdm:viewable": true, + "xdm:activeWindow": true, + "xdm:percentViewable": 89, + "xdm:viewableImpressions": { + "xdm:value": 1 + } +} +``` + +# MRC Viewability Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:activeWindow](#xdmactivewindow) | `boolean` | Optional | MRC Viewability (this schema) | +| [xdm:adHeight](#xdmadheight) | `integer` | Optional | MRC Viewability (this schema) | +| [xdm:adUnitDepth](#xdmadunitdepth) | `integer` | Optional | MRC Viewability (this schema) | +| [xdm:adWidth](#xdmadwidth) | `integer` | Optional | MRC Viewability (this schema) | +| [xdm:implementationDetails](#xdmimplementationdetails) | Implementation details | Optional | MRC Viewability (this schema) | +| [xdm:measuredAdNotVisible](#xdmmeasuredadnotvisible) | Measure | Optional | MRC Viewability (this schema) | +| [xdm:measuredMuted](#xdmmeasuredmuted) | Measure | Optional | MRC Viewability (this schema) | +| [xdm:measuredWindowInactive](#xdmmeasuredwindowinactive) | Measure | Optional | MRC Viewability (this schema) | +| [xdm:measurementEligible](#xdmmeasurementeligible) | `boolean` | Optional | MRC Viewability (this schema) | +| [xdm:percentViewable](#xdmpercentviewable) | `integer` | Optional | MRC Viewability (this schema) | +| [xdm:playerVolume](#xdmplayervolume) | `integer` | Optional | MRC Viewability (this schema) | +| [xdm:unmeasurableIframe](#xdmunmeasurableiframe) | Measure | Optional | MRC Viewability (this schema) | +| [xdm:unmeasurableOther](#xdmunmeasurableother) | Measure | Optional | MRC Viewability (this schema) | +| [xdm:viewabilityEligibleImpressions](#xdmviewabilityeligibleimpressions) | Measure | Optional | MRC Viewability (this schema) | +| [xdm:viewable](#xdmviewable) | `boolean` | Optional | MRC Viewability (this schema) | +| [xdm:viewableCompletes](#xdmviewablecompletes) | Measure | Optional | MRC Viewability (this schema) | +| [xdm:viewableFirstQuartiles](#xdmviewablefirstquartiles) | Measure | Optional | MRC Viewability (this schema) | +| [xdm:viewableImpressions](#xdmviewableimpressions) | Measure | Optional | MRC Viewability (this schema) | +| [xdm:viewableMidpoints](#xdmviewablemidpoints) | Measure | Optional | MRC Viewability (this schema) | +| [xdm:viewableThirdQuartiles](#xdmviewablethirdquartiles) | Measure | Optional | MRC Viewability (this schema) | +| [xdm:viewportHeight](#xdmviewportheight) | `integer` | Optional | MRC Viewability (this schema) | +| [xdm:viewportWidth](#xdmviewportwidth) | `integer` | Optional | MRC Viewability (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:activeWindow +### Active Window + +Indicates whether ad was shown on active window on users' device. + +`xdm:activeWindow` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:activeWindow Type + + +`boolean` + + + + + +## xdm:adHeight +### Ad Height + +The number of vertical pixels of the player, measured at runtime. This can be larger than the size of the ad if the player has extra controls or thumbnails. + +`xdm:adHeight` +* is optional +* type: `integer` +* defined in this schema + +### xdm:adHeight Type + + +`integer` +* minimum value: `0` + + + + + + +## xdm:adUnitDepth +### Ad Unit Depth + +Publishers may embed ad units inside containers/iFrames in order limit the ad's access solely to the code of the page. This describes how many 'containers' or iFrames the ad unit is displayed inside of. + +`xdm:adUnitDepth` +* is optional +* type: `integer` +* defined in this schema + +### xdm:adUnitDepth Type + + +`integer` +* minimum value: `0` + + + + + + +## xdm:adWidth +### Ad Width + +The number of horizontal pixels of the player, measured at runtime. This can be larger than the size of the ad if the player has extra controls or thumbnails. + +`xdm:adWidth` +* is optional +* type: `integer` +* defined in this schema + +### xdm:adWidth Type + + +`integer` +* minimum value: `0` + + + + + + +## xdm:implementationDetails +### Viewabiltity Implementation Details + +The name and version of the library instrumented to measure viewability metrics. + +`xdm:implementationDetails` +* is optional +* type: Implementation details +* defined in this schema + +### xdm:implementationDetails Type + + +* [Implementation details](implementationdetails.schema.md) – `https://ns.adobe.com/xdm/context/implementationdetails` + + + + + +## xdm:measuredAdNotVisible + +Indicator of ad not being visible as measured by a viewability library at impression time. + +`xdm:measuredAdNotVisible` +* is optional +* type: Measure +* defined in this schema + +### xdm:measuredAdNotVisible Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:measuredMuted + +Indicator of ad being muted as measured by a viewability library at impression time. + +`xdm:measuredMuted` +* is optional +* type: Measure +* defined in this schema + +### xdm:measuredMuted Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:measuredWindowInactive + +Indicator of ad being displayed in an inactive window as measured by a viewability library at impression time. + +`xdm:measuredWindowInactive` +* is optional +* type: Measure +* defined in this schema + +### xdm:measuredWindowInactive Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:measurementEligible +### Viewability Measurement Eligible + +Whether or not the ad was eligible to viewability measurement. An ad is eligible if the unit has a supported creative format and tag type. + +`xdm:measurementEligible` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:measurementEligible Type + + +`boolean` + + + + + +## xdm:percentViewable +### Percent Viewable + +Percent of pixels in the ad deemed viewable at measurement time. + +`xdm:percentViewable` +* is optional +* type: `integer` +* defined in this schema + +### xdm:percentViewable Type + + +`integer` +* minimum value: `0` +* maximum value: `100` + + + + + +## xdm:playerVolume +### Player Volume Percentage + +The player volume percentage, measured at runtime where 0 is muted and 100 is maximum volume. + +`xdm:playerVolume` +* is optional +* type: `integer` +* defined in this schema + +### xdm:playerVolume Type + + +`integer` +* minimum value: `0` +* maximum value: `100` + + + + + +## xdm:unmeasurableIframe + +Indicator of viewability library not being able to properly execute measurements due to ad being displayed inside an iframe. + +`xdm:unmeasurableIframe` +* is optional +* type: Measure +* defined in this schema + +### xdm:unmeasurableIframe Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:unmeasurableOther + +Indicator of viewability library not being able to properly execute measurements due to non-predefined error. + +`xdm:unmeasurableOther` +* is optional +* type: Measure +* defined in this schema + +### xdm:unmeasurableOther Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:viewabilityEligibleImpressions + +Impression(s) of an advertisement to an end-user with viewablility library instrumented. + +`xdm:viewabilityEligibleImpressions` +* is optional +* type: Measure +* defined in this schema + +### xdm:viewabilityEligibleImpressions Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:viewable +### Viewable Ad + +Display ads are considered viewable when at least 50% of the ad is visible for at least 1 second. Video ads are considered viewable when at least 50% of the ad is visible while the video is playing for at least 2 consecutive seconds. All viewable ads are measurable, because you can't confirm that an ad has met the criteria for viewability unless it can be measured. + +`xdm:viewable` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:viewable Type + + +`boolean` + + + + + +## xdm:viewableCompletes + +Completion(s) of an advertisement to an end-user deemed viewable at completion time by a viewability library. + +`xdm:viewableCompletes` +* is optional +* type: Measure +* defined in this schema + +### xdm:viewableCompletes Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:viewableFirstQuartiles + +First quartile(s) of an advertisement to an end-user deemed viewable at first quartile of play by a viewability library. + +`xdm:viewableFirstQuartiles` +* is optional +* type: Measure +* defined in this schema + +### xdm:viewableFirstQuartiles Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:viewableImpressions + +Impressions of an advertisement to an end-user deemed viewable after two seconds of play by a viewability library. + +`xdm:viewableImpressions` +* is optional +* type: Measure +* defined in this schema + +### xdm:viewableImpressions Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:viewableMidpoints + +Midpoint(s) of an advertisement to an end-user deemed viewable at midpoint of play by a viewability library. + +`xdm:viewableMidpoints` +* is optional +* type: Measure +* defined in this schema + +### xdm:viewableMidpoints Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:viewableThirdQuartiles + +Third quartile(s) of an advertisement to an end-user deemed viewable at third quartile of play by a viewability library. + +`xdm:viewableThirdQuartiles` +* is optional +* type: Measure +* defined in this schema + +### xdm:viewableThirdQuartiles Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:viewportHeight +### Viewport Height + +The vertical size (in pixels) of the window the experience was displayed inside measured at runtime. For a web view event, the browser viewport height. + +`xdm:viewportHeight` +* is optional +* type: `integer` +* defined in this schema + +### xdm:viewportHeight Type + + +`integer` +* minimum value: `0` + + + + + + +## xdm:viewportWidth +### Viewport Width + +The horizontal size (in pixels) of the window the experience was displayed inside measured at runtime. For a web view event, the browser viewport width. + +`xdm:viewportWidth` +* is optional +* type: `integer` +* defined in this schema + +### xdm:viewportWidth Type + + +`integer` +* minimum value: `0` + + + + + diff --git a/docs/reference/datatypes/application.schema.json b/docs/reference/datatypes/application.schema.json new file mode 100644 index 000000000..7dfacb7df --- /dev/null +++ b/docs/reference/datatypes/application.schema.json @@ -0,0 +1,102 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/application", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Application", + "type": "object", + "description": "Details related to the application generated interactions. Application refers to a software experience, such as a mobile or desktop application that can be installed, run, closed, or uninstalled by an end user. Details are not intended to describe agents such as chatbots, browser-based plugins, or other experiences that do not apply to applications.", + "meta:extensible": true, + "definitions": { + "application": { + "properties": { + "xdm:id": { + "title": "Application identifier", + "type": "string", + "description": "Identifier of the application." + }, + "xdm:name": { + "title": "Name", + "type": "string", + "description": "Name of the application." + }, + "xdm:version": { + "title": "Version", + "type": "string", + "description": "Version of the application." + }, + "xdm:applicationCloses": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Graceful termination of an application." + }, + "xdm:crashes": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Triggered when the application does not exit gracefully. Event is sent on application launch after a crash." + }, + "xdm:featureUsages": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Activation of an application feature that is being measured." + }, + "xdm:installs": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Install of an application on a device where the specific install event is available." + }, + "xdm:firstLaunches": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Triggered on first launch after install." + }, + "xdm:launches": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Launch of an application. Triggered on every run, including crashes and installs. Also triggered on a resume from background when the session timeout has been exceeded." + }, + "xdm:upgrades": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Upgrade of an application that has previously been installed. Triggered on first launch after upgrade." + }, + "xdm:userPerspective": { + "type": "string", + "description": "The perspective/physical relationship between the user and the app/brand at the time the event happened. The most common are the app being in the foreground with the user directly interacting with it vs the app being in the background and still generating events. Detached means the event was related to the app but didn't come directly from the app like the sending of an email or push notification from an external system. Understanding the perspective of the user in relation to the app helps with accuratly generating sessions as the majority of the time you will not want to include background and detached events as part of an active session.", + "enum": [ + "foreground", + "background", + "detached" + ], + "meta:enum": { + "foreground": "Foreground", + "background": "Background", + "detached": "Detached" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/application" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:id": "A123", + "xdm:name": "Myapp", + "xdm:version": "1.0.1", + "xdm:launches": { + "xdm:value": 1 + }, + "xdm:userPerspective": "foreground" + }, + { + "xdm:id": "A123", + "xdm:name": "Myapp", + "xdm:version": "1.0.1" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/application.schema.md b/docs/reference/datatypes/application.schema.md new file mode 100644 index 000000000..cf4d8752b --- /dev/null +++ b/docs/reference/datatypes/application.schema.md @@ -0,0 +1,265 @@ + +# Application Schema + +``` +https://ns.adobe.com/xdm/context/application +``` + +Details related to the application generated interactions. Application refers to a software experience, such as a mobile or desktop application that can be installed, run, closed, or uninstalled by an end user. Details are not intended to describe agents such as chatbots, browser-based plugins, or other experiences that do not apply to applications. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/application.schema.json](datatypes/application.schema.json) | +## Schema Hierarchy + +* Application `https://ns.adobe.com/xdm/context/application` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Measure](data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## Application Examples + +```json +{ + "xdm:id": "A123", + "xdm:name": "Myapp", + "xdm:version": "1.0.1", + "xdm:launches": { + "xdm:value": 1 + }, + "xdm:userPerspective": "foreground" +} +``` + +```json +{ + "xdm:id": "A123", + "xdm:name": "Myapp", + "xdm:version": "1.0.1" +} +``` + + +# Application Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:applicationCloses](#xdmapplicationcloses) | Measure | Optional | Application (this schema) | +| [xdm:crashes](#xdmcrashes) | Measure | Optional | Application (this schema) | +| [xdm:featureUsages](#xdmfeatureusages) | Measure | Optional | Application (this schema) | +| [xdm:firstLaunches](#xdmfirstlaunches) | Measure | Optional | Application (this schema) | +| [xdm:id](#xdmid) | `string` | Optional | Application (this schema) | +| [xdm:installs](#xdminstalls) | Measure | Optional | Application (this schema) | +| [xdm:launches](#xdmlaunches) | Measure | Optional | Application (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | Application (this schema) | +| [xdm:upgrades](#xdmupgrades) | Measure | Optional | Application (this schema) | +| [xdm:userPerspective](#xdmuserperspective) | `enum` | Optional | Application (this schema) | +| [xdm:version](#xdmversion) | `string` | Optional | Application (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:applicationCloses + +Graceful termination of an application. + +`xdm:applicationCloses` +* is optional +* type: Measure +* defined in this schema + +### xdm:applicationCloses Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:crashes + +Triggered when the application does not exit gracefully. Event is sent on application launch after a crash. + +`xdm:crashes` +* is optional +* type: Measure +* defined in this schema + +### xdm:crashes Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:featureUsages + +Activation of an application feature that is being measured. + +`xdm:featureUsages` +* is optional +* type: Measure +* defined in this schema + +### xdm:featureUsages Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:firstLaunches + +Triggered on first launch after install. + +`xdm:firstLaunches` +* is optional +* type: Measure +* defined in this schema + +### xdm:firstLaunches Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:id +### Application identifier + +Identifier of the application. + +`xdm:id` +* is optional +* type: `string` +* defined in this schema + +### xdm:id Type + + +`string` + + + + + + +## xdm:installs + +Install of an application on a device where the specific install event is available. + +`xdm:installs` +* is optional +* type: Measure +* defined in this schema + +### xdm:installs Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:launches + +Launch of an application. Triggered on every run, including crashes and installs. Also triggered on a resume from background when the session timeout has been exceeded. + +`xdm:launches` +* is optional +* type: Measure +* defined in this schema + +### xdm:launches Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:name +### Name + +Name of the application. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:upgrades + +Upgrade of an application that has previously been installed. Triggered on first launch after upgrade. + +`xdm:upgrades` +* is optional +* type: Measure +* defined in this schema + +### xdm:upgrades Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:userPerspective + +The perspective/physical relationship between the user and the app/brand at the time the event happened. The most common are the app being in the foreground with the user directly interacting with it vs the app being in the background and still generating events. Detached means the event was related to the app but didn't come directly from the app like the sending of an email or push notification from an external system. Understanding the perspective of the user in relation to the app helps with accuratly generating sessions as the majority of the time you will not want to include background and detached events as part of an active session. + +`xdm:userPerspective` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmuserperspective-known-values). + +### xdm:userPerspective Known Values +| Value | Description | +|-------|-------------| +| `foreground` | Foreground | +| `background` | Background | +| `detached` | Detached | + + + + +## xdm:version +### Version + +Version of the application. + +`xdm:version` +* is optional +* type: `string` +* defined in this schema + +### xdm:version Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/auditable.schema.json b/docs/reference/datatypes/auditable.schema.json new file mode 100644 index 000000000..e7d019a98 --- /dev/null +++ b/docs/reference/datatypes/auditable.schema.json @@ -0,0 +1,61 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/auditable", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Audit trail", + "type": "object", + "meta:abstract": true, + "description": "The audit trail schema indicates a data record is auditable. For example, who and when the record was last modified.", + "definitions": { + "auditlog": { + "properties": { + "xdm:repositoryCreatedBy": { + "title": "Created by user identifier", + "type": "string", + "description": "User ID of who created the record." + }, + "xdm:repositoryLastModifiedBy": { + "title": "Modified by user identifier", + "type": "string", + "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`." + }, + "xdm:createdByBatchID": { + "title": "Created by batch identifier", + "type": "string", + "format": "uri-reference", + "description": "The dataset files in Catalog which has been originating the creation of the record." + }, + "xdm:modifiedByBatchID": { + "title": "Modified by batch identifier", + "type": "string", + "format": "uri-reference", + "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/auditlog" + }, + { + "$ref": "http://ns.adobe.com/adobecloud/core/1.0#/definitions/date-properties" + } + ], + "meta:status": "stable", + "examples": [ + { + "repo:createDate": "2018-01-12T15:52:25+00:00", + "repo:modifyDate": "2018-01-12T15:52:25+00:00", + "xdm:repositoryCreatedBy": "jsmith", + "xdm:repositoryLastModifiedBy": "jsmith", + "xdm:createdByBatchID": "https://data.adobe.io/batchid-123", + "xdm:modifiedByBatchID": "https://data.adobe.io/batchid-456" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/auditable.schema.md b/docs/reference/datatypes/auditable.schema.md new file mode 100644 index 000000000..d7bbe3107 --- /dev/null +++ b/docs/reference/datatypes/auditable.schema.md @@ -0,0 +1,173 @@ + +# Audit trail Schema + +``` +https://ns.adobe.com/xdm/common/auditable +``` + +The audit trail schema indicates a data record is auditable. For example, who and when the record was last modified. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/auditable.schema.json](datatypes/auditable.schema.json) | +## Schema Hierarchy + +* Audit trail `https://ns.adobe.com/xdm/common/auditable` + * [Common Properties](external/repo/common.schema.md) `http://ns.adobe.com/adobecloud/core/1.0` + + +## Audit trail Example +```json +{ + "repo:createDate": "2018-01-12T15:52:25+00:00", + "repo:modifyDate": "2018-01-12T15:52:25+00:00", + "xdm:repositoryCreatedBy": "jsmith", + "xdm:repositoryLastModifiedBy": "jsmith", + "xdm:createdByBatchID": "https://data.adobe.io/batchid-123", + "xdm:modifiedByBatchID": "https://data.adobe.io/batchid-456" +} +``` + +# Audit trail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [repo:createDate](#repocreatedate) | `string` | Optional | [Common Properties](external/repo/common.schema.md#repocreatedate) | +| [repo:modifyDate](#repomodifydate) | `string` | Optional | [Common Properties](external/repo/common.schema.md#repomodifydate) | +| [xdm:createdByBatchID](#xdmcreatedbybatchid) | `string` | Optional | Audit trail (this schema) | +| [xdm:modifiedByBatchID](#xdmmodifiedbybatchid) | `string` | Optional | Audit trail (this schema) | +| [xdm:repositoryCreatedBy](#xdmrepositorycreatedby) | `string` | Optional | Audit trail (this schema) | +| [xdm:repositoryLastModifiedBy](#xdmrepositorylastmodifiedby) | `string` | Optional | Audit trail (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## repo:createDate + +The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:createDate` +* is optional +* type: `string` +* defined in [Common Properties](external/repo/common.schema.md#repocreatedate) + +### repo:createDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:createDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## repo:modifyDate + +The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:modifyDate` +* is optional +* type: `string` +* defined in [Common Properties](external/repo/common.schema.md#repomodifydate) + +### repo:modifyDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:modifyDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## xdm:createdByBatchID +### Created by batch identifier + +The dataset files in Catalog which has been originating the creation of the record. + +`xdm:createdByBatchID` +* is optional +* type: `string` +* defined in this schema + +### xdm:createdByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:modifiedByBatchID +### Modified by batch identifier + +The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`. + +`xdm:modifiedByBatchID` +* is optional +* type: `string` +* defined in this schema + +### xdm:modifiedByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:repositoryCreatedBy +### Created by user identifier + +User ID of who created the record. + +`xdm:repositoryCreatedBy` +* is optional +* type: `string` +* defined in this schema + +### xdm:repositoryCreatedBy Type + + +`string` + + + + + + +## xdm:repositoryLastModifiedBy +### Modified by user identifier + +User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`. + +`xdm:repositoryLastModifiedBy` +* is optional +* type: `string` +* defined in this schema + +### xdm:repositoryLastModifiedBy Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/b2b-contact.schema.json b/docs/reference/datatypes/b2b-contact.schema.json new file mode 100644 index 000000000..40ce1ffbc --- /dev/null +++ b/docs/reference/datatypes/b2b-contact.schema.json @@ -0,0 +1,104 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/b2b-contact", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "B2B Contact", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "This Data Type is used to capture B2B Contact specific attributes.", + "definitions": { + "b2b-contact": { + "properties": { + "xdm:ID": { + "title": "Contact Record Id", + "description": "Unique record id of the contact in the source system.", + "type": "string" + }, + "xdm:accountID": { + "title": "Contact Account id", + "description": "ID of the account that’s the parent of this contact.", + "type": "string" + }, + "xdm:leadSource": { + "title": "Lead Source", + "description": "Field recording what source the lead originated from.", + "type": "string" + }, + "xdm:extendedContact": { + "title": "Contact Extended Properties", + "description": "Holds additional properties for a person to be recognized as a contact in the business-to-business space.", + "$ref": "https://ns.adobe.com/xdm/common/contact-lead" + }, + "xdm:preferences": { + "title": "Contact Preferences", + "description": "Holds opt out values for different channels as selected by the contact.", + "$ref": "https://ns.adobe.com/xdm/context/optinout" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/b2b-contact" + } + ], + "required": [ + "xdm:ID", + "xdm:accountID" + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:ID": "11110000", + "xdm:accountID": "", + "xdm:leadSource": "Lead Source", + "xdm:extendedContact": { + "xdm:type": "", + "xdm:ownerID": "", + "xdm:isDeleted": false, + "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00", + "xdm:emailBouncedReason": "Bounced Reason Here", + "xdm:isEmailBounced": true, + "xdm:description": "Contact/Lead description here", + "xdm:status": "Status", + "xdm:timezone": "", + "xdm:jigsaw": "12345" + }, + "xdm:identityMap": { + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:preferences": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false, + "xdm:optOutDetails": { + "xdm:email": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:phone": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/b2b-contact.schema.md b/docs/reference/datatypes/b2b-contact.schema.md new file mode 100644 index 000000000..dcd1d9fc0 --- /dev/null +++ b/docs/reference/datatypes/b2b-contact.schema.md @@ -0,0 +1,175 @@ + +# B2B Contact Schema + +``` +https://ns.adobe.com/xdm/common/b2b-contact +``` + +This Data Type is used to capture B2B Contact specific attributes. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [datatypes/b2b-contact.schema.json](datatypes/b2b-contact.schema.json) | +## Schema Hierarchy + +* B2B Contact `https://ns.adobe.com/xdm/common/b2b-contact` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [XDM Contact and Lead common B2B attributes](contact-lead.schema.md) `https://ns.adobe.com/xdm/common/contact-lead` + * [OptInOut](optinout.schema.md) `https://ns.adobe.com/xdm/context/optinout` + + +## B2B Contact Example +```json +{ + "xdm:ID": "11110000", + "xdm:accountID": "", + "xdm:leadSource": "Lead Source", + "xdm:extendedContact": { + "xdm:type": "", + "xdm:ownerID": "", + "xdm:isDeleted": false, + "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00", + "xdm:emailBouncedReason": "Bounced Reason Here", + "xdm:isEmailBounced": true, + "xdm:description": "Contact/Lead description here", + "xdm:status": "Status", + "xdm:timezone": "", + "xdm:jigsaw": "12345" + }, + "xdm:identityMap": { + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:preferences": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false, + "xdm:optOutDetails": { + "xdm:email": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:phone": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + } + } +} +``` + +# B2B Contact Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:ID](#xdmid) | `string` | **Required** | B2B Contact (this schema) | +| [xdm:accountID](#xdmaccountid) | `string` | **Required** | B2B Contact (this schema) | +| [xdm:extendedContact](#xdmextendedcontact) | XDM Contact and Lead common B2B attributes | Optional | B2B Contact (this schema) | +| [xdm:leadSource](#xdmleadsource) | `string` | Optional | B2B Contact (this schema) | +| [xdm:preferences](#xdmpreferences) | OptInOut | Optional | B2B Contact (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:ID +### Contact Record Id + +Unique record id of the contact in the source system. + +`xdm:ID` +* is **required** +* type: `string` +* defined in this schema + +### xdm:ID Type + + +`string` + + + + + + +## xdm:accountID +### Contact Account id + +ID of the account that’s the parent of this contact. + +`xdm:accountID` +* is **required** +* type: `string` +* defined in this schema + +### xdm:accountID Type + + +`string` + + + + + + +## xdm:extendedContact +### Contact Extended Properties + +Holds additional properties for a person to be recognized as a contact in the business-to-business space. + +`xdm:extendedContact` +* is optional +* type: XDM Contact and Lead common B2B attributes +* defined in this schema + +### xdm:extendedContact Type + + +* [XDM Contact and Lead common B2B attributes](contact-lead.schema.md) – `https://ns.adobe.com/xdm/common/contact-lead` + + + + + +## xdm:leadSource +### Lead Source + +Field recording what source the lead originated from. + +`xdm:leadSource` +* is optional +* type: `string` +* defined in this schema + +### xdm:leadSource Type + + +`string` + + + + + + +## xdm:preferences +### Contact Preferences + +Holds opt out values for different channels as selected by the contact. + +`xdm:preferences` +* is optional +* type: OptInOut +* defined in this schema + +### xdm:preferences Type + + +* [OptInOut](optinout.schema.md) – `https://ns.adobe.com/xdm/context/optinout` + + + + diff --git a/docs/reference/datatypes/b2b-lead.schema.json b/docs/reference/datatypes/b2b-lead.schema.json new file mode 100644 index 000000000..c9589b367 --- /dev/null +++ b/docs/reference/datatypes/b2b-lead.schema.json @@ -0,0 +1,158 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/b2b-lead", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "B2B Lead", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "This Data Type is used to capture B2B Lead specific attributes.", + "definitions": { + "b2b-lead": { + "properties": { + "xdm:ID": { + "title": "Lead Id", + "description": "Lead id.", + "type": "string" + }, + "xdm:isConverted": { + "title": "Converted Indicator", + "description": "Indicates whether the Lead was successfully converted or not.", + "type": "boolean" + }, + "xdm:convertedAccountID": { + "title": "Converted Account ID", + "description": "Account Id if the lead was successfully converted.", + "type": "string" + }, + "xdm:convertedContactID": { + "title": "Converted Contact ID", + "description": "Contact Id if the lead was successfully converted.", + "type": "string" + }, + "xdm:convertedDate": { + "title": "Converted Date", + "description": "Date of conversion if the lead was successfully converted.", + "type": "string", + "format": "date-time" + }, + "xdm:convertedOpportunityID": { + "title": "Converted Opportunity ID", + "description": "Opportunity Id if the lead was successfully converted.", + "type": "string" + }, + "xdm:jigsawContactID": { + "title": "Jigsaw Contact Id", + "description": "Lead’s Data.com ID if available.", + "type": "string" + }, + "xdm:lastTransferDate": { + "title": "Last Transfer Date", + "description": "Last transfer date.", + "type": "string", + "format": "date-time" + }, + "xdm:isUnReadByOwner": { + "title": "Un-Read By Owner", + "description": "Un Read by owner indicator.", + "type": "boolean" + }, + "xdm:source": { + "title": "Lead Source", + "description": "Field recording what source the lead originated from.", + "type": "string" + }, + "xdm:organization": { + "title": "Organization Attributes", + "description": "Organization attributes if the lead is an organization.", + "$ref": "https://ns.adobe.com/xdm/common/organization" + }, + "xdm:preferences": { + "title": "Lead Preferences", + "description": "Holds opt out values for different channels as selected by the lead.", + "$ref": "https://ns.adobe.com/xdm/context/optinout" + }, + "xdm:extendedLead": { + "title": "Lead Extended Properties", + "description": "Holds additional properties for a person to be recognized as a lead in the business-to-business space.", + "$ref": "https://ns.adobe.com/xdm/common/contact-lead" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/b2b-lead" + } + ], + "required": [ + "xdm:ID" + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:ID": "", + "xdm:isConverted": true, + "xdm:convertedAccountID": "", + "xdm:convertedContactID": "", + "xdm:convertedDate": "2018-12-20T15:52:25+00:00", + "xdm:convertedOpportunityID": "", + "xdm:jigsawContactID": "", + "xdm:lastTransferDate": "2018-12-20T15:52:25+00:00", + "xdm:source": "", + "xdm:isUnReadByOwner": false, + "xdm:extendedLead": { + "xdm:type": "", + "xdm:ownerID": "", + "xdm:isDeleted": false, + "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00", + "xdm:emailBouncedReason": "Bounced Reason Here", + "xdm:isEmailBounced": true, + "xdm:description": "Contact description here", + "xdm:status": "Contacted", + "xdm:timezone": "" + }, + "xdm:identityMap": { + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:preferences": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false, + "xdm:optOutDetails": { + "xdm:email": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:phone": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + } + }, + "xdm:organization": { + "xdm:legalName": "ABC Stores", + "xdm:numberOfEmployees": 200, + "xdm:annualRevenue": 1000000, + "xdm:industry": "Retail", + "xdm:website": "http://www.abcstores.com" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/b2b-lead.schema.md b/docs/reference/datatypes/b2b-lead.schema.md new file mode 100644 index 000000000..245e096a2 --- /dev/null +++ b/docs/reference/datatypes/b2b-lead.schema.md @@ -0,0 +1,356 @@ + +# B2B Lead Schema + +``` +https://ns.adobe.com/xdm/common/b2b-lead +``` + +This Data Type is used to capture B2B Lead specific attributes. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [datatypes/b2b-lead.schema.json](datatypes/b2b-lead.schema.json) | +## Schema Hierarchy + +* B2B Lead `https://ns.adobe.com/xdm/common/b2b-lead` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Organization](organization.schema.md) `https://ns.adobe.com/xdm/common/organization` + * [OptInOut](optinout.schema.md) `https://ns.adobe.com/xdm/context/optinout` + * [XDM Contact and Lead common B2B attributes](contact-lead.schema.md) `https://ns.adobe.com/xdm/common/contact-lead` + + +## B2B Lead Example +```json +{ + "xdm:ID": "", + "xdm:isConverted": true, + "xdm:convertedAccountID": "", + "xdm:convertedContactID": "", + "xdm:convertedDate": "2018-12-20T15:52:25+00:00", + "xdm:convertedOpportunityID": "", + "xdm:jigsawContactID": "", + "xdm:lastTransferDate": "2018-12-20T15:52:25+00:00", + "xdm:source": "", + "xdm:isUnReadByOwner": false, + "xdm:extendedLead": { + "xdm:type": "", + "xdm:ownerID": "", + "xdm:isDeleted": false, + "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00", + "xdm:emailBouncedReason": "Bounced Reason Here", + "xdm:isEmailBounced": true, + "xdm:description": "Contact description here", + "xdm:status": "Contacted", + "xdm:timezone": "" + }, + "xdm:identityMap": { + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:preferences": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false, + "xdm:optOutDetails": { + "xdm:email": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:phone": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + } + }, + "xdm:organization": { + "xdm:legalName": "ABC Stores", + "xdm:numberOfEmployees": 200, + "xdm:annualRevenue": 1000000, + "xdm:industry": "Retail", + "xdm:website": "http://www.abcstores.com" + } +} +``` + +# B2B Lead Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:ID](#xdmid) | `string` | **Required** | B2B Lead (this schema) | +| [xdm:convertedAccountID](#xdmconvertedaccountid) | `string` | Optional | B2B Lead (this schema) | +| [xdm:convertedContactID](#xdmconvertedcontactid) | `string` | Optional | B2B Lead (this schema) | +| [xdm:convertedDate](#xdmconverteddate) | `string` | Optional | B2B Lead (this schema) | +| [xdm:convertedOpportunityID](#xdmconvertedopportunityid) | `string` | Optional | B2B Lead (this schema) | +| [xdm:extendedLead](#xdmextendedlead) | XDM Contact and Lead common B2B attributes | Optional | B2B Lead (this schema) | +| [xdm:isConverted](#xdmisconverted) | `boolean` | Optional | B2B Lead (this schema) | +| [xdm:isUnReadByOwner](#xdmisunreadbyowner) | `boolean` | Optional | B2B Lead (this schema) | +| [xdm:jigsawContactID](#xdmjigsawcontactid) | `string` | Optional | B2B Lead (this schema) | +| [xdm:lastTransferDate](#xdmlasttransferdate) | `string` | Optional | B2B Lead (this schema) | +| [xdm:organization](#xdmorganization) | Organization | Optional | B2B Lead (this schema) | +| [xdm:preferences](#xdmpreferences) | OptInOut | Optional | B2B Lead (this schema) | +| [xdm:source](#xdmsource) | `string` | Optional | B2B Lead (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:ID +### Lead Id + +Lead id. + +`xdm:ID` +* is **required** +* type: `string` +* defined in this schema + +### xdm:ID Type + + +`string` + + + + + + +## xdm:convertedAccountID +### Converted Account ID + +Account Id if the lead was successfully converted. + +`xdm:convertedAccountID` +* is optional +* type: `string` +* defined in this schema + +### xdm:convertedAccountID Type + + +`string` + + + + + + +## xdm:convertedContactID +### Converted Contact ID + +Contact Id if the lead was successfully converted. + +`xdm:convertedContactID` +* is optional +* type: `string` +* defined in this schema + +### xdm:convertedContactID Type + + +`string` + + + + + + +## xdm:convertedDate +### Converted Date + +Date of conversion if the lead was successfully converted. + +`xdm:convertedDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:convertedDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:convertedOpportunityID +### Converted Opportunity ID + +Opportunity Id if the lead was successfully converted. + +`xdm:convertedOpportunityID` +* is optional +* type: `string` +* defined in this schema + +### xdm:convertedOpportunityID Type + + +`string` + + + + + + +## xdm:extendedLead +### Lead Extended Properties + +Holds additional properties for a person to be recognized as a lead in the business-to-business space. + +`xdm:extendedLead` +* is optional +* type: XDM Contact and Lead common B2B attributes +* defined in this schema + +### xdm:extendedLead Type + + +* [XDM Contact and Lead common B2B attributes](contact-lead.schema.md) – `https://ns.adobe.com/xdm/common/contact-lead` + + + + + +## xdm:isConverted +### Converted Indicator + +Indicates whether the Lead was successfully converted or not. + +`xdm:isConverted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isConverted Type + + +`boolean` + + + + + +## xdm:isUnReadByOwner +### Un-Read By Owner + +Un Read by owner indicator. + +`xdm:isUnReadByOwner` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isUnReadByOwner Type + + +`boolean` + + + + + +## xdm:jigsawContactID +### Jigsaw Contact Id + +Lead’s Data.com ID if available. + +`xdm:jigsawContactID` +* is optional +* type: `string` +* defined in this schema + +### xdm:jigsawContactID Type + + +`string` + + + + + + +## xdm:lastTransferDate +### Last Transfer Date + +Last transfer date. + +`xdm:lastTransferDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:lastTransferDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:organization +### Organization Attributes + +Organization attributes if the lead is an organization. + +`xdm:organization` +* is optional +* type: Organization +* defined in this schema + +### xdm:organization Type + + +* [Organization](organization.schema.md) – `https://ns.adobe.com/xdm/common/organization` + + + + + +## xdm:preferences +### Lead Preferences + +Holds opt out values for different channels as selected by the lead. + +`xdm:preferences` +* is optional +* type: OptInOut +* defined in this schema + +### xdm:preferences Type + + +* [OptInOut](optinout.schema.md) – `https://ns.adobe.com/xdm/context/optinout` + + + + + +## xdm:source +### Lead Source + +Field recording what source the lead originated from. + +`xdm:source` +* is optional +* type: `string` +* defined in this schema + +### xdm:source Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/beacon-interaction-details.schema.json b/docs/reference/datatypes/beacon-interaction-details.schema.json new file mode 100644 index 000000000..f1fd313c6 --- /dev/null +++ b/docs/reference/datatypes/beacon-interaction-details.schema.json @@ -0,0 +1,69 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/beacon-interaction-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Beacon", + "type": "object", + "meta:extensible": true, + "description": "Beacon is a wireless device that communicates identity information to mobile applications as mobile devices come within range.", + "definitions": { + "beacon-interaction-detail": { + "properties": { + "xdm:proximityUUID": { + "title": "Proximity UUID", + "type": "string", + "description": "A proximity UUID (Universally Unique IDentifier) is a special type of identifier used to distinguish beacons in your network from all other beacons in networks outside your control. The proximity UUID is configured into a beacon, to be transmitted to mobile devices in range to identify an organizations beacons." + }, + "xdm:beaconMajor": { + "title": "Beacon major", + "type": "number", + "description": "Major values identify and distinguish a group and unsigned integer values between 1 and 65,535." + }, + "xdm:beaconMinor": { + "title": "Beacon Minor", + "type": "number", + "description": "Minor values identify and distinguish an individual and unsigned integer values between 1 and 65,535." + }, + "xdm:proximity": { + "title": "Proximity to beacon", + "type": "string", + "description": "Estimated distance from the beacon.", + "enum": [ + "immediate", + "near", + "far", + "unknown" + ], + "meta:enum": { + "immediate": "Within a few centimeter.", + "near": "Within a couple of meters.", + "far": "Greater than 10 meters away.", + "unknown": "Not able to ascertain distance, signal likely very weak." + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/beacon-interaction-detail" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", + "xdm:beaconMajor": 100, + "xdm:beaconMinor": 23, + "xdm:proximity": "near" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/beacon-interaction-details.schema.md b/docs/reference/datatypes/beacon-interaction-details.schema.md new file mode 100644 index 000000000..c4ac43d04 --- /dev/null +++ b/docs/reference/datatypes/beacon-interaction-details.schema.md @@ -0,0 +1,120 @@ + +# Beacon Schema + +``` +https://ns.adobe.com/xdm/context/beacon-interaction-details +``` + +Beacon is a wireless device that communicates identity information to mobile applications as mobile devices come within range. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/beacon-interaction-details.schema.json](datatypes/beacon-interaction-details.schema.json) | +## Schema Hierarchy + +* Beacon `https://ns.adobe.com/xdm/context/beacon-interaction-details` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Beacon Example +```json +{ + "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", + "xdm:beaconMajor": 100, + "xdm:beaconMinor": 23, + "xdm:proximity": "near" +} +``` + +# Beacon Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:beaconMajor](#xdmbeaconmajor) | `number` | Optional | Beacon (this schema) | +| [xdm:beaconMinor](#xdmbeaconminor) | `number` | Optional | Beacon (this schema) | +| [xdm:proximity](#xdmproximity) | `enum` | Optional | Beacon (this schema) | +| [xdm:proximityUUID](#xdmproximityuuid) | `string` | Optional | Beacon (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:beaconMajor +### Beacon major + +Major values identify and distinguish a group and unsigned integer values between 1 and 65,535. + +`xdm:beaconMajor` +* is optional +* type: `number` +* defined in this schema + +### xdm:beaconMajor Type + + +`number` + + + + + + +## xdm:beaconMinor +### Beacon Minor + +Minor values identify and distinguish an individual and unsigned integer values between 1 and 65,535. + +`xdm:beaconMinor` +* is optional +* type: `number` +* defined in this schema + +### xdm:beaconMinor Type + + +`number` + + + + + + +## xdm:proximity +### Proximity to beacon + +Estimated distance from the beacon. + +`xdm:proximity` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmproximity-known-values). + +### xdm:proximity Known Values +| Value | Description | +|-------|-------------| +| `immediate` | Within a few centimeter. | +| `near` | Within a couple of meters. | +| `far` | Greater than 10 meters away. | +| `unknown` | Not able to ascertain distance, signal likely very weak. | + + + + +## xdm:proximityUUID +### Proximity UUID + +A proximity UUID (Universally Unique IDentifier) is a special type of identifier used to distinguish beacons in your network from all other beacons in networks outside your control. The proximity UUID is configured into a beacon, to be transmitted to mobile devices in range to identify an organizations beacons. + +`xdm:proximityUUID` +* is optional +* type: `string` +* defined in this schema + +### xdm:proximityUUID Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/browserdetails.schema.json b/docs/reference/datatypes/browserdetails.schema.json new file mode 100644 index 000000000..1526b370a --- /dev/null +++ b/docs/reference/datatypes/browserdetails.schema.json @@ -0,0 +1,116 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/browserdetails", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Browser details", + "type": "object", + "meta:extensible": true, + "description": "Detail information related to the browser.", + "definitions": { + "browserdetails": { + "properties": { + "xdm:name": { + "title": "Name", + "type": "string", + "description": "The application or browser name." + }, + "xdm:vendor": { + "title": "Vendor", + "type": "string", + "description": "The application or browser vendor." + }, + "xdm:version": { + "title": "Version", + "type": "string", + "description": "The application or browser version." + }, + "xdm:userAgent": { + "title": "User agent", + "type": "string", + "description": "The HTTP user-agent string from the client request." + }, + "xdm:acceptLanguage": { + "title": "Accept language", + "type": "string", + "description": "An IETF language tag (RFC 5646)." + }, + "xdm:cookiesEnabled": { + "title": "Allows cookies", + "type": "boolean", + "description": "The current user agent settings allow for the writing of cookies.'" + }, + "xdm:javaScriptEnabled": { + "title": "JavaScript enabled", + "type": "boolean", + "description": "If JavaScript was enabled in the device this observation was made from." + }, + "xdm:javaScriptVersion": { + "title": "JavaScript version", + "type": "string", + "description": "The version of JavaScript supported during the observation." + }, + "xdm:javaEnabled": { + "title": "Java enabled", + "type": "boolean", + "description": "If Java was enabled in the device this observation was made from." + }, + "xdm:javaVersion": { + "title": "Java version", + "type": "string", + "description": "The version of Java supported during the observation." + }, + "xdm:quicktimeVersion": { + "title": "Quicktime version", + "type": "string", + "description": "The version of Apple Quicktime supported during the observation." + }, + "xdm:thirdPartyCookiesEnabled": { + "title": "Allows third-party cookies", + "type": "boolean", + "description": "If third-party cookies were enabled when this observation was made." + }, + "xdm:viewportHeight": { + "title": "Viewport height", + "type": "integer", + "description": "The vertical size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport height.", + "minimum": 0 + }, + "xdm:viewportWidth": { + "title": "Viewport width", + "type": "integer", + "description": "The horizontal size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport width.", + "minimum": 0 + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/browserdetails" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:name": "Chrome", + "xdm:vendor": "Google", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/browserdetails.schema.md b/docs/reference/datatypes/browserdetails.schema.md new file mode 100644 index 000000000..ce5bb0e12 --- /dev/null +++ b/docs/reference/datatypes/browserdetails.schema.md @@ -0,0 +1,332 @@ + +# Browser details Schema + +``` +https://ns.adobe.com/xdm/context/browserdetails +``` + +Detail information related to the browser. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/browserdetails.schema.json](datatypes/browserdetails.schema.json) | +## Schema Hierarchy + +* Browser details `https://ns.adobe.com/xdm/context/browserdetails` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Browser details Example +```json +{ + "xdm:name": "Chrome", + "xdm:vendor": "Google", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 +} +``` + +# Browser details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:acceptLanguage](#xdmacceptlanguage) | `string` | Optional | Browser details (this schema) | +| [xdm:cookiesEnabled](#xdmcookiesenabled) | `boolean` | Optional | Browser details (this schema) | +| [xdm:javaEnabled](#xdmjavaenabled) | `boolean` | Optional | Browser details (this schema) | +| [xdm:javaScriptEnabled](#xdmjavascriptenabled) | `boolean` | Optional | Browser details (this schema) | +| [xdm:javaScriptVersion](#xdmjavascriptversion) | `string` | Optional | Browser details (this schema) | +| [xdm:javaVersion](#xdmjavaversion) | `string` | Optional | Browser details (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | Browser details (this schema) | +| [xdm:quicktimeVersion](#xdmquicktimeversion) | `string` | Optional | Browser details (this schema) | +| [xdm:thirdPartyCookiesEnabled](#xdmthirdpartycookiesenabled) | `boolean` | Optional | Browser details (this schema) | +| [xdm:userAgent](#xdmuseragent) | `string` | Optional | Browser details (this schema) | +| [xdm:vendor](#xdmvendor) | `string` | Optional | Browser details (this schema) | +| [xdm:version](#xdmversion) | `string` | Optional | Browser details (this schema) | +| [xdm:viewportHeight](#xdmviewportheight) | `integer` | Optional | Browser details (this schema) | +| [xdm:viewportWidth](#xdmviewportwidth) | `integer` | Optional | Browser details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:acceptLanguage +### Accept language + +An IETF language tag (RFC 5646). + +`xdm:acceptLanguage` +* is optional +* type: `string` +* defined in this schema + +### xdm:acceptLanguage Type + + +`string` + + + + + + +## xdm:cookiesEnabled +### Allows cookies + +The current user agent settings allow for the writing of cookies.' + +`xdm:cookiesEnabled` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:cookiesEnabled Type + + +`boolean` + + + + + +## xdm:javaEnabled +### Java enabled + +If Java was enabled in the device this observation was made from. + +`xdm:javaEnabled` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:javaEnabled Type + + +`boolean` + + + + + +## xdm:javaScriptEnabled +### JavaScript enabled + +If JavaScript was enabled in the device this observation was made from. + +`xdm:javaScriptEnabled` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:javaScriptEnabled Type + + +`boolean` + + + + + +## xdm:javaScriptVersion +### JavaScript version + +The version of JavaScript supported during the observation. + +`xdm:javaScriptVersion` +* is optional +* type: `string` +* defined in this schema + +### xdm:javaScriptVersion Type + + +`string` + + + + + + +## xdm:javaVersion +### Java version + +The version of Java supported during the observation. + +`xdm:javaVersion` +* is optional +* type: `string` +* defined in this schema + +### xdm:javaVersion Type + + +`string` + + + + + + +## xdm:name +### Name + +The application or browser name. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:quicktimeVersion +### Quicktime version + +The version of Apple Quicktime supported during the observation. + +`xdm:quicktimeVersion` +* is optional +* type: `string` +* defined in this schema + +### xdm:quicktimeVersion Type + + +`string` + + + + + + +## xdm:thirdPartyCookiesEnabled +### Allows third-party cookies + +If third-party cookies were enabled when this observation was made. + +`xdm:thirdPartyCookiesEnabled` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:thirdPartyCookiesEnabled Type + + +`boolean` + + + + + +## xdm:userAgent +### User agent + +The HTTP user-agent string from the client request. + +`xdm:userAgent` +* is optional +* type: `string` +* defined in this schema + +### xdm:userAgent Type + + +`string` + + + + + + +## xdm:vendor +### Vendor + +The application or browser vendor. + +`xdm:vendor` +* is optional +* type: `string` +* defined in this schema + +### xdm:vendor Type + + +`string` + + + + + + +## xdm:version +### Version + +The application or browser version. + +`xdm:version` +* is optional +* type: `string` +* defined in this schema + +### xdm:version Type + + +`string` + + + + + + +## xdm:viewportHeight +### Viewport height + +The vertical size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport height. + +`xdm:viewportHeight` +* is optional +* type: `integer` +* defined in this schema + +### xdm:viewportHeight Type + + +`integer` +* minimum value: `0` + + + + + + +## xdm:viewportWidth +### Viewport width + +The horizontal size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport width. + +`xdm:viewportWidth` +* is optional +* type: `integer` +* defined in this schema + +### xdm:viewportWidth Type + + +`integer` +* minimum value: `0` + + + + + diff --git a/docs/reference/datatypes/channels/application.schema.json b/docs/reference/datatypes/channels/application.schema.json new file mode 100644 index 000000000..3fecfaa51 --- /dev/null +++ b/docs/reference/datatypes/channels/application.schema.json @@ -0,0 +1,48 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/channels/application", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Application Channel", + "type": "object", + "meta:abstract": true, + "description": "An application channel identifies apps that accepts messages or transmit events to the channel.", + "definitions": { + "application": { + "properties": { + "@id": { + "title": "Application Identifier", + "type": "string", + "description": "Unique identifier of the app." + }, + "xdm:name": { + "title": "Name", + "type": "string", + "description": "Name of the app." + }, + "xdm:version": { + "title": "Version", + "type": "string", + "description": "Version of the app." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/application" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:id": "A123", + "xdm:name": "Myapp", + "xdm:version": "1.0.1" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/channels/application.schema.md b/docs/reference/datatypes/channels/application.schema.md new file mode 100644 index 000000000..7bb271c14 --- /dev/null +++ b/docs/reference/datatypes/channels/application.schema.md @@ -0,0 +1,90 @@ + +# Application Channel Schema + +``` +https://ns.adobe.com/xdm/channels/application +``` + +An application channel identifies apps that accepts messages or transmit events to the channel. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/channels/application.schema.json](datatypes/channels/application.schema.json) | + +## Application Channel Example +```json +{ + "xdm:id": "A123", + "xdm:name": "Myapp", + "xdm:version": "1.0.1" +} +``` + +# Application Channel Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Application Channel (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | Application Channel (this schema) | +| [xdm:version](#xdmversion) | `string` | Optional | Application Channel (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Application Identifier + +Unique identifier of the app. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` + + + + + + +## xdm:name +### Name + +Name of the app. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:version +### Version + +Version of the app. + +`xdm:version` +* is optional +* type: `string` +* defined in this schema + +### xdm:version Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/channels/channel.schema.json b/docs/reference/datatypes/channels/channel.schema.json new file mode 100644 index 000000000..a7d8dc9f1 --- /dev/null +++ b/docs/reference/datatypes/channels/channel.schema.json @@ -0,0 +1,145 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/channels/channel", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Experience Channel", + "meta:extensible": true, + "meta:abstract": true, + "type": "object", + "description": "An experience channel is a way how digital experiences are consumed.\n\nThere are multiple experience channels, each with different constraints on how content is delivered and how customer interaction can be observed and data collected. Within a channel, experiences can be delivered to specific locations. The locations and types of locations that exist in a channel differ from channel to channel.\n", + "definitions": { + "channel": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "description": "The ID uniquely identifies the channel. Each specific experience channel defines a constant `@id`." + }, + "xdm:typeAtSource": { + "type": "string", + "description": "Customer defined custom channel name" + }, + "xdm:mode": { + "type": "string", + "enum": [ + "push", + "pull", + "bidirectional" + ], + "description": "How experiences are delivered in this channel.", + "meta:enum": { + "push": "The publisher of an experience can initiate an experience by sending a message into the channel. Most `push` channels involve some form of subscription or opt-in.", + "pull": "The consumer can initiate an experience by requesting a location in the channel. Most `pull` channels give publishers some control how the experience is then delivered.", + "bidirectional": "Both `push` and `pull` interaction modes are supported by the channel." + } + }, + "@type": { + "type": "string", + "format": "uri", + "description": "The `@type` property is used to provide a rough classification of channels with similar properties.", + "meta:enum": { + "https://ns.adobe.com/xdm/channel-types/web": "The world wide web, including mobile web", + "https://ns.adobe.com/xdm/channel-types/social": "Social media platforms", + "https://ns.adobe.com/xdm/channel-types/mobile": "Mobile apps", + "https://ns.adobe.com/xdm/channel-types/messaging": "Instant messaging", + "https://ns.adobe.com/xdm/channel-types/email": "Email", + "https://ns.adobe.com/xdm/channel-types/offline": "Non-digital experience channels", + "https://ns.adobe.com/xdm/channel-types/display": "Display", + "https://ns.adobe.com/xdm/channel-types/search": "Search", + "https://ns.adobe.com/xdm/channel-types/social_display": "Social Display", + "https://ns.adobe.com/xdm/channel-types/video": "Video", + "https://ns.adobe.com/xdm/channel-types/affiliate": "Affiliate", + "https://ns.adobe.com/xdm/channel-types/affinity": "Affinity", + "https://ns.adobe.com/xdm/channel-types/apps": "Applications", + "https://ns.adobe.com/xdm/channel-types/preload": "Preload", + "https://ns.adobe.com/xdm/channel-types/direct": "Direct", + "https://ns.adobe.com/xdm/channel-types/external": "External", + "https://ns.adobe.com/xdm/channel-types/mail": "Mail", + "https://ns.adobe.com/xdm/channel-types/instore": "Instore" + } + }, + "xdm:mediaType": { + "type": "string", + "description": "Describes whether the media type is paid,owned or earned.", + "meta:enum": { + "paid": "Paid", + "owned": "Owned", + "earned": "Earned" + } + }, + "xdm:mediaAction": { + "type": "string", + "description": "The `mediaAction` property is used to provide a type of experiance event media action .", + "meta:enum": { + "opens": "Opens", + "sends": "Sends", + "clicks": "Clicks", + "impressions": "Impressions", + "bounces": "Bounces", + "mirrorpages": "Mirrorpages", + "nonDeliverables": "NonDeliverables", + "notSent": "NotSent", + "offerOpens": "OfferOpens", + "unSubscriptions": "UnSubscriptions", + "userComplaints": "UserComplaints", + "subscriptions": "Subscriptions" + } + }, + "xdm:contentTypes": { + "type": "array", + "items": { + "type": "string", + "format": "uri", + "description": "The `@type` of an XDM-defined content type that is supported by this channel." + }, + "description": "The content types that this channel can deliver." + }, + "xdm:metricTypes": { + "type": "array", + "items": { + "type": "string", + "format": "uri", + "description": "The `@type` of an XDM-defined metric that is supported by this channel." + }, + "description": "The metrics that can be collected in this channel." + }, + "xdm:locationTypes": { + "type": "array", + "items": { + "type": "string", + "format": "uri", + "description": "The `@type` of an XDM-defined location (virtual place) that this channel can contain." + }, + "description": "The types of locations (virtual places) that this channel consists of and can deliver content to." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/channel" + } + ], + "required": [ + "@id" + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://ns.adobe.com/xdm/channels/facebook-feed", + "@type": "https://ns.adobe.com/xdm/channel-types/social", + "xdm:metrics": [ + "https://ns.adobe.com/xdm/data/metrics/web/page-views", + "https://ns.adobe.com/xdm/data/metrics/web/link-clicks" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/channels/channel.schema.md b/docs/reference/datatypes/channels/channel.schema.md new file mode 100644 index 000000000..9bb1c7bbe --- /dev/null +++ b/docs/reference/datatypes/channels/channel.schema.md @@ -0,0 +1,297 @@ + +# Experience Channel Schema + +``` +https://ns.adobe.com/xdm/channels/channel +``` + +An experience channel is a way how digital experiences are consumed. + +There are multiple experience channels, each with different constraints on how content is delivered and how customer interaction can be observed and data collected. Within a channel, experiences can be delivered to specific locations. The locations and types of locations that exist in a channel differ from channel to channel. + + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/channels/channel.schema.json](datatypes/channels/channel.schema.json) | +## Schema Hierarchy + +* Experience Channel `https://ns.adobe.com/xdm/channels/channel` + * [Extensibility base schema](../extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Experience Channel Example +```json +{ + "@id": "https://ns.adobe.com/xdm/channels/facebook-feed", + "@type": "https://ns.adobe.com/xdm/channel-types/social", + "xdm:metrics": [ + "https://ns.adobe.com/xdm/data/metrics/web/page-views", + "https://ns.adobe.com/xdm/data/metrics/web/link-clicks" + ] +} +``` + +# Experience Channel Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | Experience Channel (this schema) | +| [@type](#type) | `string` | Optional | Experience Channel (this schema) | +| [xdm:contentTypes](#xdmcontenttypes) | `string[]` | Optional | Experience Channel (this schema) | +| [xdm:locationTypes](#xdmlocationtypes) | `string[]` | Optional | Experience Channel (this schema) | +| [xdm:mediaAction](#xdmmediaaction) | `string` | Optional | Experience Channel (this schema) | +| [xdm:mediaType](#xdmmediatype) | `string` | Optional | Experience Channel (this schema) | +| [xdm:metricTypes](#xdmmetrictypes) | `string[]` | Optional | Experience Channel (this schema) | +| [xdm:mode](#xdmmode) | `enum` | Optional | Experience Channel (this schema) | +| [xdm:typeAtSource](#xdmtypeatsource) | `string` | Optional | Experience Channel (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The ID uniquely identifies the channel. Each specific experience channel defines a constant `@id`. + +`@id` +* is **required** +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## @type + +The `@type` property is used to provide a rough classification of channels with similar properties. + +`@type` +* is optional +* type: `string` +* defined in this schema + +### @type Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + +### @type Known Values +| Value | Description | +|-------|-------------| +| `https://ns.adobe.com/xdm/channel-types/web` | The world wide web, including mobile web | +| `https://ns.adobe.com/xdm/channel-types/social` | Social media platforms | +| `https://ns.adobe.com/xdm/channel-types/mobile` | Mobile apps | +| `https://ns.adobe.com/xdm/channel-types/messaging` | Instant messaging | +| `https://ns.adobe.com/xdm/channel-types/email` | Email | +| `https://ns.adobe.com/xdm/channel-types/offline` | Non-digital experience channels | +| `https://ns.adobe.com/xdm/channel-types/display` | Display | +| `https://ns.adobe.com/xdm/channel-types/search` | Search | +| `https://ns.adobe.com/xdm/channel-types/social_display` | Social Display | +| `https://ns.adobe.com/xdm/channel-types/video` | Video | +| `https://ns.adobe.com/xdm/channel-types/affiliate` | Affiliate | +| `https://ns.adobe.com/xdm/channel-types/affinity` | Affinity | +| `https://ns.adobe.com/xdm/channel-types/apps` | Applications | +| `https://ns.adobe.com/xdm/channel-types/preload` | Preload | +| `https://ns.adobe.com/xdm/channel-types/direct` | Direct | +| `https://ns.adobe.com/xdm/channel-types/external` | External | +| `https://ns.adobe.com/xdm/channel-types/mail` | Mail | +| `https://ns.adobe.com/xdm/channel-types/instore` | Instore | + + + + +## xdm:contentTypes + +The content types that this channel can deliver. + +`xdm:contentTypes` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:contentTypes Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + +The `@type` of an XDM-defined content type that is supported by this channel. + + + + + + + +## xdm:locationTypes + +The types of locations (virtual places) that this channel consists of and can deliver content to. + +`xdm:locationTypes` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:locationTypes Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + +The `@type` of an XDM-defined location (virtual place) that this channel can contain. + + + + + + + +## xdm:mediaAction + +The `mediaAction` property is used to provide a type of experiance event media action . + +`xdm:mediaAction` +* is optional +* type: `string` +* defined in this schema + +### xdm:mediaAction Type + + +`string` + + + +### xdm:mediaAction Known Values +| Value | Description | +|-------|-------------| +| `opens` | Opens | +| `sends` | Sends | +| `clicks` | Clicks | +| `impressions` | Impressions | +| `bounces` | Bounces | +| `mirrorpages` | Mirrorpages | +| `nonDeliverables` | NonDeliverables | +| `notSent` | NotSent | +| `offerOpens` | OfferOpens | +| `unSubscriptions` | UnSubscriptions | +| `userComplaints` | UserComplaints | +| `subscriptions` | Subscriptions | + + + + +## xdm:mediaType + +Describes whether the media type is paid,owned or earned. + +`xdm:mediaType` +* is optional +* type: `string` +* defined in this schema + +### xdm:mediaType Type + + +`string` + + + +### xdm:mediaType Known Values +| Value | Description | +|-------|-------------| +| `paid` | Paid | +| `owned` | Owned | +| `earned` | Earned | + + + + +## xdm:metricTypes + +The metrics that can be collected in this channel. + +`xdm:metricTypes` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:metricTypes Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + +The `@type` of an XDM-defined metric that is supported by this channel. + + + + + + + +## xdm:mode + +How experiences are delivered in this channel. + +`xdm:mode` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmmode-known-values). + +### xdm:mode Known Values +| Value | Description | +|-------|-------------| +| `push` | The publisher of an experience can initiate an experience by sending a message into the channel. Most `push` channels involve some form of subscription or opt-in. | +| `pull` | The consumer can initiate an experience by requesting a location in the channel. Most `pull` channels give publishers some control how the experience is then delivered. | +| `bidirectional` | Both `push` and `pull` interaction modes are supported by the channel. | + + + + +## xdm:typeAtSource + +Customer defined custom channel name + +`xdm:typeAtSource` +* is optional +* type: `string` +* defined in this schema + +### xdm:typeAtSource Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/channels/phone.schema.json b/docs/reference/datatypes/channels/phone.schema.json new file mode 100644 index 000000000..738ab0b5e --- /dev/null +++ b/docs/reference/datatypes/channels/phone.schema.json @@ -0,0 +1,90 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/channels/phone", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Phone Channel", + "description": "The telephone channel includes both inbound and outbound messages.", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/channels/channel#/definitions/channel" + ], + "type": "object", + "meta:abstract": true, + "definitions": { + "channel": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "const": "https://ns.adobe.com/xdm/channels/phone", + "description": "The ID uniquely identifies the channel. Each specific experience channel defines a constant `@id`." + }, + "xdm:mode": { + "type": "string", + "const": "bidirectional", + "description": "How experiences are delivered in this channel.", + "meta:enum": { + "push": "The publisher of an experience can initiate an experience by sending a message into the channel. Most `push` channels involve some form of subscription or opt-in.", + "pull": "The consumer can initiate an experience by requesting a location in the channel. Most `pull` channels give publishers some control how the experience is then delivered.", + "bidirectional": "Both `push` and `pull` interaction modes are supported by the channel." + } + }, + "@type": { + "type": "string", + "format": "uri", + "description": "The `@type` property is used to provide a rough classification of channels with similar properties.", + "const": "https://ns.adobe.com/xdm/channel-types/offline", + "meta:enum": { + "https://ns.adobe.com/xdm/channel-types/web": "The world wide web, including mobile web", + "https://ns.adobe.com/xdm/channel-types/social": "Social media platforms", + "https://ns.adobe.com/xdm/channel-types/mobile": "Mobile apps", + "https://ns.adobe.com/xdm/channel-types/messaging": "Instant messaging", + "https://ns.adobe.com/xdm/channel-types/email": "Email", + "https://ns.adobe.com/xdm/channel-types/offline": "Non-digital experience channels" + } + }, + "xdm:contentTypes": { + "type": "array", + "const": [], + "description": "The content types that this channel can deliver." + }, + "xdm:metricTypes": { + "type": "array", + "const": [], + "description": "The metrics that can be collected in this channel." + }, + "xdm:locationTypes": { + "type": "array", + "const": [], + "description": "The types of locations (virtual places) that this channel consists of and can deliver content to." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/channels/channel#/definitions/channel" + }, + { + "$ref": "#/definitions/channel" + } + ], + "required": [ + "@id" + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://ns.adobe.com/xdm/channels/phone", + "@type": "https://ns.adobe.com/xdm/channel-types/offline" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/channels/phone.schema.md b/docs/reference/datatypes/channels/phone.schema.md new file mode 100644 index 000000000..79c8dbc82 --- /dev/null +++ b/docs/reference/datatypes/channels/phone.schema.md @@ -0,0 +1,255 @@ + +# Phone Channel Schema + +``` +https://ns.adobe.com/xdm/channels/phone +``` + +The telephone channel includes both inbound and outbound messages. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/channels/phone.schema.json](datatypes/channels/phone.schema.json) | +## Schema Hierarchy + +* Phone Channel `https://ns.adobe.com/xdm/channels/phone` + * [Extensibility base schema](../extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Experience Channel](channel.schema.md) `https://ns.adobe.com/xdm/channels/channel` + + +## Phone Channel Example +```json +{ + "@id": "https://ns.adobe.com/xdm/channels/phone", + "@type": "https://ns.adobe.com/xdm/channel-types/offline" +} +``` + +# Phone Channel Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `const` | **Required** | Phone Channel (this schema) | +| [@type](#type) | `const` | Optional | Phone Channel (this schema) | +| [xdm:contentTypes](#xdmcontenttypes) | `const` | Optional | Phone Channel (this schema) | +| [xdm:locationTypes](#xdmlocationtypes) | `const` | Optional | Phone Channel (this schema) | +| [xdm:mediaAction](#xdmmediaaction) | `string` | Optional | [Experience Channel](channel.schema.md#xdmmediaaction) | +| [xdm:mediaType](#xdmmediatype) | `string` | Optional | [Experience Channel](channel.schema.md#xdmmediatype) | +| [xdm:metricTypes](#xdmmetrictypes) | `const` | Optional | Phone Channel (this schema) | +| [xdm:mode](#xdmmode) | `const` | Optional | Phone Channel (this schema) | +| [xdm:typeAtSource](#xdmtypeatsource) | `string` | Optional | [Experience Channel](channel.schema.md#xdmtypeatsource) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The ID uniquely identifies the channel. Each specific experience channel defines a constant `@id`. + +`@id` +* is **required** +* type: `const` +* defined in this schema + +The value of this property **must** be equal to: + +```json +"https://ns.adobe.com/xdm/channels/phone" +``` + + + + + +## @type + +The `@type` property is used to provide a rough classification of channels with similar properties. + +`@type` +* is optional +* type: `const` +* defined in this schema + +The value of this property **must** be equal to: + +```json +"https://ns.adobe.com/xdm/channel-types/offline" +``` + + +### @type Known Values +| Value | Description | +|-------|-------------| +| `https://ns.adobe.com/xdm/channel-types/web` | The world wide web, including mobile web | +| `https://ns.adobe.com/xdm/channel-types/social` | Social media platforms | +| `https://ns.adobe.com/xdm/channel-types/mobile` | Mobile apps | +| `https://ns.adobe.com/xdm/channel-types/messaging` | Instant messaging | +| `https://ns.adobe.com/xdm/channel-types/email` | Email | +| `https://ns.adobe.com/xdm/channel-types/offline` | Non-digital experience channels | + + + + +## xdm:contentTypes + +The content types that this channel can deliver. + +`xdm:contentTypes` +* is optional +* type: `const` + +* defined in this schema + +The value of this property **must** be equal to: + +```json +[] +``` + + + + + +## xdm:locationTypes + +The types of locations (virtual places) that this channel consists of and can deliver content to. + +`xdm:locationTypes` +* is optional +* type: `const` + +* defined in this schema + +The value of this property **must** be equal to: + +```json +[] +``` + + + + + +## xdm:mediaAction + +The `mediaAction` property is used to provide a type of experiance event media action . + +`xdm:mediaAction` +* is optional +* type: `string` +* defined in [Experience Channel](channel.schema.md#xdmmediaaction) + +### xdm:mediaAction Type + + +`string` + + + +### xdm:mediaAction Known Values +| Value | Description | +|-------|-------------| +| `opens` | Opens | +| `sends` | Sends | +| `clicks` | Clicks | +| `impressions` | Impressions | +| `bounces` | Bounces | +| `mirrorpages` | Mirrorpages | +| `nonDeliverables` | NonDeliverables | +| `notSent` | NotSent | +| `offerOpens` | OfferOpens | +| `unSubscriptions` | UnSubscriptions | +| `userComplaints` | UserComplaints | +| `subscriptions` | Subscriptions | + + + + +## xdm:mediaType + +Describes whether the media type is paid,owned or earned. + +`xdm:mediaType` +* is optional +* type: `string` +* defined in [Experience Channel](channel.schema.md#xdmmediatype) + +### xdm:mediaType Type + + +`string` + + + +### xdm:mediaType Known Values +| Value | Description | +|-------|-------------| +| `paid` | Paid | +| `owned` | Owned | +| `earned` | Earned | + + + + +## xdm:metricTypes + +The metrics that can be collected in this channel. + +`xdm:metricTypes` +* is optional +* type: `const` + +* defined in this schema + +The value of this property **must** be equal to: + +```json +[] +``` + + + + + +## xdm:mode + +How experiences are delivered in this channel. + +`xdm:mode` +* is optional +* type: `const` +* defined in this schema + +The value of this property **must** be equal to: + +```json +"bidirectional" +``` + + +### xdm:mode Known Values +| Value | Description | +|-------|-------------| +| `push` | The publisher of an experience can initiate an experience by sending a message into the channel. Most `push` channels involve some form of subscription or opt-in. | +| `pull` | The consumer can initiate an experience by requesting a location in the channel. Most `pull` channels give publishers some control how the experience is then delivered. | +| `bidirectional` | Both `push` and `pull` interaction modes are supported by the channel. | + + + + +## xdm:typeAtSource + +Customer defined custom channel name + +`xdm:typeAtSource` +* is optional +* type: `string` +* defined in [Experience Channel](channel.schema.md#xdmtypeatsource) + +### xdm:typeAtSource Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/commerce.schema.json b/docs/reference/datatypes/commerce.schema.json new file mode 100644 index 000000000..bd532594c --- /dev/null +++ b/docs/reference/datatypes/commerce.schema.json @@ -0,0 +1,105 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/commerce", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Commerce", + "type": "object", + "meta:extensible": true, + "description": "The records related to buying and selling activity.", + "definitions": { + "commerce": { + "properties": { + "xdm:order": { + "title": "Order", + "$ref": "https://ns.adobe.com/xdm/data/order", + "description": "The placed order for one or more products." + }, + "xdm:cartAbandons": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A product list has been identified as no longer accessible or purchasable by the user." + }, + "xdm:checkouts": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "An action during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order." + }, + "xdm:productListAdds": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Addition of a product to the product list, for example a product is added to a shopping cart." + }, + "xdm:productListOpens": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Initializations of a new product list, for example a shopping cart is created." + }, + "xdm:productListRemovals": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Removal or removals of a product entry from a product list, for example a product is removed from a shopping cart." + }, + "xdm:productListReopens": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A product list that was no longer accessible (abandoned) has been re-activated by the user. Example via a re-marketing activity." + }, + "xdm:productListViews": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "View or views of a product-list has occurred." + }, + "xdm:productViews": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "View or views of a product have occurred." + }, + "xdm:purchases": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced." + }, + "xdm:saveForLaters": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Product list is saved for future use, for example a product wish list." + }, + "xdm:inStorePurchase": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "'inStore' purchase is saved for analytics use." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/commerce" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 899.99, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionID": "transactid-a222", + "xdm:paymentAmount": 99.99, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 999.98 + }, + "xdm:purchases": { + "xdm:value": 1 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/commerce.schema.md b/docs/reference/datatypes/commerce.schema.md new file mode 100644 index 000000000..875a28d98 --- /dev/null +++ b/docs/reference/datatypes/commerce.schema.md @@ -0,0 +1,283 @@ + +# Commerce Schema + +``` +https://ns.adobe.com/xdm/context/commerce +``` + +The records related to buying and selling activity. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/commerce.schema.json](datatypes/commerce.schema.json) | +## Schema Hierarchy + +* Commerce `https://ns.adobe.com/xdm/context/commerce` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Order](data/order.schema.md) `https://ns.adobe.com/xdm/data/order` + * [Measure](data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## Commerce Example +```json +{ + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 899.99, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionID": "transactid-a222", + "xdm:paymentAmount": 99.99, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 999.98 + }, + "xdm:purchases": { + "xdm:value": 1 + } +} +``` + +# Commerce Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:cartAbandons](#xdmcartabandons) | Measure | Optional | Commerce (this schema) | +| [xdm:checkouts](#xdmcheckouts) | Measure | Optional | Commerce (this schema) | +| [xdm:inStorePurchase](#xdminstorepurchase) | Measure | Optional | Commerce (this schema) | +| [xdm:order](#xdmorder) | Order | Optional | Commerce (this schema) | +| [xdm:productListAdds](#xdmproductlistadds) | Measure | Optional | Commerce (this schema) | +| [xdm:productListOpens](#xdmproductlistopens) | Measure | Optional | Commerce (this schema) | +| [xdm:productListRemovals](#xdmproductlistremovals) | Measure | Optional | Commerce (this schema) | +| [xdm:productListReopens](#xdmproductlistreopens) | Measure | Optional | Commerce (this schema) | +| [xdm:productListViews](#xdmproductlistviews) | Measure | Optional | Commerce (this schema) | +| [xdm:productViews](#xdmproductviews) | Measure | Optional | Commerce (this schema) | +| [xdm:purchases](#xdmpurchases) | Measure | Optional | Commerce (this schema) | +| [xdm:saveForLaters](#xdmsaveforlaters) | Measure | Optional | Commerce (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:cartAbandons + +A product list has been identified as no longer accessible or purchasable by the user. + +`xdm:cartAbandons` +* is optional +* type: Measure +* defined in this schema + +### xdm:cartAbandons Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:checkouts + +An action during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order. + +`xdm:checkouts` +* is optional +* type: Measure +* defined in this schema + +### xdm:checkouts Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:inStorePurchase + +'inStore' purchase is saved for analytics use. + +`xdm:inStorePurchase` +* is optional +* type: Measure +* defined in this schema + +### xdm:inStorePurchase Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:order +### Order + +The placed order for one or more products. + +`xdm:order` +* is optional +* type: Order +* defined in this schema + +### xdm:order Type + + +* [Order](data/order.schema.md) – `https://ns.adobe.com/xdm/data/order` + + + + + +## xdm:productListAdds + +Addition of a product to the product list, for example a product is added to a shopping cart. + +`xdm:productListAdds` +* is optional +* type: Measure +* defined in this schema + +### xdm:productListAdds Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:productListOpens + +Initializations of a new product list, for example a shopping cart is created. + +`xdm:productListOpens` +* is optional +* type: Measure +* defined in this schema + +### xdm:productListOpens Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:productListRemovals + +Removal or removals of a product entry from a product list, for example a product is removed from a shopping cart. + +`xdm:productListRemovals` +* is optional +* type: Measure +* defined in this schema + +### xdm:productListRemovals Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:productListReopens + +A product list that was no longer accessible (abandoned) has been re-activated by the user. Example via a re-marketing activity. + +`xdm:productListReopens` +* is optional +* type: Measure +* defined in this schema + +### xdm:productListReopens Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:productListViews + +View or views of a product-list has occurred. + +`xdm:productListViews` +* is optional +* type: Measure +* defined in this schema + +### xdm:productListViews Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:productViews + +View or views of a product have occurred. + +`xdm:productViews` +* is optional +* type: Measure +* defined in this schema + +### xdm:productViews Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:purchases + +An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced. + +`xdm:purchases` +* is optional +* type: Measure +* defined in this schema + +### xdm:purchases Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:saveForLaters + +Product list is saved for future use, for example a product wish list. + +`xdm:saveForLaters` +* is optional +* type: Measure +* defined in this schema + +### xdm:saveForLaters Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + diff --git a/docs/reference/datatypes/consentstring.schema.json b/docs/reference/datatypes/consentstring.schema.json new file mode 100644 index 000000000..c35360350 --- /dev/null +++ b/docs/reference/datatypes/consentstring.schema.json @@ -0,0 +1,67 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/consentstring", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Consent String", + "type": "object", + "meta:extensible": true, + "description": "Consent String as presented by user along with standard information to help consent enforcer to parse the String.", + "definitions": { + "consentstring": { + "properties": { + "xdm:consentStandard": { + "title": "Standard for the consent", + "type": "string", + "description": "This helps determine the format of the consent string as set by consent management services." + }, + "xdm:consentStandardVersion": { + "title": "Standards Version", + "type": "string", + "description": "Standards version to accurately define the format of the consent string as set by consent management services." + }, + "xdm:consentStringValue": { + "title": "Consent String", + "type": "string", + "description": "Full consent string as provided by consent management services. Standard and Version help define how to parse this string." + }, + "xdm:gdprApplies": { + "title": "GDPR Applies", + "type": "boolean", + "default": false, + "description": "If this is true, it means this consent string needs to be processed for consent enforcement." + }, + "xdm:containsPersonalData": { + "title": "Contains personal data", + "type": "boolean", + "description": "If this is true, it means consent is coming with personal data." + } + }, + "required": [ + "xdm:gdprApplies" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/consentstring" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:consentStandard": "IAB TCF", + "xdm:consentStandardVersion": "2.0", + "xdm:consentStringValue": "BObdrPUOevsguAfDqFENCNAAAAAmeAAA.PVAfDObdrA.DqFENCAmeAENCDA", + "xdm:gdprApplies": true, + "xdm:containsPersonalData": false + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/consentstring.schema.md b/docs/reference/datatypes/consentstring.schema.md new file mode 100644 index 000000000..11b21225c --- /dev/null +++ b/docs/reference/datatypes/consentstring.schema.md @@ -0,0 +1,138 @@ + +# Consent String Schema + +``` +https://ns.adobe.com/xdm/context/consentstring +``` + +Consent String as presented by user along with standard information to help consent enforcer to parse the String. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/consentstring.schema.json](datatypes/consentstring.schema.json) | +## Schema Hierarchy + +* Consent String `https://ns.adobe.com/xdm/context/consentstring` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Consent String Example +```json +{ + "xdm:consentStandard": "IAB TCF", + "xdm:consentStandardVersion": "2.0", + "xdm:consentStringValue": "BObdrPUOevsguAfDqFENCNAAAAAmeAAA.PVAfDObdrA.DqFENCAmeAENCDA", + "xdm:gdprApplies": true, + "xdm:containsPersonalData": false +} +``` + +# Consent String Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:consentStandard](#xdmconsentstandard) | `string` | Optional | | Consent String (this schema) | +| [xdm:consentStandardVersion](#xdmconsentstandardversion) | `string` | Optional | | Consent String (this schema) | +| [xdm:consentStringValue](#xdmconsentstringvalue) | `string` | Optional | | Consent String (this schema) | +| [xdm:containsPersonalData](#xdmcontainspersonaldata) | `boolean` | Optional | | Consent String (this schema) | +| [xdm:gdprApplies](#xdmgdprapplies) | `boolean` | Optional | `false` | Consent String (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:consentStandard +### Standard for the consent + +This helps determine the format of the consent string as set by consent management services. + +`xdm:consentStandard` +* is optional +* type: `string` +* defined in this schema + +### xdm:consentStandard Type + + +`string` + + + + + + +## xdm:consentStandardVersion +### Standards Version + +Standards version to accurately define the format of the consent string as set by consent management services. + +`xdm:consentStandardVersion` +* is optional +* type: `string` +* defined in this schema + +### xdm:consentStandardVersion Type + + +`string` + + + + + + +## xdm:consentStringValue +### Consent String + +Full consent string as provided by consent management services. Standard and Version help define how to parse this string. + +`xdm:consentStringValue` +* is optional +* type: `string` +* defined in this schema + +### xdm:consentStringValue Type + + +`string` + + + + + + +## xdm:containsPersonalData +### Contains personal data + +If this is true, it means consent is coming with personal data. + +`xdm:containsPersonalData` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:containsPersonalData Type + + +`boolean` + + + + + +## xdm:gdprApplies +### GDPR Applies + +If this is true, it means this consent string needs to be processed for consent enforcement. + +`xdm:gdprApplies` +* is optional +* type: `boolean` +* default: `false` +* defined in this schema + +### xdm:gdprApplies Type + + +`boolean` + + + + diff --git a/docs/reference/datatypes/contact-lead.schema.json b/docs/reference/datatypes/contact-lead.schema.json new file mode 100644 index 000000000..4ce400c91 --- /dev/null +++ b/docs/reference/datatypes/contact-lead.schema.json @@ -0,0 +1,98 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/contact-lead", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Contact and Lead common B2B attributes", + "type": "object", + "description": "Common B2B attributes for contacts and leads.", + "definitions": { + "contact-lead": { + "properties": { + "xdm:type": { + "title": "Contact/Lead Type", + "description": "Type of the contact/lead.", + "type": "string" + }, + "xdm:sourceType": { + "title": "Source Type", + "description": "Type of Source system. It could be CRM or a in house system.", + "type": "string" + }, + "xdm:description": { + "title": "Contact/Lead Description", + "description": "Detailed description of Contact/Lead.", + "type": "string" + }, + "xdm:isDeleted": { + "title": "Deleted Indicator", + "description": "Indicator whether the instance was deleted.", + "type": "boolean" + }, + "xdm:ownerID": { + "title": "Owner ID", + "description": "The unique identofier for the Owner of the contact/lead record.", + "type": "string" + }, + "xdm:isEmailBounced": { + "title": "Email Bounced Indicator", + "description": "If bounce management is activated and an email is sent to a contact/lead, indicates whether the email bounced (true) or not (false).", + "type": "boolean" + }, + "xdm:emailBouncedDate": { + "title": "Email Bounced Date", + "description": "If bounce management is activated and an email is sent to a contact/lead, provides the date when the email was bounced.", + "type": "string", + "format": "date-time" + }, + "xdm:emailBouncedReason": { + "title": "Email Bounced Reason", + "description": "If bounce management is activated and an email is sent to a contact/lead, provides the reason for bounced email.", + "type": "string" + }, + "xdm:status": { + "title": "Lead/Contact Status", + "description": "Field recording the current marketing/sales status of the lead/contact.", + "type": "string" + }, + "xdm:timezone": { + "title": "Timezone", + "description": "Timezone of the contact's/lead's location.", + "type": "string" + }, + "xdm:jigsaw": { + "title": "Jigsaw", + "description": "Data.com key", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/contact-lead" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:type": "", + "xdm:ownerID": "", + "xdm:isDeleted": false, + "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00", + "xdm:emailBouncedReason": "Bounced Reason Here", + "xdm:isEmailBounced": true, + "xdm:description": "Contact/Lead description here", + "xdm:status": "Status", + "xdm:timezone": "", + "xdm:jigsaw": "12345" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/contact-lead.schema.md b/docs/reference/datatypes/contact-lead.schema.md new file mode 100644 index 000000000..52a93aa6c --- /dev/null +++ b/docs/reference/datatypes/contact-lead.schema.md @@ -0,0 +1,269 @@ + +# XDM Contact and Lead common B2B attributes Schema + +``` +https://ns.adobe.com/xdm/common/contact-lead +``` + +Common B2B attributes for contacts and leads. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [datatypes/contact-lead.schema.json](datatypes/contact-lead.schema.json) | +## Schema Hierarchy + +* XDM Contact and Lead common B2B attributes `https://ns.adobe.com/xdm/common/contact-lead` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## XDM Contact and Lead common B2B attributes Example +```json +{ + "xdm:type": "", + "xdm:ownerID": "", + "xdm:isDeleted": false, + "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00", + "xdm:emailBouncedReason": "Bounced Reason Here", + "xdm:isEmailBounced": true, + "xdm:description": "Contact/Lead description here", + "xdm:status": "Status", + "xdm:timezone": "", + "xdm:jigsaw": "12345" +} +``` + +# XDM Contact and Lead common B2B attributes Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:description](#xdmdescription) | `string` | Optional | XDM Contact and Lead common B2B attributes (this schema) | +| [xdm:emailBouncedDate](#xdmemailbounceddate) | `string` | Optional | XDM Contact and Lead common B2B attributes (this schema) | +| [xdm:emailBouncedReason](#xdmemailbouncedreason) | `string` | Optional | XDM Contact and Lead common B2B attributes (this schema) | +| [xdm:isDeleted](#xdmisdeleted) | `boolean` | Optional | XDM Contact and Lead common B2B attributes (this schema) | +| [xdm:isEmailBounced](#xdmisemailbounced) | `boolean` | Optional | XDM Contact and Lead common B2B attributes (this schema) | +| [xdm:jigsaw](#xdmjigsaw) | `string` | Optional | XDM Contact and Lead common B2B attributes (this schema) | +| [xdm:ownerID](#xdmownerid) | `string` | Optional | XDM Contact and Lead common B2B attributes (this schema) | +| [xdm:sourceType](#xdmsourcetype) | `string` | Optional | XDM Contact and Lead common B2B attributes (this schema) | +| [xdm:status](#xdmstatus) | `string` | Optional | XDM Contact and Lead common B2B attributes (this schema) | +| [xdm:timezone](#xdmtimezone) | `string` | Optional | XDM Contact and Lead common B2B attributes (this schema) | +| [xdm:type](#xdmtype) | `string` | Optional | XDM Contact and Lead common B2B attributes (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:description +### Contact/Lead Description + +Detailed description of Contact/Lead. + +`xdm:description` +* is optional +* type: `string` +* defined in this schema + +### xdm:description Type + + +`string` + + + + + + +## xdm:emailBouncedDate +### Email Bounced Date + +If bounce management is activated and an email is sent to a contact/lead, provides the date when the email was bounced. + +`xdm:emailBouncedDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:emailBouncedDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:emailBouncedReason +### Email Bounced Reason + +If bounce management is activated and an email is sent to a contact/lead, provides the reason for bounced email. + +`xdm:emailBouncedReason` +* is optional +* type: `string` +* defined in this schema + +### xdm:emailBouncedReason Type + + +`string` + + + + + + +## xdm:isDeleted +### Deleted Indicator + +Indicator whether the instance was deleted. + +`xdm:isDeleted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isDeleted Type + + +`boolean` + + + + + +## xdm:isEmailBounced +### Email Bounced Indicator + +If bounce management is activated and an email is sent to a contact/lead, indicates whether the email bounced (true) or not (false). + +`xdm:isEmailBounced` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isEmailBounced Type + + +`boolean` + + + + + +## xdm:jigsaw +### Jigsaw + +Data.com key + +`xdm:jigsaw` +* is optional +* type: `string` +* defined in this schema + +### xdm:jigsaw Type + + +`string` + + + + + + +## xdm:ownerID +### Owner ID + +The unique identofier for the Owner of the contact/lead record. + +`xdm:ownerID` +* is optional +* type: `string` +* defined in this schema + +### xdm:ownerID Type + + +`string` + + + + + + +## xdm:sourceType +### Source Type + +Type of Source system. It could be CRM or a in house system. + +`xdm:sourceType` +* is optional +* type: `string` +* defined in this schema + +### xdm:sourceType Type + + +`string` + + + + + + +## xdm:status +### Lead/Contact Status + +Field recording the current marketing/sales status of the lead/contact. + +`xdm:status` +* is optional +* type: `string` +* defined in this schema + +### xdm:status Type + + +`string` + + + + + + +## xdm:timezone +### Timezone + +Timezone of the contact's/lead's location. + +`xdm:timezone` +* is optional +* type: `string` +* defined in this schema + +### xdm:timezone Type + + +`string` + + + + + + +## xdm:type +### Contact/Lead Type + +Type of the contact/lead. + +`xdm:type` +* is optional +* type: `string` +* defined in this schema + +### xdm:type Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/data/bounces.schema.json b/docs/reference/datatypes/data/bounces.schema.json new file mode 100644 index 000000000..733fa1b14 --- /dev/null +++ b/docs/reference/datatypes/data/bounces.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Bounces", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The direct-marketing metric bounces describes the number of asynchronous messages that have been rejected by the receiving system.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:bounces", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "direct-marketing metric: bounces", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "direct-marketing metric: bounces", + "@id": "xdm:bounces", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/bounces.schema.md b/docs/reference/datatypes/data/bounces.schema.md new file mode 100644 index 000000000..05362d40c --- /dev/null +++ b/docs/reference/datatypes/data/bounces.schema.md @@ -0,0 +1,152 @@ + +# Bounces Schema + +``` +https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces +``` + +The direct-marketing metric bounces describes the number of asynchronous messages that have been rejected by the receiving system. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/bounces.schema.json](datatypes/data/bounces.schema.json) | +## Schema Hierarchy + +* Bounces `https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Bounces Example +```json +{ + "schema:name": "direct-marketing metric: bounces", + "@id": "xdm:bounces", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Bounces Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/cart-abandons.schema.json b/docs/reference/datatypes/data/cart-abandons.schema.json new file mode 100644 index 000000000..01176ac3d --- /dev/null +++ b/docs/reference/datatypes/data/cart-abandons.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/cart-abandons", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Cart Abandons", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Number of cart abandons for which a product list has been identified as no longer purchasable or accessible by the user without the user re-creating the product list from scratch.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:cartAbandons", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "commerce metric: cartAbandons", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "commerce metric: cartAbandons", + "@id": "xdm:cartAbandons", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/cart-abandons.schema.md b/docs/reference/datatypes/data/cart-abandons.schema.md new file mode 100644 index 000000000..c8ffcd7be --- /dev/null +++ b/docs/reference/datatypes/data/cart-abandons.schema.md @@ -0,0 +1,152 @@ + +# Cart Abandons Schema + +``` +https://ns.adobe.com/xdm/data/metrics/cart-abandons +``` + +Number of cart abandons for which a product list has been identified as no longer purchasable or accessible by the user without the user re-creating the product list from scratch. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/cart-abandons.schema.json](datatypes/data/cart-abandons.schema.json) | +## Schema Hierarchy + +* Cart Abandons `https://ns.adobe.com/xdm/data/metrics/cart-abandons` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Cart Abandons Example +```json +{ + "schema:name": "commerce metric: cartAbandons", + "@id": "xdm:cartAbandons", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Cart Abandons Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/checkouts.schema.json b/docs/reference/datatypes/data/checkouts.schema.json new file mode 100644 index 000000000..5fa0fba5c --- /dev/null +++ b/docs/reference/datatypes/data/checkouts.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/checkouts", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Checkouts", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Number of actions during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:checkouts", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "commerce metric: checkouts", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "commerce metric: checkouts", + "@id": "xdm:checkouts", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/checkouts.schema.md b/docs/reference/datatypes/data/checkouts.schema.md new file mode 100644 index 000000000..8f2fb82c0 --- /dev/null +++ b/docs/reference/datatypes/data/checkouts.schema.md @@ -0,0 +1,152 @@ + +# Checkouts Schema + +``` +https://ns.adobe.com/xdm/data/metrics/checkouts +``` + +Number of actions during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/checkouts.schema.json](datatypes/data/checkouts.schema.json) | +## Schema Hierarchy + +* Checkouts `https://ns.adobe.com/xdm/data/metrics/checkouts` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Checkouts Example +```json +{ + "schema:name": "commerce metric: checkouts", + "@id": "xdm:checkouts", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Checkouts Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/datasource.schema.json b/docs/reference/datatypes/data/datasource.schema.json new file mode 100644 index 000000000..7ebaec0df --- /dev/null +++ b/docs/reference/datatypes/data/datasource.schema.json @@ -0,0 +1,54 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/datasource", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Data Source", + "type": "object", + "description": "The data source acts as a namespace or unique identifier associated with a collection of data. Each EndUserID is associated with a given data source. A user can create and obtain information about a data source during the solution onboarding.\n", + "definitions": { + "datasource": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "The unique ID of this data source. This would be provided by the individual or system that created the data source.\n" + }, + "xdm:code": { + "title": "Code", + "type": "string", + "description": "The code is a shortcut to the full @id and at least one of the code or @id can be used. Sometimes, this code is referred to as the data source integration code." + }, + "xdm:tags": { + "title": "Tags", + "type": "array", + "description": "Tags are used to indicate how the aliases represented by a given data\nsource should be interpreted by applications using those aliases.\n\nExamples:\n\n* `isAVID`: data sources representing Analytics visitor IDs.\n* `isCRSKey`: data sources representing aliases that should be used as keys in CRS.\n\nTags are set when the data source is created but they are also included in\npipeline messages when referencing a given data source.\n", + "uniqueItems": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "@id" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/datasource" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/datasource.schema.md b/docs/reference/datatypes/data/datasource.schema.md new file mode 100644 index 000000000..35c65fa07 --- /dev/null +++ b/docs/reference/datatypes/data/datasource.schema.md @@ -0,0 +1,109 @@ + +# Data Source Schema + +``` +https://ns.adobe.com/xdm/data/datasource +``` + +The data source acts as a namespace or unique identifier associated with a collection of data. Each EndUserID is associated with a given data source. A user can create and obtain information about a data source during the solution onboarding. + + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/datasource.schema.json](datatypes/data/datasource.schema.json) | + +## Data Source Example +```json +{ + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" +} +``` + +# Data Source Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Data Source (this schema) | +| [xdm:code](#xdmcode) | `string` | Optional | Data Source (this schema) | +| [xdm:tags](#xdmtags) | `string[]` | Optional | Data Source (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The unique ID of this data source. This would be provided by the individual or system that created the data source. + + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:code +### Code + +The code is a shortcut to the full @id and at least one of the code or @id can be used. Sometimes, this code is referred to as the data source integration code. + +`xdm:code` +* is optional +* type: `string` +* defined in this schema + +### xdm:code Type + + +`string` + + + + + + +## xdm:tags +### Tags + +Tags are used to indicate how the aliases represented by a given data +source should be interpreted by applications using those aliases. + +Examples: + +* `isAVID`: data sources representing Analytics visitor IDs. +* `isCRSKey`: data sources representing aliases that should be used as keys in CRS. + +Tags are set when the data source is created but they are also included in +pipeline messages when referencing a given data source. + + +`xdm:tags` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:tags Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + + + diff --git a/docs/reference/datatypes/data/impressions.schema.json b/docs/reference/datatypes/data/impressions.schema.json new file mode 100644 index 000000000..557b8853a --- /dev/null +++ b/docs/reference/datatypes/data/impressions.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/advertising/impressions", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Impressions", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The metric impressions describes the number of digital assets rendered.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:impressions", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "metric: impressions", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "metric: impressions", + "@id": "xdm:impressions", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/impressions.schema.md b/docs/reference/datatypes/data/impressions.schema.md new file mode 100644 index 000000000..ab86747b2 --- /dev/null +++ b/docs/reference/datatypes/data/impressions.schema.md @@ -0,0 +1,152 @@ + +# Impressions Schema + +``` +https://ns.adobe.com/xdm/data/metrics/advertising/impressions +``` + +The metric impressions describes the number of digital assets rendered. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/impressions.schema.json](datatypes/data/impressions.schema.json) | +## Schema Hierarchy + +* Impressions `https://ns.adobe.com/xdm/data/metrics/advertising/impressions` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Impressions Example +```json +{ + "schema:name": "metric: impressions", + "@id": "xdm:impressions", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Impressions Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/linkclicks.schema.json b/docs/reference/datatypes/data/linkclicks.schema.json new file mode 100644 index 000000000..c0d254b3f --- /dev/null +++ b/docs/reference/datatypes/data/linkclicks.schema.json @@ -0,0 +1,65 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/web/linkclicks", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Link-Clicks", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The web metric `link-clicks` describes the number of clicks on a link on a web page.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "const": "xdm:linkClicks", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "web metric: linkClicks", + "description": "The web metric `link-clicks` describes the number of clicks on a link on a web page." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "web metric: linkClicks", + "@id": "xdm:linkClicks", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/linkclicks.schema.md b/docs/reference/datatypes/data/linkclicks.schema.md new file mode 100644 index 000000000..7c4d053bf --- /dev/null +++ b/docs/reference/datatypes/data/linkclicks.schema.md @@ -0,0 +1,152 @@ + +# Link-Clicks Schema + +``` +https://ns.adobe.com/xdm/data/metrics/web/linkclicks +``` + +The web metric `link-clicks` describes the number of clicks on a link on a web page. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/linkclicks.schema.json](datatypes/data/linkclicks.schema.json) | +## Schema Hierarchy + +* Link-Clicks `https://ns.adobe.com/xdm/data/metrics/web/linkclicks` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Link-Clicks Example +```json +{ + "schema:name": "web metric: linkClicks", + "@id": "xdm:linkClicks", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Link-Clicks Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/measure.schema.json b/docs/reference/datatypes/data/measure.schema.json new file mode 100644 index 000000000..8cbb84e85 --- /dev/null +++ b/docs/reference/datatypes/data/measure.schema.json @@ -0,0 +1,43 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/measure", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Measure", + "type": "object", + "meta:extensible": false, + "description": "A measure is a concrete quantifiable data point of a particular metric.\n\nIt has a value, and a unique identifier.\n", + "definitions": { + "measure": { + "properties": { + "xdm:id": { + "title": "Unique Identifier", + "type": "string", + "description": "Unique identifier of the measure. In cases of data collection using lossy communication channels, such as mobile apps or websites with offline functionality, where transmission of measures cannot be ensured, this property contains a client-generated, unique ID of the measure taken. It is best practice to make this sufficiently long to ensure enough entropy. Additionally, if information such as time stamp, device ID, IP, or MAC address, or other potentially user-identifying values are incorporated in the generation of the xdm:id, the result should be hashed, so that no PII is encoded in the value, as the goal is not to identify user or device, but the specific measure in time." + }, + "xdm:value": { + "type": "number", + "description": "The quantifiable value of this measure." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/measure" + } + ], + "required": [ + "xdm:value" + ], + "meta:status": "stable", + "examples": [ + { + "xdm:value": 175 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/measure.schema.md b/docs/reference/datatypes/data/measure.schema.md new file mode 100644 index 000000000..511dbb2e4 --- /dev/null +++ b/docs/reference/datatypes/data/measure.schema.md @@ -0,0 +1,69 @@ + +# Measure Schema + +``` +https://ns.adobe.com/xdm/data/measure +``` + +A measure is a concrete quantifiable data point of a particular metric. + +It has a value, and a unique identifier. + + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/measure.schema.json](datatypes/data/measure.schema.json) | + +## Measure Example +```json +{ + "xdm:value": 175 +} +``` + +# Measure Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:id](#xdmid) | `string` | Optional | Measure (this schema) | +| [xdm:value](#xdmvalue) | `number` | **Required** | Measure (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:id +### Unique Identifier + +Unique identifier of the measure. In cases of data collection using lossy communication channels, such as mobile apps or websites with offline functionality, where transmission of measures cannot be ensured, this property contains a client-generated, unique ID of the measure taken. It is best practice to make this sufficiently long to ensure enough entropy. Additionally, if information such as time stamp, device ID, IP, or MAC address, or other potentially user-identifying values are incorporated in the generation of the xdm:id, the result should be hashed, so that no PII is encoded in the value, as the goal is not to identify user or device, but the specific measure in time. + +`xdm:id` +* is optional +* type: `string` +* defined in this schema + +### xdm:id Type + + +`string` + + + + + + +## xdm:value + +The quantifiable value of this measure. + +`xdm:value` +* is **required** +* type: `number` +* defined in this schema + +### xdm:value Type + + +`number` + + + + + diff --git a/docs/reference/datatypes/data/metricdefinition.schema.json b/docs/reference/datatypes/data/metricdefinition.schema.json new file mode 100644 index 000000000..07dc1286a --- /dev/null +++ b/docs/reference/datatypes/data/metricdefinition.schema.json @@ -0,0 +1,72 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metricdefinition", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Metric Definition", + "type": "object", + "meta:extensible": true, + "description": "A metric definition is a definition of a measurable or countable quantity.\n\nA metric definition consists of a measurement and a dimension.\nFor easier identification, metrics have a name and a unique URI that can be used when referring to the metric definition.\n\nThrough XDM's extensibility mechanism, new metrics can be defined by extending `Metric Definition`.\n", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "examples": [ + "distance", + "time", + "price", + "count" + ] + }, + "xdm:unit": { + "type": "string", + "description": "The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null)", + "examples": [ + "m", + "kg", + "s", + "USD" + ] + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "Example Metric", + "@id": "https://ns.adobe.com/xdm/data/example-metric", + "xdm:measurement": "weight", + "xdm:unit": "kg" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/metricdefinition.schema.md b/docs/reference/datatypes/data/metricdefinition.schema.md new file mode 100644 index 000000000..b1786d795 --- /dev/null +++ b/docs/reference/datatypes/data/metricdefinition.schema.md @@ -0,0 +1,158 @@ + +# Metric Definition Schema + +``` +https://ns.adobe.com/xdm/data/metricdefinition +``` + +A metric definition is a definition of a measurable or countable quantity. + +A metric definition consists of a measurement and a dimension. +For easier identification, metrics have a name and a unique URI that can be used when referring to the metric definition. + +Through XDM's extensibility mechanism, new metrics can be defined by extending `Metric Definition`. + + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/metricdefinition.schema.json](datatypes/data/metricdefinition.schema.json) | +## Schema Hierarchy + +* Metric Definition `https://ns.adobe.com/xdm/data/metricdefinition` + * [Extensibility base schema](../extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Metric Definition Example +```json +{ + "schema:name": "Example Metric", + "@id": "https://ns.adobe.com/xdm/data/example-metric", + "xdm:measurement": "weight", + "xdm:unit": "kg" +} +``` + +# Metric Definition Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | Metric Definition (this schema) | +| [schema:name](#schemaname) | `string` | **Required** | Metric Definition (this schema) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | Metric Definition (this schema) | +| [xdm:unit](#xdmunit) | `string` | **Required** | Metric Definition (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in this schema + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in this schema + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in this schema + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/mirror-pages.schema.json b/docs/reference/datatypes/data/mirror-pages.schema.json new file mode 100644 index 000000000..5678d13bd --- /dev/null +++ b/docs/reference/datatypes/data/mirror-pages.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/mirror-pages", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Mirror Pages", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The direct-marketing metric `mirror-page`s describes the number of mirror pages for which a link to the online mirror page of a message has been clicked.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:mirrorPages", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "direct-marketing metric: mirrorPages", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "direct-marketing metric: mirrorPages", + "@id": "xdm:mirrorPages", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/mirror-pages.schema.md b/docs/reference/datatypes/data/mirror-pages.schema.md new file mode 100644 index 000000000..de9fe8323 --- /dev/null +++ b/docs/reference/datatypes/data/mirror-pages.schema.md @@ -0,0 +1,152 @@ + +# Mirror Pages Schema + +``` +https://ns.adobe.com/xdm/data/metrics/direct-marketing/mirror-pages +``` + +The direct-marketing metric `mirror-page`s describes the number of mirror pages for which a link to the online mirror page of a message has been clicked. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/mirror-pages.schema.json](datatypes/data/mirror-pages.schema.json) | +## Schema Hierarchy + +* Mirror Pages `https://ns.adobe.com/xdm/data/metrics/direct-marketing/mirror-pages` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Mirror Pages Example +```json +{ + "schema:name": "direct-marketing metric: mirrorPages", + "@id": "xdm:mirrorPages", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Mirror Pages Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/non-deliverables.schema.json b/docs/reference/datatypes/data/non-deliverables.schema.json new file mode 100644 index 000000000..4c73be66d --- /dev/null +++ b/docs/reference/datatypes/data/non-deliverables.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/non-deliverables", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Non-Deliverables", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The direct-marketing metric `non-deliverables` describes the umber of asynchronous messages that failed to deliver in a way that indicates that no future messages will be deliverable either to this address.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:nonDeliverables", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "direct-marketing metric: nonDeliverables", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "direct-marketing metric: nonDeliverables", + "@id": "xdm:nonDeliverables", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/non-deliverables.schema.md b/docs/reference/datatypes/data/non-deliverables.schema.md new file mode 100644 index 000000000..e330b5311 --- /dev/null +++ b/docs/reference/datatypes/data/non-deliverables.schema.md @@ -0,0 +1,152 @@ + +# Non-Deliverables Schema + +``` +https://ns.adobe.com/xdm/data/metrics/direct-marketing/non-deliverables +``` + +The direct-marketing metric `non-deliverables` describes the umber of asynchronous messages that failed to deliver in a way that indicates that no future messages will be deliverable either to this address. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/non-deliverables.schema.json](datatypes/data/non-deliverables.schema.json) | +## Schema Hierarchy + +* Non-Deliverables `https://ns.adobe.com/xdm/data/metrics/direct-marketing/non-deliverables` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Non-Deliverables Example +```json +{ + "schema:name": "direct-marketing metric: nonDeliverables", + "@id": "xdm:nonDeliverables", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Non-Deliverables Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/not-sent.schema.json b/docs/reference/datatypes/data/not-sent.schema.json new file mode 100644 index 000000000..d4f76ad53 --- /dev/null +++ b/docs/reference/datatypes/data/not-sent.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/notSent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Not Sent", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The direct-marketing metric `not-sent` describes the number of asynchronous messages (email, SMS, MMS etc) that have not been dispatched to an recipient's account/address/device due to cancellation or expiration of the marketing activity.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:notSent", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "direct-marketing metric: notSent", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "direct-marketing metric: notSent", + "@id": "xdm:notSent", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/not-sent.schema.md b/docs/reference/datatypes/data/not-sent.schema.md new file mode 100644 index 000000000..bd99a9736 --- /dev/null +++ b/docs/reference/datatypes/data/not-sent.schema.md @@ -0,0 +1,152 @@ + +# Not Sent Schema + +``` +https://ns.adobe.com/xdm/data/metrics/direct-marketing/notSent +``` + +The direct-marketing metric `not-sent` describes the number of asynchronous messages (email, SMS, MMS etc) that have not been dispatched to an recipient's account/address/device due to cancellation or expiration of the marketing activity. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/not-sent.schema.json](datatypes/data/not-sent.schema.json) | +## Schema Hierarchy + +* Not Sent `https://ns.adobe.com/xdm/data/metrics/direct-marketing/notSent` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Not Sent Example +```json +{ + "schema:name": "direct-marketing metric: notSent", + "@id": "xdm:notSent", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Not Sent Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/opens.schema.json b/docs/reference/datatypes/data/opens.schema.json new file mode 100644 index 000000000..eb493946b --- /dev/null +++ b/docs/reference/datatypes/data/opens.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/opens", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Opens", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The direct-marketing metric `opens` describes the number of times the direct marketing messages (email, SMS, Push Notifications etc) have been opened/swiped/touched by the recipients.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:opens", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "direct-marketing metric: opens", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "direct-marketing metric: opens", + "@id": "xdm:opens", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/opens.schema.md b/docs/reference/datatypes/data/opens.schema.md new file mode 100644 index 000000000..455e6e72b --- /dev/null +++ b/docs/reference/datatypes/data/opens.schema.md @@ -0,0 +1,152 @@ + +# Opens Schema + +``` +https://ns.adobe.com/xdm/data/metrics/direct-marketing/opens +``` + +The direct-marketing metric `opens` describes the number of times the direct marketing messages (email, SMS, Push Notifications etc) have been opened/swiped/touched by the recipients. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/opens.schema.json](datatypes/data/opens.schema.json) | +## Schema Hierarchy + +* Opens `https://ns.adobe.com/xdm/data/metrics/direct-marketing/opens` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Opens Example +```json +{ + "schema:name": "direct-marketing metric: opens", + "@id": "xdm:opens", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Opens Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/order.schema.json b/docs/reference/datatypes/data/order.schema.json new file mode 100644 index 000000000..5c59ad928 --- /dev/null +++ b/docs/reference/datatypes/data/order.schema.json @@ -0,0 +1,80 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/order", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Order", + "type": "object", + "description": "The order placed for a product list.", + "definitions": { + "order": { + "properties": { + "xdm:purchaseID": { + "title": "Purchase ID", + "type": "string", + "description": "Unique identifier assigned by the seller for this purchase or contract. There is no guarantee that the ID is unique." + }, + "xdm:purchaseOrderNumber": { + "title": "Purchase Order Number", + "type": "string", + "description": "Unique identifier assigned by the purchaser for this purchase or contract." + }, + "xdm:payments": { + "title": "Payment List", + "type": "array", + "description": "The list of payments for this order.", + "items": { + "$ref": "https://ns.adobe.com/xdm/data/paymentitem" + } + }, + "xdm:currencyCode": { + "title": "Currency", + "type": "string", + "examples": [ + "USD", + "EUR" + ], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 currency code used for the order totals." + }, + "xdm:priceTotal": { + "title": "Price Total", + "type": "number", + "description": "The total price of this order after all discounts and taxes have been applied." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/order" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 899.99, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionID": "transactid-a222", + "xdm:paymentAmount": 99.99, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 999.98 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/order.schema.md b/docs/reference/datatypes/data/order.schema.md new file mode 100644 index 000000000..1ab13912d --- /dev/null +++ b/docs/reference/datatypes/data/order.schema.md @@ -0,0 +1,172 @@ + +# Order Schema + +``` +https://ns.adobe.com/xdm/data/order +``` + +The order placed for a product list. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/order.schema.json](datatypes/data/order.schema.json) | + +## Order Example +```json +{ + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 899.99, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionID": "transactid-a222", + "xdm:paymentAmount": 99.99, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 999.98 +} +``` + +# Order Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:currencyCode](#xdmcurrencycode) | `string` | Optional | Order (this schema) | +| [xdm:payments](#xdmpayments) | Payment Item | Optional | Order (this schema) | +| [xdm:priceTotal](#xdmpricetotal) | `number` | Optional | Order (this schema) | +| [xdm:purchaseID](#xdmpurchaseid) | `string` | Optional | Order (this schema) | +| [xdm:purchaseOrderNumber](#xdmpurchaseordernumber) | `string` | Optional | Order (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:currencyCode +### Currency + +The ISO 4217 currency code used for the order totals. + +`xdm:currencyCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:currencyCode Type + + +`string` + + +All instances must conform to this regular expression +```regex +^[A-Z]{3}$ +``` + +* test example: [USD](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=USD) +* test example: [EUR](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=EUR) + + + + +### xdm:currencyCode Examples + +```json +"USD" +``` + +```json +"EUR" +``` + + + +## xdm:payments +### Payment List + +The list of payments for this order. + +`xdm:payments` +* is optional +* type: Payment Item + +* defined in this schema + +### xdm:payments Type + + +Array type: Payment Item + +All items must be of the type: +* [Payment Item](paymentitem.schema.md) – `https://ns.adobe.com/xdm/data/paymentitem` + + + + + + + + +## xdm:priceTotal +### Price Total + +The total price of this order after all discounts and taxes have been applied. + +`xdm:priceTotal` +* is optional +* type: `number` +* defined in this schema + +### xdm:priceTotal Type + + +`number` + + + + + + +## xdm:purchaseID +### Purchase ID + +Unique identifier assigned by the seller for this purchase or contract. There is no guarantee that the ID is unique. + +`xdm:purchaseID` +* is optional +* type: `string` +* defined in this schema + +### xdm:purchaseID Type + + +`string` + + + + + + +## xdm:purchaseOrderNumber +### Purchase Order Number + +Unique identifier assigned by the purchaser for this purchase or contract. + +`xdm:purchaseOrderNumber` +* is optional +* type: `string` +* defined in this schema + +### xdm:purchaseOrderNumber Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/data/pageviews.schema.json b/docs/reference/datatypes/data/pageviews.schema.json new file mode 100644 index 000000000..7935523a6 --- /dev/null +++ b/docs/reference/datatypes/data/pageviews.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/web/pageviews", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Page Views", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The web metric `pageViews` describes the number of impressions of a web page.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:pageViews", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "web metric: pageViews", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "web metric: pageViews", + "@id": "xdm:pageViews", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/pageviews.schema.md b/docs/reference/datatypes/data/pageviews.schema.md new file mode 100644 index 000000000..8caca9cf9 --- /dev/null +++ b/docs/reference/datatypes/data/pageviews.schema.md @@ -0,0 +1,152 @@ + +# Page Views Schema + +``` +https://ns.adobe.com/xdm/data/metrics/web/pageviews +``` + +The web metric `pageViews` describes the number of impressions of a web page. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/pageviews.schema.json](datatypes/data/pageviews.schema.json) | +## Schema Hierarchy + +* Page Views `https://ns.adobe.com/xdm/data/metrics/web/pageviews` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Page Views Example +```json +{ + "schema:name": "web metric: pageViews", + "@id": "xdm:pageViews", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Page Views Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/paymentitem.schema.json b/docs/reference/datatypes/data/paymentitem.schema.json new file mode 100644 index 000000000..e9b5fb0af --- /dev/null +++ b/docs/reference/datatypes/data/paymentitem.schema.json @@ -0,0 +1,70 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/paymentitem", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Payment Item", + "type": "object", + "description": "A payment associated with an order that defines the type of payment, the amount and the associated currency.", + "definitions": { + "paymentitem": { + "properties": { + "xdm:transactionID": { + "title": "Transaction ID", + "type": "string", + "description": "The unique transaction identifier for this payment item." + }, + "xdm:paymentAmount": { + "title": "Payment Amount", + "type": "number", + "description": "The value of the payment." + }, + "xdm:paymentType": { + "title": "Payment Type", + "type": "string", + "description": "The method of payment for this order. Enumerated, custom values allowed.", + "default": "other", + "meta:enum": { + "cash": "Cash", + "credit_card": "Credit Card", + "debit_card": "Debit Card", + "gift_card": "Gift Card", + "check": "Check", + "paypal": "PayPal", + "wire_transfer": "Wire Transfer", + "credit_card_reference": "Credit Card Reference Transaction", + "other": "Other" + } + }, + "xdm:currencyCode": { + "title": "Currency Code", + "type": "string", + "examples": [ + "USD", + "EUR" + ], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 currency code used for this payment item." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/paymentitem" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:transactionID": "transactid-a12345", + "xdm:paymentAmount": 333.99, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/paymentitem.schema.md b/docs/reference/datatypes/data/paymentitem.schema.md new file mode 100644 index 000000000..87d55ef4f --- /dev/null +++ b/docs/reference/datatypes/data/paymentitem.schema.md @@ -0,0 +1,145 @@ + +# Payment Item Schema + +``` +https://ns.adobe.com/xdm/data/paymentitem +``` + +A payment associated with an order that defines the type of payment, the amount and the associated currency. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/paymentitem.schema.json](datatypes/data/paymentitem.schema.json) | + +## Payment Item Example +```json +{ + "xdm:transactionID": "transactid-a12345", + "xdm:paymentAmount": 333.99, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" +} +``` + +# Payment Item Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:currencyCode](#xdmcurrencycode) | `string` | Optional | | Payment Item (this schema) | +| [xdm:paymentAmount](#xdmpaymentamount) | `number` | Optional | | Payment Item (this schema) | +| [xdm:paymentType](#xdmpaymenttype) | `string` | Optional | `"other"` | Payment Item (this schema) | +| [xdm:transactionID](#xdmtransactionid) | `string` | Optional | | Payment Item (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:currencyCode +### Currency Code + +The ISO 4217 currency code used for this payment item. + +`xdm:currencyCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:currencyCode Type + + +`string` + + +All instances must conform to this regular expression +```regex +^[A-Z]{3}$ +``` + +* test example: [USD](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=USD) +* test example: [EUR](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=EUR) + + + + +### xdm:currencyCode Examples + +```json +"USD" +``` + +```json +"EUR" +``` + + + +## xdm:paymentAmount +### Payment Amount + +The value of the payment. + +`xdm:paymentAmount` +* is optional +* type: `number` +* defined in this schema + +### xdm:paymentAmount Type + + +`number` + + + + + + +## xdm:paymentType +### Payment Type + +The method of payment for this order. Enumerated, custom values allowed. + +`xdm:paymentType` +* is optional +* type: `string` +* default: `"other"` +* defined in this schema + +### xdm:paymentType Type + + +`string` + + + +### xdm:paymentType Known Values +| Value | Description | +|-------|-------------| +| `cash` | Cash | +| `credit_card` | Credit Card | +| `debit_card` | Debit Card | +| `gift_card` | Gift Card | +| `check` | Check | +| `paypal` | PayPal | +| `wire_transfer` | Wire Transfer | +| `credit_card_reference` | Credit Card Reference Transaction | +| `other` | Other | + + + + +## xdm:transactionID +### Transaction ID + +The unique transaction identifier for this payment item. + +`xdm:transactionID` +* is optional +* type: `string` +* defined in this schema + +### xdm:transactionID Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/data/poi-entries.schema.json b/docs/reference/datatypes/data/poi-entries.schema.json new file mode 100644 index 000000000..6664f8749 --- /dev/null +++ b/docs/reference/datatypes/data/poi-entries.schema.json @@ -0,0 +1,65 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/placecontext/poi-entries", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Point of Interest (POI) Entries", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The place context metric `poi-entries` describes the number of times a person has left a point of interest (POI).", + "definitions": { + "metric": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "const": "xdm:poiEntries", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "placecontext: poiEntries", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metric" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "placecontext: poiEntries", + "@id": "xdm:poiEntries", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/poi-entries.schema.md b/docs/reference/datatypes/data/poi-entries.schema.md new file mode 100644 index 000000000..321cc889c --- /dev/null +++ b/docs/reference/datatypes/data/poi-entries.schema.md @@ -0,0 +1,152 @@ + +# Point of Interest (POI) Entries Schema + +``` +https://ns.adobe.com/xdm/data/metrics/placecontext/poi-entries +``` + +The place context metric `poi-entries` describes the number of times a person has left a point of interest (POI). + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/poi-entries.schema.json](datatypes/data/poi-entries.schema.json) | +## Schema Hierarchy + +* Point of Interest (POI) Entries `https://ns.adobe.com/xdm/data/metrics/placecontext/poi-entries` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Point of Interest (POI) Entries Example +```json +{ + "schema:name": "placecontext: poiEntries", + "@id": "xdm:poiEntries", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Point of Interest (POI) Entries Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/poi-exits.schema.json b/docs/reference/datatypes/data/poi-exits.schema.json new file mode 100644 index 000000000..01af12998 --- /dev/null +++ b/docs/reference/datatypes/data/poi-exits.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/placecontext/poi-exits", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Point of Interest (POI) Exits", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The place context metric `poi-exits` describes the number of times a person has left a point of interest (POI).", + "definitions": { + "metric": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:poiExits", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "placecontext: poiExits", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metric" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "placecontext: poiExits", + "@id": "xdm:poiExits", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/poi-exits.schema.md b/docs/reference/datatypes/data/poi-exits.schema.md new file mode 100644 index 000000000..a3c83b6ce --- /dev/null +++ b/docs/reference/datatypes/data/poi-exits.schema.md @@ -0,0 +1,152 @@ + +# Point of Interest (POI) Exits Schema + +``` +https://ns.adobe.com/xdm/data/metrics/placecontext/poi-exits +``` + +The place context metric `poi-exits` describes the number of times a person has left a point of interest (POI). + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/poi-exits.schema.json](datatypes/data/poi-exits.schema.json) | +## Schema Hierarchy + +* Point of Interest (POI) Exits `https://ns.adobe.com/xdm/data/metrics/placecontext/poi-exits` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Point of Interest (POI) Exits Example +```json +{ + "schema:name": "placecontext: poiExits", + "@id": "xdm:poiExits", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Point of Interest (POI) Exits Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/product-list-adds.schema.json b/docs/reference/datatypes/data/product-list-adds.schema.json new file mode 100644 index 000000000..68ec74998 --- /dev/null +++ b/docs/reference/datatypes/data/product-list-adds.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/product-list-adds", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product List Adds", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The commerce metric `productListAdds` describes the number of times a product has been added to a product list. The most common case is adding an item to the shopping cart.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:productListAdds", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "commerce metric: productListAdds", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "commerce metric: productListAdds", + "@id": "xdm:productListAdds", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/product-list-adds.schema.md b/docs/reference/datatypes/data/product-list-adds.schema.md new file mode 100644 index 000000000..cea6780b8 --- /dev/null +++ b/docs/reference/datatypes/data/product-list-adds.schema.md @@ -0,0 +1,152 @@ + +# Product List Adds Schema + +``` +https://ns.adobe.com/xdm/data/metrics/product-list-adds +``` + +The commerce metric `productListAdds` describes the number of times a product has been added to a product list. The most common case is adding an item to the shopping cart. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/product-list-adds.schema.json](datatypes/data/product-list-adds.schema.json) | +## Schema Hierarchy + +* Product List Adds `https://ns.adobe.com/xdm/data/metrics/product-list-adds` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Product List Adds Example +```json +{ + "schema:name": "commerce metric: productListAdds", + "@id": "xdm:productListAdds", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Product List Adds Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/product-list-opens.schema.json b/docs/reference/datatypes/data/product-list-opens.schema.json new file mode 100644 index 000000000..3516c0836 --- /dev/null +++ b/docs/reference/datatypes/data/product-list-opens.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/product-list-opens", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product List Opens", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The commerce metric `product-list-opens` describes how many new product lists have been created. The most common case is the creation of a new shopping cart by putting the first item into the shopping cart.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:productListOpens", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "commerce metric: productListOpens", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "commerce metric: productListOpens", + "@id": "xdm:productListOpens", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/product-list-opens.schema.md b/docs/reference/datatypes/data/product-list-opens.schema.md new file mode 100644 index 000000000..6e4c2f7f9 --- /dev/null +++ b/docs/reference/datatypes/data/product-list-opens.schema.md @@ -0,0 +1,152 @@ + +# Product List Opens Schema + +``` +https://ns.adobe.com/xdm/data/metrics/product-list-opens +``` + +The commerce metric `product-list-opens` describes how many new product lists have been created. The most common case is the creation of a new shopping cart by putting the first item into the shopping cart. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/product-list-opens.schema.json](datatypes/data/product-list-opens.schema.json) | +## Schema Hierarchy + +* Product List Opens `https://ns.adobe.com/xdm/data/metrics/product-list-opens` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Product List Opens Example +```json +{ + "schema:name": "commerce metric: productListOpens", + "@id": "xdm:productListOpens", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Product List Opens Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/product-list-removals.schema.json b/docs/reference/datatypes/data/product-list-removals.schema.json new file mode 100644 index 000000000..7badfb4b4 --- /dev/null +++ b/docs/reference/datatypes/data/product-list-removals.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/product-list-removals", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product List Removals", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The commerce metric `productListRemovals` describes the number of times a product has been removed from a product list. The most common use case is the removal of a product from the shopping cart.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:productListRemovals", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "commerce metric: productListRemovals", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "commerce metric: productListRemovals", + "@id": "xdm:productListRemovals", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/product-list-removals.schema.md b/docs/reference/datatypes/data/product-list-removals.schema.md new file mode 100644 index 000000000..10d51c2e0 --- /dev/null +++ b/docs/reference/datatypes/data/product-list-removals.schema.md @@ -0,0 +1,152 @@ + +# Product List Removals Schema + +``` +https://ns.adobe.com/xdm/data/metrics/product-list-removals +``` + +The commerce metric `productListRemovals` describes the number of times a product has been removed from a product list. The most common use case is the removal of a product from the shopping cart. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/product-list-removals.schema.json](datatypes/data/product-list-removals.schema.json) | +## Schema Hierarchy + +* Product List Removals `https://ns.adobe.com/xdm/data/metrics/product-list-removals` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Product List Removals Example +```json +{ + "schema:name": "commerce metric: productListRemovals", + "@id": "xdm:productListRemovals", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Product List Removals Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/product-list-reopens.schema.json b/docs/reference/datatypes/data/product-list-reopens.schema.json new file mode 100644 index 000000000..cc6bb5717 --- /dev/null +++ b/docs/reference/datatypes/data/product-list-reopens.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/product-list-reopens", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product List Reopens", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Number of reopens for which a product list that was no longer accessible has been re-activated by the user, for example via a re-marketing activity.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:productListReopens", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "commerce metric: productListReopens", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "commerce metric: productListReopens", + "@id": "xdm:productListReopens", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/product-list-reopens.schema.md b/docs/reference/datatypes/data/product-list-reopens.schema.md new file mode 100644 index 000000000..e675c9741 --- /dev/null +++ b/docs/reference/datatypes/data/product-list-reopens.schema.md @@ -0,0 +1,152 @@ + +# Product List Reopens Schema + +``` +https://ns.adobe.com/xdm/data/metrics/product-list-reopens +``` + +Number of reopens for which a product list that was no longer accessible has been re-activated by the user, for example via a re-marketing activity. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/product-list-reopens.schema.json](datatypes/data/product-list-reopens.schema.json) | +## Schema Hierarchy + +* Product List Reopens `https://ns.adobe.com/xdm/data/metrics/product-list-reopens` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Product List Reopens Example +```json +{ + "schema:name": "commerce metric: productListReopens", + "@id": "xdm:productListReopens", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Product List Reopens Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/product-list-views.schema.json b/docs/reference/datatypes/data/product-list-views.schema.json new file mode 100644 index 000000000..ef2a8cd03 --- /dev/null +++ b/docs/reference/datatypes/data/product-list-views.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/product-list-views", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product List Views", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The commerce metric `product-list-views` describes how often a product list has been seen by a shopper. The most common use case is to open the shopping cart to inspect its contents.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:productListViews", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "commerce metric: productListViews", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "commerce metric: productListViews", + "@id": "xdm:productListViews", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/product-list-views.schema.md b/docs/reference/datatypes/data/product-list-views.schema.md new file mode 100644 index 000000000..88f046d52 --- /dev/null +++ b/docs/reference/datatypes/data/product-list-views.schema.md @@ -0,0 +1,152 @@ + +# Product List Views Schema + +``` +https://ns.adobe.com/xdm/data/metrics/product-list-views +``` + +The commerce metric `product-list-views` describes how often a product list has been seen by a shopper. The most common use case is to open the shopping cart to inspect its contents. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/product-list-views.schema.json](datatypes/data/product-list-views.schema.json) | +## Schema Hierarchy + +* Product List Views `https://ns.adobe.com/xdm/data/metrics/product-list-views` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Product List Views Example +```json +{ + "schema:name": "commerce metric: productListViews", + "@id": "xdm:productListViews", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Product List Views Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/product-views.schema.json b/docs/reference/datatypes/data/product-views.schema.json new file mode 100644 index 000000000..1d3998189 --- /dev/null +++ b/docs/reference/datatypes/data/product-views.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/product-views", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product Views", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The commerce metric `productViews` describes the number of product views that have occurred. Because the number of products on a page might be greater than one, this number may differ from the page view count of product pages.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:productViews", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "commerce metric: productViews", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "commerce metric: productViews", + "@id": "xdm:productViews", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/product-views.schema.md b/docs/reference/datatypes/data/product-views.schema.md new file mode 100644 index 000000000..172738511 --- /dev/null +++ b/docs/reference/datatypes/data/product-views.schema.md @@ -0,0 +1,152 @@ + +# Product Views Schema + +``` +https://ns.adobe.com/xdm/data/metrics/product-views +``` + +The commerce metric `productViews` describes the number of product views that have occurred. Because the number of products on a page might be greater than one, this number may differ from the page view count of product pages. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/product-views.schema.json](datatypes/data/product-views.schema.json) | +## Schema Hierarchy + +* Product Views `https://ns.adobe.com/xdm/data/metrics/product-views` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Product Views Example +```json +{ + "schema:name": "commerce metric: productViews", + "@id": "xdm:productViews", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Product Views Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/purchases.schema.json b/docs/reference/datatypes/data/purchases.schema.json new file mode 100644 index 000000000..c7fa47da7 --- /dev/null +++ b/docs/reference/datatypes/data/purchases.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/purchases", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Purchases", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "Number of orders has occurred. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:purchases", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "commerce metric: purchases", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "commerce metric: purchases", + "@id": "xdm:purchases", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/purchases.schema.md b/docs/reference/datatypes/data/purchases.schema.md new file mode 100644 index 000000000..debb4f80c --- /dev/null +++ b/docs/reference/datatypes/data/purchases.schema.md @@ -0,0 +1,152 @@ + +# Purchases Schema + +``` +https://ns.adobe.com/xdm/data/metrics/purchases +``` + +Number of orders has occurred. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/purchases.schema.json](datatypes/data/purchases.schema.json) | +## Schema Hierarchy + +* Purchases `https://ns.adobe.com/xdm/data/metrics/purchases` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Purchases Example +```json +{ + "schema:name": "commerce metric: purchases", + "@id": "xdm:purchases", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Purchases Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/record-timeseries-events.schema.json b/docs/reference/datatypes/data/record-timeseries-events.schema.json new file mode 100644 index 000000000..56f3069b0 --- /dev/null +++ b/docs/reference/datatypes/data/record-timeseries-events.schema.json @@ -0,0 +1,51 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/record-timeseries-events", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Time-series Extension for Record Data", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile", + "https://ns.adobe.com/xdm/data/record" + ], + "description": "Time-series extension for record data.", + "definitions": { + "record-timeseries-events": { + "properties": { + "xdm:timeSeriesEvents": { + "title": "Time-series Events", + "description": "List of time-series based events that relate to schemas based on record.", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/data/time-series" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/record-timeseries-events" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:timeSeriesEvents": [ + { + "@id": "49069bba-3014-420b-a887-3959f87d474a" + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/record-timeseries-events.schema.md b/docs/reference/datatypes/data/record-timeseries-events.schema.md new file mode 100644 index 000000000..57fe37952 --- /dev/null +++ b/docs/reference/datatypes/data/record-timeseries-events.schema.md @@ -0,0 +1,61 @@ + +# Time-series Extension for Record Data Schema + +``` +https://ns.adobe.com/xdm/data/record-timeseries-events +``` + +Time-series extension for record data. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/record-timeseries-events.schema.json](datatypes/data/record-timeseries-events.schema.json) | +## Schema Hierarchy + +* Time-series Extension for Record Data `https://ns.adobe.com/xdm/data/record-timeseries-events` + * [Extensibility base schema](../extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Time-series Extension for Record Data Example +```json +{ + "xdm:timeSeriesEvents": [ + { + "@id": "49069bba-3014-420b-a887-3959f87d474a" + } + ] +} +``` + +# Time-series Extension for Record Data Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:timeSeriesEvents](#xdmtimeseriesevents) | Time-series Schema | Optional | Time-series Extension for Record Data (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:timeSeriesEvents +### Time-series Events + +List of time-series based events that relate to schemas based on record. + +`xdm:timeSeriesEvents` +* is optional +* type: Time-series Schema + +* defined in this schema + +### xdm:timeSeriesEvents Type + + +Array type: Time-series Schema + +All items must be of the type: +* [Time-series Schema](../../behaviors/time-series.schema.md) – `https://ns.adobe.com/xdm/data/time-series` + + + + + + + diff --git a/docs/reference/datatypes/data/save-for-laters.schema.json b/docs/reference/datatypes/data/save-for-laters.schema.json new file mode 100644 index 000000000..c626f948c --- /dev/null +++ b/docs/reference/datatypes/data/save-for-laters.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/save-for-laters", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Save For Laters", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The commerce metric `saveForLaters` describes how often a product has been saved for a later day purchase.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:saveForLaters", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "commerce metric: saveForLaters", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "commerce metric: saveForLaters", + "@id": "xdm:saveForLaters", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/save-for-laters.schema.md b/docs/reference/datatypes/data/save-for-laters.schema.md new file mode 100644 index 000000000..c5415e018 --- /dev/null +++ b/docs/reference/datatypes/data/save-for-laters.schema.md @@ -0,0 +1,152 @@ + +# Save For Laters Schema + +``` +https://ns.adobe.com/xdm/data/metrics/save-for-laters +``` + +The commerce metric `saveForLaters` describes how often a product has been saved for a later day purchase. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/save-for-laters.schema.json](datatypes/data/save-for-laters.schema.json) | +## Schema Hierarchy + +* Save For Laters `https://ns.adobe.com/xdm/data/metrics/save-for-laters` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Save For Laters Example +```json +{ + "schema:name": "commerce metric: saveForLaters", + "@id": "xdm:saveForLaters", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Save For Laters Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/sends.schema.json b/docs/reference/datatypes/data/sends.schema.json new file mode 100644 index 000000000..961c59561 --- /dev/null +++ b/docs/reference/datatypes/data/sends.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Sends", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The direct-marketing metric `sends` describes the number of asynchronous messages (email, SMS, MMS etc) that have been dispatched to an recipient's account/address/device.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:sends", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "direct-marketing metric: sends", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "direct-marketing metric: sends", + "@id": "xdm:sends", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/sends.schema.md b/docs/reference/datatypes/data/sends.schema.md new file mode 100644 index 000000000..6f48b15ca --- /dev/null +++ b/docs/reference/datatypes/data/sends.schema.md @@ -0,0 +1,152 @@ + +# Sends Schema + +``` +https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends +``` + +The direct-marketing metric `sends` describes the number of asynchronous messages (email, SMS, MMS etc) that have been dispatched to an recipient's account/address/device. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/sends.schema.json](datatypes/data/sends.schema.json) | +## Schema Hierarchy + +* Sends `https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Sends Example +```json +{ + "schema:name": "direct-marketing metric: sends", + "@id": "xdm:sends", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Sends Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/unsubscriptions.schema.json b/docs/reference/datatypes/data/unsubscriptions.schema.json new file mode 100644 index 000000000..b9d19b222 --- /dev/null +++ b/docs/reference/datatypes/data/unsubscriptions.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/unsubscriptions", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Unsubscriptions", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The direct-marketing metric `unsubscriptions` describes the number of times the recipients of direct marketing messages (email, newsletters, etc) have opted out from receiving them.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:unsubscriptions", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "direct-marketing metric: unsubscriptions", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "direct-marketing metric: unsubscriptions", + "@id": "xdm:unsubscriptions", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/unsubscriptions.schema.md b/docs/reference/datatypes/data/unsubscriptions.schema.md new file mode 100644 index 000000000..466af7589 --- /dev/null +++ b/docs/reference/datatypes/data/unsubscriptions.schema.md @@ -0,0 +1,152 @@ + +# Unsubscriptions Schema + +``` +https://ns.adobe.com/xdm/data/metrics/direct-marketing/unsubscriptions +``` + +The direct-marketing metric `unsubscriptions` describes the number of times the recipients of direct marketing messages (email, newsletters, etc) have opted out from receiving them. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/unsubscriptions.schema.json](datatypes/data/unsubscriptions.schema.json) | +## Schema Hierarchy + +* Unsubscriptions `https://ns.adobe.com/xdm/data/metrics/direct-marketing/unsubscriptions` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## Unsubscriptions Example +```json +{ + "schema:name": "direct-marketing metric: unsubscriptions", + "@id": "xdm:unsubscriptions", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# Unsubscriptions Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/data/user-complaints.schema.json b/docs/reference/datatypes/data/user-complaints.schema.json new file mode 100644 index 000000000..f49b052c2 --- /dev/null +++ b/docs/reference/datatypes/data/user-complaints.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/user-complaints", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "User Complaints", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/metricdefinition" + ], + "description": "The direct-marketing metric `user-complaints` describes the number of user complaints that have been received. This generally occurs when a recipient of a message reported it as spam.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:userComplaints", + "description": "The unique identifier of this metric." + }, + "schema:name": { + "type": "string", + "const": "direct-marketing metric: userComplaints", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + }, + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" + }, + "xdm:unit": { + "const": "" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": [ + "@id", + "schema:name", + "xdm:measurement", + "xdm:unit" + ], + "meta:status": "stable", + "examples": [ + { + "schema:name": "direct-marketing metric: userComplaints", + "@id": "xdm:userComplaints", + "xdm:measurement": "count", + "xdm:unit": "" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/data/user-complaints.schema.md b/docs/reference/datatypes/data/user-complaints.schema.md new file mode 100644 index 000000000..d028e8b9a --- /dev/null +++ b/docs/reference/datatypes/data/user-complaints.schema.md @@ -0,0 +1,152 @@ + +# User Complaints Schema + +``` +https://ns.adobe.com/xdm/data/metrics/direct-marketing/user-complaints +``` + +The direct-marketing metric `user-complaints` describes the number of user complaints that have been received. This generally occurs when a recipient of a message reported it as spam. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/data/user-complaints.schema.json](datatypes/data/user-complaints.schema.json) | +## Schema Hierarchy + +* User Complaints `https://ns.adobe.com/xdm/data/metrics/direct-marketing/user-complaints` + * [Metric Definition](metricdefinition.schema.md) `https://ns.adobe.com/xdm/data/metricdefinition` + + +## User Complaints Example +```json +{ + "schema:name": "direct-marketing metric: userComplaints", + "@id": "xdm:userComplaints", + "xdm:measurement": "count", + "xdm:unit": "" +} +``` + +# User Complaints Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#id) | +| [schema:name](#schemaname) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#schemaname) | +| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmmeasurement) | +| [xdm:unit](#xdmunit) | `string` | **Required** | [Metric Definition](metricdefinition.schema.md#xdmunit) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +The unique identifier of this metric. + +`@id` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:name + +The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. + +`schema:name` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#schemaname) + +### schema:name Type + + +`string` + + + + + + +## xdm:measurement + +How to take measures of this metric. + +`xdm:measurement` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmmeasurement) + +### xdm:measurement Type + + +`string` + + + + + +### xdm:measurement Examples + +```json +"distance" +``` + +```json +"time" +``` + +```json +"price" +``` + +```json +"count" +``` + + + +## xdm:unit + +The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null) + +`xdm:unit` +* is **required** +* type: `string` +* defined in [Metric Definition](metricdefinition.schema.md#xdmunit) + +### xdm:unit Type + + +`string` + + + + + +### xdm:unit Examples + +```json +"m" +``` + +```json +"kg" +``` + +```json +"s" +``` + +```json +"USD" +``` + + diff --git a/docs/reference/datatypes/device.schema.json b/docs/reference/datatypes/device.schema.json new file mode 100644 index 000000000..fdc25b68b --- /dev/null +++ b/docs/reference/datatypes/device.schema.json @@ -0,0 +1,118 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/device", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Device", + "type": "object", + "meta:extensible": true, + "description": "An identified device that is an application or browser instance that is trackable across sessions, normally by cookies.", + "definitions": { + "device": { + "properties": { + "xdm:typeID": { + "title": "Type identifier", + "type": "string", + "description": "An identifier for the device. This may be an identifier from 'DeviceAtlas' or another service that identifies the hardware that is being used." + }, + "xdm:typeIDService": { + "title": "Type identifier service", + "type": "string", + "format": "uri", + "description": "The namespace of the service that is used to identify the device type.", + "meta:enum": { + "https://ns.adobe.com/xdm/external/deviceatlas": "DeviceAtlas", + "https://ns.adobe.com/xdm/external/adobecampaign": "Adobe Campaign" + } + }, + "xdm:type": { + "title": "Type", + "type": "string", + "description": "Type of device being tracked.", + "meta:enum": { + "mobile": "Mobile", + "tablet": "Tablet", + "desktop": "Desktop", + "ereader": "E-reader", + "gaming": "Gaming console", + "television": "Television", + "settop": "Set-top box", + "mediaplayer": "Media player", + "computers": "Computers", + "tv screens": "TV screens" + } + }, + "xdm:manufacturer": { + "title": "Manufacturer", + "type": "string", + "description": "The name of the organization who owns the design and creation of the device, for example, 'Apple' is the manufacturer of the iPhone." + }, + "xdm:model": { + "title": "Model", + "type": "string", + "description": "The name of the model for the device. This is the common, human-readable, or marketing name for the device. For example, the 'iPhone 6S' is a particular model of mobile phone." + }, + "xdm:modelNumber": { + "title": "Model number", + "type": "string", + "description": "The unique model number designation assigned by the manufacturer for this device. Model numbers are not versions, but unique identifiers that identify a particular model configuration. While the model for a particular phone might be 'iPhone 6S' the model number would be 'A1633', or 'A1634' based on configuration at the time of sale." + }, + "xdm:screenHeight": { + "title": "Screen height", + "type": "integer", + "description": "The number of vertical pixels of the device's active display in the default orientation." + }, + "xdm:screenWidth": { + "title": "Screen width", + "type": "integer", + "description": "The number of horizontal pixels of the device's active display in the default orientation." + }, + "xdm:colorDepth": { + "title": "Color depth", + "type": "integer", + "description": "The number of colors the display is able to represent." + }, + "xdm:screenOrientation": { + "title": "Screen orientation", + "type": "string", + "description": "The current screen orientation such as \"portrait\" or \"landscape\".", + "enum": [ + "portrait", + "landscape" + ], + "meta:enum": { + "portrait": "Portrait", + "landscape": "Landscape" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/device" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:typeID": "TypeIdentifier-111", + "xdm:typeIDService": "https://ns.adobe.com/xdm/external/deviceatlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216, + "xdm:screenOrientation": "portrait" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/device.schema.md b/docs/reference/datatypes/device.schema.md new file mode 100644 index 000000000..1314a4392 --- /dev/null +++ b/docs/reference/datatypes/device.schema.md @@ -0,0 +1,271 @@ + +# Device Schema + +``` +https://ns.adobe.com/xdm/context/device +``` + +An identified device that is an application or browser instance that is trackable across sessions, normally by cookies. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/device.schema.json](datatypes/device.schema.json) | +## Schema Hierarchy + +* Device `https://ns.adobe.com/xdm/context/device` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Device Example +```json +{ + "xdm:typeID": "TypeIdentifier-111", + "xdm:typeIDService": "https://ns.adobe.com/xdm/external/deviceatlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216, + "xdm:screenOrientation": "portrait" +} +``` + +# Device Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:colorDepth](#xdmcolordepth) | `integer` | Optional | Device (this schema) | +| [xdm:manufacturer](#xdmmanufacturer) | `string` | Optional | Device (this schema) | +| [xdm:model](#xdmmodel) | `string` | Optional | Device (this schema) | +| [xdm:modelNumber](#xdmmodelnumber) | `string` | Optional | Device (this schema) | +| [xdm:screenHeight](#xdmscreenheight) | `integer` | Optional | Device (this schema) | +| [xdm:screenOrientation](#xdmscreenorientation) | `enum` | Optional | Device (this schema) | +| [xdm:screenWidth](#xdmscreenwidth) | `integer` | Optional | Device (this schema) | +| [xdm:type](#xdmtype) | `string` | Optional | Device (this schema) | +| [xdm:typeID](#xdmtypeid) | `string` | Optional | Device (this schema) | +| [xdm:typeIDService](#xdmtypeidservice) | `string` | Optional | Device (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:colorDepth +### Color depth + +The number of colors the display is able to represent. + +`xdm:colorDepth` +* is optional +* type: `integer` +* defined in this schema + +### xdm:colorDepth Type + + +`integer` + + + + + + +## xdm:manufacturer +### Manufacturer + +The name of the organization who owns the design and creation of the device, for example, 'Apple' is the manufacturer of the iPhone. + +`xdm:manufacturer` +* is optional +* type: `string` +* defined in this schema + +### xdm:manufacturer Type + + +`string` + + + + + + +## xdm:model +### Model + +The name of the model for the device. This is the common, human-readable, or marketing name for the device. For example, the 'iPhone 6S' is a particular model of mobile phone. + +`xdm:model` +* is optional +* type: `string` +* defined in this schema + +### xdm:model Type + + +`string` + + + + + + +## xdm:modelNumber +### Model number + +The unique model number designation assigned by the manufacturer for this device. Model numbers are not versions, but unique identifiers that identify a particular model configuration. While the model for a particular phone might be 'iPhone 6S' the model number would be 'A1633', or 'A1634' based on configuration at the time of sale. + +`xdm:modelNumber` +* is optional +* type: `string` +* defined in this schema + +### xdm:modelNumber Type + + +`string` + + + + + + +## xdm:screenHeight +### Screen height + +The number of vertical pixels of the device's active display in the default orientation. + +`xdm:screenHeight` +* is optional +* type: `integer` +* defined in this schema + +### xdm:screenHeight Type + + +`integer` + + + + + + +## xdm:screenOrientation +### Screen orientation + +The current screen orientation such as "portrait" or "landscape". + +`xdm:screenOrientation` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmscreenorientation-known-values). + +### xdm:screenOrientation Known Values +| Value | Description | +|-------|-------------| +| `portrait` | Portrait | +| `landscape` | Landscape | + + + + +## xdm:screenWidth +### Screen width + +The number of horizontal pixels of the device's active display in the default orientation. + +`xdm:screenWidth` +* is optional +* type: `integer` +* defined in this schema + +### xdm:screenWidth Type + + +`integer` + + + + + + +## xdm:type +### Type + +Type of device being tracked. + +`xdm:type` +* is optional +* type: `string` +* defined in this schema + +### xdm:type Type + + +`string` + + + +### xdm:type Known Values +| Value | Description | +|-------|-------------| +| `mobile` | Mobile | +| `tablet` | Tablet | +| `desktop` | Desktop | +| `ereader` | E-reader | +| `gaming` | Gaming console | +| `television` | Television | +| `settop` | Set-top box | +| `mediaplayer` | Media player | +| `computers` | Computers | +| `tv screens` | TV screens | + + + + +## xdm:typeID +### Type identifier + +An identifier for the device. This may be an identifier from 'DeviceAtlas' or another service that identifies the hardware that is being used. + +`xdm:typeID` +* is optional +* type: `string` +* defined in this schema + +### xdm:typeID Type + + +`string` + + + + + + +## xdm:typeIDService +### Type identifier service + +The namespace of the service that is used to identify the device type. + +`xdm:typeIDService` +* is optional +* type: `string` +* defined in this schema + +### xdm:typeIDService Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + +### xdm:typeIDService Known Values +| Value | Description | +|-------|-------------| +| `https://ns.adobe.com/xdm/external/deviceatlas` | DeviceAtlas | +| `https://ns.adobe.com/xdm/external/adobecampaign` | Adobe Campaign | + + + diff --git a/docs/reference/datatypes/direct-marketing.schema.json b/docs/reference/datatypes/direct-marketing.schema.json new file mode 100644 index 000000000..77083abdc --- /dev/null +++ b/docs/reference/datatypes/direct-marketing.schema.json @@ -0,0 +1,80 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/direct-marketing", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Direct marketing", + "type": "object", + "description": "The events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications.", + "meta:extensible": true, + "definitions": { + "direct-marketing": { + "properties": { + "xdm:bounces": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Asynchronous messages that have been returned as temporarily undeliverable the receiving system." + }, + "xdm:clicks": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Click actions on a message." + }, + "xdm:mirrorPages": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Click on a link in a message to a web hosted mirror page." + }, + "xdm:nonDeliverables": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Asynchronous messages failed to deliver in a way that indicates that no future delivery attempts will be successful to the address." + }, + "xdm:sends": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Asynchronous messages such as email, SMS, and MMS that have been dispatched to a person's account, address, or device." + }, + "xdm:userComplaints": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "User complaint or complaints have been received. This generally occurs when a recipient of a message reports it as spam." + }, + "xdm:opens": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The direct marketing message such as email, SMS, and push notifications has been opened, swiped, or touched by the recipient." + }, + "xdm:unsubscriptions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The recipient of the direct marketing message such as email or newsletters has opted out from receiving them." + }, + "xdm:notSent": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Asynchronous message such as email, SMS, or MMS was not dispatched due to cancellation or expiration of the marketing activity." + }, + "xdm:offerOpens": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Offer in a marketing message such as email, SMS, or push notifications has been opened, swiped, touched or otherwise interacted with by the recipient." + }, + "xdm:impressions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The direct marketing message such as push notifications or in-app message has been seen by the end user." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/direct-marketing" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:sends": { + "xdm:value": 1 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/direct-marketing.schema.md b/docs/reference/datatypes/direct-marketing.schema.md new file mode 100644 index 000000000..7a4da74cb --- /dev/null +++ b/docs/reference/datatypes/direct-marketing.schema.md @@ -0,0 +1,242 @@ + +# Direct marketing Schema + +``` +https://ns.adobe.com/xdm/context/direct-marketing +``` + +The events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/direct-marketing.schema.json](datatypes/direct-marketing.schema.json) | +## Schema Hierarchy + +* Direct marketing `https://ns.adobe.com/xdm/context/direct-marketing` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Measure](data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## Direct marketing Example +```json +{ + "xdm:sends": { + "xdm:value": 1 + } +} +``` + +# Direct marketing Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:bounces](#xdmbounces) | Measure | Optional | Direct marketing (this schema) | +| [xdm:clicks](#xdmclicks) | Measure | Optional | Direct marketing (this schema) | +| [xdm:impressions](#xdmimpressions) | Measure | Optional | Direct marketing (this schema) | +| [xdm:mirrorPages](#xdmmirrorpages) | Measure | Optional | Direct marketing (this schema) | +| [xdm:nonDeliverables](#xdmnondeliverables) | Measure | Optional | Direct marketing (this schema) | +| [xdm:notSent](#xdmnotsent) | Measure | Optional | Direct marketing (this schema) | +| [xdm:offerOpens](#xdmofferopens) | Measure | Optional | Direct marketing (this schema) | +| [xdm:opens](#xdmopens) | Measure | Optional | Direct marketing (this schema) | +| [xdm:sends](#xdmsends) | Measure | Optional | Direct marketing (this schema) | +| [xdm:unsubscriptions](#xdmunsubscriptions) | Measure | Optional | Direct marketing (this schema) | +| [xdm:userComplaints](#xdmusercomplaints) | Measure | Optional | Direct marketing (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:bounces + +Asynchronous messages that have been returned as temporarily undeliverable the receiving system. + +`xdm:bounces` +* is optional +* type: Measure +* defined in this schema + +### xdm:bounces Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:clicks + +Click actions on a message. + +`xdm:clicks` +* is optional +* type: Measure +* defined in this schema + +### xdm:clicks Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:impressions + +The direct marketing message such as push notifications or in-app message has been seen by the end user. + +`xdm:impressions` +* is optional +* type: Measure +* defined in this schema + +### xdm:impressions Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:mirrorPages + +Click on a link in a message to a web hosted mirror page. + +`xdm:mirrorPages` +* is optional +* type: Measure +* defined in this schema + +### xdm:mirrorPages Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:nonDeliverables + +Asynchronous messages failed to deliver in a way that indicates that no future delivery attempts will be successful to the address. + +`xdm:nonDeliverables` +* is optional +* type: Measure +* defined in this schema + +### xdm:nonDeliverables Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:notSent + +Asynchronous message such as email, SMS, or MMS was not dispatched due to cancellation or expiration of the marketing activity. + +`xdm:notSent` +* is optional +* type: Measure +* defined in this schema + +### xdm:notSent Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:offerOpens + +Offer in a marketing message such as email, SMS, or push notifications has been opened, swiped, touched or otherwise interacted with by the recipient. + +`xdm:offerOpens` +* is optional +* type: Measure +* defined in this schema + +### xdm:offerOpens Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:opens + +The direct marketing message such as email, SMS, and push notifications has been opened, swiped, or touched by the recipient. + +`xdm:opens` +* is optional +* type: Measure +* defined in this schema + +### xdm:opens Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:sends + +Asynchronous messages such as email, SMS, and MMS that have been dispatched to a person's account, address, or device. + +`xdm:sends` +* is optional +* type: Measure +* defined in this schema + +### xdm:sends Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:unsubscriptions + +The recipient of the direct marketing message such as email or newsletters has opted out from receiving them. + +`xdm:unsubscriptions` +* is optional +* type: Measure +* defined in this schema + +### xdm:unsubscriptions Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:userComplaints + +User complaint or complaints have been received. This generally occurs when a recipient of a message reports it as spam. + +`xdm:userComplaints` +* is optional +* type: Measure +* defined in this schema + +### xdm:userComplaints Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + diff --git a/docs/reference/datatypes/directmarketing-address.schema.json b/docs/reference/datatypes/directmarketing-address.schema.json new file mode 100644 index 000000000..492e89cae --- /dev/null +++ b/docs/reference/datatypes/directmarketing-address.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/directmarketing-address", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Direct marketing postal address", + "type": "object", + "description": "Postal address information used to contact a user.", + "definitions": { + "directmarketing-address": { + "properties": { + "xdm:errorCount": { + "title": "Address error count", + "type": "integer", + "description": "Number of consecutive errors when sending to this address." + }, + "xdm:quality": { + "title": "Address quality", + "type": "string", + "description": "Address quality rating.", + "meta:enum": { + "incomplete_address": "Incomplete address", + "unknown_town_postal_code": "Unknown town or postal code", + "empty_street": "Empty street", + "unknown_street": "Unknown street", + "partially_recognized_street": "Partially recognized street", + "fully_recognized_street": "Fully recognized street" + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/directmarketing-address" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/address" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02", + "xdm:errorCount": 0, + "xdm:quality": "Fully-recognized street" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/directmarketing-address.schema.md b/docs/reference/datatypes/directmarketing-address.schema.md new file mode 100644 index 000000000..20e363cdf --- /dev/null +++ b/docs/reference/datatypes/directmarketing-address.schema.md @@ -0,0 +1,358 @@ + +# Direct marketing postal address Schema + +``` +https://ns.adobe.com/xdm/context/directmarketing-address +``` + +Postal address information used to contact a user. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/directmarketing-address.schema.json](datatypes/directmarketing-address.schema.json) | +## Schema Hierarchy + +* Direct marketing postal address `https://ns.adobe.com/xdm/context/directmarketing-address` + * [Postal address](address.schema.md) `https://ns.adobe.com/xdm/common/address` + + +## Direct marketing postal address Example +```json +{ + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02", + "xdm:errorCount": 0, + "xdm:quality": "Fully-recognized street" +} +``` + +# Direct marketing postal address Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:country](#xdmcountry) | `string` | Optional | | [Postal address](address.schema.md#xdmcountry) | +| [xdm:errorCount](#xdmerrorcount) | `integer` | Optional | | Direct marketing postal address (this schema) | +| [xdm:label](#xdmlabel) | `string` | Optional | | [Postal address](address.schema.md#xdmlabel) | +| [xdm:lastVerifiedDate](#xdmlastverifieddate) | `string` | Optional | | [Postal address](address.schema.md#xdmlastverifieddate) | +| [xdm:postOfficeBox](#xdmpostofficebox) | `string` | Optional | | [Postal address](address.schema.md#xdmpostofficebox) | +| [xdm:primary](#xdmprimary) | `boolean` | Optional | | [Postal address](address.schema.md#xdmprimary) | +| [xdm:quality](#xdmquality) | `string` | Optional | | Direct marketing postal address (this schema) | +| [xdm:region](#xdmregion) | `string` | Optional | | [Postal address](address.schema.md#xdmregion) | +| [xdm:status](#xdmstatus) | `string` | Optional | `"active"` | [Postal address](address.schema.md#xdmstatus) | +| [xdm:statusReason](#xdmstatusreason) | `string` | Optional | | [Postal address](address.schema.md#xdmstatusreason) | +| [xdm:street1](#xdmstreet1) | `string` | Optional | | [Postal address](address.schema.md#xdmstreet1) | +| [xdm:street2](#xdmstreet2) | `string` | Optional | | [Postal address](address.schema.md#xdmstreet2) | +| [xdm:street3](#xdmstreet3) | `string` | Optional | | [Postal address](address.schema.md#xdmstreet3) | +| [xdm:street4](#xdmstreet4) | `string` | Optional | | [Postal address](address.schema.md#xdmstreet4) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:country +### Country + +The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language. + +`xdm:country` +* is optional +* type: `string` +* defined in [Postal address](address.schema.md#xdmcountry) + +### xdm:country Type + + +`string` + + + + + + +## xdm:errorCount +### Address error count + +Number of consecutive errors when sending to this address. + +`xdm:errorCount` +* is optional +* type: `integer` +* defined in this schema + +### xdm:errorCount Type + + +`integer` + + + + + + +## xdm:label +### Label + +Free form name of the address. + +`xdm:label` +* is optional +* type: `string` +* defined in [Postal address](address.schema.md#xdmlabel) + +### xdm:label Type + + +`string` + + + + + + +## xdm:lastVerifiedDate +### Last verified date + +The date that the address was last verified as still associated to the person. + +`xdm:lastVerifiedDate` +* is optional +* type: `string` +* defined in [Postal address](address.schema.md#xdmlastverifieddate) + +### xdm:lastVerifiedDate Type + + +`string` +* format: `date` – date, without time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:postOfficeBox +### Post office box + +Post office box of the address. + +`xdm:postOfficeBox` +* is optional +* type: `string` +* defined in [Postal address](address.schema.md#xdmpostofficebox) + +### xdm:postOfficeBox Type + + +`string` + +* maximum length: 20 characters + + + + + +## xdm:primary +### Primary + +Primary address indicator. A profile can have only one `primary` address at a given point of time. + +`xdm:primary` +* is optional +* type: `boolean` +* defined in [Postal address](address.schema.md#xdmprimary) + +### xdm:primary Type + + +`boolean` + + + + + +## xdm:quality +### Address quality + +Address quality rating. + +`xdm:quality` +* is optional +* type: `string` +* defined in this schema + +### xdm:quality Type + + +`string` + + + +### xdm:quality Known Values +| Value | Description | +|-------|-------------| +| `incomplete_address` | Incomplete address | +| `unknown_town_postal_code` | Unknown town or postal code | +| `empty_street` | Empty street | +| `unknown_street` | Unknown street | +| `partially_recognized_street` | Partially recognized street | +| `fully_recognized_street` | Fully recognized street | + + + + +## xdm:region +### Region + +The region, county, or district portion of the address. + +`xdm:region` +* is optional +* type: `string` +* defined in [Postal address](address.schema.md#xdmregion) + +### xdm:region Type + + +`string` + + + + + + +## xdm:status +### Status + +An indication as to the ability to use the address. + +`xdm:status` +* is optional +* type: `string` +* default: `"active"` +* defined in [Postal address](address.schema.md#xdmstatus) + +### xdm:status Type + + +`string` + + + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `active` | Active | +| `incomplete` | Incomplete | +| `pending_verification` | Pending verification | +| `blacklisted` | Blacklisted | +| `blocked` | Blocked | + + + + +## xdm:statusReason +### Status reason + +A description of the current status. + +`xdm:statusReason` +* is optional +* type: `string` +* defined in [Postal address](address.schema.md#xdmstatusreason) + +### xdm:statusReason Type + + +`string` + + + + + + +## xdm:street1 +### Street 1 + +Primary street level information, apartment number, street number, and street name. + +`xdm:street1` +* is optional +* type: `string` +* defined in [Postal address](address.schema.md#xdmstreet1) + +### xdm:street1 Type + + +`string` + + + + + + +## xdm:street2 +### Street 2 + +Optional street information second line. + +`xdm:street2` +* is optional +* type: `string` +* defined in [Postal address](address.schema.md#xdmstreet2) + +### xdm:street2 Type + + +`string` + + + + + + +## xdm:street3 +### Street 3 + +Optional street information third line. + +`xdm:street3` +* is optional +* type: `string` +* defined in [Postal address](address.schema.md#xdmstreet3) + +### xdm:street3 Type + + +`string` + + + + + + +## xdm:street4 +### Street 4 + +Optional street information fourth line. + +`xdm:street4` +* is optional +* type: `string` +* defined in [Postal address](address.schema.md#xdmstreet4) + +### xdm:street4 Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/directmarketing-emailaddress.schema.json b/docs/reference/datatypes/directmarketing-emailaddress.schema.json new file mode 100644 index 000000000..7dbf563ac --- /dev/null +++ b/docs/reference/datatypes/directmarketing-emailaddress.schema.json @@ -0,0 +1,48 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/directmarketing-emailaddress", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Direct marketing email address", + "type": "object", + "description": "Email address used to contact a user.", + "definitions": { + "directmarketing-emailaddress": { + "properties": { + "xdm:errorCount": { + "title": "Error count", + "type": "integer", + "description": "Number of consecutive errors when sending to this email address." + }, + "xdm:quality": { + "title": "Quality", + "type": "string", + "description": "Quality rating." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/directmarketing-emailaddress" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/emailaddress" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active", + "xdm:errorCount": 0 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/directmarketing-emailaddress.schema.md b/docs/reference/datatypes/directmarketing-emailaddress.schema.md new file mode 100644 index 000000000..400e7d4eb --- /dev/null +++ b/docs/reference/datatypes/directmarketing-emailaddress.schema.md @@ -0,0 +1,221 @@ + +# Direct marketing email address Schema + +``` +https://ns.adobe.com/xdm/context/directmarketing-emailaddress +``` + +Email address used to contact a user. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/directmarketing-emailaddress.schema.json](datatypes/directmarketing-emailaddress.schema.json) | +## Schema Hierarchy + +* Direct marketing email address `https://ns.adobe.com/xdm/context/directmarketing-emailaddress` + * [Email address](emailaddress.schema.md) `https://ns.adobe.com/xdm/context/emailaddress` + + +## Direct marketing email address Example +```json +{ + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active", + "xdm:errorCount": 0 +} +``` + +# Direct marketing email address Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:address](#xdmaddress) | `string` | Optional | | [Email address](emailaddress.schema.md#xdmaddress) | +| [xdm:errorCount](#xdmerrorcount) | `integer` | Optional | | Direct marketing email address (this schema) | +| [xdm:label](#xdmlabel) | `string` | Optional | | [Email address](emailaddress.schema.md#xdmlabel) | +| [xdm:primary](#xdmprimary) | `boolean` | Optional | | [Email address](emailaddress.schema.md#xdmprimary) | +| [xdm:quality](#xdmquality) | `string` | Optional | | Direct marketing email address (this schema) | +| [xdm:status](#xdmstatus) | `string` | Optional | `"active"` | [Email address](emailaddress.schema.md#xdmstatus) | +| [xdm:statusReason](#xdmstatusreason) | `string` | Optional | | [Email address](emailaddress.schema.md#xdmstatusreason) | +| [xdm:type](#xdmtype) | `string` | Optional | | [Email address](emailaddress.schema.md#xdmtype) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:address +### Address + +The technical address, for example, 'name@domain.com' as commonly defined in RFC2822 and subsequent standards. + +`xdm:address` +* is optional +* type: `string` +* defined in [Email address](emailaddress.schema.md#xdmaddress) + +### xdm:address Type + + +`string` +* format: `email` – email address (according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322)) + + + + + + +## xdm:errorCount +### Error count + +Number of consecutive errors when sending to this email address. + +`xdm:errorCount` +* is optional +* type: `integer` +* defined in this schema + +### xdm:errorCount Type + + +`integer` + + + + + + +## xdm:label +### Label + +Additional display information that maybe available, for example, Microsoft Outlook rich address controls display 'John Smith smithjr@company.uk', 'John Smith' part is data that would be placed in the label. + +`xdm:label` +* is optional +* type: `string` +* defined in [Email address](emailaddress.schema.md#xdmlabel) + +### xdm:label Type + + +`string` + + + + + + +## xdm:primary +### Primary + +Primary email indicator. A profile can have only one `primary` email address at a given point of time. + +`xdm:primary` +* is optional +* type: `boolean` +* defined in [Email address](emailaddress.schema.md#xdmprimary) + +### xdm:primary Type + + +`boolean` + + + + + +## xdm:quality +### Quality + +Quality rating. + +`xdm:quality` +* is optional +* type: `string` +* defined in this schema + +### xdm:quality Type + + +`string` + + + + + + +## xdm:status +### Status + +An indication as to the ability to use the email address. + +`xdm:status` +* is optional +* type: `string` +* default: `"active"` +* defined in [Email address](emailaddress.schema.md#xdmstatus) + +### xdm:status Type + + +`string` + + + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `active` | Active | +| `incomplete` | Incomplete | +| `pending_verification` | Pending verification | +| `blacklisted` | Blacklisted | +| `blocked` | Blocked | + + + + +## xdm:statusReason +### Status reason + +A description of the current status. + +`xdm:statusReason` +* is optional +* type: `string` +* defined in [Email address](emailaddress.schema.md#xdmstatusreason) + +### xdm:statusReason Type + + +`string` + + + + + + +## xdm:type +### Type + +The way the account relates to the person for example 'work' or 'personal'. + +`xdm:type` +* is optional +* type: `string` +* defined in [Email address](emailaddress.schema.md#xdmtype) + +### xdm:type Type + + +`string` + + + +### xdm:type Known Values +| Value | Description | +|-------|-------------| +| `unknown` | Unknown | +| `personal` | Personal | +| `work` | Work | +| `education` | Education | + + + diff --git a/docs/reference/datatypes/directmarketing-phonenumber.schema.json b/docs/reference/datatypes/directmarketing-phonenumber.schema.json new file mode 100644 index 000000000..0d09a049a --- /dev/null +++ b/docs/reference/datatypes/directmarketing-phonenumber.schema.json @@ -0,0 +1,46 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/directmarketing-phonenumber", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Direct marketing phone number", + "type": "object", + "description": "Phone number used to contact a user.", + "definitions": { + "directmarketing-phonenumber": { + "properties": { + "xdm:errorCount": { + "title": "Error count", + "type": "integer", + "description": "Number of consecutive errors when calling this phone number." + }, + "xdm:quality": { + "title": "Quality", + "type": "string", + "description": "Quality rating." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/directmarketing-phonenumber" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/phonenumber" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active", + "xdm:errorCount": 0 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/directmarketing-phonenumber.schema.md b/docs/reference/datatypes/directmarketing-phonenumber.schema.md new file mode 100644 index 000000000..da4c96607 --- /dev/null +++ b/docs/reference/datatypes/directmarketing-phonenumber.schema.md @@ -0,0 +1,217 @@ + +# Direct marketing phone number Schema + +``` +https://ns.adobe.com/xdm/context/directmarketing-phonenumber +``` + +Phone number used to contact a user. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/directmarketing-phonenumber.schema.json](datatypes/directmarketing-phonenumber.schema.json) | +## Schema Hierarchy + +* Direct marketing phone number `https://ns.adobe.com/xdm/context/directmarketing-phonenumber` + * [Phone number](phonenumber.schema.md) `https://ns.adobe.com/xdm/context/phonenumber` + + +## Direct marketing phone number Example +```json +{ + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active", + "xdm:errorCount": 0 +} +``` + +# Direct marketing phone number Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:errorCount](#xdmerrorcount) | `integer` | Optional | | Direct marketing phone number (this schema) | +| [xdm:extension](#xdmextension) | `string` | Optional | | [Phone number](phonenumber.schema.md#xdmextension) | +| [xdm:number](#xdmnumber) | `string` | Optional | | [Phone number](phonenumber.schema.md#xdmnumber) | +| [xdm:primary](#xdmprimary) | `boolean` | Optional | | [Phone number](phonenumber.schema.md#xdmprimary) | +| [xdm:quality](#xdmquality) | `string` | Optional | | Direct marketing phone number (this schema) | +| [xdm:status](#xdmstatus) | `string` | Optional | `"active"` | [Phone number](phonenumber.schema.md#xdmstatus) | +| [xdm:statusReason](#xdmstatusreason) | `string` | Optional | | [Phone number](phonenumber.schema.md#xdmstatusreason) | +| [xdm:validity](#xdmvalidity) | `string` | Optional | | [Phone number](phonenumber.schema.md#xdmvalidity) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:errorCount +### Error count + +Number of consecutive errors when calling this phone number. + +`xdm:errorCount` +* is optional +* type: `integer` +* defined in this schema + +### xdm:errorCount Type + + +`integer` + + + + + + +## xdm:extension +### Extension + +The internal dialing number used to call from a private exchange, operator, or switchboard. + +`xdm:extension` +* is optional +* type: `string` +* defined in [Phone number](phonenumber.schema.md#xdmextension) + +### xdm:extension Type + + +`string` + + + + + + +## xdm:number +### Number + +The phone number. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234. + +`xdm:number` +* is optional +* type: `string` +* defined in [Phone number](phonenumber.schema.md#xdmnumber) + +### xdm:number Type + + +`string` + + + + + + +## xdm:primary +### Primary + +Primary phone number indicator. Unlike address or email address, there can be multiple primary phone numbers; one per communication channel. The communication channel is defined by the type: `textMessaging`, `mobile`, `phone`, `home`, `work`, `unknown`, and `fax`. + +`xdm:primary` +* is optional +* type: `boolean` +* defined in [Phone number](phonenumber.schema.md#xdmprimary) + +### xdm:primary Type + + +`boolean` + + + + + +## xdm:quality +### Quality + +Quality rating. + +`xdm:quality` +* is optional +* type: `string` +* defined in this schema + +### xdm:quality Type + + +`string` + + + + + + +## xdm:status +### Status + +An indication as to the ability to use the phone number. + +`xdm:status` +* is optional +* type: `string` +* default: `"active"` +* defined in [Phone number](phonenumber.schema.md#xdmstatus) + +### xdm:status Type + + +`string` + + + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `active` | Active | +| `incomplete` | Incomplete | +| `blacklisted` | Blacklisted | +| `blocked` | Blocked | + + + + +## xdm:statusReason +### Status reason + +A description of the current status. + +`xdm:statusReason` +* is optional +* type: `string` +* defined in [Phone number](phonenumber.schema.md#xdmstatusreason) + +### xdm:statusReason Type + + +`string` + + + + + + +## xdm:validity +### Validity + +A level of technical correctness of the phone number. + +`xdm:validity` +* is optional +* type: `string` +* defined in [Phone number](phonenumber.schema.md#xdmvalidity) + +### xdm:validity Type + + +`string` + + + +### xdm:validity Known Values +| Value | Description | +|-------|-------------| +| `consistent` | Consistent | +| `inconsistent` | Inconsistent | +| `incomplete` | Incomplete | +| `successfullyUsed` | Successfully used | + + + diff --git a/docs/reference/datatypes/email-interaction.schema.json b/docs/reference/datatypes/email-interaction.schema.json new file mode 100644 index 000000000..0ab1299a3 --- /dev/null +++ b/docs/reference/datatypes/email-interaction.schema.json @@ -0,0 +1,165 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/emailinteraction", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Email Interaction", + "type": "object", + "meta:extensible": true, + "description": "Captures information in the context of an email correspondence between persons", + "definitions": { + "emailinteraction": { + "properties": { + "xdm:priority": { + "title": "Email's priority", + "type": "string", + "description": "Captures the priority set by the person who sent the email" + }, + "xdm:sentDateTime": { + "title": "Date and time the email was sent", + "type": "string", + "format": "date-time", + "description": "Captures the date and time the email correspondence was sent to an individual or a group of people" + }, + "xdm:receivedDateTime": { + "title": "Date and time the email was received", + "type": "string", + "format": "date-time", + "description": "Captures the date and time when the email was received" + }, + "xdm:body": { + "title": "Body of the mail", + "type": "string", + "description": "The contents of the email after substitution of the placeholders in the template" + }, + "xdm:hasAttachments": { + "title": "Email has attachments", + "type": "boolean", + "description": "A flag represent whether any attachment is part of the email message" + }, + "xdm:isQuarantined": { + "title": "quarantine message", + "type": "boolean", + "description": "A flag to represent whether the email message is a spam" + }, + "xdm:sizeInBytes": { + "title": "Email message size", + "type": "number", + "description": "Record the size of the email message in bytes" + }, + "xdm:failureReasonCode": { + "title": "Reason code for failure", + "type": "string", + "description": "Indicates the error code for not able to deliver the email message" + }, + "xdm:failureReasonMessage": { + "title": "Reason Message for failure", + "type": "string", + "description": "Indicates the full message for the error code, for not able to deliver the message" + }, + "xdm:fromAddress": { + "title": "Person sending the email communication", + "type": "string", + "format": "email", + "description": "Person who is sender of the email message" + }, + "xdm:toAddress": { + "type": "array", + "title": "An array of email addresses for the To list", + "description": "Person or list of people who are in the To list of the email message", + "items": { + "type": "string", + "format": "email" + } + }, + "xdm:ccAddress": { + "type": "array", + "title": "An array of email addresses for the cc list", + "description": "Person or list of people who are in the cc list of the email message", + "items": { + "type": "string", + "format": "email" + } + }, + "xdm:bccAddress": { + "type": "array", + "title": "An array of email addresses for the bcc list", + "description": "Person or list of people who are in the bcc list of the email message", + "items": { + "type": "string", + "format": "email" + } + }, + "xdm:headers": { + "title": "Email headers", + "type": "string", + "description": "Captures the headers of the email for diagnosis" + }, + "xdm:incomingMessage": { + "title": "Inbound or Outbound Message ", + "type": "boolean", + "description": "A flag to represent whether a message was sent or recieved" + }, + "xdm:firstOpenDate": { + "title": "First time the email was opened by the receiver", + "type": "string", + "format": "date-time", + "description": "First date and time when the receiver took the action to open the email" + }, + "xdm:lastOpenDate": { + "title": "Last time when the email was opened by the receiver", + "type": "string", + "format": "date-time", + "description": "Last time the email was opened, by any receiver" + }, + "xdm:isTracked": { + "title": "Email Tracking flag", + "type": "boolean", + "description": "A flag to capture whether the email was tracked by the sender" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/emailinteraction" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:priority": "high", + "xdm:sentDateTime": "2020-05-18T00:00:00+00:00", + "xdm:receivedDateTime": "2020-05-18T00:00:28+00:00", + "xdm:body": "Mark nice to meet you virtually and welcome back to conversations with Marketo......", + "xdm:hasAttachments": false, + "xdm:isQuarantined": false, + "xdm:sizeInBytes": 2576, + "xdm:failureReasonCode": "0-0000", + "xdm:failureReasonMessage": "Success", + "xdm:fromAddress": "abc@google.com", + "xdm:toAddress": [ + "mark@google.com" + ], + "xdm:ccAddress": [ + "p@google.com", + "q@yahoo.com" + ], + "xdm:bccAddress": [ + "r@google.com" + ], + "xdm:headers": "Return-Path: X-SpamCatcher-Score: 1 [X] Received: from [136.167.40.119]", + "xdm:incomingMessage": false, + "xdm:firstOpenDate": "2020-05-18T05:00:00+00:00", + "xdm:lastOpenDate": "2020-05-20T00:12:28+00:00", + "xdm:isTracked": true + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/email-interaction.schema.md b/docs/reference/datatypes/email-interaction.schema.md new file mode 100644 index 000000000..4d69e28f6 --- /dev/null +++ b/docs/reference/datatypes/email-interaction.schema.md @@ -0,0 +1,454 @@ + +# Email Interaction Schema + +``` +https://ns.adobe.com/xdm/common/emailinteraction +``` + +Captures information in the context of an email correspondence between persons + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [datatypes/email-interaction.schema.json](datatypes/email-interaction.schema.json) | +## Schema Hierarchy + +* Email Interaction `https://ns.adobe.com/xdm/common/emailinteraction` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Email Interaction Example +```json +{ + "xdm:priority": "high", + "xdm:sentDateTime": "2020-05-18T00:00:00+00:00", + "xdm:receivedDateTime": "2020-05-18T00:00:28+00:00", + "xdm:body": "Mark nice to meet you virtually and welcome back to conversations with Marketo......", + "xdm:hasAttachments": false, + "xdm:isQuarantined": false, + "xdm:sizeInBytes": 2576, + "xdm:failureReasonCode": "0-0000", + "xdm:failureReasonMessage": "Success", + "xdm:fromAddress": "abc@google.com", + "xdm:toAddress": [ + "mark@google.com" + ], + "xdm:ccAddress": [ + "p@google.com", + "q@yahoo.com" + ], + "xdm:bccAddress": [ + "r@google.com" + ], + "xdm:headers": "Return-Path: X-SpamCatcher-Score: 1 [X] Received: from [136.167.40.119]", + "xdm:incomingMessage": false, + "xdm:firstOpenDate": "2020-05-18T05:00:00+00:00", + "xdm:lastOpenDate": "2020-05-20T00:12:28+00:00", + "xdm:isTracked": true +} +``` + +# Email Interaction Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:bccAddress](#xdmbccaddress) | `string[]` | Optional | Email Interaction (this schema) | +| [xdm:body](#xdmbody) | `string` | Optional | Email Interaction (this schema) | +| [xdm:ccAddress](#xdmccaddress) | `string[]` | Optional | Email Interaction (this schema) | +| [xdm:failureReasonCode](#xdmfailurereasoncode) | `string` | Optional | Email Interaction (this schema) | +| [xdm:failureReasonMessage](#xdmfailurereasonmessage) | `string` | Optional | Email Interaction (this schema) | +| [xdm:firstOpenDate](#xdmfirstopendate) | `string` | Optional | Email Interaction (this schema) | +| [xdm:fromAddress](#xdmfromaddress) | `string` | Optional | Email Interaction (this schema) | +| [xdm:hasAttachments](#xdmhasattachments) | `boolean` | Optional | Email Interaction (this schema) | +| [xdm:headers](#xdmheaders) | `string` | Optional | Email Interaction (this schema) | +| [xdm:incomingMessage](#xdmincomingmessage) | `boolean` | Optional | Email Interaction (this schema) | +| [xdm:isQuarantined](#xdmisquarantined) | `boolean` | Optional | Email Interaction (this schema) | +| [xdm:isTracked](#xdmistracked) | `boolean` | Optional | Email Interaction (this schema) | +| [xdm:lastOpenDate](#xdmlastopendate) | `string` | Optional | Email Interaction (this schema) | +| [xdm:priority](#xdmpriority) | `string` | Optional | Email Interaction (this schema) | +| [xdm:receivedDateTime](#xdmreceiveddatetime) | `string` | Optional | Email Interaction (this schema) | +| [xdm:sentDateTime](#xdmsentdatetime) | `string` | Optional | Email Interaction (this schema) | +| [xdm:sizeInBytes](#xdmsizeinbytes) | `number` | Optional | Email Interaction (this schema) | +| [xdm:toAddress](#xdmtoaddress) | `string[]` | Optional | Email Interaction (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:bccAddress +### An array of email addresses for the bcc list + +Person or list of people who are in the bcc list of the email message + +`xdm:bccAddress` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:bccAddress Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `email` – email address (according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322)) + + + + + + + + +## xdm:body +### Body of the mail + +The contents of the email after substitution of the placeholders in the template + +`xdm:body` +* is optional +* type: `string` +* defined in this schema + +### xdm:body Type + + +`string` + + + + + + +## xdm:ccAddress +### An array of email addresses for the cc list + +Person or list of people who are in the cc list of the email message + +`xdm:ccAddress` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:ccAddress Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `email` – email address (according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322)) + + + + + + + + +## xdm:failureReasonCode +### Reason code for failure + +Indicates the error code for not able to deliver the email message + +`xdm:failureReasonCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:failureReasonCode Type + + +`string` + + + + + + +## xdm:failureReasonMessage +### Reason Message for failure + +Indicates the full message for the error code, for not able to deliver the message + +`xdm:failureReasonMessage` +* is optional +* type: `string` +* defined in this schema + +### xdm:failureReasonMessage Type + + +`string` + + + + + + +## xdm:firstOpenDate +### First time the email was opened by the receiver + +First date and time when the receiver took the action to open the email + +`xdm:firstOpenDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:firstOpenDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:fromAddress +### Person sending the email communication + +Person who is sender of the email message + +`xdm:fromAddress` +* is optional +* type: `string` +* defined in this schema + +### xdm:fromAddress Type + + +`string` +* format: `email` – email address (according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322)) + + + + + + +## xdm:hasAttachments +### Email has attachments + +A flag represent whether any attachment is part of the email message + +`xdm:hasAttachments` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:hasAttachments Type + + +`boolean` + + + + + +## xdm:headers +### Email headers + +Captures the headers of the email for diagnosis + +`xdm:headers` +* is optional +* type: `string` +* defined in this schema + +### xdm:headers Type + + +`string` + + + + + + +## xdm:incomingMessage +### Inbound or Outbound Message + +A flag to represent whether a message was sent or recieved + +`xdm:incomingMessage` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:incomingMessage Type + + +`boolean` + + + + + +## xdm:isQuarantined +### quarantine message + +A flag to represent whether the email message is a spam + +`xdm:isQuarantined` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isQuarantined Type + + +`boolean` + + + + + +## xdm:isTracked +### Email Tracking flag + +A flag to capture whether the email was tracked by the sender + +`xdm:isTracked` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isTracked Type + + +`boolean` + + + + + +## xdm:lastOpenDate +### Last time when the email was opened by the receiver + +Last time the email was opened, by any receiver + +`xdm:lastOpenDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:lastOpenDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:priority +### Email's priority + +Captures the priority set by the person who sent the email + +`xdm:priority` +* is optional +* type: `string` +* defined in this schema + +### xdm:priority Type + + +`string` + + + + + + +## xdm:receivedDateTime +### Date and time the email was received + +Captures the date and time when the email was received + +`xdm:receivedDateTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:receivedDateTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:sentDateTime +### Date and time the email was sent + +Captures the date and time the email correspondence was sent to an individual or a group of people + +`xdm:sentDateTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:sentDateTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:sizeInBytes +### Email message size + +Record the size of the email message in bytes + +`xdm:sizeInBytes` +* is optional +* type: `number` +* defined in this schema + +### xdm:sizeInBytes Type + + +`number` + + + + + + +## xdm:toAddress +### An array of email addresses for the To list + +Person or list of people who are in the To list of the email message + +`xdm:toAddress` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:toAddress Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `email` – email address (according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322)) + + + + + + + diff --git a/docs/reference/datatypes/emailaddress.schema.json b/docs/reference/datatypes/emailaddress.schema.json new file mode 100644 index 000000000..1673bf7ef --- /dev/null +++ b/docs/reference/datatypes/emailaddress.schema.json @@ -0,0 +1,83 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/emailaddress", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Email address", + "type": "object", + "meta:extensible": true, + "description": "A standard email address.", + "definitions": { + "emailaddress": { + "properties": { + "xdm:primary": { + "title": "Primary", + "type": "boolean", + "description": "Primary email indicator. A profile can have only one `primary` email address at a given point of time." + }, + "xdm:address": { + "title": "Address", + "type": "string", + "format": "email", + "description": "The technical address, for example, 'name@domain.com' as commonly defined in RFC2822 and subsequent standards." + }, + "xdm:label": { + "title": "Label", + "type": "string", + "description": "Additional display information that maybe available, for example, Microsoft Outlook rich address controls display 'John Smith smithjr@company.uk', 'John Smith' part is data that would be placed in the label." + }, + "xdm:type": { + "title": "Type", + "type": "string", + "description": "The way the account relates to the person for example 'work' or 'personal'.", + "meta:enum": { + "unknown": "Unknown", + "personal": "Personal", + "work": "Work", + "education": "Education" + } + }, + "xdm:status": { + "title": "Status", + "type": "string", + "description": "An indication as to the ability to use the email address.", + "default": "active", + "meta:enum": { + "active": "Active", + "incomplete": "Incomplete", + "pending_verification": "Pending verification", + "blacklisted": "Blacklisted", + "blocked": "Blocked" + } + }, + "xdm:statusReason": { + "title": "Status reason", + "type": "string", + "description": "A description of the current status." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/emailaddress" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/emailaddress.schema.md b/docs/reference/datatypes/emailaddress.schema.md new file mode 100644 index 000000000..ef8f01132 --- /dev/null +++ b/docs/reference/datatypes/emailaddress.schema.md @@ -0,0 +1,178 @@ + +# Email address Schema + +``` +https://ns.adobe.com/xdm/context/emailaddress +``` + +A standard email address. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/emailaddress.schema.json](datatypes/emailaddress.schema.json) | +## Schema Hierarchy + +* Email address `https://ns.adobe.com/xdm/context/emailaddress` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Email address Example +```json +{ + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active" +} +``` + +# Email address Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:address](#xdmaddress) | `string` | Optional | | Email address (this schema) | +| [xdm:label](#xdmlabel) | `string` | Optional | | Email address (this schema) | +| [xdm:primary](#xdmprimary) | `boolean` | Optional | | Email address (this schema) | +| [xdm:status](#xdmstatus) | `string` | Optional | `"active"` | Email address (this schema) | +| [xdm:statusReason](#xdmstatusreason) | `string` | Optional | | Email address (this schema) | +| [xdm:type](#xdmtype) | `string` | Optional | | Email address (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:address +### Address + +The technical address, for example, 'name@domain.com' as commonly defined in RFC2822 and subsequent standards. + +`xdm:address` +* is optional +* type: `string` +* defined in this schema + +### xdm:address Type + + +`string` +* format: `email` – email address (according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322)) + + + + + + +## xdm:label +### Label + +Additional display information that maybe available, for example, Microsoft Outlook rich address controls display 'John Smith smithjr@company.uk', 'John Smith' part is data that would be placed in the label. + +`xdm:label` +* is optional +* type: `string` +* defined in this schema + +### xdm:label Type + + +`string` + + + + + + +## xdm:primary +### Primary + +Primary email indicator. A profile can have only one `primary` email address at a given point of time. + +`xdm:primary` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:primary Type + + +`boolean` + + + + + +## xdm:status +### Status + +An indication as to the ability to use the email address. + +`xdm:status` +* is optional +* type: `string` +* default: `"active"` +* defined in this schema + +### xdm:status Type + + +`string` + + + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `active` | Active | +| `incomplete` | Incomplete | +| `pending_verification` | Pending verification | +| `blacklisted` | Blacklisted | +| `blocked` | Blocked | + + + + +## xdm:statusReason +### Status reason + +A description of the current status. + +`xdm:statusReason` +* is optional +* type: `string` +* defined in this schema + +### xdm:statusReason Type + + +`string` + + + + + + +## xdm:type +### Type + +The way the account relates to the person for example 'work' or 'personal'. + +`xdm:type` +* is optional +* type: `string` +* defined in this schema + +### xdm:type Type + + +`string` + + + +### xdm:type Known Values +| Value | Description | +|-------|-------------| +| `unknown` | Unknown | +| `personal` | Personal | +| `work` | Work | +| `education` | Education | + + + diff --git a/docs/reference/datatypes/enduserids.schema.json b/docs/reference/datatypes/enduserids.schema.json new file mode 100644 index 000000000..9dafb0dcf --- /dev/null +++ b/docs/reference/datatypes/enduserids.schema.json @@ -0,0 +1,109 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/enduserids", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "End user IDs", + "type": "object", + "meta:extensible": true, + "description": "The End User IDs schema is used to represent a federated identity of a visitor or known profile across a number of data sources.\n\nIt is an `object` that is using the `@id` of an XDM data source as keys.\nEach value consists of the (required) ID that is native to the data source, and (optional) metadata about the data source as well as (optional) confidence in the stitching.\n\nAdditionally, this schema can include a property that describes the data source that is responsible for identity stitching.\n", + "minProperties": 1, + "definitions": { + "enduserids": { + "properties": { + "https://ns.adobe.com/experience/mcid": { + "title": "Adobe Marketing Cloud ID", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "A unique identifier from Adobe Marketing Cloud." + }, + "https://ns.adobe.com/experience/aaid": { + "title": "Adobe Analytics Cloud end user IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Adobe Analytics Cloud extension to end user IDs." + }, + "https://ns.adobe.com/experience/aacustomid": { + "title": "Adobe Analytics Cloud Custom end user IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "An Adobe Analytics custom identifier passed in on a hit." + }, + "https://ns.adobe.com/experience/acid": { + "title": "Adobe Campaign end user IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Adobe Campaign extension to end user IDs." + }, + "https://ns.adobe.com/experience/tntid": { + "title": "Adobe Target end user IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Adobe Target extension to end user IDs." + }, + "https://ns.adobe.com/experience/adcloud": { + "title": "Adobe Advertising Cloud end user IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Adobe Advertising Cloud extension to end user IDs." + }, + "https://ns.adobe.com/experience/emailid": { + "title": "Email address IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Email addresses used as IDs." + }, + "https://ns.adobe.com/experience/phonenumberid": { + "title": "Phone number IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Phone numbers used as IDs." + } + }, + "patternProperties": { + ".+://.+": { + "description": "The identifier, including data source, foreign ID, and confidence. Note, `@id` must be identical to the property value.", + "type": "object", + "$ref": "https://ns.adobe.com/xdm/context/identity" + } + } + } + }, + "meta:keys": { + "https://ns.adobe.com/experience/adcloud": "Adobe Advertising Cloud", + "https://ns.adobe.com/experience/tntid": "Adobe Target", + "https://ns.adobe.com/experience/acid": "Adobe Campaign", + "https://ns.adobe.com/experience/aaid": "Adobe Analytics", + "https://ns.adobe.com/experience/aacustomid": "Adobe Analytics custom", + "https://ns.adobe.com/experience/mcid": "Marketing Cloud identity core service", + "https://ns.adobe.com/experience/emailid": "Email address", + "https://ns.adobe.com/experience/phonenumberid": "Phone number" + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/enduserids" + } + ], + "meta:status": "stable", + "examples": [ + { + "https://ns.adobe.com/experience/mcid": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "ECID" + } + }, + "https://ns.adobe.com/experience/aaid": { + "@id": "https://data.adobe.io/entities/identity/2394509340-30453470347", + "xdm:namespace": { + "xdm:code": "AVID" + } + }, + "https://ns.adobe.com/experience/tntid": { + "@id": "https://data.adobe.io/entities/identity/1233ce17-20e0-4a2c-8198-2a77fd60cf4d", + "xdm:namespace": { + "xdm:code": "tnt0051" + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/enduserids.schema.md b/docs/reference/datatypes/enduserids.schema.md new file mode 100644 index 000000000..010e52073 --- /dev/null +++ b/docs/reference/datatypes/enduserids.schema.md @@ -0,0 +1,214 @@ + +# End user IDs Schema + +``` +https://ns.adobe.com/xdm/context/enduserids +``` + +The End User IDs schema is used to represent a federated identity of a visitor or known profile across a number of data sources. + +It is an `object` that is using the `@id` of an XDM data source as keys. +Each value consists of the (required) ID that is native to the data source, and (optional) metadata about the data source as well as (optional) confidence in the stitching. + +Additionally, this schema can include a property that describes the data source that is responsible for identity stitching. + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/enduserids.schema.json](datatypes/enduserids.schema.json) | +## Schema Hierarchy + +* End user IDs `https://ns.adobe.com/xdm/context/enduserids` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Identity](identity.schema.md) `https://ns.adobe.com/xdm/context/identity` + + +## End user IDs Example +```json +{ + "https://ns.adobe.com/experience/mcid": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "ECID" + } + }, + "https://ns.adobe.com/experience/aaid": { + "@id": "https://data.adobe.io/entities/identity/2394509340-30453470347", + "xdm:namespace": { + "xdm:code": "AVID" + } + }, + "https://ns.adobe.com/experience/tntid": { + "@id": "https://data.adobe.io/entities/identity/1233ce17-20e0-4a2c-8198-2a77fd60cf4d", + "xdm:namespace": { + "xdm:code": "tnt0051" + } + } +} +``` + +# End user IDs Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [https://ns.adobe.com/experience/aacustomid](#httpsnsadobecomexperienceaacustomid) | Identity | Optional | End user IDs (this schema) | +| [https://ns.adobe.com/experience/aaid](#httpsnsadobecomexperienceaaid) | Identity | Optional | End user IDs (this schema) | +| [https://ns.adobe.com/experience/acid](#httpsnsadobecomexperienceacid) | Identity | Optional | End user IDs (this schema) | +| [https://ns.adobe.com/experience/adcloud](#httpsnsadobecomexperienceadcloud) | Identity | Optional | End user IDs (this schema) | +| [https://ns.adobe.com/experience/emailid](#httpsnsadobecomexperienceemailid) | Identity | Optional | End user IDs (this schema) | +| [https://ns.adobe.com/experience/mcid](#httpsnsadobecomexperiencemcid) | Identity | Optional | End user IDs (this schema) | +| [https://ns.adobe.com/experience/phonenumberid](#httpsnsadobecomexperiencephonenumberid) | Identity | Optional | End user IDs (this schema) | +| [https://ns.adobe.com/experience/tntid](#httpsnsadobecomexperiencetntid) | Identity | Optional | End user IDs (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/experience/aacustomid +### Adobe Analytics Cloud Custom end user IDs + +An Adobe Analytics custom identifier passed in on a hit. + +`https://ns.adobe.com/experience/aacustomid` +* is optional +* type: Identity +* defined in this schema + +### https://ns.adobe.com/experience/aacustomid Type + + +* [Identity](identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + + +## https://ns.adobe.com/experience/aaid +### Adobe Analytics Cloud end user IDs + +Adobe Analytics Cloud extension to end user IDs. + +`https://ns.adobe.com/experience/aaid` +* is optional +* type: Identity +* defined in this schema + +### https://ns.adobe.com/experience/aaid Type + + +* [Identity](identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + + +## https://ns.adobe.com/experience/acid +### Adobe Campaign end user IDs + +Adobe Campaign extension to end user IDs. + +`https://ns.adobe.com/experience/acid` +* is optional +* type: Identity +* defined in this schema + +### https://ns.adobe.com/experience/acid Type + + +* [Identity](identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + + +## https://ns.adobe.com/experience/adcloud +### Adobe Advertising Cloud end user IDs + +Adobe Advertising Cloud extension to end user IDs. + +`https://ns.adobe.com/experience/adcloud` +* is optional +* type: Identity +* defined in this schema + +### https://ns.adobe.com/experience/adcloud Type + + +* [Identity](identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + + +## https://ns.adobe.com/experience/emailid +### Email address IDs + +Email addresses used as IDs. + +`https://ns.adobe.com/experience/emailid` +* is optional +* type: Identity +* defined in this schema + +### https://ns.adobe.com/experience/emailid Type + + +* [Identity](identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + + +## https://ns.adobe.com/experience/mcid +### Adobe Marketing Cloud ID + +A unique identifier from Adobe Marketing Cloud. + +`https://ns.adobe.com/experience/mcid` +* is optional +* type: Identity +* defined in this schema + +### https://ns.adobe.com/experience/mcid Type + + +* [Identity](identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + + +## https://ns.adobe.com/experience/phonenumberid +### Phone number IDs + +Phone numbers used as IDs. + +`https://ns.adobe.com/experience/phonenumberid` +* is optional +* type: Identity +* defined in this schema + +### https://ns.adobe.com/experience/phonenumberid Type + + +* [Identity](identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + + +## https://ns.adobe.com/experience/tntid +### Adobe Target end user IDs + +Adobe Target extension to end user IDs. + +`https://ns.adobe.com/experience/tntid` +* is optional +* type: Identity +* defined in this schema + +### https://ns.adobe.com/experience/tntid Type + + +* [Identity](identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + diff --git a/docs/reference/datatypes/environment.schema.json b/docs/reference/datatypes/environment.schema.json new file mode 100644 index 000000000..2e25df812 --- /dev/null +++ b/docs/reference/datatypes/environment.schema.json @@ -0,0 +1,190 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/environment", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Environment", + "type": "object", + "meta:extensible": true, + "description": "Information about the surrounding situation the event observation occurred, specifically detailing transitory information such as the network or software versions. IMPORTANT: All values should be aligned with the [DeviceAtlas](https://deviceatlas.com) database licensed by Adobe. ", + "definitions": { + "environment": { + "properties": { + "xdm:type": { + "title": "Type", + "type": "string", + "description": "The type of the application environment.", + "enum": [ + "browser", + "application", + "iot", + "external", + "widget" + ], + "meta:enum": { + "browser": "Browser", + "application": "Application", + "iot": "Internet of things", + "external": "External system", + "widget": "Application extension" + } + }, + "xdm:browserDetails": { + "title": "Browser details", + "$ref": "https://ns.adobe.com/xdm/context/browserdetails", + "description": "The browser specific details such as browser name, version, javascript version, user agent string, and accept language." + }, + "xdm:operatingSystem": { + "title": "Operating system", + "type": "string", + "description": "The name of the operating system used when the observation was made. The attribute should not contain any version information such as '10.5.3', but instead contain 'edition' designations such as 'Ultimate' or 'Professional'." + }, + "xdm:operatingSystemVersion": { + "title": "Operating system version", + "type": "string", + "description": "The full version identifier for the operating system used when the observation was made. Versions are generally numerically composed but may be in a vendor defined format." + }, + "xdm:operatingSystemVendor": { + "title": "Operating system vendor", + "type": "string", + "description": "The name of the operating system vendor used when the observation was made." + }, + "xdm:colorDepth": { + "title": "Color depth", + "type": "integer", + "description": "The number of bits used for each color component of a single pixel.", + "minimum": 0 + }, + "xdm:viewportHeight": { + "title": "Viewport height", + "type": "integer", + "description": "The vertical size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport height.", + "minimum": 0 + }, + "xdm:viewportWidth": { + "title": "Viewport width", + "type": "integer", + "description": "The horizontal size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport width.", + "minimum": 0 + }, + "xdm:connectionType": { + "title": "Connection type", + "type": "string", + "description": "Internet connection type.", + "enum": [ + "dialup", + "isdn", + "bisdn", + "dsl", + "cable", + "wireless_wifi", + "mobile", + "mobile_edge", + "mobile_2g", + "mobile_3g", + "mobile_lte", + "t1", + "t3", + "oc3", + "lan", + "modem" + ], + "meta:enum": { + "dialup": "Dial-up", + "isdn": "ISDN", + "bisdn": "BISDN", + "dsl": "DSL", + "cable": "Cable", + "wireless_wifi": "Wireless wifi", + "mobile": "Mobile", + "mobile_edge": "Mobile Edge", + "mobile_gprs": "Mobile GPRS", + "mobile_2g": "Mobile 2G", + "mobile_3g": "Mobile 3G", + "mobile_lte": "Mobile LTE", + "t1": "T1", + "t3": "T3", + "oc3": "OC3", + "lan": "LAN", + "modem": "Modem" + } + }, + "xdm:carrier": { + "title": "Mobile network carrier", + "type": "string", + "description": "A mobile network carrier or MNO, also known as a wireless service provider, wireless carrier, cellular company, or mobile network carrier, is a provider of services wireless communications that owns or controls all the elements necessary to sell and deliver services to an end user." + }, + "xdm:ipV4": { + "title": "IPv4", + "type": "string", + "format": "ipv4", + "description": "The numerical label assigned to a device participating in a computer network that uses the Internet Protocol for communication. " + }, + "xdm:ipV6": { + "title": "IPv6", + "type": "string", + "format": "ipv6", + "description": "The numerical label assigned to a device participating in a computer network that uses the Internet Protocol for communication. " + }, + "xdm:domain": { + "title": "Domain", + "type": "string", + "description": "The domain of the users ISP." + }, + "xdm:ISP": { + "title": "Internet service provider", + "type": "string", + "description": "The name of the user's internet service provider." + }, + "dc:language": { + "meta:usereditable": false, + "title": "Language", + "type": "string", + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "description": "The language of the environment to represent the user's linguistic, geographical, or cultural preferences for data presentation.\nLanguages are specified in language code as defined in [IETF RFC 3066](https://www.ietf.org/rfc/rfc3066.txt), which is part of BCP 47, which is used elsewhere in XDM.", + "examples": [ + "en-US", + "pt-BR", + "es-ES" + ] + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/environment" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:operatingSystemVendor": "Apple", + "xdm:connectionType": "cable", + "xdm:domain": "verizon.com", + "xdm:ISP": "Verizon" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/environment.schema.md b/docs/reference/datatypes/environment.schema.md new file mode 100644 index 000000000..82219623a --- /dev/null +++ b/docs/reference/datatypes/environment.schema.md @@ -0,0 +1,413 @@ + +# Environment Schema + +``` +https://ns.adobe.com/xdm/context/environment +``` + +Information about the surrounding situation the event observation occurred, specifically detailing transitory information such as the network or software versions. IMPORTANT: All values should be aligned with the [DeviceAtlas](https://deviceatlas.com) database licensed by Adobe. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/environment.schema.json](datatypes/environment.schema.json) | +## Schema Hierarchy + +* Environment `https://ns.adobe.com/xdm/context/environment` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Browser details](browserdetails.schema.md) `https://ns.adobe.com/xdm/context/browserdetails` + + +## Environment Example +```json +{ + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:operatingSystemVendor": "Apple", + "xdm:connectionType": "cable", + "xdm:domain": "verizon.com", + "xdm:ISP": "Verizon" +} +``` + +# Environment Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [dc:language](#dclanguage) | `string` | Optional | Environment (this schema) | +| [xdm:ISP](#xdmisp) | `string` | Optional | Environment (this schema) | +| [xdm:browserDetails](#xdmbrowserdetails) | Browser details | Optional | Environment (this schema) | +| [xdm:carrier](#xdmcarrier) | `string` | Optional | Environment (this schema) | +| [xdm:colorDepth](#xdmcolordepth) | `integer` | Optional | Environment (this schema) | +| [xdm:connectionType](#xdmconnectiontype) | `enum` | Optional | Environment (this schema) | +| [xdm:domain](#xdmdomain) | `string` | Optional | Environment (this schema) | +| [xdm:ipV4](#xdmipv4) | `string` | Optional | Environment (this schema) | +| [xdm:ipV6](#xdmipv6) | `string` | Optional | Environment (this schema) | +| [xdm:operatingSystem](#xdmoperatingsystem) | `string` | Optional | Environment (this schema) | +| [xdm:operatingSystemVendor](#xdmoperatingsystemvendor) | `string` | Optional | Environment (this schema) | +| [xdm:operatingSystemVersion](#xdmoperatingsystemversion) | `string` | Optional | Environment (this schema) | +| [xdm:type](#xdmtype) | `enum` | Optional | Environment (this schema) | +| [xdm:viewportHeight](#xdmviewportheight) | `integer` | Optional | Environment (this schema) | +| [xdm:viewportWidth](#xdmviewportwidth) | `integer` | Optional | Environment (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## dc:language +### Language + +The language of the environment to represent the user's linguistic, geographical, or cultural preferences for data presentation. +Languages are specified in language code as defined in [IETF RFC 3066](https://www.ietf.org/rfc/rfc3066.txt), which is part of BCP 47, which is used elsewhere in XDM. + +`dc:language` +* is optional +* type: `string` +* defined in this schema + +### dc:language Type + + +`string` + + +All instances must conform to this regular expression +```regex +^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ +``` + +* test example: [en-US](https://regexr.com/?expression=%5E((((%5BA-Za-z%5D%7B2%2C3%7D(-(%5BA-Za-z%5D%7B3%7D(-%5BA-Za-z%5D%7B3%7D)%7B0%2C2%7D))%3F)%7C%5BA-Za-z%5D%7B4%7D%7C%5BA-Za-z%5D%7B5%2C8%7D)(-(%5BA-Za-z%5D%7B4%7D))%3F(-(%5BA-Za-z%5D%7B2%7D%7C%5B0-9%5D%7B3%7D))%3F(-(%5BA-Za-z0-9%5D%7B5%2C8%7D%7C%5B0-9%5D%5BA-Za-z0-9%5D%7B3%7D))*(-(%5B0-9A-WY-Za-wy-z%5D(-%5BA-Za-z0-9%5D%7B2%2C8%7D)%2B))*(-(x(-%5BA-Za-z0-9%5D%7B1%2C8%7D)%2B))%3F)%7C(x(-%5BA-Za-z0-9%5D%7B1%2C8%7D)%2B)%7C((en-GB-oed%7Ci-ami%7Ci-bnn%7Ci-default%7Ci-enochian%7Ci-hak%7Ci-klingon%7Ci-lux%7Ci-mingo%7Ci-navajo%7Ci-pwn%7Ci-tao%7Ci-tay%7Ci-tsu%7Csgn-BE-FR%7Csgn-BE-NL%7Csgn-CH-DE)%7C(art-lojban%7Ccel-gaulish%7Cno-bok%7Cno-nyn%7Czh-guoyu%7Czh-hakka%7Czh-min%7Czh-min-nan%7Czh-xiang)))%24&text=en-US) +* test example: [pt-BR](https://regexr.com/?expression=%5E((((%5BA-Za-z%5D%7B2%2C3%7D(-(%5BA-Za-z%5D%7B3%7D(-%5BA-Za-z%5D%7B3%7D)%7B0%2C2%7D))%3F)%7C%5BA-Za-z%5D%7B4%7D%7C%5BA-Za-z%5D%7B5%2C8%7D)(-(%5BA-Za-z%5D%7B4%7D))%3F(-(%5BA-Za-z%5D%7B2%7D%7C%5B0-9%5D%7B3%7D))%3F(-(%5BA-Za-z0-9%5D%7B5%2C8%7D%7C%5B0-9%5D%5BA-Za-z0-9%5D%7B3%7D))*(-(%5B0-9A-WY-Za-wy-z%5D(-%5BA-Za-z0-9%5D%7B2%2C8%7D)%2B))*(-(x(-%5BA-Za-z0-9%5D%7B1%2C8%7D)%2B))%3F)%7C(x(-%5BA-Za-z0-9%5D%7B1%2C8%7D)%2B)%7C((en-GB-oed%7Ci-ami%7Ci-bnn%7Ci-default%7Ci-enochian%7Ci-hak%7Ci-klingon%7Ci-lux%7Ci-mingo%7Ci-navajo%7Ci-pwn%7Ci-tao%7Ci-tay%7Ci-tsu%7Csgn-BE-FR%7Csgn-BE-NL%7Csgn-CH-DE)%7C(art-lojban%7Ccel-gaulish%7Cno-bok%7Cno-nyn%7Czh-guoyu%7Czh-hakka%7Czh-min%7Czh-min-nan%7Czh-xiang)))%24&text=pt-BR) +* test example: [es-ES](https://regexr.com/?expression=%5E((((%5BA-Za-z%5D%7B2%2C3%7D(-(%5BA-Za-z%5D%7B3%7D(-%5BA-Za-z%5D%7B3%7D)%7B0%2C2%7D))%3F)%7C%5BA-Za-z%5D%7B4%7D%7C%5BA-Za-z%5D%7B5%2C8%7D)(-(%5BA-Za-z%5D%7B4%7D))%3F(-(%5BA-Za-z%5D%7B2%7D%7C%5B0-9%5D%7B3%7D))%3F(-(%5BA-Za-z0-9%5D%7B5%2C8%7D%7C%5B0-9%5D%5BA-Za-z0-9%5D%7B3%7D))*(-(%5B0-9A-WY-Za-wy-z%5D(-%5BA-Za-z0-9%5D%7B2%2C8%7D)%2B))*(-(x(-%5BA-Za-z0-9%5D%7B1%2C8%7D)%2B))%3F)%7C(x(-%5BA-Za-z0-9%5D%7B1%2C8%7D)%2B)%7C((en-GB-oed%7Ci-ami%7Ci-bnn%7Ci-default%7Ci-enochian%7Ci-hak%7Ci-klingon%7Ci-lux%7Ci-mingo%7Ci-navajo%7Ci-pwn%7Ci-tao%7Ci-tay%7Ci-tsu%7Csgn-BE-FR%7Csgn-BE-NL%7Csgn-CH-DE)%7C(art-lojban%7Ccel-gaulish%7Cno-bok%7Cno-nyn%7Czh-guoyu%7Czh-hakka%7Czh-min%7Czh-min-nan%7Czh-xiang)))%24&text=es-ES) + + + + +### dc:language Examples + +```json +"en-US" +``` + +```json +"pt-BR" +``` + +```json +"es-ES" +``` + + + +## xdm:ISP +### Internet service provider + +The name of the user's internet service provider. + +`xdm:ISP` +* is optional +* type: `string` +* defined in this schema + +### xdm:ISP Type + + +`string` + + + + + + +## xdm:browserDetails +### Browser details + +The browser specific details such as browser name, version, javascript version, user agent string, and accept language. + +`xdm:browserDetails` +* is optional +* type: Browser details +* defined in this schema + +### xdm:browserDetails Type + + +* [Browser details](browserdetails.schema.md) – `https://ns.adobe.com/xdm/context/browserdetails` + + + + + +## xdm:carrier +### Mobile network carrier + +A mobile network carrier or MNO, also known as a wireless service provider, wireless carrier, cellular company, or mobile network carrier, is a provider of services wireless communications that owns or controls all the elements necessary to sell and deliver services to an end user. + +`xdm:carrier` +* is optional +* type: `string` +* defined in this schema + +### xdm:carrier Type + + +`string` + + + + + + +## xdm:colorDepth +### Color depth + +The number of bits used for each color component of a single pixel. + +`xdm:colorDepth` +* is optional +* type: `integer` +* defined in this schema + +### xdm:colorDepth Type + + +`integer` +* minimum value: `0` + + + + + + +## xdm:connectionType +### Connection type + +Internet connection type. + +`xdm:connectionType` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmconnectiontype-known-values). + +### xdm:connectionType Known Values +| Value | Description | +|-------|-------------| +| `dialup` | Dial-up | +| `isdn` | ISDN | +| `bisdn` | BISDN | +| `dsl` | DSL | +| `cable` | Cable | +| `wireless_wifi` | Wireless wifi | +| `mobile` | Mobile | +| `mobile_edge` | Mobile Edge | +| `mobile_gprs` | Mobile GPRS | +| `mobile_2g` | Mobile 2G | +| `mobile_3g` | Mobile 3G | +| `mobile_lte` | Mobile LTE | +| `t1` | T1 | +| `t3` | T3 | +| `oc3` | OC3 | +| `lan` | LAN | +| `modem` | Modem | + + + + +## xdm:domain +### Domain + +The domain of the users ISP. + +`xdm:domain` +* is optional +* type: `string` +* defined in this schema + +### xdm:domain Type + + +`string` + + + + + + +## xdm:ipV4 +### IPv4 + +The numerical label assigned to a device participating in a computer network that uses the Internet Protocol for communication. + +`xdm:ipV4` +* is optional +* type: `string` +* defined in this schema + +### xdm:ipV4 Type + + +`string` +* format: `ipv4` – IP (v4) address (according to [RFC 2673, section 3.2](https://tools.ietf.org/html/rfc2673)) + + + + + + +## xdm:ipV6 +### IPv6 + +The numerical label assigned to a device participating in a computer network that uses the Internet Protocol for communication. + +`xdm:ipV6` +* is optional +* type: `string` +* defined in this schema + +### xdm:ipV6 Type + + +`string` +* format: `ipv6` – IP (v6) address (according to [RFC 4291, section 2.2](https://tools.ietf.org/html/rfc4291)) + + + + + + +## xdm:operatingSystem +### Operating system + +The name of the operating system used when the observation was made. The attribute should not contain any version information such as '10.5.3', but instead contain 'edition' designations such as 'Ultimate' or 'Professional'. + +`xdm:operatingSystem` +* is optional +* type: `string` +* defined in this schema + +### xdm:operatingSystem Type + + +`string` + + + + + + +## xdm:operatingSystemVendor +### Operating system vendor + +The name of the operating system vendor used when the observation was made. + +`xdm:operatingSystemVendor` +* is optional +* type: `string` +* defined in this schema + +### xdm:operatingSystemVendor Type + + +`string` + + + + + + +## xdm:operatingSystemVersion +### Operating system version + +The full version identifier for the operating system used when the observation was made. Versions are generally numerically composed but may be in a vendor defined format. + +`xdm:operatingSystemVersion` +* is optional +* type: `string` +* defined in this schema + +### xdm:operatingSystemVersion Type + + +`string` + + + + + + +## xdm:type +### Type + +The type of the application environment. + +`xdm:type` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmtype-known-values). + +### xdm:type Known Values +| Value | Description | +|-------|-------------| +| `browser` | Browser | +| `application` | Application | +| `iot` | Internet of things | +| `external` | External system | +| `widget` | Application extension | + + + + +## xdm:viewportHeight +### Viewport height + +The vertical size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport height. + +`xdm:viewportHeight` +* is optional +* type: `integer` +* defined in this schema + +### xdm:viewportHeight Type + + +`integer` +* minimum value: `0` + + + + + + +## xdm:viewportWidth +### Viewport width + +The horizontal size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport width. + +`xdm:viewportWidth` +* is optional +* type: `integer` +* defined in this schema + +### xdm:viewportWidth Type + + +`integer` +* minimum value: `0` + + + + + diff --git a/docs/reference/datatypes/extensible.schema.json b/docs/reference/datatypes/extensible.schema.json new file mode 100644 index 000000000..2034c74cd --- /dev/null +++ b/docs/reference/datatypes/extensible.schema.json @@ -0,0 +1,382 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/common/extensible", + "type": "object", + "title": "Extensibility base schema", + "description": "This schema can be included by referencing `https://ns.adobe.com/xdm/common/extensible`. It will enable property-based extensibility with namespace protection.\n\nIn order to make a given schema extensible, include this section at the bottom of your schema:\n\n```json\n\"allOf\":[\n {\"$ref\": \"https://ns.adobe.com/xdm/common/extensible#/definitions/@context\"},\n {\"$ref\": \"#/definitions/…\"}\n ]\n```\n\nReplace `#/definitions/…` with the correct path to the `definitions` object in your local schema.\n", + "definitions": { + "@context": { + "oneOf": [ + { + "type": "object", + "patternProperties": { + "@type": {}, + "@id": {}, + "^xdm:.*$": {}, + "^core:.*$": {}, + "^meta:.*$": {}, + "^xmpMM:.*$": {}, + "^xmpDM:.*$": {}, + "^xmpRights:.*$": {}, + "^xmpTPg:.*$": {}, + "^xmp:.*$": {}, + "^stDim:.*$": {}, + "^dc:.*$": {}, + "^skos:.*$": {}, + "^rdf:.*$": {}, + "^rdfs:.*$": {}, + "^owl:.*$": {}, + "^xsd:.*$": {}, + "^xml:.*$": {}, + "^photoshop:.*$": {}, + "^tiff:.*$": {}, + "^plus:.*$": {}, + "^cc:.*$": {}, + "^stEvt:.*$": {}, + "^stFnt:.*$": {}, + "^stLayerGroup:.*$": {}, + "^stArtboard:.*$": {}, + "^exif:.*$": {}, + "^activitystreams:.*$": {}, + "^schema:.*$": {}, + "^repo:.*$": {}, + "^iptc4xmpExt:.*$": {}, + "^dsp:.*$": {}, + "^searchads:.*$": {}, + "^adcloud:.*$": {}, + "^id3:.*$": {}, + "^dataDotCom:.*$": {}, + "^marketo:.*$": {}, + ".+://.+": {}, + "@.*": {} + }, + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "@context": { + "type": "object", + "properties": { + "xdm": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/xdm/" + }, + "xdm:descriptorOneToOne": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne" + }, + "core": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/adobecloud/core/1.0/" + }, + "meta": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/adobecloud/meta/1.0/" + }, + "xmpMM": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/mm/" + }, + "xmpDM": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xmp/1.0/DynamicMedia/" + }, + "xmpRights": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/rights/" + }, + "xmpTPg": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/t/pg/" + }, + "xmp": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/" + }, + "stDim": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/sType/Dimensions#" + }, + "dc": { + "type": "string", + "format": "url", + "const": "http://purl.org/dc/elements/1.1/" + }, + "skos": { + "type": "string", + "format": "url", + "const": "http://www.w3.org/2004/02/skos/core#" + }, + "rdf": { + "type": "string", + "format": "url", + "const": "http://www.w3.org/1999/02/22-rdf-syntax-ns#" + }, + "rdfs": { + "type": "string", + "format": "url", + "const": "http://www.w3.org/2000/01/rdf-schema#" + }, + "owl": { + "type": "string", + "format": "url", + "const": "http://www.w3.org/2002/07/owl#" + }, + "xsd": { + "type": "string", + "format": "url", + "const": "http://www.w3.org/2001/XMLSchema#" + }, + "xml": { + "type": "string", + "format": "url", + "const": "http://www.w3.org/XML/1998/namespace/" + }, + "photoshop": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/photoshop/1.0/" + }, + "tiff": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/tiff/1.0/" + }, + "plus": { + "type": "string", + "format": "url", + "const": "http://ns.useplus.org/ldf/xmp/1.0/" + }, + "cc": { + "type": "string", + "format": "url", + "const": "http://creativecommons.org/ns#" + }, + "stEvt": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/sType/ResourceEvent#" + }, + "stFnt": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/sType/Font#" + }, + "stLayerGroup": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/core/1.0/sType/LayerGroup#" + }, + "stArtboard": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/core/1.0/sType/Artboard#" + }, + "exif": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/exif/1.0/#" + }, + "activitystreams": { + "type": "string", + "format": "url", + "const": "https://www.w3.org/ns/activitystreams" + }, + "schema": { + "type": "string", + "format": "url", + "const": "http://schema.org/" + }, + "repo": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/adobecloud/core/1.0/" + }, + "iptc4xmpExt": { + "type": "string", + "format": "url", + "const": "http://iptc.org/std/Iptc4xmpExt/1.1/" + }, + "dsp": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/adcloud/dsp/" + }, + "searchads": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/adcloud/searchads/" + }, + "adcloud": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/adcloud/" + }, + "id3": { + "type": "string", + "format": "url", + "const": "http://id3.org/ns/2.4/" + }, + "dataDotCom": { + "type": "string", + "format": "url", + "const": "https://www.data.com/" + }, + "marketo": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/marketo/" + } + }, + "additionalProperties": false, + "required": [ + "xdm" + ] + } + }, + "patternProperties": { + "^xdm:.*$": {}, + "^core:.*$": {}, + "^meta:.*$": {}, + "^xmpMM:.*$": {}, + "^xmpDM:.*$": {}, + "^xmpRights:.*$": {}, + "^xmpTPg:.*$": {}, + "^xmp:.*$": {}, + "^stDim:.*$": {}, + "^dc:.*$": {}, + "^skos:.*$": {}, + "^rdf:.*$": {}, + "^rdfs:.*$": {}, + "^owl:.*$": {}, + "^xsd:.*$": {}, + "^xml:.*$": {}, + "^photoshop:.*$": {}, + "^tiff:.*$": {}, + "^plus:.*$": {}, + "^cc:.*$": {}, + "^stEvt:.*$": {}, + "^stFnt:.*$": {}, + "^stLayerGroup:.*$": {}, + "^stArtboard:.*$": {}, + "^exif:.*$": {}, + "^activitystreams:.*$": {}, + "^schema:.*$": {}, + "^repo:.*$": {}, + "^iptc4xmpExt:.*$": {}, + "^dsp:.*$": {}, + "^searchads:.*$": {}, + "^adcloud:.*$": {}, + "^id3:.*$": {}, + "^dataDotCom:.*$": {}, + "^marketo:.*$": {}, + ".+://.+": {} + }, + "required": [ + "@context" + ], + "additionalProperties": false + } + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/@context" + } + ], + "meta:status": "stable", + "examples": [ + { + "@context": { + "xdm": "https://ns.adobe.com/xdm/", + "core": "http://ns.adobe.com/adobecloud/core/1.0/", + "meta": "http://ns.adobe.com/adobecloud/meta/1.0/", + "xmpMM": "http://ns.adobe.com/xap/1.0/mm/", + "xmpDM": "http://ns.adobe.com/xmp/1.0/DynamicMedia/", + "xmpRights": "http://ns.adobe.com/xap/1.0/rights/", + "xmpTPg": "http://ns.adobe.com/xap/1.0/t/pg/", + "xmp": "http://ns.adobe.com/xap/1.0/", + "stDim": "http://ns.adobe.com/xap/1.0/sType/Dimensions#", + "dc": "http://purl.org/dc/elements/1.1/", + "skos": "http://www.w3.org/2004/02/skos/core#", + "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", + "rdfs": "http://www.w3.org/2000/01/rdf-schema#", + "owl": "http://www.w3.org/2002/07/owl#", + "xsd": "http://www.w3.org/2001/XMLSchema#", + "xml": "http://www.w3.org/XML/1998/namespace/", + "photoshop": "http://ns.adobe.com/photoshop/1.0/", + "tiff": "http://ns.adobe.com/tiff/1.0/", + "plus": "http://ns.useplus.org/ldf/xmp/1.0/", + "cc": "http://creativecommons.org/ns#", + "stEvt": "http://ns.adobe.com/xap/1.0/sType/ResourceEvent#", + "stFnt": "http://ns.adobe.com/xap/1.0/sType/Font#", + "stLayerGroup": "http://ns.adobe.com/core/1.0/sType/LayerGroup#", + "stArtboard": "http://ns.adobe.com/core/1.0/sType/Artboard#", + "exif": "http://ns.adobe.com/exif/1.0/#", + "activitystreams": "https://www.w3.org/ns/activitystreams", + "schema": "http://schema.org", + "repo": "http://ns.adobe.com/adobecloud/core/1.0/" + }, + "https://ns.example.com/path": "/custom/path/1", + "https://ns.example.com/asset_name": "custom_asset_1", + "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", + "xdm:createDate": "2017-09-26T15:52:25+00:00", + "repo:createDate": "2017-09-26T15:52:25+00:00", + "xdm:repositoryCreatedBy": "lars", + "xdm:modifyDate": "2017-09-26T15:52:25+00:00", + "repo:modifyDate": "2017-09-26T15:52:25+00:00", + "xdm:repositoryLastModifiedBy": "2017-09-26T15:52:25+00:00", + "repo:version": "15", + "repo:size": 1632418, + "xdm:path": "here", + "repo:etag": "15" + }, + { + "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", + "xdm:createDate": "2017-09-26T15:52:25+00:00", + "repo:createDate": "2017-09-26T15:52:25+00:00", + "xdm:repositoryCreatedBy": "lars", + "xdm:modifyDate": "2017-09-26T15:52:25+00:00", + "repo:modifyDate": "2017-09-26T15:52:25+00:00", + "xdm:repositoryLastModifiedBy": "2017-09-26T15:52:25+00:00", + "repo:version": "15", + "dc:title": "This is an example", + "repo:size": 1632418, + "xdm:path": "/here", + "repo:etag": "15" + }, + { + "https://ns.example.com/asset_name": "custom_asset_1", + "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", + "xdm:createDate": "2017-09-26T15:52:25+00:00", + "repo:createDate": "2017-09-26T15:52:25+00:00", + "xdm:repositoryCreatedBy": "lars", + "xdm:modifyDate": "2017-09-26T15:52:25+00:00", + "repo:modifyDate": "2017-09-26T15:52:25+00:00", + "xdm:repository_lastModifiedBy": "2017-09-26T15:52:25+00:00", + "repo:version": "15", + "dc:title": "This is an example", + "repo:size": 1632418, + "xdm:path": "/here", + "repo:etag": "15" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/extensible.schema.md b/docs/reference/datatypes/extensible.schema.md new file mode 100644 index 000000000..d6f6c06e7 --- /dev/null +++ b/docs/reference/datatypes/extensible.schema.md @@ -0,0 +1,110 @@ + +# Extensibility base schema Schema + +``` +https://ns.adobe.com/xdm/common/extensible +``` + +This schema can be included by referencing `https://ns.adobe.com/xdm/common/extensible`. It will enable property-based extensibility with namespace protection. + +In order to make a given schema extensible, include this section at the bottom of your schema: + +```json +"allOf":[ + {"$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"}, + {"$ref": "#/definitions/…"} + ] +``` + +Replace `#/definitions/…` with the correct path to the `definitions` object in your local schema. + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Cannot be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/extensible.schema.json](datatypes/extensible.schema.json) | + +## Extensibility base schema Examples + +```json +{ + "@context": { + "xdm": "https://ns.adobe.com/xdm/", + "core": "http://ns.adobe.com/adobecloud/core/1.0/", + "meta": "http://ns.adobe.com/adobecloud/meta/1.0/", + "xmpMM": "http://ns.adobe.com/xap/1.0/mm/", + "xmpDM": "http://ns.adobe.com/xmp/1.0/DynamicMedia/", + "xmpRights": "http://ns.adobe.com/xap/1.0/rights/", + "xmpTPg": "http://ns.adobe.com/xap/1.0/t/pg/", + "xmp": "http://ns.adobe.com/xap/1.0/", + "stDim": "http://ns.adobe.com/xap/1.0/sType/Dimensions#", + "dc": "http://purl.org/dc/elements/1.1/", + "skos": "http://www.w3.org/2004/02/skos/core#", + "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", + "rdfs": "http://www.w3.org/2000/01/rdf-schema#", + "owl": "http://www.w3.org/2002/07/owl#", + "xsd": "http://www.w3.org/2001/XMLSchema#", + "xml": "http://www.w3.org/XML/1998/namespace/", + "photoshop": "http://ns.adobe.com/photoshop/1.0/", + "tiff": "http://ns.adobe.com/tiff/1.0/", + "plus": "http://ns.useplus.org/ldf/xmp/1.0/", + "cc": "http://creativecommons.org/ns#", + "stEvt": "http://ns.adobe.com/xap/1.0/sType/ResourceEvent#", + "stFnt": "http://ns.adobe.com/xap/1.0/sType/Font#", + "stLayerGroup": "http://ns.adobe.com/core/1.0/sType/LayerGroup#", + "stArtboard": "http://ns.adobe.com/core/1.0/sType/Artboard#", + "exif": "http://ns.adobe.com/exif/1.0/#", + "activitystreams": "https://www.w3.org/ns/activitystreams", + "schema": "http://schema.org", + "repo": "http://ns.adobe.com/adobecloud/core/1.0/" + }, + "https://ns.example.com/path": "/custom/path/1", + "https://ns.example.com/asset_name": "custom_asset_1", + "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", + "xdm:createDate": "2017-09-26T15:52:25+00:00", + "repo:createDate": "2017-09-26T15:52:25+00:00", + "xdm:repositoryCreatedBy": "lars", + "xdm:modifyDate": "2017-09-26T15:52:25+00:00", + "repo:modifyDate": "2017-09-26T15:52:25+00:00", + "xdm:repositoryLastModifiedBy": "2017-09-26T15:52:25+00:00", + "repo:version": "15", + "repo:size": 1632418, + "xdm:path": "here", + "repo:etag": "15" +} +``` + +```json +{ + "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", + "xdm:createDate": "2017-09-26T15:52:25+00:00", + "repo:createDate": "2017-09-26T15:52:25+00:00", + "xdm:repositoryCreatedBy": "lars", + "xdm:modifyDate": "2017-09-26T15:52:25+00:00", + "repo:modifyDate": "2017-09-26T15:52:25+00:00", + "xdm:repositoryLastModifiedBy": "2017-09-26T15:52:25+00:00", + "repo:version": "15", + "dc:title": "This is an example", + "repo:size": 1632418, + "xdm:path": "/here", + "repo:etag": "15" +} +``` + +```json +{ + "https://ns.example.com/asset_name": "custom_asset_1", + "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", + "xdm:createDate": "2017-09-26T15:52:25+00:00", + "repo:createDate": "2017-09-26T15:52:25+00:00", + "xdm:repositoryCreatedBy": "lars", + "xdm:modifyDate": "2017-09-26T15:52:25+00:00", + "repo:modifyDate": "2017-09-26T15:52:25+00:00", + "xdm:repository_lastModifiedBy": "2017-09-26T15:52:25+00:00", + "repo:version": "15", + "dc:title": "This is an example", + "repo:size": 1632418, + "xdm:path": "/here", + "repo:etag": "15" +} +``` + diff --git a/docs/reference/datatypes/external-source-system-audit.schema.json b/docs/reference/datatypes/external-source-system-audit.schema.json new file mode 100644 index 000000000..e30d9c303 --- /dev/null +++ b/docs/reference/datatypes/external-source-system-audit.schema.json @@ -0,0 +1,80 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/external-source-system-audit", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "External Source System Audit Attributes", + "type": "object", + "meta:extensible": true, + "description": "External Source System Audit fields.", + "definitions": { + "externalSourceSystemAudit": { + "properties": { + "xdm:createdBy": { + "title": "Created By", + "description": "Name of the user who created this record", + "type": "string" + }, + "xdm:createdDate": { + "title": "Created Date", + "description": "Date when this record was created.", + "type": "string", + "format": "date-time" + }, + "xdm:lastUpdatedBy": { + "title": "Last Updated By", + "description": "User who last modified this record.", + "type": "string" + }, + "xdm:lastUpdatedDate": { + "title": "Last Updated Date", + "description": "Date when this record was last modofied.", + "type": "string", + "format": "date-time" + }, + "xdm:lastActivityDate": { + "title": "Last Activity Date", + "description": "Last activity date.", + "type": "string", + "format": "date-time" + }, + "xdm:lastReferencedDate": { + "title": "Last Referenced Date", + "description": "Last referenced date.", + "type": "string", + "format": "date-time" + }, + "xdm:lastViewedDate": { + "title": "Last Viewed Date", + "description": "Last viewed date.", + "type": "string", + "format": "date-time" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/externalSourceSystemAudit" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-02T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-02T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-02T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-02T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-02T15:52:25+00:00" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/external-source-system-audit.schema.md b/docs/reference/datatypes/external-source-system-audit.schema.md new file mode 100644 index 000000000..9bb4c5cbd --- /dev/null +++ b/docs/reference/datatypes/external-source-system-audit.schema.md @@ -0,0 +1,188 @@ + +# External Source System Audit Attributes Schema + +``` +https://ns.adobe.com/xdm/common/external-source-system-audit +``` + +External Source System Audit fields. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/external-source-system-audit.schema.json](datatypes/external-source-system-audit.schema.json) | +## Schema Hierarchy + +* External Source System Audit Attributes `https://ns.adobe.com/xdm/common/external-source-system-audit` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## External Source System Audit Attributes Example +```json +{ + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-02T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-02T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-02T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-02T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-02T15:52:25+00:00" +} +``` + +# External Source System Audit Attributes Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:createdBy](#xdmcreatedby) | `string` | Optional | External Source System Audit Attributes (this schema) | +| [xdm:createdDate](#xdmcreateddate) | `string` | Optional | External Source System Audit Attributes (this schema) | +| [xdm:lastActivityDate](#xdmlastactivitydate) | `string` | Optional | External Source System Audit Attributes (this schema) | +| [xdm:lastReferencedDate](#xdmlastreferenceddate) | `string` | Optional | External Source System Audit Attributes (this schema) | +| [xdm:lastUpdatedBy](#xdmlastupdatedby) | `string` | Optional | External Source System Audit Attributes (this schema) | +| [xdm:lastUpdatedDate](#xdmlastupdateddate) | `string` | Optional | External Source System Audit Attributes (this schema) | +| [xdm:lastViewedDate](#xdmlastvieweddate) | `string` | Optional | External Source System Audit Attributes (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:createdBy +### Created By + +Name of the user who created this record + +`xdm:createdBy` +* is optional +* type: `string` +* defined in this schema + +### xdm:createdBy Type + + +`string` + + + + + + +## xdm:createdDate +### Created Date + +Date when this record was created. + +`xdm:createdDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:createdDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:lastActivityDate +### Last Activity Date + +Last activity date. + +`xdm:lastActivityDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:lastActivityDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:lastReferencedDate +### Last Referenced Date + +Last referenced date. + +`xdm:lastReferencedDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:lastReferencedDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:lastUpdatedBy +### Last Updated By + +User who last modified this record. + +`xdm:lastUpdatedBy` +* is optional +* type: `string` +* defined in this schema + +### xdm:lastUpdatedBy Type + + +`string` + + + + + + +## xdm:lastUpdatedDate +### Last Updated Date + +Date when this record was last modofied. + +`xdm:lastUpdatedDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:lastUpdatedDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:lastViewedDate +### Last Viewed Date + +Last viewed date. + +`xdm:lastViewedDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:lastViewedDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + diff --git a/docs/reference/datatypes/external/id3/audio.schema.json b/docs/reference/datatypes/external/id3/audio.schema.json new file mode 100644 index 000000000..77b7caf27 --- /dev/null +++ b/docs/reference/datatypes/external/id3/audio.schema.json @@ -0,0 +1,41 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://id3.org/id3v2.4/audio", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Audio", + "type": "object", + "description": "Audio metadata based on [ID3 V2.4](https://id3.org/id3v2.4.0-frames)", + "definitions": { + "audio": { + "properties": { + "id3:TPUB": { + "title": "Record label", + "type": "string", + "description": "Name of the record label." + }, + "id3:TRSN": { + "title": "InternetRadioStationName", + "type": "string", + "description": "The radio station name on which the audio is played." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/audio" + } + ], + "meta:status": "stable", + "examples": [ + { + "id3:TRSN": "Q991.3", + "id3:TPUB": "Atlantic" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/external/id3/audio.schema.md b/docs/reference/datatypes/external/id3/audio.schema.md new file mode 100644 index 000000000..bb92206d9 --- /dev/null +++ b/docs/reference/datatypes/external/id3/audio.schema.md @@ -0,0 +1,68 @@ + +# Audio Schema + +``` +https://id3.org/id3v2.4/audio +``` + +Audio metadata based on [ID3 V2.4](https://id3.org/id3v2.4.0-frames) + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/external/id3/audio.schema.json](datatypes/external/id3/audio.schema.json) | + +## Audio Example +```json +{ + "id3:TRSN": "Q991.3", + "id3:TPUB": "Atlantic" +} +``` + +# Audio Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [id3:TPUB](#id3tpub) | `string` | Optional | Audio (this schema) | +| [id3:TRSN](#id3trsn) | `string` | Optional | Audio (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## id3:TPUB +### Record label + +Name of the record label. + +`id3:TPUB` +* is optional +* type: `string` +* defined in this schema + +### id3:TPUB Type + + +`string` + + + + + + +## id3:TRSN +### InternetRadioStationName + +The radio station name on which the audio is played. + +`id3:TRSN` +* is optional +* type: `string` +* defined in this schema + +### id3:TRSN Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/external/iptc/creator.schema.json b/docs/reference/datatypes/external/iptc/creator.schema.json new file mode 100644 index 000000000..f474a9340 --- /dev/null +++ b/docs/reference/datatypes/external/iptc/creator.schema.json @@ -0,0 +1,36 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "http://www.iptc.org/creator", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Creator", + "type": "object", + "description": "The creator of the show. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", + "definitions": { + "creator": { + "properties": { + "iptc4xmpExt:Name": { + "title": "Creator Name", + "type": "string", + "description": "Full name of the Creator." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/creator" + } + ], + "meta:status": "stable", + "examples": [ + { + "iptc4xmpExt:Name": "nba_highlights", + "iptc4xmpExt:Identifier": "http://espn.com/series-identifiers/2613953" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/external/iptc/creator.schema.md b/docs/reference/datatypes/external/iptc/creator.schema.md new file mode 100644 index 000000000..3678c2728 --- /dev/null +++ b/docs/reference/datatypes/external/iptc/creator.schema.md @@ -0,0 +1,47 @@ + +# Creator Schema + +``` +http://www.iptc.org/creator +``` + +The creator of the show. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html) + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/external/iptc/creator.schema.json](datatypes/external/iptc/creator.schema.json) | + +## Creator Example +```json +{ + "iptc4xmpExt:Name": "nba_highlights", + "iptc4xmpExt:Identifier": "http://espn.com/series-identifiers/2613953" +} +``` + +# Creator Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [iptc4xmpExt:Name](#iptc4xmpextname) | `string` | Optional | Creator (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## iptc4xmpExt:Name +### Creator Name + +Full name of the Creator. + +`iptc4xmpExt:Name` +* is optional +* type: `string` +* defined in this schema + +### iptc4xmpExt:Name Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/external/iptc/episode.schema.json b/docs/reference/datatypes/external/iptc/episode.schema.json new file mode 100644 index 000000000..7df08e7d7 --- /dev/null +++ b/docs/reference/datatypes/external/iptc/episode.schema.json @@ -0,0 +1,46 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "http://www.iptc.org/episode", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Episode", + "type": "object", + "description": "The episode of the show. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", + "definitions": { + "episode": { + "properties": { + "iptc4xmpExt:Name": { + "title": "Episode Name", + "type": "string", + "description": "Name of the episode." + }, + "iptc4xmpExt:Number": { + "title": "Episode Number", + "type": "number", + "description": "Number of the episode." + }, + "iptc4xmpExt:Identifier": { + "title": "Episode Identifier", + "type": "string", + "format": "uri", + "description": "Identifier of the episode." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/episode" + } + ], + "meta:status": "stable", + "examples": [ + { + "iptc4xmpExt:Number": 1 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/external/iptc/episode.schema.md b/docs/reference/datatypes/external/iptc/episode.schema.md new file mode 100644 index 000000000..10d364d70 --- /dev/null +++ b/docs/reference/datatypes/external/iptc/episode.schema.md @@ -0,0 +1,89 @@ + +# Episode Schema + +``` +http://www.iptc.org/episode +``` + +The episode of the show. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html) + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/external/iptc/episode.schema.json](datatypes/external/iptc/episode.schema.json) | + +## Episode Example +```json +{ + "iptc4xmpExt:Number": 1 +} +``` + +# Episode Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [iptc4xmpExt:Identifier](#iptc4xmpextidentifier) | `string` | Optional | Episode (this schema) | +| [iptc4xmpExt:Name](#iptc4xmpextname) | `string` | Optional | Episode (this schema) | +| [iptc4xmpExt:Number](#iptc4xmpextnumber) | `number` | Optional | Episode (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## iptc4xmpExt:Identifier +### Episode Identifier + +Identifier of the episode. + +`iptc4xmpExt:Identifier` +* is optional +* type: `string` +* defined in this schema + +### iptc4xmpExt:Identifier Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## iptc4xmpExt:Name +### Episode Name + +Name of the episode. + +`iptc4xmpExt:Name` +* is optional +* type: `string` +* defined in this schema + +### iptc4xmpExt:Name Type + + +`string` + + + + + + +## iptc4xmpExt:Number +### Episode Number + +Number of the episode. + +`iptc4xmpExt:Number` +* is optional +* type: `number` +* defined in this schema + +### iptc4xmpExt:Number Type + + +`number` + + + + + diff --git a/docs/reference/datatypes/external/iptc/rating.schema.json b/docs/reference/datatypes/external/iptc/rating.schema.json new file mode 100644 index 000000000..394ee58ee --- /dev/null +++ b/docs/reference/datatypes/external/iptc/rating.schema.json @@ -0,0 +1,46 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "http://www.iptc.org/rating", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Rating", + "type": "object", + "description": "The rating of the show. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", + "definitions": { + "rating": { + "properties": { + "iptc4xmpExt:RatingValue": { + "title": "Rating Value", + "type": "string", + "description": "Rating value as issued by the rating source." + }, + "iptc4xmpExt:RatingSourceLink": { + "title": "Rating Source Link", + "type": "string", + "format": "uri", + "description": "Link to the site and optionally the page of the party which has issued the rating value, linked resource should explain the rating rules." + } + }, + "required": [ + "iptc4xmpExt:RatingValue", + "iptc4xmpExt:RatingSourceLink" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/rating" + } + ], + "meta:status": "stable", + "examples": [ + { + "iptc4xmpExt:RatingValue": "TV14", + "iptc4xmpExt:RatingSourceLink": "http://www.tvguidelines.org/ratings.htm" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/external/iptc/rating.schema.md b/docs/reference/datatypes/external/iptc/rating.schema.md new file mode 100644 index 000000000..9831c369a --- /dev/null +++ b/docs/reference/datatypes/external/iptc/rating.schema.md @@ -0,0 +1,69 @@ + +# Rating Schema + +``` +http://www.iptc.org/rating +``` + +The rating of the show. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html) + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/external/iptc/rating.schema.json](datatypes/external/iptc/rating.schema.json) | + +## Rating Example +```json +{ + "iptc4xmpExt:RatingValue": "TV14", + "iptc4xmpExt:RatingSourceLink": "http://www.tvguidelines.org/ratings.htm" +} +``` + +# Rating Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [iptc4xmpExt:RatingSourceLink](#iptc4xmpextratingsourcelink) | `string` | Optional | Rating (this schema) | +| [iptc4xmpExt:RatingValue](#iptc4xmpextratingvalue) | `string` | Optional | Rating (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## iptc4xmpExt:RatingSourceLink +### Rating Source Link + +Link to the site and optionally the page of the party which has issued the rating value, linked resource should explain the rating rules. + +`iptc4xmpExt:RatingSourceLink` +* is optional +* type: `string` +* defined in this schema + +### iptc4xmpExt:RatingSourceLink Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## iptc4xmpExt:RatingValue +### Rating Value + +Rating value as issued by the rating source. + +`iptc4xmpExt:RatingValue` +* is optional +* type: `string` +* defined in this schema + +### iptc4xmpExt:RatingValue Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/external/iptc/season.schema.json b/docs/reference/datatypes/external/iptc/season.schema.json new file mode 100644 index 000000000..7e42fd648 --- /dev/null +++ b/docs/reference/datatypes/external/iptc/season.schema.json @@ -0,0 +1,46 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "http://www.iptc.org/season", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Season", + "type": "object", + "description": "The season the show belongs to. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", + "definitions": { + "season": { + "properties": { + "iptc4xmpExt:Name": { + "title": "Season Name", + "type": "string", + "description": "Name of the season." + }, + "iptc4xmpExt:Number": { + "title": "Season Number", + "type": "number", + "description": "Number of the season." + }, + "iptc4xmpExt:Identifier": { + "title": "Season Identifier", + "type": "string", + "format": "uri", + "description": "Identifier of the season." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/season" + } + ], + "meta:status": "stable", + "examples": [ + { + "iptc4xmpExt:Number": 1 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/external/iptc/season.schema.md b/docs/reference/datatypes/external/iptc/season.schema.md new file mode 100644 index 000000000..ae0299223 --- /dev/null +++ b/docs/reference/datatypes/external/iptc/season.schema.md @@ -0,0 +1,89 @@ + +# Season Schema + +``` +http://www.iptc.org/season +``` + +The season the show belongs to. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html) + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/external/iptc/season.schema.json](datatypes/external/iptc/season.schema.json) | + +## Season Example +```json +{ + "iptc4xmpExt:Number": 1 +} +``` + +# Season Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [iptc4xmpExt:Identifier](#iptc4xmpextidentifier) | `string` | Optional | Season (this schema) | +| [iptc4xmpExt:Name](#iptc4xmpextname) | `string` | Optional | Season (this schema) | +| [iptc4xmpExt:Number](#iptc4xmpextnumber) | `number` | Optional | Season (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## iptc4xmpExt:Identifier +### Season Identifier + +Identifier of the season. + +`iptc4xmpExt:Identifier` +* is optional +* type: `string` +* defined in this schema + +### iptc4xmpExt:Identifier Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## iptc4xmpExt:Name +### Season Name + +Name of the season. + +`iptc4xmpExt:Name` +* is optional +* type: `string` +* defined in this schema + +### iptc4xmpExt:Name Type + + +`string` + + + + + + +## iptc4xmpExt:Number +### Season Number + +Number of the season. + +`iptc4xmpExt:Number` +* is optional +* type: `number` +* defined in this schema + +### iptc4xmpExt:Number Type + + +`number` + + + + + diff --git a/docs/reference/datatypes/external/iptc/series.schema.json b/docs/reference/datatypes/external/iptc/series.schema.json new file mode 100644 index 000000000..acb18036f --- /dev/null +++ b/docs/reference/datatypes/external/iptc/series.schema.json @@ -0,0 +1,42 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "http://www.iptc.org/series", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Series", + "type": "object", + "description": "The series the show belongs to. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", + "definitions": { + "series": { + "properties": { + "iptc4xmpExt:Name": { + "title": "Series Name", + "type": "string", + "description": "Name of the series." + }, + "iptc4xmpExt:Identifier": { + "title": "Series Identifier", + "type": "string", + "format": "uri", + "description": "Identifier of the series." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/series" + } + ], + "meta:status": "stable", + "examples": [ + { + "iptc4xmpExt:Name": "nba_highlights", + "iptc4xmpExt:Identifier": "http://espn.com/series-identifiers/2613953" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/external/iptc/series.schema.md b/docs/reference/datatypes/external/iptc/series.schema.md new file mode 100644 index 000000000..f043f581d --- /dev/null +++ b/docs/reference/datatypes/external/iptc/series.schema.md @@ -0,0 +1,69 @@ + +# Series Schema + +``` +http://www.iptc.org/series +``` + +The series the show belongs to. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html) + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/external/iptc/series.schema.json](datatypes/external/iptc/series.schema.json) | + +## Series Example +```json +{ + "iptc4xmpExt:Name": "nba_highlights", + "iptc4xmpExt:Identifier": "http://espn.com/series-identifiers/2613953" +} +``` + +# Series Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [iptc4xmpExt:Identifier](#iptc4xmpextidentifier) | `string` | Optional | Series (this schema) | +| [iptc4xmpExt:Name](#iptc4xmpextname) | `string` | Optional | Series (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## iptc4xmpExt:Identifier +### Series Identifier + +Identifier of the series. + +`iptc4xmpExt:Identifier` +* is optional +* type: `string` +* defined in this schema + +### iptc4xmpExt:Identifier Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## iptc4xmpExt:Name +### Series Name + +Name of the series. + +`iptc4xmpExt:Name` +* is optional +* type: `string` +* defined in this schema + +### iptc4xmpExt:Name Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/external/repo/common.schema.json b/docs/reference/datatypes/external/repo/common.schema.json new file mode 100644 index 000000000..14ff39c8d --- /dev/null +++ b/docs/reference/datatypes/external/repo/common.schema.json @@ -0,0 +1,66 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "http://ns.adobe.com/adobecloud/core/1.0", + "type": "object", + "title": "Common Properties", + "description": "Common Properties for storage in Adobe Experience Platform.", + "definitions": { + "common-properties": { + "properties": { + "repo:name": { + "type": "string" + }, + "repo:path": { + "type": "string" + }, + "dc:format": { + "meta:usereditable": false, + "type": "string", + "title": "Format", + "pattern": "\\w+\\/[-.\\w]+(?:\\+[-.\\w]+)?", + "examples": [ + "application/vnd.adobe.photoshop" + ], + "description": "The physical or digital manifestation of the resource. Typically, Format should include the media-type of the resource. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource. Recommended best practice is to select a value from a controlled vocabulary (for example, the list of [Internet Media Types](http://www.iana.org/ assignments/media-types/) defining computer media formats)." + } + } + }, + "date-properties": { + "properties": { + "repo:createDate": { + "type": "string", + "format": "date-time", + "meta:immutable": true, + "meta:usereditable": false, + "examples": [ + "2004-10-23T12:00:00-06:00" + ], + "description": "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\"." + }, + "repo:modifyDate": { + "type": "string", + "format": "date-time", + "meta:usereditable": false, + "examples": [ + "2004-10-23T12:00:00-06:00" + ], + "description": "The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\"." + } + } + } + }, + "meta:status": "stable", + "examples": [ + { + "repo:name": "example.png", + "repo:path": "/examples/from/xdm/example.png", + "dc:format": "image/png" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/external/repo/common.schema.md b/docs/reference/datatypes/external/repo/common.schema.md new file mode 100644 index 000000000..019f358ef --- /dev/null +++ b/docs/reference/datatypes/external/repo/common.schema.md @@ -0,0 +1,150 @@ + +# Common Properties Schema + +``` +http://ns.adobe.com/adobecloud/core/1.0 +``` + +Common Properties for storage in Adobe Experience Platform. + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Cannot be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/external/repo/common.schema.json](datatypes/external/repo/common.schema.json) | + +## Common Properties Example +```json +{ + "repo:name": "example.png", + "repo:path": "/examples/from/xdm/example.png", + "dc:format": "image/png" +} +``` + +# Common Properties Definitions + +| Property | Type | Group | +|----------|------|-------| +| [dc:format](#dcformat) | `string` | `http://ns.adobe.com/adobecloud/core/1.0#/definitions/common-properties` | +| [repo:createDate](#repocreatedate) | `string` | `http://ns.adobe.com/adobecloud/core/1.0#/definitions/date-properties` | +| [repo:modifyDate](#repomodifydate) | `string` | `http://ns.adobe.com/adobecloud/core/1.0#/definitions/date-properties` | +| [repo:name](#reponame) | `string` | `http://ns.adobe.com/adobecloud/core/1.0#/definitions/common-properties` | +| [repo:path](#repopath) | `string` | `http://ns.adobe.com/adobecloud/core/1.0#/definitions/common-properties` | + +## dc:format +### Format + +The physical or digital manifestation of the resource. Typically, Format should include the media-type of the resource. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource. Recommended best practice is to select a value from a controlled vocabulary (for example, the list of [Internet Media Types](http://www.iana.org/ assignments/media-types/) defining computer media formats). + +`dc:format` +* is optional +* type: `string` +* defined in this schema + +### dc:format Type + + +`string` + + +All instances must conform to this regular expression +```regex +\w+\/[-.\w]+(?:\+[-.\w]+)? +``` + +* test example: [application/vnd.adobe.photoshop](https://regexr.com/?expression=%5Cw%2B%5C%2F%5B-.%5Cw%5D%2B(%3F%3A%5C%2B%5B-.%5Cw%5D%2B)%3F&text=application%2Fvnd.adobe.photoshop) + + + + +### dc:format Example + +```json +"application/vnd.adobe.photoshop" +``` + + +## repo:createDate + +The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:createDate` +* is optional +* type: `string` +* defined in this schema + +### repo:createDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:createDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## repo:modifyDate + +The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:modifyDate` +* is optional +* type: `string` +* defined in this schema + +### repo:modifyDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:modifyDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## repo:name + + +`repo:name` +* is optional +* type: `string` +* defined in this schema + +### repo:name Type + + +`string` + + + + + + +## repo:path + + +`repo:path` +* is optional +* type: `string` +* defined in this schema + +### repo:path Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/external/schema/geocircle.schema.json b/docs/reference/datatypes/external/schema/geocircle.schema.json new file mode 100644 index 000000000..e9a578251 --- /dev/null +++ b/docs/reference/datatypes/external/schema/geocircle.schema.json @@ -0,0 +1,59 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "http://schema.org/GeoCircle", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Geo Circle", + "type": "object", + "description": "A circular region of a particular radius centered on a GeoCoordinate. Based on [schema.org](http://schema.org/GeoCircle)", + "definitions": { + "geocircle": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "description": "The unique identifier of the circle." + }, + "schema:description": { + "title": "Description", + "type": "string", + "description": "A description of what the circle contains." + }, + "schema:coordinates": { + "title": "Coordinates", + "$ref": "http://schema.org/GeoCoordinates", + "description": "" + }, + "schema:radius": { + "title": "Radius", + "type": "number", + "description": "The length of the radius of the circle. This value conforms to the WGS84 datum and is measured in meters." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/geocircle" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/entities/geo/circleid123", + "schema:description": "New York Metro", + "schema:coordinates": { + "@id": "https://data.adobe.io/entities/geo/111", + "schema:description": "New York", + "schema:latitude": 37.3308953, + "schema:longitude": -121.8939894, + "schema:elevation": 31.0896 + }, + "schema:radius": 80000 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/external/schema/geocircle.schema.md b/docs/reference/datatypes/external/schema/geocircle.schema.md new file mode 100644 index 000000000..9f90c58cd --- /dev/null +++ b/docs/reference/datatypes/external/schema/geocircle.schema.md @@ -0,0 +1,120 @@ + +# Geo Circle Schema + +``` +http://schema.org/GeoCircle +``` + +A circular region of a particular radius centered on a GeoCoordinate. Based on [schema.org](http://schema.org/GeoCircle) + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/external/schema/geocircle.schema.json](datatypes/external/schema/geocircle.schema.json) | +## Schema Hierarchy + +* Geo Circle `http://schema.org/GeoCircle` + * [Geo Coordinates](geocoordinates.schema.md) `http://schema.org/GeoCoordinates` + + +## Geo Circle Example +```json +{ + "@id": "https://data.adobe.io/entities/geo/circleid123", + "schema:description": "New York Metro", + "schema:coordinates": { + "@id": "https://data.adobe.io/entities/geo/111", + "schema:description": "New York", + "schema:latitude": 37.3308953, + "schema:longitude": -121.8939894, + "schema:elevation": 31.0896 + }, + "schema:radius": 80000 +} +``` + +# Geo Circle Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Geo Circle (this schema) | +| [schema:coordinates](#schemacoordinates) | Geo Coordinates | Optional | Geo Circle (this schema) | +| [schema:description](#schemadescription) | `string` | Optional | Geo Circle (this schema) | +| [schema:radius](#schemaradius) | `number` | Optional | Geo Circle (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The unique identifier of the circle. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` + + + + + + +## schema:coordinates +### Coordinates + +`schema:coordinates` +* is optional +* type: Geo Coordinates +* defined in this schema + +### schema:coordinates Type + + +* [Geo Coordinates](geocoordinates.schema.md) – `http://schema.org/GeoCoordinates` + + + + + +## schema:description +### Description + +A description of what the circle contains. + +`schema:description` +* is optional +* type: `string` +* defined in this schema + +### schema:description Type + + +`string` + + + + + + +## schema:radius +### Radius + +The length of the radius of the circle. This value conforms to the WGS84 datum and is measured in meters. + +`schema:radius` +* is optional +* type: `number` +* defined in this schema + +### schema:radius Type + + +`number` + + + + + diff --git a/docs/reference/datatypes/external/schema/geocoordinates.schema.json b/docs/reference/datatypes/external/schema/geocoordinates.schema.json new file mode 100644 index 000000000..c2219a3f2 --- /dev/null +++ b/docs/reference/datatypes/external/schema/geocoordinates.schema.json @@ -0,0 +1,65 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "http://schema.org/GeoCoordinates", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Geo Coordinates", + "type": "object", + "meta:extensible": true, + "description": "The geographic coordinates of a place. Based on [schema.org](http://schema.org/GeoCoordinates).", + "definitions": { + "geocoordinates": { + "properties": { + "@id": { + "title": "Coordinates ID", + "type": "string", + "format": "uri-reference", + "description": "The unique identifier of the coordinates." + }, + "schema:description": { + "title": "Description", + "type": "string", + "description": "A description of what the coordinates identify." + }, + "schema:latitude": { + "title": "Latitude", + "type": "number", + "minimum": -90, + "maximum": 90, + "description": "The signed vertical coordinate of a geographic point." + }, + "schema:longitude": { + "title": "Longitude", + "type": "number", + "minimum": -180, + "maximum": 180, + "description": "The signed horizontal coordinate of a geographic point." + }, + "schema:elevation": { + "title": "Elevation", + "type": "number", + "description": "The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/geocoordinates" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/entities/geo/111", + "xdm:description": "New York", + "xdm:latitude": 37.3308953, + "xdm:longitude": -121.8939894, + "xdm:elevation": 31.0896 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/external/schema/geocoordinates.schema.md b/docs/reference/datatypes/external/schema/geocoordinates.schema.md new file mode 100644 index 000000000..10967c549 --- /dev/null +++ b/docs/reference/datatypes/external/schema/geocoordinates.schema.md @@ -0,0 +1,137 @@ + +# Geo Coordinates Schema + +``` +http://schema.org/GeoCoordinates +``` + +The geographic coordinates of a place. Based on [schema.org](http://schema.org/GeoCoordinates). + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/external/schema/geocoordinates.schema.json](datatypes/external/schema/geocoordinates.schema.json) | + +## Geo Coordinates Example +```json +{ + "@id": "https://data.adobe.io/entities/geo/111", + "xdm:description": "New York", + "xdm:latitude": 37.3308953, + "xdm:longitude": -121.8939894, + "xdm:elevation": 31.0896 +} +``` + +# Geo Coordinates Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Geo Coordinates (this schema) | +| [schema:description](#schemadescription) | `string` | Optional | Geo Coordinates (this schema) | +| [schema:elevation](#schemaelevation) | `number` | Optional | Geo Coordinates (this schema) | +| [schema:latitude](#schemalatitude) | `number` | Optional | Geo Coordinates (this schema) | +| [schema:longitude](#schemalongitude) | `number` | Optional | Geo Coordinates (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Coordinates ID + +The unique identifier of the coordinates. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:description +### Description + +A description of what the coordinates identify. + +`schema:description` +* is optional +* type: `string` +* defined in this schema + +### schema:description Type + + +`string` + + + + + + +## schema:elevation +### Elevation + +The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters. + +`schema:elevation` +* is optional +* type: `number` +* defined in this schema + +### schema:elevation Type + + +`number` + + + + + + +## schema:latitude +### Latitude + +The signed vertical coordinate of a geographic point. + +`schema:latitude` +* is optional +* type: `number` +* defined in this schema + +### schema:latitude Type + + +`number` +* minimum value: `-90` +* maximum value: `90` + + + + + +## schema:longitude +### Longitude + +The signed horizontal coordinate of a geographic point. + +`schema:longitude` +* is optional +* type: `number` +* defined in this schema + +### schema:longitude Type + + +`number` +* minimum value: `-180` +* maximum value: `180` + + + + diff --git a/docs/reference/datatypes/external/schema/geoshape.schema.json b/docs/reference/datatypes/external/schema/geoshape.schema.json new file mode 100644 index 000000000..3f4a2dfbd --- /dev/null +++ b/docs/reference/datatypes/external/schema/geoshape.schema.json @@ -0,0 +1,87 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "http://schema.org/GeoShape", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Geo Shape", + "type": "object", + "description": "The geographic shape of a place. Based on [schema.org](http://schema.org/GeoShape).", + "definitions": { + "geoshape": { + "properties": { + "@id": { + "title": "Shape ID", + "type": "string", + "description": "The unique identifier of the shape." + }, + "schema:description": { + "title": "Description", + "type": "string", + "description": "A description of what the shape is defining." + }, + "schema:polygon": { + "title": "Polygon", + "type": "array", + "items": { + "$ref": "http://schema.org/GeoCoordinates" + }, + "description": "A series of four or more coordinates where the first and final coordinates are identical. In schema.org, this is a plain text. In XDM, it is a structured array instead.", + "minItems": 4 + }, + "schema:circle": { + "title": "Circle", + "$ref": "http://schema.org/GeoCircle", + "description": "A circular region with a specific radius centered on a geographic coordinate." + }, + "schema:box": { + "title": "Box", + "type": "array", + "items": { + "$ref": "http://schema.org/GeoCoordinates" + }, + "description": "The area enclosed by the rectangle formed by two coordinates. The first coordinate is the lower corner and the second coordinate is the upper corner of a rectangle.", + "minItems": 2, + "maxItems": 2 + }, + "schema:elevation": { + "title": "Elevation", + "type": "number", + "description": "The specific or minimum elevation of the shape. This value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters. In combination with `ceiling`, this property can be used to express a three-dimensional bounding box for a location." + }, + "xdm:ceiling": { + "title": "Ceiling", + "type": "number", + "description": "The maximum elevation of the shape. Only valid when used in combination with `elevation`. This value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters. This value is not part of the schema.org spec. In combination with `elevation`, this property can be used to express a three-dimensional bounding box for a location." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/geoshape" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/entities/geo/shapeid123", + "schema:description": "GeoCircle of New York Metro", + "schema:circle": { + "@id": "https://data.adobe.io/entities/geo/circleid123", + "schema:description": "New York Metro", + "schema:coordinates": { + "@id": "https://data.adobe.io/entities/geo/111", + "schema:description": "New York", + "schema:latitude": 37.3308953, + "schema:longitude": -121.8939894, + "schema:elevation": 31.0896 + }, + "schema:radius": 80000 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/external/schema/geoshape.schema.md b/docs/reference/datatypes/external/schema/geoshape.schema.md new file mode 100644 index 000000000..3d6122ba7 --- /dev/null +++ b/docs/reference/datatypes/external/schema/geoshape.schema.md @@ -0,0 +1,201 @@ + +# Geo Shape Schema + +``` +http://schema.org/GeoShape +``` + +The geographic shape of a place. Based on [schema.org](http://schema.org/GeoShape). + +| [Abstract](../../../../abstract.md) | [Extensible](../../../../extensions.md) | [Status](../../../../status.md) | [Identifiable](../../../../id.md) | [Custom Properties](../../../../extensions.md) | [Additional Properties](../../../../extensions.md) | Defined In | +|-------------------------------------|-----------------------------------------|---------------------------------|-----------------------------------|------------------------------------------------|----------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/external/schema/geoshape.schema.json](datatypes/external/schema/geoshape.schema.json) | +## Schema Hierarchy + +* Geo Shape `http://schema.org/GeoShape` + * [Geo Circle](geocircle.schema.md) `http://schema.org/GeoCircle` + + +## Geo Shape Example +```json +{ + "@id": "https://data.adobe.io/entities/geo/shapeid123", + "schema:description": "GeoCircle of New York Metro", + "schema:circle": { + "@id": "https://data.adobe.io/entities/geo/circleid123", + "schema:description": "New York Metro", + "schema:coordinates": { + "@id": "https://data.adobe.io/entities/geo/111", + "schema:description": "New York", + "schema:latitude": 37.3308953, + "schema:longitude": -121.8939894, + "schema:elevation": 31.0896 + }, + "schema:radius": 80000 + } +} +``` + +# Geo Shape Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Geo Shape (this schema) | +| [schema:box](#schemabox) | Geo Coordinates | Optional | Geo Shape (this schema) | +| [schema:circle](#schemacircle) | Geo Circle | Optional | Geo Shape (this schema) | +| [schema:description](#schemadescription) | `string` | Optional | Geo Shape (this schema) | +| [schema:elevation](#schemaelevation) | `number` | Optional | Geo Shape (this schema) | +| [schema:polygon](#schemapolygon) | Geo Coordinates | Optional | Geo Shape (this schema) | +| [xdm:ceiling](#xdmceiling) | `number` | Optional | Geo Shape (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Shape ID + +The unique identifier of the shape. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` + + + + + + +## schema:box +### Box + +The area enclosed by the rectangle formed by two coordinates. The first coordinate is the lower corner and the second coordinate is the upper corner of a rectangle. + +`schema:box` +* is optional +* type: Geo Coordinates +* between `2` and `2` items in the array +* defined in this schema + +### schema:box Type + + +Array type: Geo Coordinates + +All items must be of the type: +* [Geo Coordinates](geocoordinates.schema.md) – `http://schema.org/GeoCoordinates` + + + + + + + + +## schema:circle +### Circle + +A circular region with a specific radius centered on a geographic coordinate. + +`schema:circle` +* is optional +* type: Geo Circle +* defined in this schema + +### schema:circle Type + + +* [Geo Circle](geocircle.schema.md) – `http://schema.org/GeoCircle` + + + + + +## schema:description +### Description + +A description of what the shape is defining. + +`schema:description` +* is optional +* type: `string` +* defined in this schema + +### schema:description Type + + +`string` + + + + + + +## schema:elevation +### Elevation + +The specific or minimum elevation of the shape. This value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters. In combination with `ceiling`, this property can be used to express a three-dimensional bounding box for a location. + +`schema:elevation` +* is optional +* type: `number` +* defined in this schema + +### schema:elevation Type + + +`number` + + + + + + +## schema:polygon +### Polygon + +A series of four or more coordinates where the first and final coordinates are identical. In schema.org, this is a plain text. In XDM, it is a structured array instead. + +`schema:polygon` +* is optional +* type: Geo Coordinates +* at least `4` items in the array +* defined in this schema + +### schema:polygon Type + + +Array type: Geo Coordinates + +All items must be of the type: +* [Geo Coordinates](geocoordinates.schema.md) – `http://schema.org/GeoCoordinates` + + + + + + + + +## xdm:ceiling +### Ceiling + +The maximum elevation of the shape. Only valid when used in combination with `elevation`. This value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters. This value is not part of the schema.org spec. In combination with `elevation`, this property can be used to express a three-dimensional bounding box for a location. + +`xdm:ceiling` +* is optional +* type: `number` +* defined in this schema + +### xdm:ceiling Type + + +`number` + + + + + diff --git a/docs/reference/datatypes/geo-interaction-details.schema.json b/docs/reference/datatypes/geo-interaction-details.schema.json new file mode 100644 index 000000000..cb4b6a8c7 --- /dev/null +++ b/docs/reference/datatypes/geo-interaction-details.schema.json @@ -0,0 +1,50 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/geo-interaction-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Geo interaction details", + "type": "object", + "meta:extensible": true, + "description": "The geo details relating to the current state of inclusion in a geo defined area.", + "definitions": { + "geo-interaction-detail": { + "properties": { + "xdm:distanceToCenter": { + "title": "Distance to center", + "type": "number", + "description": "Distance to center of geo in, case of a geo circle, measured in meters." + }, + "xdm:deviceGeoAccuracy": { + "title": "Geo device accuracy", + "type": "number", + "description": "The accuracy of the geo measuring device or mechanism, measured in meters." + }, + "xdm:geoShape": { + "title": "Geo shape", + "$ref": "http://schema.org/GeoShape", + "description": "Geo shape of the geo being interacted with." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/geo-interaction-detail" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:distanceToCenter": 100, + "xdm:accuracy": 30 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/geo-interaction-details.schema.md b/docs/reference/datatypes/geo-interaction-details.schema.md new file mode 100644 index 000000000..2caae6866 --- /dev/null +++ b/docs/reference/datatypes/geo-interaction-details.schema.md @@ -0,0 +1,94 @@ + +# Geo interaction details Schema + +``` +https://ns.adobe.com/xdm/context/geo-interaction-details +``` + +The geo details relating to the current state of inclusion in a geo defined area. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/geo-interaction-details.schema.json](datatypes/geo-interaction-details.schema.json) | +## Schema Hierarchy + +* Geo interaction details `https://ns.adobe.com/xdm/context/geo-interaction-details` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Geo Shape](external/schema/geoshape.schema.md) `http://schema.org/GeoShape` + + +## Geo interaction details Example +```json +{ + "xdm:distanceToCenter": 100, + "xdm:accuracy": 30 +} +``` + +# Geo interaction details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:deviceGeoAccuracy](#xdmdevicegeoaccuracy) | `number` | Optional | Geo interaction details (this schema) | +| [xdm:distanceToCenter](#xdmdistancetocenter) | `number` | Optional | Geo interaction details (this schema) | +| [xdm:geoShape](#xdmgeoshape) | Geo Shape | Optional | Geo interaction details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:deviceGeoAccuracy +### Geo device accuracy + +The accuracy of the geo measuring device or mechanism, measured in meters. + +`xdm:deviceGeoAccuracy` +* is optional +* type: `number` +* defined in this schema + +### xdm:deviceGeoAccuracy Type + + +`number` + + + + + + +## xdm:distanceToCenter +### Distance to center + +Distance to center of geo in, case of a geo circle, measured in meters. + +`xdm:distanceToCenter` +* is optional +* type: `number` +* defined in this schema + +### xdm:distanceToCenter Type + + +`number` + + + + + + +## xdm:geoShape +### Geo shape + +Geo shape of the geo being interacted with. + +`xdm:geoShape` +* is optional +* type: Geo Shape +* defined in this schema + +### xdm:geoShape Type + + +* [Geo Shape](external/schema/geoshape.schema.md) – `http://schema.org/GeoShape` + + + + diff --git a/docs/reference/datatypes/geo.schema.json b/docs/reference/datatypes/geo.schema.json new file mode 100644 index 000000000..6e097cfb2 --- /dev/null +++ b/docs/reference/datatypes/geo.schema.json @@ -0,0 +1,87 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/geo", + "$schema": "http://json-schema.org/draft-06/schema#", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "http://schema.org/GeoCoordinates" + ], + "title": "Geo", + "description": "The geographic related data where an event was observed.", + "definitions": { + "geo": { + "properties": { + "xdm:countryCode": { + "title": "Country code", + "type": "string", + "pattern": "^[A-Z]{2}$", + "description": "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country." + }, + "xdm:stateProvince": { + "title": "State or province", + "type": "string", + "description": "The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.", + "examples": [ + "US-CA", + "DE-BB", + "JP-13" + ], + "pattern": "([A-Z]{2}-[A-Z0-9]{1,3}|)" + }, + "xdm:city": { + "title": "City", + "type": "string", + "description": "The name of the city." + }, + "xdm:postalCode": { + "title": "Postal code", + "type": "string", + "description": "The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code." + }, + "xdm:dmaID": { + "title": "Designated market area", + "type": "integer", + "description": "The Nielsen media research designated market area." + }, + "xdm:msaID": { + "title": "Metropolitan statistical area", + "type": "integer", + "description": "The metropolitan statistical area in the United States where the observation occurred." + } + } + } + }, + "allOf": [ + { + "$ref": "http://schema.org/GeoCoordinates" + }, + { + "$ref": "#/definitions/geo" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/entities/geo/potsdam", + "xdm:countryCode": "DE", + "xdm:stateProvince": "DE-BB", + "xdm:city": "Potsdam", + "xdm:postalCode": "14482" + }, + { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/geo.schema.md b/docs/reference/datatypes/geo.schema.md new file mode 100644 index 000000000..61238c29e --- /dev/null +++ b/docs/reference/datatypes/geo.schema.md @@ -0,0 +1,313 @@ + +# Geo Schema + +``` +https://ns.adobe.com/xdm/common/geo +``` + +The geographic related data where an event was observed. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/geo.schema.json](datatypes/geo.schema.json) | +## Schema Hierarchy + +* Geo `https://ns.adobe.com/xdm/common/geo` + * [Geo Coordinates](external/schema/geocoordinates.schema.md) `http://schema.org/GeoCoordinates` + + +## Geo Examples + +```json +{ + "@id": "https://data.adobe.io/entities/geo/potsdam", + "xdm:countryCode": "DE", + "xdm:stateProvince": "DE-BB", + "xdm:city": "Potsdam", + "xdm:postalCode": "14482" +} +``` + +```json +{ + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 +} +``` + + +# Geo Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Geo Coordinates](external/schema/geocoordinates.schema.md#id) | +| [schema:description](#schemadescription) | `string` | Optional | [Geo Coordinates](external/schema/geocoordinates.schema.md#schemadescription) | +| [schema:elevation](#schemaelevation) | `number` | Optional | [Geo Coordinates](external/schema/geocoordinates.schema.md#schemaelevation) | +| [schema:latitude](#schemalatitude) | `number` | Optional | [Geo Coordinates](external/schema/geocoordinates.schema.md#schemalatitude) | +| [schema:longitude](#schemalongitude) | `number` | Optional | [Geo Coordinates](external/schema/geocoordinates.schema.md#schemalongitude) | +| [xdm:city](#xdmcity) | `string` | Optional | Geo (this schema) | +| [xdm:countryCode](#xdmcountrycode) | `string` | Optional | Geo (this schema) | +| [xdm:dmaID](#xdmdmaid) | `integer` | Optional | Geo (this schema) | +| [xdm:msaID](#xdmmsaid) | `integer` | Optional | Geo (this schema) | +| [xdm:postalCode](#xdmpostalcode) | `string` | Optional | Geo (this schema) | +| [xdm:stateProvince](#xdmstateprovince) | `string` | Optional | Geo (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Coordinates ID + +The unique identifier of the coordinates. + +`@id` +* is optional +* type: `string` +* defined in [Geo Coordinates](external/schema/geocoordinates.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:description +### Description + +A description of what the coordinates identify. + +`schema:description` +* is optional +* type: `string` +* defined in [Geo Coordinates](external/schema/geocoordinates.schema.md#schemadescription) + +### schema:description Type + + +`string` + + + + + + +## schema:elevation +### Elevation + +The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters. + +`schema:elevation` +* is optional +* type: `number` +* defined in [Geo Coordinates](external/schema/geocoordinates.schema.md#schemaelevation) + +### schema:elevation Type + + +`number` + + + + + + +## schema:latitude +### Latitude + +The signed vertical coordinate of a geographic point. + +`schema:latitude` +* is optional +* type: `number` +* defined in [Geo Coordinates](external/schema/geocoordinates.schema.md#schemalatitude) + +### schema:latitude Type + + +`number` +* minimum value: `-90` +* maximum value: `90` + + + + + +## schema:longitude +### Longitude + +The signed horizontal coordinate of a geographic point. + +`schema:longitude` +* is optional +* type: `number` +* defined in [Geo Coordinates](external/schema/geocoordinates.schema.md#schemalongitude) + +### schema:longitude Type + + +`number` +* minimum value: `-180` +* maximum value: `180` + + + + + +## xdm:city +### City + +The name of the city. + +`xdm:city` +* is optional +* type: `string` +* defined in this schema + +### xdm:city Type + + +`string` + + + + + + +## xdm:countryCode +### Country code + +The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country. + +`xdm:countryCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:countryCode Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E%5BA-Z%5D%7B2%7D%24)): +```regex +^[A-Z]{2}$ +``` + + + + + + +## xdm:dmaID +### Designated market area + +The Nielsen media research designated market area. + +`xdm:dmaID` +* is optional +* type: `integer` +* defined in this schema + +### xdm:dmaID Type + + +`integer` + + + + + + +## xdm:msaID +### Metropolitan statistical area + +The metropolitan statistical area in the United States where the observation occurred. + +`xdm:msaID` +* is optional +* type: `integer` +* defined in this schema + +### xdm:msaID Type + + +`integer` + + + + + + +## xdm:postalCode +### Postal code + +The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code. + +`xdm:postalCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:postalCode Type + + +`string` + + + + + + +## xdm:stateProvince +### State or province + +The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard. + +`xdm:stateProvince` +* is optional +* type: `string` +* defined in this schema + +### xdm:stateProvince Type + + +`string` + + +All instances must conform to this regular expression +```regex +([A-Z]{2}-[A-Z0-9]{1,3}|) +``` + +* test example: [US-CA](https://regexr.com/?expression=(%5BA-Z%5D%7B2%7D-%5BA-Z0-9%5D%7B1%2C3%7D%7C)&text=US-CA) +* test example: [DE-BB](https://regexr.com/?expression=(%5BA-Z%5D%7B2%7D-%5BA-Z0-9%5D%7B1%2C3%7D%7C)&text=DE-BB) +* test example: [JP-13](https://regexr.com/?expression=(%5BA-Z%5D%7B2%7D-%5BA-Z0-9%5D%7B1%2C3%7D%7C)&text=JP-13) + + + + +### xdm:stateProvince Examples + +```json +"US-CA" +``` + +```json +"DE-BB" +``` + +```json +"JP-13" +``` + + diff --git a/docs/reference/datatypes/geounit.schema.json b/docs/reference/datatypes/geounit.schema.json new file mode 100644 index 000000000..5d117dbf5 --- /dev/null +++ b/docs/reference/datatypes/geounit.schema.json @@ -0,0 +1,46 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/geounit", + "$schema": "http://json-schema.org/draft-06/schema#", + "type": "object", + "meta:extensible": true, + "title": "Geographical unit", + "description": "The geographical unit of a parent geographical unit.", + "definitions": { + "geounit": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "The ID associated with this geographical unit." + }, + "xdm:label": { + "title": "Label of the geographical unit.", + "type": "string", + "description": "The user-friendly name for the geographical unit." + } + }, + "required": [ + "@id" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/geounit" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/geo-san-jose", + "xdm:label": "San Jose" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/geounit.schema.md b/docs/reference/datatypes/geounit.schema.md new file mode 100644 index 000000000..f84942236 --- /dev/null +++ b/docs/reference/datatypes/geounit.schema.md @@ -0,0 +1,69 @@ + +# Geographical unit Schema + +``` +https://ns.adobe.com/xdm/common/geounit +``` + +The geographical unit of a parent geographical unit. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/geounit.schema.json](datatypes/geounit.schema.json) | + +## Geographical unit Example +```json +{ + "@id": "https://data.adobe.io/geo-san-jose", + "xdm:label": "San Jose" +} +``` + +# Geographical unit Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Geographical unit (this schema) | +| [xdm:label](#xdmlabel) | `string` | Optional | Geographical unit (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The ID associated with this geographical unit. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:label +### Label of the geographical unit. + +The user-friendly name for the geographical unit. + +`xdm:label` +* is optional +* type: `string` +* defined in this schema + +### xdm:label Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/identity-provider.schema.json b/docs/reference/datatypes/identity-provider.schema.json new file mode 100644 index 000000000..406642e76 --- /dev/null +++ b/docs/reference/datatypes/identity-provider.schema.json @@ -0,0 +1,39 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/common/identity-provider", + "title": "Identity Provider", + "meta:extensible": true, + "description": "An identity provider (abbreviated IdP) is a system entity that creates, maintains, and manages identity information for principals while providing authentication services to relying party applications within a federation or distributed network. An identity provider offers subject authentication as a service.", + "definitions": { + "name": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "description": "A unique (uniqueness is defined on the same lines as defined [here](https://tools.ietf.org/html/rfc8141#section-5)) and persistent identifier for the identity provider. Ideally, this identifier should be a [URI](https://tools.ietf.org/html/rfc3986)." + } + } + } + }, + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/name" + } + ], + "required": [ + "@id" + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://ims-na1.adobelogin.com/" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/identity-provider.schema.md b/docs/reference/datatypes/identity-provider.schema.md new file mode 100644 index 000000000..20d7dc163 --- /dev/null +++ b/docs/reference/datatypes/identity-provider.schema.md @@ -0,0 +1,46 @@ + +# Identity Provider Schema + +``` +https://ns.adobe.com/xdm/common/identity-provider +``` + +An identity provider (abbreviated IdP) is a system entity that creates, maintains, and manages identity information for principals while providing authentication services to relying party applications within a federation or distributed network. An identity provider offers subject authentication as a service. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/identity-provider.schema.json](datatypes/identity-provider.schema.json) | + +## Identity Provider Example +```json +{ + "@id": "https://ims-na1.adobelogin.com/" +} +``` + +# Identity Provider Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | Identity Provider (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +A unique (uniqueness is defined on the same lines as defined [here](https://tools.ietf.org/html/rfc8141#section-5)) and persistent identifier for the identity provider. Ideally, this identifier should be a [URI](https://tools.ietf.org/html/rfc3986). + +`@id` +* is **required** +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + diff --git a/docs/reference/datatypes/identity.schema.json b/docs/reference/datatypes/identity.schema.json new file mode 100644 index 000000000..d3d871050 --- /dev/null +++ b/docs/reference/datatypes/identity.schema.json @@ -0,0 +1,60 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/identity", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Identity", + "type": "object", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/context/identityitem" + ], + "description": "Identity is used to clearly distinguish people that are interacting with digital experiences. Identity is established by an identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the identity is unique.", + "definitions": { + "identity": { + "properties": { + "xdm:namespace": { + "title": "Namespace", + "$ref": "https://ns.adobe.com/xdm/context/namespace", + "description": "The namespace associated with the `xid` attribute and matched up with the AAM data source integration code." + }, + "xdm:xid": { + "title": "Experience identifier", + "type": "string", + "description": "When present, experience identifier value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identityitem#/definitions/identityitem" + }, + { + "$ref": "#/definitions/identity" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:id": "id123", + "xdm:namespace": { + "xdm:code": "AA12345" + }, + "xdm:authenticatedState": "ambiguous" + }, + { + "xdm:id": "someone@example.com", + "xdm:namespace": { + "xdm:code": "Email" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/identity.schema.md b/docs/reference/datatypes/identity.schema.md new file mode 100644 index 000000000..53e10c9f6 --- /dev/null +++ b/docs/reference/datatypes/identity.schema.md @@ -0,0 +1,153 @@ + +# Identity Schema + +``` +https://ns.adobe.com/xdm/context/identity +``` + +Identity is used to clearly distinguish people that are interacting with digital experiences. Identity is established by an identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the identity is unique. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/identity.schema.json](datatypes/identity.schema.json) | +## Schema Hierarchy + +* Identity `https://ns.adobe.com/xdm/context/identity` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Identity item](identityitem.schema.md) `https://ns.adobe.com/xdm/context/identityitem` + * [Namespace](namespace.schema.md) `https://ns.adobe.com/xdm/context/namespace` + + +## Identity Examples + +```json +{ + "xdm:id": "id123", + "xdm:namespace": { + "xdm:code": "AA12345" + }, + "xdm:authenticatedState": "ambiguous" +} +``` + +```json +{ + "xdm:id": "someone@example.com", + "xdm:namespace": { + "xdm:code": "Email" + } +} +``` + + +# Identity Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:authenticatedState](#xdmauthenticatedstate) | `enum` | Optional | `"ambiguous"` | [Identity item](identityitem.schema.md#xdmauthenticatedstate) | +| [xdm:id](#xdmid) | `string` | Optional | | [Identity item](identityitem.schema.md#xdmid) | +| [xdm:namespace](#xdmnamespace) | Namespace | Optional | | Identity (this schema) | +| [xdm:primary](#xdmprimary) | `boolean` | Optional | `false` | [Identity item](identityitem.schema.md#xdmprimary) | +| [xdm:xid](#xdmxid) | `string` | Optional | | Identity (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:authenticatedState + +The state this identity is authenticated as for this observed ExperienceEvent. + +`xdm:authenticatedState` +* is optional +* type: `enum` +* default: `"ambiguous"` +* defined in [Identity item](identityitem.schema.md#xdmauthenticatedstate) + +The value of this property **must** be equal to one of the [known values below](#xdmauthenticatedstate-known-values). + +### xdm:authenticatedState Known Values +| Value | Description | +|-------|-------------| +| `ambiguous` | Ambiguous | +| `authenticated` | User identified by a login or similar action that was valid at the time of the event observation. | +| `loggedOut` | User was identified by a login action at some point of time previously, but is not currently logged in. | + + + + +## xdm:id +### Identifier + +Identity of the consumer in the related namespace. + +`xdm:id` +* is optional +* type: `string` +* defined in [Identity item](identityitem.schema.md#xdmid) + +### xdm:id Type + + +`string` + + + + + + +## xdm:namespace +### Namespace + +The namespace associated with the `xid` attribute and matched up with the AAM data source integration code. + +`xdm:namespace` +* is optional +* type: Namespace +* defined in this schema + +### xdm:namespace Type + + +* [Namespace](namespace.schema.md) – `https://ns.adobe.com/xdm/context/namespace` + + + + + +## xdm:primary +### Primary + +Indicates this identity is the preferred identity. Is used as a hint to help systems better organize how identities are queried. + +`xdm:primary` +* is optional +* type: `boolean` +* default: `false` +* defined in [Identity item](identityitem.schema.md#xdmprimary) + +### xdm:primary Type + + +`boolean` + + + + + +## xdm:xid +### Experience identifier + +When present, experience identifier value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces. + +`xdm:xid` +* is optional +* type: `string` +* defined in this schema + +### xdm:xid Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/identityitem.schema.json b/docs/reference/datatypes/identityitem.schema.json new file mode 100644 index 000000000..a73d7cfa6 --- /dev/null +++ b/docs/reference/datatypes/identityitem.schema.json @@ -0,0 +1,61 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/identityitem", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Identity item", + "type": "object", + "meta:extensible": true, + "description": "An end user identity item, to be included in an instance of `context/identitymap`.", + "definitions": { + "identityitem": { + "properties": { + "xdm:id": { + "title": "Identifier", + "type": "string", + "description": "Identity of the consumer in the related namespace." + }, + "xdm:authenticatedState": { + "description": "The state this identity is authenticated as for this observed ExperienceEvent.", + "type": "string", + "default": "ambiguous", + "enum": [ + "ambiguous", + "authenticated", + "loggedOut" + ], + "meta:enum": { + "ambiguous": "Ambiguous", + "authenticated": "User identified by a login or similar action that was valid at the time of the event observation.", + "loggedOut": "User was identified by a login action at some point of time previously, but is not currently logged in." + } + }, + "xdm:primary": { + "title": "Primary", + "type": "boolean", + "default": false, + "description": "Indicates this identity is the preferred identity. Is used as a hint to help systems better organize how identities are queried." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/identityitem" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:id": "id123", + "xdm:authenticatedState": "ambiguous" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/identityitem.schema.md b/docs/reference/datatypes/identityitem.schema.md new file mode 100644 index 000000000..3d0ef09e5 --- /dev/null +++ b/docs/reference/datatypes/identityitem.schema.md @@ -0,0 +1,96 @@ + +# Identity item Schema + +``` +https://ns.adobe.com/xdm/context/identityitem +``` + +An end user identity item, to be included in an instance of `context/identitymap`. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/identityitem.schema.json](datatypes/identityitem.schema.json) | +## Schema Hierarchy + +* Identity item `https://ns.adobe.com/xdm/context/identityitem` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Identity item Example +```json +{ + "xdm:id": "id123", + "xdm:authenticatedState": "ambiguous" +} +``` + +# Identity item Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:authenticatedState](#xdmauthenticatedstate) | `enum` | Optional | `"ambiguous"` | Identity item (this schema) | +| [xdm:id](#xdmid) | `string` | Optional | | Identity item (this schema) | +| [xdm:primary](#xdmprimary) | `boolean` | Optional | `false` | Identity item (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:authenticatedState + +The state this identity is authenticated as for this observed ExperienceEvent. + +`xdm:authenticatedState` +* is optional +* type: `enum` +* default: `"ambiguous"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmauthenticatedstate-known-values). + +### xdm:authenticatedState Known Values +| Value | Description | +|-------|-------------| +| `ambiguous` | Ambiguous | +| `authenticated` | User identified by a login or similar action that was valid at the time of the event observation. | +| `loggedOut` | User was identified by a login action at some point of time previously, but is not currently logged in. | + + + + +## xdm:id +### Identifier + +Identity of the consumer in the related namespace. + +`xdm:id` +* is optional +* type: `string` +* defined in this schema + +### xdm:id Type + + +`string` + + + + + + +## xdm:primary +### Primary + +Indicates this identity is the preferred identity. Is used as a hint to help systems better organize how identities are queried. + +`xdm:primary` +* is optional +* type: `boolean` +* default: `false` +* defined in this schema + +### xdm:primary Type + + +`boolean` + + + + diff --git a/docs/reference/datatypes/implementationdetails.schema.json b/docs/reference/datatypes/implementationdetails.schema.json new file mode 100644 index 000000000..00ae803f7 --- /dev/null +++ b/docs/reference/datatypes/implementationdetails.schema.json @@ -0,0 +1,72 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/implementationdetails", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Implementation details", + "type": "object", + "meta:extensible": true, + "meta:status": "stable", + "description": "Details about the SDK, library, or service used in an application or web page implementation of a service.", + "definitions": { + "implementationdetails": { + "properties": { + "xdm:name": { + "title": "Name", + "type": "string", + "format": "uri", + "description": "SDK or endpoint identifier. All SDKs or endpoints are identified through a URI, including extensions.", + "meta:enum": { + "https://ns.adobe.com/experience/analytics/scode": "Adobe Analytics sCode", + "https://ns.adobe.com/experience/analytics/appmeasurement": "Adobe app measurement", + "https://ns.adobe.com/experience/analytics/mbox": "Adobe Target mBox", + "https://ns.adobe.com/experience/visitorapi": "Adobe Visitor service", + "https://ns.adobe.com/experience/adcloud/viewability": "Adobe Advertising Cloud viewability", + "https://ns.adobe.com/experience/alloy": "Adobe Experience Cloud web SDK (Alloy)" + } + }, + "xdm:version": { + "title": "Version", + "type": "string", + "description": "The version identifier of the API, e.g h.18." + }, + "xdm:environment": { + "title": "Environment", + "type": "string", + "description": "The environment of the implementation", + "enum": [ + "browser", + "app", + "server", + "iot" + ], + "meta:enum": { + "browser": "Web Browser", + "app": "Application", + "server": "Server", + "iot": "Internet of Things Device" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/implementationdetails" + } + ], + "examples": [ + { + "xdm:name": "https://ns.adobe.com/experience/analytics/appmeasurement", + "xdm:version": "2.7.0", + "xdm:environment": "browser" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/implementationdetails.schema.md b/docs/reference/datatypes/implementationdetails.schema.md new file mode 100644 index 000000000..bf0b8e9c5 --- /dev/null +++ b/docs/reference/datatypes/implementationdetails.schema.md @@ -0,0 +1,109 @@ + +# Implementation details Schema + +``` +https://ns.adobe.com/xdm/context/implementationdetails +``` + +Details about the SDK, library, or service used in an application or web page implementation of a service. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/implementationdetails.schema.json](datatypes/implementationdetails.schema.json) | +## Schema Hierarchy + +* Implementation details `https://ns.adobe.com/xdm/context/implementationdetails` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Implementation details Example +```json +{ + "xdm:name": "https://ns.adobe.com/experience/analytics/appmeasurement", + "xdm:version": "2.7.0", + "xdm:environment": "browser" +} +``` + +# Implementation details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:environment](#xdmenvironment) | `enum` | Optional | Implementation details (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | Implementation details (this schema) | +| [xdm:version](#xdmversion) | `string` | Optional | Implementation details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:environment +### Environment + +The environment of the implementation + +`xdm:environment` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmenvironment-known-values). + +### xdm:environment Known Values +| Value | Description | +|-------|-------------| +| `browser` | Web Browser | +| `app` | Application | +| `server` | Server | +| `iot` | Internet of Things Device | + + + + +## xdm:name +### Name + +SDK or endpoint identifier. All SDKs or endpoints are identified through a URI, including extensions. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + +### xdm:name Known Values +| Value | Description | +|-------|-------------| +| `https://ns.adobe.com/experience/analytics/scode` | Adobe Analytics sCode | +| `https://ns.adobe.com/experience/analytics/appmeasurement` | Adobe app measurement | +| `https://ns.adobe.com/experience/analytics/mbox` | Adobe Target mBox | +| `https://ns.adobe.com/experience/visitorapi` | Adobe Visitor service | +| `https://ns.adobe.com/experience/adcloud/viewability` | Adobe Advertising Cloud viewability | +| `https://ns.adobe.com/experience/alloy` | Adobe Experience Cloud web SDK (Alloy) | + + + + +## xdm:version +### Version + +The version identifier of the API, e.g h.18. + +`xdm:version` +* is optional +* type: `string` +* defined in this schema + +### xdm:version Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/marketing.schema.json b/docs/reference/datatypes/marketing.schema.json new file mode 100644 index 000000000..7d5290374 --- /dev/null +++ b/docs/reference/datatypes/marketing.schema.json @@ -0,0 +1,49 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/marketing", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Marketing", + "type": "object", + "meta:extensible": true, + "description": "The information related to marketing activities that are active with the touchpoint.", + "definitions": { + "marketing": { + "properties": { + "xdm:trackingCode": { + "title": "Tracking code", + "type": "string", + "description": "Tracking code that can be used to identify the marketing campaign the event is associated with." + }, + "xdm:campaignName": { + "title": "Campaign name", + "type": "string", + "description": "Name of the campaign used to identify marketing campaign like '50%_DISCOUNT_USA' or '50%_DISCOUNT_ASIA'." + }, + "xdm:campaignGroup": { + "title": "Campaign group", + "type": "string", + "description": "Name of the campaign group where multiple campaigns are grouped together like '50%_DISCOUNT'." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/marketing" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:trackingCode": "marketingcampaign111" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/marketing.schema.md b/docs/reference/datatypes/marketing.schema.md new file mode 100644 index 000000000..5e755d2d4 --- /dev/null +++ b/docs/reference/datatypes/marketing.schema.md @@ -0,0 +1,93 @@ + +# Marketing Schema + +``` +https://ns.adobe.com/xdm/context/marketing +``` + +The information related to marketing activities that are active with the touchpoint. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/marketing.schema.json](datatypes/marketing.schema.json) | +## Schema Hierarchy + +* Marketing `https://ns.adobe.com/xdm/context/marketing` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Marketing Example +```json +{ + "xdm:trackingCode": "marketingcampaign111" +} +``` + +# Marketing Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:campaignGroup](#xdmcampaigngroup) | `string` | Optional | Marketing (this schema) | +| [xdm:campaignName](#xdmcampaignname) | `string` | Optional | Marketing (this schema) | +| [xdm:trackingCode](#xdmtrackingcode) | `string` | Optional | Marketing (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:campaignGroup +### Campaign group + +Name of the campaign group where multiple campaigns are grouped together like '50%_DISCOUNT'. + +`xdm:campaignGroup` +* is optional +* type: `string` +* defined in this schema + +### xdm:campaignGroup Type + + +`string` + + + + + + +## xdm:campaignName +### Campaign name + +Name of the campaign used to identify marketing campaign like '50%_DISCOUNT_USA' or '50%_DISCOUNT_ASIA'. + +`xdm:campaignName` +* is optional +* type: `string` +* defined in this schema + +### xdm:campaignName Type + + +`string` + + + + + + +## xdm:trackingCode +### Tracking code + +Tracking code that can be used to identify the marketing campaign the event is associated with. + +`xdm:trackingCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:trackingCode Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/media-timed-asset-reference.schema.json b/docs/reference/datatypes/media-timed-asset-reference.schema.json new file mode 100644 index 000000000..198b5adac --- /dev/null +++ b/docs/reference/datatypes/media-timed-asset-reference.schema.json @@ -0,0 +1,200 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-asset-reference", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Timed media primary asset reference", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Asset information about the main content that was played, but present on all ads and chapters that occur during the content playback.", + "definitions": { + "media-asset-reference": { + "properties": { + "@id": { + "title": "Asset ID", + "type": "string", + "format": "uri-reference", + "description": "Identifier of the content, which can be used to tie back to other industry or CMS IDs." + }, + "dc:title": { + "title": "Content name", + "type": "string", + "description": "The friendly, human-readable name of the timed media asset." + }, + "dc:creator": { + "title": "Originator", + "type": "string", + "description": "Creator of the content." + }, + "id3:Audio": { + "title": "Audio", + "description": "Metadata specific to audio content (record label, radio station, etc.).", + "$ref": "https://id3.org/id3v2.4/audio", + "meta:status": "deprecated" + }, + "xmpDM:artist": { + "title": "Artist", + "type": "string", + "description": "The name of the album artist or group performing the music recording or video.", + "meta:status": "deprecated" + }, + "xmpDM:album": { + "title": "Album", + "type": "string", + "description": "The name of the album that the music recording or video belongs to.", + "meta:status": "deprecated" + }, + "xdm:Audio": { + "title": "Audio", + "description": "Metadata specific to audio content (record label, radio station, etc.).", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-audio" + }, + "xmpDM:duration": { + "title": "Media content length", + "type": "integer", + "description": "Length of primary media asset in seconds." + }, + "xdm:showType": { + "title": "Show type", + "type": "string", + "description": "The type of content for example, trailer or full episode." + }, + "iptc4xmpExt:Series": { + "title": "Series", + "description": "The series the show belongs to.", + "$ref": "http://www.iptc.org/series" + }, + "xdm:streamFormat": { + "title": "Stream format", + "type": "string", + "description": "Free-form format of the stream for example, short or long." + }, + "xdm:streamType": { + "title": "Stream type", + "description": "The type of the media stream", + "type": "string", + "default": "video", + "enum": [ + "audio", + "video", + "gaming" + ], + "meta:enum": { + "audio": "An audio stream (e.g. podcast, audiobook, radio stream).", + "video": "A video stream (e.g. Video-On-Demand, live event stream, downloaded movie).", + "gaming": "A gaming stream (e.g. Twitch, Hitbox)." + } + }, + "iptc4xmpExt:Season": { + "title": "Season", + "description": "The season the show belongs to.", + "$ref": "http://www.iptc.org/season" + }, + "iptc4xmpExt:Episode": { + "title": "Episode", + "description": "The episode the show belongs to.", + "$ref": "http://www.iptc.org/episode" + }, + "iptc4xmpExt:Genre": { + "title": "Genre", + "description": "Type or grouping of content as defined by content producer.", + "type": "array", + "items": { + "type": "string" + } + }, + "iptc4xmpExt:Rating": { + "title": "Content rating", + "description": "The rating as defined by Parental Guidelines.", + "type": "array", + "items": { + "$ref": "http://www.iptc.org/rating" + } + }, + "iptc4xmpExt:Creator": { + "title": "Creator", + "description": "Party or parties including person or organization which created the video, refinement by the role attribute.", + "type": "array", + "items": { + "$ref": "http://www.iptc.org/creator" + } + }, + "xdm:firstAirDate": { + "title": "First air date", + "type": "string", + "description": "The date when the content first aired on television." + }, + "xmpDM:releaseDate": { + "title": "First digital date", + "type": "string", + "description": "The date when the content first aired on any digital channel or platform." + } + }, + "required": [ + "@id" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-asset-reference" + } + ], + "examples": [ + { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "show_highlights", + "iptc4xmpExt:Identifier": "http://mychanneltv.com/series-identifiers/2613953" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "OTV", + "iptc4xmpExt:RatingSourceLink": "http://www.tvmedia.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "MyChannelTV" + } + ], + "xdm:firstAirDate": "2016-01-05", + "xmpDM:releaseDate": "2016-01-25" + }, + { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234431", + "dc:title": "Stairway to Heaven", + "xdm:audio": { + "dc:creator": "Jimmy Page", + "xdm:artist": "Led Zeppelin", + "xdm:album": "Led Zeppelin IV" + }, + "xmpDM:duration": 482, + "xdm:streamType": "audio" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/media-timed-asset-reference.schema.md b/docs/reference/datatypes/media-timed-asset-reference.schema.md new file mode 100644 index 000000000..5c6ac1be8 --- /dev/null +++ b/docs/reference/datatypes/media-timed-asset-reference.schema.md @@ -0,0 +1,501 @@ + +# Timed media primary asset reference Schema + +``` +https://ns.adobe.com/xdm/context/media-timed-asset-reference +``` + +Asset information about the main content that was played, but present on all ads and chapters that occur during the content playback. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/media-timed-asset-reference.schema.json](datatypes/media-timed-asset-reference.schema.json) | +## Schema Hierarchy + +* Timed media primary asset reference `https://ns.adobe.com/xdm/context/media-timed-asset-reference` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Audio](external/id3/audio.schema.md) `https://id3.org/id3v2.4/audio` + * [Media audio](media-timed-audio.schema.md) `https://ns.adobe.com/xdm/context/media-timed-audio` + * [Series](external/iptc/series.schema.md) `http://www.iptc.org/series` + * [Season](external/iptc/season.schema.md) `http://www.iptc.org/season` + * [Episode](external/iptc/episode.schema.md) `http://www.iptc.org/episode` + + +## Timed media primary asset reference Examples + +```json +{ + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "show_highlights", + "iptc4xmpExt:Identifier": "http://mychanneltv.com/series-identifiers/2613953" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "OTV", + "iptc4xmpExt:RatingSourceLink": "http://www.tvmedia.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "MyChannelTV" + } + ], + "xdm:firstAirDate": "2016-01-05", + "xmpDM:releaseDate": "2016-01-25" +} +``` + +```json +{ + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234431", + "dc:title": "Stairway to Heaven", + "xdm:audio": { + "dc:creator": "Jimmy Page", + "xdm:artist": "Led Zeppelin", + "xdm:album": "Led Zeppelin IV" + }, + "xmpDM:duration": 482, + "xdm:streamType": "audio" +} +``` + + +# Timed media primary asset reference Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [@id](#id) | `string` | Optional | | Timed media primary asset reference (this schema) | +| [dc:creator](#dccreator) | `string` | Optional | | Timed media primary asset reference (this schema) | +| [dc:title](#dctitle) | `string` | Optional | | Timed media primary asset reference (this schema) | +| [id3:Audio](#id3audio) | Audio | Optional | | Timed media primary asset reference (this schema) | +| [iptc4xmpExt:Creator](#iptc4xmpextcreator) | Creator | Optional | | Timed media primary asset reference (this schema) | +| [iptc4xmpExt:Episode](#iptc4xmpextepisode) | Episode | Optional | | Timed media primary asset reference (this schema) | +| [iptc4xmpExt:Genre](#iptc4xmpextgenre) | `string[]` | Optional | | Timed media primary asset reference (this schema) | +| [iptc4xmpExt:Rating](#iptc4xmpextrating) | Rating | Optional | | Timed media primary asset reference (this schema) | +| [iptc4xmpExt:Season](#iptc4xmpextseason) | Season | Optional | | Timed media primary asset reference (this schema) | +| [iptc4xmpExt:Series](#iptc4xmpextseries) | Series | Optional | | Timed media primary asset reference (this schema) | +| [xdm:Audio](#xdmaudio) | Media audio | Optional | | Timed media primary asset reference (this schema) | +| [xdm:firstAirDate](#xdmfirstairdate) | `string` | Optional | | Timed media primary asset reference (this schema) | +| [xdm:showType](#xdmshowtype) | `string` | Optional | | Timed media primary asset reference (this schema) | +| [xdm:streamFormat](#xdmstreamformat) | `string` | Optional | | Timed media primary asset reference (this schema) | +| [xdm:streamType](#xdmstreamtype) | `enum` | Optional | `"video"` | Timed media primary asset reference (this schema) | +| [xmpDM:album](#xmpdmalbum) | `string` | Optional | | Timed media primary asset reference (this schema) | +| [xmpDM:artist](#xmpdmartist) | `string` | Optional | | Timed media primary asset reference (this schema) | +| [xmpDM:duration](#xmpdmduration) | `integer` | Optional | | Timed media primary asset reference (this schema) | +| [xmpDM:releaseDate](#xmpdmreleasedate) | `string` | Optional | | Timed media primary asset reference (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Asset ID + +Identifier of the content, which can be used to tie back to other industry or CMS IDs. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## dc:creator +### Originator + +Creator of the content. + +`dc:creator` +* is optional +* type: `string` +* defined in this schema + +### dc:creator Type + + +`string` + + + + + + +## dc:title +### Content name + +The friendly, human-readable name of the timed media asset. + +`dc:title` +* is optional +* type: `string` +* defined in this schema + +### dc:title Type + + +`string` + + + + + + +## id3:Audio +### Audio + +Metadata specific to audio content (record label, radio station, etc.). + +`id3:Audio` +* is optional +* type: Audio +* defined in this schema + +### id3:Audio Type + + +* [Audio](external/id3/audio.schema.md) – `https://id3.org/id3v2.4/audio` + + + + + +## iptc4xmpExt:Creator +### Creator + +Party or parties including person or organization which created the video, refinement by the role attribute. + +`iptc4xmpExt:Creator` +* is optional +* type: Creator + +* defined in this schema + +### iptc4xmpExt:Creator Type + + +Array type: Creator + +All items must be of the type: +* [Creator](external/iptc/creator.schema.md) – `http://www.iptc.org/creator` + + + + + + + + +## iptc4xmpExt:Episode +### Episode + +The episode the show belongs to. + +`iptc4xmpExt:Episode` +* is optional +* type: Episode +* defined in this schema + +### iptc4xmpExt:Episode Type + + +* [Episode](external/iptc/episode.schema.md) – `http://www.iptc.org/episode` + + + + + +## iptc4xmpExt:Genre +### Genre + +Type or grouping of content as defined by content producer. + +`iptc4xmpExt:Genre` +* is optional +* type: `string[]` + +* defined in this schema + +### iptc4xmpExt:Genre Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + + + + +## iptc4xmpExt:Rating +### Content rating + +The rating as defined by Parental Guidelines. + +`iptc4xmpExt:Rating` +* is optional +* type: Rating + +* defined in this schema + +### iptc4xmpExt:Rating Type + + +Array type: Rating + +All items must be of the type: +* [Rating](external/iptc/rating.schema.md) – `http://www.iptc.org/rating` + + + + + + + + +## iptc4xmpExt:Season +### Season + +The season the show belongs to. + +`iptc4xmpExt:Season` +* is optional +* type: Season +* defined in this schema + +### iptc4xmpExt:Season Type + + +* [Season](external/iptc/season.schema.md) – `http://www.iptc.org/season` + + + + + +## iptc4xmpExt:Series +### Series + +The series the show belongs to. + +`iptc4xmpExt:Series` +* is optional +* type: Series +* defined in this schema + +### iptc4xmpExt:Series Type + + +* [Series](external/iptc/series.schema.md) – `http://www.iptc.org/series` + + + + + +## xdm:Audio +### Audio + +Metadata specific to audio content (record label, radio station, etc.). + +`xdm:Audio` +* is optional +* type: Media audio +* defined in this schema + +### xdm:Audio Type + + +* [Media audio](media-timed-audio.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-audio` + + + + + +## xdm:firstAirDate +### First air date + +The date when the content first aired on television. + +`xdm:firstAirDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:firstAirDate Type + + +`string` + + + + + + +## xdm:showType +### Show type + +The type of content for example, trailer or full episode. + +`xdm:showType` +* is optional +* type: `string` +* defined in this schema + +### xdm:showType Type + + +`string` + + + + + + +## xdm:streamFormat +### Stream format + +Free-form format of the stream for example, short or long. + +`xdm:streamFormat` +* is optional +* type: `string` +* defined in this schema + +### xdm:streamFormat Type + + +`string` + + + + + + +## xdm:streamType +### Stream type + +The type of the media stream + +`xdm:streamType` +* is optional +* type: `enum` +* default: `"video"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmstreamtype-known-values). + +### xdm:streamType Known Values +| Value | Description | +|-------|-------------| +| `audio` | An audio stream (e.g. podcast, audiobook, radio stream). | +| `video` | A video stream (e.g. Video-On-Demand, live event stream, downloaded movie). | +| `gaming` | A gaming stream (e.g. Twitch, Hitbox). | + + + + +## xmpDM:album +### Album + +The name of the album that the music recording or video belongs to. + +`xmpDM:album` +* is optional +* type: `string` +* defined in this schema + +### xmpDM:album Type + + +`string` + + + + + + +## xmpDM:artist +### Artist + +The name of the album artist or group performing the music recording or video. + +`xmpDM:artist` +* is optional +* type: `string` +* defined in this schema + +### xmpDM:artist Type + + +`string` + + + + + + +## xmpDM:duration +### Media content length + +Length of primary media asset in seconds. + +`xmpDM:duration` +* is optional +* type: `integer` +* defined in this schema + +### xmpDM:duration Type + + +`integer` + + + + + + +## xmpDM:releaseDate +### First digital date + +The date when the content first aired on any digital channel or platform. + +`xmpDM:releaseDate` +* is optional +* type: `string` +* defined in this schema + +### xmpDM:releaseDate Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/media-timed-asset-view-details.schema.json b/docs/reference/datatypes/media-timed-asset-view-details.schema.json new file mode 100644 index 000000000..a49b2c0dd --- /dev/null +++ b/docs/reference/datatypes/media-timed-asset-view-details.schema.json @@ -0,0 +1,187 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-asset-view-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Primary asset view details", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "View details for the main content playback, present on all ads and chapters that occur during the content's playback.", + "definitions": { + "media-asset-view-details": { + "properties": { + "@id": { + "title": "Media session ID", + "type": "string", + "format": "uri-reference", + "description": "Identifies an instance of a content stream unique to an individual playback." + }, + "xdm:playerName": { + "title": "Content player name", + "type": "string", + "description": "Name of the content player." + }, + "xdm:videoSegment": { + "title": "Video segment", + "type": "string", + "pattern": "^[0-9]+-[0-9]+$", + "description": "The interval that describes the part of the content that has been viewed in minutes." + }, + "xdm:path": { + "title": "Video path", + "type": "string", + "description": "The path to the video in the app or site." + }, + "xdm:broadcastChannel": { + "title": "Content channel", + "type": "string", + "description": "Distribution channel from where the content was played." + }, + "xdm:broadcastContentType": { + "title": "Broadcast content type", + "type": "string", + "description": "The type of the stream delivery.", + "meta:enum": { + "VOD": "Video-on-demand", + "Live": "Live streaming", + "Linear": "Linear playback of the media asset", + "UGC": "User-generated content", + "Radio": "Radio show", + "Podcast": "Audio podcast", + "Audiobook": "Audiobook" + } + }, + "xdm:playerSDKVersion": { + "title": "Player SDK version", + "$ref": "https://ns.adobe.com/xdm/context/implementationdetails", + "description": "The SDK version used by the player." + }, + "xdm:vhlVersion": { + "title": "VHL version", + "type": "string", + "description": "The Media SDK version used for the tracking session." + }, + "xdm:broadcastNetwork": { + "title": "Broadcast network", + "type": "string", + "description": "The programmer network name." + }, + "xdm:adLoadType": { + "title": "Ad load type", + "type": "string", + "description": "The type of ad loaded as defined by each customer's internal representation." + }, + "xdm:sourceFeed": { + "title": "Feed type", + "type": "string", + "description": "The type of feed, which can either represent actual feed-related data such as EAST HD or SD, or the source of the feed like a URL." + }, + "xdm:sessionTimeout": { + "title": "Media session server timeout", + "type": "integer", + "description": "Indicates the amount of time, in seconds, that passed between the user's last known interaction and the moment the session was closed." + }, + "xdm:qoe": { + "title": "Quality of experience", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-qoe", + "description": "Timed media properties related to the content playback's quality of experience (QoE)." + }, + "xdm:downloadedPlayback": { + "title": "Media downloaded flag", + "type": "boolean", + "description": "The stream was played locally on the device after being downloaded." + }, + "xdm:fullScreen": { + "title": "Full screen", + "$ref": "https://ns.adobe.com/xdm/context/player-state", + "description": "Timed media properties related to full screen player state." + }, + "xdm:mute": { + "title": "Mute", + "$ref": "https://ns.adobe.com/xdm/context/player-state", + "description": "Timed media properties related to mute player state." + }, + "xdm:closeCaption": { + "title": "Close caption", + "$ref": "https://ns.adobe.com/xdm/context/player-state", + "description": "Timed media properties related to close caption player state." + }, + "xdm:pictureInPicture": { + "title": "Picture in picture", + "$ref": "https://ns.adobe.com/xdm/context/player-state", + "description": "Timed media properties related to picture in picture player state." + }, + "xdm:inFocus": { + "title": "In focus", + "$ref": "https://ns.adobe.com/xdm/context/player-state", + "description": "Timed media properties related to in focus player state." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-asset-view-details" + } + ], + "examples": [ + { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchtv", + "xdm:videoSegment": "3-10", + "xdm:path": "mid:cartoon:episode:kidschannel.com:dfb59263-4ce7", + "xdm:broadcastChannel": "WatchTV", + "xdm:broadcastContentType": "VOD", + "xdm:streamFormat": "short", + "xdm:vhlVersion": "js-2.0.1.88-c8c0b1", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "nbpu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.pure.centurylink.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:downloadedPlayback": false, + "xdm:fullScreen": { + "xdm:playerStateSet": true, + "xdm:playerStateCount": 3, + "xdm:playerStateTime": 2520 + }, + "xdm:mute": { + "xdm:playerStateSet": false, + "xdm:playerStateCount": 5, + "xdm:playerStateTime": 80 + }, + "xdm:closeCaption": { + "xdm:playerStateSet": true, + "xdm:playerStateCount": 1, + "xdm:playerStateTime": 3 + }, + "xdm:pictureInPicture": { + "xdm:playerStateSet": true, + "xdm:playerStateCount": 1, + "xdm:playerStateTime": 2700 + }, + "xdm:inFocus": { + "xdm:playerStateSet": false, + "xdm:playerStateCount": 2, + "xdm:playerStateTime": 10 + } + }, + { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114231", + "xdm:playerName": "watchtv", + "xdm:adLoadType": "1", + "xdm:sessionTimeout": 1800, + "xdm:downloadedPlayback": false + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/media-timed-asset-view-details.schema.md b/docs/reference/datatypes/media-timed-asset-view-details.schema.md new file mode 100644 index 000000000..e5345daef --- /dev/null +++ b/docs/reference/datatypes/media-timed-asset-view-details.schema.md @@ -0,0 +1,495 @@ + +# Primary asset view details Schema + +``` +https://ns.adobe.com/xdm/context/media-timed-asset-view-details +``` + +View details for the main content playback, present on all ads and chapters that occur during the content's playback. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/media-timed-asset-view-details.schema.json](datatypes/media-timed-asset-view-details.schema.json) | +## Schema Hierarchy + +* Primary asset view details `https://ns.adobe.com/xdm/context/media-timed-asset-view-details` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Implementation details](implementationdetails.schema.md) `https://ns.adobe.com/xdm/context/implementationdetails` + * [Timed media quality of experience](media-timed-qoe.schema.md) `https://ns.adobe.com/xdm/context/media-timed-qoe` + * [Player state information](player-state.schema.md) `https://ns.adobe.com/xdm/context/player-state` + + +## Primary asset view details Examples + +```json +{ + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchtv", + "xdm:videoSegment": "3-10", + "xdm:path": "mid:cartoon:episode:kidschannel.com:dfb59263-4ce7", + "xdm:broadcastChannel": "WatchTV", + "xdm:broadcastContentType": "VOD", + "xdm:streamFormat": "short", + "xdm:vhlVersion": "js-2.0.1.88-c8c0b1", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "nbpu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.pure.centurylink.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:downloadedPlayback": false, + "xdm:fullScreen": { + "xdm:playerStateSet": true, + "xdm:playerStateCount": 3, + "xdm:playerStateTime": 2520 + }, + "xdm:mute": { + "xdm:playerStateSet": false, + "xdm:playerStateCount": 5, + "xdm:playerStateTime": 80 + }, + "xdm:closeCaption": { + "xdm:playerStateSet": true, + "xdm:playerStateCount": 1, + "xdm:playerStateTime": 3 + }, + "xdm:pictureInPicture": { + "xdm:playerStateSet": true, + "xdm:playerStateCount": 1, + "xdm:playerStateTime": 2700 + }, + "xdm:inFocus": { + "xdm:playerStateSet": false, + "xdm:playerStateCount": 2, + "xdm:playerStateTime": 10 + } +} +``` + +```json +{ + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114231", + "xdm:playerName": "watchtv", + "xdm:adLoadType": "1", + "xdm:sessionTimeout": 1800, + "xdm:downloadedPlayback": false +} +``` + + +# Primary asset view details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Primary asset view details (this schema) | +| [xdm:adLoadType](#xdmadloadtype) | `string` | Optional | Primary asset view details (this schema) | +| [xdm:broadcastChannel](#xdmbroadcastchannel) | `string` | Optional | Primary asset view details (this schema) | +| [xdm:broadcastContentType](#xdmbroadcastcontenttype) | `string` | Optional | Primary asset view details (this schema) | +| [xdm:broadcastNetwork](#xdmbroadcastnetwork) | `string` | Optional | Primary asset view details (this schema) | +| [xdm:closeCaption](#xdmclosecaption) | Player state information | Optional | Primary asset view details (this schema) | +| [xdm:downloadedPlayback](#xdmdownloadedplayback) | `boolean` | Optional | Primary asset view details (this schema) | +| [xdm:fullScreen](#xdmfullscreen) | Player state information | Optional | Primary asset view details (this schema) | +| [xdm:inFocus](#xdminfocus) | Player state information | Optional | Primary asset view details (this schema) | +| [xdm:mute](#xdmmute) | Player state information | Optional | Primary asset view details (this schema) | +| [xdm:path](#xdmpath) | `string` | Optional | Primary asset view details (this schema) | +| [xdm:pictureInPicture](#xdmpictureinpicture) | Player state information | Optional | Primary asset view details (this schema) | +| [xdm:playerName](#xdmplayername) | `string` | Optional | Primary asset view details (this schema) | +| [xdm:playerSDKVersion](#xdmplayersdkversion) | Implementation details | Optional | Primary asset view details (this schema) | +| [xdm:qoe](#xdmqoe) | Timed media quality of experience | Optional | Primary asset view details (this schema) | +| [xdm:sessionTimeout](#xdmsessiontimeout) | `integer` | Optional | Primary asset view details (this schema) | +| [xdm:sourceFeed](#xdmsourcefeed) | `string` | Optional | Primary asset view details (this schema) | +| [xdm:vhlVersion](#xdmvhlversion) | `string` | Optional | Primary asset view details (this schema) | +| [xdm:videoSegment](#xdmvideosegment) | `string` | Optional | Primary asset view details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Media session ID + +Identifies an instance of a content stream unique to an individual playback. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:adLoadType +### Ad load type + +The type of ad loaded as defined by each customer's internal representation. + +`xdm:adLoadType` +* is optional +* type: `string` +* defined in this schema + +### xdm:adLoadType Type + + +`string` + + + + + + +## xdm:broadcastChannel +### Content channel + +Distribution channel from where the content was played. + +`xdm:broadcastChannel` +* is optional +* type: `string` +* defined in this schema + +### xdm:broadcastChannel Type + + +`string` + + + + + + +## xdm:broadcastContentType +### Broadcast content type + +The type of the stream delivery. + +`xdm:broadcastContentType` +* is optional +* type: `string` +* defined in this schema + +### xdm:broadcastContentType Type + + +`string` + + + +### xdm:broadcastContentType Known Values +| Value | Description | +|-------|-------------| +| `VOD` | Video-on-demand | +| `Live` | Live streaming | +| `Linear` | Linear playback of the media asset | +| `UGC` | User-generated content | +| `Radio` | Radio show | +| `Podcast` | Audio podcast | +| `Audiobook` | Audiobook | + + + + +## xdm:broadcastNetwork +### Broadcast network + +The programmer network name. + +`xdm:broadcastNetwork` +* is optional +* type: `string` +* defined in this schema + +### xdm:broadcastNetwork Type + + +`string` + + + + + + +## xdm:closeCaption +### Close caption + +Timed media properties related to close caption player state. + +`xdm:closeCaption` +* is optional +* type: Player state information +* defined in this schema + +### xdm:closeCaption Type + + +* [Player state information](player-state.schema.md) – `https://ns.adobe.com/xdm/context/player-state` + + + + + +## xdm:downloadedPlayback +### Media downloaded flag + +The stream was played locally on the device after being downloaded. + +`xdm:downloadedPlayback` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:downloadedPlayback Type + + +`boolean` + + + + + +## xdm:fullScreen +### Full screen + +Timed media properties related to full screen player state. + +`xdm:fullScreen` +* is optional +* type: Player state information +* defined in this schema + +### xdm:fullScreen Type + + +* [Player state information](player-state.schema.md) – `https://ns.adobe.com/xdm/context/player-state` + + + + + +## xdm:inFocus +### In focus + +Timed media properties related to in focus player state. + +`xdm:inFocus` +* is optional +* type: Player state information +* defined in this schema + +### xdm:inFocus Type + + +* [Player state information](player-state.schema.md) – `https://ns.adobe.com/xdm/context/player-state` + + + + + +## xdm:mute +### Mute + +Timed media properties related to mute player state. + +`xdm:mute` +* is optional +* type: Player state information +* defined in this schema + +### xdm:mute Type + + +* [Player state information](player-state.schema.md) – `https://ns.adobe.com/xdm/context/player-state` + + + + + +## xdm:path +### Video path + +The path to the video in the app or site. + +`xdm:path` +* is optional +* type: `string` +* defined in this schema + +### xdm:path Type + + +`string` + + + + + + +## xdm:pictureInPicture +### Picture in picture + +Timed media properties related to picture in picture player state. + +`xdm:pictureInPicture` +* is optional +* type: Player state information +* defined in this schema + +### xdm:pictureInPicture Type + + +* [Player state information](player-state.schema.md) – `https://ns.adobe.com/xdm/context/player-state` + + + + + +## xdm:playerName +### Content player name + +Name of the content player. + +`xdm:playerName` +* is optional +* type: `string` +* defined in this schema + +### xdm:playerName Type + + +`string` + + + + + + +## xdm:playerSDKVersion +### Player SDK version + +The SDK version used by the player. + +`xdm:playerSDKVersion` +* is optional +* type: Implementation details +* defined in this schema + +### xdm:playerSDKVersion Type + + +* [Implementation details](implementationdetails.schema.md) – `https://ns.adobe.com/xdm/context/implementationdetails` + + + + + +## xdm:qoe +### Quality of experience + +Timed media properties related to the content playback's quality of experience (QoE). + +`xdm:qoe` +* is optional +* type: Timed media quality of experience +* defined in this schema + +### xdm:qoe Type + + +* [Timed media quality of experience](media-timed-qoe.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-qoe` + + + + + +## xdm:sessionTimeout +### Media session server timeout + +Indicates the amount of time, in seconds, that passed between the user's last known interaction and the moment the session was closed. + +`xdm:sessionTimeout` +* is optional +* type: `integer` +* defined in this schema + +### xdm:sessionTimeout Type + + +`integer` + + + + + + +## xdm:sourceFeed +### Feed type + +The type of feed, which can either represent actual feed-related data such as EAST HD or SD, or the source of the feed like a URL. + +`xdm:sourceFeed` +* is optional +* type: `string` +* defined in this schema + +### xdm:sourceFeed Type + + +`string` + + + + + + +## xdm:vhlVersion +### VHL version + +The Media SDK version used for the tracking session. + +`xdm:vhlVersion` +* is optional +* type: `string` +* defined in this schema + +### xdm:vhlVersion Type + + +`string` + + + + + + +## xdm:videoSegment +### Video segment + +The interval that describes the part of the content that has been viewed in minutes. + +`xdm:videoSegment` +* is optional +* type: `string` +* defined in this schema + +### xdm:videoSegment Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E%5B0-9%5D%2B-%5B0-9%5D%2B%24)): +```regex +^[0-9]+-[0-9]+$ +``` + + + + + diff --git a/docs/reference/datatypes/media-timed-audio.schema.json b/docs/reference/datatypes/media-timed-audio.schema.json new file mode 100644 index 000000000..e6ccd3deb --- /dev/null +++ b/docs/reference/datatypes/media-timed-audio.schema.json @@ -0,0 +1,56 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-audio", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Media audio", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Asset information about the audio content.", + "definitions": { + "media-asset-reference": { + "properties": { + "dc:creator": { + "title": "Author", + "type": "string", + "description": "Name of the media author." + }, + "xmpDM:artist": { + "title": "Artist", + "type": "string", + "description": "The name of the album artist or group performing the music recording or video." + }, + "xmpDM:album": { + "title": "Album", + "type": "string", + "description": "The name of the album that the music recording or video belongs to." + }, + "id3:Audio": { + "title": "Audio", + "description": "Metadata specific to audio content (record label, radio station, etc.).", + "$ref": "https://id3.org/id3v2.4/audio" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-asset-reference" + } + ], + "examples": [ + { + "dc:creator": "Jimmy Page", + "xdm:artist": "Led Zeppelin", + "xdm:album": "Led Zeppelin IV" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/media-timed-audio.schema.md b/docs/reference/datatypes/media-timed-audio.schema.md new file mode 100644 index 000000000..58381add6 --- /dev/null +++ b/docs/reference/datatypes/media-timed-audio.schema.md @@ -0,0 +1,116 @@ + +# Media audio Schema + +``` +https://ns.adobe.com/xdm/context/media-timed-audio +``` + +Asset information about the audio content. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/media-timed-audio.schema.json](datatypes/media-timed-audio.schema.json) | +## Schema Hierarchy + +* Media audio `https://ns.adobe.com/xdm/context/media-timed-audio` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Audio](external/id3/audio.schema.md) `https://id3.org/id3v2.4/audio` + + +## Media audio Example +```json +{ + "dc:creator": "Jimmy Page", + "xdm:artist": "Led Zeppelin", + "xdm:album": "Led Zeppelin IV" +} +``` + +# Media audio Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [dc:creator](#dccreator) | `string` | Optional | Media audio (this schema) | +| [id3:Audio](#id3audio) | Audio | Optional | Media audio (this schema) | +| [xmpDM:album](#xmpdmalbum) | `string` | Optional | Media audio (this schema) | +| [xmpDM:artist](#xmpdmartist) | `string` | Optional | Media audio (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## dc:creator +### Author + +Name of the media author. + +`dc:creator` +* is optional +* type: `string` +* defined in this schema + +### dc:creator Type + + +`string` + + + + + + +## id3:Audio +### Audio + +Metadata specific to audio content (record label, radio station, etc.). + +`id3:Audio` +* is optional +* type: Audio +* defined in this schema + +### id3:Audio Type + + +* [Audio](external/id3/audio.schema.md) – `https://id3.org/id3v2.4/audio` + + + + + +## xmpDM:album +### Album + +The name of the album that the music recording or video belongs to. + +`xmpDM:album` +* is optional +* type: `string` +* defined in this schema + +### xmpDM:album Type + + +`string` + + + + + + +## xmpDM:artist +### Artist + +The name of the album artist or group performing the music recording or video. + +`xmpDM:artist` +* is optional +* type: `string` +* defined in this schema + +### xmpDM:artist Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/media-timed-chapter-asset-reference.schema.json b/docs/reference/datatypes/media-timed-chapter-asset-reference.schema.json new file mode 100644 index 000000000..54a64bdbe --- /dev/null +++ b/docs/reference/datatypes/media-timed-chapter-asset-reference.schema.json @@ -0,0 +1,55 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Timed media chapter asset reference", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Asset information about the chapter captured by the experience event.", + "definitions": { + "media-chapter-asset-reference": { + "properties": { + "@id": { + "title": "Chapter identity", + "format": "uri-reference", + "type": "string", + "description": "The identity of the chapter." + }, + "dc:title": { + "title": "Chapter name", + "type": "string", + "description": "The friendly name of the chapter and or segment." + }, + "xmpDM:duration": { + "title": "Chapter length or duration", + "type": "integer", + "description": "The length of the chapter, in seconds." + } + }, + "required": [ + "@id" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-chapter-asset-reference" + } + ], + "examples": [ + { + "@id": "https://data.adobe.io/entities/media-chapter-asset-reference/2144511", + "dc:title": "Chapter1", + "xmpDM:duration": 44 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/media-timed-chapter-asset-reference.schema.md b/docs/reference/datatypes/media-timed-chapter-asset-reference.schema.md new file mode 100644 index 000000000..52fb9eca6 --- /dev/null +++ b/docs/reference/datatypes/media-timed-chapter-asset-reference.schema.md @@ -0,0 +1,96 @@ + +# Timed media chapter asset reference Schema + +``` +https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference +``` + +Asset information about the chapter captured by the experience event. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/media-timed-chapter-asset-reference.schema.json](datatypes/media-timed-chapter-asset-reference.schema.json) | +## Schema Hierarchy + +* Timed media chapter asset reference `https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Timed media chapter asset reference Example +```json +{ + "@id": "https://data.adobe.io/entities/media-chapter-asset-reference/2144511", + "dc:title": "Chapter1", + "xmpDM:duration": 44 +} +``` + +# Timed media chapter asset reference Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Timed media chapter asset reference (this schema) | +| [dc:title](#dctitle) | `string` | Optional | Timed media chapter asset reference (this schema) | +| [xmpDM:duration](#xmpdmduration) | `integer` | Optional | Timed media chapter asset reference (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Chapter identity + +The identity of the chapter. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## dc:title +### Chapter name + +The friendly name of the chapter and or segment. + +`dc:title` +* is optional +* type: `string` +* defined in this schema + +### dc:title Type + + +`string` + + + + + + +## xmpDM:duration +### Chapter length or duration + +The length of the chapter, in seconds. + +`xmpDM:duration` +* is optional +* type: `integer` +* defined in this schema + +### xmpDM:duration Type + + +`integer` + + + + + diff --git a/docs/reference/datatypes/media-timed-chapter-view-details.schema.json b/docs/reference/datatypes/media-timed-chapter-view-details.schema.json new file mode 100644 index 000000000..f88425997 --- /dev/null +++ b/docs/reference/datatypes/media-timed-chapter-view-details.schema.json @@ -0,0 +1,49 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-chapter-view-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Timed media chapter view details", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "View details for the chapter playback captured by the experience event.", + "definitions": { + "media-chapter-view-details": { + "properties": { + "xdm:index": { + "title": "Chapter position", + "type": "integer", + "description": "The index of the chapter inside the content." + }, + "xdm:offset": { + "title": "Chapter offset", + "type": "integer", + "description": "The offset of the chapter, in seconds, inside the content from the start." + } + }, + "required": [ + "xdm:index", + "xdm:offset" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-chapter-view-details" + } + ], + "examples": [ + { + "xdm:index": 0, + "xdm:offset": 0 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/media-timed-chapter-view-details.schema.md b/docs/reference/datatypes/media-timed-chapter-view-details.schema.md new file mode 100644 index 000000000..0c17ca00c --- /dev/null +++ b/docs/reference/datatypes/media-timed-chapter-view-details.schema.md @@ -0,0 +1,73 @@ + +# Timed media chapter view details Schema + +``` +https://ns.adobe.com/xdm/context/media-timed-chapter-view-details +``` + +View details for the chapter playback captured by the experience event. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/media-timed-chapter-view-details.schema.json](datatypes/media-timed-chapter-view-details.schema.json) | +## Schema Hierarchy + +* Timed media chapter view details `https://ns.adobe.com/xdm/context/media-timed-chapter-view-details` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Timed media chapter view details Example +```json +{ + "xdm:index": 0, + "xdm:offset": 0 +} +``` + +# Timed media chapter view details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:index](#xdmindex) | `integer` | Optional | Timed media chapter view details (this schema) | +| [xdm:offset](#xdmoffset) | `integer` | Optional | Timed media chapter view details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:index +### Chapter position + +The index of the chapter inside the content. + +`xdm:index` +* is optional +* type: `integer` +* defined in this schema + +### xdm:index Type + + +`integer` + + + + + + +## xdm:offset +### Chapter offset + +The offset of the chapter, in seconds, inside the content from the start. + +`xdm:offset` +* is optional +* type: `integer` +* defined in this schema + +### xdm:offset Type + + +`integer` + + + + + diff --git a/docs/reference/datatypes/media-timed-chapter.schema.json b/docs/reference/datatypes/media-timed-chapter.schema.json new file mode 100644 index 000000000..a20bb89a1 --- /dev/null +++ b/docs/reference/datatypes/media-timed-chapter.schema.json @@ -0,0 +1,71 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-chapter", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Timed media chapter information", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Timed media chapter information.", + "definitions": { + "media-timed-chapter": { + "properties": { + "xdm:chapterAssetReference": { + "title": "Chapter asset reference", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference", + "description": "Asset information about the chapter captured by the experience event." + }, + "xdm:chapterAssetViewDetails": { + "title": "Chapter view details", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-chapter-view-details", + "description": "View details for the chapter playback captured by the experience event." + }, + "xdm:impressions": { + "title": "Chapter starts", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the intention to play a timed media asset. It does not measure success, as the user might abandon the content before the first frame is viewed." + }, + "xdm:completes": { + "title": "Chapter completes", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates if a timed media asset was watched to completion - this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead." + }, + "xdm:timePlayed": { + "title": "Chapter time spent", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the amount of time in seconds spent by a user on a specific timed media asset." + }, + "xdm:federated": { + "title": "Chapter federated", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates if an experience event was created through data federation or data sharing." + }, + "xdm:downloadedPlayback": { + "title": "Chapter downloaded flag", + "type": "boolean", + "description": "Set to true when the hit is generated due to playing a downloaded chapter content session." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-timed-chapter" + } + ], + "examples": [ + { + "@id": "https://data.adobe.io/entities/media-chapter/2144511", + "dc:title": "Chapter1", + "xmpDM:duration": 44 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/media-timed-chapter.schema.md b/docs/reference/datatypes/media-timed-chapter.schema.md new file mode 100644 index 000000000..91ad23ad8 --- /dev/null +++ b/docs/reference/datatypes/media-timed-chapter.schema.md @@ -0,0 +1,175 @@ + +# Timed media chapter information Schema + +``` +https://ns.adobe.com/xdm/context/media-timed-chapter +``` + +Timed media chapter information. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/media-timed-chapter.schema.json](datatypes/media-timed-chapter.schema.json) | +## Schema Hierarchy + +* Timed media chapter information `https://ns.adobe.com/xdm/context/media-timed-chapter` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Timed media chapter asset reference](media-timed-chapter-asset-reference.schema.md) `https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference` + * [Timed media chapter view details](media-timed-chapter-view-details.schema.md) `https://ns.adobe.com/xdm/context/media-timed-chapter-view-details` + * [Measure](data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## Timed media chapter information Example +```json +{ + "@id": "https://data.adobe.io/entities/media-chapter/2144511", + "dc:title": "Chapter1", + "xmpDM:duration": 44 +} +``` + +# Timed media chapter information Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:chapterAssetReference](#xdmchapterassetreference) | Timed media chapter asset reference | Optional | Timed media chapter information (this schema) | +| [xdm:chapterAssetViewDetails](#xdmchapterassetviewdetails) | Timed media chapter view details | Optional | Timed media chapter information (this schema) | +| [xdm:completes](#xdmcompletes) | Measure | Optional | Timed media chapter information (this schema) | +| [xdm:downloadedPlayback](#xdmdownloadedplayback) | `boolean` | Optional | Timed media chapter information (this schema) | +| [xdm:federated](#xdmfederated) | Measure | Optional | Timed media chapter information (this schema) | +| [xdm:impressions](#xdmimpressions) | Measure | Optional | Timed media chapter information (this schema) | +| [xdm:timePlayed](#xdmtimeplayed) | Measure | Optional | Timed media chapter information (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:chapterAssetReference +### Chapter asset reference + +Asset information about the chapter captured by the experience event. + +`xdm:chapterAssetReference` +* is optional +* type: Timed media chapter asset reference +* defined in this schema + +### xdm:chapterAssetReference Type + + +* [Timed media chapter asset reference](media-timed-chapter-asset-reference.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference` + + + + + +## xdm:chapterAssetViewDetails +### Chapter view details + +View details for the chapter playback captured by the experience event. + +`xdm:chapterAssetViewDetails` +* is optional +* type: Timed media chapter view details +* defined in this schema + +### xdm:chapterAssetViewDetails Type + + +* [Timed media chapter view details](media-timed-chapter-view-details.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-chapter-view-details` + + + + + +## xdm:completes +### Chapter completes + +Indicates if a timed media asset was watched to completion - this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead. + +`xdm:completes` +* is optional +* type: Measure +* defined in this schema + +### xdm:completes Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:downloadedPlayback +### Chapter downloaded flag + +Set to true when the hit is generated due to playing a downloaded chapter content session. + +`xdm:downloadedPlayback` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:downloadedPlayback Type + + +`boolean` + + + + + +## xdm:federated +### Chapter federated + +Indicates if an experience event was created through data federation or data sharing. + +`xdm:federated` +* is optional +* type: Measure +* defined in this schema + +### xdm:federated Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:impressions +### Chapter starts + +Describes the intention to play a timed media asset. It does not measure success, as the user might abandon the content before the first frame is viewed. + +`xdm:impressions` +* is optional +* type: Measure +* defined in this schema + +### xdm:impressions Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:timePlayed +### Chapter time spent + +Describes the amount of time in seconds spent by a user on a specific timed media asset. + +`xdm:timePlayed` +* is optional +* type: Measure +* defined in this schema + +### xdm:timePlayed Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + diff --git a/docs/reference/datatypes/media-timed-qoe.schema.json b/docs/reference/datatypes/media-timed-qoe.schema.json new file mode 100644 index 000000000..2fcd7e883 --- /dev/null +++ b/docs/reference/datatypes/media-timed-qoe.schema.json @@ -0,0 +1,191 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-qoe", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Timed media quality of experience", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Timed media properties related to the content playback's quality of experience (QoE).", + "definitions": { + "media-timed-qoe": { + "properties": { + "xdm:errors": { + "title": "Errors", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of errors that were encountered during playback." + }, + "xdm:buffers": { + "title": "Buffer events", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of buffer states that occurred during a playback session." + }, + "xdm:bufferTime": { + "title": "Total buffer duration", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the total amount of time in seconds, spent buffering." + }, + "xdm:bufferImpactedStreams": { + "title": "Buffer impacted streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of streams impacted by buffering." + }, + "xdm:stalls": { + "title": "Stalling events", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of stall states that occurred during a playback session." + }, + "xdm:stallTime": { + "title": "Total stalling duration", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the duration in seconds in which the playback was stalled during playback." + }, + "xdm:stallingImpactedStreams": { + "title": "Stalling impacted streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of streams impacted by stalling." + }, + "xdm:bitrateChanges": { + "title": "Bitrate changes", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of bitrate change events that occurred during a playback session." + }, + "xdm:bitrateAverage": { + "title": "Average bitrate", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A weighted average of all bitrate values related to the play duration that occurred during a playback session." + }, + "xdm:bitrateAverageBucket": { + "title": "Average bitrate bucket", + "type": "string", + "description": "The average bitrate (in kbps). The value is predefined buckets at 100kbps intervals." + }, + "xdm:bitrateChangeImpactedStreams": { + "title": "Bitrate change impacted streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of streams in which bitrate changes occurred." + }, + "xdm:droppedFrames": { + "title": "Dropped frames", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of frames dropped during playback of the main content." + }, + "xdm:droppedFrameImpactedStreams": { + "title": "Dropped frame impacted streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of streams in which frames were dropped." + }, + "xdm:dropBeforeStarts": { + "title": "Drops before starts", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates the user abandoned the media stream before the first frame for example, during the pre-roll ad break, or due to an error while loading the content from the CDN." + }, + "xdm:timeToStart": { + "title": "Time to start", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the duration (in seconds) passed between video load and start." + }, + "xdm:playerSdkErrors": { + "title": "Player SDK Error IDs", + "type": "array", + "items": { + "type": "string" + }, + "description": "The error IDs encountered during a playback session that originated in the Player." + }, + "xdm:mediaSdkErrors": { + "title": "Media SDK Error IDs", + "type": "array", + "items": { + "type": "string" + }, + "description": "The error IDs encountered during a playback session that originated in the Media SDK." + }, + "xdm:externalSdkErrors": { + "title": "External Error IDs", + "type": "array", + "items": { + "type": "string" + }, + "description": "The error IDs encountered during a playback session that originated outside the Player or SDK." + }, + "xdm:errorImpactedStreams": { + "title": "Error impacted streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of streams in which an error event occurred." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-timed-qoe" + } + ], + "examples": [ + { + "xdm:errors": { + "xdm:value": 0 + }, + "xdm:errorImpactedStreams": { + "xdm:value": 0 + }, + "xdm:buffers": { + "xdm:value": 4 + }, + "xdm:bufferTime": { + "xdm:value": 5 + }, + "xdm:bufferImpactedStreams": { + "xdm:value": 2 + }, + "xdm:stalls": { + "xdm:value": 0 + }, + "xdm:stallTime": { + "xdm:value": 0 + }, + "xdm:stallingImpactedStreams": { + "xdm:value": 0 + }, + "xdm:bitrateChanges": { + "xdm:value": 0 + }, + "xdm:bitrateChangeImpactedStreams": { + "xdm:value": 0 + }, + "xdm:bitrateAverage": { + "xdm:value": 320 + }, + "xdm:bitrateAverageBucket": "800-899", + "xdm:droppedFrames": { + "xdm:value": 2 + }, + "xdm:droppedFrameImpactedStreams": { + "xdm:value": 2 + }, + "xdm:timeToStart": { + "xdm:value": 3 + }, + "xdm:mediaSdkErrors": [ + "300", + "500.300.200" + ], + "xdm:playerSdkErrors": [ + "custom.error.code" + ], + "xdm:externalSdkErrors": [ + "100-5", + "11.12" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/media-timed-qoe.schema.md b/docs/reference/datatypes/media-timed-qoe.schema.md new file mode 100644 index 000000000..19d124376 --- /dev/null +++ b/docs/reference/datatypes/media-timed-qoe.schema.md @@ -0,0 +1,489 @@ + +# Timed media quality of experience Schema + +``` +https://ns.adobe.com/xdm/context/media-timed-qoe +``` + +Timed media properties related to the content playback's quality of experience (QoE). + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/media-timed-qoe.schema.json](datatypes/media-timed-qoe.schema.json) | +## Schema Hierarchy + +* Timed media quality of experience `https://ns.adobe.com/xdm/context/media-timed-qoe` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Measure](data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## Timed media quality of experience Example +```json +{ + "xdm:errors": { + "xdm:value": 0 + }, + "xdm:errorImpactedStreams": { + "xdm:value": 0 + }, + "xdm:buffers": { + "xdm:value": 4 + }, + "xdm:bufferTime": { + "xdm:value": 5 + }, + "xdm:bufferImpactedStreams": { + "xdm:value": 2 + }, + "xdm:stalls": { + "xdm:value": 0 + }, + "xdm:stallTime": { + "xdm:value": 0 + }, + "xdm:stallingImpactedStreams": { + "xdm:value": 0 + }, + "xdm:bitrateChanges": { + "xdm:value": 0 + }, + "xdm:bitrateChangeImpactedStreams": { + "xdm:value": 0 + }, + "xdm:bitrateAverage": { + "xdm:value": 320 + }, + "xdm:bitrateAverageBucket": "800-899", + "xdm:droppedFrames": { + "xdm:value": 2 + }, + "xdm:droppedFrameImpactedStreams": { + "xdm:value": 2 + }, + "xdm:timeToStart": { + "xdm:value": 3 + }, + "xdm:mediaSdkErrors": [ + "300", + "500.300.200" + ], + "xdm:playerSdkErrors": [ + "custom.error.code" + ], + "xdm:externalSdkErrors": [ + "100-5", + "11.12" + ] +} +``` + +# Timed media quality of experience Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:bitrateAverage](#xdmbitrateaverage) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:bitrateAverageBucket](#xdmbitrateaveragebucket) | `string` | Optional | Timed media quality of experience (this schema) | +| [xdm:bitrateChangeImpactedStreams](#xdmbitratechangeimpactedstreams) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:bitrateChanges](#xdmbitratechanges) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:bufferImpactedStreams](#xdmbufferimpactedstreams) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:bufferTime](#xdmbuffertime) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:buffers](#xdmbuffers) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:dropBeforeStarts](#xdmdropbeforestarts) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:droppedFrameImpactedStreams](#xdmdroppedframeimpactedstreams) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:droppedFrames](#xdmdroppedframes) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:errorImpactedStreams](#xdmerrorimpactedstreams) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:errors](#xdmerrors) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:externalSdkErrors](#xdmexternalsdkerrors) | `string[]` | Optional | Timed media quality of experience (this schema) | +| [xdm:mediaSdkErrors](#xdmmediasdkerrors) | `string[]` | Optional | Timed media quality of experience (this schema) | +| [xdm:playerSdkErrors](#xdmplayersdkerrors) | `string[]` | Optional | Timed media quality of experience (this schema) | +| [xdm:stallTime](#xdmstalltime) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:stallingImpactedStreams](#xdmstallingimpactedstreams) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:stalls](#xdmstalls) | Measure | Optional | Timed media quality of experience (this schema) | +| [xdm:timeToStart](#xdmtimetostart) | Measure | Optional | Timed media quality of experience (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:bitrateAverage +### Average bitrate + +A weighted average of all bitrate values related to the play duration that occurred during a playback session. + +`xdm:bitrateAverage` +* is optional +* type: Measure +* defined in this schema + +### xdm:bitrateAverage Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:bitrateAverageBucket +### Average bitrate bucket + +The average bitrate (in kbps). The value is predefined buckets at 100kbps intervals. + +`xdm:bitrateAverageBucket` +* is optional +* type: `string` +* defined in this schema + +### xdm:bitrateAverageBucket Type + + +`string` + + + + + + +## xdm:bitrateChangeImpactedStreams +### Bitrate change impacted streams + +The number of streams in which bitrate changes occurred. + +`xdm:bitrateChangeImpactedStreams` +* is optional +* type: Measure +* defined in this schema + +### xdm:bitrateChangeImpactedStreams Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:bitrateChanges +### Bitrate changes + +The number of bitrate change events that occurred during a playback session. + +`xdm:bitrateChanges` +* is optional +* type: Measure +* defined in this schema + +### xdm:bitrateChanges Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:bufferImpactedStreams +### Buffer impacted streams + +The number of streams impacted by buffering. + +`xdm:bufferImpactedStreams` +* is optional +* type: Measure +* defined in this schema + +### xdm:bufferImpactedStreams Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:bufferTime +### Total buffer duration + +Describes the total amount of time in seconds, spent buffering. + +`xdm:bufferTime` +* is optional +* type: Measure +* defined in this schema + +### xdm:bufferTime Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:buffers +### Buffer events + +The number of buffer states that occurred during a playback session. + +`xdm:buffers` +* is optional +* type: Measure +* defined in this schema + +### xdm:buffers Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:dropBeforeStarts +### Drops before starts + +Indicates the user abandoned the media stream before the first frame for example, during the pre-roll ad break, or due to an error while loading the content from the CDN. + +`xdm:dropBeforeStarts` +* is optional +* type: Measure +* defined in this schema + +### xdm:dropBeforeStarts Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:droppedFrameImpactedStreams +### Dropped frame impacted streams + +The number of streams in which frames were dropped. + +`xdm:droppedFrameImpactedStreams` +* is optional +* type: Measure +* defined in this schema + +### xdm:droppedFrameImpactedStreams Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:droppedFrames +### Dropped frames + +The number of frames dropped during playback of the main content. + +`xdm:droppedFrames` +* is optional +* type: Measure +* defined in this schema + +### xdm:droppedFrames Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:errorImpactedStreams +### Error impacted streams + +The number of streams in which an error event occurred. + +`xdm:errorImpactedStreams` +* is optional +* type: Measure +* defined in this schema + +### xdm:errorImpactedStreams Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:errors +### Errors + +The number of errors that were encountered during playback. + +`xdm:errors` +* is optional +* type: Measure +* defined in this schema + +### xdm:errors Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:externalSdkErrors +### External Error IDs + +The error IDs encountered during a playback session that originated outside the Player or SDK. + +`xdm:externalSdkErrors` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:externalSdkErrors Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + + + + +## xdm:mediaSdkErrors +### Media SDK Error IDs + +The error IDs encountered during a playback session that originated in the Media SDK. + +`xdm:mediaSdkErrors` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:mediaSdkErrors Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + + + + +## xdm:playerSdkErrors +### Player SDK Error IDs + +The error IDs encountered during a playback session that originated in the Player. + +`xdm:playerSdkErrors` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:playerSdkErrors Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + + + + +## xdm:stallTime +### Total stalling duration + +Describes the duration in seconds in which the playback was stalled during playback. + +`xdm:stallTime` +* is optional +* type: Measure +* defined in this schema + +### xdm:stallTime Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:stallingImpactedStreams +### Stalling impacted streams + +The number of streams impacted by stalling. + +`xdm:stallingImpactedStreams` +* is optional +* type: Measure +* defined in this schema + +### xdm:stallingImpactedStreams Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:stalls +### Stalling events + +The number of stall states that occurred during a playback session. + +`xdm:stalls` +* is optional +* type: Measure +* defined in this schema + +### xdm:stalls Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:timeToStart +### Time to start + +Describes the duration (in seconds) passed between video load and start. + +`xdm:timeToStart` +* is optional +* type: Measure +* defined in this schema + +### xdm:timeToStart Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + diff --git a/docs/reference/datatypes/media-timed.schema.json b/docs/reference/datatypes/media-timed.schema.json new file mode 100644 index 000000000..0b3ce67ed --- /dev/null +++ b/docs/reference/datatypes/media-timed.schema.json @@ -0,0 +1,261 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Timed media information", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Information related to timed media such main content, ads, and chapters.", + "definitions": { + "media-timed": { + "properties": { + "xdm:primaryAssetReference": { + "title": "Primary asset reference", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-asset-reference", + "description": "Asset information about the main content that was played, present on all ads and chapters that occur during the content's playback." + }, + "xdm:primaryAssetViewDetails": { + "title": "Primary asset view details", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-asset-view-details", + "description": "View details for the main content playback, present on all ads and chapters that occur during the content's playback." + }, + "xdm:mediaChapter": { + "title": "Media chapter", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-chapter", + "description": "Timed media chapter information." + }, + "xdm:impressions": { + "title": "Media starts", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the intention to play a timed media asset. It does not measure success, as the user might abandon the content before the first frame is viewed." + }, + "xdm:completes": { + "title": "Content completes", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates if a timed media asset was watched to completion, this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead." + }, + "xdm:timePlayed": { + "title": "Content time spent", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The amount of time spent in seconds by a user on a specific timed media asset." + }, + "xdm:federated": { + "title": "Media federated", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates the experience event was created through data federation or data sharing." + }, + "xdm:starts": { + "title": "Content starts", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates the first frame of the timed media asset has been viewed for example, the viewer did not abandon during pre-roll ad, or buffering." + }, + "xdm:mediaSegmentViews": { + "title": "Media segment views", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates when at least one frame, not necessarily the first has been viewed." + }, + "xdm:dropBeforeStarts": { + "title": "Drops before starts", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates the user abandoned the media stream before the first frame for example, during the pre-roll ad break, or due to an error while loading the content from the CDN.", + "meta:status": "deprecated" + }, + "xdm:totalTimePlayed": { + "title": "Media Time Spent", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the total amount of time spent by a user on a specific timed media asset, which includes time spent watching ads." + }, + "xdm:uniqueTimePlayed": { + "title": "Unique Time Played", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the sum of the unique intervals seen by a user on a timed media asset - i.e. the length playback intervals viewed multiple times are only counted once." + }, + "xdm:averageMinuteAudience": { + "title": "Average Minute Audience", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the average content time spent for a specific media item - i.e. the total content time spent divided by the length for all of the playback sessions." + }, + "xdm:adCount": { + "title": "Ad count", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of ads started during the playback." + }, + "xdm:chapterCount": { + "title": "Chapter count", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of chapters started during the playback." + }, + "xdm:progress10": { + "title": "10% Progress marker", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates that the playhead passed the 10% marker of media based on stream length. The marker is only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." + }, + "xdm:progress25": { + "title": "25% Progress marker", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates that the playhead passed the 25% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." + }, + "xdm:progress50": { + "title": "50% Progress marker", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates that the playhead passed the 50% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." + }, + "xdm:progress75": { + "title": "75% Progress marker", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates that the playhead passed the 75% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." + }, + "xdm:progress95": { + "title": "95% Progress marker", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates that the playhead passed the 95% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." + }, + "xdm:resumes": { + "title": "Content resumes", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Marks each playback that was resumed after more than 30 minutes of buffer, pause, or stall period." + }, + "xdm:estimatedStreams": { + "title": "Estimated streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The estimated number of video or audio streams per each individual content." + }, + "xdm:pauseImpactedStreams": { + "title": "Pause impacted streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates if one or more pauses occurred during the playback of a single media item." + }, + "xdm:pauses": { + "title": "Pause events", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of pause periods that occurred during playback." + }, + "xdm:pauseTime": { + "title": "Total pause duration", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the duration in seconds in which playback was paused by the user." + }, + "xdm:idp": { + "title": "MVPD Identifier", + "type": "string", + "description": "The MVPD (Multichannel Video Programming Distributor) provided via authentication. [https://en.wikipedia.org/?title=MVPD]" + }, + "xdm:mediaAuth": { + "title": "Media authorized", + "type": "string", + "description": "The user has been authorized via authentication." + }, + "xdm:dayPart": { + "title": "Day part", + "type": "string", + "description": "Defines the time of the day when the content was broadcast or played." + } + }, + "required": [ + "xdm:primaryAssetReference" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-timed" + } + ], + "examples": [ + { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "show_summary", + "iptc4xmpExt:Identifier": "http://sporttv.com/series-identifiers/2613123" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "MYTV", + "iptc4xmpExt:RatingSourceLink": "http://www.sporttops.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "SportTV" + } + ] + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchsport", + "xdm:videoSegment": "3-10", + "xdm:path": "id:show:season:episode:bla.com:123a12263-4ce7", + "xdm:broadcastChannel": "WatchSportTV", + "xdm:broadcastContentType": "VOD", + "xdm:streamFormat": "short", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "ntwu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.this.link.net%2Fhls%2Fvu%2F9083406%2FVUBX02804879t475=90980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:downloadedPlayback": false, + "xdm:fullScreen": { + "xdm:playerStateSet": true, + "xdm:playerStateCount": 3, + "xdm:playerStateTime": 2520 + }, + "xdm:mute": { + "xdm:playerStateSet": false, + "xdm:playerStateCount": 5, + "xdm:playerStateTime": 80 + } + }, + "xdm:mediaChapter": { + "xdm:chapterAssetReference": { + "@id": "https://data.adobe.io/entities/media-chapter-asset-reference/2144511", + "dc:title": "Chapter1", + "xmpDM:duration": 44 + }, + "xdm:chapterAssetViewDetails": { + "xdm:index": 0, + "xdm:offset": 0 + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 1 + }, + "xdm:timePlayed": { + "xdm:value": 44 + }, + "xdm:federated": { + "xdm:value": 0 + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/media-timed.schema.md b/docs/reference/datatypes/media-timed.schema.md new file mode 100644 index 000000000..029f154e4 --- /dev/null +++ b/docs/reference/datatypes/media-timed.schema.md @@ -0,0 +1,680 @@ + +# Timed media information Schema + +``` +https://ns.adobe.com/xdm/context/media-timed +``` + +Information related to timed media such main content, ads, and chapters. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/media-timed.schema.json](datatypes/media-timed.schema.json) | +## Schema Hierarchy + +* Timed media information `https://ns.adobe.com/xdm/context/media-timed` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Timed media primary asset reference](media-timed-asset-reference.schema.md) `https://ns.adobe.com/xdm/context/media-timed-asset-reference` + * [Primary asset view details](media-timed-asset-view-details.schema.md) `https://ns.adobe.com/xdm/context/media-timed-asset-view-details` + * [Timed media chapter information](media-timed-chapter.schema.md) `https://ns.adobe.com/xdm/context/media-timed-chapter` + * [Measure](data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## Timed media information Example +```json +{ + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "show_summary", + "iptc4xmpExt:Identifier": "http://sporttv.com/series-identifiers/2613123" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "MYTV", + "iptc4xmpExt:RatingSourceLink": "http://www.sporttops.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "SportTV" + } + ] + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchsport", + "xdm:videoSegment": "3-10", + "xdm:path": "id:show:season:episode:bla.com:123a12263-4ce7", + "xdm:broadcastChannel": "WatchSportTV", + "xdm:broadcastContentType": "VOD", + "xdm:streamFormat": "short", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "ntwu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.this.link.net%2Fhls%2Fvu%2F9083406%2FVUBX02804879t475=90980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:downloadedPlayback": false, + "xdm:fullScreen": { + "xdm:playerStateSet": true, + "xdm:playerStateCount": 3, + "xdm:playerStateTime": 2520 + }, + "xdm:mute": { + "xdm:playerStateSet": false, + "xdm:playerStateCount": 5, + "xdm:playerStateTime": 80 + } + }, + "xdm:mediaChapter": { + "xdm:chapterAssetReference": { + "@id": "https://data.adobe.io/entities/media-chapter-asset-reference/2144511", + "dc:title": "Chapter1", + "xmpDM:duration": 44 + }, + "xdm:chapterAssetViewDetails": { + "xdm:index": 0, + "xdm:offset": 0 + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 1 + }, + "xdm:timePlayed": { + "xdm:value": 44 + }, + "xdm:federated": { + "xdm:value": 0 + } + } +} +``` + +# Timed media information Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:adCount](#xdmadcount) | Measure | Optional | Timed media information (this schema) | +| [xdm:averageMinuteAudience](#xdmaverageminuteaudience) | Measure | Optional | Timed media information (this schema) | +| [xdm:chapterCount](#xdmchaptercount) | Measure | Optional | Timed media information (this schema) | +| [xdm:completes](#xdmcompletes) | Measure | Optional | Timed media information (this schema) | +| [xdm:dayPart](#xdmdaypart) | `string` | Optional | Timed media information (this schema) | +| [xdm:dropBeforeStarts](#xdmdropbeforestarts) | Measure | Optional | Timed media information (this schema) | +| [xdm:estimatedStreams](#xdmestimatedstreams) | Measure | Optional | Timed media information (this schema) | +| [xdm:federated](#xdmfederated) | Measure | Optional | Timed media information (this schema) | +| [xdm:idp](#xdmidp) | `string` | Optional | Timed media information (this schema) | +| [xdm:impressions](#xdmimpressions) | Measure | Optional | Timed media information (this schema) | +| [xdm:mediaAuth](#xdmmediaauth) | `string` | Optional | Timed media information (this schema) | +| [xdm:mediaChapter](#xdmmediachapter) | Timed media chapter information | Optional | Timed media information (this schema) | +| [xdm:mediaSegmentViews](#xdmmediasegmentviews) | Measure | Optional | Timed media information (this schema) | +| [xdm:pauseImpactedStreams](#xdmpauseimpactedstreams) | Measure | Optional | Timed media information (this schema) | +| [xdm:pauseTime](#xdmpausetime) | Measure | Optional | Timed media information (this schema) | +| [xdm:pauses](#xdmpauses) | Measure | Optional | Timed media information (this schema) | +| [xdm:primaryAssetReference](#xdmprimaryassetreference) | Timed media primary asset reference | Optional | Timed media information (this schema) | +| [xdm:primaryAssetViewDetails](#xdmprimaryassetviewdetails) | Primary asset view details | Optional | Timed media information (this schema) | +| [xdm:progress10](#xdmprogress10) | Measure | Optional | Timed media information (this schema) | +| [xdm:progress25](#xdmprogress25) | Measure | Optional | Timed media information (this schema) | +| [xdm:progress50](#xdmprogress50) | Measure | Optional | Timed media information (this schema) | +| [xdm:progress75](#xdmprogress75) | Measure | Optional | Timed media information (this schema) | +| [xdm:progress95](#xdmprogress95) | Measure | Optional | Timed media information (this schema) | +| [xdm:resumes](#xdmresumes) | Measure | Optional | Timed media information (this schema) | +| [xdm:starts](#xdmstarts) | Measure | Optional | Timed media information (this schema) | +| [xdm:timePlayed](#xdmtimeplayed) | Measure | Optional | Timed media information (this schema) | +| [xdm:totalTimePlayed](#xdmtotaltimeplayed) | Measure | Optional | Timed media information (this schema) | +| [xdm:uniqueTimePlayed](#xdmuniquetimeplayed) | Measure | Optional | Timed media information (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:adCount +### Ad count + +The number of ads started during the playback. + +`xdm:adCount` +* is optional +* type: Measure +* defined in this schema + +### xdm:adCount Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:averageMinuteAudience +### Average Minute Audience + +Describes the average content time spent for a specific media item - i.e. the total content time spent divided by the length for all of the playback sessions. + +`xdm:averageMinuteAudience` +* is optional +* type: Measure +* defined in this schema + +### xdm:averageMinuteAudience Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:chapterCount +### Chapter count + +The number of chapters started during the playback. + +`xdm:chapterCount` +* is optional +* type: Measure +* defined in this schema + +### xdm:chapterCount Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:completes +### Content completes + +Indicates if a timed media asset was watched to completion, this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead. + +`xdm:completes` +* is optional +* type: Measure +* defined in this schema + +### xdm:completes Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:dayPart +### Day part + +Defines the time of the day when the content was broadcast or played. + +`xdm:dayPart` +* is optional +* type: `string` +* defined in this schema + +### xdm:dayPart Type + + +`string` + + + + + + +## xdm:dropBeforeStarts +### Drops before starts + +Indicates the user abandoned the media stream before the first frame for example, during the pre-roll ad break, or due to an error while loading the content from the CDN. + +`xdm:dropBeforeStarts` +* is optional +* type: Measure +* defined in this schema + +### xdm:dropBeforeStarts Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:estimatedStreams +### Estimated streams + +The estimated number of video or audio streams per each individual content. + +`xdm:estimatedStreams` +* is optional +* type: Measure +* defined in this schema + +### xdm:estimatedStreams Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:federated +### Media federated + +Indicates the experience event was created through data federation or data sharing. + +`xdm:federated` +* is optional +* type: Measure +* defined in this schema + +### xdm:federated Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:idp +### MVPD Identifier + +The MVPD (Multichannel Video Programming Distributor) provided via authentication. [https://en.wikipedia.org/?title=MVPD] + +`xdm:idp` +* is optional +* type: `string` +* defined in this schema + +### xdm:idp Type + + +`string` + + + + + + +## xdm:impressions +### Media starts + +Describes the intention to play a timed media asset. It does not measure success, as the user might abandon the content before the first frame is viewed. + +`xdm:impressions` +* is optional +* type: Measure +* defined in this schema + +### xdm:impressions Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:mediaAuth +### Media authorized + +The user has been authorized via authentication. + +`xdm:mediaAuth` +* is optional +* type: `string` +* defined in this schema + +### xdm:mediaAuth Type + + +`string` + + + + + + +## xdm:mediaChapter +### Media chapter + +Timed media chapter information. + +`xdm:mediaChapter` +* is optional +* type: Timed media chapter information +* defined in this schema + +### xdm:mediaChapter Type + + +* [Timed media chapter information](media-timed-chapter.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-chapter` + + + + + +## xdm:mediaSegmentViews +### Media segment views + +Indicates when at least one frame, not necessarily the first has been viewed. + +`xdm:mediaSegmentViews` +* is optional +* type: Measure +* defined in this schema + +### xdm:mediaSegmentViews Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:pauseImpactedStreams +### Pause impacted streams + +Indicates if one or more pauses occurred during the playback of a single media item. + +`xdm:pauseImpactedStreams` +* is optional +* type: Measure +* defined in this schema + +### xdm:pauseImpactedStreams Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:pauseTime +### Total pause duration + +Describes the duration in seconds in which playback was paused by the user. + +`xdm:pauseTime` +* is optional +* type: Measure +* defined in this schema + +### xdm:pauseTime Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:pauses +### Pause events + +The number of pause periods that occurred during playback. + +`xdm:pauses` +* is optional +* type: Measure +* defined in this schema + +### xdm:pauses Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:primaryAssetReference +### Primary asset reference + +Asset information about the main content that was played, present on all ads and chapters that occur during the content's playback. + +`xdm:primaryAssetReference` +* is optional +* type: Timed media primary asset reference +* defined in this schema + +### xdm:primaryAssetReference Type + + +* [Timed media primary asset reference](media-timed-asset-reference.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-asset-reference` + + + + + +## xdm:primaryAssetViewDetails +### Primary asset view details + +View details for the main content playback, present on all ads and chapters that occur during the content's playback. + +`xdm:primaryAssetViewDetails` +* is optional +* type: Primary asset view details +* defined in this schema + +### xdm:primaryAssetViewDetails Type + + +* [Primary asset view details](media-timed-asset-view-details.schema.md) – `https://ns.adobe.com/xdm/context/media-timed-asset-view-details` + + + + + +## xdm:progress10 +### 10% Progress marker + +Indicates that the playhead passed the 10% marker of media based on stream length. The marker is only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted. + +`xdm:progress10` +* is optional +* type: Measure +* defined in this schema + +### xdm:progress10 Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:progress25 +### 25% Progress marker + +Indicates that the playhead passed the 25% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted. + +`xdm:progress25` +* is optional +* type: Measure +* defined in this schema + +### xdm:progress25 Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:progress50 +### 50% Progress marker + +Indicates that the playhead passed the 50% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted. + +`xdm:progress50` +* is optional +* type: Measure +* defined in this schema + +### xdm:progress50 Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:progress75 +### 75% Progress marker + +Indicates that the playhead passed the 75% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted. + +`xdm:progress75` +* is optional +* type: Measure +* defined in this schema + +### xdm:progress75 Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:progress95 +### 95% Progress marker + +Indicates that the playhead passed the 95% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted. + +`xdm:progress95` +* is optional +* type: Measure +* defined in this schema + +### xdm:progress95 Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:resumes +### Content resumes + +Marks each playback that was resumed after more than 30 minutes of buffer, pause, or stall period. + +`xdm:resumes` +* is optional +* type: Measure +* defined in this schema + +### xdm:resumes Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:starts +### Content starts + +Indicates the first frame of the timed media asset has been viewed for example, the viewer did not abandon during pre-roll ad, or buffering. + +`xdm:starts` +* is optional +* type: Measure +* defined in this schema + +### xdm:starts Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:timePlayed +### Content time spent + +The amount of time spent in seconds by a user on a specific timed media asset. + +`xdm:timePlayed` +* is optional +* type: Measure +* defined in this schema + +### xdm:timePlayed Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:totalTimePlayed +### Media Time Spent + +Describes the total amount of time spent by a user on a specific timed media asset, which includes time spent watching ads. + +`xdm:totalTimePlayed` +* is optional +* type: Measure +* defined in this schema + +### xdm:totalTimePlayed Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:uniqueTimePlayed +### Unique Time Played + +Describes the sum of the unique intervals seen by a user on a timed media asset - i.e. the length playback intervals viewed multiple times are only counted once. + +`xdm:uniqueTimePlayed` +* is optional +* type: Measure +* defined in this schema + +### xdm:uniqueTimePlayed Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + diff --git a/docs/reference/datatypes/media.schema.json b/docs/reference/datatypes/media.schema.json new file mode 100644 index 000000000..d0a61532f --- /dev/null +++ b/docs/reference/datatypes/media.schema.json @@ -0,0 +1,115 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Media information", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Media context information for content related interactions.", + "definitions": { + "media": { + "properties": { + "xdm:mediaTimed": { + "title": "Timed media information", + "$ref": "https://ns.adobe.com/xdm/context/media-timed", + "description": "Information related to timed media main content, such as ads and chapters." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media" + } + ], + "examples": [ + { + "xdm:mediaTimed": { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "nba_highlights", + "iptc4xmpExt:Identifier": "http://espn.com/series-identifiers/2613953" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:rating": [ + { + "iptc4xmpExt:RatingValue": "TV", + "iptc4xmpExt:RatingSourceLink": "http://www.tvrates.org/ratings.htm" + } + ], + "iptc4xmpExt:creator": [ + { + "iptc4xmpExt:Name": "MyChannel" + } + ] + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchmytv", + "xdm:videoSegment": "3-10", + "xdm:path": "mid:movie:part:foo.com:dfehfdb3-4ce7", + "xdm:broadcastChannel": "WatchMyTV", + "xdm:broadcastContentType": "VOD", + "xdm:streamFormat": "short", + "xdm:vhlVersion": "js-2.0.1.88-c8c0b1", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "eccu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.pure.centurylink.net%2Fhls%2Fvu%2F9080890106690980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:downloadedPlayback": false + }, + "xdm:mediaChapter": { + "xdm:chapterAssetReference": { + "@id": "https://data.adobe.io/entities/media-chapter-asset-reference/2144511", + "xdm:name": "Chapter1", + "xmpDM:duration": 44 + }, + "xdm:chapterAssetViewDetails": { + "xdm:index": 0, + "xdm:offset": 0 + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 1 + }, + "xdm:timePlayed": { + "xdm:value": 44 + }, + "xdm:federated": { + "xdm:value": 0 + } + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/media.schema.md b/docs/reference/datatypes/media.schema.md new file mode 100644 index 000000000..8eca56923 --- /dev/null +++ b/docs/reference/datatypes/media.schema.md @@ -0,0 +1,127 @@ + +# Media information Schema + +``` +https://ns.adobe.com/xdm/context/media +``` + +Media context information for content related interactions. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/media.schema.json](datatypes/media.schema.json) | +## Schema Hierarchy + +* Media information `https://ns.adobe.com/xdm/context/media` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Timed media information](media-timed.schema.md) `https://ns.adobe.com/xdm/context/media-timed` + + +## Media information Example +```json +{ + "xdm:mediaTimed": { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "nba_highlights", + "iptc4xmpExt:Identifier": "http://espn.com/series-identifiers/2613953" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:rating": [ + { + "iptc4xmpExt:RatingValue": "TV", + "iptc4xmpExt:RatingSourceLink": "http://www.tvrates.org/ratings.htm" + } + ], + "iptc4xmpExt:creator": [ + { + "iptc4xmpExt:Name": "MyChannel" + } + ] + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchmytv", + "xdm:videoSegment": "3-10", + "xdm:path": "mid:movie:part:foo.com:dfehfdb3-4ce7", + "xdm:broadcastChannel": "WatchMyTV", + "xdm:broadcastContentType": "VOD", + "xdm:streamFormat": "short", + "xdm:vhlVersion": "js-2.0.1.88-c8c0b1", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "eccu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.pure.centurylink.net%2Fhls%2Fvu%2F9080890106690980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:downloadedPlayback": false + }, + "xdm:mediaChapter": { + "xdm:chapterAssetReference": { + "@id": "https://data.adobe.io/entities/media-chapter-asset-reference/2144511", + "xdm:name": "Chapter1", + "xmpDM:duration": 44 + }, + "xdm:chapterAssetViewDetails": { + "xdm:index": 0, + "xdm:offset": 0 + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 1 + }, + "xdm:timePlayed": { + "xdm:value": 44 + }, + "xdm:federated": { + "xdm:value": 0 + } + } + } +} +``` + +# Media information Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:mediaTimed](#xdmmediatimed) | Timed media information | Optional | Media information (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:mediaTimed +### Timed media information + +Information related to timed media main content, such as ads and chapters. + +`xdm:mediaTimed` +* is optional +* type: Timed media information +* defined in this schema + +### xdm:mediaTimed Type + + +* [Timed media information](media-timed.schema.md) – `https://ns.adobe.com/xdm/context/media-timed` + + + + diff --git a/docs/reference/datatypes/meeting-interaction.schema.json b/docs/reference/datatypes/meeting-interaction.schema.json new file mode 100644 index 000000000..5c708dfc9 --- /dev/null +++ b/docs/reference/datatypes/meeting-interaction.schema.json @@ -0,0 +1,78 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/meetinginteraction", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Meeting Interaction", + "type": "object", + "meta:extensible": true, + "description": "Captures information in the context of a meeting between people online or at a specified location", + "definitions": { + "meetinginteraction": { + "properties": { + "xdm:isAllDay": { + "title": "All Day meeting/event", + "type": "boolean", + "description": "A flag to represent whether the meeting is all day long" + }, + "xdm:isOnline": { + "title": "Meeting online/offline", + "type": "boolean", + "description": "A flag indicating whether the neeting is online of offline" + }, + "xdm:isReminderSet": { + "title": "Reminder Set for the meeting", + "type": "boolean", + "description": "A flag indicating whether a reminder has been in place for the meeting" + }, + "xdm:reminderDateTime": { + "title": "Date and time at which the reminder is set", + "type": "string", + "format": "date-time", + "description": "The date and time for which the reminder is set, if the flag for reminder set has been set to true" + }, + "xdm:scheduledStartDateTime": { + "title": "Time at which the meeting has been schedued to start", + "type": "string", + "format": "date-time", + "description": "Scheduled time at which the meeting will start" + }, + "xdm:scheduledEndDateTime": { + "title": "Scheduled time for the meeting to end", + "type": "string", + "format": "date-time", + "description": "Scheduled time by which the meeting should end" + }, + "xdm:organizerID": { + "title": "Person organizing the meeting", + "type": "string", + "description": "Person who is responsible to control and manage the meeting" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/meetinginteraction" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:isAllDay": true, + "xdm:isOnline": true, + "xdm:isReminderSet": true, + "xdm:reminderDateTime": "2020-05-19T00:00:00+00:00", + "xdm:scheduledStartDateTime": "2020-05-20T09:00:00+00:00", + "xdm:scheduledEndDateTime": "2020-05-20T18:00:00+00:00", + "xdm:organizerID": "98536" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/meeting-interaction.schema.md b/docs/reference/datatypes/meeting-interaction.schema.md new file mode 100644 index 000000000..75fc15da8 --- /dev/null +++ b/docs/reference/datatypes/meeting-interaction.schema.md @@ -0,0 +1,183 @@ + +# Meeting Interaction Schema + +``` +https://ns.adobe.com/xdm/common/meetinginteraction +``` + +Captures information in the context of a meeting between people online or at a specified location + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [datatypes/meeting-interaction.schema.json](datatypes/meeting-interaction.schema.json) | +## Schema Hierarchy + +* Meeting Interaction `https://ns.adobe.com/xdm/common/meetinginteraction` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Meeting Interaction Example +```json +{ + "xdm:isAllDay": true, + "xdm:isOnline": true, + "xdm:isReminderSet": true, + "xdm:reminderDateTime": "2020-05-19T00:00:00+00:00", + "xdm:scheduledStartDateTime": "2020-05-20T09:00:00+00:00", + "xdm:scheduledEndDateTime": "2020-05-20T18:00:00+00:00", + "xdm:organizerID": "98536" +} +``` + +# Meeting Interaction Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:isAllDay](#xdmisallday) | `boolean` | Optional | Meeting Interaction (this schema) | +| [xdm:isOnline](#xdmisonline) | `boolean` | Optional | Meeting Interaction (this schema) | +| [xdm:isReminderSet](#xdmisreminderset) | `boolean` | Optional | Meeting Interaction (this schema) | +| [xdm:organizerID](#xdmorganizerid) | `string` | Optional | Meeting Interaction (this schema) | +| [xdm:reminderDateTime](#xdmreminderdatetime) | `string` | Optional | Meeting Interaction (this schema) | +| [xdm:scheduledEndDateTime](#xdmscheduledenddatetime) | `string` | Optional | Meeting Interaction (this schema) | +| [xdm:scheduledStartDateTime](#xdmscheduledstartdatetime) | `string` | Optional | Meeting Interaction (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:isAllDay +### All Day meeting/event + +A flag to represent whether the meeting is all day long + +`xdm:isAllDay` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isAllDay Type + + +`boolean` + + + + + +## xdm:isOnline +### Meeting online/offline + +A flag indicating whether the neeting is online of offline + +`xdm:isOnline` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isOnline Type + + +`boolean` + + + + + +## xdm:isReminderSet +### Reminder Set for the meeting + +A flag indicating whether a reminder has been in place for the meeting + +`xdm:isReminderSet` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isReminderSet Type + + +`boolean` + + + + + +## xdm:organizerID +### Person organizing the meeting + +Person who is responsible to control and manage the meeting + +`xdm:organizerID` +* is optional +* type: `string` +* defined in this schema + +### xdm:organizerID Type + + +`string` + + + + + + +## xdm:reminderDateTime +### Date and time at which the reminder is set + +The date and time for which the reminder is set, if the flag for reminder set has been set to true + +`xdm:reminderDateTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:reminderDateTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:scheduledEndDateTime +### Scheduled time for the meeting to end + +Scheduled time by which the meeting should end + +`xdm:scheduledEndDateTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:scheduledEndDateTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:scheduledStartDateTime +### Time at which the meeting has been schedued to start + +Scheduled time at which the meeting will start + +`xdm:scheduledStartDateTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:scheduledStartDateTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + diff --git a/docs/reference/datatypes/namespace.schema.json b/docs/reference/datatypes/namespace.schema.json new file mode 100644 index 000000000..795c1d2a0 --- /dev/null +++ b/docs/reference/datatypes/namespace.schema.json @@ -0,0 +1,43 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/namespace", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Namespace", + "type": "object", + "meta:extensible": true, + "description": "Namespaces are used to scope end-user and device identities generated by different parties which need to later be linked or correlated. The namespace ensures first, second, and third party user and device identities can be used in customer engagement platforms. (Note: do not confuse identity namespaces with the JSON-LD namespaces used in describing XDM schemas.)\n\nNamespaces are used to attain uniqueness with user and device identities that originate in distributed, uncoordinated identity environments. It can be thought of as an additional prefix that can be used to guarantee uniqueness between several generators of identities that are only otherwise guaranteed to be unique in the scope of the individual generating system (the standard case for cookies and integer based identities).\n\nIn XDM, end-user or device identities (represented by the `Identity` schema) are always scoped by a namespace.\n\nThis architecture assumes the following components:\n\n * The *managing service* is the system (for example, a customer engagement platform) that needs to manage and use identities flowing from different sources and from disparate parties.\n * The *contributing service* is the system (for example, a web site that places end-user cookies) that sends identities to the managing service to be managed or used.\n * The *namespace service* is the system that manages namespaces on behalf of the other services in order to allow them to share identities while ensuring uniqueness. It is often, but not always, operated as part of the managing service.\n \nWithin this architecture, identities may be shared with the managing service as follows:\n\n * The contributing service calls the namespace service and creates a new namespace. While the namespace service owns the namespace, the contributing service is responsible for giving it a name that is unique for itself. This name is called a \"code\". The namespace service is responsible for ensuring that each namespace created has a unique code within the context of the contributing service. For example, the namespace service may use the authentication credentials provided by the contributing service (or other mechanism) to identify the contributing service, and to ensure the code is unique within the set of codes provided by that service.\n \n * When sending end-user identities to the managing service (for example, when sending data via `ExperienceEvent`), the contributing service includes the namespace code on each identity.\n \n * When receiving end-user identities, the managing service stores, links, or otherwise uses the provided identities prefixed with the namespace code, ensuring uniqueness. The managing service should verify both that the namespace is valid and that the namespace was created by or owned by the contributing service. \n\nA namespace code is used in lieu of a UUID or namespace service controlled identifier in order to integrate more easily with existing systems that generate end-user identities. These systems use many different schemes for managing uniqueness within their own domains. Often these codes are human-readable values that designate an account or contract.\n\nWhile in the general case namespace codes are owned and managed by the contributing service, a namespace service may allocate its own namespaces with codes that might be used by multiple contributing services to send common identifies. Examples here include email addresses, phone numbers, or push notification tokens. Details on how a namespace service shares these global codes with a contributing service, or prevents them from conflicting with codes generated by contributing services, is not defined by this framework.\n\nRelated:\n\nNamespaces are similar to datasources, both in the use of codes and in the assumed architecture for their use. The core difference being datasources are used to uniquely identify specific sources of general data in an uncoordinated data environment, such as independent data collection applications. These concepts are distinct because the source of data, and the source of the identities contained in that data, may not be the same.\n", + "definitions": { + "namespace": { + "properties": { + "xdm:code": { + "title": "Code", + "type": "string", + "description": "The code is a human readable identifier for the namespace and can be used to request the technical namespace id which is used for identity graph processing." + } + }, + "required": [ + "xdm:code" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/namespace" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/entities/namespace/12345", + "xdm:code": "AA12345" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/namespace.schema.md b/docs/reference/datatypes/namespace.schema.md new file mode 100644 index 000000000..5bfa90fd0 --- /dev/null +++ b/docs/reference/datatypes/namespace.schema.md @@ -0,0 +1,79 @@ + +# Namespace Schema + +``` +https://ns.adobe.com/xdm/context/namespace +``` + +Namespaces are used to scope end-user and device identities generated by different parties which need to later be linked or correlated. The namespace ensures first, second, and third party user and device identities can be used in customer engagement platforms. (Note: do not confuse identity namespaces with the JSON-LD namespaces used in describing XDM schemas.) + +Namespaces are used to attain uniqueness with user and device identities that originate in distributed, uncoordinated identity environments. It can be thought of as an additional prefix that can be used to guarantee uniqueness between several generators of identities that are only otherwise guaranteed to be unique in the scope of the individual generating system (the standard case for cookies and integer based identities). + +In XDM, end-user or device identities (represented by the `Identity` schema) are always scoped by a namespace. + +This architecture assumes the following components: + + * The *managing service* is the system (for example, a customer engagement platform) that needs to manage and use identities flowing from different sources and from disparate parties. + * The *contributing service* is the system (for example, a web site that places end-user cookies) that sends identities to the managing service to be managed or used. + * The *namespace service* is the system that manages namespaces on behalf of the other services in order to allow them to share identities while ensuring uniqueness. It is often, but not always, operated as part of the managing service. + +Within this architecture, identities may be shared with the managing service as follows: + + * The contributing service calls the namespace service and creates a new namespace. While the namespace service owns the namespace, the contributing service is responsible for giving it a name that is unique for itself. This name is called a "code". The namespace service is responsible for ensuring that each namespace created has a unique code within the context of the contributing service. For example, the namespace service may use the authentication credentials provided by the contributing service (or other mechanism) to identify the contributing service, and to ensure the code is unique within the set of codes provided by that service. + + * When sending end-user identities to the managing service (for example, when sending data via `ExperienceEvent`), the contributing service includes the namespace code on each identity. + + * When receiving end-user identities, the managing service stores, links, or otherwise uses the provided identities prefixed with the namespace code, ensuring uniqueness. The managing service should verify both that the namespace is valid and that the namespace was created by or owned by the contributing service. + +A namespace code is used in lieu of a UUID or namespace service controlled identifier in order to integrate more easily with existing systems that generate end-user identities. These systems use many different schemes for managing uniqueness within their own domains. Often these codes are human-readable values that designate an account or contract. + +While in the general case namespace codes are owned and managed by the contributing service, a namespace service may allocate its own namespaces with codes that might be used by multiple contributing services to send common identifies. Examples here include email addresses, phone numbers, or push notification tokens. Details on how a namespace service shares these global codes with a contributing service, or prevents them from conflicting with codes generated by contributing services, is not defined by this framework. + +Related: + +Namespaces are similar to datasources, both in the use of codes and in the assumed architecture for their use. The core difference being datasources are used to uniquely identify specific sources of general data in an uncoordinated data environment, such as independent data collection applications. These concepts are distinct because the source of data, and the source of the identities contained in that data, may not be the same. + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/namespace.schema.json](datatypes/namespace.schema.json) | +## Schema Hierarchy + +* Namespace `https://ns.adobe.com/xdm/context/namespace` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Namespace Example +```json +{ + "@id": "https://data.adobe.io/entities/namespace/12345", + "xdm:code": "AA12345" +} +``` + +# Namespace Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:code](#xdmcode) | `string` | Optional | Namespace (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:code +### Code + +The code is a human readable identifier for the namespace and can be used to request the technical namespace id which is used for identity graph processing. + +`xdm:code` +* is optional +* type: `string` +* defined in this schema + +### xdm:code Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/optinout-additional-details.schema.json b/docs/reference/datatypes/optinout-additional-details.schema.json new file mode 100644 index 000000000..e58593228 --- /dev/null +++ b/docs/reference/datatypes/optinout-additional-details.schema.json @@ -0,0 +1,45 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/optinout-additional-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "OptOut Additional Details", + "type": "object", + "description": "Describes user communication preferences by channel. For each channel individually, which is a property of this object, a user's preference such as opt-in, opt-out, or pending can be recorded. In addition, a global override opt-out is possible. Each property of this schema must be a valid and known URI for an XDM Channel.", + "definitions": { + "optinout-additional-details": { + "properties": { + "xdm:optOutReason": { + "title": "Opt Out Reason", + "description": "Reason for opting out for a notification.", + "type": "string" + }, + "xdm:optOutDate": { + "title": "Opt Out Date", + "description": "Date of opting out for a notification.", + "type": "string", + "format": "date-time" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/optinout-additional-details" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/optinout-additional-details.schema.md b/docs/reference/datatypes/optinout-additional-details.schema.md new file mode 100644 index 000000000..d81378882 --- /dev/null +++ b/docs/reference/datatypes/optinout-additional-details.schema.md @@ -0,0 +1,74 @@ + +# OptOut Additional Details Schema + +``` +https://ns.adobe.com/xdm/common/optinout-additional-details +``` + +Describes user communication preferences by channel. For each channel individually, which is a property of this object, a user's preference such as opt-in, opt-out, or pending can be recorded. In addition, a global override opt-out is possible. Each property of this schema must be a valid and known URI for an XDM Channel. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [datatypes/optinout-additional-details.schema.json](datatypes/optinout-additional-details.schema.json) | +## Schema Hierarchy + +* OptOut Additional Details `https://ns.adobe.com/xdm/common/optinout-additional-details` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## OptOut Additional Details Example +```json +{ + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" +} +``` + +# OptOut Additional Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:optOutDate](#xdmoptoutdate) | `string` | Optional | OptOut Additional Details (this schema) | +| [xdm:optOutReason](#xdmoptoutreason) | `string` | Optional | OptOut Additional Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:optOutDate +### Opt Out Date + +Date of opting out for a notification. + +`xdm:optOutDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:optOutDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:optOutReason +### Opt Out Reason + +Reason for opting out for a notification. + +`xdm:optOutReason` +* is optional +* type: `string` +* defined in this schema + +### xdm:optOutReason Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/optinout.schema.json b/docs/reference/datatypes/optinout.schema.json new file mode 100644 index 000000000..ec89df6e4 --- /dev/null +++ b/docs/reference/datatypes/optinout.schema.json @@ -0,0 +1,457 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/optinout", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "OptInOut", + "type": "object", + "description": "Describes user communication preferences by channel. For each channel individually, which is a property of this object, a user's preference such as opt-in, opt-out, or pending can be recorded. In addition, a global override opt-out is possible. Each property of this schema must be a valid and known URI for an XDM Channel.", + "definitions": { + "optinout": { + "properties": { + "https://ns.adobe.com/xdm/channels/adm": { + "title": "Amazon Device Messaging", + "description": "Amazon Device Messaging (ADM) channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/agency": { + "title": "Agency", + "description": "External agency channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/apns": { + "title": "Apple Push Notification Service", + "description": "Apple Push Notification Service (APNS) channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/application": { + "title": "Application", + "description": "Application channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/baidu": { + "title": "Baidu Cloud Push Service", + "description": "Baidu Cloud Push Service channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/channel": { + "title": "Experience Channel", + "description": "Experience channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/direct-mail": { + "title": "Direct mail", + "description": "Mail delivered by a postal service channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/email": { + "title": "Email", + "description": "Email messages, delivered via SMTP to list subscribers channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/facebook-feed": { + "title": "Facebook news feed", + "description": "The Facebook news feed channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/fax": { + "title": "Fax", + "description": "Fax or telefacsimile channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/gcm": { + "title": "Google Cloud Messaging", + "description": "Google Cloud Messaging (GCM) channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/line": { + "title": "Line Platform Notification", + "description": "Line Platform Notification (LINE) channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/mobile-app": { + "title": "Web", + "description": "Native mobile applications that are installed through an app store channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/mpns": { + "title": "Microsoft Push Notification Service", + "description": "Microsoft Push Notification Service (MPNS) channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/phone": { + "title": "Phone", + "description": "The telephone channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/sms": { + "title": "SMS", + "description": "Short Message Service delivered to a mobile phone channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/twitter-feed": { + "title": "Twitter feed", + "description": "Twitter feed channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/web": { + "title": "Web", + "description": "World Wide Web and mobile web channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/webpage": { + "title": "Web Page", + "description": "Web Page channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/wechat": { + "title": "WeChat", + "description": "WeChat Platform Notification channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "https://ns.adobe.com/xdm/channels/wns": { + "title": "Windows Push Notification Service", + "description": "Windows Push Notification Service (WNS) channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." + } + }, + "xdm:globalOptout": { + "title": "Global Opt-out", + "type": "boolean", + "description": "Do not contact this profile on any outbound channel.", + "default": false + }, + "xdm:optOutDetails": { + "properties": { + "xdm:email": { + "title": "Additional Details for Email Opt Out", + "description": "Additional Details for Email Opt Out like reason, date.", + "$ref": "https://ns.adobe.com/xdm/common/optinout-additional-details" + }, + "xdm:phone": { + "title": "Additional Details for Phone Opt Out", + "description": "Additional details for phone opt out like reason, date.", + "$ref": "https://ns.adobe.com/xdm/common/optinout-additional-details" + }, + "xdm:fax": { + "title": "Additional Details for Fax Opt Out", + "description": "Additional details for fax opt out like reason, date.", + "$ref": "https://ns.adobe.com/xdm/common/optinout-additional-details" + }, + "xdm:direct-mail": { + "title": "Additional Details for Direct-Mail Opt Out", + "description": "Additional details for direct-mail opt out like reason, date.", + "$ref": "https://ns.adobe.com/xdm/common/optinout-additional-details" + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/optinout" + } + ], + "meta:status": "stable", + "examples": [ + { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false, + "xdm:optOutDetails": { + "xdm:email": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:phone": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/optinout.schema.md b/docs/reference/datatypes/optinout.schema.md new file mode 100644 index 000000000..c0f47e61b --- /dev/null +++ b/docs/reference/datatypes/optinout.schema.md @@ -0,0 +1,637 @@ + +# OptInOut Schema + +``` +https://ns.adobe.com/xdm/context/optinout +``` + +Describes user communication preferences by channel. For each channel individually, which is a property of this object, a user's preference such as opt-in, opt-out, or pending can be recorded. In addition, a global override opt-out is possible. Each property of this schema must be a valid and known URI for an XDM Channel. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/optinout.schema.json](datatypes/optinout.schema.json) | +## Schema Hierarchy + +* OptInOut `https://ns.adobe.com/xdm/context/optinout` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## OptInOut Example +```json +{ + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false, + "xdm:optOutDetails": { + "xdm:email": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:phone": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + } +} +``` + +# OptInOut Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [https://ns.adobe.com/xdm/channels/adm](#httpsnsadobecomxdmchannelsadm) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/agency](#httpsnsadobecomxdmchannelsagency) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/apns](#httpsnsadobecomxdmchannelsapns) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/application](#httpsnsadobecomxdmchannelsapplication) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/baidu](#httpsnsadobecomxdmchannelsbaidu) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/channel](#httpsnsadobecomxdmchannelschannel) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/direct-mail](#httpsnsadobecomxdmchannelsdirect-mail) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/email](#httpsnsadobecomxdmchannelsemail) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/facebook-feed](#httpsnsadobecomxdmchannelsfacebook-feed) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/fax](#httpsnsadobecomxdmchannelsfax) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/gcm](#httpsnsadobecomxdmchannelsgcm) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/line](#httpsnsadobecomxdmchannelsline) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/mobile-app](#httpsnsadobecomxdmchannelsmobile-app) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/mpns](#httpsnsadobecomxdmchannelsmpns) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/phone](#httpsnsadobecomxdmchannelsphone) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/sms](#httpsnsadobecomxdmchannelssms) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/twitter-feed](#httpsnsadobecomxdmchannelstwitter-feed) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/web](#httpsnsadobecomxdmchannelsweb) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/webpage](#httpsnsadobecomxdmchannelswebpage) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/wechat](#httpsnsadobecomxdmchannelswechat) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [https://ns.adobe.com/xdm/channels/wns](#httpsnsadobecomxdmchannelswns) | `enum` | Optional | `"not_provided"` | OptInOut (this schema) | +| [xdm:globalOptout](#xdmglobaloptout) | `boolean` | Optional | `false` | OptInOut (this schema) | +| [xdm:optOutDetails](#xdmoptoutdetails) | complex | Optional | | OptInOut (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## https://ns.adobe.com/xdm/channels/adm +### Amazon Device Messaging + +Amazon Device Messaging (ADM) channel OptInOut. + +`https://ns.adobe.com/xdm/channels/adm` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsadm-known-values). + +### https://ns.adobe.com/xdm/channels/adm Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/agency +### Agency + +External agency channel OptInOut. + +`https://ns.adobe.com/xdm/channels/agency` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsagency-known-values). + +### https://ns.adobe.com/xdm/channels/agency Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/apns +### Apple Push Notification Service + +Apple Push Notification Service (APNS) channel OptInOut. + +`https://ns.adobe.com/xdm/channels/apns` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsapns-known-values). + +### https://ns.adobe.com/xdm/channels/apns Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/application +### Application + +Application channel OptInOut. + +`https://ns.adobe.com/xdm/channels/application` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsapplication-known-values). + +### https://ns.adobe.com/xdm/channels/application Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/baidu +### Baidu Cloud Push Service + +Baidu Cloud Push Service channel OptInOut. + +`https://ns.adobe.com/xdm/channels/baidu` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsbaidu-known-values). + +### https://ns.adobe.com/xdm/channels/baidu Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/channel +### Experience Channel + +Experience channel OptInOut. + +`https://ns.adobe.com/xdm/channels/channel` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelschannel-known-values). + +### https://ns.adobe.com/xdm/channels/channel Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/direct-mail +### Direct mail + +Mail delivered by a postal service channel OptInOut. + +`https://ns.adobe.com/xdm/channels/direct-mail` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsdirect-mail-known-values). + +### https://ns.adobe.com/xdm/channels/direct-mail Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/email +### Email + +Email messages, delivered via SMTP to list subscribers channel OptInOut. + +`https://ns.adobe.com/xdm/channels/email` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsemail-known-values). + +### https://ns.adobe.com/xdm/channels/email Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/facebook-feed +### Facebook news feed + +The Facebook news feed channel OptInOut. + +`https://ns.adobe.com/xdm/channels/facebook-feed` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsfacebook-feed-known-values). + +### https://ns.adobe.com/xdm/channels/facebook-feed Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/fax +### Fax + +Fax or telefacsimile channel OptInOut. + +`https://ns.adobe.com/xdm/channels/fax` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsfax-known-values). + +### https://ns.adobe.com/xdm/channels/fax Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/gcm +### Google Cloud Messaging + +Google Cloud Messaging (GCM) channel OptInOut. + +`https://ns.adobe.com/xdm/channels/gcm` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsgcm-known-values). + +### https://ns.adobe.com/xdm/channels/gcm Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/line +### Line Platform Notification + +Line Platform Notification (LINE) channel OptInOut. + +`https://ns.adobe.com/xdm/channels/line` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsline-known-values). + +### https://ns.adobe.com/xdm/channels/line Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/mobile-app +### Web + +Native mobile applications that are installed through an app store channel OptInOut. + +`https://ns.adobe.com/xdm/channels/mobile-app` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsmobile-app-known-values). + +### https://ns.adobe.com/xdm/channels/mobile-app Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/mpns +### Microsoft Push Notification Service + +Microsoft Push Notification Service (MPNS) channel OptInOut. + +`https://ns.adobe.com/xdm/channels/mpns` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsmpns-known-values). + +### https://ns.adobe.com/xdm/channels/mpns Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/phone +### Phone + +The telephone channel OptInOut. + +`https://ns.adobe.com/xdm/channels/phone` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsphone-known-values). + +### https://ns.adobe.com/xdm/channels/phone Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/sms +### SMS + +Short Message Service delivered to a mobile phone channel OptInOut. + +`https://ns.adobe.com/xdm/channels/sms` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelssms-known-values). + +### https://ns.adobe.com/xdm/channels/sms Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/twitter-feed +### Twitter feed + +Twitter feed channel OptInOut. + +`https://ns.adobe.com/xdm/channels/twitter-feed` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelstwitter-feed-known-values). + +### https://ns.adobe.com/xdm/channels/twitter-feed Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/web +### Web + +World Wide Web and mobile web channel OptInOut. + +`https://ns.adobe.com/xdm/channels/web` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelsweb-known-values). + +### https://ns.adobe.com/xdm/channels/web Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/webpage +### Web Page + +Web Page channel OptInOut. + +`https://ns.adobe.com/xdm/channels/webpage` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelswebpage-known-values). + +### https://ns.adobe.com/xdm/channels/webpage Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/wechat +### WeChat + +WeChat Platform Notification channel OptInOut. + +`https://ns.adobe.com/xdm/channels/wechat` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelswechat-known-values). + +### https://ns.adobe.com/xdm/channels/wechat Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## https://ns.adobe.com/xdm/channels/wns +### Windows Push Notification Service + +Windows Push Notification Service (WNS) channel OptInOut. + +`https://ns.adobe.com/xdm/channels/wns` +* is optional +* type: `enum` +* default: `"not_provided"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#httpsnsadobecomxdmchannelswns-known-values). + +### https://ns.adobe.com/xdm/channels/wns Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in: the user explicitly consents to receiving messages. | +| `out` | Opt-out: the user declines to receive any messages on this channel. | + + + + +## xdm:globalOptout +### Global Opt-out + +Do not contact this profile on any outbound channel. + +`xdm:globalOptout` +* is optional +* type: `boolean` +* default: `false` +* defined in this schema + +### xdm:globalOptout Type + + +`boolean` + + + + + +## xdm:optOutDetails + + +`xdm:optOutDetails` +* is optional +* type: complex +* defined in this schema + +### xdm:optOutDetails Type + +Unknown type ``. + +```json +{ + "properties": { + "xdm:email": { + "title": "Additional Details for Email Opt Out", + "description": "Additional Details for Email Opt Out like reason, date.", + "$ref": "https://ns.adobe.com/xdm/common/optinout-additional-details" + }, + "xdm:phone": { + "title": "Additional Details for Phone Opt Out", + "description": "Additional details for phone opt out like reason, date.", + "$ref": "https://ns.adobe.com/xdm/common/optinout-additional-details" + }, + "xdm:fax": { + "title": "Additional Details for Fax Opt Out", + "description": "Additional details for fax opt out like reason, date.", + "$ref": "https://ns.adobe.com/xdm/common/optinout-additional-details" + }, + "xdm:direct-mail": { + "title": "Additional Details for Direct-Mail Opt Out", + "description": "Additional details for direct-mail opt out like reason, date.", + "$ref": "https://ns.adobe.com/xdm/common/optinout-additional-details" + } + }, + "simpletype": "complex" +} +``` + + + + diff --git a/docs/reference/datatypes/organization.schema.json b/docs/reference/datatypes/organization.schema.json new file mode 100644 index 000000000..b98ccd1a2 --- /dev/null +++ b/docs/reference/datatypes/organization.schema.json @@ -0,0 +1,172 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/organization", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Organization", + "type": "object", + "description": "Information that uniquely identifies an organized entity such as company, non-profit, government agency or educational institution, plus additional information that further qualifies the organization.\n", + "definitions": { + "organization": { + "properties": { + "@id": { + "title": "Organization ID", + "type": "string", + "format": "uri-reference", + "description": "A unique identifier for the organization." + }, + "xdm:legalName": { + "title": "Organization legal name", + "type": "string", + "description": "The official or legal name of the organization." + }, + "schema:description": { + "title": "Organization description", + "type": "string", + "description": "A description of the organization." + }, + "schema:numberOfEmployees": { + "title": "Number of employees", + "type": "number", + "description": "The number of employees the at the organization." + }, + "xdm:annualRevenue": { + "title": "Annual Revenue", + "description": "Estimated amount of annual revenue of the organization.", + "type": "number" + }, + "xdm:industry": { + "title": "Industry", + "type": "string", + "description": "The industry that this organization is a part of. This is a free-form field, and it is advisable to use a structured value for queries or to use the `xdm:classifier` property." + }, + "xdm:website": { + "title": "Website URL", + "type": "string", + "format": "uri", + "description": "The URL of the organization's website." + }, + "xdm:marketSegment": { + "title": "Market segment", + "type": "string", + "description": "The named market segment that the organization participates in. This is a free-form field, and it is advisable to use a structured value for queries or to use the `xdm:identifier` property." + }, + "xdm:location": { + "title": "Location", + "$ref": "https://ns.adobe.com/xdm/context/place", + "description": "The location of the organization's main office or headquarters." + }, + "xdm:rating": { + "title": "Rating", + "type": "number", + "minimum": 0, + "maximum": 1, + "description": "The calculated score or star rating for this organization. `1` indicates the maximum possible rating, `0` the minimum possible rating." + }, + "xdm:identifier": { + "title": "Organization identifier", + "type": "object", + "meta:keys": { + "https://ns.adobe.com/xdm/external/dnb": "Dun & Bradstreet", + "https://ns.adobe.com/xdm/external/angellist": "Angellist" + }, + "properties": { + "://": { + "type": "string" + } + }, + "patternProperties": { + ".+://.+": { + "type": "string", + "description": "ID of the organization according to the service." + } + }, + "examples": [ + { + "https://ns.adobe.com/xdm/external/dnb": "1234", + "https://ns.adobe.com/xdm/external/angellist": "https://angel.co/adobe" + } + ], + "description": "This object contains unambiguous identifiers for the organization. Each key is the URI of an identification service, each value is the unique ID or preferably URI of the organization as defined by the identification service." + }, + "xdm:classifier": { + "title": "Market or industry classifier", + "type": "object", + "meta:keys": { + "https://ns.adobe.com/xdm/external/isic4": "International Standard of Industrial Classification of All Economic Activities (ISIC)", + "https://ns.adobe.com/xdm/external/sic": "Standard Industrial Classification", + "https://ns.adobe.com/xdm/external/naics": "North American Industry Classification System" + }, + "properties": { + "://": { + "type": "string" + } + }, + "patternProperties": { + ".+://.+": { + "type": "string", + "description": "ID of the market or industry according to the service." + } + }, + "examples": [ + { + "https://ns.adobe.com/xdm/external/sic": "1234", + "https://ns.adobe.com/xdm/external/naics": "1234" + } + ], + "description": "This object contains unambiguous classifiers for the organization. Each key is the URI of an classification service or standard, each value is the unique ID or preferably URI of the organization as defined by the classification service." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/organization" + } + ], + "meta:status": "experimental", + "examples": [ + { + "@id": "https://data.adobe.io/entities/org/orgid111", + "xdm:legalName": "ABC Stores", + "xdm:numberOfEmployees": 200, + "xdm:annualRevenue": 1000000, + "xdm:industry": "Retail", + "xdm:website": "http://www.abcstores.com", + "rating": 1, + "xdm:marketSegment": "apparel for kids", + "xdm:location": { + "@id": "https://data.adobe.io/entities/places/locid123", + "schema:description": "ABC Store location", + "xdm:address": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": true, + "xdm:type": "work", + "xdm:street1": "100 Lincoln Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95125", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-03" + }, + "schema:telephone": "1-408-800-0000", + "xdm:identifier": { + "https://ns.adobe.com/xdm/external/dnb": "1234", + "https://ns.adobe.com/xdm/external/angellist": "https://angel.co/adobe" + }, + "xdm:classifier": { + "https://ns.adobe.com/xdm/external/sic": "1234", + "https://ns.adobe.com/xdm/external/naics": "1234" + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/organization.schema.md b/docs/reference/datatypes/organization.schema.md new file mode 100644 index 000000000..37453433a --- /dev/null +++ b/docs/reference/datatypes/organization.schema.md @@ -0,0 +1,388 @@ + +# Organization Schema + +``` +https://ns.adobe.com/xdm/common/organization +``` + +Information that uniquely identifies an organized entity such as company, non-profit, government agency or educational institution, plus additional information that further qualifies the organization. + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [datatypes/organization.schema.json](datatypes/organization.schema.json) | +## Schema Hierarchy + +* Organization `https://ns.adobe.com/xdm/common/organization` + * [Physical place](place.schema.md) `https://ns.adobe.com/xdm/context/place` + + +## Organization Example +```json +{ + "@id": "https://data.adobe.io/entities/org/orgid111", + "xdm:legalName": "ABC Stores", + "xdm:numberOfEmployees": 200, + "xdm:annualRevenue": 1000000, + "xdm:industry": "Retail", + "xdm:website": "http://www.abcstores.com", + "rating": 1, + "xdm:marketSegment": "apparel for kids", + "xdm:location": { + "@id": "https://data.adobe.io/entities/places/locid123", + "schema:description": "ABC Store location", + "xdm:address": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": true, + "xdm:type": "work", + "xdm:street1": "100 Lincoln Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95125", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-03" + }, + "schema:telephone": "1-408-800-0000", + "xdm:identifier": { + "https://ns.adobe.com/xdm/external/dnb": "1234", + "https://ns.adobe.com/xdm/external/angellist": "https://angel.co/adobe" + }, + "xdm:classifier": { + "https://ns.adobe.com/xdm/external/sic": "1234", + "https://ns.adobe.com/xdm/external/naics": "1234" + } + } +} +``` + +# Organization Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Organization (this schema) | +| [schema:description](#schemadescription) | `string` | Optional | Organization (this schema) | +| [schema:numberOfEmployees](#schemanumberofemployees) | `number` | Optional | Organization (this schema) | +| [xdm:annualRevenue](#xdmannualrevenue) | `number` | Optional | Organization (this schema) | +| [xdm:classifier](#xdmclassifier) | `object` | Optional | Organization (this schema) | +| [xdm:identifier](#xdmidentifier) | `object` | Optional | Organization (this schema) | +| [xdm:industry](#xdmindustry) | `string` | Optional | Organization (this schema) | +| [xdm:legalName](#xdmlegalname) | `string` | Optional | Organization (this schema) | +| [xdm:location](#xdmlocation) | Physical place | Optional | Organization (this schema) | +| [xdm:marketSegment](#xdmmarketsegment) | `string` | Optional | Organization (this schema) | +| [xdm:rating](#xdmrating) | `number` | Optional | Organization (this schema) | +| [xdm:website](#xdmwebsite) | `string` | Optional | Organization (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Organization ID + +A unique identifier for the organization. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:description +### Organization description + +A description of the organization. + +`schema:description` +* is optional +* type: `string` +* defined in this schema + +### schema:description Type + + +`string` + + + + + + +## schema:numberOfEmployees +### Number of employees + +The number of employees the at the organization. + +`schema:numberOfEmployees` +* is optional +* type: `number` +* defined in this schema + +### schema:numberOfEmployees Type + + +`number` + + + + + + +## xdm:annualRevenue +### Annual Revenue + +Estimated amount of annual revenue of the organization. + +`xdm:annualRevenue` +* is optional +* type: `number` +* defined in this schema + +### xdm:annualRevenue Type + + +`number` + + + + + + +## xdm:classifier +### Market or industry classifier + +This object contains unambiguous classifiers for the organization. Each key is the URI of an classification service or standard, each value is the unique ID or preferably URI of the organization as defined by the classification service. + +`xdm:classifier` +* is optional +* type: `object` +* defined in this schema + +### xdm:classifier Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `://`| string | Optional | + + + +#### :// + +undefined + +`://` +* is optional +* type: `string` + +##### :// Type + + +`string` + + + + + + + + + + +### xdm:classifier Example + +```json +{ + "https://ns.adobe.com/xdm/external/sic": "1234", + "https://ns.adobe.com/xdm/external/naics": "1234" +} +``` + + +## xdm:identifier +### Organization identifier + +This object contains unambiguous identifiers for the organization. Each key is the URI of an identification service, each value is the unique ID or preferably URI of the organization as defined by the identification service. + +`xdm:identifier` +* is optional +* type: `object` +* defined in this schema + +### xdm:identifier Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `://`| string | Optional | + + + +#### :// + +undefined + +`://` +* is optional +* type: `string` + +##### :// Type + + +`string` + + + + + + + + + + +### xdm:identifier Example + +```json +{ + "https://ns.adobe.com/xdm/external/dnb": "1234", + "https://ns.adobe.com/xdm/external/angellist": "https://angel.co/adobe" +} +``` + + +## xdm:industry +### Industry + +The industry that this organization is a part of. This is a free-form field, and it is advisable to use a structured value for queries or to use the `xdm:classifier` property. + +`xdm:industry` +* is optional +* type: `string` +* defined in this schema + +### xdm:industry Type + + +`string` + + + + + + +## xdm:legalName +### Organization legal name + +The official or legal name of the organization. + +`xdm:legalName` +* is optional +* type: `string` +* defined in this schema + +### xdm:legalName Type + + +`string` + + + + + + +## xdm:location +### Location + +The location of the organization's main office or headquarters. + +`xdm:location` +* is optional +* type: Physical place +* defined in this schema + +### xdm:location Type + + +* [Physical place](place.schema.md) – `https://ns.adobe.com/xdm/context/place` + + + + + +## xdm:marketSegment +### Market segment + +The named market segment that the organization participates in. This is a free-form field, and it is advisable to use a structured value for queries or to use the `xdm:identifier` property. + +`xdm:marketSegment` +* is optional +* type: `string` +* defined in this schema + +### xdm:marketSegment Type + + +`string` + + + + + + +## xdm:rating +### Rating + +The calculated score or star rating for this organization. `1` indicates the maximum possible rating, `0` the minimum possible rating. + +`xdm:rating` +* is optional +* type: `number` +* defined in this schema + +### xdm:rating Type + + +`number` +* minimum value: `0` +* maximum value: `1` + + + + + +## xdm:website +### Website URL + +The URL of the organization's website. + +`xdm:website` +* is optional +* type: `string` +* defined in this schema + +### xdm:website Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + diff --git a/docs/reference/datatypes/orgunit.schema.json b/docs/reference/datatypes/orgunit.schema.json new file mode 100644 index 000000000..6c74c4c6c --- /dev/null +++ b/docs/reference/datatypes/orgunit.schema.json @@ -0,0 +1,46 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/orgunit", + "$schema": "http://json-schema.org/draft-06/schema#", + "type": "object", + "meta:extensible": true, + "title": "Organizational unit", + "description": "The organizational unit of a parent organization.", + "definitions": { + "orgunit": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "The ID associated with this organizational unit." + }, + "xdm:label": { + "title": "Label of the organizational unit.", + "type": "string", + "description": "The user-friendly name for the organizational unit." + } + }, + "required": [ + "@id" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/orgunit" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/org-apparals-men", + "xdm:label": "Men Apparals" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/orgunit.schema.md b/docs/reference/datatypes/orgunit.schema.md new file mode 100644 index 000000000..09b29c7ae --- /dev/null +++ b/docs/reference/datatypes/orgunit.schema.md @@ -0,0 +1,69 @@ + +# Organizational unit Schema + +``` +https://ns.adobe.com/xdm/common/orgunit +``` + +The organizational unit of a parent organization. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/orgunit.schema.json](datatypes/orgunit.schema.json) | + +## Organizational unit Example +```json +{ + "@id": "https://data.adobe.io/org-apparals-men", + "xdm:label": "Men Apparals" +} +``` + +# Organizational unit Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Organizational unit (this schema) | +| [xdm:label](#xdmlabel) | `string` | Optional | Organizational unit (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The ID associated with this organizational unit. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:label +### Label of the organizational unit. + +The user-friendly name for the organizational unit. + +`xdm:label` +* is optional +* type: `string` +* defined in this schema + +### xdm:label Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/page.schema.json b/docs/reference/datatypes/page.schema.json new file mode 100644 index 000000000..1c8e8176d --- /dev/null +++ b/docs/reference/datatypes/page.schema.json @@ -0,0 +1,77 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/page", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Page", + "type": "object", + "description": "Page information for paginated resource list operations.\n", + "definitions": { + "page": { + "properties": { + "orderBy": { + "title": "Order by Property", + "type": "string", + "description": "The `orderBy` parameter specifies the comma-separated (no spaces after comma) list of properties by which the resource should be sorted. The properties by which to sort are listed in priority order. The first property is used for primary sorting, the second property to resolve ties in primary sorting, etc. The name of a property may be prefixed with a `+` to indicate ascending ordering or `-` to indicate descending ordering by that property. If the property name is not prefixed the result is sorted in ascending order. If `orderBy` is not given or does not name a property supported to sort by, the order is indeterminate and the service may return the elements in any order." + }, + "start": { + "title": "First Value", + "type": "string", + "description": "The first value, in sorted order, of the `orderby` property on this page." + }, + "next": { + "title": "Next Page Start Value", + "type": "string", + "description": "The start value for the next page." + }, + "property": { + "title": "Filter Properties", + "type": "string", + "description": "The list of properties by which the result is filtered, if any.\nThis list is comma-separated (no spaces after comma). The resulting list will only include entries for which the filtered property has been defined. " + }, + "type": { + "title": "Filter Type Value", + "type": "string", + "description": "The applied type filtering value, if any. Unlike `property` which allows to filter for presence of any property, `type` filters only for the specific value of the `type` attribute, i.e. the media type. This is a literal filter without any globbing or pattern matching." + }, + "count": { + "title": "Number of Items", + "type": "integer", + "minimum": 0, + "description": "The number of items on this page." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/page" + } + ], + "required": [ + "orderBy", + "start", + "next", + "count" + ], + "meta:status": "stable", + "examples": [ + { + "orderBy": "id", + "start": "123", + "next": "789", + "type": "image/jpeg", + "count": 100 + }, + { + "orderBy": "id", + "start": "123", + "next": "789", + "count": 100 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/page.schema.md b/docs/reference/datatypes/page.schema.md new file mode 100644 index 000000000..53f398dd2 --- /dev/null +++ b/docs/reference/datatypes/page.schema.md @@ -0,0 +1,169 @@ + +# Page Schema + +``` +https://ns.adobe.com/xdm/common/page +``` + +Page information for paginated resource list operations. + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/page.schema.json](datatypes/page.schema.json) | + +## Page Examples + +```json +{ + "orderBy": "id", + "start": "123", + "next": "789", + "type": "image/jpeg", + "count": 100 +} +``` + +```json +{ + "orderBy": "id", + "start": "123", + "next": "789", + "count": 100 +} +``` + + +# Page Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [count](#count) | `integer` | **Required** | Page (this schema) | +| [next](#next) | `string` | **Required** | Page (this schema) | +| [orderBy](#orderby) | `string` | **Required** | Page (this schema) | +| [property](#property) | `string` | Optional | Page (this schema) | +| [start](#start) | `string` | **Required** | Page (this schema) | +| [type](#type) | `string` | Optional | Page (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## count +### Number of Items + +The number of items on this page. + +`count` +* is **required** +* type: `integer` +* defined in this schema + +### count Type + + +`integer` +* minimum value: `0` + + + + + + +## next +### Next Page Start Value + +The start value for the next page. + +`next` +* is **required** +* type: `string` +* defined in this schema + +### next Type + + +`string` + + + + + + +## orderBy +### Order by Property + +The `orderBy` parameter specifies the comma-separated (no spaces after comma) list of properties by which the resource should be sorted. The properties by which to sort are listed in priority order. The first property is used for primary sorting, the second property to resolve ties in primary sorting, etc. The name of a property may be prefixed with a `+` to indicate ascending ordering or `-` to indicate descending ordering by that property. If the property name is not prefixed the result is sorted in ascending order. If `orderBy` is not given or does not name a property supported to sort by, the order is indeterminate and the service may return the elements in any order. + +`orderBy` +* is **required** +* type: `string` +* defined in this schema + +### orderBy Type + + +`string` + + + + + + +## property +### Filter Properties + +The list of properties by which the result is filtered, if any. +This list is comma-separated (no spaces after comma). The resulting list will only include entries for which the filtered property has been defined. + +`property` +* is optional +* type: `string` +* defined in this schema + +### property Type + + +`string` + + + + + + +## start +### First Value + +The first value, in sorted order, of the `orderby` property on this page. + +`start` +* is **required** +* type: `string` +* defined in this schema + +### start Type + + +`string` + + + + + + +## type +### Filter Type Value + +The applied type filtering value, if any. Unlike `property` which allows to filter for presence of any property, `type` filters only for the specific value of the `type` attribute, i.e. the media type. This is a literal filter without any globbing or pattern matching. + +`type` +* is optional +* type: `string` +* defined in this schema + +### type Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/person-name.schema.json b/docs/reference/datatypes/person-name.schema.json new file mode 100644 index 000000000..00b3134c1 --- /dev/null +++ b/docs/reference/datatypes/person-name.schema.json @@ -0,0 +1,77 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/person-name", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Person name", + "type": "object", + "meta:extensible": true, + "description": "The Person Name schema is used to model the full name of a person.\nAs the conventions for structing names differ widely across languages and cultures, names should always be modeled using the `xdm:fullName` property.\nIn addition, a number of optional properties are made available that can be used in situations that require using only a fragment of the full name, such as creating a formal or informal greeting.\n", + "definitions": { + "personname": { + "properties": { + "xdm:firstName": { + "title": "First name", + "type": "string", + "description": "The first segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the preferred personal or given name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable." + }, + "xdm:lastName": { + "title": "Last name", + "type": "string", + "description": "The last segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the inherited family name, surname, patronymic, or matronymic name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable." + }, + "xdm:middleName": { + "title": "Middle name", + "type": "string", + "description": "Middle, alternative, or additional names supplied between the first name and last name." + }, + "xdm:courtesyTitle": { + "title": "Courtesy title", + "type": "string", + "description": "Normally an abbreviation of a persons title, honorific, or salutation. The `courtesyTitle` is used in front of full or last name in opening texts. For example, Mr. Miss. or Dr." + }, + "xdm:suffix": { + "title": "Suffix", + "type": "string", + "description": "A group of letters provided after a person's name to provide additional information. The `suffix` is used at the end of someones name. For example Jr., Sr., M.D., PhD, I, II, III, etc." + }, + "xdm:fullName": { + "title": "Full name", + "type": "string", + "description": "The full name of the person, in writing order most commonly accepted in the language of the name." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/personname" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:firstName": "فلانة", + "xdm:lastName": "الفلانية", + "xdm:fullName": "فلانة الفلانية" + }, + { + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" + }, + { + "xdm:firstName": "张", + "xdm:lastName": "三", + "xdm:fullName": "张三" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/person-name.schema.md b/docs/reference/datatypes/person-name.schema.md new file mode 100644 index 000000000..966eb8e68 --- /dev/null +++ b/docs/reference/datatypes/person-name.schema.md @@ -0,0 +1,180 @@ + +# Person name Schema + +``` +https://ns.adobe.com/xdm/context/person-name +``` + +The Person Name schema is used to model the full name of a person. +As the conventions for structing names differ widely across languages and cultures, names should always be modeled using the `xdm:fullName` property. +In addition, a number of optional properties are made available that can be used in situations that require using only a fragment of the full name, such as creating a formal or informal greeting. + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/person-name.schema.json](datatypes/person-name.schema.json) | +## Schema Hierarchy + +* Person name `https://ns.adobe.com/xdm/context/person-name` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Person name Examples + +```json +{ + "xdm:firstName": "فلانة", + "xdm:lastName": "الفلانية", + "xdm:fullName": "فلانة الفلانية" +} +``` + +```json +{ + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" +} +``` + +```json +{ + "xdm:firstName": "张", + "xdm:lastName": "三", + "xdm:fullName": "张三" +} +``` + + +# Person name Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:courtesyTitle](#xdmcourtesytitle) | `string` | Optional | Person name (this schema) | +| [xdm:firstName](#xdmfirstname) | `string` | Optional | Person name (this schema) | +| [xdm:fullName](#xdmfullname) | `string` | Optional | Person name (this schema) | +| [xdm:lastName](#xdmlastname) | `string` | Optional | Person name (this schema) | +| [xdm:middleName](#xdmmiddlename) | `string` | Optional | Person name (this schema) | +| [xdm:suffix](#xdmsuffix) | `string` | Optional | Person name (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:courtesyTitle +### Courtesy title + +Normally an abbreviation of a persons title, honorific, or salutation. The `courtesyTitle` is used in front of full or last name in opening texts. For example, Mr. Miss. or Dr. + +`xdm:courtesyTitle` +* is optional +* type: `string` +* defined in this schema + +### xdm:courtesyTitle Type + + +`string` + + + + + + +## xdm:firstName +### First name + +The first segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the preferred personal or given name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable. + +`xdm:firstName` +* is optional +* type: `string` +* defined in this schema + +### xdm:firstName Type + + +`string` + + + + + + +## xdm:fullName +### Full name + +The full name of the person, in writing order most commonly accepted in the language of the name. + +`xdm:fullName` +* is optional +* type: `string` +* defined in this schema + +### xdm:fullName Type + + +`string` + + + + + + +## xdm:lastName +### Last name + +The last segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the inherited family name, surname, patronymic, or matronymic name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable. + +`xdm:lastName` +* is optional +* type: `string` +* defined in this schema + +### xdm:lastName Type + + +`string` + + + + + + +## xdm:middleName +### Middle name + +Middle, alternative, or additional names supplied between the first name and last name. + +`xdm:middleName` +* is optional +* type: `string` +* defined in this schema + +### xdm:middleName Type + + +`string` + + + + + + +## xdm:suffix +### Suffix + +A group of letters provided after a person's name to provide additional information. The `suffix` is used at the end of someones name. For example Jr., Sr., M.D., PhD, I, II, III, etc. + +`xdm:suffix` +* is optional +* type: `string` +* defined in this schema + +### xdm:suffix Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/person.schema.json b/docs/reference/datatypes/person.schema.json new file mode 100644 index 000000000..67dcb4600 --- /dev/null +++ b/docs/reference/datatypes/person.schema.json @@ -0,0 +1,117 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/person", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Person", + "type": "object", + "meta:extensible": true, + "meta:auditable": true, + "description": "An individual person. May represent a person acting in various roles, such as a customer, contact, or owner.", + "definitions": { + "person": { + "properties": { + "xdm:name": { + "title": "Full name", + "$ref": "https://ns.adobe.com/xdm/context/person-name", + "description": "The person's full name." + }, + "xdm:birthDate": { + "title": "Birth date", + "type": "string", + "format": "date", + "description": "The full date a person was born." + }, + "xdm:birthDayAndMonth": { + "title": "Birth date", + "type": "string", + "pattern": "[0-1][0-9]-[0-9][0-9]", + "description": "The day and month a person was born, in the format MM-DD. This field should be used when the day and month of a person's birth is known, but not the year." + }, + "xdm:birthYear": { + "title": "Birth year", + "type": "integer", + "description": "The year a person was born including the century, for example, 1983. This field should be used when only the person's age is known, not the full birth date.", + "minimum": 1, + "maximum": 32767 + }, + "xdm:gender": { + "title": "Gender", + "type": "string", + "enum": [ + "male", + "female", + "not_specified", + "non_specific" + ], + "meta:enum": { + "male": "Male", + "female": "Female", + "not_specified": "Not Specified", + "non_specific": "Non-specific" + }, + "description": "Gender identity of the person.\n", + "default": "not_specified" + }, + "xdm:maritalStatus": { + "title": "Marital Status", + "type": "string", + "enum": [ + "married", + "single", + "divorced", + "widowed", + "not_specified" + ], + "meta:enum": { + "married": "Married", + "single": "Single", + "divorced": "Divorced", + "widowed": "Widowed", + "not_specified": "Not Specified" + }, + "description": "Describes a person's relationship with a significant other.", + "default": "not_specified" + }, + "xdm:nationality": { + "title": "Nationality", + "type": "string", + "pattern": "^[A-Z]{2}$", + "description": "The legal relationship between a person and their state represented using the ISO 3166-1 Alpha-2 code." + }, + "xdm:taxId": { + "title": "Tax ID", + "type": "string", + "description": "The Tax / Fiscal ID of the person, e.g. the TIN in the US or the CIF/NIF in Spain." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/person" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDate": "1996-01-19", + "xdm:gender": "female", + "xdm:maritalStatus": "single", + "xdm:nationality": "CA" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/person.schema.md b/docs/reference/datatypes/person.schema.md new file mode 100644 index 000000000..9121bc018 --- /dev/null +++ b/docs/reference/datatypes/person.schema.md @@ -0,0 +1,233 @@ + +# Person Schema + +``` +https://ns.adobe.com/xdm/context/person +``` + +An individual person. May represent a person acting in various roles, such as a customer, contact, or owner. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/person.schema.json](datatypes/person.schema.json) | +## Schema Hierarchy + +* Person `https://ns.adobe.com/xdm/context/person` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Person name](person-name.schema.md) `https://ns.adobe.com/xdm/context/person-name` + + +## Person Example +```json +{ + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDate": "1996-01-19", + "xdm:gender": "female", + "xdm:maritalStatus": "single", + "xdm:nationality": "CA" +} +``` + +# Person Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:birthDate](#xdmbirthdate) | `string` | Optional | | Person (this schema) | +| [xdm:birthDayAndMonth](#xdmbirthdayandmonth) | `string` | Optional | | Person (this schema) | +| [xdm:birthYear](#xdmbirthyear) | `integer` | Optional | | Person (this schema) | +| [xdm:gender](#xdmgender) | `enum` | Optional | `"not_specified"` | Person (this schema) | +| [xdm:maritalStatus](#xdmmaritalstatus) | `enum` | Optional | `"not_specified"` | Person (this schema) | +| [xdm:name](#xdmname) | Person name | Optional | | Person (this schema) | +| [xdm:nationality](#xdmnationality) | `string` | Optional | | Person (this schema) | +| [xdm:taxId](#xdmtaxid) | `string` | Optional | | Person (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:birthDate +### Birth date + +The full date a person was born. + +`xdm:birthDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:birthDate Type + + +`string` +* format: `date` – date, without time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:birthDayAndMonth +### Birth date + +The day and month a person was born, in the format MM-DD. This field should be used when the day and month of a person's birth is known, but not the year. + +`xdm:birthDayAndMonth` +* is optional +* type: `string` +* defined in this schema + +### xdm:birthDayAndMonth Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5B0-1%5D%5B0-9%5D-%5B0-9%5D%5B0-9%5D)): +```regex +[0-1][0-9]-[0-9][0-9] +``` + + + + + + +## xdm:birthYear +### Birth year + +The year a person was born including the century, for example, 1983. This field should be used when only the person's age is known, not the full birth date. + +`xdm:birthYear` +* is optional +* type: `integer` +* defined in this schema + +### xdm:birthYear Type + + +`integer` +* minimum value: `1` +* maximum value: `32767` + + + + + +## xdm:gender +### Gender + +Gender identity of the person. + + +`xdm:gender` +* is optional +* type: `enum` +* default: `"not_specified"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmgender-known-values). + +### xdm:gender Known Values +| Value | Description | +|-------|-------------| +| `male` | Male | +| `female` | Female | +| `not_specified` | Not Specified | +| `non_specific` | Non-specific | + + + + +## xdm:maritalStatus +### Marital Status + +Describes a person's relationship with a significant other. + +`xdm:maritalStatus` +* is optional +* type: `enum` +* default: `"not_specified"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmmaritalstatus-known-values). + +### xdm:maritalStatus Known Values +| Value | Description | +|-------|-------------| +| `married` | Married | +| `single` | Single | +| `divorced` | Divorced | +| `widowed` | Widowed | +| `not_specified` | Not Specified | + + + + +## xdm:name +### Full name + +The person's full name. + +`xdm:name` +* is optional +* type: Person name +* defined in this schema + +### xdm:name Type + + +* [Person name](person-name.schema.md) – `https://ns.adobe.com/xdm/context/person-name` + + + + + +## xdm:nationality +### Nationality + +The legal relationship between a person and their state represented using the ISO 3166-1 Alpha-2 code. + +`xdm:nationality` +* is optional +* type: `string` +* defined in this schema + +### xdm:nationality Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E%5BA-Z%5D%7B2%7D%24)): +```regex +^[A-Z]{2}$ +``` + + + + + + +## xdm:taxId +### Tax ID + +The Tax / Fiscal ID of the person, e.g. the TIN in the US or the CIF/NIF in Spain. + +`xdm:taxId` +* is optional +* type: `string` +* defined in this schema + +### xdm:taxId Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/phone-interaction.schema.json b/docs/reference/datatypes/phone-interaction.schema.json new file mode 100644 index 000000000..54dbc2b2d --- /dev/null +++ b/docs/reference/datatypes/phone-interaction.schema.json @@ -0,0 +1,92 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/phoneinteraction", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Phone Interaction", + "type": "object", + "meta:extensible": true, + "description": "Captures information in the context of a phone call conversation ", + "definitions": { + "phoneinteraction": { + "properties": { + "xdm:ID": { + "title": "ID of the call conversation", + "type": "string", + "description": "A unique identifier to represent the phone call conversation" + }, + "xdm:fromWhoID": { + "title": "Initiator of the call", + "type": "string", + "description": "Person ID who initiated the call of the conversation" + }, + "xdm:toWhoID": { + "title": "Call reciever", + "type": "string", + "description": "Person ID who recieved the call" + }, + "xdm:disposition": { + "title": "Label the outcome of the phone call", + "type": "string", + "description": "The outcome of the call as next triggering actions such as 'demo scheduled','left voicemail', etc." + }, + "xdm:duration": { + "title": "Time Spent during the call", + "type": "number", + "description": "Record the length of the phone conversation in seconds" + }, + "xdm:type": { + "title": "Type of the phone call", + "type": "string", + "description": "A way to represent the nature of the call", + "meta:enum": { + "internal": "Internal", + "inbound": "Inbound", + "outbound": "Outbound" + } + }, + "xdm:fromNumber": { + "title": "Phone Number of the initiator of the call", + "type": "string", + "description": "Person's phone number who initiated the conversation. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234." + }, + "xdm:toNumber": { + "title": "Phone number of the call reciever", + "type": "string", + "description": "Person's phone number who is the reciever of the call. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234." + }, + "xdm:hasLeftVoiceMail": { + "title": "Has the initiator of the call left any Voice Mail message", + "type": "boolean", + "description": "A boolean flag to represent whether a voice mail has been left for the reciever" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/phoneinteraction" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:ID": "7263723", + "xdm:fromWhoID": "4587", + "xdm:toWhoID": "3785", + "xdm:disposition": "Setup a meeting for next week to pursue opportunity", + "xdm:duration": 387, + "xdm:type": "Inbound", + "xdm:fromNumber": "408-536-4985", + "xdm:toNumber": "650-497-0986", + "xdm:hasLeftVoiceMail": false + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/phone-interaction.schema.md b/docs/reference/datatypes/phone-interaction.schema.md new file mode 100644 index 000000000..e3df78b4a --- /dev/null +++ b/docs/reference/datatypes/phone-interaction.schema.md @@ -0,0 +1,233 @@ + +# Phone Interaction Schema + +``` +https://ns.adobe.com/xdm/common/phoneinteraction +``` + +Captures information in the context of a phone call conversation + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [datatypes/phone-interaction.schema.json](datatypes/phone-interaction.schema.json) | +## Schema Hierarchy + +* Phone Interaction `https://ns.adobe.com/xdm/common/phoneinteraction` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Phone Interaction Example +```json +{ + "xdm:ID": "7263723", + "xdm:fromWhoID": "4587", + "xdm:toWhoID": "3785", + "xdm:disposition": "Setup a meeting for next week to pursue opportunity", + "xdm:duration": 387, + "xdm:type": "Inbound", + "xdm:fromNumber": "408-536-4985", + "xdm:toNumber": "650-497-0986", + "xdm:hasLeftVoiceMail": false +} +``` + +# Phone Interaction Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:ID](#xdmid) | `string` | Optional | Phone Interaction (this schema) | +| [xdm:disposition](#xdmdisposition) | `string` | Optional | Phone Interaction (this schema) | +| [xdm:duration](#xdmduration) | `number` | Optional | Phone Interaction (this schema) | +| [xdm:fromNumber](#xdmfromnumber) | `string` | Optional | Phone Interaction (this schema) | +| [xdm:fromWhoID](#xdmfromwhoid) | `string` | Optional | Phone Interaction (this schema) | +| [xdm:hasLeftVoiceMail](#xdmhasleftvoicemail) | `boolean` | Optional | Phone Interaction (this schema) | +| [xdm:toNumber](#xdmtonumber) | `string` | Optional | Phone Interaction (this schema) | +| [xdm:toWhoID](#xdmtowhoid) | `string` | Optional | Phone Interaction (this schema) | +| [xdm:type](#xdmtype) | `string` | Optional | Phone Interaction (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:ID +### ID of the call conversation + +A unique identifier to represent the phone call conversation + +`xdm:ID` +* is optional +* type: `string` +* defined in this schema + +### xdm:ID Type + + +`string` + + + + + + +## xdm:disposition +### Label the outcome of the phone call + +The outcome of the call as next triggering actions such as 'demo scheduled','left voicemail', etc. + +`xdm:disposition` +* is optional +* type: `string` +* defined in this schema + +### xdm:disposition Type + + +`string` + + + + + + +## xdm:duration +### Time Spent during the call + +Record the length of the phone conversation in seconds + +`xdm:duration` +* is optional +* type: `number` +* defined in this schema + +### xdm:duration Type + + +`number` + + + + + + +## xdm:fromNumber +### Phone Number of the initiator of the call + +Person's phone number who initiated the conversation. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234. + +`xdm:fromNumber` +* is optional +* type: `string` +* defined in this schema + +### xdm:fromNumber Type + + +`string` + + + + + + +## xdm:fromWhoID +### Initiator of the call + +Person ID who initiated the call of the conversation + +`xdm:fromWhoID` +* is optional +* type: `string` +* defined in this schema + +### xdm:fromWhoID Type + + +`string` + + + + + + +## xdm:hasLeftVoiceMail +### Has the initiator of the call left any Voice Mail message + +A boolean flag to represent whether a voice mail has been left for the reciever + +`xdm:hasLeftVoiceMail` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:hasLeftVoiceMail Type + + +`boolean` + + + + + +## xdm:toNumber +### Phone number of the call reciever + +Person's phone number who is the reciever of the call. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234. + +`xdm:toNumber` +* is optional +* type: `string` +* defined in this schema + +### xdm:toNumber Type + + +`string` + + + + + + +## xdm:toWhoID +### Call reciever + +Person ID who recieved the call + +`xdm:toWhoID` +* is optional +* type: `string` +* defined in this schema + +### xdm:toWhoID Type + + +`string` + + + + + + +## xdm:type +### Type of the phone call + +A way to represent the nature of the call + +`xdm:type` +* is optional +* type: `string` +* defined in this schema + +### xdm:type Type + + +`string` + + + +### xdm:type Known Values +| Value | Description | +|-------|-------------| +| `internal` | Internal | +| `inbound` | Inbound | +| `outbound` | Outbound | + + + diff --git a/docs/reference/datatypes/phonenumber.schema.json b/docs/reference/datatypes/phonenumber.schema.json new file mode 100644 index 000000000..b4e79dfc7 --- /dev/null +++ b/docs/reference/datatypes/phonenumber.schema.json @@ -0,0 +1,79 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/phonenumber", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Phone number", + "type": "object", + "meta:extensible": true, + "description": "Information that enables the contact of a person with a phone. Typically an alphanumeric number, 1-222-333-4444 in North America, but can have a wide range of formats.", + "definitions": { + "phonenumber": { + "properties": { + "xdm:primary": { + "title": "Primary", + "type": "boolean", + "description": "Primary phone number indicator. Unlike address or email address, there can be multiple primary phone numbers; one per communication channel. The communication channel is defined by the type: `textMessaging`, `mobile`, `phone`, `home`, `work`, `unknown`, and `fax`." + }, + "xdm:number": { + "title": "Number", + "type": "string", + "description": "The phone number. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234." + }, + "xdm:extension": { + "title": "Extension", + "type": "string", + "description": "The internal dialing number used to call from a private exchange, operator, or switchboard." + }, + "xdm:status": { + "title": "Status", + "type": "string", + "description": "An indication as to the ability to use the phone number.", + "default": "active", + "meta:enum": { + "active": "Active", + "incomplete": "Incomplete", + "blacklisted": "Blacklisted", + "blocked": "Blocked" + } + }, + "xdm:statusReason": { + "title": "Status reason", + "type": "string", + "description": "A description of the current status." + }, + "xdm:validity": { + "title": "Validity", + "type": "string", + "description": "A level of technical correctness of the phone number.", + "meta:enum": { + "consistent": "Consistent", + "inconsistent": "Inconsistent", + "incomplete": "Incomplete", + "successfullyUsed": "Successfully used" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/phonenumber" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/phonenumber.schema.md b/docs/reference/datatypes/phonenumber.schema.md new file mode 100644 index 000000000..ca9116a09 --- /dev/null +++ b/docs/reference/datatypes/phonenumber.schema.md @@ -0,0 +1,174 @@ + +# Phone number Schema + +``` +https://ns.adobe.com/xdm/context/phonenumber +``` + +Information that enables the contact of a person with a phone. Typically an alphanumeric number, 1-222-333-4444 in North America, but can have a wide range of formats. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/phonenumber.schema.json](datatypes/phonenumber.schema.json) | +## Schema Hierarchy + +* Phone number `https://ns.adobe.com/xdm/context/phonenumber` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Phone number Example +```json +{ + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" +} +``` + +# Phone number Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:extension](#xdmextension) | `string` | Optional | | Phone number (this schema) | +| [xdm:number](#xdmnumber) | `string` | Optional | | Phone number (this schema) | +| [xdm:primary](#xdmprimary) | `boolean` | Optional | | Phone number (this schema) | +| [xdm:status](#xdmstatus) | `string` | Optional | `"active"` | Phone number (this schema) | +| [xdm:statusReason](#xdmstatusreason) | `string` | Optional | | Phone number (this schema) | +| [xdm:validity](#xdmvalidity) | `string` | Optional | | Phone number (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:extension +### Extension + +The internal dialing number used to call from a private exchange, operator, or switchboard. + +`xdm:extension` +* is optional +* type: `string` +* defined in this schema + +### xdm:extension Type + + +`string` + + + + + + +## xdm:number +### Number + +The phone number. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234. + +`xdm:number` +* is optional +* type: `string` +* defined in this schema + +### xdm:number Type + + +`string` + + + + + + +## xdm:primary +### Primary + +Primary phone number indicator. Unlike address or email address, there can be multiple primary phone numbers; one per communication channel. The communication channel is defined by the type: `textMessaging`, `mobile`, `phone`, `home`, `work`, `unknown`, and `fax`. + +`xdm:primary` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:primary Type + + +`boolean` + + + + + +## xdm:status +### Status + +An indication as to the ability to use the phone number. + +`xdm:status` +* is optional +* type: `string` +* default: `"active"` +* defined in this schema + +### xdm:status Type + + +`string` + + + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `active` | Active | +| `incomplete` | Incomplete | +| `blacklisted` | Blacklisted | +| `blocked` | Blocked | + + + + +## xdm:statusReason +### Status reason + +A description of the current status. + +`xdm:statusReason` +* is optional +* type: `string` +* defined in this schema + +### xdm:statusReason Type + + +`string` + + + + + + +## xdm:validity +### Validity + +A level of technical correctness of the phone number. + +`xdm:validity` +* is optional +* type: `string` +* defined in this schema + +### xdm:validity Type + + +`string` + + + +### xdm:validity Known Values +| Value | Description | +|-------|-------------| +| `consistent` | Consistent | +| `inconsistent` | Inconsistent | +| `incomplete` | Incomplete | +| `successfullyUsed` | Successfully used | + + + diff --git a/docs/reference/datatypes/place.schema.json b/docs/reference/datatypes/place.schema.json new file mode 100644 index 000000000..2710eb044 --- /dev/null +++ b/docs/reference/datatypes/place.schema.json @@ -0,0 +1,109 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/place", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Physical place", + "type": "object", + "meta:extensible": true, + "description": "A place in the real world with a physical location.", + "definitions": { + "physicallocation": { + "properties": { + "@id": { + "title": "Place ID", + "type": "string", + "format": "uri-reference", + "description": "The unique identifier of the place." + }, + "schema:description": { + "title": "Description", + "type": "string", + "description": "The description of the physical location." + }, + "xdm:address": { + "title": "Address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "The physical address of the location." + }, + "schema:telephone": { + "title": "Phone number", + "type": "string", + "description": "The phone number." + }, + "schema:branchCode": { + "title": "Location code", + "type": "string", + "description": "A short textual code also called \"store code\" that uniquely identifies a place of business. The code is typically assigned by the parent organization and used in structured URLs. For example, in the URL `http://www.starbucks.co.uk/store-locator/etc/detail/3047` the code \"3047\" is a `branchCode` for a particular branch." + }, + "xdm:shape": { + "title": "Geo shape", + "$ref": "http://schema.org/GeoShape", + "description": "The geographic shape of the physical location." + }, + "xdm:pointOfInterest": { + "title": "Point of interest", + "$ref": "http://schema.org/GeoCoordinates", + "description": "The coordinates of the point of interest for this location." + }, + "xdm:containedInPlace": { + "title": "Contained by location", + "type": "string", + "format": "uri", + "description": "XDM URI of another `Place` that this place is contained in. This property is based on `schema:containedInPlace`, but is using URI references instead of embedding the containing place." + }, + "xdm:containsPlaces": { + "title": "Contains locations", + "type": "array", + "items": { + "type": "string", + "format": "uri", + "description": "The XDM URI of another `Place` that this place contains." + }, + "description": "An array of XDM URIs of other `Place` instances that this place is containing. This property is based on `schema:containsPlace`, but is using URI references instead of embedding the containing place. In addition, it is an array, allowing one place to include multiple other places." + } + }, + "required": [ + "@id" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/physicallocation" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/entities/places/locationid-123456", + "schema:description": "A nice place to work", + "xdm:address": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "schema:telephone": "1-408-888-0000", + "xdm:containsPlaces": [ + "https://data.adobe.io/entities/places/locationid-123457", + "https://data.adobe.io/entities/places/locationid-123458" + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/place.schema.md b/docs/reference/datatypes/place.schema.md new file mode 100644 index 000000000..07eb5aee4 --- /dev/null +++ b/docs/reference/datatypes/place.schema.md @@ -0,0 +1,251 @@ + +# Physical place Schema + +``` +https://ns.adobe.com/xdm/context/place +``` + +A place in the real world with a physical location. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/place.schema.json](datatypes/place.schema.json) | +## Schema Hierarchy + +* Physical place `https://ns.adobe.com/xdm/context/place` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Postal address](address.schema.md) `https://ns.adobe.com/xdm/common/address` + * [Geo Shape](external/schema/geoshape.schema.md) `http://schema.org/GeoShape` + * [Geo Coordinates](external/schema/geocoordinates.schema.md) `http://schema.org/GeoCoordinates` + + +## Physical place Example +```json +{ + "@id": "https://data.adobe.io/entities/places/locationid-123456", + "schema:description": "A nice place to work", + "xdm:address": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "schema:telephone": "1-408-888-0000", + "xdm:containsPlaces": [ + "https://data.adobe.io/entities/places/locationid-123457", + "https://data.adobe.io/entities/places/locationid-123458" + ] +} +``` + +# Physical place Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Physical place (this schema) | +| [schema:branchCode](#schemabranchcode) | `string` | Optional | Physical place (this schema) | +| [schema:description](#schemadescription) | `string` | Optional | Physical place (this schema) | +| [schema:telephone](#schematelephone) | `string` | Optional | Physical place (this schema) | +| [xdm:address](#xdmaddress) | Postal address | Optional | Physical place (this schema) | +| [xdm:containedInPlace](#xdmcontainedinplace) | `string` | Optional | Physical place (this schema) | +| [xdm:containsPlaces](#xdmcontainsplaces) | `string[]` | Optional | Physical place (this schema) | +| [xdm:pointOfInterest](#xdmpointofinterest) | Geo Coordinates | Optional | Physical place (this schema) | +| [xdm:shape](#xdmshape) | Geo Shape | Optional | Physical place (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Place ID + +The unique identifier of the place. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:branchCode +### Location code + +A short textual code also called "store code" that uniquely identifies a place of business. The code is typically assigned by the parent organization and used in structured URLs. For example, in the URL `http://www.starbucks.co.uk/store-locator/etc/detail/3047` the code "3047" is a `branchCode` for a particular branch. + +`schema:branchCode` +* is optional +* type: `string` +* defined in this schema + +### schema:branchCode Type + + +`string` + + + + + + +## schema:description +### Description + +The description of the physical location. + +`schema:description` +* is optional +* type: `string` +* defined in this schema + +### schema:description Type + + +`string` + + + + + + +## schema:telephone +### Phone number + +The phone number. + +`schema:telephone` +* is optional +* type: `string` +* defined in this schema + +### schema:telephone Type + + +`string` + + + + + + +## xdm:address +### Address + +The physical address of the location. + +`xdm:address` +* is optional +* type: Postal address +* defined in this schema + +### xdm:address Type + + +* [Postal address](address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + +## xdm:containedInPlace +### Contained by location + +XDM URI of another `Place` that this place is contained in. This property is based on `schema:containedInPlace`, but is using URI references instead of embedding the containing place. + +`xdm:containedInPlace` +* is optional +* type: `string` +* defined in this schema + +### xdm:containedInPlace Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:containsPlaces +### Contains locations + +An array of XDM URIs of other `Place` instances that this place is containing. This property is based on `schema:containsPlace`, but is using URI references instead of embedding the containing place. In addition, it is an array, allowing one place to include multiple other places. + +`xdm:containsPlaces` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:containsPlaces Type + + +Array type: `string[]` + +All items must be of the type: +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + +The XDM URI of another `Place` that this place contains. + + + + + + + +## xdm:pointOfInterest +### Point of interest + +The coordinates of the point of interest for this location. + +`xdm:pointOfInterest` +* is optional +* type: Geo Coordinates +* defined in this schema + +### xdm:pointOfInterest Type + + +* [Geo Coordinates](external/schema/geocoordinates.schema.md) – `http://schema.org/GeoCoordinates` + + + + + +## xdm:shape +### Geo shape + +The geographic shape of the physical location. + +`xdm:shape` +* is optional +* type: Geo Shape +* defined in this schema + +### xdm:shape Type + + +* [Geo Shape](external/schema/geoshape.schema.md) – `http://schema.org/GeoShape` + + + + diff --git a/docs/reference/datatypes/placecontext.schema.json b/docs/reference/datatypes/placecontext.schema.json new file mode 100644 index 000000000..5c8edbcb2 --- /dev/null +++ b/docs/reference/datatypes/placecontext.schema.json @@ -0,0 +1,113 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/placecontext", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Place context", + "type": "object", + "meta:extensible": true, + "description": "The transient circumstances related to the place or physical location of the observation. \nExamples include location specific information such as weather, local time, traffic, day of the week, workday vs. holiday, working hours.\n", + "definitions": { + "placecontext": { + "properties": { + "xdm:localTime": { + "title": "Local time", + "type": "string", + "format": "date-time", + "description": "The local time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." + }, + "xdm:localTimezoneOffset": { + "title": "Local time zone offset", + "type": "integer", + "description": "The current, local time zone offset in minutes from UTC for the localTime in this object. This will include the current DST offset if applicable." + }, + "xdm:geo": { + "title": "Geo", + "$ref": "https://ns.adobe.com/xdm/common/geo", + "description": "The geographic location where the experience was delivered." + }, + "xdm:POIinteraction": { + "title": "POI interaction", + "description": "The point of interest (POI) interaction details.", + "meta:status": "experimental", + "$ref": "https://ns.adobe.com/xdm/context/poi-interaction" + }, + "xdm:activePOIs": { + "title": "POI detail", + "description": "Details of the points of interest (POIs) that cause the event.", + "meta:status": "experimental", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/poi-detail" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/placecontext" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:localTime": "2001-07-04T12:08:56+01:00", + "xdm:localTimezoneOffset": -360, + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + }, + "xdm:POIinteraction": { + "https://ns.adobe.com/xdm/data/metrics/placecontext/poi-exits": { + "xdm:value": 1 + }, + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Acme Hotel Tokyo Lobby", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:beacon": { + "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", + "xdm:beaconMajor": 300, + "xdm:beaconMinor": 34 + } + }, + "xdm:activePOIs": [ + { + "xdm:POIID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", + "xdm:name": "Acme Hotel Tokyo", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:beacon": { + "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", + "xdm:beaconMajor": 100, + "xdm:beaconMinor": 23 + } + }, + { + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Acme Hotel Tokyo Lobby", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:beacon": { + "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", + "xdm:beaconMajor": 300, + "xdm:beaconMinor": 34 + } + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/placecontext.schema.md b/docs/reference/datatypes/placecontext.schema.md new file mode 100644 index 000000000..c354d3c78 --- /dev/null +++ b/docs/reference/datatypes/placecontext.schema.md @@ -0,0 +1,192 @@ + +# Place context Schema + +``` +https://ns.adobe.com/xdm/context/placecontext +``` + +The transient circumstances related to the place or physical location of the observation. +Examples include location specific information such as weather, local time, traffic, day of the week, workday vs. holiday, working hours. + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/placecontext.schema.json](datatypes/placecontext.schema.json) | +## Schema Hierarchy + +* Place context `https://ns.adobe.com/xdm/context/placecontext` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Geo](geo.schema.md) `https://ns.adobe.com/xdm/common/geo` + * [Point of interest interaction](poi-interaction.schema.md) `https://ns.adobe.com/xdm/context/poi-interaction` + + +## Place context Example +```json +{ + "xdm:localTime": "2001-07-04T12:08:56+01:00", + "xdm:localTimezoneOffset": -360, + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + }, + "xdm:POIinteraction": { + "https://ns.adobe.com/xdm/data/metrics/placecontext/poi-exits": { + "xdm:value": 1 + }, + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Acme Hotel Tokyo Lobby", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:beacon": { + "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", + "xdm:beaconMajor": 300, + "xdm:beaconMinor": 34 + } + }, + "xdm:activePOIs": [ + { + "xdm:POIID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", + "xdm:name": "Acme Hotel Tokyo", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:beacon": { + "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", + "xdm:beaconMajor": 100, + "xdm:beaconMinor": 23 + } + }, + { + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Acme Hotel Tokyo Lobby", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:beacon": { + "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", + "xdm:beaconMajor": 300, + "xdm:beaconMinor": 34 + } + } + ] +} +``` + +# Place context Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:POIinteraction](#xdmpoiinteraction) | Point of interest interaction | Optional | Place context (this schema) | +| [xdm:activePOIs](#xdmactivepois) | Point of interest details | Optional | Place context (this schema) | +| [xdm:geo](#xdmgeo) | Geo | Optional | Place context (this schema) | +| [xdm:localTime](#xdmlocaltime) | `string` | Optional | Place context (this schema) | +| [xdm:localTimezoneOffset](#xdmlocaltimezoneoffset) | `integer` | Optional | Place context (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:POIinteraction +### POI interaction + +The point of interest (POI) interaction details. + +`xdm:POIinteraction` +* is optional +* type: Point of interest interaction +* defined in this schema + +### xdm:POIinteraction Type + + +* [Point of interest interaction](poi-interaction.schema.md) – `https://ns.adobe.com/xdm/context/poi-interaction` + + + + + +## xdm:activePOIs +### POI detail + +Details of the points of interest (POIs) that cause the event. + +`xdm:activePOIs` +* is optional +* type: Point of interest details + +* defined in this schema + +### xdm:activePOIs Type + + +Array type: Point of interest details + +All items must be of the type: +* [Point of interest details](poi-detail.schema.md) – `https://ns.adobe.com/xdm/context/poi-detail` + + + + + + + + +## xdm:geo +### Geo + +The geographic location where the experience was delivered. + +`xdm:geo` +* is optional +* type: Geo +* defined in this schema + +### xdm:geo Type + + +* [Geo](geo.schema.md) – `https://ns.adobe.com/xdm/common/geo` + + + + + +## xdm:localTime +### Local time + +The local time using RFC3339 with a stated time zone offset such as "2001-07-04T12:08:56-07:00". An example formatting pattern is "yyyy-MM-dd'T'HH:mm:ssXXX". + +`xdm:localTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:localTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:localTimezoneOffset +### Local time zone offset + +The current, local time zone offset in minutes from UTC for the localTime in this object. This will include the current DST offset if applicable. + +`xdm:localTimezoneOffset` +* is optional +* type: `integer` +* defined in this schema + +### xdm:localTimezoneOffset Type + + +`integer` + + + + + diff --git a/docs/reference/datatypes/player-state.schema.json b/docs/reference/datatypes/player-state.schema.json new file mode 100644 index 000000000..441830efd --- /dev/null +++ b/docs/reference/datatypes/player-state.schema.json @@ -0,0 +1,53 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/player-state", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Player state information", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Information related to player state.", + "definitions": { + "player-state": { + "properties": { + "xdm:playerStateSet": { + "title": "Player state set", + "type": "boolean", + "description": "Whether or not the player state is set on that state." + }, + "xdm:playerStateCount": { + "title": "Player state count", + "type": "integer", + "minimum": 0, + "description": "The number of times that player state was set on the stream." + }, + "xdm:playerStateTime": { + "title": "Player state time", + "type": "integer", + "minimum": 0, + "description": "The total duration of that player state." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/player-state" + } + ], + "examples": [ + { + "xdm:playerStateSet": true, + "xdm:playerStateCount": 3, + "xdm:playerStateTime": 180 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/player-state.schema.md b/docs/reference/datatypes/player-state.schema.md new file mode 100644 index 000000000..919864e28 --- /dev/null +++ b/docs/reference/datatypes/player-state.schema.md @@ -0,0 +1,96 @@ + +# Player state information Schema + +``` +https://ns.adobe.com/xdm/context/player-state +``` + +Information related to player state. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/player-state.schema.json](datatypes/player-state.schema.json) | +## Schema Hierarchy + +* Player state information `https://ns.adobe.com/xdm/context/player-state` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Player state information Example +```json +{ + "xdm:playerStateSet": true, + "xdm:playerStateCount": 3, + "xdm:playerStateTime": 180 +} +``` + +# Player state information Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:playerStateCount](#xdmplayerstatecount) | `integer` | Optional | Player state information (this schema) | +| [xdm:playerStateSet](#xdmplayerstateset) | `boolean` | Optional | Player state information (this schema) | +| [xdm:playerStateTime](#xdmplayerstatetime) | `integer` | Optional | Player state information (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:playerStateCount +### Player state count + +The number of times that player state was set on the stream. + +`xdm:playerStateCount` +* is optional +* type: `integer` +* defined in this schema + +### xdm:playerStateCount Type + + +`integer` +* minimum value: `0` + + + + + + +## xdm:playerStateSet +### Player state set + +Whether or not the player state is set on that state. + +`xdm:playerStateSet` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:playerStateSet Type + + +`boolean` + + + + + +## xdm:playerStateTime +### Player state time + +The total duration of that player state. + +`xdm:playerStateTime` +* is optional +* type: `integer` +* defined in this schema + +### xdm:playerStateTime Type + + +`integer` +* minimum value: `0` + + + + + diff --git a/docs/reference/datatypes/poi-detail.schema.json b/docs/reference/datatypes/poi-detail.schema.json new file mode 100644 index 000000000..86c15da3b --- /dev/null +++ b/docs/reference/datatypes/poi-detail.schema.json @@ -0,0 +1,107 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/poi-detail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Point of interest details", + "type": "object", + "meta:extensible": true, + "description": "A point or place of interest (POI) Details. Used to capture the technical and metadata information for a POI.", + "definitions": { + "geo-interaction-detail": { + "properties": { + "xdm:POIID": { + "title": "POI identity", + "type": "string", + "meta:status": "deprecated", + "description": "The unique identifier of the POI." + }, + "xdm:poiID": { + "title": "POI Identity", + "type": "string", + "description": "The unique identifier of the POI." + }, + "xdm:name": { + "title": "POI name", + "type": "string", + "description": "The name given to the POI." + }, + "xdm:category": { + "title": "POI category", + "type": "string", + "description": "General category assigned for organizing the POIs by the administrator of POI definitions." + }, + "xdm:type": { + "title": "POI type", + "type": "string", + "description": "The general type of the POI using a typing schema selected by the administrator of the POI definitions." + }, + "xdm:distanceToPOICenter": { + "title": "Distance to POI center", + "type": "number", + "description": "Estimated distance from the POI center in meters." + }, + "xdm:locatingType": { + "title": "Locating type", + "type": "string", + "description": "Mechanism used to determine location.", + "meta:enum": { + "beacon": "Hardware beacon", + "gps": "Device GPS", + "ip": "IP to geo lookup", + "ip+wifi": "IP with wifi lookup", + "wifi-triangulation": "Wifi triangulation" + } + }, + "xdm:beaconInteractionDetails": { + "title": "Beacon interaction details", + "$ref": "https://ns.adobe.com/xdm/context/beacon-interaction-details", + "description": "Beacon details active for the POI interaction." + }, + "xdm:geoInteractionDetails": { + "title": "Geo interaction details", + "$ref": "https://ns.adobe.com/xdm/context/geo-interaction-details", + "description": "Geo details active for the POI interaction." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/geo-interaction-detail" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:poiID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", + "xdm:name": "Acme Hotel Tokyo", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "gps", + "xdm:geoInteractionDetails": { + "xdm:distanceToCenter": 100, + "xdm:accuracy": 30 + } + }, + { + "xdm:poiID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", + "xdm:name": "Acme Hotel Tokyo", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", + "xdm:beaconMajor": 100, + "xdm:beaconMinor": 23 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/poi-detail.schema.md b/docs/reference/datatypes/poi-detail.schema.md new file mode 100644 index 000000000..c304746c5 --- /dev/null +++ b/docs/reference/datatypes/poi-detail.schema.md @@ -0,0 +1,253 @@ + +# Point of interest details Schema + +``` +https://ns.adobe.com/xdm/context/poi-detail +``` + +A point or place of interest (POI) Details. Used to capture the technical and metadata information for a POI. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/poi-detail.schema.json](datatypes/poi-detail.schema.json) | +## Schema Hierarchy + +* Point of interest details `https://ns.adobe.com/xdm/context/poi-detail` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Beacon](beacon-interaction-details.schema.md) `https://ns.adobe.com/xdm/context/beacon-interaction-details` + * [Geo interaction details](geo-interaction-details.schema.md) `https://ns.adobe.com/xdm/context/geo-interaction-details` + + +## Point of interest details Examples + +```json +{ + "xdm:poiID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", + "xdm:name": "Acme Hotel Tokyo", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "gps", + "xdm:geoInteractionDetails": { + "xdm:distanceToCenter": 100, + "xdm:accuracy": 30 + } +} +``` + +```json +{ + "xdm:poiID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", + "xdm:name": "Acme Hotel Tokyo", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", + "xdm:beaconMajor": 100, + "xdm:beaconMinor": 23 + } +} +``` + + +# Point of interest details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:POIID](#xdmpoiid) | `string` | Optional | Point of interest details (this schema) | +| [xdm:beaconInteractionDetails](#xdmbeaconinteractiondetails) | Beacon | Optional | Point of interest details (this schema) | +| [xdm:category](#xdmcategory) | `string` | Optional | Point of interest details (this schema) | +| [xdm:distanceToPOICenter](#xdmdistancetopoicenter) | `number` | Optional | Point of interest details (this schema) | +| [xdm:geoInteractionDetails](#xdmgeointeractiondetails) | Geo interaction details | Optional | Point of interest details (this schema) | +| [xdm:locatingType](#xdmlocatingtype) | `string` | Optional | Point of interest details (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | Point of interest details (this schema) | +| [xdm:poiID](#xdmpoiid-1) | `string` | Optional | Point of interest details (this schema) | +| [xdm:type](#xdmtype) | `string` | Optional | Point of interest details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:POIID +### POI identity + +The unique identifier of the POI. + +`xdm:POIID` +* is optional +* type: `string` +* defined in this schema + +### xdm:POIID Type + + +`string` + + + + + + +## xdm:beaconInteractionDetails +### Beacon interaction details + +Beacon details active for the POI interaction. + +`xdm:beaconInteractionDetails` +* is optional +* type: Beacon +* defined in this schema + +### xdm:beaconInteractionDetails Type + + +* [Beacon](beacon-interaction-details.schema.md) – `https://ns.adobe.com/xdm/context/beacon-interaction-details` + + + + + +## xdm:category +### POI category + +General category assigned for organizing the POIs by the administrator of POI definitions. + +`xdm:category` +* is optional +* type: `string` +* defined in this schema + +### xdm:category Type + + +`string` + + + + + + +## xdm:distanceToPOICenter +### Distance to POI center + +Estimated distance from the POI center in meters. + +`xdm:distanceToPOICenter` +* is optional +* type: `number` +* defined in this schema + +### xdm:distanceToPOICenter Type + + +`number` + + + + + + +## xdm:geoInteractionDetails +### Geo interaction details + +Geo details active for the POI interaction. + +`xdm:geoInteractionDetails` +* is optional +* type: Geo interaction details +* defined in this schema + +### xdm:geoInteractionDetails Type + + +* [Geo interaction details](geo-interaction-details.schema.md) – `https://ns.adobe.com/xdm/context/geo-interaction-details` + + + + + +## xdm:locatingType +### Locating type + +Mechanism used to determine location. + +`xdm:locatingType` +* is optional +* type: `string` +* defined in this schema + +### xdm:locatingType Type + + +`string` + + + +### xdm:locatingType Known Values +| Value | Description | +|-------|-------------| +| `beacon` | Hardware beacon | +| `gps` | Device GPS | +| `ip` | IP to geo lookup | +| `ip+wifi` | IP with wifi lookup | +| `wifi-triangulation` | Wifi triangulation | + + + + +## xdm:name +### POI name + +The name given to the POI. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:poiID +### POI Identity + +The unique identifier of the POI. + +`xdm:poiID` +* is optional +* type: `string` +* defined in this schema + +### xdm:poiID Type + + +`string` + + + + + + +## xdm:type +### POI type + +The general type of the POI using a typing schema selected by the administrator of the POI definitions. + +`xdm:type` +* is optional +* type: `string` +* defined in this schema + +### xdm:type Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/poi-interaction.schema.json b/docs/reference/datatypes/poi-interaction.schema.json new file mode 100644 index 000000000..d9aaa7909 --- /dev/null +++ b/docs/reference/datatypes/poi-interaction.schema.json @@ -0,0 +1,67 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/poi-interaction", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Point of interest interaction", + "type": "object", + "meta:extensible": true, + "description": "A point or place of interest (POI) interaction used to capture triggered engagement activities when users enter, leave, or come within range of a POI.", + "definitions": { + "poi-interaction": { + "properties": { + "xdm:POIDetail": { + "title": "POI detail", + "meta:status": "deprecated", + "description": "Detail of the POI that cause the event.", + "$ref": "https://ns.adobe.com/xdm/context/poi-detail" + }, + "xdm:poiDetail": { + "title": "POI detail", + "description": "Detail of the POI that cause the event.", + "$ref": "https://ns.adobe.com/xdm/context/poi-detail" + }, + "xdm:poiEntries": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of times a person has entered the point of interest (POI)." + }, + "xdm:poiExits": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of times a person has exited the point of interest (POI)." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/poi-interaction" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:poiExits": { + "xdm:value": 1 + }, + "xdm:poiDetail": { + "xdm:POIID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", + "xdm:name": "Acme Hotel Tokyo", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", + "xdm:beaconMajor": 100, + "xdm:beaconMinor": 23 + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/poi-interaction.schema.md b/docs/reference/datatypes/poi-interaction.schema.md new file mode 100644 index 000000000..253bbefbb --- /dev/null +++ b/docs/reference/datatypes/poi-interaction.schema.md @@ -0,0 +1,124 @@ + +# Point of interest interaction Schema + +``` +https://ns.adobe.com/xdm/context/poi-interaction +``` + +A point or place of interest (POI) interaction used to capture triggered engagement activities when users enter, leave, or come within range of a POI. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/poi-interaction.schema.json](datatypes/poi-interaction.schema.json) | +## Schema Hierarchy + +* Point of interest interaction `https://ns.adobe.com/xdm/context/poi-interaction` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Point of interest details](poi-detail.schema.md) `https://ns.adobe.com/xdm/context/poi-detail` + * [Measure](data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## Point of interest interaction Example +```json +{ + "xdm:poiExits": { + "xdm:value": 1 + }, + "xdm:poiDetail": { + "xdm:POIID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", + "xdm:name": "Acme Hotel Tokyo", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", + "xdm:beaconMajor": 100, + "xdm:beaconMinor": 23 + } + } +} +``` + +# Point of interest interaction Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:POIDetail](#xdmpoidetail) | Point of interest details | Optional | Point of interest interaction (this schema) | +| [xdm:poiDetail](#xdmpoidetail-1) | Point of interest details | Optional | Point of interest interaction (this schema) | +| [xdm:poiEntries](#xdmpoientries) | Measure | Optional | Point of interest interaction (this schema) | +| [xdm:poiExits](#xdmpoiexits) | Measure | Optional | Point of interest interaction (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:POIDetail +### POI detail + +Detail of the POI that cause the event. + +`xdm:POIDetail` +* is optional +* type: Point of interest details +* defined in this schema + +### xdm:POIDetail Type + + +* [Point of interest details](poi-detail.schema.md) – `https://ns.adobe.com/xdm/context/poi-detail` + + + + + +## xdm:poiDetail +### POI detail + +Detail of the POI that cause the event. + +`xdm:poiDetail` +* is optional +* type: Point of interest details +* defined in this schema + +### xdm:poiDetail Type + + +* [Point of interest details](poi-detail.schema.md) – `https://ns.adobe.com/xdm/context/poi-detail` + + + + + +## xdm:poiEntries + +The number of times a person has entered the point of interest (POI). + +`xdm:poiEntries` +* is optional +* type: Measure +* defined in this schema + +### xdm:poiEntries Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:poiExits + +The number of times a person has exited the point of interest (POI). + +`xdm:poiExits` +* is optional +* type: Measure +* defined in this schema + +### xdm:poiExits Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + diff --git a/docs/reference/datatypes/principal.schema.json b/docs/reference/datatypes/principal.schema.json new file mode 100644 index 000000000..252c4d452 --- /dev/null +++ b/docs/reference/datatypes/principal.schema.json @@ -0,0 +1,44 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/common/principal", + "title": "Principal", + "description": "This model represents a principal in an access control system. Principals are entities that have been authenticated against an identity provider.", + "type": "object", + "meta:extensible": false, + "properties": { + "xdm:provider": { + "description": "The identity provider that manages this principal.", + "$ref": "https://ns.adobe.com/xdm/common/identity-provider" + }, + "@id": { + "type": "string", + "description": "A unique (uniqueness is defined on the same lines as defined [here](https://tools.ietf.org/html/rfc8141#section-5)) and persistent identifier for the principal. Ideally, this identifier should be a [URI](https://tools.ietf.org/html/rfc3986)." + }, + "@type": { + "type": "string", + "format": "uri", + "description": "The type of the principal. Acts as a processing hint to the client. Ideally, each value should be identified as a [URI](https://tools.ietf.org/html/rfc3986)." + } + }, + "required": [ + "xdm:provider", + "@id", + "@type" + ], + "meta:status": "stable", + "examples": [ + { + "xdm:provider": { + "@id": "https://ims-na1.adobelogin.com/" + }, + "@id": "C0B648DE57D701277F000101@AdobeID", + "@type": "https://ns.adobe.com/adobecloudplatform/ims/user" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/principal.schema.md b/docs/reference/datatypes/principal.schema.md new file mode 100644 index 000000000..114524256 --- /dev/null +++ b/docs/reference/datatypes/principal.schema.md @@ -0,0 +1,94 @@ + +# Principal Schema + +``` +https://ns.adobe.com/xdm/common/principal +``` + +This model represents a principal in an access control system. Principals are entities that have been authenticated against an identity provider. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | No | Stable | No | Forbidden | Permitted | [datatypes/principal.schema.json](datatypes/principal.schema.json) | +## Schema Hierarchy + +* Principal `https://ns.adobe.com/xdm/common/principal` + * [Identity Provider](identity-provider.schema.md) `https://ns.adobe.com/xdm/common/identity-provider` + + +## Principal Example +```json +{ + "xdm:provider": { + "@id": "https://ims-na1.adobelogin.com/" + }, + "@id": "C0B648DE57D701277F000101@AdobeID", + "@type": "https://ns.adobe.com/adobecloudplatform/ims/user" +} +``` + +# Principal Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | **Required** | Principal (this schema) | +| [@type](#type) | `string` | **Required** | Principal (this schema) | +| [xdm:provider](#xdmprovider) | Identity Provider | **Required** | Principal (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id + +A unique (uniqueness is defined on the same lines as defined [here](https://tools.ietf.org/html/rfc8141#section-5)) and persistent identifier for the principal. Ideally, this identifier should be a [URI](https://tools.ietf.org/html/rfc3986). + +`@id` +* is **required** +* type: `string` +* defined in this schema + +### @id Type + + +`string` + + + + + + +## @type + +The type of the principal. Acts as a processing hint to the client. Ideally, each value should be identified as a [URI](https://tools.ietf.org/html/rfc3986). + +`@type` +* is **required** +* type: `string` +* defined in this schema + +### @type Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:provider + +The identity provider that manages this principal. + +`xdm:provider` +* is **required** +* type: Identity Provider +* defined in this schema + +### xdm:provider Type + + +* [Identity Provider](identity-provider.schema.md) – `https://ns.adobe.com/xdm/common/identity-provider` + + + + diff --git a/docs/reference/datatypes/product.schema.json b/docs/reference/datatypes/product.schema.json new file mode 100644 index 000000000..3c79b4c4a --- /dev/null +++ b/docs/reference/datatypes/product.schema.json @@ -0,0 +1,190 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/product", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product", + "type": "object", + "description": "XDM product name or title, master product, and key attributes of product in the product catalog.", + "definitions": { + "product": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "The internal unique ID of the product in the commerce backend system." + }, + "xdm:SKU": { + "title": "SKU", + "type": "string", + "description": "The unique SKU (stock keeping unit) of the product assigned by the vendor." + }, + "xdm:name": { + "title": "Name", + "type": "string", + "description": "The name of the product." + }, + "schema:description": { + "title": "Description", + "type": "string", + "description": "The localized description of the product." + }, + "xdm:category": { + "title": "Category", + "type": "string", + "description": "Primary categorization or category name of the product." + }, + "xdm:department": { + "title": "Department", + "type": "string", + "description": "Primary department the product is associated with." + }, + "xdm:brand": { + "title": "Brand", + "type": "string", + "description": "The brand of the product." + }, + "xdm:masterProductID": { + "title": "Master product identifier", + "type": "string", + "format": "uri", + "description": "The internal unique ID of the product in the commerce backend system." + }, + "xdm:masterProductSKU": { + "title": "Master product SKU", + "type": "string", + "description": "The unique SKU (stock keeping unit) of the master product assigned by the vendor or manufacturer." + }, + "xdm:masterProductName": { + "title": "Master product name", + "type": "string", + "description": "The localized name of the product." + }, + "xdm:masterProductDescription": { + "title": "Master product description", + "type": "string", + "description": "The description of the product." + }, + "xdm:fabrication": { + "title": "Fabrication", + "type": "string", + "description": "Primary material of the product construction." + }, + "xdm:gender": { + "title": "Gender", + "type": "string", + "description": "Gender the product is marketed to.", + "meta:enum": { + "male": "For men", + "female": "For women", + "unisex": "For both men and women", + "unknown": "Unknown" + } + }, + "xdm:size": { + "title": "Size", + "type": "number", + "description": "Standard product size for the product." + }, + "xdm:unitOfMeasure": { + "title": "Unit of measure", + "type": "string", + "description": "Standard unit of measure of the product and or variation and relates the units for the size measurement." + }, + "xdm:countryOfOrigin": { + "title": "Country of origin", + "type": "string", + "pattern": "^[A-Z]{2}$", + "description": "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country of origin of the product as defined by customs requirements." + }, + "xdm:COGS": { + "title": "Cost of good sold", + "type": "number", + "description": "Cost of good sold, in the `currencyCode` currency." + }, + "xdm:listPrice": { + "title": "List price", + "type": "number", + "description": "Default price of the product before sales and discounting, in the `currencyCode` currency." + }, + "xdm:currencyCode": { + "title": "Currency code", + "type": "string", + "examples": [ + "USD", + "EUR" + ], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 alphabetic currency code used for cost and pricing, including `listPrice` and `COGS`." + }, + "xdm:originalSaleDate": { + "title": "Original sale date", + "type": "string", + "format": "date", + "description": "First date the product was made available for sale. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." + }, + "xdm:productCreateDate": { + "title": "Product creation date", + "format": "date", + "type": "string", + "description": "The date when this product was created. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." + }, + "xdm:productLastModified": { + "title": "Product last modified", + "format": "date", + "type": "string", + "description": "The date when this product was last modified. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." + }, + "xdm:productURL": { + "title": "Product URL", + "type": "string", + "description": "The URL for the primary product view of the product page." + }, + "xdm:manufacturerName": { + "title": "Manufacturer name", + "type": "string", + "description": "Manufacturer of the product." + }, + "xdm:supplierName": { + "title": "Supplier name", + "type": "string", + "description": "The distributor of the product." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/product" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://commerce.adobe.io/entities/product/product-203766910", + "xdm:SKU": "203766910", + "xdm:name": "Lahara Single Hole Single-Handle Bathroom Faucet with Metal Drain Assembly in Stainless", + "schema:description": "Just like ocean waves, the one-piece curves and sleek lines of this Lahara Single Hole 1-Handle High Arc Bathroom Faucet in Stainless make a lasting impression. Delta's exclusive DIAMOND seal technology uses a valve with a tough diamond coating to bring you a faucet built to last up to five million uses.", + "xdm:category": "Bathroom Faucets", + "xdm:department": "Bathroom", + "xdm:brand": "Delta", + "xdm:fabrication": "stainless steel", + "xdm:size": 8.91, + "xdm:unitOfMeasure": "Inch", + "xdm:countryOfOrigin": "US", + "xdm:listPrice": 151.99, + "xdm:currencyCode": "USD", + "xdm:productURL": "https://www.homedepot.com/p/Delta-Lahara-Single-Hole-Single-Handle-Bathroom-Faucet-with-Metal-Drain-Assembly-in-Stainless-538-SSMPU-DST/203766910", + "xdm:manufacturerName": "Delta Faucet Company", + "xdm:supplierName": "Home Depot" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/product.schema.md b/docs/reference/datatypes/product.schema.md new file mode 100644 index 000000000..aff0f1c62 --- /dev/null +++ b/docs/reference/datatypes/product.schema.md @@ -0,0 +1,609 @@ + +# Product Schema + +``` +https://ns.adobe.com/xdm/context/product +``` + +XDM product name or title, master product, and key attributes of product in the product catalog. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/product.schema.json](datatypes/product.schema.json) | +## Schema Hierarchy + +* Product `https://ns.adobe.com/xdm/context/product` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Product Example +```json +{ + "@id": "https://commerce.adobe.io/entities/product/product-203766910", + "xdm:SKU": "203766910", + "xdm:name": "Lahara Single Hole Single-Handle Bathroom Faucet with Metal Drain Assembly in Stainless", + "schema:description": "Just like ocean waves, the one-piece curves and sleek lines of this Lahara Single Hole 1-Handle High Arc Bathroom Faucet in Stainless make a lasting impression. Delta's exclusive DIAMOND seal technology uses a valve with a tough diamond coating to bring you a faucet built to last up to five million uses.", + "xdm:category": "Bathroom Faucets", + "xdm:department": "Bathroom", + "xdm:brand": "Delta", + "xdm:fabrication": "stainless steel", + "xdm:size": 8.91, + "xdm:unitOfMeasure": "Inch", + "xdm:countryOfOrigin": "US", + "xdm:listPrice": 151.99, + "xdm:currencyCode": "USD", + "xdm:productURL": "https://www.homedepot.com/p/Delta-Lahara-Single-Hole-Single-Handle-Bathroom-Faucet-with-Metal-Drain-Assembly-in-Stainless-538-SSMPU-DST/203766910", + "xdm:manufacturerName": "Delta Faucet Company", + "xdm:supplierName": "Home Depot" +} +``` + +# Product Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Product (this schema) | +| [schema:description](#schemadescription) | `string` | Optional | Product (this schema) | +| [xdm:COGS](#xdmcogs) | `number` | Optional | Product (this schema) | +| [xdm:SKU](#xdmsku) | `string` | Optional | Product (this schema) | +| [xdm:brand](#xdmbrand) | `string` | Optional | Product (this schema) | +| [xdm:category](#xdmcategory) | `string` | Optional | Product (this schema) | +| [xdm:countryOfOrigin](#xdmcountryoforigin) | `string` | Optional | Product (this schema) | +| [xdm:currencyCode](#xdmcurrencycode) | `string` | Optional | Product (this schema) | +| [xdm:department](#xdmdepartment) | `string` | Optional | Product (this schema) | +| [xdm:fabrication](#xdmfabrication) | `string` | Optional | Product (this schema) | +| [xdm:gender](#xdmgender) | `string` | Optional | Product (this schema) | +| [xdm:listPrice](#xdmlistprice) | `number` | Optional | Product (this schema) | +| [xdm:manufacturerName](#xdmmanufacturername) | `string` | Optional | Product (this schema) | +| [xdm:masterProductDescription](#xdmmasterproductdescription) | `string` | Optional | Product (this schema) | +| [xdm:masterProductID](#xdmmasterproductid) | `string` | Optional | Product (this schema) | +| [xdm:masterProductName](#xdmmasterproductname) | `string` | Optional | Product (this schema) | +| [xdm:masterProductSKU](#xdmmasterproductsku) | `string` | Optional | Product (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | Product (this schema) | +| [xdm:originalSaleDate](#xdmoriginalsaledate) | `string` | Optional | Product (this schema) | +| [xdm:productCreateDate](#xdmproductcreatedate) | `string` | Optional | Product (this schema) | +| [xdm:productLastModified](#xdmproductlastmodified) | `string` | Optional | Product (this schema) | +| [xdm:productURL](#xdmproducturl) | `string` | Optional | Product (this schema) | +| [xdm:size](#xdmsize) | `number` | Optional | Product (this schema) | +| [xdm:supplierName](#xdmsuppliername) | `string` | Optional | Product (this schema) | +| [xdm:unitOfMeasure](#xdmunitofmeasure) | `string` | Optional | Product (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The internal unique ID of the product in the commerce backend system. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## schema:description +### Description + +The localized description of the product. + +`schema:description` +* is optional +* type: `string` +* defined in this schema + +### schema:description Type + + +`string` + + + + + + +## xdm:COGS +### Cost of good sold + +Cost of good sold, in the `currencyCode` currency. + +`xdm:COGS` +* is optional +* type: `number` +* defined in this schema + +### xdm:COGS Type + + +`number` + + + + + + +## xdm:SKU +### SKU + +The unique SKU (stock keeping unit) of the product assigned by the vendor. + +`xdm:SKU` +* is optional +* type: `string` +* defined in this schema + +### xdm:SKU Type + + +`string` + + + + + + +## xdm:brand +### Brand + +The brand of the product. + +`xdm:brand` +* is optional +* type: `string` +* defined in this schema + +### xdm:brand Type + + +`string` + + + + + + +## xdm:category +### Category + +Primary categorization or category name of the product. + +`xdm:category` +* is optional +* type: `string` +* defined in this schema + +### xdm:category Type + + +`string` + + + + + + +## xdm:countryOfOrigin +### Country of origin + +The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country of origin of the product as defined by customs requirements. + +`xdm:countryOfOrigin` +* is optional +* type: `string` +* defined in this schema + +### xdm:countryOfOrigin Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E%5BA-Z%5D%7B2%7D%24)): +```regex +^[A-Z]{2}$ +``` + + + + + + +## xdm:currencyCode +### Currency code + +The ISO 4217 alphabetic currency code used for cost and pricing, including `listPrice` and `COGS`. + +`xdm:currencyCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:currencyCode Type + + +`string` + + +All instances must conform to this regular expression +```regex +^[A-Z]{3}$ +``` + +* test example: [USD](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=USD) +* test example: [EUR](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=EUR) + + + + +### xdm:currencyCode Examples + +```json +"USD" +``` + +```json +"EUR" +``` + + + +## xdm:department +### Department + +Primary department the product is associated with. + +`xdm:department` +* is optional +* type: `string` +* defined in this schema + +### xdm:department Type + + +`string` + + + + + + +## xdm:fabrication +### Fabrication + +Primary material of the product construction. + +`xdm:fabrication` +* is optional +* type: `string` +* defined in this schema + +### xdm:fabrication Type + + +`string` + + + + + + +## xdm:gender +### Gender + +Gender the product is marketed to. + +`xdm:gender` +* is optional +* type: `string` +* defined in this schema + +### xdm:gender Type + + +`string` + + + +### xdm:gender Known Values +| Value | Description | +|-------|-------------| +| `male` | For men | +| `female` | For women | +| `unisex` | For both men and women | +| `unknown` | Unknown | + + + + +## xdm:listPrice +### List price + +Default price of the product before sales and discounting, in the `currencyCode` currency. + +`xdm:listPrice` +* is optional +* type: `number` +* defined in this schema + +### xdm:listPrice Type + + +`number` + + + + + + +## xdm:manufacturerName +### Manufacturer name + +Manufacturer of the product. + +`xdm:manufacturerName` +* is optional +* type: `string` +* defined in this schema + +### xdm:manufacturerName Type + + +`string` + + + + + + +## xdm:masterProductDescription +### Master product description + +The description of the product. + +`xdm:masterProductDescription` +* is optional +* type: `string` +* defined in this schema + +### xdm:masterProductDescription Type + + +`string` + + + + + + +## xdm:masterProductID +### Master product identifier + +The internal unique ID of the product in the commerce backend system. + +`xdm:masterProductID` +* is optional +* type: `string` +* defined in this schema + +### xdm:masterProductID Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:masterProductName +### Master product name + +The localized name of the product. + +`xdm:masterProductName` +* is optional +* type: `string` +* defined in this schema + +### xdm:masterProductName Type + + +`string` + + + + + + +## xdm:masterProductSKU +### Master product SKU + +The unique SKU (stock keeping unit) of the master product assigned by the vendor or manufacturer. + +`xdm:masterProductSKU` +* is optional +* type: `string` +* defined in this schema + +### xdm:masterProductSKU Type + + +`string` + + + + + + +## xdm:name +### Name + +The name of the product. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:originalSaleDate +### Original sale date + +First date the product was made available for sale. The time using RFC3339 with a stated time zone offset such as "2001-07-04T12:08:56-07:00". An example formatting pattern is "yyyy-MM-dd'T'HH:mm:ssXXX". + +`xdm:originalSaleDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:originalSaleDate Type + + +`string` +* format: `date` – date, without time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:productCreateDate +### Product creation date + +The date when this product was created. The time using RFC3339 with a stated time zone offset such as "2001-07-04T12:08:56-07:00". An example formatting pattern is "yyyy-MM-dd'T'HH:mm:ssXXX". + +`xdm:productCreateDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:productCreateDate Type + + +`string` +* format: `date` – date, without time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:productLastModified +### Product last modified + +The date when this product was last modified. The time using RFC3339 with a stated time zone offset such as "2001-07-04T12:08:56-07:00". An example formatting pattern is "yyyy-MM-dd'T'HH:mm:ssXXX". + +`xdm:productLastModified` +* is optional +* type: `string` +* defined in this schema + +### xdm:productLastModified Type + + +`string` +* format: `date` – date, without time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:productURL +### Product URL + +The URL for the primary product view of the product page. + +`xdm:productURL` +* is optional +* type: `string` +* defined in this schema + +### xdm:productURL Type + + +`string` + + + + + + +## xdm:size +### Size + +Standard product size for the product. + +`xdm:size` +* is optional +* type: `number` +* defined in this schema + +### xdm:size Type + + +`number` + + + + + + +## xdm:supplierName +### Supplier name + +The distributor of the product. + +`xdm:supplierName` +* is optional +* type: `string` +* defined in this schema + +### xdm:supplierName Type + + +`string` + + + + + + +## xdm:unitOfMeasure +### Unit of measure + +Standard unit of measure of the product and or variation and relates the units for the size measurement. + +`xdm:unitOfMeasure` +* is optional +* type: `string` +* defined in this schema + +### xdm:unitOfMeasure Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/productlistitem.schema.json b/docs/reference/datatypes/productlistitem.schema.json new file mode 100644 index 000000000..a63d290eb --- /dev/null +++ b/docs/reference/datatypes/productlistitem.schema.json @@ -0,0 +1,86 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/content/productlistitem", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product list item", + "type": "object", + "description": "The product list item represents a product selected by a customer with specific options, pricing, usage context for a specific point of time and may differ from the product record. For example the product record contains details from the product information system that are consistent for all customers, where the product list item has the actual price offered to the customer at that time which may vary due to sales campaigns or seasonal pricing.", + "definitions": { + "productlistitem": { + "properties": { + "xdm:SKU": { + "title": "SKU", + "type": "string", + "description": "Stock keeping unit (SKU), the unique identifier for a product defined by the vendor." + }, + "@id": { + "title": "Line item ID.", + "type": "string", + "format": "uri-reference", + "description": "The line item identifier for this product entry. The product itself is identified through `xdm:product`." + }, + "xdm:product": { + "title": "Product", + "type": "string", + "format": "uri", + "description": "The XDM identifier of the product itself." + }, + "xdm:name": { + "title": "Name", + "type": "string", + "description": "The display name for the product as presented to the user for this product view." + }, + "xdm:productAddMethod": { + "title": "Product add method", + "type": "string", + "description": "The method that was used to add a product item to the list by the visitor. Set with product list add metrics." + }, + "xdm:currencyCode": { + "title": "Currency code", + "type": "string", + "examples": [ + "USD", + "EUR" + ], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 alphabetic currency code used for pricing the product." + }, + "xdm:quantity": { + "title": "Quantity", + "type": "integer", + "description": "The number of units the customer has indicated they require of the product." + }, + "xdm:priceTotal": { + "title": "Price total", + "type": "number", + "description": "The total price for the product line item." + } + }, + "required": [ + "xdm:SKU" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/productlistitem" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:SKU": "1002352692", + "xdm:product": "https://commerce.adobe.io/entities/product/product-203766910", + "@id": "https://commerce.adobe.io/entities/item/item-12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/productlistitem.schema.md b/docs/reference/datatypes/productlistitem.schema.md new file mode 100644 index 000000000..76b0b5810 --- /dev/null +++ b/docs/reference/datatypes/productlistitem.schema.md @@ -0,0 +1,220 @@ + +# Product list item Schema + +``` +https://ns.adobe.com/xdm/content/productlistitem +``` + +The product list item represents a product selected by a customer with specific options, pricing, usage context for a specific point of time and may differ from the product record. For example the product record contains details from the product information system that are consistent for all customers, where the product list item has the actual price offered to the customer at that time which may vary due to sales campaigns or seasonal pricing. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/productlistitem.schema.json](datatypes/productlistitem.schema.json) | + +## Product list item Example +```json +{ + "xdm:SKU": "1002352692", + "xdm:product": "https://commerce.adobe.io/entities/product/product-203766910", + "@id": "https://commerce.adobe.io/entities/item/item-12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 +} +``` + +# Product list item Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Product list item (this schema) | +| [xdm:SKU](#xdmsku) | `string` | Optional | Product list item (this schema) | +| [xdm:currencyCode](#xdmcurrencycode) | `string` | Optional | Product list item (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | Product list item (this schema) | +| [xdm:priceTotal](#xdmpricetotal) | `number` | Optional | Product list item (this schema) | +| [xdm:product](#xdmproduct) | `string` | Optional | Product list item (this schema) | +| [xdm:productAddMethod](#xdmproductaddmethod) | `string` | Optional | Product list item (this schema) | +| [xdm:quantity](#xdmquantity) | `integer` | Optional | Product list item (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Line item ID. + +The line item identifier for this product entry. The product itself is identified through `xdm:product`. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:SKU +### SKU + +Stock keeping unit (SKU), the unique identifier for a product defined by the vendor. + +`xdm:SKU` +* is optional +* type: `string` +* defined in this schema + +### xdm:SKU Type + + +`string` + + + + + + +## xdm:currencyCode +### Currency code + +The ISO 4217 alphabetic currency code used for pricing the product. + +`xdm:currencyCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:currencyCode Type + + +`string` + + +All instances must conform to this regular expression +```regex +^[A-Z]{3}$ +``` + +* test example: [USD](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=USD) +* test example: [EUR](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=EUR) + + + + +### xdm:currencyCode Examples + +```json +"USD" +``` + +```json +"EUR" +``` + + + +## xdm:name +### Name + +The display name for the product as presented to the user for this product view. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:priceTotal +### Price total + +The total price for the product line item. + +`xdm:priceTotal` +* is optional +* type: `number` +* defined in this schema + +### xdm:priceTotal Type + + +`number` + + + + + + +## xdm:product +### Product + +The XDM identifier of the product itself. + +`xdm:product` +* is optional +* type: `string` +* defined in this schema + +### xdm:product Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:productAddMethod +### Product add method + +The method that was used to add a product item to the list by the visitor. Set with product list add metrics. + +`xdm:productAddMethod` +* is optional +* type: `string` +* defined in this schema + +### xdm:productAddMethod Type + + +`string` + + + + + + +## xdm:quantity +### Quantity + +The number of units the customer has indicated they require of the product. + +`xdm:quantity` +* is optional +* type: `integer` +* defined in this schema + +### xdm:quantity Type + + +`integer` + + + + + diff --git a/docs/reference/datatypes/profilestitch.schema.json b/docs/reference/datatypes/profilestitch.schema.json new file mode 100644 index 000000000..939bfe319 --- /dev/null +++ b/docs/reference/datatypes/profilestitch.schema.json @@ -0,0 +1,62 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profileStitch", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile stitch", + "type": "object", + "description": "Details about the IDs that were joined by profile stitching.", + "definitions": { + "profileStitch": { + "properties": { + "xdm:profileStitchID": { + "title": "Profile stitch ID", + "$ref": "https://ns.adobe.com/xdm/context/profileStitchIdentity", + "description": "The identity of the segment or snapshot definition in with the domain of the specific system that processes that type of segment." + }, + "xdm:version": { + "title": "Version", + "type": "string", + "description": "The version of the profile stitch definition used and is useful for debugging." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "#/definitions/profileStitch" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "1.0", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/92312748749128" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/62312748749321" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" + } + ] + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/profilestitch.schema.md b/docs/reference/datatypes/profilestitch.schema.md new file mode 100644 index 000000000..0f0070b5c --- /dev/null +++ b/docs/reference/datatypes/profilestitch.schema.md @@ -0,0 +1,114 @@ + +# Profile stitch Schema + +``` +https://ns.adobe.com/xdm/context/profileStitch +``` + +Details about the IDs that were joined by profile stitching. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/profilestitch.schema.json](datatypes/profilestitch.schema.json) | +## Schema Hierarchy + +* Profile stitch `https://ns.adobe.com/xdm/context/profileStitch` + * [IdentityMap](../mixins/shared/identitymap.schema.md) `https://ns.adobe.com/xdm/context/identitymap` + * [Profile stitch identity](profilestitchidentity.schema.md) `https://ns.adobe.com/xdm/context/profileStitchIdentity` + + +## Profile stitch Example +```json +{ + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "1.0", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/92312748749128" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/62312748749321" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" + } + ] + } +} +``` + +# Profile stitch Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:identityMap](#xdmidentitymap) | `object` | Optional | [IdentityMap](../mixins/shared/identitymap.schema.md#xdmidentitymap) | +| [xdm:profileStitchID](#xdmprofilestitchid) | Profile stitch identity | Optional | Profile stitch (this schema) | +| [xdm:version](#xdmversion) | `string` | Optional | Profile stitch (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:identityMap + + +`xdm:identityMap` +* is optional +* type: `object` +* defined in [IdentityMap](../mixins/shared/identitymap.schema.md#xdmidentitymap) + +### xdm:identityMap Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:profileStitchID +### Profile stitch ID + +The identity of the segment or snapshot definition in with the domain of the specific system that processes that type of segment. + +`xdm:profileStitchID` +* is optional +* type: Profile stitch identity +* defined in this schema + +### xdm:profileStitchID Type + + +* [Profile stitch identity](profilestitchidentity.schema.md) – `https://ns.adobe.com/xdm/context/profileStitchIdentity` + + + + + +## xdm:version +### Version + +The version of the profile stitch definition used and is useful for debugging. + +`xdm:version` +* is optional +* type: `string` +* defined in this schema + +### xdm:version Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/profilestitchidentity.schema.json b/docs/reference/datatypes/profilestitchidentity.schema.json new file mode 100644 index 000000000..e57cfb853 --- /dev/null +++ b/docs/reference/datatypes/profilestitchidentity.schema.json @@ -0,0 +1,49 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profileStitchIdentity", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile stitch identity", + "type": "object", + "description": "Profile stitch identity is used to clearly distinguish profile stitching from multiple sources. `ProfileStitchIdentity` is established by an profile stitch identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the profileStitchIdentity is unique.", + "definitions": { + "profileStitchIdentity": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "Identity of the profile stitch in the related namespace." + }, + "xdm:namespace": { + "title": "Namespace", + "$ref": "https://ns.adobe.com/xdm/context/namespace", + "description": "The namespace associated with the `xid` attribute." + }, + "xdm:xid": { + "title": "Experience identifier", + "type": "string", + "description": "When present, this value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/profileStitchIdentity" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/profilestitchidentity.schema.md b/docs/reference/datatypes/profilestitchidentity.schema.md new file mode 100644 index 000000000..e752678d2 --- /dev/null +++ b/docs/reference/datatypes/profilestitchidentity.schema.md @@ -0,0 +1,96 @@ + +# Profile stitch identity Schema + +``` +https://ns.adobe.com/xdm/context/profileStitchIdentity +``` + +Profile stitch identity is used to clearly distinguish profile stitching from multiple sources. `ProfileStitchIdentity` is established by an profile stitch identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the profileStitchIdentity is unique. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/profilestitchidentity.schema.json](datatypes/profilestitchidentity.schema.json) | +## Schema Hierarchy + +* Profile stitch identity `https://ns.adobe.com/xdm/context/profileStitchIdentity` + * [Namespace](namespace.schema.md) `https://ns.adobe.com/xdm/context/namespace` + + +## Profile stitch identity Example +```json +{ + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + } +} +``` + +# Profile stitch identity Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Profile stitch identity (this schema) | +| [xdm:namespace](#xdmnamespace) | Namespace | Optional | Profile stitch identity (this schema) | +| [xdm:xid](#xdmxid) | `string` | Optional | Profile stitch identity (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +Identity of the profile stitch in the related namespace. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:namespace +### Namespace + +The namespace associated with the `xid` attribute. + +`xdm:namespace` +* is optional +* type: Namespace +* defined in this schema + +### xdm:namespace Type + + +* [Namespace](namespace.schema.md) – `https://ns.adobe.com/xdm/context/namespace` + + + + + +## xdm:xid +### Experience identifier + +When present, this value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces. + +`xdm:xid` +* is optional +* type: `string` +* defined in this schema + +### xdm:xid Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/pushdetail.schema.json b/docs/reference/datatypes/pushdetail.schema.json new file mode 100644 index 000000000..00b92db29 --- /dev/null +++ b/docs/reference/datatypes/pushdetail.schema.json @@ -0,0 +1,80 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/pushdetail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Push notification detail", + "type": "object", + "meta:extensible": true, + "description": "Push notification detail required to send mobile push notification to a specific mobile application on a given device.", + "definitions": { + "pushdetail": { + "properties": { + "xdm:token": { + "title": "Push Token", + "type": "string", + "description": "Valid push token for the given push platform." + }, + "xdm:platform": { + "title": "Push Platform", + "type": "string", + "description": "Push provider, e.g. apns or fcm" + }, + "xdm:blacklisted": { + "title": "Blacklist Flag", + "type": "boolean", + "meta:status": "deprecated", + "description": "Indicates whether the push token is blacklisted. Deprecated due to new guidance on key names, use blocklisted instead." + }, + "xdm:blocklisted": { + "title": "Blocklist Flag", + "type": "boolean", + "description": "Indicates whether the push token is blocked by the push provider. " + }, + "xdm:appID": { + "title": "Application Identifier", + "type": "string", + "description": "Unique Identifier for the mobile application." + }, + "xdm:identiy": { + "title": "Identity associated with this token", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "meta:status": "deprecated", + "description": "The identity associated with this token before profile stitching. Deprecated due to typo, use xdm:identity instead." + }, + "xdm:identity": { + "title": "Identity associated with this token", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "The identity associated with this token before profile stitching." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/pushdetail" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:appID": "75eafb7e-fa44-4514-86fc-221e32c5aef9", + "xdm:token": "99156313-c9df-4e54-9c6c-5740f940c3ca", + "xdm:platform": "apns", + "xdm:blocklisted": false, + "xdm:identity": { + "xdm:namespace": { + "xdm:code": "ECID" + }, + "xdm:xid": "92312748749128" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/pushdetail.schema.md b/docs/reference/datatypes/pushdetail.schema.md new file mode 100644 index 000000000..9482e2672 --- /dev/null +++ b/docs/reference/datatypes/pushdetail.schema.md @@ -0,0 +1,183 @@ + +# Push notification detail Schema + +``` +https://ns.adobe.com/xdm/context/pushdetail +``` + +Push notification detail required to send mobile push notification to a specific mobile application on a given device. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/pushdetail.schema.json](datatypes/pushdetail.schema.json) | +## Schema Hierarchy + +* Push notification detail `https://ns.adobe.com/xdm/context/pushdetail` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Identity](identity.schema.md) `https://ns.adobe.com/xdm/context/identity` + + +## Push notification detail Example +```json +{ + "xdm:appID": "75eafb7e-fa44-4514-86fc-221e32c5aef9", + "xdm:token": "99156313-c9df-4e54-9c6c-5740f940c3ca", + "xdm:platform": "apns", + "xdm:blocklisted": false, + "xdm:identity": { + "xdm:namespace": { + "xdm:code": "ECID" + }, + "xdm:xid": "92312748749128" + } +} +``` + +# Push notification detail Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:appID](#xdmappid) | `string` | Optional | Push notification detail (this schema) | +| [xdm:blacklisted](#xdmblacklisted) | `boolean` | Optional | Push notification detail (this schema) | +| [xdm:blocklisted](#xdmblocklisted) | `boolean` | Optional | Push notification detail (this schema) | +| [xdm:identity](#xdmidentity) | Identity | Optional | Push notification detail (this schema) | +| [xdm:identiy](#xdmidentiy) | Identity | Optional | Push notification detail (this schema) | +| [xdm:platform](#xdmplatform) | `string` | Optional | Push notification detail (this schema) | +| [xdm:token](#xdmtoken) | `string` | Optional | Push notification detail (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:appID +### Application Identifier + +Unique Identifier for the mobile application. + +`xdm:appID` +* is optional +* type: `string` +* defined in this schema + +### xdm:appID Type + + +`string` + + + + + + +## xdm:blacklisted +### Blacklist Flag + +Indicates whether the push token is blacklisted. Deprecated due to new guidance on key names, use blocklisted instead. + +`xdm:blacklisted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:blacklisted Type + + +`boolean` + + + + + +## xdm:blocklisted +### Blocklist Flag + +Indicates whether the push token is blocked by the push provider. + +`xdm:blocklisted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:blocklisted Type + + +`boolean` + + + + + +## xdm:identity +### Identity associated with this token + +The identity associated with this token before profile stitching. + +`xdm:identity` +* is optional +* type: Identity +* defined in this schema + +### xdm:identity Type + + +* [Identity](identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + + +## xdm:identiy +### Identity associated with this token + +The identity associated with this token before profile stitching. Deprecated due to typo, use xdm:identity instead. + +`xdm:identiy` +* is optional +* type: Identity +* defined in this schema + +### xdm:identiy Type + + +* [Identity](identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + + +## xdm:platform +### Push Platform + +Push provider, e.g. apns or fcm + +`xdm:platform` +* is optional +* type: `string` +* defined in this schema + +### xdm:platform Type + + +`string` + + + + + + +## xdm:token +### Push Token + +Valid push token for the given push platform. + +`xdm:token` +* is optional +* type: `string` +* defined in this schema + +### xdm:token Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/pushnotificationtoken.schema.json b/docs/reference/datatypes/pushnotificationtoken.schema.json new file mode 100644 index 000000000..abf546109 --- /dev/null +++ b/docs/reference/datatypes/pushnotificationtoken.schema.json @@ -0,0 +1,110 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/pushnotificationtoken", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Push notification token", + "type": "object", + "meta:extensible": true, + "description": "Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts. Examples include mobile application notifications over notification services like the Apple Push Notification service.", + "definitions": { + "pushnotificationtoken": { + "properties": { + "xdm:token": { + "title": "Token", + "type": "string", + "description": "The service specific token used to address the application for communication for example, an Apple APN ID or a Google GCM ID." + }, + "xdm:registrationDate": { + "title": "Registration date", + "type": "string", + "format": "date-time", + "description": "Date and time when the profile has authorized the application to receive push notifications." + }, + "xdm:deregistrationDate": { + "title": "De-registration date", + "type": "string", + "format": "date-time", + "description": "Date and time when the profile has disabled push notifications on the application." + }, + "xdm:environment": { + "title": "Environment", + "$ref": "https://ns.adobe.com/xdm/context/environment", + "description": "Environment of at the time of the registration." + }, + "xdm:device": { + "title": "Device", + "$ref": "https://ns.adobe.com/xdm/context/device", + "description": "The device originating the registration." + }, + "xdm:application": { + "title": "Application", + "$ref": "https://ns.adobe.com/xdm/context/application", + "description": "Application registered to receive push notifications." + }, + "xdm:channel": { + "title": "Communication channel", + "$ref": "https://ns.adobe.com/xdm/channels/channel", + "description": "Channels for communicating with customers or users." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/pushnotificationtoken" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:token": "ABC123DEFG", + "xdm:registrationDate": "2017-09-26T15:52:25+00:00", + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 600, + "xdm:viewportWidth": 300 + }, + "xdm:operatingSystem": "iOS", + "xdm:operatingSystemVersion": "11.2.1", + "xdm:connectionType": "mobile" + }, + "xdm:device": { + "xdm:typeId": "TypeIdentifier-111", + "xdm:typeIdService": "deviceAtlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216 + }, + "xdm:application": { + "xdm:id": "Abc123", + "xdm:name": "facebook", + "xdm:version": "153.0" + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/facebook-feed", + "@type": "https://ns.adobe.com/xdm/channel-types/social" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/pushnotificationtoken.schema.md b/docs/reference/datatypes/pushnotificationtoken.schema.md new file mode 100644 index 000000000..28e490786 --- /dev/null +++ b/docs/reference/datatypes/pushnotificationtoken.schema.md @@ -0,0 +1,218 @@ + +# Push notification token Schema + +``` +https://ns.adobe.com/xdm/context/pushnotificationtoken +``` + +Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts. Examples include mobile application notifications over notification services like the Apple Push Notification service. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/pushnotificationtoken.schema.json](datatypes/pushnotificationtoken.schema.json) | +## Schema Hierarchy + +* Push notification token `https://ns.adobe.com/xdm/context/pushnotificationtoken` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Environment](environment.schema.md) `https://ns.adobe.com/xdm/context/environment` + * [Device](device.schema.md) `https://ns.adobe.com/xdm/context/device` + * [Application](application.schema.md) `https://ns.adobe.com/xdm/context/application` + * [Experience Channel](channels/channel.schema.md) `https://ns.adobe.com/xdm/channels/channel` + + +## Push notification token Example +```json +{ + "xdm:token": "ABC123DEFG", + "xdm:registrationDate": "2017-09-26T15:52:25+00:00", + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 600, + "xdm:viewportWidth": 300 + }, + "xdm:operatingSystem": "iOS", + "xdm:operatingSystemVersion": "11.2.1", + "xdm:connectionType": "mobile" + }, + "xdm:device": { + "xdm:typeId": "TypeIdentifier-111", + "xdm:typeIdService": "deviceAtlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216 + }, + "xdm:application": { + "xdm:id": "Abc123", + "xdm:name": "facebook", + "xdm:version": "153.0" + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/facebook-feed", + "@type": "https://ns.adobe.com/xdm/channel-types/social" + } +} +``` + +# Push notification token Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:application](#xdmapplication) | Application | Optional | Push notification token (this schema) | +| [xdm:channel](#xdmchannel) | Experience Channel | Optional | Push notification token (this schema) | +| [xdm:deregistrationDate](#xdmderegistrationdate) | `string` | Optional | Push notification token (this schema) | +| [xdm:device](#xdmdevice) | Device | Optional | Push notification token (this schema) | +| [xdm:environment](#xdmenvironment) | Environment | Optional | Push notification token (this schema) | +| [xdm:registrationDate](#xdmregistrationdate) | `string` | Optional | Push notification token (this schema) | +| [xdm:token](#xdmtoken) | `string` | Optional | Push notification token (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:application +### Application + +Application registered to receive push notifications. + +`xdm:application` +* is optional +* type: Application +* defined in this schema + +### xdm:application Type + + +* [Application](application.schema.md) – `https://ns.adobe.com/xdm/context/application` + + + + + +## xdm:channel +### Communication channel + +Channels for communicating with customers or users. + +`xdm:channel` +* is optional +* type: Experience Channel +* defined in this schema + +### xdm:channel Type + + +* [Experience Channel](channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel` + + + + + +## xdm:deregistrationDate +### De-registration date + +Date and time when the profile has disabled push notifications on the application. + +`xdm:deregistrationDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:deregistrationDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:device +### Device + +The device originating the registration. + +`xdm:device` +* is optional +* type: Device +* defined in this schema + +### xdm:device Type + + +* [Device](device.schema.md) – `https://ns.adobe.com/xdm/context/device` + + + + + +## xdm:environment +### Environment + +Environment of at the time of the registration. + +`xdm:environment` +* is optional +* type: Environment +* defined in this schema + +### xdm:environment Type + + +* [Environment](environment.schema.md) – `https://ns.adobe.com/xdm/context/environment` + + + + + +## xdm:registrationDate +### Registration date + +Date and time when the profile has authorized the application to receive push notifications. + +`xdm:registrationDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:registrationDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:token +### Token + +The service specific token used to address the application for communication for example, an Apple APN ID or a Google GCM ID. + +`xdm:token` +* is optional +* type: `string` +* defined in this schema + +### xdm:token Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/search.schema.json b/docs/reference/datatypes/search.schema.json new file mode 100644 index 000000000..d48cc5f23 --- /dev/null +++ b/docs/reference/datatypes/search.schema.json @@ -0,0 +1,78 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/search", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Search", + "type": "object", + "meta:extensible": true, + "description": "Information about web search activity.", + "definitions": { + "search": { + "properties": { + "xdm:searchEngine": { + "title": "Search engine", + "type": "string", + "description": "The search engine used by the search." + }, + "xdm:searchEngineID": { + "title": "Search engine ID", + "type": "string", + "format": "uri", + "description": "The application specified identifier used to identify the search engine used by the search." + }, + "xdm:keywords": { + "title": "Keywords", + "type": "string", + "description": "Keywords for the search." + }, + "xdm:isPaid": { + "title": "Is paid", + "type": "boolean", + "description": "Indicate if the search is paid or not." + }, + "xdm:pageDepth": { + "title": "Page depth", + "type": "integer", + "description": "Page depth in the search results." + }, + "xdm:slot": { + "title": "Page slot", + "type": "string", + "description": "Named section of the page where the search result appeared, for example, top or side.", + "meta:enum": { + "top": "Top of the page", + "side": "Side of the page" + } + }, + "xdm:position": { + "title": "Listing position", + "type": "integer", + "description": "Position or rank of the listing in the search result page." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/search" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:searchEngine": "Google", + "xdm:searchEngineID": "https://ns.adobe.com/searchengines/3", + "xdm:keywords": "rice cooker", + "xdm:isPaid": true, + "xdm:pageDepth": 1 + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/search.schema.md b/docs/reference/datatypes/search.schema.md new file mode 100644 index 000000000..ad9495b14 --- /dev/null +++ b/docs/reference/datatypes/search.schema.md @@ -0,0 +1,187 @@ + +# Search Schema + +``` +https://ns.adobe.com/xdm/context/search +``` + +Information about web search activity. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/search.schema.json](datatypes/search.schema.json) | +## Schema Hierarchy + +* Search `https://ns.adobe.com/xdm/context/search` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Search Example +```json +{ + "xdm:searchEngine": "Google", + "xdm:searchEngineID": "https://ns.adobe.com/searchengines/3", + "xdm:keywords": "rice cooker", + "xdm:isPaid": true, + "xdm:pageDepth": 1 +} +``` + +# Search Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:isPaid](#xdmispaid) | `boolean` | Optional | Search (this schema) | +| [xdm:keywords](#xdmkeywords) | `string` | Optional | Search (this schema) | +| [xdm:pageDepth](#xdmpagedepth) | `integer` | Optional | Search (this schema) | +| [xdm:position](#xdmposition) | `integer` | Optional | Search (this schema) | +| [xdm:searchEngine](#xdmsearchengine) | `string` | Optional | Search (this schema) | +| [xdm:searchEngineID](#xdmsearchengineid) | `string` | Optional | Search (this schema) | +| [xdm:slot](#xdmslot) | `string` | Optional | Search (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:isPaid +### Is paid + +Indicate if the search is paid or not. + +`xdm:isPaid` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isPaid Type + + +`boolean` + + + + + +## xdm:keywords +### Keywords + +Keywords for the search. + +`xdm:keywords` +* is optional +* type: `string` +* defined in this schema + +### xdm:keywords Type + + +`string` + + + + + + +## xdm:pageDepth +### Page depth + +Page depth in the search results. + +`xdm:pageDepth` +* is optional +* type: `integer` +* defined in this schema + +### xdm:pageDepth Type + + +`integer` + + + + + + +## xdm:position +### Listing position + +Position or rank of the listing in the search result page. + +`xdm:position` +* is optional +* type: `integer` +* defined in this schema + +### xdm:position Type + + +`integer` + + + + + + +## xdm:searchEngine +### Search engine + +The search engine used by the search. + +`xdm:searchEngine` +* is optional +* type: `string` +* defined in this schema + +### xdm:searchEngine Type + + +`string` + + + + + + +## xdm:searchEngineID +### Search engine ID + +The application specified identifier used to identify the search engine used by the search. + +`xdm:searchEngineID` +* is optional +* type: `string` +* defined in this schema + +### xdm:searchEngineID Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:slot +### Page slot + +Named section of the page where the search result appeared, for example, top or side. + +`xdm:slot` +* is optional +* type: `string` +* defined in this schema + +### xdm:slot Type + + +`string` + + + +### xdm:slot Known Values +| Value | Description | +|-------|-------------| +| `top` | Top of the page | +| `side` | Side of the page | + + + diff --git a/docs/reference/datatypes/segmentidentity.schema.json b/docs/reference/datatypes/segmentidentity.schema.json new file mode 100644 index 000000000..40b28ff09 --- /dev/null +++ b/docs/reference/datatypes/segmentidentity.schema.json @@ -0,0 +1,49 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/segmentidentity", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment identity", + "type": "object", + "description": "Segment identity is used to clearly distinguish segments from multiple sources. Segment identity is established by an segment identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the segment identity is unique.", + "definitions": { + "segmentIdentity": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "Identity of the segment in the related namespace." + }, + "xdm:namespace": { + "title": "Namespace", + "$ref": "https://ns.adobe.com/xdm/context/namespace", + "description": "The namespace associated with the `xid` attribute." + }, + "xdm:xid": { + "title": "Experience identifier", + "type": "string", + "description": "When present, this value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces." + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/segmentIdentity" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/entities/segmentIdentity/id123", + "xdm:namespace": { + "xdm:code": "AA12345" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/segmentidentity.schema.md b/docs/reference/datatypes/segmentidentity.schema.md new file mode 100644 index 000000000..c861e6344 --- /dev/null +++ b/docs/reference/datatypes/segmentidentity.schema.md @@ -0,0 +1,96 @@ + +# Segment identity Schema + +``` +https://ns.adobe.com/xdm/context/segmentidentity +``` + +Segment identity is used to clearly distinguish segments from multiple sources. Segment identity is established by an segment identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the segment identity is unique. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/segmentidentity.schema.json](datatypes/segmentidentity.schema.json) | +## Schema Hierarchy + +* Segment identity `https://ns.adobe.com/xdm/context/segmentidentity` + * [Namespace](namespace.schema.md) `https://ns.adobe.com/xdm/context/namespace` + + +## Segment identity Example +```json +{ + "@id": "https://data.adobe.io/entities/segmentIdentity/id123", + "xdm:namespace": { + "xdm:code": "AA12345" + } +} +``` + +# Segment identity Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Segment identity (this schema) | +| [xdm:namespace](#xdmnamespace) | Namespace | Optional | Segment identity (this schema) | +| [xdm:xid](#xdmxid) | `string` | Optional | Segment identity (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +Identity of the segment in the related namespace. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:namespace +### Namespace + +The namespace associated with the `xid` attribute. + +`xdm:namespace` +* is optional +* type: Namespace +* defined in this schema + +### xdm:namespace Type + + +* [Namespace](namespace.schema.md) – `https://ns.adobe.com/xdm/context/namespace` + + + + + +## xdm:xid +### Experience identifier + +When present, this value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces. + +`xdm:xid` +* is optional +* type: `string` +* defined in this schema + +### xdm:xid Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/segmentmembership.schema.json b/docs/reference/datatypes/segmentmembership.schema.json new file mode 100644 index 000000000..e57c29173 --- /dev/null +++ b/docs/reference/datatypes/segmentmembership.schema.json @@ -0,0 +1,128 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/segmentmembership", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment membership", + "type": "object", + "description": "Details about a segment membership.", + "definitions": { + "segmentMembership": { + "properties": { + "xdm:segmentID": { + "title": "Segment ID", + "meta:status": "deprecated", + "$ref": "https://ns.adobe.com/xdm/context/segmentidentity", + "description": "The identity of the segment or snapshot definition in with the domain of the specific system that processes that type of segment. Deprecated." + }, + "xdm:version": { + "title": "Version", + "type": "string", + "description": "The version of the segment definition used in this segment assertion. Version can be omitted in audience lists when all memberships versions are the same." + }, + "xdm:lastQualificationTime": { + "title": "Last qualification time", + "type": "string", + "format": "date-time", + "description": "The timestamp when the assertion of segment membership was made." + }, + "xdm:payload": { + "title": "Payload", + "description": "Values that are directly related with the segment realization. This payload exists with the same 'validUntil' as the segment realization. Note that the intention is that exactly one payload value be included, as indicated by the payload type. This was originally modeled using 'oneOf', but due to limitations in our tooling that was removed. This more semantically meaningful representation will be re-introduced in the future.", + "type": "object", + "properties": { + "xdm:payloadBooleanValue": { + "title": "Value", + "type": "boolean", + "description": "The boolean value." + }, + "xdm:payloadNumberValue": { + "title": "Value", + "type": "number", + "description": "The number." + }, + "xdm:payloadPropensityValue": { + "title": "Value", + "type": "number", + "description": "The propensity.", + "exclusiveMinimum": 0, + "maximum": 1 + }, + "xdm:payloadStringValue": { + "title": "Value", + "type": "string", + "description": "The string value." + }, + "xdm:payloadType": { + "title": "Payload Type", + "type": "string", + "enum": [ + "boolean", + "number", + "propensity", + "string" + ], + "meta:enum": { + "boolean": "Boolean", + "number": "Number", + "propensity": "Propensity", + "string": "String" + }, + "description": "The type of payload." + } + }, + "required": [ + "xdm:payloadType" + ] + }, + "xdm:validUntil": { + "title": "Valid until", + "type": "string", + "format": "date-time", + "description": "The timestamp for when the segment assertion should no longer be assumed to be valid and should either be ignored or revalidated." + }, + "xdm:status": { + "title": "Status", + "type": "string", + "description": "Is the segment participation realized as part of the current request.", + "default": "realized", + "enum": [ + "existing", + "realized", + "exited" + ], + "meta:enum": { + "existing": "Entity continues to be in the segment.", + "realized": "Entity is entering the segment.", + "exited": "Entity is exiting the segment." + } + }, + "xdm:profileStitchID": { + "$ref": "https://ns.adobe.com/xdm/context/profileStitchIdentity" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/segmentMembership" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:version": "1.0", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "realized", + "xdm:payload": { + "xdm:payloadPropensityValue": 0.5, + "xdm:payloadType": "propensity" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/segmentmembership.schema.md b/docs/reference/datatypes/segmentmembership.schema.md new file mode 100644 index 000000000..f6fa749fb --- /dev/null +++ b/docs/reference/datatypes/segmentmembership.schema.md @@ -0,0 +1,302 @@ + +# Segment membership Schema + +``` +https://ns.adobe.com/xdm/context/segmentmembership +``` + +Details about a segment membership. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/segmentmembership.schema.json](datatypes/segmentmembership.schema.json) | +## Schema Hierarchy + +* Segment membership `https://ns.adobe.com/xdm/context/segmentmembership` + * [Segment identity](segmentidentity.schema.md) `https://ns.adobe.com/xdm/context/segmentidentity` + * [Profile stitch identity](profilestitchidentity.schema.md) `https://ns.adobe.com/xdm/context/profileStitchIdentity` + + +## Segment membership Example +```json +{ + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:version": "1.0", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "realized", + "xdm:payload": { + "xdm:payloadPropensityValue": 0.5, + "xdm:payloadType": "propensity" + } +} +``` + +# Segment membership Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:lastQualificationTime](#xdmlastqualificationtime) | `string` | Optional | | Segment membership (this schema) | +| [xdm:payload](#xdmpayload) | `object` | Optional | | Segment membership (this schema) | +| [xdm:profileStitchID](#xdmprofilestitchid) | Profile stitch identity | Optional | | Segment membership (this schema) | +| [xdm:segmentID](#xdmsegmentid) | Segment identity | Optional | | Segment membership (this schema) | +| [xdm:status](#xdmstatus) | `enum` | Optional | `"realized"` | Segment membership (this schema) | +| [xdm:validUntil](#xdmvaliduntil) | `string` | Optional | | Segment membership (this schema) | +| [xdm:version](#xdmversion) | `string` | Optional | | Segment membership (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:lastQualificationTime +### Last qualification time + +The timestamp when the assertion of segment membership was made. + +`xdm:lastQualificationTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:lastQualificationTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:payload +### Payload + +Values that are directly related with the segment realization. This payload exists with the same 'validUntil' as the segment realization. Note that the intention is that exactly one payload value be included, as indicated by the payload type. This was originally modeled using 'oneOf', but due to limitations in our tooling that was removed. This more semantically meaningful representation will be re-introduced in the future. + +`xdm:payload` +* is optional +* type: `object` +* defined in this schema + +### xdm:payload Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:payloadBooleanValue`| boolean | Optional | +| `xdm:payloadNumberValue`| number | Optional | +| `xdm:payloadPropensityValue`| number | Optional | +| `xdm:payloadStringValue`| string | Optional | +| `xdm:payloadType`| string | **Required** | + + + +#### xdm:payloadBooleanValue +##### Value + +The boolean value. + +`xdm:payloadBooleanValue` +* is optional +* type: `boolean` + +##### xdm:payloadBooleanValue Type + + +`boolean` + + + + + + + +#### xdm:payloadNumberValue +##### Value + +The number. + +`xdm:payloadNumberValue` +* is optional +* type: `number` + +##### xdm:payloadNumberValue Type + + +`number` + + + + + + + + +#### xdm:payloadPropensityValue +##### Value + +The propensity. + +`xdm:payloadPropensityValue` +* is optional +* type: `number` + +##### xdm:payloadPropensityValue Type + + +`number` +* maximum value: `1` + + + + + + + +#### xdm:payloadStringValue +##### Value + +The string value. + +`xdm:payloadStringValue` +* is optional +* type: `string` + +##### xdm:payloadStringValue Type + + +`string` + + + + + + + + +#### xdm:payloadType +##### Payload Type + +The type of payload. + +`xdm:payloadType` +* is **required** +* type: `enum` + +The value of this property **must** be equal to one of the [known values below](#xdmpayload-known-values). + +##### xdm:payloadType Known Values +| Value | Description | +|-------|-------------| +| `boolean` | Boolean | +| `number` | Number | +| `propensity` | Propensity | +| `string` | String | + + + + + + + + + +## xdm:profileStitchID + + +`xdm:profileStitchID` +* is optional +* type: Profile stitch identity +* defined in this schema + +### xdm:profileStitchID Type + + +* [Profile stitch identity](profilestitchidentity.schema.md) – `https://ns.adobe.com/xdm/context/profileStitchIdentity` + + + + + +## xdm:segmentID +### Segment ID + +The identity of the segment or snapshot definition in with the domain of the specific system that processes that type of segment. Deprecated. + +`xdm:segmentID` +* is optional +* type: Segment identity +* defined in this schema + +### xdm:segmentID Type + + +* [Segment identity](segmentidentity.schema.md) – `https://ns.adobe.com/xdm/context/segmentidentity` + + + + + +## xdm:status +### Status + +Is the segment participation realized as part of the current request. + +`xdm:status` +* is optional +* type: `enum` +* default: `"realized"` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmstatus-known-values). + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `existing` | Entity continues to be in the segment. | +| `realized` | Entity is entering the segment. | +| `exited` | Entity is exiting the segment. | + + + + +## xdm:validUntil +### Valid until + +The timestamp for when the segment assertion should no longer be assumed to be valid and should either be ignored or revalidated. + +`xdm:validUntil` +* is optional +* type: `string` +* defined in this schema + +### xdm:validUntil Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:version +### Version + +The version of the segment definition used in this segment assertion. Version can be omitted in audience lists when all memberships versions are the same. + +`xdm:version` +* is optional +* type: `string` +* defined in this schema + +### xdm:version Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/segmentmembershipitem.schema.json b/docs/reference/datatypes/segmentmembershipitem.schema.json new file mode 100644 index 000000000..21f7cd418 --- /dev/null +++ b/docs/reference/datatypes/segmentmembershipitem.schema.json @@ -0,0 +1,51 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/segmentmembershipitem", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment membership item", + "type": "object", + "description": "List item that contains details of segment membership combined the profile stitched identities to which the membership applies.", + "definitions": { + "membershipIdentities": { + "properties": { + "xdm:profileStitchID": { + "$ref": "https://ns.adobe.com/xdm/context/profileStitchIdentity" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/segmentmembership" + }, + { + "$ref": "#/definitions/membershipIdentities" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + }, + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:version": "1.0", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "realized" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/segmentmembershipitem.schema.md b/docs/reference/datatypes/segmentmembershipitem.schema.md new file mode 100644 index 000000000..de96155ac --- /dev/null +++ b/docs/reference/datatypes/segmentmembershipitem.schema.md @@ -0,0 +1,310 @@ + +# Segment membership item Schema + +``` +https://ns.adobe.com/xdm/context/segmentmembershipitem +``` + +List item that contains details of segment membership combined the profile stitched identities to which the membership applies. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/segmentmembershipitem.schema.json](datatypes/segmentmembershipitem.schema.json) | +## Schema Hierarchy + +* Segment membership item `https://ns.adobe.com/xdm/context/segmentmembershipitem` + * [Segment membership](segmentmembership.schema.md) `https://ns.adobe.com/xdm/context/segmentmembership` + * [Profile stitch identity](profilestitchidentity.schema.md) `https://ns.adobe.com/xdm/context/profileStitchIdentity` + + +## Segment membership item Example +```json +{ + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + }, + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:version": "1.0", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "realized" + } +} +``` + +# Segment membership item Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:lastQualificationTime](#xdmlastqualificationtime) | `string` | Optional | | [Segment membership](segmentmembership.schema.md#xdmlastqualificationtime) | +| [xdm:payload](#xdmpayload) | `object` | Optional | | [Segment membership](segmentmembership.schema.md#xdmpayload) | +| [xdm:profileStitchID](#xdmprofilestitchid) | Profile stitch identity | Optional | | [Segment membership](segmentmembership.schema.md#xdmprofilestitchid) | +| [xdm:segmentID](#xdmsegmentid) | Segment identity | Optional | | [Segment membership](segmentmembership.schema.md#xdmsegmentid) | +| [xdm:status](#xdmstatus) | `enum` | Optional | `"realized"` | [Segment membership](segmentmembership.schema.md#xdmstatus) | +| [xdm:validUntil](#xdmvaliduntil) | `string` | Optional | | [Segment membership](segmentmembership.schema.md#xdmvaliduntil) | +| [xdm:version](#xdmversion) | `string` | Optional | | [Segment membership](segmentmembership.schema.md#xdmversion) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:lastQualificationTime +### Last qualification time + +The timestamp when the assertion of segment membership was made. + +`xdm:lastQualificationTime` +* is optional +* type: `string` +* defined in [Segment membership](segmentmembership.schema.md#xdmlastqualificationtime) + +### xdm:lastQualificationTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:payload +### Payload + +Values that are directly related with the segment realization. This payload exists with the same 'validUntil' as the segment realization. Note that the intention is that exactly one payload value be included, as indicated by the payload type. This was originally modeled using 'oneOf', but due to limitations in our tooling that was removed. This more semantically meaningful representation will be re-introduced in the future. + +`xdm:payload` +* is optional +* type: `object` +* defined in [Segment membership](segmentmembership.schema.md#xdmpayload) + +### xdm:payload Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:payloadBooleanValue`| boolean | Optional | +| `xdm:payloadNumberValue`| number | Optional | +| `xdm:payloadPropensityValue`| number | Optional | +| `xdm:payloadStringValue`| string | Optional | +| `xdm:payloadType`| string | **Required** | + + + +#### xdm:payloadBooleanValue +##### Value + +The boolean value. + +`xdm:payloadBooleanValue` +* is optional +* type: `boolean` + +##### xdm:payloadBooleanValue Type + + +`boolean` + + + + + + + +#### xdm:payloadNumberValue +##### Value + +The number. + +`xdm:payloadNumberValue` +* is optional +* type: `number` + +##### xdm:payloadNumberValue Type + + +`number` + + + + + + + + +#### xdm:payloadPropensityValue +##### Value + +The propensity. + +`xdm:payloadPropensityValue` +* is optional +* type: `number` + +##### xdm:payloadPropensityValue Type + + +`number` +* maximum value: `1` + + + + + + + +#### xdm:payloadStringValue +##### Value + +The string value. + +`xdm:payloadStringValue` +* is optional +* type: `string` + +##### xdm:payloadStringValue Type + + +`string` + + + + + + + + +#### xdm:payloadType +##### Payload Type + +The type of payload. + +`xdm:payloadType` +* is **required** +* type: `enum` + +The value of this property **must** be equal to one of the [known values below](#xdmpayload-known-values). + +##### xdm:payloadType Known Values +| Value | Description | +|-------|-------------| +| `boolean` | Boolean | +| `number` | Number | +| `propensity` | Propensity | +| `string` | String | + + + + + + + + + +## xdm:profileStitchID + + +`xdm:profileStitchID` +* is optional +* type: Profile stitch identity +* defined in [Segment membership](segmentmembership.schema.md#xdmprofilestitchid) + +### xdm:profileStitchID Type + + +* [Profile stitch identity](profilestitchidentity.schema.md) – `https://ns.adobe.com/xdm/context/profileStitchIdentity` + + + + + +## xdm:segmentID +### Segment ID + +The identity of the segment or snapshot definition in with the domain of the specific system that processes that type of segment. Deprecated. + +`xdm:segmentID` +* is optional +* type: Segment identity +* defined in [Segment membership](segmentmembership.schema.md#xdmsegmentid) + +### xdm:segmentID Type + + +* [Segment identity](segmentidentity.schema.md) – `https://ns.adobe.com/xdm/context/segmentidentity` + + + + + +## xdm:status +### Status + +Is the segment participation realized as part of the current request. + +`xdm:status` +* is optional +* type: `enum` +* default: `"realized"` +* defined in [Segment membership](segmentmembership.schema.md#xdmstatus) + +The value of this property **must** be equal to one of the [known values below](#xdmstatus-known-values). + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `existing` | Entity continues to be in the segment. | +| `realized` | Entity is entering the segment. | +| `exited` | Entity is exiting the segment. | + + + + +## xdm:validUntil +### Valid until + +The timestamp for when the segment assertion should no longer be assumed to be valid and should either be ignored or revalidated. + +`xdm:validUntil` +* is optional +* type: `string` +* defined in [Segment membership](segmentmembership.schema.md#xdmvaliduntil) + +### xdm:validUntil Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:version +### Version + +The version of the segment definition used in this segment assertion. Version can be omitted in audience lists when all memberships versions are the same. + +`xdm:version` +* is optional +* type: `string` +* defined in [Segment membership](segmentmembership.schema.md#xdmversion) + +### xdm:version Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/selfservice.schema.json b/docs/reference/datatypes/selfservice.schema.json new file mode 100644 index 000000000..f7c3b2e51 --- /dev/null +++ b/docs/reference/datatypes/selfservice.schema.json @@ -0,0 +1,162 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/common/selfservice", + "title": "Customer Managed Environment", + "description": "A customer managed environment is an environment that allows a system integration or deployer to manage applications. This is also known as self service.", + "type": "object", + "definitions": { + "selfservice": { + "properties": { + "xdm:tenant": { + "name": "Tenant", + "description": "A description of a customer having a agreement to use a specific set of services (see `xdm:service`). A tenant will typically have a URI which can be used to reference the tenant, and should be resolvable by an identity provider.", + "type": "string", + "format": "uri" + }, + "xdm:applicationOwner": { + "name": "Application Owner", + "description": "An application owner, distinct from a tenant (`xdm:tenant`), owns an application (see `xdm:application`) and manages its state. The application owner may be a individual user or roll. Typically the application owner will be a member of the tenant, however that is not a requirement.", + "type": "string", + "format": "uri" + }, + "xdm:application": { + "name": "Application", + "description": "A set of code, content, and data that together implement an experience. Some applications do not allow a system integrator, partner or customer to perform customization. Other applications may allow customization on a per instance basis. These may be applications managed by the system integrator, partner or customer. An application be defined by a URI referencing the definition of the application.", + "type": "string", + "format": "uri" + }, + "xdm:environment": { + "name": "Environment", + "description": "A tenant (see `xdm:tenant`) may work with 1..n environments where the application (see `xdm:application`) runs. Each environment serves a purpose in the CI/CD chain providing a structure whereby changes to the application can be rolled out. Typically the owner of the application manages transitions between environments. A system integrator, partner or customer may be the owner of the application especially where the application has been extended and customized. An environment may have a URI referencing the definition of the environment. ", + "type": "string", + "meta:enum": { + "dev": "A development environment for engineering teams to develop and test against prior to releasing to the QE teams.", + "qe": "A deployment provisioned to satisfy the quality engineering process.", + "stage": "A final deployment environment before production. Typically used to perform final testing and give a reference deployment to the last production deployment.", + "beta": "A production deployment environment used to introduce end-users of the `application` to new features.", + "prod": "The production deployment environment." + } + }, + "xdm:cluster": { + "name": "Cluster", + "description": "A group of instances deployed within a environment (see `xdm:environment` ) as part of a topology (see `xdm:topology`) that deliver a service within an application (see `xdm:application`) often using a single source of persistence. A topology may have one or more clusters (see `xdm:cluster`). A service (see `xdm:service`) is typically delivered by a single cluster. Members of the cluster are typically stateless and disposable, meaning they are created and destroyed to maintain a suitable cluster size to deliver the service against the agreed SLA. A cluster will have a URI referencing the definition of the cluster, including parameters defining its scaling behavior.", + "type": "string", + "format": "uri" + }, + "xdm:CICDPipeline": { + "name": "CI/CD Pipeline", + "description": "A continuous deployment continuous integration pipeline (xdm:CICDPipeline) is used to deploy an application (see `xdm:application`) conforming to a defined topology (see `xdm:topology`) into an environment (see `xdm:environment`). The pipeline runs a standard process that understands the defining of the topology, environment and application. The pipeline is a shared resource used by many applications and tenants (see `xdm:tenant`), although special tenants may have customized pipelines. A pipeline will have a URI which defines the API.", + "type": "string", + "format": "uri" + }, + "xdm:service": { + "name": "Service", + "description": "An application (see `xdm:application`) consists of one or more services, deployed into a topology (see `xdm:topology`) and implemented as a cluster (see `xdm:cluster`). The service will generally expose an API to consumers however that service may be private to the application. The implementation of a service my be changed without changing the specification of the service. A service will have a URI defining it.", + "type": "string", + "format": "uri" + }, + "xdm:topology": { + "name": "Topology", + "description": "A topology is a logical group of services (see `xdm:service`) and their implementations that together form an application (see `xdm:application`). The topology may consist of services and service implementations at different layers throughout an application. Some services within a topology may be satisfied by shared components, for instance many applications may share an edge traffic load balancer. A service will have a URI defining it.", + "type": "string", + "format": "uri" + }, + "xdm:codeRepository": { + "name": "Code Repository", + "description": "A code repository stores the application (see `xdm:application`) code and any definitions for topologies (see `xdm:topology`), services (see `xdm:service`), clusters (see `xdm:cluster`) and environments (see `(see `xdm:environment`). The CI/CD Pipeline (see `xdm:CICDPipeline`) will read the Code repository to perform integration and deploy the application.", + "type": "string", + "format": "uri" + }, + "xdm:provisioning": { + "name": "Provisioning", + "description": "Provisioning is the operation which sets up everything required to allow a tenant (see `xdm:tenant`) to deploy an application (see `xdm:application`). This includes setting up the Code Repository (see `xdm:codeRepository`), and allocating any resources that the CI/CD pipeline (see `xdm:CICDPipeline`) might require to deploy the application. Provisioning will ensure that any costs or charges are appropriately registered as being related to the tenant so that billing systems can ensure the tenant is billed. Where the infrastructure is dedicated to the tenant, provisioning will ensure that sufficient infrastructure is available when the first deployment (see `xdm:deployment`) is being performed. If the infrastructure is to be provisioned from a pool, provisioning will ensure that the pool is notified of the level of future demand. Provisioning will understand any legal or jurisdictional requirements and constraints that the tenant may have expressed in the contract and ensure that those requirements and constraints are satisfied.", + "type": "string", + "format": "uri" + }, + "xdm:deployment": { + "name": "Deployment", + "description": "Deployment is the final act of deploying an application (see `xdm:application`) into an environment (see `xdm:environment`) prior to going live in that environment. This should be achieved via an automated process working from specification and configuration stored in the codeRepository (see `xdm:codeRepository`). Some applications may require the installation of packages directly into a service (see `xdm:service`) or API provided by the application. Where this is the case the deployment process must be capable of supporting that style of deployment and must not make the application or any of its parts available to serve requests while the deployment is incomplete. The deployment process should include steps to validate that the deployment was successful. Deployment is not the same as provisioning (see `xdm:provisioning`), which is a pre-requisite for deployment. Typically a deployment will be performed every time changes in the code repository needs to be made available in the environment` Typically the deployment process is implemented by the CICDPipeline (see `xdm:CICDPipeline`).", + "type": "string", + "format": "uri" + }, + "xdm:artifact": { + "name": "Artifact", + "description": "An artifact is a package forming the implementation of a service (see `xdm:service`). It is is stored in the artifactRepository (see `xdm:artifactRepository`) published to the artifactRepository by the CICDPipeline (see `xdm:CICDPipeline`). An artifact has a version. Once an artifact with a version is published it becomes immutable. A version may be a unique string such as a SHA identifying a commit in a Git repository, or a semantic version number. Which is chosen depends on the preferred versioning mechanism.", + "type": "string", + "format": "uri" + }, + "xdm:artifactRepository": { + "name": "Artifact Repository", + "description": "An artifact repository stores released binaries including artifacts (see `xdm:artifact`) either from vendors or created by the CICDPipeline (see `xdm:CICDPipeline`). These artifacts are used by the deployment pipeline to deploy an application (see `xdm:application`) into an environment (see `xdm:environment`). The artifactRepository will allow many versions of an artifact to exist and will be organized in a way that will allow artifacts specific to a tenant (see `xdm:tenant`), application, topology (see `xdm:topology`) and environment to be stored. The artifact repository must not be used to store any sensitive data.", + "type": "string", + "format": "uri" + }, + "xdm:selfServiceAPI": { + "name": "Self Service API", + "description": "The self service API is a well defined API that will, using the model defined in XDM expose to a suitably authorized client a service implementation that allows that client to one or more applications (see `xdm:application`) within a tenant (see `xdm:tenant`). The API must maintain tenant boundaries, as defined and controlled by an identity provider.", + "type": "string", + "format": "uri" + }, + "xdm:selfServiceUI": { + "name": "Self Service UI", + "description": "A user interface or portal containing all the functionality of the selfServiceAPI (see `xdm:selfServiceAPI`) presented for use by a human in a web browser interface. Typically this UI will use the selfServiceAPI and be implemented as a browser application or SPA.", + "type": "string", + "format": "uri" + }, + "xdm:selfServiceBuild": { + "name": "Build", + "description": "The process by which the CICDPipeline (see `xdm:CICDPipeline`) creates a artifact (see `xdm:artifact`). How the build is performed and what the build creates depends on the source code stored in the codeRepository , which will also contain instructions to perform the build. In the case of a java artifact, the build would typically be performed by maven or gradle. In the case of a docker image, the build might be performed by make.", + "type": "string", + "format": "uri" + }, + "xdm:runningInstance": { + "name": "Instance", + "description": "An instance is 1 copy of a service (see `xdm:service`) implementation running within a cluster (see `xdm:cluster`) within a topology (see `xdm:topology`) deployed to an environment (see `xdm:environment`) as an application (see `xdm:application`) for a tenant (see `xdm:tenant`). Where the application is a java application, deployed to a provisioned virtual machine, the instance will be the java process, however where the application has been deployed as part of a container based application the instance will be the running container.", + "type": "string", + "format": "uri" + }, + "xdm:qualityGateState": { + "name": "Quality Gate", + "description": "The customer CICDPipeline (see `xdm:CICDPipeline`) defines a number of quality gates that will determine the success or fail of the entire process. If any Pass property being false indicates the quality gate has failed.", + "type": "object", + "properties": { + "*Pass": { + "type": "boolean", + "name": "*Pass", + "description": "A quality gate test, false means it failed, true means it passed." + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/selfservice" + }, + { + "required": [ + "id", + "xdm:tenant", + "xdm:application", + "xdm:environment" + ] + } + ], + "meta:status": "stable", + "examples": [ + { + "id": "urn:selfsevice:example1", + "xdm:tenant": "https://selfsevice.adobe.io/tenant/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", + "xdm:application": "http://git.corp.adobe.com/Applications/application1/definition.json", + "xdm:environment": "beta", + "xdm:selfServicePortal": "https://selfsevice.adobe.io/portal" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/selfservice.schema.md b/docs/reference/datatypes/selfservice.schema.md new file mode 100644 index 000000000..90c33bbd0 --- /dev/null +++ b/docs/reference/datatypes/selfservice.schema.md @@ -0,0 +1,438 @@ + +# Customer Managed Environment Schema + +``` +https://ns.adobe.com/xdm/common/selfservice +``` + +A customer managed environment is an environment that allows a system integration or deployer to manage applications. This is also known as self service. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/selfservice.schema.json](datatypes/selfservice.schema.json) | + +## Customer Managed Environment Example +```json +{ + "id": "urn:selfsevice:example1", + "xdm:tenant": "https://selfsevice.adobe.io/tenant/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", + "xdm:application": "http://git.corp.adobe.com/Applications/application1/definition.json", + "xdm:environment": "beta", + "xdm:selfServicePortal": "https://selfsevice.adobe.io/portal" +} +``` + +# Customer Managed Environment Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:CICDPipeline](#xdmcicdpipeline) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:application](#xdmapplication) | `string` | **Required** | Customer Managed Environment (this schema) | +| [xdm:applicationOwner](#xdmapplicationowner) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:artifact](#xdmartifact) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:artifactRepository](#xdmartifactrepository) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:cluster](#xdmcluster) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:codeRepository](#xdmcoderepository) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:deployment](#xdmdeployment) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:environment](#xdmenvironment) | `string` | **Required** | Customer Managed Environment (this schema) | +| [xdm:provisioning](#xdmprovisioning) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:qualityGateState](#xdmqualitygatestate) | `object` | Optional | Customer Managed Environment (this schema) | +| [xdm:runningInstance](#xdmrunninginstance) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:selfServiceAPI](#xdmselfserviceapi) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:selfServiceBuild](#xdmselfservicebuild) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:selfServiceUI](#xdmselfserviceui) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:service](#xdmservice) | `string` | Optional | Customer Managed Environment (this schema) | +| [xdm:tenant](#xdmtenant) | `string` | **Required** | Customer Managed Environment (this schema) | +| [xdm:topology](#xdmtopology) | `string` | Optional | Customer Managed Environment (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:CICDPipeline + +A continuous deployment continuous integration pipeline (xdm:CICDPipeline) is used to deploy an application (see `xdm:application`) conforming to a defined topology (see `xdm:topology`) into an environment (see `xdm:environment`). The pipeline runs a standard process that understands the defining of the topology, environment and application. The pipeline is a shared resource used by many applications and tenants (see `xdm:tenant`), although special tenants may have customized pipelines. A pipeline will have a URI which defines the API. + +`xdm:CICDPipeline` +* is optional +* type: `string` +* defined in this schema + +### xdm:CICDPipeline Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:application + +A set of code, content, and data that together implement an experience. Some applications do not allow a system integrator, partner or customer to perform customization. Other applications may allow customization on a per instance basis. These may be applications managed by the system integrator, partner or customer. An application be defined by a URI referencing the definition of the application. + +`xdm:application` +* is **required** +* type: `string` +* defined in this schema + +### xdm:application Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:applicationOwner + +An application owner, distinct from a tenant (`xdm:tenant`), owns an application (see `xdm:application`) and manages its state. The application owner may be a individual user or roll. Typically the application owner will be a member of the tenant, however that is not a requirement. + +`xdm:applicationOwner` +* is optional +* type: `string` +* defined in this schema + +### xdm:applicationOwner Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:artifact + +An artifact is a package forming the implementation of a service (see `xdm:service`). It is is stored in the artifactRepository (see `xdm:artifactRepository`) published to the artifactRepository by the CICDPipeline (see `xdm:CICDPipeline`). An artifact has a version. Once an artifact with a version is published it becomes immutable. A version may be a unique string such as a SHA identifying a commit in a Git repository, or a semantic version number. Which is chosen depends on the preferred versioning mechanism. + +`xdm:artifact` +* is optional +* type: `string` +* defined in this schema + +### xdm:artifact Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:artifactRepository + +An artifact repository stores released binaries including artifacts (see `xdm:artifact`) either from vendors or created by the CICDPipeline (see `xdm:CICDPipeline`). These artifacts are used by the deployment pipeline to deploy an application (see `xdm:application`) into an environment (see `xdm:environment`). The artifactRepository will allow many versions of an artifact to exist and will be organized in a way that will allow artifacts specific to a tenant (see `xdm:tenant`), application, topology (see `xdm:topology`) and environment to be stored. The artifact repository must not be used to store any sensitive data. + +`xdm:artifactRepository` +* is optional +* type: `string` +* defined in this schema + +### xdm:artifactRepository Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:cluster + +A group of instances deployed within a environment (see `xdm:environment` ) as part of a topology (see `xdm:topology`) that deliver a service within an application (see `xdm:application`) often using a single source of persistence. A topology may have one or more clusters (see `xdm:cluster`). A service (see `xdm:service`) is typically delivered by a single cluster. Members of the cluster are typically stateless and disposable, meaning they are created and destroyed to maintain a suitable cluster size to deliver the service against the agreed SLA. A cluster will have a URI referencing the definition of the cluster, including parameters defining its scaling behavior. + +`xdm:cluster` +* is optional +* type: `string` +* defined in this schema + +### xdm:cluster Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:codeRepository + +A code repository stores the application (see `xdm:application`) code and any definitions for topologies (see `xdm:topology`), services (see `xdm:service`), clusters (see `xdm:cluster`) and environments (see `(see `xdm:environment`). The CI/CD Pipeline (see `xdm:CICDPipeline`) will read the Code repository to perform integration and deploy the application. + +`xdm:codeRepository` +* is optional +* type: `string` +* defined in this schema + +### xdm:codeRepository Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:deployment + +Deployment is the final act of deploying an application (see `xdm:application`) into an environment (see `xdm:environment`) prior to going live in that environment. This should be achieved via an automated process working from specification and configuration stored in the codeRepository (see `xdm:codeRepository`). Some applications may require the installation of packages directly into a service (see `xdm:service`) or API provided by the application. Where this is the case the deployment process must be capable of supporting that style of deployment and must not make the application or any of its parts available to serve requests while the deployment is incomplete. The deployment process should include steps to validate that the deployment was successful. Deployment is not the same as provisioning (see `xdm:provisioning`), which is a pre-requisite for deployment. Typically a deployment will be performed every time changes in the code repository needs to be made available in the environment` Typically the deployment process is implemented by the CICDPipeline (see `xdm:CICDPipeline`). + +`xdm:deployment` +* is optional +* type: `string` +* defined in this schema + +### xdm:deployment Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:environment + +A tenant (see `xdm:tenant`) may work with 1..n environments where the application (see `xdm:application`) runs. Each environment serves a purpose in the CI/CD chain providing a structure whereby changes to the application can be rolled out. Typically the owner of the application manages transitions between environments. A system integrator, partner or customer may be the owner of the application especially where the application has been extended and customized. An environment may have a URI referencing the definition of the environment. + +`xdm:environment` +* is **required** +* type: `string` +* defined in this schema + +### xdm:environment Type + + +`string` + + + +### xdm:environment Known Values +| Value | Description | +|-------|-------------| +| `dev` | A development environment for engineering teams to develop and test against prior to releasing to the QE teams. | +| `qe` | A deployment provisioned to satisfy the quality engineering process. | +| `stage` | A final deployment environment before production. Typically used to perform final testing and give a reference deployment to the last production deployment. | +| `beta` | A production deployment environment used to introduce end-users of the `application` to new features. | +| `prod` | The production deployment environment. | + + + + +## xdm:provisioning + +Provisioning is the operation which sets up everything required to allow a tenant (see `xdm:tenant`) to deploy an application (see `xdm:application`). This includes setting up the Code Repository (see `xdm:codeRepository`), and allocating any resources that the CI/CD pipeline (see `xdm:CICDPipeline`) might require to deploy the application. Provisioning will ensure that any costs or charges are appropriately registered as being related to the tenant so that billing systems can ensure the tenant is billed. Where the infrastructure is dedicated to the tenant, provisioning will ensure that sufficient infrastructure is available when the first deployment (see `xdm:deployment`) is being performed. If the infrastructure is to be provisioned from a pool, provisioning will ensure that the pool is notified of the level of future demand. Provisioning will understand any legal or jurisdictional requirements and constraints that the tenant may have expressed in the contract and ensure that those requirements and constraints are satisfied. + +`xdm:provisioning` +* is optional +* type: `string` +* defined in this schema + +### xdm:provisioning Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:qualityGateState + +The customer CICDPipeline (see `xdm:CICDPipeline`) defines a number of quality gates that will determine the success or fail of the entire process. If any Pass property being false indicates the quality gate has failed. + +`xdm:qualityGateState` +* is optional +* type: `object` +* defined in this schema + +### xdm:qualityGateState Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `*Pass`| boolean | Optional | + + + +#### *Pass + +A quality gate test, false means it failed, true means it passed. + +`*Pass` +* is optional +* type: `boolean` + +##### *Pass Type + + +`boolean` + + + + + + + + + + +## xdm:runningInstance + +An instance is 1 copy of a service (see `xdm:service`) implementation running within a cluster (see `xdm:cluster`) within a topology (see `xdm:topology`) deployed to an environment (see `xdm:environment`) as an application (see `xdm:application`) for a tenant (see `xdm:tenant`). Where the application is a java application, deployed to a provisioned virtual machine, the instance will be the java process, however where the application has been deployed as part of a container based application the instance will be the running container. + +`xdm:runningInstance` +* is optional +* type: `string` +* defined in this schema + +### xdm:runningInstance Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:selfServiceAPI + +The self service API is a well defined API that will, using the model defined in XDM expose to a suitably authorized client a service implementation that allows that client to one or more applications (see `xdm:application`) within a tenant (see `xdm:tenant`). The API must maintain tenant boundaries, as defined and controlled by an identity provider. + +`xdm:selfServiceAPI` +* is optional +* type: `string` +* defined in this schema + +### xdm:selfServiceAPI Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:selfServiceBuild + +The process by which the CICDPipeline (see `xdm:CICDPipeline`) creates a artifact (see `xdm:artifact`). How the build is performed and what the build creates depends on the source code stored in the codeRepository , which will also contain instructions to perform the build. In the case of a java artifact, the build would typically be performed by maven or gradle. In the case of a docker image, the build might be performed by make. + +`xdm:selfServiceBuild` +* is optional +* type: `string` +* defined in this schema + +### xdm:selfServiceBuild Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:selfServiceUI + +A user interface or portal containing all the functionality of the selfServiceAPI (see `xdm:selfServiceAPI`) presented for use by a human in a web browser interface. Typically this UI will use the selfServiceAPI and be implemented as a browser application or SPA. + +`xdm:selfServiceUI` +* is optional +* type: `string` +* defined in this schema + +### xdm:selfServiceUI Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:service + +An application (see `xdm:application`) consists of one or more services, deployed into a topology (see `xdm:topology`) and implemented as a cluster (see `xdm:cluster`). The service will generally expose an API to consumers however that service may be private to the application. The implementation of a service my be changed without changing the specification of the service. A service will have a URI defining it. + +`xdm:service` +* is optional +* type: `string` +* defined in this schema + +### xdm:service Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:tenant + +A description of a customer having a agreement to use a specific set of services (see `xdm:service`). A tenant will typically have a URI which can be used to reference the tenant, and should be resolvable by an identity provider. + +`xdm:tenant` +* is **required** +* type: `string` +* defined in this schema + +### xdm:tenant Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:topology + +A topology is a logical group of services (see `xdm:service`) and their implementations that together form an application (see `xdm:application`). The topology may consist of services and service implementations at different layers throughout an application. Some services within a topology may be satisfied by shared components, for instance many applications may share an edge traffic load balancer. A service will have a URI defining it. + +`xdm:topology` +* is optional +* type: `string` +* defined in this schema + +### xdm:topology Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + diff --git a/docs/reference/datatypes/subscription.schema.json b/docs/reference/datatypes/subscription.schema.json new file mode 100644 index 000000000..2d1e94d25 --- /dev/null +++ b/docs/reference/datatypes/subscription.schema.json @@ -0,0 +1,195 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/subscription", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Subscription", + "type": "object", + "meta:extensible": true, + "description": "Subscriptions are licensed entitlements to software, services, or goods that are utilized in a time or usage based way.", + "definitions": { + "subscription": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "description": "Unique identifier for the subscription instance." + }, + "xdm:subscriber": { + "title": "Subscriber", + "$ref": "https://ns.adobe.com/xdm/context/person", + "description": "The owner of the subscription." + }, + "xdm:device": { + "title": "Device", + "$ref": "https://ns.adobe.com/xdm/context/device", + "description": "The device linked to the subscription." + }, + "xdm:environment": { + "title": "Environment", + "$ref": "https://ns.adobe.com/xdm/context/environment", + "description": "Environment of the subscription. This can be either then known environment at the time of the subscription or the environment of the application for subscriptions related to an application." + }, + "xdm:SKU": { + "title": "SKU", + "type": "string", + "description": "Stock keeping unit (SKU), a generally unique identifier for a product." + }, + "xdm:planName": { + "title": "Plan name", + "type": "string", + "description": "The human readable name for the subscription." + }, + "xdm:type": { + "title": "Type", + "type": "string", + "description": "The scope of entitlement in relation to how many people are covered by the subscription." + }, + "xdm:country": { + "title": "Country", + "type": "string", + "description": "The country that the subscription contractual and agreement terms are rooted in." + }, + "xdm:startDate": { + "title": "Start date", + "type": "string", + "format": "date", + "description": "The date the subscription begins." + }, + "xdm:endDate": { + "title": "End date", + "type": "string", + "format": "date", + "description": "The date the current subscription term ends." + }, + "xdm:term": { + "title": "Term", + "type": "integer", + "description": "The numeric value of the term." + }, + "xdm:termUnitOfTime": { + "title": "Term unit of time", + "type": "string", + "description": "The unit of time for the term period." + }, + "xdm:renew": { + "title": "Renew", + "type": "string", + "description": "The agreed way that the subscription may continue after the end date." + }, + "xdm:topUp": { + "title": "Top up", + "type": "string", + "description": "Agreed terms for how consumable aspects of a subscription are repurchased during a billing period." + }, + "xdm:status": { + "title": "Status", + "type": "string", + "description": "The current status of the subscription." + }, + "xdm:contractID": { + "title": "Contract ID", + "type": "string", + "description": "Unique ID for the contract that governs this subscription." + }, + "xdm:paymentMethod": { + "title": "Payment method", + "type": "string", + "description": "The payment method for recurring payments." + }, + "xdm:billingPeriod": { + "title": "Billing period", + "type": "string", + "description": "The duration between billings." + }, + "xdm:billingStartDate": { + "title": "Billing start date", + "type": "string", + "format": "date", + "description": "The date when the first bill is due." + }, + "xdm:chargeMethod": { + "title": "Charge method", + "type": "string", + "description": "The way the billing is setup to charge the customer." + }, + "xdm:paymentStatus": { + "title": "Payment status", + "type": "string", + "description": "The standing of the account." + }, + "xdm:category": { + "title": "Category", + "type": "string", + "description": "The main, top level categorization of this type of subscription." + }, + "xdm:subCategory": { + "title": "Sub category", + "type": "string", + "description": "The specific sub categorization of the subscription." + }, + "xdm:revision": { + "title": "Revision", + "type": "string", + "description": "The identification between subscriptions of the same name and category hierarchy." + }, + "xdm:reason": { + "title": "Reason", + "type": "string", + "description": "The general intent the member has for the use of the subscription." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/subscription" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/subscriptionid-123", + "xdm:subscriber": { + "xdm:firstName": "John", + "xdm:lastName": "Smith", + "xdm:courtesyTitle": "Mr.", + "xdm:birthDay": 1, + "xdm:birthMonth": 1, + "xdm:birthYear": 2000, + "xdm:gender": "male" + }, + "xdm:device": { + "xdm:typeId": "TypeIdentifier-111", + "xdm:typeIdService": "deviceAtlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216 + }, + "xdm:SKU": "12345678", + "xdm:planName": "PS+ 12 Month Membership", + "xdm:country": "USA", + "xdm:startDate": "2001-01-01", + "xdm:endDate": "2002-01-01", + "xdm:term": 12, + "xdm:termUnitOfTime": "Month", + "xdm:status": "active", + "xdm:contractId": "contractid-123", + "xdm:paymentMethod": "creditCard", + "xdm:billingPeriod": "Month", + "xdm:billingStartDate": "2001-01-01", + "xdm:paymentStatus": "paid" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/subscription.schema.md b/docs/reference/datatypes/subscription.schema.md new file mode 100644 index 000000000..822fc6ee6 --- /dev/null +++ b/docs/reference/datatypes/subscription.schema.md @@ -0,0 +1,591 @@ + +# Subscription Schema + +``` +https://ns.adobe.com/xdm/context/subscription +``` + +Subscriptions are licensed entitlements to software, services, or goods that are utilized in a time or usage based way. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/subscription.schema.json](datatypes/subscription.schema.json) | +## Schema Hierarchy + +* Subscription `https://ns.adobe.com/xdm/context/subscription` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Person](person.schema.md) `https://ns.adobe.com/xdm/context/person` + * [Device](device.schema.md) `https://ns.adobe.com/xdm/context/device` + * [Environment](environment.schema.md) `https://ns.adobe.com/xdm/context/environment` + + +## Subscription Example +```json +{ + "@id": "https://data.adobe.io/subscriptionid-123", + "xdm:subscriber": { + "xdm:firstName": "John", + "xdm:lastName": "Smith", + "xdm:courtesyTitle": "Mr.", + "xdm:birthDay": 1, + "xdm:birthMonth": 1, + "xdm:birthYear": 2000, + "xdm:gender": "male" + }, + "xdm:device": { + "xdm:typeId": "TypeIdentifier-111", + "xdm:typeIdService": "deviceAtlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216 + }, + "xdm:SKU": "12345678", + "xdm:planName": "PS+ 12 Month Membership", + "xdm:country": "USA", + "xdm:startDate": "2001-01-01", + "xdm:endDate": "2002-01-01", + "xdm:term": 12, + "xdm:termUnitOfTime": "Month", + "xdm:status": "active", + "xdm:contractId": "contractid-123", + "xdm:paymentMethod": "creditCard", + "xdm:billingPeriod": "Month", + "xdm:billingStartDate": "2001-01-01", + "xdm:paymentStatus": "paid" +} +``` + +# Subscription Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Subscription (this schema) | +| [xdm:SKU](#xdmsku) | `string` | Optional | Subscription (this schema) | +| [xdm:billingPeriod](#xdmbillingperiod) | `string` | Optional | Subscription (this schema) | +| [xdm:billingStartDate](#xdmbillingstartdate) | `string` | Optional | Subscription (this schema) | +| [xdm:category](#xdmcategory) | `string` | Optional | Subscription (this schema) | +| [xdm:chargeMethod](#xdmchargemethod) | `string` | Optional | Subscription (this schema) | +| [xdm:contractID](#xdmcontractid) | `string` | Optional | Subscription (this schema) | +| [xdm:country](#xdmcountry) | `string` | Optional | Subscription (this schema) | +| [xdm:device](#xdmdevice) | Device | Optional | Subscription (this schema) | +| [xdm:endDate](#xdmenddate) | `string` | Optional | Subscription (this schema) | +| [xdm:environment](#xdmenvironment) | Environment | Optional | Subscription (this schema) | +| [xdm:paymentMethod](#xdmpaymentmethod) | `string` | Optional | Subscription (this schema) | +| [xdm:paymentStatus](#xdmpaymentstatus) | `string` | Optional | Subscription (this schema) | +| [xdm:planName](#xdmplanname) | `string` | Optional | Subscription (this schema) | +| [xdm:reason](#xdmreason) | `string` | Optional | Subscription (this schema) | +| [xdm:renew](#xdmrenew) | `string` | Optional | Subscription (this schema) | +| [xdm:revision](#xdmrevision) | `string` | Optional | Subscription (this schema) | +| [xdm:startDate](#xdmstartdate) | `string` | Optional | Subscription (this schema) | +| [xdm:status](#xdmstatus) | `string` | Optional | Subscription (this schema) | +| [xdm:subCategory](#xdmsubcategory) | `string` | Optional | Subscription (this schema) | +| [xdm:subscriber](#xdmsubscriber) | Person | Optional | Subscription (this schema) | +| [xdm:term](#xdmterm) | `integer` | Optional | Subscription (this schema) | +| [xdm:termUnitOfTime](#xdmtermunitoftime) | `string` | Optional | Subscription (this schema) | +| [xdm:topUp](#xdmtopup) | `string` | Optional | Subscription (this schema) | +| [xdm:type](#xdmtype) | `string` | Optional | Subscription (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +Unique identifier for the subscription instance. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` + + + + + + +## xdm:SKU +### SKU + +Stock keeping unit (SKU), a generally unique identifier for a product. + +`xdm:SKU` +* is optional +* type: `string` +* defined in this schema + +### xdm:SKU Type + + +`string` + + + + + + +## xdm:billingPeriod +### Billing period + +The duration between billings. + +`xdm:billingPeriod` +* is optional +* type: `string` +* defined in this schema + +### xdm:billingPeriod Type + + +`string` + + + + + + +## xdm:billingStartDate +### Billing start date + +The date when the first bill is due. + +`xdm:billingStartDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:billingStartDate Type + + +`string` +* format: `date` – date, without time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:category +### Category + +The main, top level categorization of this type of subscription. + +`xdm:category` +* is optional +* type: `string` +* defined in this schema + +### xdm:category Type + + +`string` + + + + + + +## xdm:chargeMethod +### Charge method + +The way the billing is setup to charge the customer. + +`xdm:chargeMethod` +* is optional +* type: `string` +* defined in this schema + +### xdm:chargeMethod Type + + +`string` + + + + + + +## xdm:contractID +### Contract ID + +Unique ID for the contract that governs this subscription. + +`xdm:contractID` +* is optional +* type: `string` +* defined in this schema + +### xdm:contractID Type + + +`string` + + + + + + +## xdm:country +### Country + +The country that the subscription contractual and agreement terms are rooted in. + +`xdm:country` +* is optional +* type: `string` +* defined in this schema + +### xdm:country Type + + +`string` + + + + + + +## xdm:device +### Device + +The device linked to the subscription. + +`xdm:device` +* is optional +* type: Device +* defined in this schema + +### xdm:device Type + + +* [Device](device.schema.md) – `https://ns.adobe.com/xdm/context/device` + + + + + +## xdm:endDate +### End date + +The date the current subscription term ends. + +`xdm:endDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:endDate Type + + +`string` +* format: `date` – date, without time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:environment +### Environment + +Environment of the subscription. This can be either then known environment at the time of the subscription or the environment of the application for subscriptions related to an application. + +`xdm:environment` +* is optional +* type: Environment +* defined in this schema + +### xdm:environment Type + + +* [Environment](environment.schema.md) – `https://ns.adobe.com/xdm/context/environment` + + + + + +## xdm:paymentMethod +### Payment method + +The payment method for recurring payments. + +`xdm:paymentMethod` +* is optional +* type: `string` +* defined in this schema + +### xdm:paymentMethod Type + + +`string` + + + + + + +## xdm:paymentStatus +### Payment status + +The standing of the account. + +`xdm:paymentStatus` +* is optional +* type: `string` +* defined in this schema + +### xdm:paymentStatus Type + + +`string` + + + + + + +## xdm:planName +### Plan name + +The human readable name for the subscription. + +`xdm:planName` +* is optional +* type: `string` +* defined in this schema + +### xdm:planName Type + + +`string` + + + + + + +## xdm:reason +### Reason + +The general intent the member has for the use of the subscription. + +`xdm:reason` +* is optional +* type: `string` +* defined in this schema + +### xdm:reason Type + + +`string` + + + + + + +## xdm:renew +### Renew + +The agreed way that the subscription may continue after the end date. + +`xdm:renew` +* is optional +* type: `string` +* defined in this schema + +### xdm:renew Type + + +`string` + + + + + + +## xdm:revision +### Revision + +The identification between subscriptions of the same name and category hierarchy. + +`xdm:revision` +* is optional +* type: `string` +* defined in this schema + +### xdm:revision Type + + +`string` + + + + + + +## xdm:startDate +### Start date + +The date the subscription begins. + +`xdm:startDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:startDate Type + + +`string` +* format: `date` – date, without time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:status +### Status + +The current status of the subscription. + +`xdm:status` +* is optional +* type: `string` +* defined in this schema + +### xdm:status Type + + +`string` + + + + + + +## xdm:subCategory +### Sub category + +The specific sub categorization of the subscription. + +`xdm:subCategory` +* is optional +* type: `string` +* defined in this schema + +### xdm:subCategory Type + + +`string` + + + + + + +## xdm:subscriber +### Subscriber + +The owner of the subscription. + +`xdm:subscriber` +* is optional +* type: Person +* defined in this schema + +### xdm:subscriber Type + + +* [Person](person.schema.md) – `https://ns.adobe.com/xdm/context/person` + + + + + +## xdm:term +### Term + +The numeric value of the term. + +`xdm:term` +* is optional +* type: `integer` +* defined in this schema + +### xdm:term Type + + +`integer` + + + + + + +## xdm:termUnitOfTime +### Term unit of time + +The unit of time for the term period. + +`xdm:termUnitOfTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:termUnitOfTime Type + + +`string` + + + + + + +## xdm:topUp +### Top up + +Agreed terms for how consumable aspects of a subscription are repurchased during a billing period. + +`xdm:topUp` +* is optional +* type: `string` +* defined in this schema + +### xdm:topUp Type + + +`string` + + + + + + +## xdm:type +### Type + +The scope of entitlement in relation to how many people are covered by the subscription. + +`xdm:type` +* is optional +* type: `string` +* defined in this schema + +### xdm:type Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/webinfo.schema.json b/docs/reference/datatypes/webinfo.schema.json new file mode 100644 index 000000000..d94799662 --- /dev/null +++ b/docs/reference/datatypes/webinfo.schema.json @@ -0,0 +1,85 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/webinfo", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Web information", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Information recorded via an `ExperienceEvent` that is specific to the World Wide Web channel, including the web page, referrer and/or link related to the on-page interaction.\n", + "definitions": { + "webinfo": { + "properties": { + "xdm:webPageDetails": { + "title": "Web page details", + "$ref": "https://ns.adobe.com/xdm/context/webpagedetails", + "description": "Details about the web page where the web interaction occurred." + }, + "xdm:webInteraction": { + "title": "Web interaction", + "$ref": "https://ns.adobe.com/xdm/context/webinteraction", + "description": "Details about the web link or URL that corresponds to where the interaction occurred." + }, + "xdm:webReferrer": { + "title": "Web referrer", + "$ref": "https://ns.adobe.com/xdm/context/webreferrer", + "description": "The referrer of a web interaction, which is the URL a visitor came from immediately before the current web interaction was recorded." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/webinfo" + } + ], + "examples": [ + { + "xdm:webPageDetails": { + "xdm:siteSection": "Product section", + "xdm:server": "example.com", + "xdm:name": "product home", + "xdm:URL": "https://www.example.com/products", + "xdm:errorPage": false, + "xdm:homePage": true, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.some-adserver.com", + "xdm:referrerType": "external" + } + }, + { + "xdm:webPageDetails": { + "xdm:siteSection": "Product section", + "xdm:server": "example.com", + "xdm:name": "product home", + "xdm:URL": "https://www.example.com/products", + "xdm:errorPage": false, + "xdm:homePage": true + }, + "xdm:webInteraction": { + "xdm:type": "other", + "xdm:URL": "#stores", + "xdm:name": "product store", + "xdm:linkClicks": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/products", + "xdm:type": "internal" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/webinfo.schema.md b/docs/reference/datatypes/webinfo.schema.md new file mode 100644 index 000000000..5a8d6ada1 --- /dev/null +++ b/docs/reference/datatypes/webinfo.schema.md @@ -0,0 +1,135 @@ + +# Web information Schema + +``` +https://ns.adobe.com/xdm/context/webinfo +``` + +Information recorded via an `ExperienceEvent` that is specific to the World Wide Web channel, including the web page, referrer and/or link related to the on-page interaction. + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/webinfo.schema.json](datatypes/webinfo.schema.json) | +## Schema Hierarchy + +* Web information `https://ns.adobe.com/xdm/context/webinfo` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Web page details](webpagedetails.schema.md) `https://ns.adobe.com/xdm/context/webpagedetails` + * [Web interaction](webinteraction.schema.md) `https://ns.adobe.com/xdm/context/webinteraction` + * [Web referrer](webreferrer.schema.md) `https://ns.adobe.com/xdm/context/webreferrer` + + +## Web information Examples + +```json +{ + "xdm:webPageDetails": { + "xdm:siteSection": "Product section", + "xdm:server": "example.com", + "xdm:name": "product home", + "xdm:URL": "https://www.example.com/products", + "xdm:errorPage": false, + "xdm:homePage": true, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.some-adserver.com", + "xdm:referrerType": "external" + } +} +``` + +```json +{ + "xdm:webPageDetails": { + "xdm:siteSection": "Product section", + "xdm:server": "example.com", + "xdm:name": "product home", + "xdm:URL": "https://www.example.com/products", + "xdm:errorPage": false, + "xdm:homePage": true + }, + "xdm:webInteraction": { + "xdm:type": "other", + "xdm:URL": "#stores", + "xdm:name": "product store", + "xdm:linkClicks": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/products", + "xdm:type": "internal" + } +} +``` + + +# Web information Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:webInteraction](#xdmwebinteraction) | Web interaction | Optional | Web information (this schema) | +| [xdm:webPageDetails](#xdmwebpagedetails) | Web page details | Optional | Web information (this schema) | +| [xdm:webReferrer](#xdmwebreferrer) | Web referrer | Optional | Web information (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:webInteraction +### Web interaction + +Details about the web link or URL that corresponds to where the interaction occurred. + +`xdm:webInteraction` +* is optional +* type: Web interaction +* defined in this schema + +### xdm:webInteraction Type + + +* [Web interaction](webinteraction.schema.md) – `https://ns.adobe.com/xdm/context/webinteraction` + + + + + +## xdm:webPageDetails +### Web page details + +Details about the web page where the web interaction occurred. + +`xdm:webPageDetails` +* is optional +* type: Web page details +* defined in this schema + +### xdm:webPageDetails Type + + +* [Web page details](webpagedetails.schema.md) – `https://ns.adobe.com/xdm/context/webpagedetails` + + + + + +## xdm:webReferrer +### Web referrer + +The referrer of a web interaction, which is the URL a visitor came from immediately before the current web interaction was recorded. + +`xdm:webReferrer` +* is optional +* type: Web referrer +* defined in this schema + +### xdm:webReferrer Type + + +* [Web referrer](webreferrer.schema.md) – `https://ns.adobe.com/xdm/context/webreferrer` + + + + diff --git a/docs/reference/datatypes/webinteraction.schema.json b/docs/reference/datatypes/webinteraction.schema.json new file mode 100644 index 000000000..f41e9f1d4 --- /dev/null +++ b/docs/reference/datatypes/webinteraction.schema.json @@ -0,0 +1,69 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/webinteraction", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Web interaction", + "type": "object", + "meta:extensible": true, + "description": "The Web Interaction schema captures information about interactions that happened on a web page after the intial page load (see also Web Page View) was completed.\n\nIt is intended for recording interactions in rich web applications that do not trigger a new page load such as single page web apps (SPAs).\n", + "definitions": { + "webinteraction": { + "properties": { + "xdm:type": { + "title": "Type", + "type": "string", + "description": "The link type.", + "enum": [ + "download", + "exit", + "other" + ], + "meta:enum": { + "download": "Download", + "exit": "Exit", + "other": "Other" + } + }, + "xdm:URL": { + "title": "URL", + "type": "string", + "description": "The actual link or URL used for this web interaction." + }, + "xdm:name": { + "title": "Name", + "type": "string", + "description": "The normative name used for this web link, used for classification purposes." + }, + "xdm:linkClicks": { + "title": "Link Clicks", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Click of a web link has occurred." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/webinteraction" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:type": "other", + "xdm:URL": "https://www.example.com/products/store/?view=1", + "xdm:name": "product store", + "xdm:linkClicks": { + "xdm:value": 1 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/webinteraction.schema.md b/docs/reference/datatypes/webinteraction.schema.md new file mode 100644 index 000000000..f5cd15203 --- /dev/null +++ b/docs/reference/datatypes/webinteraction.schema.md @@ -0,0 +1,124 @@ + +# Web interaction Schema + +``` +https://ns.adobe.com/xdm/context/webinteraction +``` + +The Web Interaction schema captures information about interactions that happened on a web page after the intial page load (see also Web Page View) was completed. + +It is intended for recording interactions in rich web applications that do not trigger a new page load such as single page web apps (SPAs). + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/webinteraction.schema.json](datatypes/webinteraction.schema.json) | +## Schema Hierarchy + +* Web interaction `https://ns.adobe.com/xdm/context/webinteraction` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Measure](data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## Web interaction Example +```json +{ + "xdm:type": "other", + "xdm:URL": "https://www.example.com/products/store/?view=1", + "xdm:name": "product store", + "xdm:linkClicks": { + "xdm:value": 1 + } +} +``` + +# Web interaction Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:URL](#xdmurl) | `string` | Optional | Web interaction (this schema) | +| [xdm:linkClicks](#xdmlinkclicks) | Measure | Optional | Web interaction (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | Web interaction (this schema) | +| [xdm:type](#xdmtype) | `enum` | Optional | Web interaction (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:URL +### URL + +The actual link or URL used for this web interaction. + +`xdm:URL` +* is optional +* type: `string` +* defined in this schema + +### xdm:URL Type + + +`string` + + + + + + +## xdm:linkClicks +### Link Clicks + +Click of a web link has occurred. + +`xdm:linkClicks` +* is optional +* type: Measure +* defined in this schema + +### xdm:linkClicks Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:name +### Name + +The normative name used for this web link, used for classification purposes. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:type +### Type + +The link type. + +`xdm:type` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmtype-known-values). + +### xdm:type Known Values +| Value | Description | +|-------|-------------| +| `download` | Download | +| `exit` | Exit | +| `other` | Other | + + + diff --git a/docs/reference/datatypes/webpagedetails.schema.json b/docs/reference/datatypes/webpagedetails.schema.json new file mode 100644 index 000000000..9d1edb983 --- /dev/null +++ b/docs/reference/datatypes/webpagedetails.schema.json @@ -0,0 +1,78 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/webpagedetails", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Web page details", + "type": "object", + "meta:extensible": true, + "description": "Details about the web page that has just been loaded and viewed, as recorded by an `ExperienceEvent`.\n\nThis schema is intended for full page details and initial page loads of single page web applications (SPAs).\nFor interactions that are happening on a loaded page that do not trigger a new page load, see `WebInteraction`.\n", + "definitions": { + "webpagedetails": { + "properties": { + "xdm:siteSection": { + "title": "Site section", + "type": "string", + "description": "The normative name of the site section where this web page resides, which may be used to classify or categorize the interaction." + }, + "xdm:name": { + "title": "Name", + "type": "string", + "description": "The normative name of the web page. This name is not necessarily the page title or directly associate with page content, but is used to organize a site's pages for classification purposes." + }, + "xdm:URL": { + "title": "URL", + "type": "string", + "format": "uri", + "description": "The normative or usual URL of the web page. This may or may not be the actual URL used to reach the page, which would be recorded using `Web Link`." + }, + "xdm:server": { + "title": "Server", + "type": "string", + "description": "The normative or usual server that hosts the web page. This may or may not be the host or server that actually served the page interaction, but is used for classification purposes." + }, + "xdm:isErrorPage": { + "title": "Is error page", + "type": "boolean", + "description": "Flag that indicate if the page is error page or not. Error here is defined by the application, and may nor may not correspond to a page served with an HTTP error code. This flag is used to broadly categorize web interactions." + }, + "xdm:isHomePage": { + "title": "Is home page", + "type": "boolean", + "description": "Flag that indicate if the page is the site home page or not. The definition of home page is determined by the application, but is commonly used to designate a top level landing page or common site entry point. This flag is used to broadly categorize web interactions." + }, + "xdm:pageViews": { + "title": "Page Views", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "View(s) of a webpage has occurred." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/webpagedetails" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:siteSection": "Product section", + "xdm:server": "example.com", + "xdm:name": "product home", + "xdm:URL": "https://www.example.com", + "xdm:errorPage": false, + "xdm:homePage": true, + "xdm:pageViews": { + "xdm:value": 1 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/webpagedetails.schema.md b/docs/reference/datatypes/webpagedetails.schema.md new file mode 100644 index 000000000..bec004555 --- /dev/null +++ b/docs/reference/datatypes/webpagedetails.schema.md @@ -0,0 +1,188 @@ + +# Web page details Schema + +``` +https://ns.adobe.com/xdm/context/webpagedetails +``` + +Details about the web page that has just been loaded and viewed, as recorded by an `ExperienceEvent`. + +This schema is intended for full page details and initial page loads of single page web applications (SPAs). +For interactions that are happening on a loaded page that do not trigger a new page load, see `WebInteraction`. + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/webpagedetails.schema.json](datatypes/webpagedetails.schema.json) | +## Schema Hierarchy + +* Web page details `https://ns.adobe.com/xdm/context/webpagedetails` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Measure](data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## Web page details Example +```json +{ + "xdm:siteSection": "Product section", + "xdm:server": "example.com", + "xdm:name": "product home", + "xdm:URL": "https://www.example.com", + "xdm:errorPage": false, + "xdm:homePage": true, + "xdm:pageViews": { + "xdm:value": 1 + } +} +``` + +# Web page details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:URL](#xdmurl) | `string` | Optional | Web page details (this schema) | +| [xdm:isErrorPage](#xdmiserrorpage) | `boolean` | Optional | Web page details (this schema) | +| [xdm:isHomePage](#xdmishomepage) | `boolean` | Optional | Web page details (this schema) | +| [xdm:name](#xdmname) | `string` | Optional | Web page details (this schema) | +| [xdm:pageViews](#xdmpageviews) | Measure | Optional | Web page details (this schema) | +| [xdm:server](#xdmserver) | `string` | Optional | Web page details (this schema) | +| [xdm:siteSection](#xdmsitesection) | `string` | Optional | Web page details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:URL +### URL + +The normative or usual URL of the web page. This may or may not be the actual URL used to reach the page, which would be recorded using `Web Link`. + +`xdm:URL` +* is optional +* type: `string` +* defined in this schema + +### xdm:URL Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:isErrorPage +### Is error page + +Flag that indicate if the page is error page or not. Error here is defined by the application, and may nor may not correspond to a page served with an HTTP error code. This flag is used to broadly categorize web interactions. + +`xdm:isErrorPage` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isErrorPage Type + + +`boolean` + + + + + +## xdm:isHomePage +### Is home page + +Flag that indicate if the page is the site home page or not. The definition of home page is determined by the application, but is commonly used to designate a top level landing page or common site entry point. This flag is used to broadly categorize web interactions. + +`xdm:isHomePage` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isHomePage Type + + +`boolean` + + + + + +## xdm:name +### Name + +The normative name of the web page. This name is not necessarily the page title or directly associate with page content, but is used to organize a site's pages for classification purposes. + +`xdm:name` +* is optional +* type: `string` +* defined in this schema + +### xdm:name Type + + +`string` + + + + + + +## xdm:pageViews +### Page Views + +View(s) of a webpage has occurred. + +`xdm:pageViews` +* is optional +* type: Measure +* defined in this schema + +### xdm:pageViews Type + + +* [Measure](data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:server +### Server + +The normative or usual server that hosts the web page. This may or may not be the host or server that actually served the page interaction, but is used for classification purposes. + +`xdm:server` +* is optional +* type: `string` +* defined in this schema + +### xdm:server Type + + +`string` + + + + + + +## xdm:siteSection +### Site section + +The normative name of the site section where this web page resides, which may be used to classify or categorize the interaction. + +`xdm:siteSection` +* is optional +* type: `string` +* defined in this schema + +### xdm:siteSection Type + + +`string` + + + + + diff --git a/docs/reference/datatypes/webreferrer.schema.json b/docs/reference/datatypes/webreferrer.schema.json new file mode 100644 index 000000000..1f7a49873 --- /dev/null +++ b/docs/reference/datatypes/webreferrer.schema.json @@ -0,0 +1,65 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/webreferrer", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Web referrer", + "type": "object", + "meta:extensible": true, + "description": "The referrer of the web page, which is the URL a visitor came from immediately before the current web interaction was recorded.\nThe information in this schema is semantically compatible with the information in the HTTP `referer` header field, but allows for additional classification.\n\n> **Note:** While the [HTTP specification](https://www.w3.org/Protocols/HTTP/HTRQ_Headers.html#z14) uses the term \"referer\", XDM follows the [Document Object Model specification ](https://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.html#ID-95229140) and uses the spelling \"referrer\", which is more widely accepted as the correct spelling.\n", + "definitions": { + "webreferrer": { + "properties": { + "xdm:URL": { + "title": "URL", + "type": "string", + "description": "The referrer URL." + }, + "xdm:type": { + "title": "Type", + "type": "string", + "description": "The referrer type.", + "enum": [ + "internal", + "external", + "search_engine", + "typed_bookmarked", + "email", + "social", + "unknown", + "usenet" + ], + "meta:enum": { + "internal": "Internal", + "external": "External", + "search_engine": "Search engine", + "typed_bookmarked": "Typed or bookmarked", + "email": "Email", + "social": "Social network", + "unknown": "Unknown", + "news": "Usenet newsgroup" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/webreferrer" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:URL": "https://www.some-adserver.com", + "xdm:type": "external" + } + ] +} \ No newline at end of file diff --git a/docs/reference/datatypes/webreferrer.schema.md b/docs/reference/datatypes/webreferrer.schema.md new file mode 100644 index 000000000..4abff4467 --- /dev/null +++ b/docs/reference/datatypes/webreferrer.schema.md @@ -0,0 +1,85 @@ + +# Web referrer Schema + +``` +https://ns.adobe.com/xdm/context/webreferrer +``` + +The referrer of the web page, which is the URL a visitor came from immediately before the current web interaction was recorded. +The information in this schema is semantically compatible with the information in the HTTP `referer` header field, but allows for additional classification. + +> **Note:** While the [HTTP specification](https://www.w3.org/Protocols/HTTP/HTRQ_Headers.html#z14) uses the term "referer", XDM follows the [Document Object Model specification ](https://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.html#ID-95229140) and uses the spelling "referrer", which is more widely accepted as the correct spelling. + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [datatypes/webreferrer.schema.json](datatypes/webreferrer.schema.json) | +## Schema Hierarchy + +* Web referrer `https://ns.adobe.com/xdm/context/webreferrer` + * [Extensibility base schema](extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Web referrer Example +```json +{ + "xdm:URL": "https://www.some-adserver.com", + "xdm:type": "external" +} +``` + +# Web referrer Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:URL](#xdmurl) | `string` | Optional | Web referrer (this schema) | +| [xdm:type](#xdmtype) | `enum` | Optional | Web referrer (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:URL +### URL + +The referrer URL. + +`xdm:URL` +* is optional +* type: `string` +* defined in this schema + +### xdm:URL Type + + +`string` + + + + + + +## xdm:type +### Type + +The referrer type. + +`xdm:type` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmtype-known-values). + +### xdm:type Known Values +| Value | Description | +|-------|-------------| +| `internal` | Internal | +| `external` | External | +| `search_engine` | Search engine | +| `typed_bookmarked` | Typed or bookmarked | +| `email` | Email | +| `social` | Social network | +| `unknown` | Unknown | +| `news` | Usenet newsgroup | +| `usenet` | | + + + diff --git a/docs/reference/descriptors/display/alternateDisplayInfo.schema.json b/docs/reference/descriptors/display/alternateDisplayInfo.schema.json new file mode 100644 index 000000000..1a8593cfc --- /dev/null +++ b/docs/reference/descriptors/display/alternateDisplayInfo.schema.json @@ -0,0 +1,138 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/alternateDisplayInfo", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Friendly Name Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Allows to modify the \"title\" and \"description\" values of the core library schema fields. UI can use these to show a more friendly name for a standard field or to only show fields that have friendly names.", + "definitions": { + "alternateDisplayInfo": { + "properties": { + "@type": { + "title": "Type", + "type": "string", + "const": "xdm:alternateDisplayInfo" + }, + "xdm:title": { + "title": "Title", + "type": "object", + "description": "When present, user friendly title to display.", + "patternProperties": { + ".+_.+": { + "type": "string" + } + } + }, + "xdm:description": { + "title": "Description", + "type": "object", + "description": "When present, user friendly description to display.", + "patternProperties": { + ".+_.+": { + "type": "string" + } + } + }, + "xdm:note": { + "title": "Note", + "type": "object", + "description": "When present, user friendly note to display. Similar to a description, but provides more details about the actual usage of the field.", + "patternProperties": { + ".+_.+": { + "type": "string" + } + } + }, + "meta:enum": { + "title": "Extended meta:enum values", + "type": "object", + "patternProperties": { + ".+_.+": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + } + ] + } + } + } + }, + "anyOf": [ + { + "required": [ + "xdm:title" + ] + }, + { + "required": [ + "xdm:description" + ] + }, + { + "required": [ + "meta:enum" + ] + } + ], + "required": [ + "xdm:sourceProperty" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "#/definitions/alternateDisplayInfo" + } + ], + "meta:status": "stable", + "examples": [ + { + "@type": "xdm:alternateDisplayInfo", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/environment", + "xdm:sourceVersion": 1, + "xdm:sourceProperty": "/browserDetails", + "xdm:title": { + "en_us": "friendly title for browser details", + "fr_ca": "titre convivial pour les détails du navigateur" + } + }, + { + "@type": "xdm:alternateDisplayInfo", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/environment", + "xdm:sourceVersion": 1, + "xdm:sourceProperty": "/browserDetails", + "xdm:description": { + "en_us": "friendly description for browser details", + "fr_ca": "description conviviale pour les détails du navigateur" + } + }, + { + "@type": "xdm:alternateDisplayInfo", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/environment", + "xdm:sourceVersion": 1, + "xdm:sourceProperty": "/browserDetails", + "xdm:title": { + "en_us": "friendly title for browser details" + }, + "xdm:description": { + "en_us": "friendly description for browser details" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/descriptors/display/alternateDisplayInfo.schema.md b/docs/reference/descriptors/display/alternateDisplayInfo.schema.md new file mode 100644 index 000000000..c8f12c94c --- /dev/null +++ b/docs/reference/descriptors/display/alternateDisplayInfo.schema.md @@ -0,0 +1,307 @@ + +# Friendly Name Descriptor Schema + +``` +https://ns.adobe.com/xdm/common/descriptors/alternateDisplayInfo +``` + +Allows to modify the "title" and "description" values of the core library schema fields. UI can use these to show a more friendly name for a standard field or to only show fields that have friendly names. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [descriptors/display/alternateDisplayInfo.schema.json](descriptors/display/alternateDisplayInfo.schema.json) | +## Schema Hierarchy + +* Friendly Name Descriptor `https://ns.adobe.com/xdm/common/descriptors/alternateDisplayInfo` + * [Schema Descriptor](../schemadescriptor.schema.md) `https://ns.adobe.com/xdm/common/descriptors/schemadescriptor` + + +## Friendly Name Descriptor Examples + +```json +{ + "@type": "xdm:alternateDisplayInfo", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/environment", + "xdm:sourceVersion": 1, + "xdm:sourceProperty": "/browserDetails", + "xdm:title": { + "en_us": "friendly title for browser details", + "fr_ca": "titre convivial pour les détails du navigateur" + } +} +``` + +```json +{ + "@type": "xdm:alternateDisplayInfo", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/environment", + "xdm:sourceVersion": 1, + "xdm:sourceProperty": "/browserDetails", + "xdm:description": { + "en_us": "friendly description for browser details", + "fr_ca": "description conviviale pour les détails du navigateur" + } +} +``` + +```json +{ + "@type": "xdm:alternateDisplayInfo", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/environment", + "xdm:sourceVersion": 1, + "xdm:sourceProperty": "/browserDetails", + "xdm:title": { + "en_us": "friendly title for browser details" + }, + "xdm:description": { + "en_us": "friendly description for browser details" + } +} +``` + + +# Friendly Name Descriptor Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#id) | +| [@type](#type) | `const` | Optional | Friendly Name Descriptor (this schema) | +| [meta:enum](#metaenum) | `object` | Optional | Friendly Name Descriptor (this schema) | +| [xdm:description](#xdmdescription) | `object` | Optional | Friendly Name Descriptor (this schema) | +| [xdm:note](#xdmnote) | `object` | Optional | Friendly Name Descriptor (this schema) | +| [xdm:sourceItem](#xdmsourceitem) | complex | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) | +| [xdm:sourceProperty](#xdmsourceproperty) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) | +| [xdm:sourceSchema](#xdmsourceschema) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) | +| [xdm:sourceVersion](#xdmsourceversion) | `number` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) | +| [xdm:title](#xdmtitle) | `object` | Optional | Friendly Name Descriptor (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'. + +`@id` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## @type +### Type + +`@type` +* is optional +* type: `const` +* defined in this schema + +The value of this property **must** be equal to: + +```json +"xdm:alternateDisplayInfo" +``` + + + + + +## meta:enum +### Extended meta:enum values + +`meta:enum` +* is optional +* type: `object` +* defined in this schema + +### meta:enum Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:description +### Description + +When present, user friendly description to display. + +`xdm:description` +* is optional +* type: `object` +* defined in this schema + +### xdm:description Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:note +### Note + +When present, user friendly note to display. Similar to a description, but provides more details about the actual usage of the field. + +`xdm:note` +* is optional +* type: `object` +* defined in this schema + +### xdm:note Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:sourceItem +### Source Item + +When present, the selector used to match a specific item in the array pointed to by `sourceProperty`. + +`xdm:sourceItem` +* is optional +* type: complex +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) + +### xdm:sourceItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:sourceProperty +### Source Property + +When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`. + +`xdm:sourceProperty` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) + +### xdm:sourceProperty Type + + +`string` + + + + + + +## xdm:sourceSchema +### Source Schema + +The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors' + +`xdm:sourceSchema` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) + +### xdm:sourceSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:sourceVersion +### Source Version + +Major version being referenced. + +`xdm:sourceVersion` +* is optional +* type: `number` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) + +### xdm:sourceVersion Type + + +`number` + + + + + + +## xdm:title +### Title + +When present, user friendly title to display. + +`xdm:title` +* is optional +* type: `object` +* defined in this schema + +### xdm:title Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + diff --git a/docs/reference/descriptors/identity/descriptorIdentity.schema.json b/docs/reference/descriptors/identity/descriptorIdentity.schema.json new file mode 100644 index 000000000..a76db9280 --- /dev/null +++ b/docs/reference/descriptors/identity/descriptorIdentity.schema.json @@ -0,0 +1,81 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/descriptorIdentity", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Identity Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Used to mark a field as an identity.", + "definitions": { + "descriptorIdentity": { + "properties": { + "@type": { + "title": "Type", + "type": "string", + "const": "xdm:descriptorIdentity" + }, + "xdm:namespace": { + "title": "Namespace", + "type": "string", + "description": "Identity ID or Code." + }, + "xdm:property": { + "title": "Property", + "type": "string", + "description": "Property of the `xdm:namespace` field.", + "enum": [ + "xdm:id", + "xdm:code" + ] + }, + "xdm:isPrimary": { + "title": "Is primary key or not", + "type": "boolean", + "description": "When present, only one field should be marked as the primary. Default is false." + } + }, + "required": [ + "xdm:sourceProperty", + "xdm:namespace", + "xdm:property" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "#/definitions/descriptorIdentity" + } + ], + "meta:status": "stable", + "examples": [ + { + "@type": "xdm:descriptorIdentity", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:sourceVersion": 1, + "xdm:sourceProperty": "/orgUnitId", + "xdm:namespace": "12345", + "xdm:property": "xdm:id" + }, + { + "@type": "xdm:descriptorIdentity", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:sourceVersion": 1, + "xdm:sourceProperty": "/orgUnitId", + "xdm:namespace": "AAM", + "xdm:property": "xdm:code", + "xdm:isPrimary": true + } + ] +} \ No newline at end of file diff --git a/docs/reference/descriptors/identity/descriptorIdentity.schema.md b/docs/reference/descriptors/identity/descriptorIdentity.schema.md new file mode 100644 index 000000000..b1ca93796 --- /dev/null +++ b/docs/reference/descriptors/identity/descriptorIdentity.schema.md @@ -0,0 +1,254 @@ + +# Identity Descriptor Schema + +``` +https://ns.adobe.com/xdm/common/descriptors/descriptorIdentity +``` + +Used to mark a field as an identity. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [descriptors/identity/descriptorIdentity.schema.json](descriptors/identity/descriptorIdentity.schema.json) | +## Schema Hierarchy + +* Identity Descriptor `https://ns.adobe.com/xdm/common/descriptors/descriptorIdentity` + * [Schema Descriptor](../schemadescriptor.schema.md) `https://ns.adobe.com/xdm/common/descriptors/schemadescriptor` + + +## Identity Descriptor Examples + +```json +{ + "@type": "xdm:descriptorIdentity", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:sourceVersion": 1, + "xdm:sourceProperty": "/orgUnitId", + "xdm:namespace": "12345", + "xdm:property": "xdm:id" +} +``` + +```json +{ + "@type": "xdm:descriptorIdentity", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:sourceVersion": 1, + "xdm:sourceProperty": "/orgUnitId", + "xdm:namespace": "AAM", + "xdm:property": "xdm:code", + "xdm:isPrimary": true +} +``` + + +# Identity Descriptor Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#id) | +| [@type](#type) | `const` | Optional | Identity Descriptor (this schema) | +| [xdm:isPrimary](#xdmisprimary) | `boolean` | Optional | Identity Descriptor (this schema) | +| [xdm:namespace](#xdmnamespace) | `string` | Optional | Identity Descriptor (this schema) | +| [xdm:property](#xdmproperty) | `enum` | Optional | Identity Descriptor (this schema) | +| [xdm:sourceItem](#xdmsourceitem) | complex | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) | +| [xdm:sourceProperty](#xdmsourceproperty) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) | +| [xdm:sourceSchema](#xdmsourceschema) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) | +| [xdm:sourceVersion](#xdmsourceversion) | `number` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'. + +`@id` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## @type +### Type + +`@type` +* is optional +* type: `const` +* defined in this schema + +The value of this property **must** be equal to: + +```json +"xdm:descriptorIdentity" +``` + + + + + +## xdm:isPrimary +### Is primary key or not + +When present, only one field should be marked as the primary. Default is false. + +`xdm:isPrimary` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isPrimary Type + + +`boolean` + + + + + +## xdm:namespace +### Namespace + +Identity ID or Code. + +`xdm:namespace` +* is optional +* type: `string` +* defined in this schema + +### xdm:namespace Type + + +`string` + + + + + + +## xdm:property +### Property + +Property of the `xdm:namespace` field. + +`xdm:property` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmproperty-known-values). + +### xdm:property Known Values +| Value | Description | +|-------|-------------| +| `xdm:id` | | +| `xdm:code` | | + + + + +## xdm:sourceItem +### Source Item + +When present, the selector used to match a specific item in the array pointed to by `sourceProperty`. + +`xdm:sourceItem` +* is optional +* type: complex +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) + +### xdm:sourceItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:sourceProperty +### Source Property + +When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`. + +`xdm:sourceProperty` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) + +### xdm:sourceProperty Type + + +`string` + + + + + + +## xdm:sourceSchema +### Source Schema + +The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors' + +`xdm:sourceSchema` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) + +### xdm:sourceSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:sourceVersion +### Source Version + +Major version being referenced. + +`xdm:sourceVersion` +* is optional +* type: `number` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) + +### xdm:sourceVersion Type + + +`number` + + + + + diff --git a/docs/reference/descriptors/identity/descriptorReferenceIdentity.schema.json b/docs/reference/descriptors/identity/descriptorReferenceIdentity.schema.json new file mode 100644 index 000000000..6b047fa43 --- /dev/null +++ b/docs/reference/descriptors/identity/descriptorReferenceIdentity.schema.json @@ -0,0 +1,56 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/descriptorReferenceIdentity", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Identity Reference Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Used to assign a namespace that will be used to derive a relationship.", + "definitions": { + "descriptorReferenceIdentity": { + "properties": { + "@type": { + "title": "Type", + "type": "string", + "const": "xdm:descriptorReferenceIdentity" + }, + "xdm:identityNamespace": { + "title": "Identity Namespace", + "type": "string", + "description": "The namespace code defined in identity system." + } + }, + "required": [ + "xdm:sourceProperty", + "xdm:identityNamespace" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "#/definitions/descriptorReferenceIdentity" + } + ], + "meta:status": "stable", + "examples": [ + { + "@type": "xdm:descriptorReferenceIdentity", + "xdm:sourceSchema": "https://ns.adobe.com/marriot/schemas/marriott-loyalty", + "xdm:sourceVersion": 1, + "xdm:sourceProperty": "/_marriott/favoriteHotel", + "xdm:identityNamespace": "marriott" + } + ] +} \ No newline at end of file diff --git a/docs/reference/descriptors/identity/descriptorReferenceIdentity.schema.md b/docs/reference/descriptors/identity/descriptorReferenceIdentity.schema.md new file mode 100644 index 000000000..a18e09164 --- /dev/null +++ b/docs/reference/descriptors/identity/descriptorReferenceIdentity.schema.md @@ -0,0 +1,197 @@ + +# Identity Reference Descriptor Schema + +``` +https://ns.adobe.com/xdm/common/descriptors/descriptorReferenceIdentity +``` + +Used to assign a namespace that will be used to derive a relationship. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [descriptors/identity/descriptorReferenceIdentity.schema.json](descriptors/identity/descriptorReferenceIdentity.schema.json) | +## Schema Hierarchy + +* Identity Reference Descriptor `https://ns.adobe.com/xdm/common/descriptors/descriptorReferenceIdentity` + * [Schema Descriptor](../schemadescriptor.schema.md) `https://ns.adobe.com/xdm/common/descriptors/schemadescriptor` + + +## Identity Reference Descriptor Example +```json +{ + "@type": "xdm:descriptorReferenceIdentity", + "xdm:sourceSchema": "https://ns.adobe.com/marriot/schemas/marriott-loyalty", + "xdm:sourceVersion": 1, + "xdm:sourceProperty": "/_marriott/favoriteHotel", + "xdm:identityNamespace": "marriott" +} +``` + +# Identity Reference Descriptor Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#id) | +| [@type](#type) | `const` | Optional | Identity Reference Descriptor (this schema) | +| [xdm:identityNamespace](#xdmidentitynamespace) | `string` | Optional | Identity Reference Descriptor (this schema) | +| [xdm:sourceItem](#xdmsourceitem) | complex | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) | +| [xdm:sourceProperty](#xdmsourceproperty) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) | +| [xdm:sourceSchema](#xdmsourceschema) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) | +| [xdm:sourceVersion](#xdmsourceversion) | `number` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'. + +`@id` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## @type +### Type + +`@type` +* is optional +* type: `const` +* defined in this schema + +The value of this property **must** be equal to: + +```json +"xdm:descriptorReferenceIdentity" +``` + + + + + +## xdm:identityNamespace +### Identity Namespace + +The namespace code defined in identity system. + +`xdm:identityNamespace` +* is optional +* type: `string` +* defined in this schema + +### xdm:identityNamespace Type + + +`string` + + + + + + +## xdm:sourceItem +### Source Item + +When present, the selector used to match a specific item in the array pointed to by `sourceProperty`. + +`xdm:sourceItem` +* is optional +* type: complex +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) + +### xdm:sourceItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:sourceProperty +### Source Property + +When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`. + +`xdm:sourceProperty` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) + +### xdm:sourceProperty Type + + +`string` + + + + + + +## xdm:sourceSchema +### Source Schema + +The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors' + +`xdm:sourceSchema` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) + +### xdm:sourceSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:sourceVersion +### Source Version + +Major version being referenced. + +`xdm:sourceVersion` +* is optional +* type: `number` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) + +### xdm:sourceVersion Type + + +`number` + + + + + diff --git a/docs/reference/descriptors/itemselector.schema.json b/docs/reference/descriptors/itemselector.schema.json new file mode 100644 index 000000000..24a46cd4f --- /dev/null +++ b/docs/reference/descriptors/itemselector.schema.json @@ -0,0 +1,93 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/itemselector", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Item Selector", + "meta:extensible": false, + "meta:abstract": false, + "type": "object", + "description": "Describes how to select or match to a specific item from an array of values described by an XDM schema.\n\nMatching may be done based on array index, `@id`, `@type`, or schema URI.\n", + "definitions": { + "selector": { + "oneOf": [ + { + "properties": { + "xdm:index": { + "title": "Index", + "type": "integer", + "description": "When present, indicates the item at this array index should be selected.", + "minimum": 0 + } + }, + "required": [ + "xdm:index" + ] + }, + { + "properties": { + "xdm:id": { + "title": "ID", + "type": "string", + "format": "uri", + "description": "When present, indicates the item with this @id value should be selected." + } + }, + "required": [ + "xdm:id" + ] + }, + { + "properties": { + "xdm:type": { + "title": "Type", + "type": "string", + "format": "uri", + "description": "When present, indicates the item with this @type value should be selected." + } + }, + "required": [ + "xdm:type" + ] + }, + { + "properties": { + "xdm:schema": { + "title": "Schema", + "type": "string", + "format": "uri", + "description": "When present, indicates the item which conforms to this schema URI should be selected." + } + }, + "required": [ + "xdm:schema" + ] + } + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/selector" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:type": "https://ns.adobe.com/experience/mcid" + }, + { + "xdm:schema": "https://ns.adobe.com/xdm/context/identity" + }, + { + "xdm:index": 0 + }, + { + "xdm:id": "https://example.com/objects/12345" + } + ] +} \ No newline at end of file diff --git a/docs/reference/descriptors/itemselector.schema.md b/docs/reference/descriptors/itemselector.schema.md new file mode 100644 index 000000000..be49a97d2 --- /dev/null +++ b/docs/reference/descriptors/itemselector.schema.md @@ -0,0 +1,42 @@ + +# Item Selector Schema + +``` +https://ns.adobe.com/xdm/common/descriptors/itemselector +``` + +Describes how to select or match to a specific item from an array of values described by an XDM schema. + +Matching may be done based on array index, `@id`, `@type`, or schema URI. + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Cannot be instantiated | Yes | Stable | No | Forbidden | Permitted | [descriptors/itemselector.schema.json](descriptors/itemselector.schema.json) | + +## Item Selector Examples + +```json +{ + "xdm:type": "https://ns.adobe.com/experience/mcid" +} +``` + +```json +{ + "xdm:schema": "https://ns.adobe.com/xdm/context/identity" +} +``` + +```json +{ + "xdm:index": 0 +} +``` + +```json +{ + "xdm:id": "https://example.com/objects/12345" +} +``` + diff --git a/docs/reference/descriptors/relationship/descriptorManyToMany.schema.json b/docs/reference/descriptors/relationship/descriptorManyToMany.schema.json new file mode 100644 index 000000000..0cb01b44a --- /dev/null +++ b/docs/reference/descriptors/relationship/descriptorManyToMany.schema.json @@ -0,0 +1,52 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/descriptorManyToMany", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Many to Many Relationship Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor", + "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Describes many to many relationship descriptor.", + "definitions": { + "descriptorManyToMany": { + "properties": { + "@type": { + "type": "string", + "const": "xdm:descriptorManyToMany" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" + }, + { + "$ref": "#/definitions/descriptorManyToMany" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://ns.adobe.com/example/descriptorManyToMany/1", + "@type": "xdm:descriptorManyToMany", + "xdm:sourceSchema": "https://ns.adobe.com/experience/aem/user", + "xdm:sourceVersion": 1, + "xdm:destinationSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:destinationVersion": 1, + "xdm:label": "UserProfile" + } + ] +} \ No newline at end of file diff --git a/docs/reference/descriptors/relationship/descriptorManyToMany.schema.md b/docs/reference/descriptors/relationship/descriptorManyToMany.schema.md new file mode 100644 index 000000000..8906d7447 --- /dev/null +++ b/docs/reference/descriptors/relationship/descriptorManyToMany.schema.md @@ -0,0 +1,320 @@ + +# Many to Many Relationship Descriptor Schema + +``` +https://ns.adobe.com/xdm/common/descriptors/descriptorManyToMany +``` + +Describes many to many relationship descriptor. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [descriptors/relationship/descriptorManyToMany.schema.json](descriptors/relationship/descriptorManyToMany.schema.json) | +## Schema Hierarchy + +* Many to Many Relationship Descriptor `https://ns.adobe.com/xdm/common/descriptors/descriptorManyToMany` + * [Schema Descriptor](../schemadescriptor.schema.md) `https://ns.adobe.com/xdm/common/descriptors/schemadescriptor` + * [Relationship Descriptor](../relationshipdescriptor.schema.md) `https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor` + + +## Many to Many Relationship Descriptor Example +```json +{ + "@id": "https://ns.adobe.com/example/descriptorManyToMany/1", + "@type": "xdm:descriptorManyToMany", + "xdm:sourceSchema": "https://ns.adobe.com/experience/aem/user", + "xdm:sourceVersion": 1, + "xdm:destinationSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:destinationVersion": 1, + "xdm:label": "UserProfile" +} +``` + +# Many to Many Relationship Descriptor Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#id) | +| [@type](#type) | `const` | Optional | Many to Many Relationship Descriptor (this schema) | +| [xdm:destinationItem](#xdmdestinationitem) | complex | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationitem) | +| [xdm:destinationProperty](#xdmdestinationproperty) | `string` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationproperty) | +| [xdm:destinationSchema](#xdmdestinationschema) | `string` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationschema) | +| [xdm:destinationVersion](#xdmdestinationversion) | `number` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationversion) | +| [xdm:label](#xdmlabel) | `string` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmlabel) | +| [xdm:sourceItem](#xdmsourceitem) | complex | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) | +| [xdm:sourceProperty](#xdmsourceproperty) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) | +| [xdm:sourceSchema](#xdmsourceschema) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) | +| [xdm:sourceValue](#xdmsourcevalue) | `string` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmsourcevalue) | +| [xdm:sourceVersion](#xdmsourceversion) | `number` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'. + +`@id` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## @type + + +`@type` +* is optional +* type: `const` +* defined in this schema + +The value of this property **must** be equal to: + +```json +"xdm:descriptorManyToMany" +``` + + + + + +## xdm:destinationItem +### Destination Item + +When present, the selector used to match a specific item in the array pointed to by destProperty + +`xdm:destinationItem` +* is optional +* type: complex +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationitem) + +### xdm:destinationItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:destinationProperty +### Destination Property + +When present, the property of the destination schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by 'xdm:destSchema' + +`xdm:destinationProperty` +* is optional +* type: `string` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationproperty) + +### xdm:destinationProperty Type + + +`string` + + + + + + +## xdm:destinationSchema +### Destination Schema + +The destination schema this descriptor applies to + +`xdm:destinationSchema` +* is optional +* type: `string` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationschema) + +### xdm:destinationSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:destinationVersion +### Destination Version + +Major version being referenced. + +`xdm:destinationVersion` +* is optional +* type: `number` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationversion) + +### xdm:destinationVersion Type + + +`number` + + + + + + +## xdm:label +### Label + +`xdm:label` +* is optional +* type: `string` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmlabel) + +### xdm:label Type + + +`string` + + + + + + +## xdm:sourceItem +### Source Item + +When present, the selector used to match a specific item in the array pointed to by `sourceProperty`. + +`xdm:sourceItem` +* is optional +* type: complex +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) + +### xdm:sourceItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:sourceProperty +### Source Property + +When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`. + +`xdm:sourceProperty` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) + +### xdm:sourceProperty Type + + +`string` + + + + + + +## xdm:sourceSchema +### Source Schema + +The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors' + +`xdm:sourceSchema` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) + +### xdm:sourceSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:sourceValue +### Source Value + +When present, provides additional information about the values in that field. Descriptor producer and consumer should coordinate on how to use this field, e.g. defining rules on formats, values, and operations. + +`xdm:sourceValue` +* is optional +* type: `string` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmsourcevalue) + +### xdm:sourceValue Type + + +`string` + + + + + + +## xdm:sourceVersion +### Source Version + +Major version being referenced. + +`xdm:sourceVersion` +* is optional +* type: `number` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) + +### xdm:sourceVersion Type + + +`number` + + + + + diff --git a/docs/reference/descriptors/relationship/descriptorOneToMany.schema.json b/docs/reference/descriptors/relationship/descriptorOneToMany.schema.json new file mode 100644 index 000000000..cf9e90ef0 --- /dev/null +++ b/docs/reference/descriptors/relationship/descriptorOneToMany.schema.json @@ -0,0 +1,52 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/descriptorOneToMany", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "One to Many Relationship Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor", + "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Describes one to many relationship descriptor.", + "definitions": { + "descriptorOneToMany": { + "properties": { + "@type": { + "type": "string", + "const": "xdm:descriptorOneToMany" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" + }, + { + "$ref": "#/definitions/descriptorOneToMany" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://ns.adobe.com/example/descriptorOneToMany/1", + "@type": "xdm:descriptorOneToMany", + "xdm:sourceSchema": "https://ns.adobe.com/experience/aem/user", + "xdm:sourceVersion": 1, + "xdm:destinationSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:destinationVersion": 1, + "xdm:label": "UserProfile" + } + ] +} \ No newline at end of file diff --git a/docs/reference/descriptors/relationship/descriptorOneToMany.schema.md b/docs/reference/descriptors/relationship/descriptorOneToMany.schema.md new file mode 100644 index 000000000..7522abc1a --- /dev/null +++ b/docs/reference/descriptors/relationship/descriptorOneToMany.schema.md @@ -0,0 +1,320 @@ + +# One to Many Relationship Descriptor Schema + +``` +https://ns.adobe.com/xdm/common/descriptors/descriptorOneToMany +``` + +Describes one to many relationship descriptor. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [descriptors/relationship/descriptorOneToMany.schema.json](descriptors/relationship/descriptorOneToMany.schema.json) | +## Schema Hierarchy + +* One to Many Relationship Descriptor `https://ns.adobe.com/xdm/common/descriptors/descriptorOneToMany` + * [Schema Descriptor](../schemadescriptor.schema.md) `https://ns.adobe.com/xdm/common/descriptors/schemadescriptor` + * [Relationship Descriptor](../relationshipdescriptor.schema.md) `https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor` + + +## One to Many Relationship Descriptor Example +```json +{ + "@id": "https://ns.adobe.com/example/descriptorOneToMany/1", + "@type": "xdm:descriptorOneToMany", + "xdm:sourceSchema": "https://ns.adobe.com/experience/aem/user", + "xdm:sourceVersion": 1, + "xdm:destinationSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:destinationVersion": 1, + "xdm:label": "UserProfile" +} +``` + +# One to Many Relationship Descriptor Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#id) | +| [@type](#type) | `const` | Optional | One to Many Relationship Descriptor (this schema) | +| [xdm:destinationItem](#xdmdestinationitem) | complex | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationitem) | +| [xdm:destinationProperty](#xdmdestinationproperty) | `string` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationproperty) | +| [xdm:destinationSchema](#xdmdestinationschema) | `string` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationschema) | +| [xdm:destinationVersion](#xdmdestinationversion) | `number` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationversion) | +| [xdm:label](#xdmlabel) | `string` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmlabel) | +| [xdm:sourceItem](#xdmsourceitem) | complex | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) | +| [xdm:sourceProperty](#xdmsourceproperty) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) | +| [xdm:sourceSchema](#xdmsourceschema) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) | +| [xdm:sourceValue](#xdmsourcevalue) | `string` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmsourcevalue) | +| [xdm:sourceVersion](#xdmsourceversion) | `number` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'. + +`@id` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## @type + + +`@type` +* is optional +* type: `const` +* defined in this schema + +The value of this property **must** be equal to: + +```json +"xdm:descriptorOneToMany" +``` + + + + + +## xdm:destinationItem +### Destination Item + +When present, the selector used to match a specific item in the array pointed to by destProperty + +`xdm:destinationItem` +* is optional +* type: complex +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationitem) + +### xdm:destinationItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:destinationProperty +### Destination Property + +When present, the property of the destination schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by 'xdm:destSchema' + +`xdm:destinationProperty` +* is optional +* type: `string` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationproperty) + +### xdm:destinationProperty Type + + +`string` + + + + + + +## xdm:destinationSchema +### Destination Schema + +The destination schema this descriptor applies to + +`xdm:destinationSchema` +* is optional +* type: `string` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationschema) + +### xdm:destinationSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:destinationVersion +### Destination Version + +Major version being referenced. + +`xdm:destinationVersion` +* is optional +* type: `number` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationversion) + +### xdm:destinationVersion Type + + +`number` + + + + + + +## xdm:label +### Label + +`xdm:label` +* is optional +* type: `string` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmlabel) + +### xdm:label Type + + +`string` + + + + + + +## xdm:sourceItem +### Source Item + +When present, the selector used to match a specific item in the array pointed to by `sourceProperty`. + +`xdm:sourceItem` +* is optional +* type: complex +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) + +### xdm:sourceItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:sourceProperty +### Source Property + +When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`. + +`xdm:sourceProperty` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) + +### xdm:sourceProperty Type + + +`string` + + + + + + +## xdm:sourceSchema +### Source Schema + +The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors' + +`xdm:sourceSchema` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) + +### xdm:sourceSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:sourceValue +### Source Value + +When present, provides additional information about the values in that field. Descriptor producer and consumer should coordinate on how to use this field, e.g. defining rules on formats, values, and operations. + +`xdm:sourceValue` +* is optional +* type: `string` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmsourcevalue) + +### xdm:sourceValue Type + + +`string` + + + + + + +## xdm:sourceVersion +### Source Version + +Major version being referenced. + +`xdm:sourceVersion` +* is optional +* type: `number` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) + +### xdm:sourceVersion Type + + +`number` + + + + + diff --git a/docs/reference/descriptors/relationship/descriptorOneToOne.schema.json b/docs/reference/descriptors/relationship/descriptorOneToOne.schema.json new file mode 100644 index 000000000..22e2cd45b --- /dev/null +++ b/docs/reference/descriptors/relationship/descriptorOneToOne.schema.json @@ -0,0 +1,52 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "One to One Relationship Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor", + "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Describes one to one relationship descriptor.", + "definitions": { + "descriptorOneToOne": { + "properties": { + "@type": { + "type": "string", + "const": "xdm:descriptorOneToOne" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" + }, + { + "$ref": "#/definitions/descriptorOneToOne" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://ns.adobe.com/example/descriptorOneToOne/1", + "@type": "xdm:descriptorOneToOne", + "xdm:sourceSchema": "https://ns.adobe.com/experience/aem/user", + "xdm:sourceVersion": 1, + "xdm:destinationSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:destinationVersion": 1, + "xdm:label": "UserProfile" + } + ] +} \ No newline at end of file diff --git a/docs/reference/descriptors/relationship/descriptorOneToOne.schema.md b/docs/reference/descriptors/relationship/descriptorOneToOne.schema.md new file mode 100644 index 000000000..f8b6679c0 --- /dev/null +++ b/docs/reference/descriptors/relationship/descriptorOneToOne.schema.md @@ -0,0 +1,320 @@ + +# One to One Relationship Descriptor Schema + +``` +https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne +``` + +Describes one to one relationship descriptor. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [descriptors/relationship/descriptorOneToOne.schema.json](descriptors/relationship/descriptorOneToOne.schema.json) | +## Schema Hierarchy + +* One to One Relationship Descriptor `https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne` + * [Schema Descriptor](../schemadescriptor.schema.md) `https://ns.adobe.com/xdm/common/descriptors/schemadescriptor` + * [Relationship Descriptor](../relationshipdescriptor.schema.md) `https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor` + + +## One to One Relationship Descriptor Example +```json +{ + "@id": "https://ns.adobe.com/example/descriptorOneToOne/1", + "@type": "xdm:descriptorOneToOne", + "xdm:sourceSchema": "https://ns.adobe.com/experience/aem/user", + "xdm:sourceVersion": 1, + "xdm:destinationSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:destinationVersion": 1, + "xdm:label": "UserProfile" +} +``` + +# One to One Relationship Descriptor Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#id) | +| [@type](#type) | `const` | Optional | One to One Relationship Descriptor (this schema) | +| [xdm:destinationItem](#xdmdestinationitem) | complex | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationitem) | +| [xdm:destinationProperty](#xdmdestinationproperty) | `string` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationproperty) | +| [xdm:destinationSchema](#xdmdestinationschema) | `string` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationschema) | +| [xdm:destinationVersion](#xdmdestinationversion) | `number` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationversion) | +| [xdm:label](#xdmlabel) | `string` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmlabel) | +| [xdm:sourceItem](#xdmsourceitem) | complex | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) | +| [xdm:sourceProperty](#xdmsourceproperty) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) | +| [xdm:sourceSchema](#xdmsourceschema) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) | +| [xdm:sourceValue](#xdmsourcevalue) | `string` | Optional | [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmsourcevalue) | +| [xdm:sourceVersion](#xdmsourceversion) | `number` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'. + +`@id` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## @type + + +`@type` +* is optional +* type: `const` +* defined in this schema + +The value of this property **must** be equal to: + +```json +"xdm:descriptorOneToOne" +``` + + + + + +## xdm:destinationItem +### Destination Item + +When present, the selector used to match a specific item in the array pointed to by destProperty + +`xdm:destinationItem` +* is optional +* type: complex +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationitem) + +### xdm:destinationItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:destinationProperty +### Destination Property + +When present, the property of the destination schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by 'xdm:destSchema' + +`xdm:destinationProperty` +* is optional +* type: `string` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationproperty) + +### xdm:destinationProperty Type + + +`string` + + + + + + +## xdm:destinationSchema +### Destination Schema + +The destination schema this descriptor applies to + +`xdm:destinationSchema` +* is optional +* type: `string` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationschema) + +### xdm:destinationSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:destinationVersion +### Destination Version + +Major version being referenced. + +`xdm:destinationVersion` +* is optional +* type: `number` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmdestinationversion) + +### xdm:destinationVersion Type + + +`number` + + + + + + +## xdm:label +### Label + +`xdm:label` +* is optional +* type: `string` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmlabel) + +### xdm:label Type + + +`string` + + + + + + +## xdm:sourceItem +### Source Item + +When present, the selector used to match a specific item in the array pointed to by `sourceProperty`. + +`xdm:sourceItem` +* is optional +* type: complex +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) + +### xdm:sourceItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:sourceProperty +### Source Property + +When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`. + +`xdm:sourceProperty` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) + +### xdm:sourceProperty Type + + +`string` + + + + + + +## xdm:sourceSchema +### Source Schema + +The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors' + +`xdm:sourceSchema` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) + +### xdm:sourceSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:sourceValue +### Source Value + +When present, provides additional information about the values in that field. Descriptor producer and consumer should coordinate on how to use this field, e.g. defining rules on formats, values, and operations. + +`xdm:sourceValue` +* is optional +* type: `string` +* defined in [Relationship Descriptor](../relationshipdescriptor.schema.md#xdmsourcevalue) + +### xdm:sourceValue Type + + +`string` + + + + + + +## xdm:sourceVersion +### Source Version + +Major version being referenced. + +`xdm:sourceVersion` +* is optional +* type: `number` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) + +### xdm:sourceVersion Type + + +`number` + + + + + diff --git a/docs/reference/descriptors/relationship/eventRelationship.schema.json b/docs/reference/descriptors/relationship/eventRelationship.schema.json new file mode 100644 index 000000000..4902c61f6 --- /dev/null +++ b/docs/reference/descriptors/relationship/eventRelationship.schema.json @@ -0,0 +1,61 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/eventRelationship", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Event Relationship Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Used by the UPS system to assign the specific schema that will used for the timeSeriesEvents field which is part of the union view of a class. If not supplied, the system today will default to the unified ExperienceEvent.", + "definitions": { + "eventRelationship": { + "properties": { + "@type": { + "type": "string", + "const": "xdm:eventRelationship" + }, + "xdm:destinationSchema": { + "title": "Destination Schema", + "type": "string", + "format": "uri", + "description": "The destination schema this descriptor applies to" + }, + "xdm:destinationVersion": { + "title": "Destination Version", + "type": "number", + "description": "When present, major version being referenced." + } + }, + "required": [ + "xdm:destinationSchema", + "xdm:destinationVersion" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "#/definitions/eventRelationship" + } + ], + "meta:status": "stable", + "examples": [ + { + "@type": "xdm:eventRelationship", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile__union", + "xdm:sourceVersion": 1, + "xdm:destinationSchema": "https://ns.adobe.com/xdm/context/experienceevent__union", + "xdm:destinationVersion": 1 + } + ] +} \ No newline at end of file diff --git a/docs/reference/descriptors/relationship/eventRelationship.schema.md b/docs/reference/descriptors/relationship/eventRelationship.schema.md new file mode 100644 index 000000000..80f77d9b4 --- /dev/null +++ b/docs/reference/descriptors/relationship/eventRelationship.schema.md @@ -0,0 +1,219 @@ + +# Event Relationship Descriptor Schema + +``` +https://ns.adobe.com/xdm/common/descriptors/eventRelationship +``` + +Used by the UPS system to assign the specific schema that will used for the timeSeriesEvents field which is part of the union view of a class. If not supplied, the system today will default to the unified ExperienceEvent. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [descriptors/relationship/eventRelationship.schema.json](descriptors/relationship/eventRelationship.schema.json) | +## Schema Hierarchy + +* Event Relationship Descriptor `https://ns.adobe.com/xdm/common/descriptors/eventRelationship` + * [Schema Descriptor](../schemadescriptor.schema.md) `https://ns.adobe.com/xdm/common/descriptors/schemadescriptor` + + +## Event Relationship Descriptor Example +```json +{ + "@type": "xdm:eventRelationship", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile__union", + "xdm:sourceVersion": 1, + "xdm:destinationSchema": "https://ns.adobe.com/xdm/context/experienceevent__union", + "xdm:destinationVersion": 1 +} +``` + +# Event Relationship Descriptor Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#id) | +| [@type](#type) | `const` | Optional | Event Relationship Descriptor (this schema) | +| [xdm:destinationSchema](#xdmdestinationschema) | `string` | Optional | Event Relationship Descriptor (this schema) | +| [xdm:destinationVersion](#xdmdestinationversion) | `number` | Optional | Event Relationship Descriptor (this schema) | +| [xdm:sourceItem](#xdmsourceitem) | complex | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) | +| [xdm:sourceProperty](#xdmsourceproperty) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) | +| [xdm:sourceSchema](#xdmsourceschema) | `string` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) | +| [xdm:sourceVersion](#xdmsourceversion) | `number` | Optional | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'. + +`@id` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## @type + + +`@type` +* is optional +* type: `const` +* defined in this schema + +The value of this property **must** be equal to: + +```json +"xdm:eventRelationship" +``` + + + + + +## xdm:destinationSchema +### Destination Schema + +The destination schema this descriptor applies to + +`xdm:destinationSchema` +* is optional +* type: `string` +* defined in this schema + +### xdm:destinationSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:destinationVersion +### Destination Version + +When present, major version being referenced. + +`xdm:destinationVersion` +* is optional +* type: `number` +* defined in this schema + +### xdm:destinationVersion Type + + +`number` + + + + + + +## xdm:sourceItem +### Source Item + +When present, the selector used to match a specific item in the array pointed to by `sourceProperty`. + +`xdm:sourceItem` +* is optional +* type: complex +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) + +### xdm:sourceItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:sourceProperty +### Source Property + +When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`. + +`xdm:sourceProperty` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) + +### xdm:sourceProperty Type + + +`string` + + + + + + +## xdm:sourceSchema +### Source Schema + +The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors' + +`xdm:sourceSchema` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) + +### xdm:sourceSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:sourceVersion +### Source Version + +Major version being referenced. + +`xdm:sourceVersion` +* is optional +* type: `number` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) + +### xdm:sourceVersion Type + + +`number` + + + + + diff --git a/docs/reference/descriptors/relationshipdescriptor.schema.json b/docs/reference/descriptors/relationshipdescriptor.schema.json new file mode 100644 index 000000000..1930599ef --- /dev/null +++ b/docs/reference/descriptors/relationshipdescriptor.schema.json @@ -0,0 +1,94 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Relationship Descriptor", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "A descriptor that describes a relationship between two schemas, a 'source' and a 'destination'.\n\nThis relationship may be directly between the schemas, or between specific properties of the schemas. Relationship descriptors may be used to describe foreign key relationships between schemas, defining a relational model or star schema.\n\nWhile schema descriptors can be used to define metadata about a single schema, they are also commonly used to describe relationships between schemas. This mechanism can be used to link schemas together at the property level, defining the equivalent of \"foreign key\" relationships in a relational database.\n\nThe following relationship types are defined by XDM:\n\n- `xdm:oneToOne`: describes a 1:1 relationship between a source schema and a destination schema\n- `xdm:oneToMany`: describes a 1:m relationship between a source schema and a destination schema\n- `xdm:manyToOne`: describes a m:1 relationship between a source schema and a destination schema\n- `xdm:manyToMany`: describes an m:n relationship between a source schema and a destination schema\n\n## Arrays and Denormalized Links\n\nThe interpretation of the relationship descriptor is modified slightly when the descriptor is applied to an array property. When the source property is an array, this indicates that the array contains a set of values, each of which reference an instance of the destination schema type based on the provided destination property.\n\nFor example, if a relationship of type `xdm:oneToMany` is applied with a source property that is an array, this is to be interpreted to mean that the items in the array each represent a value that can be linked to the corresponding property in the destination schema (either 1:1 or 1:m) and therefore the overall relationship being defined is 1:m.\n\n## Example Relationship Descriptor\n\nWe have two schemas, which form a parent/child relationship. The first is parent.json:\n\n```json\n{\n \"$schema\": \"http://json-schema.org/draft-06/schema#\",\n \"$id\": \"https://ns.adobe.com/xdm/example/parent\",\n \"title\": \"Parent\",\n \"type\": \"object\",\n \"properties\": {\n \"@id\": {\n \"meta:descriptors\": [\n {\n \"@type\": \"xdm:oneToMany\",\n \"xdm:destinationSchema\": \"https://ns.adobe.com/xdm/example/child\",\n \"xdm:destinationProperty\": \"xdm:parent\"\n }\n ],\n \"type\": \"string\"\n }\n }\n}\n```\n\nThe second is child.json:\n\n```json\n{\n \"$schema\": \"http://json-schema.org/draft-06/schema#\",\n \"$id\": \"https://ns.adobe.com/xdm/example/child\",\n \"title\": \"Child\",\n \"type\": \"object\",\n \"properties\": {\n \"@id\": { \"type\": \"string\" },\n \"xdm:parent\": {\n \"meta:descriptors\": [\n {\n \"@type\": \"xdm:manyToOne\",\n \"xdm:destinationSchema\": \"https://ns.adobe.com/xdm/example/parent\",\n \"xdm:destinationProperty\": \"@id\"\n }\n ],\n \"type\": \"string\",\n \"format\": \"uri\"\n }\n }\n}\n```\n\nThe source schema in this example is Parent, which contains a single relationship descriptor describing a one-to-many relationship between objects of schema Parent to objects of schema Child.\n\nThe above example shows how a descriptor may be embedded in the schema being described, directly on the property where it applies. The example also shows the reciprocal relationship between the parent and child entities. If we were to define this as a stand-alone descriptor, it would look like this:\n\n```json\n{\n \"@id\": \"https://example.com/descriptors/1\",\n \"@type\": \"xdm:oneToMany\",\n \"xdm:sourceSchema\": \"https://ns.adobe.com/xdm/example/parent\",\n \"xdm:sourcePropery\": \"@id\",\n \"xdm:destinationSchema\": \"https://ns.adobe.com/xdm/example/child\",\n \"xdm:destinationProperty\": \"xdm:parent\"\n}\n```\n\nThis highlights the ability to use schema descriptors both directly in schemas and also as independent entities.\n\n## Example Relationship Descriptor using an Array\n\nWe can also model the above parent/child relationship using a denormalized array from. The denormalized parent.json:\n\n```json\n{\n \"$schema\": \"http://json-schema.org/draft-06/schema#\",\n \"$id\": \"https://ns.adobe.com/xdm/example/parent\",\n \"title\": \"Parent\",\n \"type\": \"object\",\n \"properties\": {\n \"@id\": {\n \"type\": \"string\"\n },\n \"children\": {\n \"meta:descriptors\": [\n {\n \"@type\": \"xdm:oneToMany\",\n \"xdm:destinationSchema\": \"https://ns.adobe.com/xdm/example/child\",\n \"xdm:destinationProperty\": \"@id\"\n }\n ],\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"format\": \"uri\"\n }\n }\n }\n}\n```\n\nThis changes child.json to:\n\n```json\n{\n \"$schema\": \"http://json-schema.org/draft-06/schema#\",\n \"$id\": \"https://ns.adobe.com/xdm/example/child\",\n \"title\": \"Child\",\n \"type\": \"object\",\n \"properties\": {\n \"@id\": {\n \"meta:descriptors\": [\n {\n \"@type\": \"xdm:manyToOne\",\n \"xdm:destinationSchema\": \"https://ns.adobe.com/xdm/example/parent\",\n \"xdm:destinationProperty\": \"children\"\n }\n ],\n \"type\": \"string\"\n }\n }\n}\n```\n", + "definitions": { + "relationshipdescriptor": { + "properties": { + "xdm:destinationSchema": { + "title": "Destination Schema", + "type": "string", + "format": "uri", + "description": "The destination schema this descriptor applies to" + }, + "xdm:destinationProperty": { + "title": "Destination Property", + "type": "string", + "description": "When present, the property of the destination schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by 'xdm:destSchema'" + }, + "xdm:destinationItem": { + "title": "Destination Item", + "description": "When present, the selector used to match a specific item in the array pointed to by destProperty", + "$ref": "https://ns.adobe.com/xdm/common/descriptors/itemselector#/definitions/selector" + }, + "xdm:destinationVersion": { + "title": "Destination Version", + "type": "number", + "description": "Major version being referenced." + }, + "xdm:sourceValue": { + "title": "Source Value", + "type": "string", + "description": "When present, provides additional information about the values in that field. Descriptor producer and consumer should coordinate on how to use this field, e.g. defining rules on formats, values, and operations." + }, + "xdm:label": { + "title": "Label", + "type": "string" + } + }, + "oneOf": [ + { + "required": [ + "xdm:label" + ] + }, + { + "required": [ + "xdm:sourceProperty" + ] + } + ], + "required": [ + "xdm:destinationSchema", + "xdm:destinationVersion" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "#/definitions/relationshipdescriptor" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://example.com/descriptors/1", + "@type": "xdm:descriptorOneToOne", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:sourceProperty": "/xdm:identities", + "xdm:sourceVersion": 1, + "xdm:sourceItem": { + "xdm:type": "https://example.com/crmID" + }, + "xdm:destinationSchema": "https://ns.adobe.com/extensions/12345678/customers", + "xdm:destinationProperty": "/xdm:crmID", + "xdm:destinationVersion": 1 + } + ] +} \ No newline at end of file diff --git a/docs/reference/descriptors/relationshipdescriptor.schema.md b/docs/reference/descriptors/relationshipdescriptor.schema.md new file mode 100644 index 000000000..9dc68d45f --- /dev/null +++ b/docs/reference/descriptors/relationshipdescriptor.schema.md @@ -0,0 +1,470 @@ + +# Relationship Descriptor Schema + +``` +https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor +``` + +A descriptor that describes a relationship between two schemas, a 'source' and a 'destination'. + +This relationship may be directly between the schemas, or between specific properties of the schemas. Relationship descriptors may be used to describe foreign key relationships between schemas, defining a relational model or star schema. + +While schema descriptors can be used to define metadata about a single schema, they are also commonly used to describe relationships between schemas. This mechanism can be used to link schemas together at the property level, defining the equivalent of "foreign key" relationships in a relational database. + +The following relationship types are defined by XDM: + +- `xdm:oneToOne`: describes a 1:1 relationship between a source schema and a destination schema +- `xdm:oneToMany`: describes a 1:m relationship between a source schema and a destination schema +- `xdm:manyToOne`: describes a m:1 relationship between a source schema and a destination schema +- `xdm:manyToMany`: describes an m:n relationship between a source schema and a destination schema + +## Arrays and Denormalized Links + +The interpretation of the relationship descriptor is modified slightly when the descriptor is applied to an array property. When the source property is an array, this indicates that the array contains a set of values, each of which reference an instance of the destination schema type based on the provided destination property. + +For example, if a relationship of type `xdm:oneToMany` is applied with a source property that is an array, this is to be interpreted to mean that the items in the array each represent a value that can be linked to the corresponding property in the destination schema (either 1:1 or 1:m) and therefore the overall relationship being defined is 1:m. + +## Example Relationship Descriptor + +We have two schemas, which form a parent/child relationship. The first is parent.json: + +```json +{ + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/example/parent", + "title": "Parent", + "type": "object", + "properties": { + "@id": { + "meta:descriptors": [ + { + "@type": "xdm:oneToMany", + "xdm:destinationSchema": "https://ns.adobe.com/xdm/example/child", + "xdm:destinationProperty": "xdm:parent" + } + ], + "type": "string" + } + } +} +``` + +The second is child.json: + +```json +{ + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/example/child", + "title": "Child", + "type": "object", + "properties": { + "@id": { "type": "string" }, + "xdm:parent": { + "meta:descriptors": [ + { + "@type": "xdm:manyToOne", + "xdm:destinationSchema": "https://ns.adobe.com/xdm/example/parent", + "xdm:destinationProperty": "@id" + } + ], + "type": "string", + "format": "uri" + } + } +} +``` + +The source schema in this example is Parent, which contains a single relationship descriptor describing a one-to-many relationship between objects of schema Parent to objects of schema Child. + +The above example shows how a descriptor may be embedded in the schema being described, directly on the property where it applies. The example also shows the reciprocal relationship between the parent and child entities. If we were to define this as a stand-alone descriptor, it would look like this: + +```json +{ + "@id": "https://example.com/descriptors/1", + "@type": "xdm:oneToMany", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/example/parent", + "xdm:sourcePropery": "@id", + "xdm:destinationSchema": "https://ns.adobe.com/xdm/example/child", + "xdm:destinationProperty": "xdm:parent" +} +``` + +This highlights the ability to use schema descriptors both directly in schemas and also as independent entities. + +## Example Relationship Descriptor using an Array + +We can also model the above parent/child relationship using a denormalized array from. The denormalized parent.json: + +```json +{ + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/example/parent", + "title": "Parent", + "type": "object", + "properties": { + "@id": { + "type": "string" + }, + "children": { + "meta:descriptors": [ + { + "@type": "xdm:oneToMany", + "xdm:destinationSchema": "https://ns.adobe.com/xdm/example/child", + "xdm:destinationProperty": "@id" + } + ], + "type": "array", + "items": { + "type": "string", + "format": "uri" + } + } + } +} +``` + +This changes child.json to: + +```json +{ + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/example/child", + "title": "Child", + "type": "object", + "properties": { + "@id": { + "meta:descriptors": [ + { + "@type": "xdm:manyToOne", + "xdm:destinationSchema": "https://ns.adobe.com/xdm/example/parent", + "xdm:destinationProperty": "children" + } + ], + "type": "string" + } + } +} +``` + + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [descriptors/relationshipdescriptor.schema.json](descriptors/relationshipdescriptor.schema.json) | +## Schema Hierarchy + +* Relationship Descriptor `https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor` + * [Schema Descriptor](schemadescriptor.schema.md) `https://ns.adobe.com/xdm/common/descriptors/schemadescriptor` + * [Item Selector](itemselector.schema.md) `https://ns.adobe.com/xdm/common/descriptors/itemselector` + + +## Relationship Descriptor Example +```json +{ + "@id": "https://example.com/descriptors/1", + "@type": "xdm:descriptorOneToOne", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:sourceProperty": "/xdm:identities", + "xdm:sourceVersion": 1, + "xdm:sourceItem": { + "xdm:type": "https://example.com/crmID" + }, + "xdm:destinationSchema": "https://ns.adobe.com/extensions/12345678/customers", + "xdm:destinationProperty": "/xdm:crmID", + "xdm:destinationVersion": 1 +} +``` + +# Relationship Descriptor Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Schema Descriptor](schemadescriptor.schema.md#id) | +| [@type](#type) | `string` | Optional | [Schema Descriptor](schemadescriptor.schema.md#type) | +| [xdm:destinationItem](#xdmdestinationitem) | complex | Optional | Relationship Descriptor (this schema) | +| [xdm:destinationProperty](#xdmdestinationproperty) | `string` | Optional | Relationship Descriptor (this schema) | +| [xdm:destinationSchema](#xdmdestinationschema) | `string` | Optional | Relationship Descriptor (this schema) | +| [xdm:destinationVersion](#xdmdestinationversion) | `number` | Optional | Relationship Descriptor (this schema) | +| [xdm:label](#xdmlabel) | `string` | Optional | Relationship Descriptor (this schema) | +| [xdm:sourceItem](#xdmsourceitem) | complex | Optional | [Schema Descriptor](schemadescriptor.schema.md#xdmsourceitem) | +| [xdm:sourceProperty](#xdmsourceproperty) | `string` | Optional | [Schema Descriptor](schemadescriptor.schema.md#xdmsourceproperty) | +| [xdm:sourceSchema](#xdmsourceschema) | `string` | Optional | [Schema Descriptor](schemadescriptor.schema.md#xdmsourceschema) | +| [xdm:sourceValue](#xdmsourcevalue) | `string` | Optional | Relationship Descriptor (this schema) | +| [xdm:sourceVersion](#xdmsourceversion) | `number` | Optional | [Schema Descriptor](schemadescriptor.schema.md#xdmsourceversion) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'. + +`@id` +* is optional +* type: `string` +* defined in [Schema Descriptor](schemadescriptor.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## @type +### Type + +The type of descriptor this object represents. + +`@type` +* is optional +* type: `string` +* defined in [Schema Descriptor](schemadescriptor.schema.md#type) + +### @type Type + + +`string` + + + +### @type Known Values +| Value | Description | +|-------|-------------| + + + + +## xdm:destinationItem +### Destination Item + +When present, the selector used to match a specific item in the array pointed to by destProperty + +`xdm:destinationItem` +* is optional +* type: complex +* defined in this schema + +### xdm:destinationItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:destinationProperty +### Destination Property + +When present, the property of the destination schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by 'xdm:destSchema' + +`xdm:destinationProperty` +* is optional +* type: `string` +* defined in this schema + +### xdm:destinationProperty Type + + +`string` + + + + + + +## xdm:destinationSchema +### Destination Schema + +The destination schema this descriptor applies to + +`xdm:destinationSchema` +* is optional +* type: `string` +* defined in this schema + +### xdm:destinationSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:destinationVersion +### Destination Version + +Major version being referenced. + +`xdm:destinationVersion` +* is optional +* type: `number` +* defined in this schema + +### xdm:destinationVersion Type + + +`number` + + + + + + +## xdm:label +### Label + +`xdm:label` +* is optional +* type: `string` +* defined in this schema + +### xdm:label Type + + +`string` + + + + + + +## xdm:sourceItem +### Source Item + +When present, the selector used to match a specific item in the array pointed to by `sourceProperty`. + +`xdm:sourceItem` +* is optional +* type: complex +* defined in [Schema Descriptor](schemadescriptor.schema.md#xdmsourceitem) + +### xdm:sourceItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:sourceProperty +### Source Property + +When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`. + +`xdm:sourceProperty` +* is optional +* type: `string` +* defined in [Schema Descriptor](schemadescriptor.schema.md#xdmsourceproperty) + +### xdm:sourceProperty Type + + +`string` + + + + + + +## xdm:sourceSchema +### Source Schema + +The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors' + +`xdm:sourceSchema` +* is optional +* type: `string` +* defined in [Schema Descriptor](schemadescriptor.schema.md#xdmsourceschema) + +### xdm:sourceSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:sourceValue +### Source Value + +When present, provides additional information about the values in that field. Descriptor producer and consumer should coordinate on how to use this field, e.g. defining rules on formats, values, and operations. + +`xdm:sourceValue` +* is optional +* type: `string` +* defined in this schema + +### xdm:sourceValue Type + + +`string` + + + + + + +## xdm:sourceVersion +### Source Version + +Major version being referenced. + +`xdm:sourceVersion` +* is optional +* type: `number` +* defined in [Schema Descriptor](schemadescriptor.schema.md#xdmsourceversion) + +### xdm:sourceVersion Type + + +`number` + + + + + diff --git a/docs/reference/descriptors/schemadescriptor.schema.json b/docs/reference/descriptors/schemadescriptor.schema.json new file mode 100644 index 000000000..8d351b512 --- /dev/null +++ b/docs/reference/descriptors/schemadescriptor.schema.json @@ -0,0 +1,79 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Schema Descriptor", + "meta:extensible": true, + "meta:abstract": false, + "type": "object", + "description": "A descriptor that contains metadata about an XDM schema, including an optional property and array item selector, used to address the descriptor to a specific property or item.", + "definitions": { + "descriptor": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'." + }, + "@type": { + "title": "Type", + "type": "string", + "description": "The type of descriptor this object represents.", + "meta:enum": {} + }, + "xdm:sourceSchema": { + "title": "Source Schema", + "type": "string", + "format": "uri", + "description": "The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'" + }, + "xdm:sourceProperty": { + "title": "Source Property", + "type": "string", + "description": "When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`." + }, + "xdm:sourceVersion": { + "title": "Source Version", + "type": "number", + "description": "Major version being referenced." + }, + "xdm:sourceItem": { + "title": "Source Item", + "description": "When present, the selector used to match a specific item in the array pointed to by `sourceProperty`.", + "$ref": "https://ns.adobe.com/xdm/common/descriptors/itemselector#/definitions/selector" + } + }, + "required": [ + "xdm:sourceSchema", + "xdm:sourceVersion" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/descriptor" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://example.com/descriptors/1", + "@type": "xdm:descriptorPrimaryKey", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:sourceProperty": "xdm:identities", + "xdm:sourceVersion": 1, + "xdm:sourceItem": { + "xdm:type": "https://ns.adobe.com/experience/mcid" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/descriptors/schemadescriptor.schema.md b/docs/reference/descriptors/schemadescriptor.schema.md new file mode 100644 index 000000000..0947fab27 --- /dev/null +++ b/docs/reference/descriptors/schemadescriptor.schema.md @@ -0,0 +1,186 @@ + +# Schema Descriptor Schema + +``` +https://ns.adobe.com/xdm/common/descriptors/schemadescriptor +``` + +A descriptor that contains metadata about an XDM schema, including an optional property and array item selector, used to address the descriptor to a specific property or item. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [descriptors/schemadescriptor.schema.json](descriptors/schemadescriptor.schema.json) | +## Schema Hierarchy + +* Schema Descriptor `https://ns.adobe.com/xdm/common/descriptors/schemadescriptor` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Item Selector](itemselector.schema.md) `https://ns.adobe.com/xdm/common/descriptors/itemselector` + + +## Schema Descriptor Example +```json +{ + "@id": "https://example.com/descriptors/1", + "@type": "xdm:descriptorPrimaryKey", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:sourceProperty": "xdm:identities", + "xdm:sourceVersion": 1, + "xdm:sourceItem": { + "xdm:type": "https://ns.adobe.com/experience/mcid" + } +} +``` + +# Schema Descriptor Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | Schema Descriptor (this schema) | +| [@type](#type) | `string` | Optional | Schema Descriptor (this schema) | +| [xdm:sourceItem](#xdmsourceitem) | complex | Optional | Schema Descriptor (this schema) | +| [xdm:sourceProperty](#xdmsourceproperty) | `string` | Optional | Schema Descriptor (this schema) | +| [xdm:sourceSchema](#xdmsourceschema) | `string` | Optional | Schema Descriptor (this schema) | +| [xdm:sourceVersion](#xdmsourceversion) | `number` | Optional | Schema Descriptor (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'. + +`@id` +* is optional +* type: `string` +* defined in this schema + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## @type +### Type + +The type of descriptor this object represents. + +`@type` +* is optional +* type: `string` +* defined in this schema + +### @type Type + + +`string` + + + +### @type Known Values +| Value | Description | +|-------|-------------| + + + + +## xdm:sourceItem +### Source Item + +When present, the selector used to match a specific item in the array pointed to by `sourceProperty`. + +`xdm:sourceItem` +* is optional +* type: complex +* defined in this schema + +### xdm:sourceItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:sourceProperty +### Source Property + +When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`. + +`xdm:sourceProperty` +* is optional +* type: `string` +* defined in this schema + +### xdm:sourceProperty Type + + +`string` + + + + + + +## xdm:sourceSchema +### Source Schema + +The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors' + +`xdm:sourceSchema` +* is optional +* type: `string` +* defined in this schema + +### xdm:sourceSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:sourceVersion +### Source Version + +Major version being referenced. + +`xdm:sourceVersion` +* is optional +* type: `number` +* defined in this schema + +### xdm:sourceVersion Type + + +`number` + + + + + diff --git a/docs/reference/descriptors/search/searchdescriptor.schema.json b/docs/reference/descriptors/search/searchdescriptor.schema.json new file mode 100644 index 000000000..91e46f0c0 --- /dev/null +++ b/docs/reference/descriptors/search/searchdescriptor.schema.json @@ -0,0 +1,131 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/searchdescriptor", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Search Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Describes how XDM properties are to be handled for search, including the application of analyzers and operation in queries. The search:indexed descriptor is set to true to indicate that a property should be indexed, as specified by the values of the other search descriptor properties. When search:index is false (including by default), the other search descriptors will be ignored.\n\n# Descriptors\n\n| Descriptor | Description | Values | Default |\n| :--------------------- | :------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------ | :-------------- |\n| search:indexed | Whether this property is to be indexed | true, false | false |\n| search:store | Whether values are stored in the index and, if so, are included in results by default | notStored, stored, storedAndFetchByDefault | notStored |\n| search:filterable | When this property can be used as a filter in queries | true, false | false |\n| search:sort | Whether and how sorting is applied to this property | notSortable, sortedCaseSensitive, sortedCaseInsensitive | notSortable |\n| search:analyzers | The set of analyzers applied to property values during indexing | _See Analyzers, below_ | \\[ noAnalysis ] |\n| search:defaultAnalyzer | The analyzer output to be used when a query reference to this property is made without also specifying the analyzer | _See Analyzers, below_ |\n\n# Analyzers\n\n| Category | Description | Values |\n| :---------------- | :--------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------- |\n| null | Used to pass through property values without analysis | noAnalysis |\n| Standard | Lower-casing and standard grammar-based tokenization | standard |\n| Generic Language | Extends the Standard analyzer with better analysis of Asian languages, Unicode normalization, and Unicode-aware case folding | langGeneric |\n| Language-Specific | Extends the analyzer with language-specific knowledge | langFr (French)
langTh (Thai)
langDe (German)
langJa (Japanese)
langZh (Chinese) |\n| Prefix | Applies filters and tokenizers to values starting with patterns | startsWithDefaultAnalyzer
startsWithWhitespaceAnalyzer |\n| Custom | Applies semantics specific to specific value types | filename
filenameExtension |\n", + "definitions": { + "searchdescriptor": { + "properties": { + "search:indexed": { + "title": "Indexed", + "type": "boolean", + "description": "Whether the property is indexable and searchable.", + "default": false + }, + "search:filterable": { + "title": "Filterable", + "type": "boolean", + "description": "Whether the property can be used as a filter in search queries.", + "default": false + }, + "search:store": { + "title": "Stored", + "type": "string", + "description": "Whether the property value is stored in, and therefore can be retrieved from, the index.", + "meta:enum": { + "notStored": "notStored", + "stored": "stored", + "storedAndFetchByDefault": "storedAndFetchByDefault" + }, + "default": "notStored" + }, + "search:sort": { + "title": "Sort Type", + "type": "string", + "description": "Whether and how search results can be sorted on this property.", + "meta:enum": { + "notSortable": "notSortable", + "sorted": "sorted", + "sortedCaseSensitive": "sortedCaseSensitive", + "sortedCaseInsensitive": "sortedCaseInsensitive" + }, + "default": "notSortable" + }, + "search:analyzers": { + "title": "Analyzers", + "type": "array", + "items": { + "type": "string" + }, + "meta:enum": { + "noAnalysis": "noAnalysis", + "standard": "standard", + "langGeneric": "langGeneric", + "langFr": "langFr", + "langTh": "langTh", + "langDe": "langDe", + "langJa": "langJa", + "langZh": "langZh", + "startsWithDefaultAnalyzer": "startsWithDefaultAnalyzer", + "startsWithWhiteSpaceAnalyzer": "startsWithWhiteSpaceAnalyzer", + "fileName": "fileName", + "fileNameExtension": "fileNameExtension" + }, + "description": "A set of analyzers to be applied when indexing this property.", + "default": "noAnalysis" + }, + "search:defaultAnalyzer": { + "title": "Default analyzer", + "type": "string", + "description": "Default analyzer to be applied when search queries are made against this property.", + "meta:enum": { + "noAnalysis": "noAnalysis", + "standard": "standard", + "langGeneric": "langGeneric", + "langFr": "langFr", + "langTh": "langTh", + "langDe": "langDe", + "langJa": "langJa", + "langZh": "langZh", + "startsWithDefaultAnalyzer": "startsWithDefaultAnalyzer", + "startsWithWhiteSpaceAnalyzer": "startsWithWhiteSpaceAnalyzer", + "fileName": "fileName", + "fileNameExtension": "fileNameExtension" + }, + "default": "noAnalysis" + } + }, + "required": [ + "search:indexed" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "#/definitions/searchdescriptor" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://ns.adobe.com/xdm/common/descriptors/searchdescriptor", + "@type": "xdm:searchdescriptor", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:sourceVersion": 1, + "search:indexed": true, + "search:filterable": true, + "search:store": "storedAndFetchByDefault", + "search:sort": "sortedCaseInsensitive", + "search:analyzers": [ + "standard", + "noAnalysis" + ], + "search:defaultAnalyzer": "standard" + } + ] +} \ No newline at end of file diff --git a/docs/reference/descriptors/search/searchdescriptor.schema.md b/docs/reference/descriptors/search/searchdescriptor.schema.md new file mode 100644 index 000000000..c213f05b2 --- /dev/null +++ b/docs/reference/descriptors/search/searchdescriptor.schema.md @@ -0,0 +1,397 @@ + +# Search Descriptor Schema + +``` +https://ns.adobe.com/xdm/common/descriptors/searchdescriptor +``` + +Describes how XDM properties are to be handled for search, including the application of analyzers and operation in queries. The search:indexed descriptor is set to true to indicate that a property should be indexed, as specified by the values of the other search descriptor properties. When search:index is false (including by default), the other search descriptors will be ignored. + +# Descriptors + +| Descriptor | Description | Values | Default | +| :--------------------- | :------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------ | :-------------- | +| search:indexed | Whether this property is to be indexed | true, false | false | +| search:store | Whether values are stored in the index and, if so, are included in results by default | notStored, stored, storedAndFetchByDefault | notStored | +| search:filterable | When this property can be used as a filter in queries | true, false | false | +| search:sort | Whether and how sorting is applied to this property | notSortable, sortedCaseSensitive, sortedCaseInsensitive | notSortable | +| search:analyzers | The set of analyzers applied to property values during indexing | _See Analyzers, below_ | \[ noAnalysis ] | +| search:defaultAnalyzer | The analyzer output to be used when a query reference to this property is made without also specifying the analyzer | _See Analyzers, below_ | + +# Analyzers + +| Category | Description | Values | +| :---------------- | :--------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------- | +| null | Used to pass through property values without analysis | noAnalysis | +| Standard | Lower-casing and standard grammar-based tokenization | standard | +| Generic Language | Extends the Standard analyzer with better analysis of Asian languages, Unicode normalization, and Unicode-aware case folding | langGeneric | +| Language-Specific | Extends the analyzer with language-specific knowledge | langFr (French)
langTh (Thai)
langDe (German)
langJa (Japanese)
langZh (Chinese) | +| Prefix | Applies filters and tokenizers to values starting with patterns | startsWithDefaultAnalyzer
startsWithWhitespaceAnalyzer | +| Custom | Applies semantics specific to specific value types | filename
filenameExtension | + + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [descriptors/search/searchdescriptor.schema.json](descriptors/search/searchdescriptor.schema.json) | +## Schema Hierarchy + +* Search Descriptor `https://ns.adobe.com/xdm/common/descriptors/searchdescriptor` + * [Schema Descriptor](../schemadescriptor.schema.md) `https://ns.adobe.com/xdm/common/descriptors/schemadescriptor` + + +## Search Descriptor Example +```json +{ + "@id": "https://ns.adobe.com/xdm/common/descriptors/searchdescriptor", + "@type": "xdm:searchdescriptor", + "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile", + "xdm:sourceVersion": 1, + "search:indexed": true, + "search:filterable": true, + "search:store": "storedAndFetchByDefault", + "search:sort": "sortedCaseInsensitive", + "search:analyzers": [ + "standard", + "noAnalysis" + ], + "search:defaultAnalyzer": "standard" +} +``` + +# Search Descriptor Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [@id](#id) | `string` | Optional | | [Schema Descriptor](../schemadescriptor.schema.md#id) | +| [@type](#type) | `string` | Optional | | [Schema Descriptor](../schemadescriptor.schema.md#type) | +| [search:analyzers](#searchanalyzers) | `string[]` | Optional | `"noAnalysis"` | Search Descriptor (this schema) | +| [search:defaultAnalyzer](#searchdefaultanalyzer) | `string` | Optional | `"noAnalysis"` | Search Descriptor (this schema) | +| [search:filterable](#searchfilterable) | `boolean` | Optional | `false` | Search Descriptor (this schema) | +| [search:indexed](#searchindexed) | `boolean` | Optional | `false` | Search Descriptor (this schema) | +| [search:sort](#searchsort) | `string` | Optional | `"notSortable"` | Search Descriptor (this schema) | +| [search:store](#searchstore) | `string` | Optional | `"notStored"` | Search Descriptor (this schema) | +| [xdm:sourceItem](#xdmsourceitem) | complex | Optional | | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) | +| [xdm:sourceProperty](#xdmsourceproperty) | `string` | Optional | | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) | +| [xdm:sourceSchema](#xdmsourceschema) | `string` | Optional | | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) | +| [xdm:sourceVersion](#xdmsourceversion) | `number` | Optional | | [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'. + +`@id` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## @type +### Type + +The type of descriptor this object represents. + +`@type` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#type) + +### @type Type + + +`string` + + + +### @type Known Values +| Value | Description | +|-------|-------------| + + + + +## search:analyzers +### Analyzers + +A set of analyzers to be applied when indexing this property. + +`search:analyzers` +* is optional +* type: `string[]` + +* default: `"noAnalysis"` +* defined in this schema + +### search:analyzers Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + +### search:analyzers Known Values +| Value | Description | +|-------|-------------| +| `noAnalysis` | noAnalysis | +| `standard` | standard | +| `langGeneric` | langGeneric | +| `langFr` | langFr | +| `langTh` | langTh | +| `langDe` | langDe | +| `langJa` | langJa | +| `langZh` | langZh | +| `startsWithDefaultAnalyzer` | startsWithDefaultAnalyzer | +| `startsWithWhiteSpaceAnalyzer` | startsWithWhiteSpaceAnalyzer | +| `fileName` | fileName | +| `fileNameExtension` | fileNameExtension | + + + + +## search:defaultAnalyzer +### Default analyzer + +Default analyzer to be applied when search queries are made against this property. + +`search:defaultAnalyzer` +* is optional +* type: `string` +* default: `"noAnalysis"` +* defined in this schema + +### search:defaultAnalyzer Type + + +`string` + + + +### search:defaultAnalyzer Known Values +| Value | Description | +|-------|-------------| +| `noAnalysis` | noAnalysis | +| `standard` | standard | +| `langGeneric` | langGeneric | +| `langFr` | langFr | +| `langTh` | langTh | +| `langDe` | langDe | +| `langJa` | langJa | +| `langZh` | langZh | +| `startsWithDefaultAnalyzer` | startsWithDefaultAnalyzer | +| `startsWithWhiteSpaceAnalyzer` | startsWithWhiteSpaceAnalyzer | +| `fileName` | fileName | +| `fileNameExtension` | fileNameExtension | + + + + +## search:filterable +### Filterable + +Whether the property can be used as a filter in search queries. + +`search:filterable` +* is optional +* type: `boolean` +* default: `false` +* defined in this schema + +### search:filterable Type + + +`boolean` + + + + + +## search:indexed +### Indexed + +Whether the property is indexable and searchable. + +`search:indexed` +* is optional +* type: `boolean` +* default: `false` +* defined in this schema + +### search:indexed Type + + +`boolean` + + + + + +## search:sort +### Sort Type + +Whether and how search results can be sorted on this property. + +`search:sort` +* is optional +* type: `string` +* default: `"notSortable"` +* defined in this schema + +### search:sort Type + + +`string` + + + +### search:sort Known Values +| Value | Description | +|-------|-------------| +| `notSortable` | notSortable | +| `sorted` | sorted | +| `sortedCaseSensitive` | sortedCaseSensitive | +| `sortedCaseInsensitive` | sortedCaseInsensitive | + + + + +## search:store +### Stored + +Whether the property value is stored in, and therefore can be retrieved from, the index. + +`search:store` +* is optional +* type: `string` +* default: `"notStored"` +* defined in this schema + +### search:store Type + + +`string` + + + +### search:store Known Values +| Value | Description | +|-------|-------------| +| `notStored` | notStored | +| `stored` | stored | +| `storedAndFetchByDefault` | storedAndFetchByDefault | + + + + +## xdm:sourceItem +### Source Item + +When present, the selector used to match a specific item in the array pointed to by `sourceProperty`. + +`xdm:sourceItem` +* is optional +* type: complex +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceitem) + +### xdm:sourceItem Type + + +**One** of the following *conditions* need to be fulfilled. + + +#### Condition 1 + + + +#### Condition 2 + + + +#### Condition 3 + + + +#### Condition 4 + + + + + + + +## xdm:sourceProperty +### Source Property + +When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`. + +`xdm:sourceProperty` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceproperty) + +### xdm:sourceProperty Type + + +`string` + + + + + + +## xdm:sourceSchema +### Source Schema + +The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors' + +`xdm:sourceSchema` +* is optional +* type: `string` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceschema) + +### xdm:sourceSchema Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:sourceVersion +### Source Version + +Major version being referenced. + +`xdm:sourceVersion` +* is optional +* type: `number` +* defined in [Schema Descriptor](../schemadescriptor.schema.md#xdmsourceversion) + +### xdm:sourceVersion Type + + +`number` + + + + + diff --git a/docs/reference/destinations/destination-namespace.schema.json b/docs/reference/destinations/destination-namespace.schema.json new file mode 100644 index 000000000..7ab6c45b8 --- /dev/null +++ b/docs/reference/destinations/destination-namespace.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/destination-namespace", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Destinations Namespace Mapping", + "type": "object", + "meta:extensible": false, + "meta:abstract": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record" + ], + "description": "Destinations Namespace Mapping Schema.", + "definitions": { + "destination-namespace": { + "properties": { + "xdm:destinationID": { + "title": "Destination ID", + "type": "string", + "description": "Unique Identifier for a destination instance" + }, + "xdm:namespaceCode": { + "title": "Namespace Code", + "type": "string", + "description": "This code is a human readable identifier for the namespace and can be used to request the technical namespace id which is used for identity graph processing." + }, + "xdm:createTime": { + "title": "Create Time", + "type": "string", + "description": "The date and UTC time when the activation flow to the destination-namespace mapping was createdByID" + }, + "xdm:createdByID": { + "title": "Created User ID", + "type": "string", + "description": "ID of user who created the destination flow" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/destination-namespace" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:destinationID": "b297ed27-607e-4715-97ed-27607e171589", + "xdm:namespaceCode": "Email_LC_SHA256", + "xdm:createTime": "2019-01-01T15:52:25+00:00", + "xdm:createdByID": "mprabhak" + } + ] +} \ No newline at end of file diff --git a/docs/reference/destinations/destination-namespace.schema.md b/docs/reference/destinations/destination-namespace.schema.md new file mode 100644 index 000000000..8b4d5bc3e --- /dev/null +++ b/docs/reference/destinations/destination-namespace.schema.md @@ -0,0 +1,140 @@ + +# Destinations Namespace Mapping Schema + +``` +https://ns.adobe.com/xdm/context/destination-namespace +``` + +Destinations Namespace Mapping Schema. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [destinations/destination-namespace.schema.json](destinations/destination-namespace.schema.json) | +## Schema Hierarchy + +* Destinations Namespace Mapping `https://ns.adobe.com/xdm/context/destination-namespace` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Destinations Namespace Mapping Example +```json +{ + "xdm:destinationID": "b297ed27-607e-4715-97ed-27607e171589", + "xdm:namespaceCode": "Email_LC_SHA256", + "xdm:createTime": "2019-01-01T15:52:25+00:00", + "xdm:createdByID": "mprabhak" +} +``` + +# Destinations Namespace Mapping Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [xdm:createTime](#xdmcreatetime) | `string` | Optional | Destinations Namespace Mapping (this schema) | +| [xdm:createdByID](#xdmcreatedbyid) | `string` | Optional | Destinations Namespace Mapping (this schema) | +| [xdm:destinationID](#xdmdestinationid) | `string` | Optional | Destinations Namespace Mapping (this schema) | +| [xdm:namespaceCode](#xdmnamespacecode) | `string` | Optional | Destinations Namespace Mapping (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:createTime +### Create Time + +The date and UTC time when the activation flow to the destination-namespace mapping was createdByID + +`xdm:createTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:createTime Type + + +`string` + + + + + + +## xdm:createdByID +### Created User ID + +ID of user who created the destination flow + +`xdm:createdByID` +* is optional +* type: `string` +* defined in this schema + +### xdm:createdByID Type + + +`string` + + + + + + +## xdm:destinationID +### Destination ID + +Unique Identifier for a destination instance + +`xdm:destinationID` +* is optional +* type: `string` +* defined in this schema + +### xdm:destinationID Type + + +`string` + + + + + + +## xdm:namespaceCode +### Namespace Code + +This code is a human readable identifier for the namespace and can be used to request the technical namespace id which is used for identity graph processing. + +`xdm:namespaceCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:namespaceCode Type + + +`string` + + + + + diff --git a/docs/reference/destinations/destination-segment.schema.json b/docs/reference/destinations/destination-segment.schema.json new file mode 100644 index 000000000..62d6cc17d --- /dev/null +++ b/docs/reference/destinations/destination-segment.schema.json @@ -0,0 +1,64 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/destination-segment", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Destinations Segment Mapping", + "type": "object", + "meta:extensible": false, + "meta:abstract": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record" + ], + "description": "Destinations Segment Mapping Schema.", + "definitions": { + "destination-segment": { + "properties": { + "xdm:destinationID": { + "title": "Destination ID", + "type": "string", + "description": "Unique Identifier for a destination instance" + }, + "xdm:segmentID": { + "title": "Segment ID", + "type": "string", + "description": "Identity of the segment in the related namespace" + }, + "xdm:createTime": { + "title": "Create Time", + "type": "string", + "description": "The date and UTC time when the activation flow to the destination-segment mapping was createdByID" + }, + "xdm:createdByID": { + "title": "Created User ID", + "type": "string", + "description": "ID of user who created the destination flow" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/destination-segment" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:destinationID": "b297ed27-607e-4715-97ed-27607e171589", + "xdm:segmentID": "0b12f30c-2260-442e-9120-2b12e96c0c40", + "xdm:createTime": "2019-01-01T15:52:25+00:00", + "xdm:createdByID": "mprabhak" + } + ] +} \ No newline at end of file diff --git a/docs/reference/destinations/destination-segment.schema.md b/docs/reference/destinations/destination-segment.schema.md new file mode 100644 index 000000000..6283e2e26 --- /dev/null +++ b/docs/reference/destinations/destination-segment.schema.md @@ -0,0 +1,140 @@ + +# Destinations Segment Mapping Schema + +``` +https://ns.adobe.com/xdm/context/destination-segment +``` + +Destinations Segment Mapping Schema. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [destinations/destination-segment.schema.json](destinations/destination-segment.schema.json) | +## Schema Hierarchy + +* Destinations Segment Mapping `https://ns.adobe.com/xdm/context/destination-segment` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Destinations Segment Mapping Example +```json +{ + "xdm:destinationID": "b297ed27-607e-4715-97ed-27607e171589", + "xdm:segmentID": "0b12f30c-2260-442e-9120-2b12e96c0c40", + "xdm:createTime": "2019-01-01T15:52:25+00:00", + "xdm:createdByID": "mprabhak" +} +``` + +# Destinations Segment Mapping Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [xdm:createTime](#xdmcreatetime) | `string` | Optional | Destinations Segment Mapping (this schema) | +| [xdm:createdByID](#xdmcreatedbyid) | `string` | Optional | Destinations Segment Mapping (this schema) | +| [xdm:destinationID](#xdmdestinationid) | `string` | Optional | Destinations Segment Mapping (this schema) | +| [xdm:segmentID](#xdmsegmentid) | `string` | Optional | Destinations Segment Mapping (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:createTime +### Create Time + +The date and UTC time when the activation flow to the destination-segment mapping was createdByID + +`xdm:createTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:createTime Type + + +`string` + + + + + + +## xdm:createdByID +### Created User ID + +ID of user who created the destination flow + +`xdm:createdByID` +* is optional +* type: `string` +* defined in this schema + +### xdm:createdByID Type + + +`string` + + + + + + +## xdm:destinationID +### Destination ID + +Unique Identifier for a destination instance + +`xdm:destinationID` +* is optional +* type: `string` +* defined in this schema + +### xdm:destinationID Type + + +`string` + + + + + + +## xdm:segmentID +### Segment ID + +Identity of the segment in the related namespace + +`xdm:segmentID` +* is optional +* type: `string` +* defined in this schema + +### xdm:segmentID Type + + +`string` + + + + + diff --git a/docs/reference/destinations/destination.schema.json b/docs/reference/destinations/destination.schema.json new file mode 100644 index 000000000..71f2fe2aa --- /dev/null +++ b/docs/reference/destinations/destination.schema.json @@ -0,0 +1,92 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/destination", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Destinations", + "type": "object", + "meta:extensible": false, + "meta:abstract": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record" + ], + "description": "Destinations Schema.", + "definitions": { + "destination": { + "properties": { + "xdm:destinationID": { + "title": "Destination ID", + "type": "string", + "description": "Unique Identifier for a destination instance" + }, + "xdm:destinationName": { + "title": "Destination Name", + "type": "string", + "description": "Destination flow name" + }, + "xdm:destinationPlatform": { + "title": "Destination Platform", + "type": "string", + "description": "The destination platform selected for activation flow." + }, + "xdm:createTime": { + "title": "Create Time", + "type": "string", + "description": "The date and UTC time when the activation flow to the destination was createdByID" + }, + "xdm:createdByID": { + "title": "Created User ID", + "type": "string", + "description": "ID of user who created the destination flow" + }, + "xdm:destinationDescription": { + "title": "Destination Description", + "type": "string", + "description": "Destination flow description" + }, + "xdm:destinationStatus": { + "title": "Destination Status", + "type": "string", + "description": "Status of destination flow", + "meta:enum": { + "enabled": "Enabled and ready to use", + "disabled": "Disabled and cannot be used" + } + }, + "xdm:version": { + "title": "Version", + "type": "string", + "description": "Destination flow version" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/destination" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:destinationID": "b297ed27-607e-4715-97ed-27607e171589", + "xdm:destinationName": "Infa", + "xdm:destinationPlatform": "Informatica", + "xdm:createTime": "2019-01-01T15:52:25+00:00", + "xdm:createdByID": "mprabhbak", + "xdm:destinationDescription": "Informatica connection", + "xdm:destinationStatus": "enabled", + "xdm:version": "1.2" + } + ] +} \ No newline at end of file diff --git a/docs/reference/destinations/destination.schema.md b/docs/reference/destinations/destination.schema.md new file mode 100644 index 000000000..12f22c444 --- /dev/null +++ b/docs/reference/destinations/destination.schema.md @@ -0,0 +1,234 @@ + +# Destinations Schema + +``` +https://ns.adobe.com/xdm/context/destination +``` + +Destinations Schema. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [destinations/destination.schema.json](destinations/destination.schema.json) | +## Schema Hierarchy + +* Destinations `https://ns.adobe.com/xdm/context/destination` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Destinations Example +```json +{ + "xdm:destinationID": "b297ed27-607e-4715-97ed-27607e171589", + "xdm:destinationName": "Infa", + "xdm:destinationPlatform": "Informatica", + "xdm:createTime": "2019-01-01T15:52:25+00:00", + "xdm:createdByID": "mprabhbak", + "xdm:destinationDescription": "Informatica connection", + "xdm:destinationStatus": "enabled", + "xdm:version": "1.2" +} +``` + +# Destinations Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [xdm:createTime](#xdmcreatetime) | `string` | Optional | Destinations (this schema) | +| [xdm:createdByID](#xdmcreatedbyid) | `string` | Optional | Destinations (this schema) | +| [xdm:destinationDescription](#xdmdestinationdescription) | `string` | Optional | Destinations (this schema) | +| [xdm:destinationID](#xdmdestinationid) | `string` | Optional | Destinations (this schema) | +| [xdm:destinationName](#xdmdestinationname) | `string` | Optional | Destinations (this schema) | +| [xdm:destinationPlatform](#xdmdestinationplatform) | `string` | Optional | Destinations (this schema) | +| [xdm:destinationStatus](#xdmdestinationstatus) | `string` | Optional | Destinations (this schema) | +| [xdm:version](#xdmversion) | `string` | Optional | Destinations (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:createTime +### Create Time + +The date and UTC time when the activation flow to the destination was createdByID + +`xdm:createTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:createTime Type + + +`string` + + + + + + +## xdm:createdByID +### Created User ID + +ID of user who created the destination flow + +`xdm:createdByID` +* is optional +* type: `string` +* defined in this schema + +### xdm:createdByID Type + + +`string` + + + + + + +## xdm:destinationDescription +### Destination Description + +Destination flow description + +`xdm:destinationDescription` +* is optional +* type: `string` +* defined in this schema + +### xdm:destinationDescription Type + + +`string` + + + + + + +## xdm:destinationID +### Destination ID + +Unique Identifier for a destination instance + +`xdm:destinationID` +* is optional +* type: `string` +* defined in this schema + +### xdm:destinationID Type + + +`string` + + + + + + +## xdm:destinationName +### Destination Name + +Destination flow name + +`xdm:destinationName` +* is optional +* type: `string` +* defined in this schema + +### xdm:destinationName Type + + +`string` + + + + + + +## xdm:destinationPlatform +### Destination Platform + +The destination platform selected for activation flow. + +`xdm:destinationPlatform` +* is optional +* type: `string` +* defined in this schema + +### xdm:destinationPlatform Type + + +`string` + + + + + + +## xdm:destinationStatus +### Destination Status + +Status of destination flow + +`xdm:destinationStatus` +* is optional +* type: `string` +* defined in this schema + +### xdm:destinationStatus Type + + +`string` + + + +### xdm:destinationStatus Known Values +| Value | Description | +|-------|-------------| +| `enabled` | Enabled and ready to use | +| `disabled` | Disabled and cannot be used | + + + + +## xdm:version +### Version + +Destination flow version + +`xdm:version` +* is optional +* type: `string` +* defined in this schema + +### xdm:version Type + + +`string` + + + + + diff --git a/docs/reference/mixins/account/account-crm.schema.json b/docs/reference/mixins/account/account-crm.schema.json new file mode 100644 index 000000000..5180a79fb --- /dev/null +++ b/docs/reference/mixins/account/account-crm.schema.json @@ -0,0 +1,249 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/account-crm", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Account", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/account" + ], + "description": "An XDM Business Account.", + "definitions": { + "account-crm": { + "properties": { + "xdm:ownerID": { + "title": "Account Owner", + "description": "assigned owner of account. Not available in personal edition.", + "type": "string" + }, + "xdm:parentID": { + "title": "Parent Account", + "description": "Parent company for companies that are subsidiaries of a larger company or organization. The parent account must be an existing account in salesforce. You can enter the account name, or select (or optionally, create) the account using the lookup icon.", + "type": "string" + }, + "xdm:partnerAccountID": { + "title": "Partner Account Id", + "description": "Partner accounts are accounts that a channel manager uses to manage partner organizations, partner users, and activities when using a partner community or partner portal.", + "type": "string" + }, + "xdm:territoryID": { + "title": "Territory Id", + "description": "The territory to which the account has been assigned.", + "type": "string" + }, + "xdm:accountSite": { + "title": "Account Site Details", + "description": "Information about the account’s location, such as single location, headquarters, or branch. Up to 80 characters are allowed in this field.", + "type": "string" + }, + "xdm:currencyCode": { + "title": "Currency Code", + "type": "string", + "examples": [ + "USD", + "EUR" + ], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 currency code." + }, + "xdm:annualRevenue": { + "title": "Annual Revenue", + "description": "Estimated annual revenue of the account.", + "type": "number" + }, + "xdm:fax": { + "title": "Fax Number", + "description": "Fax number for the account.", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/phonenumber" + } + }, + "xdm:accountOrganization": { + "title": "Account Details", + "description": "Account details like number of employees, market segment, industry, and location.", + "$ref": "https://ns.adobe.com/xdm/common/organization" + }, + "xdm:naicsDescription": { + "title": "NAICS Description", + "description": "A brief description of an organization’s line of business, based on its NAICS code.", + "type": "string" + }, + "xdm:sicDescription": { + "title": "SIC Description", + "description": "A brief description of an organization’s line of business, based on its SIC code.", + "type": "string" + }, + "xdm:accountName": { + "title": "Account Name", + "description": "name of company. Up to 255 characters are allowed in this field.", + "type": "string" + }, + "xdm:accountDescription": { + "title": "Account Description", + "description": "Text description of the account.", + "type": "string" + }, + "xdm:ownership": { + "title": "Ownership", + "description": "Ownership of company, for example, public or private. Entry is selected from a picklist of available values, which a salesforce admin sets. Each picklist value can have up to 40 characters.", + "type": "string" + }, + "xdm:isDeleted": { + "title": "Account Record Deleted Indicator", + "description": "Indicator whether the Account record is deleted or not.", + "type": "boolean" + }, + "xdm:logoUrl": { + "title": "Logo URL", + "description": "Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the account. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the account.", + "type": "string", + "format": "uri" + }, + "xdm:sourceType": { + "title": "Account Source Type", + "description": "Source type for the account.", + "type": "string" + }, + "xdm:tradeStyle": { + "title": "Account Trade Style", + "description": "A name, different from its legal name, that an organization may use for conducting business. Similar to (Doing business as) or (DBA).", + "type": "string" + }, + "xdm:tickerSymbol": { + "title": "Ticker Symbol", + "description": "The stock market symbol for this account. Maximum of 20 characters.", + "type": "string" + }, + "xdm:billingAddress": { + "title": "Account Billing Address", + "description": "Billing address(es) for the account.", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/common/address" + } + }, + "xdm:shippingAddress": { + "title": "Account Shipping Address", + "description": "Shipping address(es) for the account.", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/common/address" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/account-crm" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:ownerID": "OWNER111", + "xdm:parentID": "ACC000", + "xdm:partnerAccountID": "PRTNR1111", + "xdm:territoryID": "Terr1", + "xdm:accountSite": "Additional account site details", + "xdm:currencyCode": "USD", + "xdm:annualRevenue": 10000000, + "xdm:fax": [ + { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + } + ], + "xdm:accountOrganization": { + "@id": "https://data.adobe.io/entities/org/orgid111", + "xdm:legalName": "ABC Stores", + "xdm:numberOfEmployees": 200, + "xdm:industry": "Retail", + "xdm:website": "http://www.abcstores.com", + "rating": 1, + "xdm:marketSegment": "apparel for kids", + "xdm:location": { + "@id": "https://data.adobe.io/entities/places/locid123", + "schema:description": "ABC Store location", + "xdm:address": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": true, + "xdm:type": "work", + "xdm:street1": "100 Lincoln Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95125", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + }, + "schema:telephone": "1-408-800-0000", + "xdm:identifier": { + "https://ns.adobe.com/xdm/external/dnb": "1234", + "https://ns.adobe.com/xdm/external/angellist": "https://angel.co/adobe" + }, + "xdm:classifier": { + "https://ns.adobe.com/xdm/external/sic": "1234", + "https://ns.adobe.com/xdm/external/naics": "1234" + } + } + }, + "xdm:naicsDescription": "Naics Description Here", + "xdm:sicDescription": "SIC Description Here", + "xdm:accountName": "Account 123", + "xdm:accountDescription": "Account Description", + "xdm:ownership": "Public", + "xdm:logoUrl": "https://sampleaccount.com/logo.png", + "xdm:tradeStyle": "Trade style here", + "xdm:tickerSymbol": "Ticker Symbol Here", + "xdm:isDeleted": false, + "xdm:billingAddress": [ + { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": true, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + } + ], + "xdm:shippingAddress": [ + { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": true, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/account/account-crm.schema.md b/docs/reference/mixins/account/account-crm.schema.md new file mode 100644 index 000000000..be25f8618 --- /dev/null +++ b/docs/reference/mixins/account/account-crm.schema.md @@ -0,0 +1,599 @@ + +# XDM Business Account Schema + +``` +https://ns.adobe.com/xdm/context/account-crm +``` + +An XDM Business Account. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [mixins/account/account-crm.schema.json](mixins/account/account-crm.schema.json) | +## Schema Hierarchy + +* XDM Business Account `https://ns.adobe.com/xdm/context/account-crm` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Organization](../../datatypes/organization.schema.md) `https://ns.adobe.com/xdm/common/organization` + + +## XDM Business Account Example +```json +{ + "xdm:ownerID": "OWNER111", + "xdm:parentID": "ACC000", + "xdm:partnerAccountID": "PRTNR1111", + "xdm:territoryID": "Terr1", + "xdm:accountSite": "Additional account site details", + "xdm:currencyCode": "USD", + "xdm:annualRevenue": 10000000, + "xdm:fax": [ + { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + } + ], + "xdm:accountOrganization": { + "@id": "https://data.adobe.io/entities/org/orgid111", + "xdm:legalName": "ABC Stores", + "xdm:numberOfEmployees": 200, + "xdm:industry": "Retail", + "xdm:website": "http://www.abcstores.com", + "rating": 1, + "xdm:marketSegment": "apparel for kids", + "xdm:location": { + "@id": "https://data.adobe.io/entities/places/locid123", + "schema:description": "ABC Store location", + "xdm:address": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": true, + "xdm:type": "work", + "xdm:street1": "100 Lincoln Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95125", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + }, + "schema:telephone": "1-408-800-0000", + "xdm:identifier": { + "https://ns.adobe.com/xdm/external/dnb": "1234", + "https://ns.adobe.com/xdm/external/angellist": "https://angel.co/adobe" + }, + "xdm:classifier": { + "https://ns.adobe.com/xdm/external/sic": "1234", + "https://ns.adobe.com/xdm/external/naics": "1234" + } + } + }, + "xdm:naicsDescription": "Naics Description Here", + "xdm:sicDescription": "SIC Description Here", + "xdm:accountName": "Account 123", + "xdm:accountDescription": "Account Description", + "xdm:ownership": "Public", + "xdm:logoUrl": "https://sampleaccount.com/logo.png", + "xdm:tradeStyle": "Trade style here", + "xdm:tickerSymbol": "Ticker Symbol Here", + "xdm:isDeleted": false, + "xdm:billingAddress": [ + { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": true, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + } + ], + "xdm:shippingAddress": [ + { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": true, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + } + ] +} +``` + +# XDM Business Account Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:accountDescription](#xdmaccountdescription) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:accountName](#xdmaccountname) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:accountOrganization](#xdmaccountorganization) | Organization | Optional | XDM Business Account (this schema) | +| [xdm:accountSite](#xdmaccountsite) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:annualRevenue](#xdmannualrevenue) | `number` | Optional | XDM Business Account (this schema) | +| [xdm:billingAddress](#xdmbillingaddress) | Postal address | Optional | XDM Business Account (this schema) | +| [xdm:currencyCode](#xdmcurrencycode) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:fax](#xdmfax) | Phone number | Optional | XDM Business Account (this schema) | +| [xdm:isDeleted](#xdmisdeleted) | `boolean` | Optional | XDM Business Account (this schema) | +| [xdm:logoUrl](#xdmlogourl) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:naicsDescription](#xdmnaicsdescription) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:ownerID](#xdmownerid) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:ownership](#xdmownership) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:parentID](#xdmparentid) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:partnerAccountID](#xdmpartneraccountid) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:shippingAddress](#xdmshippingaddress) | Postal address | Optional | XDM Business Account (this schema) | +| [xdm:sicDescription](#xdmsicdescription) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:sourceType](#xdmsourcetype) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:territoryID](#xdmterritoryid) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:tickerSymbol](#xdmtickersymbol) | `string` | Optional | XDM Business Account (this schema) | +| [xdm:tradeStyle](#xdmtradestyle) | `string` | Optional | XDM Business Account (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:accountDescription +### Account Description + +Text description of the account. + +`xdm:accountDescription` +* is optional +* type: `string` +* defined in this schema + +### xdm:accountDescription Type + + +`string` + + + + + + +## xdm:accountName +### Account Name + +name of company. Up to 255 characters are allowed in this field. + +`xdm:accountName` +* is optional +* type: `string` +* defined in this schema + +### xdm:accountName Type + + +`string` + + + + + + +## xdm:accountOrganization +### Account Details + +Account details like number of employees, market segment, industry, and location. + +`xdm:accountOrganization` +* is optional +* type: Organization +* defined in this schema + +### xdm:accountOrganization Type + + +* [Organization](../../datatypes/organization.schema.md) – `https://ns.adobe.com/xdm/common/organization` + + + + + +## xdm:accountSite +### Account Site Details + +Information about the account’s location, such as single location, headquarters, or branch. Up to 80 characters are allowed in this field. + +`xdm:accountSite` +* is optional +* type: `string` +* defined in this schema + +### xdm:accountSite Type + + +`string` + + + + + + +## xdm:annualRevenue +### Annual Revenue + +Estimated annual revenue of the account. + +`xdm:annualRevenue` +* is optional +* type: `number` +* defined in this schema + +### xdm:annualRevenue Type + + +`number` + + + + + + +## xdm:billingAddress +### Account Billing Address + +Billing address(es) for the account. + +`xdm:billingAddress` +* is optional +* type: Postal address + +* defined in this schema + +### xdm:billingAddress Type + + +Array type: Postal address + +All items must be of the type: +* [Postal address](../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + + + + +## xdm:currencyCode +### Currency Code + +The ISO 4217 currency code. + +`xdm:currencyCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:currencyCode Type + + +`string` + + +All instances must conform to this regular expression +```regex +^[A-Z]{3}$ +``` + +* test example: [USD](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=USD) +* test example: [EUR](https://regexr.com/?expression=%5E%5BA-Z%5D%7B3%7D%24&text=EUR) + + + + +### xdm:currencyCode Examples + +```json +"USD" +``` + +```json +"EUR" +``` + + + +## xdm:fax +### Fax Number + +Fax number for the account. + +`xdm:fax` +* is optional +* type: Phone number + +* defined in this schema + +### xdm:fax Type + + +Array type: Phone number + +All items must be of the type: +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + + + + +## xdm:isDeleted +### Account Record Deleted Indicator + +Indicator whether the Account record is deleted or not. + +`xdm:isDeleted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isDeleted Type + + +`boolean` + + + + + +## xdm:logoUrl +### Logo URL + +Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the account. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the account. + +`xdm:logoUrl` +* is optional +* type: `string` +* defined in this schema + +### xdm:logoUrl Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:naicsDescription +### NAICS Description + +A brief description of an organization’s line of business, based on its NAICS code. + +`xdm:naicsDescription` +* is optional +* type: `string` +* defined in this schema + +### xdm:naicsDescription Type + + +`string` + + + + + + +## xdm:ownerID +### Account Owner + +assigned owner of account. Not available in personal edition. + +`xdm:ownerID` +* is optional +* type: `string` +* defined in this schema + +### xdm:ownerID Type + + +`string` + + + + + + +## xdm:ownership +### Ownership + +Ownership of company, for example, public or private. Entry is selected from a picklist of available values, which a salesforce admin sets. Each picklist value can have up to 40 characters. + +`xdm:ownership` +* is optional +* type: `string` +* defined in this schema + +### xdm:ownership Type + + +`string` + + + + + + +## xdm:parentID +### Parent Account + +Parent company for companies that are subsidiaries of a larger company or organization. The parent account must be an existing account in salesforce. You can enter the account name, or select (or optionally, create) the account using the lookup icon. + +`xdm:parentID` +* is optional +* type: `string` +* defined in this schema + +### xdm:parentID Type + + +`string` + + + + + + +## xdm:partnerAccountID +### Partner Account Id + +Partner accounts are accounts that a channel manager uses to manage partner organizations, partner users, and activities when using a partner community or partner portal. + +`xdm:partnerAccountID` +* is optional +* type: `string` +* defined in this schema + +### xdm:partnerAccountID Type + + +`string` + + + + + + +## xdm:shippingAddress +### Account Shipping Address + +Shipping address(es) for the account. + +`xdm:shippingAddress` +* is optional +* type: Postal address + +* defined in this schema + +### xdm:shippingAddress Type + + +Array type: Postal address + +All items must be of the type: +* [Postal address](../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + + + + +## xdm:sicDescription +### SIC Description + +A brief description of an organization’s line of business, based on its SIC code. + +`xdm:sicDescription` +* is optional +* type: `string` +* defined in this schema + +### xdm:sicDescription Type + + +`string` + + + + + + +## xdm:sourceType +### Account Source Type + +Source type for the account. + +`xdm:sourceType` +* is optional +* type: `string` +* defined in this schema + +### xdm:sourceType Type + + +`string` + + + + + + +## xdm:territoryID +### Territory Id + +The territory to which the account has been assigned. + +`xdm:territoryID` +* is optional +* type: `string` +* defined in this schema + +### xdm:territoryID Type + + +`string` + + + + + + +## xdm:tickerSymbol +### Ticker Symbol + +The stock market symbol for this account. Maximum of 20 characters. + +`xdm:tickerSymbol` +* is optional +* type: `string` +* defined in this schema + +### xdm:tickerSymbol Type + + +`string` + + + + + + +## xdm:tradeStyle +### Account Trade Style + +A name, different from its legal name, that an organization may use for conducting business. Similar to (Doing business as) or (DBA). + +`xdm:tradeStyle` +* is optional +* type: `string` +* defined in this schema + +### xdm:tradeStyle Type + + +`string` + + + + + diff --git a/docs/reference/mixins/activity-log/activity-log-details.schema.json b/docs/reference/mixins/activity-log/activity-log-details.schema.json new file mode 100644 index 000000000..67cb8ab32 --- /dev/null +++ b/docs/reference/mixins/activity-log/activity-log-details.schema.json @@ -0,0 +1,306 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/activity-log-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Activity Log details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/activity-log" + ], + "description": "An XDM Activity representing task or a business event", + "definitions": { + "activity-log-details": { + "properties": { + "xdm:activityDueDateTime": { + "title": "Activity Due date time", + "description": "Due date and time by which the activity should complete", + "type": "string", + "format": "date-time" + }, + "xdm:activityStartDateTime": { + "title": "Activity Start date time", + "description": "The date and time when the activity in the form of task/business event got started", + "type": "string", + "format": "date-time" + }, + "xdm:activityEndDateTime": { + "title": "Activity end date time", + "description": "The date and time when the activity in the form of task/business event got completed", + "type": "string", + "format": "date-time" + }, + "xdm:isTask": { + "title": "Activity is task or business event", + "description": "A boolean flag to represent whether the activity is a task of Event Management", + "type": "boolean" + }, + "xdm:isCompleted": { + "title": "Activity completed or still open to work on", + "type": "boolean", + "description": "A boolean flag to indicate whether the activity is completed" + }, + "xdm:isDeleted": { + "title": "Activity soft deletion", + "type": "boolean", + "description": "A boolean flag to indicate whether the activity is soft deleted" + }, + "xdm:highPriority": { + "title": "Activity is a high priority task", + "description": "A boolean flag to indicate whether the activity is of high priority", + "type": "boolean" + }, + "xdm:accountID": { + "title": "Business Account", + "description": "Business Account Unique Identifier", + "type": "string" + }, + "xdm:division": { + "title": "Division of Account Enterprise", + "description": "name of division of the account", + "type": "string" + }, + "xdm:ownerID": { + "title": "Ownership of the Activity", + "description": "The owner which is responsible for completing the task or event management", + "type": "string" + }, + "xdm:userID": { + "title": "User who is performing the activity", + "description": "The user initiating the activity", + "type": "string" + }, + "xdm:entity": { + "title": "Entity", + "description": "Holds Entity Name and its ID on which activity action is based upon.", + "properties": { + "xdm:name": { + "title": "Entity Name", + "description": "Holds Entity Name", + "type": "string" + }, + "xdm:ID": { + "title": "Entity tuple ID", + "description": "Holds Entity Tuple's Primary Identifier", + "type": "string" + } + }, + "required": [ + "xdm:name", + "xdm:ID" + ] + }, + "xdm:sourceType": { + "title": "Activity Source Type", + "description": "The upstream source from where the activity record has been syncronized", + "type": "string" + }, + "xdm:asset": { + "title": "Object asset", + "description": "Asset details for its type and ID", + "properties": { + "xdm:type": { + "title": "Asset Type", + "description": "Holds Asset Type", + "type": "string" + }, + "xdm:ID": { + "title": "Asset ID", + "description": "Holds Asset Identifier", + "type": "string" + } + }, + "required": [ + "xdm:type", + "xdm:ID" + ] + }, + "xdm:campaign": { + "title": "Campaign details", + "description": "Campaign amd its relevant associated details", + "properties": { + "xdm:ID": { + "title": "Campaign ID", + "description": "Unique identifer for Campaign.", + "type": "string" + }, + "xdm:type": { + "title": "Campaign Type", + "description": "The type of campaign for which audience is invited", + "type": "string" + }, + "xdm:member": { + "properties": { + "xdm:type": { + "title": "Member type", + "description": "Whether the Member is a lead or a contact", + "type": "string" + }, + "xdm:ID": { + "title": "ID of the Member", + "description": "Member's ID", + "type": "string" + } + } + }, + "xdm:program": { + "properties": { + "xdm:ID": { + "title": "Program ID associated with the campaign", + "description": "Unique identifer for Campaign.", + "type": "string" + }, + "xdm:type": { + "title": "Program Type", + "description": "The type of program which is associated with the campaign", + "type": "string" + }, + "xdm:step": { + "properties": { + "xdm:number": { + "title": "Workflow step number", + "description": "Program's Workflow Step Number", + "type": "integer" + }, + "xdm:status": { + "title": "Program Workflow Step Status", + "description": "Program's workflow name of the step status", + "type": "string" + } + } + } + } + } + } + }, + "xdm:activityDescription": { + "title": "Activity description", + "description": "Activity self detailed description", + "type": "string" + }, + "xdm:activitySubject": { + "title": "Subject of the activity", + "description": "Shortened version of the activityDescription", + "type": "string" + }, + "xdm:activityStatus": { + "title": "Activity Status", + "description": "Current Status of the activity", + "type": "string" + }, + "xdm:activityPriority": { + "title": "Activity priority", + "description": "Current priority of the activity", + "type": "string" + }, + "xdm:interactionEvents": { + "title": "Interaction Events", + "description": "collection of various forms of interactions", + "properties": { + "xdm:phoneCall": { + "title": "Phone interaction", + "$ref": "https://ns.adobe.com/xdm/common/phoneinteraction", + "description": "Contextual information captured during a given phone conversation" + }, + "xdm:meeting": { + "title": "Meeting", + "description": "Meeting details with location co-ordinates", + "properties": { + "xdm:meetingDetails": { + "title": "Meeting interaction", + "$ref": "https://ns.adobe.com/xdm/common/meetinginteraction", + "description": "Contextual information captured for a online/offline meeting" + }, + "xdm:location": { + "title": "Physical location of the event management if meeting is offline ", + "$ref": "https://ns.adobe.com/xdm/context/place", + "description": "Physical location where the meeting is taking place" + } + } + }, + "xdm:email": { + "title": "Email interaction", + "$ref": "https://ns.adobe.com/xdm/common/emailinteraction", + "description": "Contextual information captured during any given email message" + } + } + } + }, + "required": [ + "xdm:isTask" + ] + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/activity-log-details" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:activityDueDateTime": "2020-05-20T00:00:00+00:00", + "xdm:activityStartDateTime": "2020-05-19T09:05:25+00:00", + "xdm:activityEndDateTime": "2020-05-19T18:10:00+00:00", + "xdm:isTask": false, + "xdm:isCompleted": false, + "xdm:isDeleted": false, + "xdm:isHighPriority": false, + "xdm:accountID": "423", + "xdm:division": "div1", + "xdm:ownerID": "6534", + "xdm:userID": "3784", + "xdm:entity": { + "xdm:name": "Contact", + "xdm:ID": "7863" + }, + "xdm:sourceType": "Marketo", + "xdm:asset": { + "xdm:type": "Web Page", + "xdm:ID": "1654" + }, + "xdm:campaign": { + "xdm:ID": "C1875", + "xdm:type": "Marketing", + "xdm:member": { + "xdm:ID": "14563", + "xdm:type": "Contact" + }, + "xdm:program": { + "xdm:ID": "Webinar", + "xdm:type": "Event", + "xdm:step": { + "xdm:number": 10, + "xdm:status": "Invited" + } + } + }, + "xdm:activityDescription": "To organize a webinar on Finance", + "xdm:activitySubject": "Finance Webinar", + "xdm:activityStatus": "Not Started", + "xdm:activityPriority": "Normal", + "xdm:interactionEvents": { + "xdm:meeting": { + "xdm:meetingDetails": { + "xdm:isAllDay": true, + "xdm:inOnlineMeeting": true, + "xdm:isReminderSet": true, + "xdm:reminderDateTime": "2020-05-18T00:00:00+00:00", + "xdm:scheduledStartDateTime": "2020-05-19T09:00:00+00:00", + "xdm:scheduledEndDateTime": "2020-05-19T18:00:00+00:00", + "xdm:organizerID": "98536" + } + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/activity-log/activity-log-details.schema.md b/docs/reference/mixins/activity-log/activity-log-details.schema.md new file mode 100644 index 000000000..1373dc05c --- /dev/null +++ b/docs/reference/mixins/activity-log/activity-log-details.schema.md @@ -0,0 +1,639 @@ + +# XDM Business Activity Log details Schema + +``` +https://ns.adobe.com/xdm/context/activity-log-details +``` + +An XDM Activity representing task or a business event + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [mixins/activity-log/activity-log-details.schema.json](mixins/activity-log/activity-log-details.schema.json) | +## Schema Hierarchy + +* XDM Business Activity Log details `https://ns.adobe.com/xdm/context/activity-log-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## XDM Business Activity Log details Example +```json +{ + "xdm:activityDueDateTime": "2020-05-20T00:00:00+00:00", + "xdm:activityStartDateTime": "2020-05-19T09:05:25+00:00", + "xdm:activityEndDateTime": "2020-05-19T18:10:00+00:00", + "xdm:isTask": false, + "xdm:isCompleted": false, + "xdm:isDeleted": false, + "xdm:isHighPriority": false, + "xdm:accountID": "423", + "xdm:division": "div1", + "xdm:ownerID": "6534", + "xdm:userID": "3784", + "xdm:entity": { + "xdm:name": "Contact", + "xdm:ID": "7863" + }, + "xdm:sourceType": "Marketo", + "xdm:asset": { + "xdm:type": "Web Page", + "xdm:ID": "1654" + }, + "xdm:campaign": { + "xdm:ID": "C1875", + "xdm:type": "Marketing", + "xdm:member": { + "xdm:ID": "14563", + "xdm:type": "Contact" + }, + "xdm:program": { + "xdm:ID": "Webinar", + "xdm:type": "Event", + "xdm:step": { + "xdm:number": 10, + "xdm:status": "Invited" + } + } + }, + "xdm:activityDescription": "To organize a webinar on Finance", + "xdm:activitySubject": "Finance Webinar", + "xdm:activityStatus": "Not Started", + "xdm:activityPriority": "Normal", + "xdm:interactionEvents": { + "xdm:meeting": { + "xdm:meetingDetails": { + "xdm:isAllDay": true, + "xdm:inOnlineMeeting": true, + "xdm:isReminderSet": true, + "xdm:reminderDateTime": "2020-05-18T00:00:00+00:00", + "xdm:scheduledStartDateTime": "2020-05-19T09:00:00+00:00", + "xdm:scheduledEndDateTime": "2020-05-19T18:00:00+00:00", + "xdm:organizerID": "98536" + } + } + } +} +``` + +# XDM Business Activity Log details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:accountID](#xdmaccountid) | `string` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:activityDescription](#xdmactivitydescription) | `string` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:activityDueDateTime](#xdmactivityduedatetime) | `string` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:activityEndDateTime](#xdmactivityenddatetime) | `string` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:activityPriority](#xdmactivitypriority) | `string` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:activityStartDateTime](#xdmactivitystartdatetime) | `string` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:activityStatus](#xdmactivitystatus) | `string` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:activitySubject](#xdmactivitysubject) | `string` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:asset](#xdmasset) | complex | Optional | XDM Business Activity Log details (this schema) | +| [xdm:campaign](#xdmcampaign) | complex | Optional | XDM Business Activity Log details (this schema) | +| [xdm:division](#xdmdivision) | `string` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:entity](#xdmentity) | complex | Optional | XDM Business Activity Log details (this schema) | +| [xdm:highPriority](#xdmhighpriority) | `boolean` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:interactionEvents](#xdminteractionevents) | complex | Optional | XDM Business Activity Log details (this schema) | +| [xdm:isCompleted](#xdmiscompleted) | `boolean` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:isDeleted](#xdmisdeleted) | `boolean` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:isTask](#xdmistask) | `boolean` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:ownerID](#xdmownerid) | `string` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:sourceType](#xdmsourcetype) | `string` | Optional | XDM Business Activity Log details (this schema) | +| [xdm:userID](#xdmuserid) | `string` | Optional | XDM Business Activity Log details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:accountID +### Business Account + +Business Account Unique Identifier + +`xdm:accountID` +* is optional +* type: `string` +* defined in this schema + +### xdm:accountID Type + + +`string` + + + + + + +## xdm:activityDescription +### Activity description + +Activity self detailed description + +`xdm:activityDescription` +* is optional +* type: `string` +* defined in this schema + +### xdm:activityDescription Type + + +`string` + + + + + + +## xdm:activityDueDateTime +### Activity Due date time + +Due date and time by which the activity should complete + +`xdm:activityDueDateTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:activityDueDateTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:activityEndDateTime +### Activity end date time + +The date and time when the activity in the form of task/business event got completed + +`xdm:activityEndDateTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:activityEndDateTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:activityPriority +### Activity priority + +Current priority of the activity + +`xdm:activityPriority` +* is optional +* type: `string` +* defined in this schema + +### xdm:activityPriority Type + + +`string` + + + + + + +## xdm:activityStartDateTime +### Activity Start date time + +The date and time when the activity in the form of task/business event got started + +`xdm:activityStartDateTime` +* is optional +* type: `string` +* defined in this schema + +### xdm:activityStartDateTime Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:activityStatus +### Activity Status + +Current Status of the activity + +`xdm:activityStatus` +* is optional +* type: `string` +* defined in this schema + +### xdm:activityStatus Type + + +`string` + + + + + + +## xdm:activitySubject +### Subject of the activity + +Shortened version of the activityDescription + +`xdm:activitySubject` +* is optional +* type: `string` +* defined in this schema + +### xdm:activitySubject Type + + +`string` + + + + + + +## xdm:asset +### Object asset + +Asset details for its type and ID + +`xdm:asset` +* is optional +* type: complex +* defined in this schema + +### xdm:asset Type + +Unknown type ``. + +```json +{ + "title": "Object asset", + "description": "Asset details for its type and ID", + "properties": { + "xdm:type": { + "title": "Asset Type", + "description": "Holds Asset Type", + "type": "string" + }, + "xdm:ID": { + "title": "Asset ID", + "description": "Holds Asset Identifier", + "type": "string" + } + }, + "required": [ + "xdm:type", + "xdm:ID" + ], + "simpletype": "complex" +} +``` + + + + + +## xdm:campaign +### Campaign details + +Campaign amd its relevant associated details + +`xdm:campaign` +* is optional +* type: complex +* defined in this schema + +### xdm:campaign Type + +Unknown type ``. + +```json +{ + "title": "Campaign details", + "description": "Campaign amd its relevant associated details", + "properties": { + "xdm:ID": { + "title": "Campaign ID", + "description": "Unique identifer for Campaign.", + "type": "string" + }, + "xdm:type": { + "title": "Campaign Type", + "description": "The type of campaign for which audience is invited", + "type": "string" + }, + "xdm:member": { + "properties": { + "xdm:type": { + "title": "Member type", + "description": "Whether the Member is a lead or a contact", + "type": "string" + }, + "xdm:ID": { + "title": "ID of the Member", + "description": "Member's ID", + "type": "string" + } + } + }, + "xdm:program": { + "properties": { + "xdm:ID": { + "title": "Program ID associated with the campaign", + "description": "Unique identifer for Campaign.", + "type": "string" + }, + "xdm:type": { + "title": "Program Type", + "description": "The type of program which is associated with the campaign", + "type": "string" + }, + "xdm:step": { + "properties": { + "xdm:number": { + "title": "Workflow step number", + "description": "Program's Workflow Step Number", + "type": "integer" + }, + "xdm:status": { + "title": "Program Workflow Step Status", + "description": "Program's workflow name of the step status", + "type": "string" + } + } + } + } + } + }, + "simpletype": "complex" +} +``` + + + + + +## xdm:division +### Division of Account Enterprise + +name of division of the account + +`xdm:division` +* is optional +* type: `string` +* defined in this schema + +### xdm:division Type + + +`string` + + + + + + +## xdm:entity +### Entity + +Holds Entity Name and its ID on which activity action is based upon. + +`xdm:entity` +* is optional +* type: complex +* defined in this schema + +### xdm:entity Type + +Unknown type ``. + +```json +{ + "title": "Entity", + "description": "Holds Entity Name and its ID on which activity action is based upon.", + "properties": { + "xdm:name": { + "title": "Entity Name", + "description": "Holds Entity Name", + "type": "string" + }, + "xdm:ID": { + "title": "Entity tuple ID", + "description": "Holds Entity Tuple's Primary Identifier", + "type": "string" + } + }, + "required": [ + "xdm:name", + "xdm:ID" + ], + "simpletype": "complex" +} +``` + + + + + +## xdm:highPriority +### Activity is a high priority task + +A boolean flag to indicate whether the activity is of high priority + +`xdm:highPriority` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:highPriority Type + + +`boolean` + + + + + +## xdm:interactionEvents +### Interaction Events + +collection of various forms of interactions + +`xdm:interactionEvents` +* is optional +* type: complex +* defined in this schema + +### xdm:interactionEvents Type + +Unknown type ``. + +```json +{ + "title": "Interaction Events", + "description": "collection of various forms of interactions", + "properties": { + "xdm:phoneCall": { + "title": "Phone interaction", + "$ref": "https://ns.adobe.com/xdm/common/phoneinteraction", + "description": "Contextual information captured during a given phone conversation" + }, + "xdm:meeting": { + "title": "Meeting", + "description": "Meeting details with location co-ordinates", + "properties": { + "xdm:meetingDetails": { + "title": "Meeting interaction", + "$ref": "https://ns.adobe.com/xdm/common/meetinginteraction", + "description": "Contextual information captured for a online/offline meeting" + }, + "xdm:location": { + "title": "Physical location of the event management if meeting is offline ", + "$ref": "https://ns.adobe.com/xdm/context/place", + "description": "Physical location where the meeting is taking place" + } + } + }, + "xdm:email": { + "title": "Email interaction", + "$ref": "https://ns.adobe.com/xdm/common/emailinteraction", + "description": "Contextual information captured during any given email message" + } + }, + "simpletype": "complex" +} +``` + + + + + +## xdm:isCompleted +### Activity completed or still open to work on + +A boolean flag to indicate whether the activity is completed + +`xdm:isCompleted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isCompleted Type + + +`boolean` + + + + + +## xdm:isDeleted +### Activity soft deletion + +A boolean flag to indicate whether the activity is soft deleted + +`xdm:isDeleted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isDeleted Type + + +`boolean` + + + + + +## xdm:isTask +### Activity is task or business event + +A boolean flag to represent whether the activity is a task of Event Management + +`xdm:isTask` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isTask Type + + +`boolean` + + + + + +## xdm:ownerID +### Ownership of the Activity + +The owner which is responsible for completing the task or event management + +`xdm:ownerID` +* is optional +* type: `string` +* defined in this schema + +### xdm:ownerID Type + + +`string` + + + + + + +## xdm:sourceType +### Activity Source Type + +The upstream source from where the activity record has been syncronized + +`xdm:sourceType` +* is optional +* type: `string` +* defined in this schema + +### xdm:sourceType Type + + +`string` + + + + + + +## xdm:userID +### User who is performing the activity + +The user initiating the activity + +`xdm:userID` +* is optional +* type: `string` +* defined in this schema + +### xdm:userID Type + + +`string` + + + + + diff --git a/docs/reference/mixins/activity-type/activity-type-details.schema.json b/docs/reference/mixins/activity-type/activity-type-details.schema.json new file mode 100644 index 000000000..80c5db94a --- /dev/null +++ b/docs/reference/mixins/activity-type/activity-type-details.schema.json @@ -0,0 +1,51 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/activity-type-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Activity Type Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/activity-type" + ], + "description": "An XDM Activity representing task or a business event", + "definitions": { + "activity-type-details": { + "properties": { + "xdm:activityType": { + "title": "Activity Type Details", + "$ref": "https://ns.adobe.com/xdm/common/activity-type-reference-details", + "description": "Additional properties for Activity type" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/activity-type-details" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:activityType": { + "xdm:name": "Send Email", + "xdm:description": "Send Marketo Email to a person", + "xdm:type": "task", + "xdm:area": "Email", + "xdm:category": "Marketing Mail", + "xdm:isDeleted": false, + "xdm:isActive": true + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/activity-type/activity-type-details.schema.md b/docs/reference/mixins/activity-type/activity-type-details.schema.md new file mode 100644 index 000000000..ea91b57fa --- /dev/null +++ b/docs/reference/mixins/activity-type/activity-type-details.schema.md @@ -0,0 +1,59 @@ + +# XDM Activity Type Details Schema + +``` +https://ns.adobe.com/xdm/context/activity-type-details +``` + +An XDM Activity representing task or a business event + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [mixins/activity-type/activity-type-details.schema.json](mixins/activity-type/activity-type-details.schema.json) | +## Schema Hierarchy + +* XDM Activity Type Details `https://ns.adobe.com/xdm/context/activity-type-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [XDM Activity](../../datatypes/activity-type-reference-details.schema.md) `https://ns.adobe.com/xdm/common/activity-type-reference-details` + + +## XDM Activity Type Details Example +```json +{ + "xdm:activityType": { + "xdm:name": "Send Email", + "xdm:description": "Send Marketo Email to a person", + "xdm:type": "task", + "xdm:area": "Email", + "xdm:category": "Marketing Mail", + "xdm:isDeleted": false, + "xdm:isActive": true + } +} +``` + +# XDM Activity Type Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:activityType](#xdmactivitytype) | XDM Activity | Optional | XDM Activity Type Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:activityType +### Activity Type Details + +Additional properties for Activity type + +`xdm:activityType` +* is optional +* type: XDM Activity +* defined in this schema + +### xdm:activityType Type + + +* [XDM Activity](../../datatypes/activity-type-reference-details.schema.md) – `https://ns.adobe.com/xdm/common/activity-type-reference-details` + + + + diff --git a/docs/reference/mixins/campaign-member/campaign-member-details.schema.json b/docs/reference/mixins/campaign-member/campaign-member-details.schema.json new file mode 100644 index 000000000..6c4a6d7b8 --- /dev/null +++ b/docs/reference/mixins/campaign-member/campaign-member-details.schema.json @@ -0,0 +1,141 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/campaign-member-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Campaign Member Details", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/campaign-member" + ], + "description": "An XDM Business Campaign Member", + "definitions": { + "campaign-member-details": { + "properties": { + "xdm:campaignMember": { + "title": "Campaign Member", + "description": "Member type and associated reference ID", + "properties": { + "xdm:type": { + "title": "Member type", + "description": "Member's type e.g. lead or contact", + "type": "string" + }, + "xdm:ID": { + "title": "Member ID", + "description": "Member Unique Identifier", + "type": "string" + } + }, + "required": [ + "xdm:type", + "xdm:ID" + ] + }, + "xdm:response": { + "title": "Response of the Member", + "description": "Record whether the member has responded to the workflow stage", + "properties": { + "xdm:hasResponded": { + "title": "Response of the Member", + "description": "Record whether the member has responded to the workflow stage", + "type": "boolean" + }, + "xdm:respondDate": { + "title": "Date captured on which response was submitted", + "description": "Date of the response by the Member", + "type": "string", + "format": "date-time" + } + } + }, + "xdm:campaignProgram": { + "title": "Campaign's Program", + "description": "The name and the type of the program with which the campaign is associated, eg, 'Tradeshow'->'Event'", + "properties": { + "xdm:ID": { + "title": "Campaign Program ID", + "description": "Program ID with which the campaign is associated", + "type": "string" + }, + "xdm:type": { + "title": "Campaign Program Type", + "description": "Program Type with which the campaign is associated", + "type": "string" + }, + "xdm:step": { + "properties": { + "xdm:number": { + "title": "Campaign Program's control workflow step number", + "description": "Program's workflow step number with which the campaign is associated", + "type": "integer" + }, + "xdm:status": { + "title": "Campaign Program Step Status Name", + "description": "Program Step Status Name based on Step number with which the campaign is associated", + "type": "string" + } + }, + "required": [ + "xdm:number", + "xdm:status" + ] + } + }, + "required": [ + "xdm:ID", + "xdm:type" + ] + }, + "xdm:sourceType": { + "title": "Campaign Source Type", + "description": "The upstream source from where the campaign record has been syncronized", + "type": "string" + }, + "xdm:isDeleted": { + "title": "Campaign soft delete status", + "description": "A boolean flag which indicates whether the campaign is soft deleted in the system", + "type": "boolean" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/campaign-member-details" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:campaignMember": { + "xdm:type": "Lead", + "xdm:ID": "18765386" + }, + "xdm:response": { + "xdm:hasResponded": true, + "xdm:respondDate": "2020-05-19T00:00:00+00:00" + }, + "xdm:campaignProgram": { + "xdm:ID": "1", + "xdm:type": "Webinar", + "xdm:step": { + "xdm:number": 10, + "xdm:status": "Invited" + } + }, + "xdm:sourceType": "salesforce", + "xdm:isDeleted": false + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/campaign-member/campaign-member-details.schema.md b/docs/reference/mixins/campaign-member/campaign-member-details.schema.md new file mode 100644 index 000000000..414dfd258 --- /dev/null +++ b/docs/reference/mixins/campaign-member/campaign-member-details.schema.md @@ -0,0 +1,232 @@ + +# XDM Business Campaign Member Details Schema + +``` +https://ns.adobe.com/xdm/context/campaign-member-details +``` + +An XDM Business Campaign Member + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [mixins/campaign-member/campaign-member-details.schema.json](mixins/campaign-member/campaign-member-details.schema.json) | +## Schema Hierarchy + +* XDM Business Campaign Member Details `https://ns.adobe.com/xdm/context/campaign-member-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## XDM Business Campaign Member Details Example +```json +{ + "xdm:campaignMember": { + "xdm:type": "Lead", + "xdm:ID": "18765386" + }, + "xdm:response": { + "xdm:hasResponded": true, + "xdm:respondDate": "2020-05-19T00:00:00+00:00" + }, + "xdm:campaignProgram": { + "xdm:ID": "1", + "xdm:type": "Webinar", + "xdm:step": { + "xdm:number": 10, + "xdm:status": "Invited" + } + }, + "xdm:sourceType": "salesforce", + "xdm:isDeleted": false +} +``` + +# XDM Business Campaign Member Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:campaignMember](#xdmcampaignmember) | complex | Optional | XDM Business Campaign Member Details (this schema) | +| [xdm:campaignProgram](#xdmcampaignprogram) | complex | Optional | XDM Business Campaign Member Details (this schema) | +| [xdm:isDeleted](#xdmisdeleted) | `boolean` | Optional | XDM Business Campaign Member Details (this schema) | +| [xdm:response](#xdmresponse) | complex | Optional | XDM Business Campaign Member Details (this schema) | +| [xdm:sourceType](#xdmsourcetype) | `string` | Optional | XDM Business Campaign Member Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:campaignMember +### Campaign Member + +Member type and associated reference ID + +`xdm:campaignMember` +* is optional +* type: complex +* defined in this schema + +### xdm:campaignMember Type + +Unknown type ``. + +```json +{ + "title": "Campaign Member", + "description": "Member type and associated reference ID", + "properties": { + "xdm:type": { + "title": "Member type", + "description": "Member's type e.g. lead or contact", + "type": "string" + }, + "xdm:ID": { + "title": "Member ID", + "description": "Member Unique Identifier", + "type": "string" + } + }, + "required": [ + "xdm:type", + "xdm:ID" + ], + "simpletype": "complex" +} +``` + + + + + +## xdm:campaignProgram +### Campaign's Program + +The name and the type of the program with which the campaign is associated, eg, 'Tradeshow'->'Event' + +`xdm:campaignProgram` +* is optional +* type: complex +* defined in this schema + +### xdm:campaignProgram Type + +Unknown type ``. + +```json +{ + "title": "Campaign's Program", + "description": "The name and the type of the program with which the campaign is associated, eg, 'Tradeshow'->'Event'", + "properties": { + "xdm:ID": { + "title": "Campaign Program ID", + "description": "Program ID with which the campaign is associated", + "type": "string" + }, + "xdm:type": { + "title": "Campaign Program Type", + "description": "Program Type with which the campaign is associated", + "type": "string" + }, + "xdm:step": { + "properties": { + "xdm:number": { + "title": "Campaign Program's control workflow step number", + "description": "Program's workflow step number with which the campaign is associated", + "type": "integer" + }, + "xdm:status": { + "title": "Campaign Program Step Status Name", + "description": "Program Step Status Name based on Step number with which the campaign is associated", + "type": "string" + } + }, + "required": [ + "xdm:number", + "xdm:status" + ] + } + }, + "required": [ + "xdm:ID", + "xdm:type" + ], + "simpletype": "complex" +} +``` + + + + + +## xdm:isDeleted +### Campaign soft delete status + +A boolean flag which indicates whether the campaign is soft deleted in the system + +`xdm:isDeleted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isDeleted Type + + +`boolean` + + + + + +## xdm:response +### Response of the Member + +Record whether the member has responded to the workflow stage + +`xdm:response` +* is optional +* type: complex +* defined in this schema + +### xdm:response Type + +Unknown type ``. + +```json +{ + "title": "Response of the Member", + "description": "Record whether the member has responded to the workflow stage", + "properties": { + "xdm:hasResponded": { + "title": "Response of the Member", + "description": "Record whether the member has responded to the workflow stage", + "type": "boolean" + }, + "xdm:respondDate": { + "title": "Date captured on which response was submitted", + "description": "Date of the response by the Member", + "type": "string", + "format": "date-time" + } + }, + "simpletype": "complex" +} +``` + + + + + +## xdm:sourceType +### Campaign Source Type + +The upstream source from where the campaign record has been syncronized + +`xdm:sourceType` +* is optional +* type: `string` +* defined in this schema + +### xdm:sourceType Type + + +`string` + + + + + diff --git a/docs/reference/mixins/campaign-workflow/campaign-workflow-details.schema.json b/docs/reference/mixins/campaign-workflow/campaign-workflow-details.schema.json new file mode 100644 index 000000000..e4d770502 --- /dev/null +++ b/docs/reference/mixins/campaign-workflow/campaign-workflow-details.schema.json @@ -0,0 +1,350 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/campaign-workflow-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Campaign workflow", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/campaign-workflow" + ], + "description": "An XDM campaign workflow", + "definitions": { + "campaign-workflow-details": { + "properties": { + "xdm:campaignName": { + "title": "Campaign Name", + "description": "Name of the campaign", + "type": "string" + }, + "xdm:campaignDescription": { + "title": "Campaign description", + "description": "Detailed description of the campaign", + "type": "string" + }, + "xdm:campaignStartDate": { + "title": "Campaign Start date time", + "description": "The date and time when the campaign started", + "type": "string", + "format": "date-time" + }, + "xdm:campaignEndDate": { + "title": "Campaign End date time", + "description": "The date and time by which the campaign should end", + "type": "string", + "format": "date-time" + }, + "xdm:ownerID": { + "title": "Campaign Owner", + "type": "string", + "description": "The owner of the campaign" + }, + "xdm:timezoneName": { + "title": "Timezone Name", + "description": "Name of the timezone 'Pacific Time','Eastern time' etc.", + "type": "string" + }, + "xdm:parentCampaignID": { + "title": "Parent Campaign", + "description": "The parent of the campaignID", + "type": "string" + }, + "xdm:campaignProgram": { + "title": "Campaign's Program", + "description": "The ID and the type of the program with which the campaign is associated, eg, 'Tradeshow'->'Event'", + "properties": { + "xdm:ID": { + "title": "Program ID", + "description": "Program ID associated with the Campaign", + "type": "string" + }, + "xdm:type": { + "title": "Program Type", + "description": "Program's Type of the Program ID", + "type": "string" + } + }, + "required": [ + "xdm:ID", + "xdm:type" + ] + }, + "xdm:channelType": { + "title": "Channel Type", + "type": "string", + "description": "The type of the channel" + }, + "xdm:sourceType": { + "title": "Campaign Source Type", + "description": "The upstream source from where the campaign record has been syncronized", + "type": "string" + }, + "xdm:campaignStatus": { + "title": "Campaign Status", + "description": "Current Status of the campaign. eg. 'Active','Disabled' etc.", + "type": "string" + }, + "xdm:isDeleted": { + "title": "Campaign soft delete status", + "description": "A boolean flag which indicates whether the campaign is soft deleted in the system", + "type": "boolean" + }, + "xdm:isActive": { + "title": "Campaign Active status ", + "description": "A flag to indicate if the campaign is currently in the running/completed state", + "type": "boolean" + }, + "xdm:currencyCode": { + "title": "Currency code", + "description": "Standard ISO code(ISO 4217) for currency.", + "type": "string", + "pattern": "^([A-Z]{3})$" + }, + "xdm:budgetedCost": { + "title": "Budgeted Cost", + "description": "Cost for which the campaign has been budgeted", + "type": "number" + }, + "xdm:actualCost": { + "title": "Actual cost", + "description": "Actual cost spent for the campaign", + "type": "number" + }, + "xdm:webinarSession": { + "title": "Webinar details", + "description": "Webinar details captured if the campaign type is Webinar", + "type": "object", + "properties": { + "xdm:ID": { + "title": "Webinar session ID", + "description": "Detail description of the Webinar session.", + "type": "string" + }, + "xdm:name": { + "title": "Webinar session name", + "description": "Name of Webinar session.", + "type": "string" + }, + "xdm:description": { + "title": "Webinar detail description", + "description": "Detail description of the Webinar session", + "type": "string" + } + } + }, + "xdm:expectedParticipation": { + "title": "Expected Participation", + "description": "Metrics expected out of this campaign", + "type": "object", + "properties": { + "xdm:numberOfResponses": { + "title": "Responses expected", + "description": "Capture how many responses are expected for this campaign", + "type": "integer" + }, + "xdm:revenue": { + "title": "Revenue Expected", + "description": "Campaign's expected revenue", + "type": "number" + } + } + }, + "xdm:participation": { + "title": "Campaign participation", + "description": "Capture metrics related to what actually happenedfor the campaign", + "type": "object", + "properties": { + "xdm:numberOfRequestsSent": { + "title": "Number of Requests sent", + "description": "Number of requests sent to persons for participation", + "type": "integer" + }, + "xdm:numberOfResponses": { + "title": "Recieved Responses", + "description": "Number of responses recieved out of number of requests sent", + "type": "integer" + }, + "xdm:numberOfLeads": { + "title": "Number of leads", + "description": "Number of leads to whom the requests have sent", + "type": "integer" + }, + "xdm:numberOfConvertedLeads": { + "title": "Converted Leads", + "description": "Number to indicate that how many leads got converted by this campaign", + "type": "integer" + }, + "xdm:numberOfContacts": { + "title": "Number of Contacts", + "description": "Number to indicate that the request was sent to how many contacts", + "type": "integer" + } + } + }, + "xdm:opportunity": { + "title": "Opportunity details for the campaign", + "description": "Opportunity related metrics captured for the campaign", + "type": "object", + "properties": { + "xdm:numberOfOpportunities": { + "title": "Number of Opportunities", + "description": "Total number of opportunities associated with the campaign", + "type": "integer" + }, + "xdm:amountOfAllOpportunities": { + "title": "Amount for all opportunities", + "description": "Sum amount associated with all opportunities", + "type": "number" + }, + "xdm:numberOfWonOpportunities": { + "title": "Number of won Opportunities", + "description": "Number of converted opportunities", + "type": "integer" + }, + "xdm:amountOFWonOpportunities": { + "title": "Amount of Won Opportunities", + "description": "Sum amount of the converted opportunities", + "type": "number" + } + } + }, + "xdm:hierarchy": { + "title": "Hierarcy Metrics captured", + "description": "Metrics captured at each hierarchy of the campaign, provided there are sub-campaigns", + "type": "object", + "properties": { + "xdm:budgetedCost": { + "title": "Budgeted cost", + "description": "Cost for which the Campaign has been budgeted for", + "type": "number" + }, + "xdm:actualCost": { + "title": "Actual Cost", + "description": "Actual cost spent for the campaign", + "type": "number" + }, + "xdm:numberOfRequestsSent": { + "title": "Number of Requests sent", + "description": "Number of Requests sent to participants at each level", + "type": "integer" + }, + "xdm:numberOfResponses": { + "title": "Number of responses", + "description": "Number of responses recieved by the participants at each level of the hierarchy", + "type": "integer" + }, + "xdm:numberOfLeads": { + "title": "Number of leads", + "description": "Number of leads to whom the requests have sent", + "type": "integer" + }, + "xdm:numberOfConvertedLeads": { + "title": "Converted Leads", + "description": "Number to indicate that how many leads got converted by this campaign", + "type": "integer" + }, + "xdm:numberOfContacts": { + "title": "Number of Contacts", + "description": "Number to indicate that the request was sent to how many contacts", + "type": "integer" + }, + "xdm:numberOfOpportunities": { + "title": "Number of Opportunities", + "description": "Total number of opportunities associated with the campaign", + "type": "integer" + }, + "xdm:amountOfAllOpportunities": { + "title": "Amount for all opportunities", + "description": "Sum amount associated with all opportunities", + "type": "number" + }, + "xdm:numberOfWonOpportunities": { + "title": "Number of won Opportunities", + "description": "Number of converted opportunities", + "type": "integer" + }, + "xdm:amountOFWonOpportunities": { + "title": "Amount of Won Opportunities", + "description": "Sum amount of the converted opportunities", + "type": "number" + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/campaign-workflow-details" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:campaignName": "Direct Marketing on Financials", + "xdm:campaignDescription": "Campaign to attract individuals topurchase financial product", + "xdm:campaignStartDate": "2018-01-19T15:52:25+00:00", + "xdm:campaignEndDate": "2018-01-26T15:52:25+00:00", + "xdm:ownerID": "34567", + "xdm:timezoneName": "America/Los_Angeles", + "xdm:parentCampaignID": "12", + "xdm:campaignProgram": { + "xdm:ID": "1", + "xdm:type": "Webinar" + }, + "xdm:channelType": "Direct Mail", + "xdm:sourceType": "salesforce", + "xdm:campaignStatus": "In Progress", + "xdm:isDeleted": false, + "xdm:isActive": true, + "xdm:currencyCode": "USD", + "xdm:budgetedCost": 50000, + "xdm:actualCost": 46756, + "xdm:webinarSession": { + "xdm:ID": "12345", + "xdm:name": "Financial discipline", + "xdm:description": "Webinar for well being on finances" + }, + "xdm:expectedParticipation": { + "xdm:numberOfResponses": 243, + "xdm:revenue": 60000 + }, + "xdm:participation": { + "xdm:numberOfRequestsSent": 300, + "xdm:numberOfResponses": 276, + "xdm:numberOfLeads": 235, + "xdm:numberOfConvertedLeads": 200, + "xdm:numberOfContacts": 35 + }, + "xdm:opportunity": { + "xdm:numberOfOpportunities": 48, + "xdm:amountOfAllOpportunities": 500000, + "xdm:numberOfWonOpportunities": 34, + "xdm:amountOFWonOpportunities": 349850 + }, + "xdm:hierarchy": { + "xdm:budgetedCost": 50000, + "xdm:actualCost": 46756, + "xdm:numberOfRequestsSent": 300, + "xdm:numberOfResponses": 276, + "xdm:numberOfLeads": 235, + "xdm:numberOfConvertedLeads": 200, + "xdm:numberOfContacts": 35, + "xdm:numberOfOpportunities": 48, + "xdm:amountOfAllOpportunities": 500000, + "xdm:numberOfWonOpportunities": 34, + "xdm:amountOFWonOpportunities": 349850 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/campaign-workflow/campaign-workflow-details.schema.md b/docs/reference/mixins/campaign-workflow/campaign-workflow-details.schema.md new file mode 100644 index 000000000..196415c07 --- /dev/null +++ b/docs/reference/mixins/campaign-workflow/campaign-workflow-details.schema.md @@ -0,0 +1,1123 @@ + +# XDM Business Campaign workflow Schema + +``` +https://ns.adobe.com/xdm/context/campaign-workflow-details +``` + +An XDM campaign workflow + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [mixins/campaign-workflow/campaign-workflow-details.schema.json](mixins/campaign-workflow/campaign-workflow-details.schema.json) | +## Schema Hierarchy + +* XDM Business Campaign workflow `https://ns.adobe.com/xdm/context/campaign-workflow-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## XDM Business Campaign workflow Example +```json +{ + "xdm:campaignName": "Direct Marketing on Financials", + "xdm:campaignDescription": "Campaign to attract individuals topurchase financial product", + "xdm:campaignStartDate": "2018-01-19T15:52:25+00:00", + "xdm:campaignEndDate": "2018-01-26T15:52:25+00:00", + "xdm:ownerID": "34567", + "xdm:timezoneName": "America/Los_Angeles", + "xdm:parentCampaignID": "12", + "xdm:campaignProgram": { + "xdm:ID": "1", + "xdm:type": "Webinar" + }, + "xdm:channelType": "Direct Mail", + "xdm:sourceType": "salesforce", + "xdm:campaignStatus": "In Progress", + "xdm:isDeleted": false, + "xdm:isActive": true, + "xdm:currencyCode": "USD", + "xdm:budgetedCost": 50000, + "xdm:actualCost": 46756, + "xdm:webinarSession": { + "xdm:ID": "12345", + "xdm:name": "Financial discipline", + "xdm:description": "Webinar for well being on finances" + }, + "xdm:expectedParticipation": { + "xdm:numberOfResponses": 243, + "xdm:revenue": 60000 + }, + "xdm:participation": { + "xdm:numberOfRequestsSent": 300, + "xdm:numberOfResponses": 276, + "xdm:numberOfLeads": 235, + "xdm:numberOfConvertedLeads": 200, + "xdm:numberOfContacts": 35 + }, + "xdm:opportunity": { + "xdm:numberOfOpportunities": 48, + "xdm:amountOfAllOpportunities": 500000, + "xdm:numberOfWonOpportunities": 34, + "xdm:amountOFWonOpportunities": 349850 + }, + "xdm:hierarchy": { + "xdm:budgetedCost": 50000, + "xdm:actualCost": 46756, + "xdm:numberOfRequestsSent": 300, + "xdm:numberOfResponses": 276, + "xdm:numberOfLeads": 235, + "xdm:numberOfConvertedLeads": 200, + "xdm:numberOfContacts": 35, + "xdm:numberOfOpportunities": 48, + "xdm:amountOfAllOpportunities": 500000, + "xdm:numberOfWonOpportunities": 34, + "xdm:amountOFWonOpportunities": 349850 + } +} +``` + +# XDM Business Campaign workflow Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:actualCost](#xdmactualcost) | `number` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:budgetedCost](#xdmbudgetedcost) | `number` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:campaignDescription](#xdmcampaigndescription) | `string` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:campaignEndDate](#xdmcampaignenddate) | `string` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:campaignName](#xdmcampaignname) | `string` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:campaignProgram](#xdmcampaignprogram) | complex | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:campaignStartDate](#xdmcampaignstartdate) | `string` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:campaignStatus](#xdmcampaignstatus) | `string` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:channelType](#xdmchanneltype) | `string` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:currencyCode](#xdmcurrencycode) | `string` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:expectedParticipation](#xdmexpectedparticipation) | `object` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:hierarchy](#xdmhierarchy) | `object` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:isActive](#xdmisactive) | `boolean` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:isDeleted](#xdmisdeleted) | `boolean` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:opportunity](#xdmopportunity) | `object` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:ownerID](#xdmownerid) | `string` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:parentCampaignID](#xdmparentcampaignid) | `string` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:participation](#xdmparticipation) | `object` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:sourceType](#xdmsourcetype) | `string` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:timezoneName](#xdmtimezonename) | `string` | Optional | XDM Business Campaign workflow (this schema) | +| [xdm:webinarSession](#xdmwebinarsession) | `object` | Optional | XDM Business Campaign workflow (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:actualCost +### Actual cost + +Actual cost spent for the campaign + +`xdm:actualCost` +* is optional +* type: `number` +* defined in this schema + +### xdm:actualCost Type + + +`number` + + + + + + +## xdm:budgetedCost +### Budgeted Cost + +Cost for which the campaign has been budgeted + +`xdm:budgetedCost` +* is optional +* type: `number` +* defined in this schema + +### xdm:budgetedCost Type + + +`number` + + + + + + +## xdm:campaignDescription +### Campaign description + +Detailed description of the campaign + +`xdm:campaignDescription` +* is optional +* type: `string` +* defined in this schema + +### xdm:campaignDescription Type + + +`string` + + + + + + +## xdm:campaignEndDate +### Campaign End date time + +The date and time by which the campaign should end + +`xdm:campaignEndDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:campaignEndDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:campaignName +### Campaign Name + +Name of the campaign + +`xdm:campaignName` +* is optional +* type: `string` +* defined in this schema + +### xdm:campaignName Type + + +`string` + + + + + + +## xdm:campaignProgram +### Campaign's Program + +The ID and the type of the program with which the campaign is associated, eg, 'Tradeshow'->'Event' + +`xdm:campaignProgram` +* is optional +* type: complex +* defined in this schema + +### xdm:campaignProgram Type + +Unknown type ``. + +```json +{ + "title": "Campaign's Program", + "description": "The ID and the type of the program with which the campaign is associated, eg, 'Tradeshow'->'Event'", + "properties": { + "xdm:ID": { + "title": "Program ID", + "description": "Program ID associated with the Campaign", + "type": "string" + }, + "xdm:type": { + "title": "Program Type", + "description": "Program's Type of the Program ID", + "type": "string" + } + }, + "required": [ + "xdm:ID", + "xdm:type" + ], + "simpletype": "complex" +} +``` + + + + + +## xdm:campaignStartDate +### Campaign Start date time + +The date and time when the campaign started + +`xdm:campaignStartDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:campaignStartDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:campaignStatus +### Campaign Status + +Current Status of the campaign. eg. 'Active','Disabled' etc. + +`xdm:campaignStatus` +* is optional +* type: `string` +* defined in this schema + +### xdm:campaignStatus Type + + +`string` + + + + + + +## xdm:channelType +### Channel Type + +The type of the channel + +`xdm:channelType` +* is optional +* type: `string` +* defined in this schema + +### xdm:channelType Type + + +`string` + + + + + + +## xdm:currencyCode +### Currency code + +Standard ISO code(ISO 4217) for currency. + +`xdm:currencyCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:currencyCode Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E(%5BA-Z%5D%7B3%7D)%24)): +```regex +^([A-Z]{3})$ +``` + + + + + + +## xdm:expectedParticipation +### Expected Participation + +Metrics expected out of this campaign + +`xdm:expectedParticipation` +* is optional +* type: `object` +* defined in this schema + +### xdm:expectedParticipation Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:numberOfResponses`| integer | Optional | +| `xdm:revenue`| number | Optional | + + + +#### xdm:numberOfResponses +##### Responses expected + +Capture how many responses are expected for this campaign + +`xdm:numberOfResponses` +* is optional +* type: `integer` + +##### xdm:numberOfResponses Type + + +`integer` + + + + + + + + +#### xdm:revenue +##### Revenue Expected + +Campaign's expected revenue + +`xdm:revenue` +* is optional +* type: `number` + +##### xdm:revenue Type + + +`number` + + + + + + + + + + + +## xdm:hierarchy +### Hierarcy Metrics captured + +Metrics captured at each hierarchy of the campaign, provided there are sub-campaigns + +`xdm:hierarchy` +* is optional +* type: `object` +* defined in this schema + +### xdm:hierarchy Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:actualCost`| number | Optional | +| `xdm:amountOFWonOpportunities`| number | Optional | +| `xdm:amountOfAllOpportunities`| number | Optional | +| `xdm:budgetedCost`| number | Optional | +| `xdm:numberOfContacts`| integer | Optional | +| `xdm:numberOfConvertedLeads`| integer | Optional | +| `xdm:numberOfLeads`| integer | Optional | +| `xdm:numberOfOpportunities`| integer | Optional | +| `xdm:numberOfRequestsSent`| integer | Optional | +| `xdm:numberOfResponses`| integer | Optional | +| `xdm:numberOfWonOpportunities`| integer | Optional | + + + +#### xdm:actualCost +##### Actual Cost + +Actual cost spent for the campaign + +`xdm:actualCost` +* is optional +* type: `number` + +##### xdm:actualCost Type + + +`number` + + + + + + + + +#### xdm:amountOFWonOpportunities +##### Amount of Won Opportunities + +Sum amount of the converted opportunities + +`xdm:amountOFWonOpportunities` +* is optional +* type: `number` + +##### xdm:amountOFWonOpportunities Type + + +`number` + + + + + + + + +#### xdm:amountOfAllOpportunities +##### Amount for all opportunities + +Sum amount associated with all opportunities + +`xdm:amountOfAllOpportunities` +* is optional +* type: `number` + +##### xdm:amountOfAllOpportunities Type + + +`number` + + + + + + + + +#### xdm:budgetedCost +##### Budgeted cost + +Cost for which the Campaign has been budgeted for + +`xdm:budgetedCost` +* is optional +* type: `number` + +##### xdm:budgetedCost Type + + +`number` + + + + + + + + +#### xdm:numberOfContacts +##### Number of Contacts + +Number to indicate that the request was sent to how many contacts + +`xdm:numberOfContacts` +* is optional +* type: `integer` + +##### xdm:numberOfContacts Type + + +`integer` + + + + + + + + +#### xdm:numberOfConvertedLeads +##### Converted Leads + +Number to indicate that how many leads got converted by this campaign + +`xdm:numberOfConvertedLeads` +* is optional +* type: `integer` + +##### xdm:numberOfConvertedLeads Type + + +`integer` + + + + + + + + +#### xdm:numberOfLeads +##### Number of leads + +Number of leads to whom the requests have sent + +`xdm:numberOfLeads` +* is optional +* type: `integer` + +##### xdm:numberOfLeads Type + + +`integer` + + + + + + + + +#### xdm:numberOfOpportunities +##### Number of Opportunities + +Total number of opportunities associated with the campaign + +`xdm:numberOfOpportunities` +* is optional +* type: `integer` + +##### xdm:numberOfOpportunities Type + + +`integer` + + + + + + + + +#### xdm:numberOfRequestsSent +##### Number of Requests sent + +Number of Requests sent to participants at each level + +`xdm:numberOfRequestsSent` +* is optional +* type: `integer` + +##### xdm:numberOfRequestsSent Type + + +`integer` + + + + + + + + +#### xdm:numberOfResponses +##### Number of responses + +Number of responses recieved by the participants at each level of the hierarchy + +`xdm:numberOfResponses` +* is optional +* type: `integer` + +##### xdm:numberOfResponses Type + + +`integer` + + + + + + + + +#### xdm:numberOfWonOpportunities +##### Number of won Opportunities + +Number of converted opportunities + +`xdm:numberOfWonOpportunities` +* is optional +* type: `integer` + +##### xdm:numberOfWonOpportunities Type + + +`integer` + + + + + + + + + + + +## xdm:isActive +### Campaign Active status + +A flag to indicate if the campaign is currently in the running/completed state + +`xdm:isActive` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isActive Type + + +`boolean` + + + + + +## xdm:isDeleted +### Campaign soft delete status + +A boolean flag which indicates whether the campaign is soft deleted in the system + +`xdm:isDeleted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isDeleted Type + + +`boolean` + + + + + +## xdm:opportunity +### Opportunity details for the campaign + +Opportunity related metrics captured for the campaign + +`xdm:opportunity` +* is optional +* type: `object` +* defined in this schema + +### xdm:opportunity Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:amountOFWonOpportunities`| number | Optional | +| `xdm:amountOfAllOpportunities`| number | Optional | +| `xdm:numberOfOpportunities`| integer | Optional | +| `xdm:numberOfWonOpportunities`| integer | Optional | + + + +#### xdm:amountOFWonOpportunities +##### Amount of Won Opportunities + +Sum amount of the converted opportunities + +`xdm:amountOFWonOpportunities` +* is optional +* type: `number` + +##### xdm:amountOFWonOpportunities Type + + +`number` + + + + + + + + +#### xdm:amountOfAllOpportunities +##### Amount for all opportunities + +Sum amount associated with all opportunities + +`xdm:amountOfAllOpportunities` +* is optional +* type: `number` + +##### xdm:amountOfAllOpportunities Type + + +`number` + + + + + + + + +#### xdm:numberOfOpportunities +##### Number of Opportunities + +Total number of opportunities associated with the campaign + +`xdm:numberOfOpportunities` +* is optional +* type: `integer` + +##### xdm:numberOfOpportunities Type + + +`integer` + + + + + + + + +#### xdm:numberOfWonOpportunities +##### Number of won Opportunities + +Number of converted opportunities + +`xdm:numberOfWonOpportunities` +* is optional +* type: `integer` + +##### xdm:numberOfWonOpportunities Type + + +`integer` + + + + + + + + + + + +## xdm:ownerID +### Campaign Owner + +The owner of the campaign + +`xdm:ownerID` +* is optional +* type: `string` +* defined in this schema + +### xdm:ownerID Type + + +`string` + + + + + + +## xdm:parentCampaignID +### Parent Campaign + +The parent of the campaignID + +`xdm:parentCampaignID` +* is optional +* type: `string` +* defined in this schema + +### xdm:parentCampaignID Type + + +`string` + + + + + + +## xdm:participation +### Campaign participation + +Capture metrics related to what actually happenedfor the campaign + +`xdm:participation` +* is optional +* type: `object` +* defined in this schema + +### xdm:participation Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:numberOfContacts`| integer | Optional | +| `xdm:numberOfConvertedLeads`| integer | Optional | +| `xdm:numberOfLeads`| integer | Optional | +| `xdm:numberOfRequestsSent`| integer | Optional | +| `xdm:numberOfResponses`| integer | Optional | + + + +#### xdm:numberOfContacts +##### Number of Contacts + +Number to indicate that the request was sent to how many contacts + +`xdm:numberOfContacts` +* is optional +* type: `integer` + +##### xdm:numberOfContacts Type + + +`integer` + + + + + + + + +#### xdm:numberOfConvertedLeads +##### Converted Leads + +Number to indicate that how many leads got converted by this campaign + +`xdm:numberOfConvertedLeads` +* is optional +* type: `integer` + +##### xdm:numberOfConvertedLeads Type + + +`integer` + + + + + + + + +#### xdm:numberOfLeads +##### Number of leads + +Number of leads to whom the requests have sent + +`xdm:numberOfLeads` +* is optional +* type: `integer` + +##### xdm:numberOfLeads Type + + +`integer` + + + + + + + + +#### xdm:numberOfRequestsSent +##### Number of Requests sent + +Number of requests sent to persons for participation + +`xdm:numberOfRequestsSent` +* is optional +* type: `integer` + +##### xdm:numberOfRequestsSent Type + + +`integer` + + + + + + + + +#### xdm:numberOfResponses +##### Recieved Responses + +Number of responses recieved out of number of requests sent + +`xdm:numberOfResponses` +* is optional +* type: `integer` + +##### xdm:numberOfResponses Type + + +`integer` + + + + + + + + + + + +## xdm:sourceType +### Campaign Source Type + +The upstream source from where the campaign record has been syncronized + +`xdm:sourceType` +* is optional +* type: `string` +* defined in this schema + +### xdm:sourceType Type + + +`string` + + + + + + +## xdm:timezoneName +### Timezone Name + +Name of the timezone 'Pacific Time','Eastern time' etc. + +`xdm:timezoneName` +* is optional +* type: `string` +* defined in this schema + +### xdm:timezoneName Type + + +`string` + + + + + + +## xdm:webinarSession +### Webinar details + +Webinar details captured if the campaign type is Webinar + +`xdm:webinarSession` +* is optional +* type: `object` +* defined in this schema + +### xdm:webinarSession Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:ID`| string | Optional | +| `xdm:description`| string | Optional | +| `xdm:name`| string | Optional | + + + +#### xdm:ID +##### Webinar session ID + +Detail description of the Webinar session. + +`xdm:ID` +* is optional +* type: `string` + +##### xdm:ID Type + + +`string` + + + + + + + + +#### xdm:description +##### Webinar detail description + +Detail description of the Webinar session + +`xdm:description` +* is optional +* type: `string` + +##### xdm:description Type + + +`string` + + + + + + + + +#### xdm:name +##### Webinar session name + +Name of Webinar session. + +`xdm:name` +* is optional +* type: `string` + +##### xdm:name Type + + +`string` + + + + + + + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-advertising.schema.json b/docs/reference/mixins/experience-event/experienceevent-advertising.schema.json new file mode 100644 index 000000000..130b311a3 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-advertising.schema.json @@ -0,0 +1,66 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-advertising", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent details for advertising", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "This mixin is used to capture advertising details related to an ExperienceEvent, such as clicks, completes, impressions, and conversions.", + "definitions": { + "experienceevent-advertising": { + "properties": { + "xdm:advertising": { + "title": "Advertising", + "$ref": "https://ns.adobe.com/xdm/context/advertising", + "description": "Information related to advertising activity in ExperienceEvents." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-advertising" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:advertising": { + "xdm:adViewability": { + "xdm:adUnitDepth": 0, + "xdm:viewportHeight": 1250, + "xdm:viewportWidth": 1600, + "xdm:adHeight": 250, + "xdm:adWidth": 300, + "xdm:playerVolume": 85, + "xdm:measurementEligible": true, + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", + "xdm:version": "1" + }, + "xdm:viewable": true, + "xdm:activeWindow": true, + "xdm:percentViewable": 89, + "xdm:viewableFirstQuartile": { + "xdm:value": 1 + } + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-advertising.schema.md b/docs/reference/mixins/experience-event/experienceevent-advertising.schema.md new file mode 100644 index 000000000..9be09baf1 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-advertising.schema.md @@ -0,0 +1,74 @@ + +# ExperienceEvent details for advertising Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-advertising +``` + +This mixin is used to capture advertising details related to an ExperienceEvent, such as clicks, completes, impressions, and conversions. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-advertising.schema.json](mixins/experience-event/experienceevent-advertising.schema.json) | +## Schema Hierarchy + +* ExperienceEvent details for advertising `https://ns.adobe.com/xdm/context/experienceevent-advertising` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Advertising](../../datatypes/advertising.schema.md) `https://ns.adobe.com/xdm/context/advertising` + + +## ExperienceEvent details for advertising Example +```json +{ + "xdm:advertising": { + "xdm:adViewability": { + "xdm:adUnitDepth": 0, + "xdm:viewportHeight": 1250, + "xdm:viewportWidth": 1600, + "xdm:adHeight": 250, + "xdm:adWidth": 300, + "xdm:playerVolume": 85, + "xdm:measurementEligible": true, + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/adcloud/viewability", + "xdm:version": "1" + }, + "xdm:viewable": true, + "xdm:activeWindow": true, + "xdm:percentViewable": 89, + "xdm:viewableFirstQuartile": { + "xdm:value": 1 + } + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + } + } +} +``` + +# ExperienceEvent details for advertising Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:advertising](#xdmadvertising) | Advertising | Optional | ExperienceEvent details for advertising (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:advertising +### Advertising + +Information related to advertising activity in ExperienceEvents. + +`xdm:advertising` +* is optional +* type: Advertising +* defined in this schema + +### xdm:advertising Type + + +* [Advertising](../../datatypes/advertising.schema.md) – `https://ns.adobe.com/xdm/context/advertising` + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-application.schema.json b/docs/reference/mixins/experience-event/experienceevent-application.schema.json new file mode 100644 index 000000000..fc31d5f95 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-application.schema.json @@ -0,0 +1,50 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-application", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent application details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Application related data from ExperienceEvent observations.", + "definitions": { + "experienceevent-application": { + "properties": { + "xdm:application": { + "title": "Application", + "$ref": "https://ns.adobe.com/xdm/context/application", + "description": "This mixin is used to capture application information related to an ExperienceEvent, including the name of the application, app version, installs, launches, crashes, and closures. It could be either the application targeted by the event like the send of a push notification or the application originating the event such as a click, or a login." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-application" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:application": { + "xdm:id": "A123", + "xdm:name": "Myapp", + "xdm:version": "1.0.1", + "xdm:launches": { + "xdm:value": 1 + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-application.schema.md b/docs/reference/mixins/experience-event/experienceevent-application.schema.md new file mode 100644 index 000000000..44ce07c40 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-application.schema.md @@ -0,0 +1,58 @@ + +# ExperienceEvent application details Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-application +``` + +Application related data from ExperienceEvent observations. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-application.schema.json](mixins/experience-event/experienceevent-application.schema.json) | +## Schema Hierarchy + +* ExperienceEvent application details `https://ns.adobe.com/xdm/context/experienceevent-application` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Application](../../datatypes/application.schema.md) `https://ns.adobe.com/xdm/context/application` + + +## ExperienceEvent application details Example +```json +{ + "xdm:application": { + "xdm:id": "A123", + "xdm:name": "Myapp", + "xdm:version": "1.0.1", + "xdm:launches": { + "xdm:value": 1 + } + } +} +``` + +# ExperienceEvent application details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:application](#xdmapplication) | Application | Optional | ExperienceEvent application details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:application +### Application + +This mixin is used to capture application information related to an ExperienceEvent, including the name of the application, app version, installs, launches, crashes, and closures. It could be either the application targeted by the event like the send of a push notification or the application originating the event such as a click, or a login. + +`xdm:application` +* is optional +* type: Application +* defined in this schema + +### xdm:application Type + + +* [Application](../../datatypes/application.schema.md) – `https://ns.adobe.com/xdm/context/application` + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-channel.schema.json b/docs/reference/mixins/experience-event/experienceevent-channel.schema.json new file mode 100644 index 000000000..1e9bef8c1 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-channel.schema.json @@ -0,0 +1,46 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-channel", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent channel details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "This mixin is used to capture channel information related to an ExperienceEvent, including the channel ID, channel type, media type, and location type.", + "definitions": { + "experienceevent-channel": { + "properties": { + "xdm:channel": { + "title": "Experience channel", + "description": "Experience channel related to the ExperienceEvent.", + "$ref": "https://ns.adobe.com/xdm/channels/channel" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-channel" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-channel.schema.md b/docs/reference/mixins/experience-event/experienceevent-channel.schema.md new file mode 100644 index 000000000..0e4f99fce --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-channel.schema.md @@ -0,0 +1,54 @@ + +# ExperienceEvent channel details Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-channel +``` + +This mixin is used to capture channel information related to an ExperienceEvent, including the channel ID, channel type, media type, and location type. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-channel.schema.json](mixins/experience-event/experienceevent-channel.schema.json) | +## Schema Hierarchy + +* ExperienceEvent channel details `https://ns.adobe.com/xdm/context/experienceevent-channel` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Experience Channel](../../datatypes/channels/channel.schema.md) `https://ns.adobe.com/xdm/channels/channel` + + +## ExperienceEvent channel details Example +```json +{ + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + } +} +``` + +# ExperienceEvent channel details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:channel](#xdmchannel) | Experience Channel | Optional | ExperienceEvent channel details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:channel +### Experience channel + +Experience channel related to the ExperienceEvent. + +`xdm:channel` +* is optional +* type: Experience Channel +* defined in this schema + +### xdm:channel Type + + +* [Experience Channel](../../datatypes/channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel` + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-commerce.schema.json b/docs/reference/mixins/experience-event/experienceevent-commerce.schema.json new file mode 100644 index 000000000..148721ec3 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-commerce.schema.json @@ -0,0 +1,85 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-commerce", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent commerce details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "This mixin is used to capture information regarding commerce activities related to an ExperienceEvent such as standard cart operations (order, checkout, abandon) and product details (SKU, product name, quantity).", + "definitions": { + "experienceevent-commerce": { + "properties": { + "xdm:productListItems": { + "title": "Product list items", + "type": "array", + "description": "A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record.", + "items": { + "$ref": "https://ns.adobe.com/xdm/content/productlistitem" + } + }, + "xdm:commerce": { + "title": "Commerce", + "$ref": "https://ns.adobe.com/xdm/context/commerce", + "description": "Commerce specific data related to this event." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-commerce" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-commerce.schema.md b/docs/reference/mixins/experience-event/experienceevent-commerce.schema.md new file mode 100644 index 000000000..87e9624f7 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-commerce.schema.md @@ -0,0 +1,112 @@ + +# ExperienceEvent commerce details Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-commerce +``` + +This mixin is used to capture information regarding commerce activities related to an ExperienceEvent such as standard cart operations (order, checkout, abandon) and product details (SKU, product name, quantity). + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-commerce.schema.json](mixins/experience-event/experienceevent-commerce.schema.json) | +## Schema Hierarchy + +* ExperienceEvent commerce details `https://ns.adobe.com/xdm/context/experienceevent-commerce` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Commerce](../../datatypes/commerce.schema.md) `https://ns.adobe.com/xdm/context/commerce` + + +## ExperienceEvent commerce details Example +```json +{ + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + } +} +``` + +# ExperienceEvent commerce details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:commerce](#xdmcommerce) | Commerce | Optional | ExperienceEvent commerce details (this schema) | +| [xdm:productListItems](#xdmproductlistitems) | Product list item | Optional | ExperienceEvent commerce details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:commerce +### Commerce + +Commerce specific data related to this event. + +`xdm:commerce` +* is optional +* type: Commerce +* defined in this schema + +### xdm:commerce Type + + +* [Commerce](../../datatypes/commerce.schema.md) – `https://ns.adobe.com/xdm/context/commerce` + + + + + +## xdm:productListItems +### Product list items + +A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record. + +`xdm:productListItems` +* is optional +* type: Product list item + +* defined in this schema + +### xdm:productListItems Type + + +Array type: Product list item + +All items must be of the type: +* [Product list item](../../datatypes/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem` + + + + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-consumer.schema.json b/docs/reference/mixins/experience-event/experienceevent-consumer.schema.json new file mode 100644 index 000000000..1d8fb2398 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-consumer.schema.json @@ -0,0 +1,177 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-consumer", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Consumer ExperienceEvent mixin", + "type": "object", + "description": "This mixin groups a set of standard fields to describe the behavior of an individual as it relates to digital content consumption (web, mobile app) as well as online or off-line purchases. Using this standard mixin allows data producers and consumers to have a consistent representation of individual behavior across Experience Platform.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/experienceevent-application", + "https://ns.adobe.com/xdm/context/experienceevent-channel", + "https://ns.adobe.com/xdm/context/experienceevent-environment-details", + "https://ns.adobe.com/xdm/context/experienceevent-marketing", + "https://ns.adobe.com/xdm/context/experienceevent-media", + "https://ns.adobe.com/xdm/context/experienceevent-search", + "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership", + "https://ns.adobe.com/xdm/context/experienceevent-technical-details", + "https://ns.adobe.com/xdm/context/experienceevent-web", + "https://ns.adobe.com/xdm/context/experienceevent-commerce" + ], + "definitions": {}, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-application" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-channel" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-marketing" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-media" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-search" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-technical-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-web" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-commerce" + } + ], + "meta:status": "stable", + "examples": [ + { + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "id": "68519882713298129995549973016107434638", + "primary": true + } + ], + "AVID": [ + { + "id": "2dfb7d8e00003ba4-056de00000000085", + "primary": false + } + ] + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + }, + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-consumer.schema.md b/docs/reference/mixins/experience-event/experienceevent-consumer.schema.md new file mode 100644 index 000000000..47b7685c2 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-consumer.schema.md @@ -0,0 +1,466 @@ + +# Consumer ExperienceEvent mixin Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-consumer +``` + +This mixin groups a set of standard fields to describe the behavior of an individual as it relates to digital content consumption (web, mobile app) as well as online or off-line purchases. Using this standard mixin allows data producers and consumers to have a consistent representation of individual behavior across Experience Platform. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-consumer.schema.json](mixins/experience-event/experienceevent-consumer.schema.json) | +## Schema Hierarchy + +* Consumer ExperienceEvent mixin `https://ns.adobe.com/xdm/context/experienceevent-consumer` + * [ExperienceEvent application details](experienceevent-application.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-application` + * [ExperienceEvent channel details](experienceevent-channel.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-channel` + * [ExperienceEvent environment details](experienceevent-environment-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-environment-details` + * [ExperienceEvent details for marketing](experienceevent-marketing.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-marketing` + * [ExperienceEvent details for media](experienceevent-media.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-media` + * [ExperienceEvent details for search](experienceevent-search.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-search` + * [ExperienceEvent Segment Membership Details](experienceevent-segmentmembership.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-segmentmembership` + * [ExperienceEvent technical details](experienceevent-technical-details.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-technical-details` + * [ExperienceEvent web details](experienceevent-web.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-web` + * [ExperienceEvent commerce details](experienceevent-commerce.schema.md) `https://ns.adobe.com/xdm/context/experienceevent-commerce` + + +## Consumer ExperienceEvent mixin Example +```json +{ + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:identityMap": { + "ECID": [ + { + "id": "68519882713298129995549973016107434638", + "primary": true + } + ], + "AVID": [ + { + "id": "2dfb7d8e00003ba4-056de00000000085", + "primary": false + } + ] + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + }, + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + } +} +``` + +# Consumer ExperienceEvent mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:application](#xdmapplication) | Application | Optional | [ExperienceEvent application details](experienceevent-application.schema.md#xdmapplication) | +| [xdm:channel](#xdmchannel) | Experience Channel | Optional | [ExperienceEvent channel details](experienceevent-channel.schema.md#xdmchannel) | +| [xdm:commerce](#xdmcommerce) | Commerce | Optional | [ExperienceEvent commerce details](experienceevent-commerce.schema.md#xdmcommerce) | +| [xdm:dataSource](#xdmdatasource) | Data Source | Optional | [ExperienceEvent technical details](experienceevent-technical-details.schema.md#xdmdatasource) | +| [xdm:device](#xdmdevice) | Device | Optional | [ExperienceEvent environment details](experienceevent-environment-details.schema.md#xdmdevice) | +| [xdm:environment](#xdmenvironment) | Environment | Optional | [ExperienceEvent environment details](experienceevent-environment-details.schema.md#xdmenvironment) | +| [xdm:marketing](#xdmmarketing) | Marketing | Optional | [ExperienceEvent details for marketing](experienceevent-marketing.schema.md#xdmmarketing) | +| [xdm:media](#xdmmedia) | Media information | Optional | [ExperienceEvent details for media](experienceevent-media.schema.md#xdmmedia) | +| [xdm:placeContext](#xdmplacecontext) | Place context | Optional | [ExperienceEvent environment details](experienceevent-environment-details.schema.md#xdmplacecontext) | +| [xdm:productListItems](#xdmproductlistitems) | Product list item | Optional | [ExperienceEvent commerce details](experienceevent-commerce.schema.md#xdmproductlistitems) | +| [xdm:receivedTimestamp](#xdmreceivedtimestamp) | `string` | Optional | [ExperienceEvent technical details](experienceevent-technical-details.schema.md#xdmreceivedtimestamp) | +| [xdm:search](#xdmsearch) | Search | Optional | [ExperienceEvent details for search](experienceevent-search.schema.md#xdmsearch) | +| [xdm:segmentMembership](#xdmsegmentmembership) | `object` | Optional | [ExperienceEvent Segment Membership Details](experienceevent-segmentmembership.schema.md#xdmsegmentmembership) | +| [xdm:segmentMemberships](#xdmsegmentmemberships) | Segment membership item | Optional | [ExperienceEvent Segment Membership Details](experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) | +| [xdm:web](#xdmweb) | Web information | Optional | [ExperienceEvent web details](experienceevent-web.schema.md#xdmweb) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:application +### Application + +This mixin is used to capture application information related to an ExperienceEvent, including the name of the application, app version, installs, launches, crashes, and closures. It could be either the application targeted by the event like the send of a push notification or the application originating the event such as a click, or a login. + +`xdm:application` +* is optional +* type: Application +* defined in [ExperienceEvent application details](experienceevent-application.schema.md#xdmapplication) + +### xdm:application Type + + +* [Application](../../datatypes/application.schema.md) – `https://ns.adobe.com/xdm/context/application` + + + + + +## xdm:channel +### Experience channel + +Experience channel related to the ExperienceEvent. + +`xdm:channel` +* is optional +* type: Experience Channel +* defined in [ExperienceEvent channel details](experienceevent-channel.schema.md#xdmchannel) + +### xdm:channel Type + + +* [Experience Channel](../../datatypes/channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel` + + + + + +## xdm:commerce +### Commerce + +Commerce specific data related to this event. + +`xdm:commerce` +* is optional +* type: Commerce +* defined in [ExperienceEvent commerce details](experienceevent-commerce.schema.md#xdmcommerce) + +### xdm:commerce Type + + +* [Commerce](../../datatypes/commerce.schema.md) – `https://ns.adobe.com/xdm/context/commerce` + + + + + +## xdm:dataSource +### Data source + +Globally unique identification of a data source. + +`xdm:dataSource` +* is optional +* type: Data Source +* defined in [ExperienceEvent technical details](experienceevent-technical-details.schema.md#xdmdatasource) + +### xdm:dataSource Type + + +* [Data Source](../../datatypes/data/datasource.schema.md) – `https://ns.adobe.com/xdm/data/datasource` + + + + + +## xdm:device +### Device + +An identified device, application or device browser instance that is trackable across sessions, normally by cookies. + +`xdm:device` +* is optional +* type: Device +* defined in [ExperienceEvent environment details](experienceevent-environment-details.schema.md#xdmdevice) + +### xdm:device Type + + +* [Device](../../datatypes/device.schema.md) – `https://ns.adobe.com/xdm/context/device` + + + + + +## xdm:environment +### Environment + +Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions. + +`xdm:environment` +* is optional +* type: Environment +* defined in [ExperienceEvent environment details](experienceevent-environment-details.schema.md#xdmenvironment) + +### xdm:environment Type + + +* [Environment](../../datatypes/environment.schema.md) – `https://ns.adobe.com/xdm/context/environment` + + + + + +## xdm:marketing +### Marketing + +The information related to marketing activities that are active with the touchpoint. + +`xdm:marketing` +* is optional +* type: Marketing +* defined in [ExperienceEvent details for marketing](experienceevent-marketing.schema.md#xdmmarketing) + +### xdm:marketing Type + + +* [Marketing](../../datatypes/marketing.schema.md) – `https://ns.adobe.com/xdm/context/marketing` + + + + + +## xdm:media +### Media + +Media activity information related to the experience event. + +`xdm:media` +* is optional +* type: Media information +* defined in [ExperienceEvent details for media](experienceevent-media.schema.md#xdmmedia) + +### xdm:media Type + + +* [Media information](../../datatypes/media.schema.md) – `https://ns.adobe.com/xdm/context/media` + + + + + +## xdm:placeContext +### Place context + +The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, and working hours. + +`xdm:placeContext` +* is optional +* type: Place context +* defined in [ExperienceEvent environment details](experienceevent-environment-details.schema.md#xdmplacecontext) + +### xdm:placeContext Type + + +* [Place context](../../datatypes/placecontext.schema.md) – `https://ns.adobe.com/xdm/context/placecontext` + + + + + +## xdm:productListItems +### Product list items + +A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record. + +`xdm:productListItems` +* is optional +* type: Product list item + +* defined in [ExperienceEvent commerce details](experienceevent-commerce.schema.md#xdmproductlistitems) + +### xdm:productListItems Type + + +Array type: Product list item + +All items must be of the type: +* [Product list item](../../datatypes/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem` + + + + + + + + +## xdm:receivedTimestamp +### Received time stamp + +The time at which this interaction was received by a server. + +`xdm:receivedTimestamp` +* is optional +* type: `string` +* defined in [ExperienceEvent technical details](experienceevent-technical-details.schema.md#xdmreceivedtimestamp) + +### xdm:receivedTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:search +### Search + +The information related to web or mobile search. + +`xdm:search` +* is optional +* type: Search +* defined in [ExperienceEvent details for search](experienceevent-search.schema.md#xdmsearch) + +### xdm:search Type + + +* [Search](../../datatypes/search.schema.md) – `https://ns.adobe.com/xdm/context/search` + + + + + +## xdm:segmentMembership +### Segment Membership Map + +`xdm:segmentMembership` +* is optional +* type: `object` +* defined in [ExperienceEvent Segment Membership Details](experienceevent-segmentmembership.schema.md#xdmsegmentmembership) + +### xdm:segmentMembership Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:segmentMemberships +### Segment Memberships + +The segments associated with this ExperienceEvent. Deprecated, use `xdm:segmentMembership` instead. + +`xdm:segmentMemberships` +* is optional +* type: Segment membership item + +* defined in [ExperienceEvent Segment Membership Details](experienceevent-segmentmembership.schema.md#xdmsegmentmemberships) + +### xdm:segmentMemberships Type + + +Array type: Segment membership item + +All items must be of the type: +* [Segment membership item](../../datatypes/segmentmembershipitem.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembershipitem` + + + + + + + + +## xdm:web +### Web + +The information related to web page and link of the ExperienceEvent. + +`xdm:web` +* is optional +* type: Web information +* defined in [ExperienceEvent web details](experienceevent-web.schema.md#xdmweb) + +### xdm:web Type + + +* [Web information](../../datatypes/webinfo.schema.md) – `https://ns.adobe.com/xdm/context/webinfo` + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-directmarketing.schema.json b/docs/reference/mixins/experience-event/experienceevent-directmarketing.schema.json new file mode 100644 index 000000000..4a15d9b81 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-directmarketing.schema.json @@ -0,0 +1,47 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-directmarketing", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent direct marketing details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "This mixin is used to capture information regarding direct marketing details related to an ExperienceEvent. This includes opens, clicks, impressions, and unsubscribes.", + "definitions": { + "experienceevent-directmarketing": { + "properties": { + "xdm:directMarketing": { + "title": "Direct marketing", + "$ref": "https://ns.adobe.com/xdm/context/direct-marketing", + "description": "Events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-directmarketing" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:directMarketing": { + "xdm:sends": { + "xdm:value": 1 + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-directmarketing.schema.md b/docs/reference/mixins/experience-event/experienceevent-directmarketing.schema.md new file mode 100644 index 000000000..15d08dacc --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-directmarketing.schema.md @@ -0,0 +1,55 @@ + +# ExperienceEvent direct marketing details Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-directmarketing +``` + +This mixin is used to capture information regarding direct marketing details related to an ExperienceEvent. This includes opens, clicks, impressions, and unsubscribes. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-directmarketing.schema.json](mixins/experience-event/experienceevent-directmarketing.schema.json) | +## Schema Hierarchy + +* ExperienceEvent direct marketing details `https://ns.adobe.com/xdm/context/experienceevent-directmarketing` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Direct marketing](../../datatypes/direct-marketing.schema.md) `https://ns.adobe.com/xdm/context/direct-marketing` + + +## ExperienceEvent direct marketing details Example +```json +{ + "xdm:directMarketing": { + "xdm:sends": { + "xdm:value": 1 + } + } +} +``` + +# ExperienceEvent direct marketing details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:directMarketing](#xdmdirectmarketing) | Direct marketing | Optional | ExperienceEvent direct marketing details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:directMarketing +### Direct marketing + +Events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications. + +`xdm:directMarketing` +* is optional +* type: Direct marketing +* defined in this schema + +### xdm:directMarketing Type + + +* [Direct marketing](../../datatypes/direct-marketing.schema.md) – `https://ns.adobe.com/xdm/context/direct-marketing` + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-enduserids-deprecated.schema.json b/docs/reference/mixins/experience-event/experienceevent-enduserids-deprecated.schema.json new file mode 100644 index 000000000..f9fa84e7d --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-enduserids-deprecated.schema.json @@ -0,0 +1,63 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-enduserids-deprecated", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent endUserIDs (deprecated)", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "ExperienceEvent endUserIDs (deprecated).", + "definitions": { + "experienceevent-enduserids-deprecated": { + "properties": { + "xdm:endUserIDs": { + "meta:status": "deprecated", + "title": "End-User IDs", + "$ref": "https://ns.adobe.com/xdm/context/enduserids", + "description": "Condensed, normalized encapsulation of all end-user identifiers. Deprecated, use `xdm:identityMap` instead." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-enduserids-deprecated" + } + ], + "meta:status": "deprecated", + "examples": [ + { + "xdm:endUserIDs": { + "https://ns.adobe.com/experience/mcid": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "ECID" + } + }, + "https://ns.adobe.com/experience/aaid": { + "@id": "https://data.adobe.io/entities/identity/2394509340-30453470347", + "xdm:namespace": { + "xdm:code": "AVID" + } + }, + "https://ns.adobe.com/experience/tntid": { + "@id": "https://data.adobe.io/entities/identity/1233ce17-20e0-4a2c-8198-2a77fd60cf4d", + "xdm:namespace": { + "xdm:code": "tnt0051" + } + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-enduserids-deprecated.schema.md b/docs/reference/mixins/experience-event/experienceevent-enduserids-deprecated.schema.md new file mode 100644 index 000000000..94c0cc172 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-enduserids-deprecated.schema.md @@ -0,0 +1,70 @@ + +# ExperienceEvent endUserIDs (deprecated) Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-enduserids-deprecated +``` + +ExperienceEvent endUserIDs (deprecated). + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Deprecated | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-enduserids-deprecated.schema.json](mixins/experience-event/experienceevent-enduserids-deprecated.schema.json) | +## Schema Hierarchy + +* ExperienceEvent endUserIDs (deprecated) `https://ns.adobe.com/xdm/context/experienceevent-enduserids-deprecated` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [End user IDs](../../datatypes/enduserids.schema.md) `https://ns.adobe.com/xdm/context/enduserids` + + +## ExperienceEvent endUserIDs (deprecated) Example +```json +{ + "xdm:endUserIDs": { + "https://ns.adobe.com/experience/mcid": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "ECID" + } + }, + "https://ns.adobe.com/experience/aaid": { + "@id": "https://data.adobe.io/entities/identity/2394509340-30453470347", + "xdm:namespace": { + "xdm:code": "AVID" + } + }, + "https://ns.adobe.com/experience/tntid": { + "@id": "https://data.adobe.io/entities/identity/1233ce17-20e0-4a2c-8198-2a77fd60cf4d", + "xdm:namespace": { + "xdm:code": "tnt0051" + } + } + } +} +``` + +# ExperienceEvent endUserIDs (deprecated) Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:endUserIDs](#xdmenduserids) | End user IDs | Optional | ExperienceEvent endUserIDs (deprecated) (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:endUserIDs +### End-User IDs + +Condensed, normalized encapsulation of all end-user identifiers. Deprecated, use `xdm:identityMap` instead. + +`xdm:endUserIDs` +* is optional +* type: End user IDs +* defined in this schema + +### xdm:endUserIDs Type + + +* [End user IDs](../../datatypes/enduserids.schema.md) – `https://ns.adobe.com/xdm/context/enduserids` + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-enduserids.schema.json b/docs/reference/mixins/experience-event/experienceevent-enduserids.schema.json new file mode 100644 index 000000000..bc20d5ec4 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-enduserids.schema.json @@ -0,0 +1,62 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-enduserids", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent EndUserIDs", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "This mixin provides a condensed, normalized encapsulation of end-user identifiers asserted for an ExperienceEvent. These IDs could include phone numbers, email addresses, or other identifiers related to an individual.", + "definitions": { + "experienceevent-enduserids": { + "properties": { + "xdm:endUserIDs": { + "title": "EndUserIDs", + "$ref": "https://ns.adobe.com/xdm/context/enduserids", + "description": "Condensed, normalized encapsulation of end user identifiers asserted for this ExperienceEvent." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-enduserids" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:endUserIDs": { + "https://ns.adobe.com/experience/mcid": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "ECID" + } + }, + "https://ns.adobe.com/experience/aaid": { + "@id": "https://data.adobe.io/entities/identity/2394509340-30453470347", + "xdm:namespace": { + "xdm:code": "AVID" + } + }, + "https://ns.adobe.com/experience/tntid": { + "@id": "https://data.adobe.io/entities/identity/1233ce17-20e0-4a2c-8198-2a77fd60cf4d", + "xdm:namespace": { + "xdm:code": "tnt0051" + } + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-enduserids.schema.md b/docs/reference/mixins/experience-event/experienceevent-enduserids.schema.md new file mode 100644 index 000000000..543240432 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-enduserids.schema.md @@ -0,0 +1,70 @@ + +# ExperienceEvent EndUserIDs Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-enduserids +``` + +This mixin provides a condensed, normalized encapsulation of end-user identifiers asserted for an ExperienceEvent. These IDs could include phone numbers, email addresses, or other identifiers related to an individual. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-enduserids.schema.json](mixins/experience-event/experienceevent-enduserids.schema.json) | +## Schema Hierarchy + +* ExperienceEvent EndUserIDs `https://ns.adobe.com/xdm/context/experienceevent-enduserids` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [End user IDs](../../datatypes/enduserids.schema.md) `https://ns.adobe.com/xdm/context/enduserids` + + +## ExperienceEvent EndUserIDs Example +```json +{ + "xdm:endUserIDs": { + "https://ns.adobe.com/experience/mcid": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "ECID" + } + }, + "https://ns.adobe.com/experience/aaid": { + "@id": "https://data.adobe.io/entities/identity/2394509340-30453470347", + "xdm:namespace": { + "xdm:code": "AVID" + } + }, + "https://ns.adobe.com/experience/tntid": { + "@id": "https://data.adobe.io/entities/identity/1233ce17-20e0-4a2c-8198-2a77fd60cf4d", + "xdm:namespace": { + "xdm:code": "tnt0051" + } + } + } +} +``` + +# ExperienceEvent EndUserIDs Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:endUserIDs](#xdmenduserids) | End user IDs | Optional | ExperienceEvent EndUserIDs (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:endUserIDs +### EndUserIDs + +Condensed, normalized encapsulation of end user identifiers asserted for this ExperienceEvent. + +`xdm:endUserIDs` +* is optional +* type: End user IDs +* defined in this schema + +### xdm:endUserIDs Type + + +* [End user IDs](../../datatypes/enduserids.schema.md) – `https://ns.adobe.com/xdm/context/enduserids` + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-environment-details.schema.json b/docs/reference/mixins/experience-event/experienceevent-environment-details.schema.json new file mode 100644 index 000000000..87d3c999b --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-environment-details.schema.json @@ -0,0 +1,94 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-environment-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent environment details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "This mixin is used to capture information regarding environment details related to an ExperienceEvent, such as device details, browser information, local time, and other geographical information.", + "definitions": { + "experienceevent-environment-details": { + "properties": { + "xdm:environment": { + "title": "Environment", + "$ref": "https://ns.adobe.com/xdm/context/environment", + "description": "Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions." + }, + "xdm:device": { + "title": "Device", + "$ref": "https://ns.adobe.com/xdm/context/device", + "description": "An identified device, application or device browser instance that is trackable across sessions, normally by cookies." + }, + "xdm:placeContext": { + "title": "Place context", + "$ref": "https://ns.adobe.com/xdm/context/placecontext", + "description": "The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, and working hours." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-environment-details" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:device": { + "xdm:typeID": "TypeIdentifier-111", + "xdm:typeIDService": "https://ns.adobe.com/xdm/external/deviceatlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216, + "xdm:screenOrientation": "portrait" + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-environment-details.schema.md b/docs/reference/mixins/experience-event/experienceevent-environment-details.schema.md new file mode 100644 index 000000000..ec1215f73 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-environment-details.schema.md @@ -0,0 +1,134 @@ + +# ExperienceEvent environment details Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-environment-details +``` + +This mixin is used to capture information regarding environment details related to an ExperienceEvent, such as device details, browser information, local time, and other geographical information. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-environment-details.schema.json](mixins/experience-event/experienceevent-environment-details.schema.json) | +## Schema Hierarchy + +* ExperienceEvent environment details `https://ns.adobe.com/xdm/context/experienceevent-environment-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Environment](../../datatypes/environment.schema.md) `https://ns.adobe.com/xdm/context/environment` + * [Device](../../datatypes/device.schema.md) `https://ns.adobe.com/xdm/context/device` + * [Place context](../../datatypes/placecontext.schema.md) `https://ns.adobe.com/xdm/context/placecontext` + + +## ExperienceEvent environment details Example +```json +{ + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:device": { + "xdm:typeID": "TypeIdentifier-111", + "xdm:typeIDService": "https://ns.adobe.com/xdm/external/deviceatlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216, + "xdm:screenOrientation": "portrait" + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + } +} +``` + +# ExperienceEvent environment details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:device](#xdmdevice) | Device | Optional | ExperienceEvent environment details (this schema) | +| [xdm:environment](#xdmenvironment) | Environment | Optional | ExperienceEvent environment details (this schema) | +| [xdm:placeContext](#xdmplacecontext) | Place context | Optional | ExperienceEvent environment details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:device +### Device + +An identified device, application or device browser instance that is trackable across sessions, normally by cookies. + +`xdm:device` +* is optional +* type: Device +* defined in this schema + +### xdm:device Type + + +* [Device](../../datatypes/device.schema.md) – `https://ns.adobe.com/xdm/context/device` + + + + + +## xdm:environment +### Environment + +Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions. + +`xdm:environment` +* is optional +* type: Environment +* defined in this schema + +### xdm:environment Type + + +* [Environment](../../datatypes/environment.schema.md) – `https://ns.adobe.com/xdm/context/environment` + + + + + +## xdm:placeContext +### Place context + +The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, and working hours. + +`xdm:placeContext` +* is optional +* type: Place context +* defined in this schema + +### xdm:placeContext Type + + +* [Place context](../../datatypes/placecontext.schema.md) – `https://ns.adobe.com/xdm/context/placecontext` + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-implementation-details.schema.json b/docs/reference/mixins/experience-event/experienceevent-implementation-details.schema.json new file mode 100644 index 000000000..5c53d84ac --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-implementation-details.schema.json @@ -0,0 +1,47 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-implementation-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent implementation details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Field to capture the details of the software used to collect the ExperienceEvent.", + "definitions": { + "experienceevent-implementation-details": { + "properties": { + "xdm:implementationDetails": { + "title": "Implementation details", + "$ref": "https://ns.adobe.com/xdm/context/implementationdetails", + "description": "The details of the software used to collect the ExperienceEvent." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-implementation-details" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/alloy", + "xdm:version": "0.11.0", + "xdm:environment": "browser" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-implementation-details.schema.md b/docs/reference/mixins/experience-event/experienceevent-implementation-details.schema.md new file mode 100644 index 000000000..8dac96133 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-implementation-details.schema.md @@ -0,0 +1,55 @@ + +# ExperienceEvent implementation details Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-implementation-details +``` + +Field to capture the details of the software used to collect the ExperienceEvent. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-implementation-details.schema.json](mixins/experience-event/experienceevent-implementation-details.schema.json) | +## Schema Hierarchy + +* ExperienceEvent implementation details `https://ns.adobe.com/xdm/context/experienceevent-implementation-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Implementation details](../../datatypes/implementationdetails.schema.md) `https://ns.adobe.com/xdm/context/implementationdetails` + + +## ExperienceEvent implementation details Example +```json +{ + "xdm:implementationDetails": { + "xdm:name": "https://ns.adobe.com/experience/alloy", + "xdm:version": "0.11.0", + "xdm:environment": "browser" + } +} +``` + +# ExperienceEvent implementation details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:implementationDetails](#xdmimplementationdetails) | Implementation details | Optional | ExperienceEvent implementation details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:implementationDetails +### Implementation details + +The details of the software used to collect the ExperienceEvent. + +`xdm:implementationDetails` +* is optional +* type: Implementation details +* defined in this schema + +### xdm:implementationDetails Type + + +* [Implementation details](../../datatypes/implementationdetails.schema.md) – `https://ns.adobe.com/xdm/context/implementationdetails` + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-marketing.schema.json b/docs/reference/mixins/experience-event/experienceevent-marketing.schema.json new file mode 100644 index 000000000..8014bd598 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-marketing.schema.json @@ -0,0 +1,45 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-marketing", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent details for marketing", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "This mixin is used to capture information regarding marketing campaigns details related to an ExperienceEvent, including campaign group, campaign name, and tracking code.", + "definitions": { + "experienceevent-marketing": { + "properties": { + "xdm:marketing": { + "title": "Marketing", + "$ref": "https://ns.adobe.com/xdm/context/marketing", + "description": "The information related to marketing activities that are active with the touchpoint." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-marketing" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-marketing.schema.md b/docs/reference/mixins/experience-event/experienceevent-marketing.schema.md new file mode 100644 index 000000000..23a0bb252 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-marketing.schema.md @@ -0,0 +1,53 @@ + +# ExperienceEvent details for marketing Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-marketing +``` + +This mixin is used to capture information regarding marketing campaigns details related to an ExperienceEvent, including campaign group, campaign name, and tracking code. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-marketing.schema.json](mixins/experience-event/experienceevent-marketing.schema.json) | +## Schema Hierarchy + +* ExperienceEvent details for marketing `https://ns.adobe.com/xdm/context/experienceevent-marketing` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Marketing](../../datatypes/marketing.schema.md) `https://ns.adobe.com/xdm/context/marketing` + + +## ExperienceEvent details for marketing Example +```json +{ + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + } +} +``` + +# ExperienceEvent details for marketing Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:marketing](#xdmmarketing) | Marketing | Optional | ExperienceEvent details for marketing (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:marketing +### Marketing + +The information related to marketing activities that are active with the touchpoint. + +`xdm:marketing` +* is optional +* type: Marketing +* defined in this schema + +### xdm:marketing Type + + +* [Marketing](../../datatypes/marketing.schema.md) – `https://ns.adobe.com/xdm/context/marketing` + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-media.schema.json b/docs/reference/mixins/experience-event/experienceevent-media.schema.json new file mode 100644 index 000000000..db535b933 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-media.schema.json @@ -0,0 +1,224 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-media", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent details for media", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "This mixin is used to capture information regarding interactions with media such as progress (how much was consumed), total time played, timing of any pauses, and number of media completions.", + "definitions": { + "experienceevent-media": { + "properties": { + "xdm:media": { + "title": "Media", + "meta:status": "experimental", + "$ref": "https://ns.adobe.com/xdm/context/media", + "description": "Media activity information related to the experience event." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-media" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:media": { + "xdm:mediaTimed": { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "nba_highlights", + "iptc4xmpExt:Identifier": "http://sportcnl.com/series-identifiers/2613953" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "TV14", + "iptc4xmpExt:RatingSourceLink": "http://www.tvguidelines.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "SportCNL" + } + ] + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchsportcnl", + "xdm:videoSegment": "3-10", + "xdm:path": "id:arg:ep:npqr.com:dfb21354-4ce7", + "xdm:broadcastChannel": "WatchSportCnl", + "xdm:broadcastContentType": "VOD", + "xdm:streamFormat": "short", + "xdm:vhlVersion": "js-2.0.1.88-c8c0b1", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "scu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.url.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:QOE": { + "xdm:errors": { + "xdm:value": 0 + }, + "xdm:errorImpactedStreams": { + "xdm:value": 0 + }, + "xdm:buffers": { + "xdm:value": 4 + }, + "xdm:bufferTime": { + "xdm:value": 5 + }, + "xdm:bufferImpactedStreams": { + "xdm:value": 2 + }, + "xdm:stalls": { + "xdm:value": 0 + }, + "xdm:stallTime": { + "xdm:value": 0 + }, + "xdm:stallingImpactedStreams": { + "xdm:value": 0 + }, + "xdm:bitrateChanges": { + "xdm:value": 0 + }, + "xdm:bitrateAverage": { + "xdm:value": 320 + }, + "xdm:bitrateAverageBucket": "800-899", + "xdm:bitrateChangeImpactedStreams": { + "xdm:value": 0 + }, + "xdm:dropBeforeStart": { + "xdm:value": 0 + }, + "xdm:droppedFrames": { + "xdm:value": 2 + }, + "xdm:droppedFrameImpactedStreams": { + "xdm:value": 2 + }, + "xdm:timeToStart": { + "xdm:value": 3 + }, + "xdm:mediaSdkErrors": [ + "300", + "500.300.200" + ], + "xdm:playerSdkErrors": [ + "custom.error.code" + ], + "xdm:externalSdkErrors": [ + "100-5", + "11.12" + ] + }, + "xdm:downloadedPlayback": false + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 0 + }, + "xdm:timePlayed": { + "xdm:value": 80 + }, + "xdm:federated": { + "xdm:value": 0 + }, + "xdm:starts": { + "xdm:value": 1 + }, + "xdm:mediaSegmentView": { + "xdm:value": 1 + }, + "xdm:totalTimePlayed": { + "xdm:value": 190 + }, + "xdm:uniqueTimePlayed": { + "xdm:value": 80 + }, + "xdm:averageMinuteAudience": { + "xdm:value": 1.03 + }, + "xdm:adCount": { + "xdm:value": 3 + }, + "xdm:chapterCount": { + "xdm:value": 1 + }, + "xdm:progress10": { + "xdm:value": 1 + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + }, + "xdm:midpoints": { + "xdm:value": 1 + }, + "xdm:thirdQuartiles": { + "xdm:value": 1 + }, + "xdm:progress95": { + "xdm:value": 0 + }, + "xdm:resumes": { + "xdm:value": 0 + }, + "xdm:estimatedStreams": { + "xdm:value": 2 + }, + "xdm:pauseImpactedStreams": { + "xdm:value": 3 + }, + "xdm:pauses": { + "xdm:value": 0 + }, + "xdm:pauseTime": { + "xdm:value": 0 + }, + "xdm:idp": "MyTVOnline", + "xdm:mediaAuth": "Sample auth", + "xdm:dayPart": "daytime" + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-media.schema.md b/docs/reference/mixins/experience-event/experienceevent-media.schema.md new file mode 100644 index 000000000..878fa76ef --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-media.schema.md @@ -0,0 +1,231 @@ + +# ExperienceEvent details for media Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-media +``` + +This mixin is used to capture information regarding interactions with media such as progress (how much was consumed), total time played, timing of any pauses, and number of media completions. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-media.schema.json](mixins/experience-event/experienceevent-media.schema.json) | +## Schema Hierarchy + +* ExperienceEvent details for media `https://ns.adobe.com/xdm/context/experienceevent-media` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Media information](../../datatypes/media.schema.md) `https://ns.adobe.com/xdm/context/media` + + +## ExperienceEvent details for media Example +```json +{ + "xdm:media": { + "xdm:mediaTimed": { + "xdm:primaryAssetReference": { + "@id": "https://data.adobe.io/entities/media-timed-asset-reference/15234430", + "dc:title": "Floki Begs Helga for Freedom", + "dc:creator": "Video Author", + "dc:publisher": "tvonline", + "xmpDM:duration": 87, + "iptc4xmpExt:Series": { + "iptc4xmpExt:Name": "nba_highlights", + "iptc4xmpExt:Identifier": "http://sportcnl.com/series-identifiers/2613953" + }, + "xdm:showType": "episode", + "xdm:streamFormat": "long", + "xdm:streamType": "video", + "iptc4xmpExt:Season": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Episode": { + "iptc4xmpExt:Number": 1 + }, + "iptc4xmpExt:Genre": [ + "sports" + ], + "iptc4xmpExt:Rating": [ + { + "iptc4xmpExt:RatingValue": "TV14", + "iptc4xmpExt:RatingSourceLink": "http://www.tvguidelines.org/ratings.htm" + } + ], + "iptc4xmpExt:Creator": [ + { + "iptc4xmpExt:Name": "SportCNL" + } + ] + }, + "xdm:primaryAssetViewDetails": { + "@id": "https://data.adobe.io/entities/media-sessionid/1427461282884250114230", + "xdm:playerName": "watchsportcnl", + "xdm:videoSegment": "3-10", + "xdm:path": "id:arg:ep:npqr.com:dfb21354-4ce7", + "xdm:broadcastChannel": "WatchSportCnl", + "xdm:broadcastContentType": "VOD", + "xdm:streamFormat": "short", + "xdm:vhlVersion": "js-2.0.1.88-c8c0b1", + "xdm:playerSDKVersion": { + "xdm:version": "1.0.8" + }, + "xdm:broadcastNetwork": "scu", + "xdm:adLoadType": "2", + "xdm:sourceFeed": "http%3A%2F%2Fvod01.url.net%2Fhls%2Fvu%2F9083406%2FVUBX0280890106690980_38_3_M_HD.m3u8", + "xdm:sessionTimeout": 1800, + "xdm:QOE": { + "xdm:errors": { + "xdm:value": 0 + }, + "xdm:errorImpactedStreams": { + "xdm:value": 0 + }, + "xdm:buffers": { + "xdm:value": 4 + }, + "xdm:bufferTime": { + "xdm:value": 5 + }, + "xdm:bufferImpactedStreams": { + "xdm:value": 2 + }, + "xdm:stalls": { + "xdm:value": 0 + }, + "xdm:stallTime": { + "xdm:value": 0 + }, + "xdm:stallingImpactedStreams": { + "xdm:value": 0 + }, + "xdm:bitrateChanges": { + "xdm:value": 0 + }, + "xdm:bitrateAverage": { + "xdm:value": 320 + }, + "xdm:bitrateAverageBucket": "800-899", + "xdm:bitrateChangeImpactedStreams": { + "xdm:value": 0 + }, + "xdm:dropBeforeStart": { + "xdm:value": 0 + }, + "xdm:droppedFrames": { + "xdm:value": 2 + }, + "xdm:droppedFrameImpactedStreams": { + "xdm:value": 2 + }, + "xdm:timeToStart": { + "xdm:value": 3 + }, + "xdm:mediaSdkErrors": [ + "300", + "500.300.200" + ], + "xdm:playerSdkErrors": [ + "custom.error.code" + ], + "xdm:externalSdkErrors": [ + "100-5", + "11.12" + ] + }, + "xdm:downloadedPlayback": false + }, + "xdm:impressions": { + "xdm:value": 1 + }, + "xdm:completes": { + "xdm:value": 0 + }, + "xdm:timePlayed": { + "xdm:value": 80 + }, + "xdm:federated": { + "xdm:value": 0 + }, + "xdm:starts": { + "xdm:value": 1 + }, + "xdm:mediaSegmentView": { + "xdm:value": 1 + }, + "xdm:totalTimePlayed": { + "xdm:value": 190 + }, + "xdm:uniqueTimePlayed": { + "xdm:value": 80 + }, + "xdm:averageMinuteAudience": { + "xdm:value": 1.03 + }, + "xdm:adCount": { + "xdm:value": 3 + }, + "xdm:chapterCount": { + "xdm:value": 1 + }, + "xdm:progress10": { + "xdm:value": 1 + }, + "xdm:firstQuartiles": { + "xdm:value": 1 + }, + "xdm:midpoints": { + "xdm:value": 1 + }, + "xdm:thirdQuartiles": { + "xdm:value": 1 + }, + "xdm:progress95": { + "xdm:value": 0 + }, + "xdm:resumes": { + "xdm:value": 0 + }, + "xdm:estimatedStreams": { + "xdm:value": 2 + }, + "xdm:pauseImpactedStreams": { + "xdm:value": 3 + }, + "xdm:pauses": { + "xdm:value": 0 + }, + "xdm:pauseTime": { + "xdm:value": 0 + }, + "xdm:idp": "MyTVOnline", + "xdm:mediaAuth": "Sample auth", + "xdm:dayPart": "daytime" + } + } +} +``` + +# ExperienceEvent details for media Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:media](#xdmmedia) | Media information | Optional | ExperienceEvent details for media (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:media +### Media + +Media activity information related to the experience event. + +`xdm:media` +* is optional +* type: Media information +* defined in this schema + +### xdm:media Type + + +* [Media information](../../datatypes/media.schema.md) – `https://ns.adobe.com/xdm/context/media` + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-privacy.schema.json b/docs/reference/mixins/experience-event/experienceevent-privacy.schema.json new file mode 100644 index 000000000..ef40afa13 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-privacy.schema.json @@ -0,0 +1,53 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-privacy", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Experience event privacy mixin", + "description": "Experience event privacy schema captures consent information on the hit.", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "definitions": { + "experienceevent-privacy": { + "properties": { + "xdm:consentStrings": { + "title": "Identity level consent information", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/consentstring" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-privacy" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:consentStrings": [ + { + "xdm:consentStandard": "IAB TCF", + "xdm:consentStandardVersion": "2.0", + "xdm:consentStringValue": "BObdrPUOevsguAfDqFENCNAAAAAmeAAA.PVAfDObdrA.DqFENCAmeAENCDA", + "xdm:gdprApplies": true, + "xdm:containsPersonalData": false + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-privacy.schema.md b/docs/reference/mixins/experience-event/experienceevent-privacy.schema.md new file mode 100644 index 000000000..eafda9c95 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-privacy.schema.md @@ -0,0 +1,63 @@ + +# Experience event privacy mixin Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-privacy +``` + +Experience event privacy schema captures consent information on the hit. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-privacy.schema.json](mixins/experience-event/experienceevent-privacy.schema.json) | +## Schema Hierarchy + +* Experience event privacy mixin `https://ns.adobe.com/xdm/context/experienceevent-privacy` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Experience event privacy mixin Example +```json +{ + "xdm:consentStrings": [ + { + "xdm:consentStandard": "IAB TCF", + "xdm:consentStandardVersion": "2.0", + "xdm:consentStringValue": "BObdrPUOevsguAfDqFENCNAAAAAmeAAA.PVAfDObdrA.DqFENCAmeAENCDA", + "xdm:gdprApplies": true, + "xdm:containsPersonalData": false + } + ] +} +``` + +# Experience event privacy mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:consentStrings](#xdmconsentstrings) | Consent String | Optional | Experience event privacy mixin (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:consentStrings +### Identity level consent information + +`xdm:consentStrings` +* is optional +* type: Consent String + +* defined in this schema + +### xdm:consentStrings Type + + +Array type: Consent String + +All items must be of the type: +* [Consent String](../../datatypes/consentstring.schema.md) – `https://ns.adobe.com/xdm/context/consentstring` + + + + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-profile-stitch.schema.json b/docs/reference/mixins/experience-event/experienceevent-profile-stitch.schema.json new file mode 100644 index 000000000..82a2f9689 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-profile-stitch.schema.json @@ -0,0 +1,89 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent profile stitch details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "ExperienceEvent profile stitch describes details about the IDs that were joined by profile stitching.", + "definitions": { + "experienceevent-profile-stitch": { + "properties": { + "xdm:profileStitch": { + "title": "Profile stitch", + "description": "Details about the IDs that were joined by profile stitching.", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/profileStitch" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-profile-stitch" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:profileStitch": [ + { + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "1.0", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/92312748749128" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/62312748749321" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" + } + ] + } + } + ], + "xdm:segmentMemberships": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + }, + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:version": "1.0", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "realized" + } + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-profile-stitch.schema.md b/docs/reference/mixins/experience-event/experienceevent-profile-stitch.schema.md new file mode 100644 index 000000000..b0fb6d760 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-profile-stitch.schema.md @@ -0,0 +1,100 @@ + +# ExperienceEvent profile stitch details Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-profile-stitch +``` + +ExperienceEvent profile stitch describes details about the IDs that were joined by profile stitching. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-profile-stitch.schema.json](mixins/experience-event/experienceevent-profile-stitch.schema.json) | +## Schema Hierarchy + +* ExperienceEvent profile stitch details `https://ns.adobe.com/xdm/context/experienceevent-profile-stitch` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## ExperienceEvent profile stitch details Example +```json +{ + "xdm:profileStitch": [ + { + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:version": "1.0", + "xdm:identityMap": { + "ECID": [ + { + "xdm:id": "https://data.adobe.io/entities/identity/92312748749128" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/62312748749321" + }, + { + "xdm:id": "https://data.adobe.io/entities/identity/49312748749132" + } + ] + } + } + ], + "xdm:segmentMemberships": [ + { + "xdm:segmentID": { + "@id": "https://data.adobe.io/entities/identity/92312748749128", + "xdm:namespace": { + "xdm:code": "AAM" + } + }, + "xdm:profileStitchID": { + "@id": "https://data.adobe.io/entities/profileStitchIdentity/1", + "xdm:namespace": { + "xdm:code": "AAM" + }, + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:version": "1.0", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "realized" + } + } + ] +} +``` + +# ExperienceEvent profile stitch details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:profileStitch](#xdmprofilestitch) | Profile stitch | Optional | ExperienceEvent profile stitch details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:profileStitch +### Profile stitch + +Details about the IDs that were joined by profile stitching. + +`xdm:profileStitch` +* is optional +* type: Profile stitch + +* defined in this schema + +### xdm:profileStitch Type + + +Array type: Profile stitch + +All items must be of the type: +* [Profile stitch](../../datatypes/profilestitch.schema.md) – `https://ns.adobe.com/xdm/context/profileStitch` + + + + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-search.schema.json b/docs/reference/mixins/experience-event/experienceevent-search.schema.json new file mode 100644 index 000000000..11bd6ea3d --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-search.schema.json @@ -0,0 +1,49 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-search", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent details for search", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "This mixin is used to capture search-related information for an ExperienceEvent, such as search engine, paid search (boolean), keywords, and position.", + "definitions": { + "experienceevent-search": { + "properties": { + "xdm:search": { + "title": "Search", + "$ref": "https://ns.adobe.com/xdm/context/search", + "description": "The information related to web or mobile search." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-search" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:search": { + "xdm:searchEngine": "Google", + "xdm:searchEngineID": "https://ns.adobe.com/searchengines/3", + "xdm:keywords": "rice cooker", + "xdm:isPaid": true, + "xdm:pageDepth": 1 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-search.schema.md b/docs/reference/mixins/experience-event/experienceevent-search.schema.md new file mode 100644 index 000000000..81acd0848 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-search.schema.md @@ -0,0 +1,57 @@ + +# ExperienceEvent details for search Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-search +``` + +This mixin is used to capture search-related information for an ExperienceEvent, such as search engine, paid search (boolean), keywords, and position. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-search.schema.json](mixins/experience-event/experienceevent-search.schema.json) | +## Schema Hierarchy + +* ExperienceEvent details for search `https://ns.adobe.com/xdm/context/experienceevent-search` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Search](../../datatypes/search.schema.md) `https://ns.adobe.com/xdm/context/search` + + +## ExperienceEvent details for search Example +```json +{ + "xdm:search": { + "xdm:searchEngine": "Google", + "xdm:searchEngineID": "https://ns.adobe.com/searchengines/3", + "xdm:keywords": "rice cooker", + "xdm:isPaid": true, + "xdm:pageDepth": 1 + } +} +``` + +# ExperienceEvent details for search Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:search](#xdmsearch) | Search | Optional | ExperienceEvent details for search (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:search +### Search + +The information related to web or mobile search. + +`xdm:search` +* is optional +* type: Search +* defined in this schema + +### xdm:search Type + + +* [Search](../../datatypes/search.schema.md) – `https://ns.adobe.com/xdm/context/search` + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-segmentmembership.schema.json b/docs/reference/mixins/experience-event/experienceevent-segmentmembership.schema.json new file mode 100644 index 000000000..a58b4109f --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-segmentmembership.schema.json @@ -0,0 +1,83 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent Segment Membership Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "This mixin is used to capture information regarding ExperienceEvent segment membership, including which segments the individual belongs to, the last qualification time, and when the membership is valid until.", + "definitions": { + "experienceevent-segmentmembership": { + "properties": { + "xdm:segmentMemberships": { + "title": "Segment Memberships", + "meta:status": "deprecated", + "description": "The segments associated with this ExperienceEvent. Deprecated, use `xdm:segmentMembership` instead.", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/segmentmembershipitem" + } + }, + "xdm:segmentMembership": { + "title": "Segment Membership Map", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "title": "Segment Membership per Namespace", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "$ref": "https://ns.adobe.com/xdm/context/segmentmembership" + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-segmentmembership" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:segmentMembership": { + "AAM": { + "04a81716-43d6-4e7a-a49c-f1d8b3129ba9": { + "xdm:version": "15", + "xdm:timestamp": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2019-04-26T15:52:25+00:00", + "xdm:status": "existing" + }, + "53cba6b2-a23b-454a-8069-fc41308f1c0f": { + "xdm:version": "3", + "xdm:lastQualificationTime": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2018-04-27T15:52:25+00:00", + "xdm:status": "realized" + } + }, + "Email": { + "abcd@adobe.com": { + "xdm:version": "1", + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "exited" + } + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-segmentmembership.schema.md b/docs/reference/mixins/experience-event/experienceevent-segmentmembership.schema.md new file mode 100644 index 000000000..21dcd2bc4 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-segmentmembership.schema.md @@ -0,0 +1,103 @@ + +# ExperienceEvent Segment Membership Details Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-segmentmembership +``` + +This mixin is used to capture information regarding ExperienceEvent segment membership, including which segments the individual belongs to, the last qualification time, and when the membership is valid until. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-segmentmembership.schema.json](mixins/experience-event/experienceevent-segmentmembership.schema.json) | +## Schema Hierarchy + +* ExperienceEvent Segment Membership Details `https://ns.adobe.com/xdm/context/experienceevent-segmentmembership` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## ExperienceEvent Segment Membership Details Example +```json +{ + "xdm:segmentMembership": { + "AAM": { + "04a81716-43d6-4e7a-a49c-f1d8b3129ba9": { + "xdm:version": "15", + "xdm:timestamp": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2019-04-26T15:52:25+00:00", + "xdm:status": "existing" + }, + "53cba6b2-a23b-454a-8069-fc41308f1c0f": { + "xdm:version": "3", + "xdm:lastQualificationTime": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2018-04-27T15:52:25+00:00", + "xdm:status": "realized" + } + }, + "Email": { + "abcd@adobe.com": { + "xdm:version": "1", + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "exited" + } + } + } +} +``` + +# ExperienceEvent Segment Membership Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:segmentMembership](#xdmsegmentmembership) | `object` | Optional | ExperienceEvent Segment Membership Details (this schema) | +| [xdm:segmentMemberships](#xdmsegmentmemberships) | Segment membership item | Optional | ExperienceEvent Segment Membership Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:segmentMembership +### Segment Membership Map + +`xdm:segmentMembership` +* is optional +* type: `object` +* defined in this schema + +### xdm:segmentMembership Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:segmentMemberships +### Segment Memberships + +The segments associated with this ExperienceEvent. Deprecated, use `xdm:segmentMembership` instead. + +`xdm:segmentMemberships` +* is optional +* type: Segment membership item + +* defined in this schema + +### xdm:segmentMemberships Type + + +Array type: Segment membership item + +All items must be of the type: +* [Segment membership item](../../datatypes/segmentmembershipitem.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembershipitem` + + + + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-technical-details.schema.json b/docs/reference/mixins/experience-event/experienceevent-technical-details.schema.json new file mode 100644 index 000000000..59ea2212c --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-technical-details.schema.json @@ -0,0 +1,53 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-technical-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent technical details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "Technical details extension for ExperienceEvent.", + "definitions": { + "experienceevent-technical-details": { + "properties": { + "xdm:dataSource": { + "title": "Data source", + "$ref": "https://ns.adobe.com/xdm/data/datasource", + "description": "Globally unique identification of a data source." + }, + "xdm:receivedTimestamp": { + "title": "Received time stamp", + "type": "string", + "format": "date-time", + "description": "The time at which this interaction was received by a server." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-technical-details" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:receivedTimestamp": "2017-09-26T15:52:25+00:00" + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-technical-details.schema.md b/docs/reference/mixins/experience-event/experienceevent-technical-details.schema.md new file mode 100644 index 000000000..a6850931c --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-technical-details.schema.md @@ -0,0 +1,77 @@ + +# ExperienceEvent technical details Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-technical-details +``` + +Technical details extension for ExperienceEvent. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-technical-details.schema.json](mixins/experience-event/experienceevent-technical-details.schema.json) | +## Schema Hierarchy + +* ExperienceEvent technical details `https://ns.adobe.com/xdm/context/experienceevent-technical-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Data Source](../../datatypes/data/datasource.schema.md) `https://ns.adobe.com/xdm/data/datasource` + + +## ExperienceEvent technical details Example +```json +{ + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "xdm:receivedTimestamp": "2017-09-26T15:52:25+00:00" +} +``` + +# ExperienceEvent technical details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:dataSource](#xdmdatasource) | Data Source | Optional | ExperienceEvent technical details (this schema) | +| [xdm:receivedTimestamp](#xdmreceivedtimestamp) | `string` | Optional | ExperienceEvent technical details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:dataSource +### Data source + +Globally unique identification of a data source. + +`xdm:dataSource` +* is optional +* type: Data Source +* defined in this schema + +### xdm:dataSource Type + + +* [Data Source](../../datatypes/data/datasource.schema.md) – `https://ns.adobe.com/xdm/data/datasource` + + + + + +## xdm:receivedTimestamp +### Received time stamp + +The time at which this interaction was received by a server. + +`xdm:receivedTimestamp` +* is optional +* type: `string` +* defined in this schema + +### xdm:receivedTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + diff --git a/docs/reference/mixins/experience-event/experienceevent-web.schema.json b/docs/reference/mixins/experience-event/experienceevent-web.schema.json new file mode 100644 index 000000000..113262184 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-web.schema.json @@ -0,0 +1,59 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-web", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent web details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/experienceevent" + ], + "description": "This mixin is used to capture information regarding web details related to an ExperienceEvent, such as the interaction, page details, and referrer.", + "definitions": { + "experienceevent-web": { + "properties": { + "xdm:web": { + "title": "Web", + "$ref": "https://ns.adobe.com/xdm/context/webinfo", + "description": "The information related to web page and link of the ExperienceEvent." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-web" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/experience-event/experienceevent-web.schema.md b/docs/reference/mixins/experience-event/experienceevent-web.schema.md new file mode 100644 index 000000000..63c0bfaa2 --- /dev/null +++ b/docs/reference/mixins/experience-event/experienceevent-web.schema.md @@ -0,0 +1,67 @@ + +# ExperienceEvent web details Schema + +``` +https://ns.adobe.com/xdm/context/experienceevent-web +``` + +This mixin is used to capture information regarding web details related to an ExperienceEvent, such as the interaction, page details, and referrer. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/experience-event/experienceevent-web.schema.json](mixins/experience-event/experienceevent-web.schema.json) | +## Schema Hierarchy + +* ExperienceEvent web details `https://ns.adobe.com/xdm/context/experienceevent-web` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Web information](../../datatypes/webinfo.schema.md) `https://ns.adobe.com/xdm/context/webinfo` + + +## ExperienceEvent web details Example +```json +{ + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + } +} +``` + +# ExperienceEvent web details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:web](#xdmweb) | Web information | Optional | ExperienceEvent web details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:web +### Web + +The information related to web page and link of the ExperienceEvent. + +`xdm:web` +* is optional +* type: Web information +* defined in this schema + +### xdm:web Type + + +* [Web information](../../datatypes/webinfo.schema.md) – `https://ns.adobe.com/xdm/context/webinfo` + + + + diff --git a/docs/reference/mixins/graphs/graph-edge.schema.json b/docs/reference/mixins/graphs/graph-edge.schema.json new file mode 100644 index 000000000..64ded1268 --- /dev/null +++ b/docs/reference/mixins/graphs/graph-edge.schema.json @@ -0,0 +1,169 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/graph-edge", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Graph Edge", + "type": "object", + "description": "XDM graph schema for edge/relationship between two nodes/vertices.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/graphs" + ], + "definitions": { + "graph-edge": { + "properties": { + "xdm:edges": { + "title": "Array Of Edges", + "description": "Array of edges.", + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:edgeId": { + "title": "Edge Identifier", + "description": "The unique identifier of the identity associated with this graph edge.", + "type": "string" + }, + "xdm:sourceNodeId": { + "title": "Source Node Id", + "description": "Source node identifier.", + "type": "string" + }, + "xdm:targetNodeId": { + "title": "Target Node Id", + "description": "Target node identifier.", + "type": "string" + }, + "xdm:relation": { + "title": "Relation Description", + "description": "Relation description.", + "type": "string" + }, + "xdm:label": { + "title": "Label", + "description": "Additional description.", + "type": "string" + }, + "xdm:dataProvider": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "xdm:dataProviderId": { + "title": "Data Provider Id", + "description": "Identifier of the Data Provider..", + "type": "integer" + }, + "xdm:firstSeenTimestamp": { + "title": "Relationship Observed Time and Date", + "description": "Time and date the relation was first observed.", + "type": "string", + "format": "date-time" + }, + "xdm:lastSeenTimestamp": { + "title": "Relationship Observed most recent Time and Date", + "description": "Time and date the relation was last observed.", + "type": "string", + "format": "date-time" + }, + "xdm:trusted": { + "title": "Trusted Data Source Flag", + "description": "Indicator of whether the data source is trusted or not.", + "type": "boolean", + "default": true + }, + "xdm:directed": { + "title": "Directed Or Birectional", + "description": "Nature of graph whether it is directed or birectional.", + "type": "boolean", + "default": false + }, + "xdm:relationType": { + "title": "Relationship Type", + "description": "The method that established the relationship - Online/Offline deterministic/probabilistic.", + "type": "string", + "enum": [ + "online_deterministic", + "online_probabilistic", + "offline_deterministic", + "offline_probabilistic" + ], + "meta:enum": { + "online_deterministic": "Online Deterministic", + "online_probabilistic": "Online Probabilistic", + "offline_deterministic": "Offline Deterministic", + "offline_probabilistic": "Offline Probabilistic" + } + }, + "xdm:frequency": { + "title": "Frequency", + "description": "Frequency of the observed relationship.", + "type": "integer" + }, + "xdm:score": { + "title": "Relationship Score", + "description": "Imputed score of relationship.", + "type": "number" + }, + "xdm:summedRecency": { + "title": "Recency Score", + "description": "Recency score of relationship.", + "type": "integer" + }, + "xdm:lastCalculatedTimestamp": { + "title": "Last Calculated Data And Time", + "description": "Time and date the relationship score was last calculated.", + "type": "string", + "format": "date-time" + } + } + } + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/graph-edge" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:edges": [ + { + "xdm:sourceNodeId": "aam_1|0", + "xdm:targetNodeId": "dpuuid_1|10", + "xdm:dataProvider": [ + { + "xdm:dataProviderId": 5, + "xdm:firstSeenTimestamp": "2019-02-01T15:52:25+00:00", + "xdm:lastSeenTimestamp": "2019-02-01T15:52:25+00:00", + "xdm:trusted": true, + "xdm:directed": false, + "xdm:relationType": "online_deterministic", + "xdm:frequency": 1, + "xdm:lastCalculatedTimestamp": "2019-02-01T15:52:25+00:00" + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/graphs/graph-edge.schema.md b/docs/reference/mixins/graphs/graph-edge.schema.md new file mode 100644 index 000000000..f3a4f2ebc --- /dev/null +++ b/docs/reference/mixins/graphs/graph-edge.schema.md @@ -0,0 +1,587 @@ + +# XDM Graph Edge Schema + +``` +https://ns.adobe.com/xdm/context/graph-edge +``` + +XDM graph schema for edge/relationship between two nodes/vertices. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/graphs/graph-edge.schema.json](mixins/graphs/graph-edge.schema.json) | +## Schema Hierarchy + +* XDM Graph Edge `https://ns.adobe.com/xdm/context/graph-edge` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Audit trail](../../datatypes/auditable.schema.md) `https://ns.adobe.com/xdm/common/auditable` + + +## XDM Graph Edge Example +```json +{ + "xdm:edges": [ + { + "xdm:sourceNodeId": "aam_1|0", + "xdm:targetNodeId": "dpuuid_1|10", + "xdm:dataProvider": [ + { + "xdm:dataProviderId": 5, + "xdm:firstSeenTimestamp": "2019-02-01T15:52:25+00:00", + "xdm:lastSeenTimestamp": "2019-02-01T15:52:25+00:00", + "xdm:trusted": true, + "xdm:directed": false, + "xdm:relationType": "online_deterministic", + "xdm:frequency": 1, + "xdm:lastCalculatedTimestamp": "2019-02-01T15:52:25+00:00" + } + ] + } + ] +} +``` + +# XDM Graph Edge Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [repo:createDate](#repocreatedate) | `string` | Optional | [Audit trail](../../datatypes/auditable.schema.md#repocreatedate) | +| [repo:modifyDate](#repomodifydate) | `string` | Optional | [Audit trail](../../datatypes/auditable.schema.md#repomodifydate) | +| [xdm:createdByBatchID](#xdmcreatedbybatchid) | `string` | Optional | [Audit trail](../../datatypes/auditable.schema.md#xdmcreatedbybatchid) | +| [xdm:edges](#xdmedges) | `object[]` | Optional | XDM Graph Edge (this schema) | +| [xdm:modifiedByBatchID](#xdmmodifiedbybatchid) | `string` | Optional | [Audit trail](../../datatypes/auditable.schema.md#xdmmodifiedbybatchid) | +| [xdm:repositoryCreatedBy](#xdmrepositorycreatedby) | `string` | Optional | [Audit trail](../../datatypes/auditable.schema.md#xdmrepositorycreatedby) | +| [xdm:repositoryLastModifiedBy](#xdmrepositorylastmodifiedby) | `string` | Optional | [Audit trail](../../datatypes/auditable.schema.md#xdmrepositorylastmodifiedby) | +| `*` | any | Additional | this schema *allows* additional properties | + +## repo:createDate + +The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:createDate` +* is optional +* type: `string` +* defined in [Audit trail](../../datatypes/auditable.schema.md#repocreatedate) + +### repo:createDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:createDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## repo:modifyDate + +The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:modifyDate` +* is optional +* type: `string` +* defined in [Audit trail](../../datatypes/auditable.schema.md#repomodifydate) + +### repo:modifyDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:modifyDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## xdm:createdByBatchID +### Created by batch identifier + +The dataset files in Catalog which has been originating the creation of the record. + +`xdm:createdByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](../../datatypes/auditable.schema.md#xdmcreatedbybatchid) + +### xdm:createdByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:edges +### Array Of Edges + +Array of edges. + +`xdm:edges` +* is optional +* type: `object[]` + +* defined in this schema + +### xdm:edges Type + + +Array type: `object[]` + +All items must be of the type: +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:dataProvider`| array | Optional | +| `xdm:edgeId`| string | Optional | +| `xdm:label`| string | Optional | +| `xdm:relation`| string | Optional | +| `xdm:sourceNodeId`| string | Optional | +| `xdm:targetNodeId`| string | Optional | + + + +#### xdm:dataProvider + +undefined + +`xdm:dataProvider` +* is optional +* type: `object[]` + + +##### xdm:dataProvider Type + + +Array type: `object[]` + +All items must be of the type: +`object` with following properties: + + +| Property | Type | Required | Default | +|----------|------|----------|---------| +| `xdm:dataProviderId`| integer | Optional | | +| `xdm:directed`| boolean | Optional | `false` | +| `xdm:firstSeenTimestamp`| string | Optional | | +| `xdm:frequency`| integer | Optional | | +| `xdm:lastCalculatedTimestamp`| string | Optional | | +| `xdm:lastSeenTimestamp`| string | Optional | | +| `xdm:relationType`| string | Optional | | +| `xdm:score`| number | Optional | | +| `xdm:summedRecency`| integer | Optional | | +| `xdm:trusted`| boolean | Optional | `true` | + + + +#### xdm:dataProviderId +##### Data Provider Id + +Identifier of the Data Provider.. + +`xdm:dataProviderId` +* is optional +* type: `integer` + +##### xdm:dataProviderId Type + + +`integer` + + + + + + + + +#### xdm:directed +##### Directed Or Birectional + +Nature of graph whether it is directed or birectional. + +`xdm:directed` +* is optional +* type: `boolean` +* default: `false` + + +##### xdm:directed Type + + +`boolean` + + + + + + + +#### xdm:firstSeenTimestamp +##### Relationship Observed Time and Date + +Time and date the relation was first observed. + +`xdm:firstSeenTimestamp` +* is optional +* type: `string` + +##### xdm:firstSeenTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + +#### xdm:frequency +##### Frequency + +Frequency of the observed relationship. + +`xdm:frequency` +* is optional +* type: `integer` + +##### xdm:frequency Type + + +`integer` + + + + + + + + +#### xdm:lastCalculatedTimestamp +##### Last Calculated Data And Time + +Time and date the relationship score was last calculated. + +`xdm:lastCalculatedTimestamp` +* is optional +* type: `string` + +##### xdm:lastCalculatedTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + +#### xdm:lastSeenTimestamp +##### Relationship Observed most recent Time and Date + +Time and date the relation was last observed. + +`xdm:lastSeenTimestamp` +* is optional +* type: `string` + +##### xdm:lastSeenTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + +#### xdm:relationType +##### Relationship Type + +The method that established the relationship - Online/Offline deterministic/probabilistic. + +`xdm:relationType` +* is optional +* type: `enum` + +The value of this property **must** be equal to one of the [known values below](#xdmedges-known-values). + +##### xdm:relationType Known Values +| Value | Description | +|-------|-------------| +| `online_deterministic` | Online Deterministic | +| `online_probabilistic` | Online Probabilistic | +| `offline_deterministic` | Offline Deterministic | +| `offline_probabilistic` | Offline Probabilistic | + + + + + + +#### xdm:score +##### Relationship Score + +Imputed score of relationship. + +`xdm:score` +* is optional +* type: `number` + +##### xdm:score Type + + +`number` + + + + + + + + +#### xdm:summedRecency +##### Recency Score + +Recency score of relationship. + +`xdm:summedRecency` +* is optional +* type: `integer` + +##### xdm:summedRecency Type + + +`integer` + + + + + + + + +#### xdm:trusted +##### Trusted Data Source Flag + +Indicator of whether the data source is trusted or not. + +`xdm:trusted` +* is optional +* type: `boolean` +* default: `true` + + +##### xdm:trusted Type + + +`boolean` + + + + + + + + + + + + + + +#### xdm:edgeId +##### Edge Identifier + +The unique identifier of the identity associated with this graph edge. + +`xdm:edgeId` +* is optional +* type: `string` + +##### xdm:edgeId Type + + +`string` + + + + + + + + +#### xdm:label +##### Label + +Additional description. + +`xdm:label` +* is optional +* type: `string` + +##### xdm:label Type + + +`string` + + + + + + + + +#### xdm:relation +##### Relation Description + +Relation description. + +`xdm:relation` +* is optional +* type: `string` + +##### xdm:relation Type + + +`string` + + + + + + + + +#### xdm:sourceNodeId +##### Source Node Id + +Source node identifier. + +`xdm:sourceNodeId` +* is optional +* type: `string` + +##### xdm:sourceNodeId Type + + +`string` + + + + + + + + +#### xdm:targetNodeId +##### Target Node Id + +Target node identifier. + +`xdm:targetNodeId` +* is optional +* type: `string` + +##### xdm:targetNodeId Type + + +`string` + + + + + + + + + + + + + + +## xdm:modifiedByBatchID +### Modified by batch identifier + +The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`. + +`xdm:modifiedByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](../../datatypes/auditable.schema.md#xdmmodifiedbybatchid) + +### xdm:modifiedByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:repositoryCreatedBy +### Created by user identifier + +User ID of who created the record. + +`xdm:repositoryCreatedBy` +* is optional +* type: `string` +* defined in [Audit trail](../../datatypes/auditable.schema.md#xdmrepositorycreatedby) + +### xdm:repositoryCreatedBy Type + + +`string` + + + + + + +## xdm:repositoryLastModifiedBy +### Modified by user identifier + +User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`. + +`xdm:repositoryLastModifiedBy` +* is optional +* type: `string` +* defined in [Audit trail](../../datatypes/auditable.schema.md#xdmrepositorylastmodifiedby) + +### xdm:repositoryLastModifiedBy Type + + +`string` + + + + + diff --git a/docs/reference/mixins/graphs/graph-node.schema.json b/docs/reference/mixins/graphs/graph-node.schema.json new file mode 100644 index 000000000..40806ede3 --- /dev/null +++ b/docs/reference/mixins/graphs/graph-node.schema.json @@ -0,0 +1,110 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/graph-node", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Graph Node/Vertex Schema", + "type": "object", + "description": "XDM Schema for a graph Node/Vertex.", + "meta:auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/graphs" + ], + "definitions": { + "graph-node": { + "properties": { + "xdm:nodes": { + "title": "Array Of Nodes", + "description": "Array of nodes.", + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:nodeId": { + "title": "Node Identifier", + "description": "The unique identifier of the identity associated with this graph node.", + "type": "string" + }, + "xdm:nodeType": { + "title": "Node Type", + "description": "Type of node.", + "type": "string" + }, + "xdm:label": { + "title": "Node Label", + "description": "Node label.", + "type": "string" + }, + "xdm:dataSource": { + "title": "Data Source", + "description": "Data source for the node.", + "type": "string" + }, + "xdm:firstSeenTimestamp": { + "title": "Node First Seen Date And Time", + "description": "Time and date this node was first seen.", + "type": "string", + "format": "date-time" + }, + "xdm:lastSeenTimestamp": { + "title": "Node Last Seen Date And Time", + "description": "Time and date this node was last seen.", + "type": "string", + "format": "date-time" + }, + "xdm:firstCreateTimestamp": { + "title": "Node Created Date And Time", + "description": "Time and date this node was first created.", + "type": "string", + "format": "date-time" + }, + "xdm:lastModifiedTimestamp": { + "title": "Node Last Modified Date And Time", + "description": "Time and date this node was last modified.", + "type": "string", + "format": "date-time" + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/graph-node" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:nodes": [ + { + "xdm:nodeId": "aam_1|0", + "xdm:nodeType": "Identity", + "xdm:firstSeenTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:lastSeenTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:firstCreateTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:lastModifiedTimestamp": "2019-01-01T15:52:25+00:00" + }, + { + "xdm:nodeId": "dpuuid_1|10", + "xdm:nodeType": "Identity", + "xdm:firstSeenTimestamp": "2019-03-01T15:52:25+00:00", + "xdm:lastSeenTimestamp": "2019-03-01T15:52:25+00:00", + "xdm:firstCreateTimestamp": "2019-03-01T15:52:25+00:00", + "xdm:lastModifiedTimestamp": "2019-03-01T15:52:25+00:00" + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/graphs/graph-node.schema.md b/docs/reference/mixins/graphs/graph-node.schema.md new file mode 100644 index 000000000..f66cf1427 --- /dev/null +++ b/docs/reference/mixins/graphs/graph-node.schema.md @@ -0,0 +1,259 @@ + +# XDM Graph Node/Vertex Schema Schema + +``` +https://ns.adobe.com/xdm/context/graph-node +``` + +XDM Schema for a graph Node/Vertex. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/graphs/graph-node.schema.json](mixins/graphs/graph-node.schema.json) | +## Schema Hierarchy + +* XDM Graph Node/Vertex Schema `https://ns.adobe.com/xdm/context/graph-node` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## XDM Graph Node/Vertex Schema Example +```json +{ + "xdm:nodes": [ + { + "xdm:nodeId": "aam_1|0", + "xdm:nodeType": "Identity", + "xdm:firstSeenTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:lastSeenTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:firstCreateTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:lastModifiedTimestamp": "2019-01-01T15:52:25+00:00" + }, + { + "xdm:nodeId": "dpuuid_1|10", + "xdm:nodeType": "Identity", + "xdm:firstSeenTimestamp": "2019-03-01T15:52:25+00:00", + "xdm:lastSeenTimestamp": "2019-03-01T15:52:25+00:00", + "xdm:firstCreateTimestamp": "2019-03-01T15:52:25+00:00", + "xdm:lastModifiedTimestamp": "2019-03-01T15:52:25+00:00" + } + ] +} +``` + +# XDM Graph Node/Vertex Schema Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:nodes](#xdmnodes) | `object[]` | Optional | XDM Graph Node/Vertex Schema (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:nodes +### Array Of Nodes + +Array of nodes. + +`xdm:nodes` +* is optional +* type: `object[]` + +* defined in this schema + +### xdm:nodes Type + + +Array type: `object[]` + +All items must be of the type: +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:dataSource`| string | Optional | +| `xdm:firstCreateTimestamp`| string | Optional | +| `xdm:firstSeenTimestamp`| string | Optional | +| `xdm:label`| string | Optional | +| `xdm:lastModifiedTimestamp`| string | Optional | +| `xdm:lastSeenTimestamp`| string | Optional | +| `xdm:nodeId`| string | Optional | +| `xdm:nodeType`| string | Optional | + + + +#### xdm:dataSource +##### Data Source + +Data source for the node. + +`xdm:dataSource` +* is optional +* type: `string` + +##### xdm:dataSource Type + + +`string` + + + + + + + + +#### xdm:firstCreateTimestamp +##### Node Created Date And Time + +Time and date this node was first created. + +`xdm:firstCreateTimestamp` +* is optional +* type: `string` + +##### xdm:firstCreateTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + +#### xdm:firstSeenTimestamp +##### Node First Seen Date And Time + +Time and date this node was first seen. + +`xdm:firstSeenTimestamp` +* is optional +* type: `string` + +##### xdm:firstSeenTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + +#### xdm:label +##### Node Label + +Node label. + +`xdm:label` +* is optional +* type: `string` + +##### xdm:label Type + + +`string` + + + + + + + + +#### xdm:lastModifiedTimestamp +##### Node Last Modified Date And Time + +Time and date this node was last modified. + +`xdm:lastModifiedTimestamp` +* is optional +* type: `string` + +##### xdm:lastModifiedTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + +#### xdm:lastSeenTimestamp +##### Node Last Seen Date And Time + +Time and date this node was last seen. + +`xdm:lastSeenTimestamp` +* is optional +* type: `string` + +##### xdm:lastSeenTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + +#### xdm:nodeId +##### Node Identifier + +The unique identifier of the identity associated with this graph node. + +`xdm:nodeId` +* is optional +* type: `string` + +##### xdm:nodeId Type + + +`string` + + + + + + + + +#### xdm:nodeType +##### Node Type + +Type of node. + +`xdm:nodeType` +* is optional +* type: `string` + +##### xdm:nodeType Type + + +`string` + + + + + + + + + + + + + diff --git a/docs/reference/mixins/graphs/graph.schema.json b/docs/reference/mixins/graphs/graph.schema.json new file mode 100644 index 000000000..63607e7b4 --- /dev/null +++ b/docs/reference/mixins/graphs/graph.schema.json @@ -0,0 +1,80 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/graph", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Graph Schema", + "type": "object", + "description": "XDM graph schema to host graph data.", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/graphs" + ], + "definitions": { + "graph": { + "properties": { + "xdm:graphId": { + "title": "Graph Identifier", + "description": "The unique identifier of the identity associated with this graph.", + "type": "string" + }, + "xdm:label": { + "title": "Graph Label", + "description": "Graph label.", + "type": "string" + }, + "xdm:directed": { + "title": "Directed Graph Indicator", + "description": "Directed graph indicator.", + "type": "boolean", + "default": true + }, + "xdm:graphType": { + "title": "Graph Type", + "description": "Graph type. Examples - Person graph, Third party graph, Private graph etc.", + "type": "string" + }, + "xdm:firstCreatedTimestamp": { + "title": "Graph Created Date And Time", + "description": "Time and date this graph was created.", + "type": "string", + "format": "date-time" + }, + "xdm:lastModifiedTimestamp": { + "title": "Graph Last Modified Date And Time", + "description": "Time and date this graph was last modified.", + "type": "string", + "format": "date-time" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/graph" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:graphId": "96698daa-d44a-4960-bb7e-588bfc928ea3", + "xdm:directed": false, + "xdm:graphType": "Person Graph", + "xdm:graphCreateTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:firstCreatedTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:lastModifiedTimestamp": "2019-03-10T15:52:25+00:00" + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/graphs/graph.schema.md b/docs/reference/mixins/graphs/graph.schema.md new file mode 100644 index 000000000..45c748798 --- /dev/null +++ b/docs/reference/mixins/graphs/graph.schema.md @@ -0,0 +1,302 @@ + +# XDM Graph Schema Schema + +``` +https://ns.adobe.com/xdm/context/graph +``` + +XDM graph schema to host graph data. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/graphs/graph.schema.json](mixins/graphs/graph.schema.json) | +## Schema Hierarchy + +* XDM Graph Schema `https://ns.adobe.com/xdm/context/graph` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Audit trail](../../datatypes/auditable.schema.md) `https://ns.adobe.com/xdm/common/auditable` + + +## XDM Graph Schema Example +```json +{ + "xdm:graphId": "96698daa-d44a-4960-bb7e-588bfc928ea3", + "xdm:directed": false, + "xdm:graphType": "Person Graph", + "xdm:graphCreateTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:firstCreatedTimestamp": "2019-01-01T15:52:25+00:00", + "xdm:lastModifiedTimestamp": "2019-03-10T15:52:25+00:00" +} +``` + +# XDM Graph Schema Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [repo:createDate](#repocreatedate) | `string` | Optional | | [Audit trail](../../datatypes/auditable.schema.md#repocreatedate) | +| [repo:modifyDate](#repomodifydate) | `string` | Optional | | [Audit trail](../../datatypes/auditable.schema.md#repomodifydate) | +| [xdm:createdByBatchID](#xdmcreatedbybatchid) | `string` | Optional | | [Audit trail](../../datatypes/auditable.schema.md#xdmcreatedbybatchid) | +| [xdm:directed](#xdmdirected) | `boolean` | Optional | `true` | XDM Graph Schema (this schema) | +| [xdm:firstCreatedTimestamp](#xdmfirstcreatedtimestamp) | `string` | Optional | | XDM Graph Schema (this schema) | +| [xdm:graphId](#xdmgraphid) | `string` | Optional | | XDM Graph Schema (this schema) | +| [xdm:graphType](#xdmgraphtype) | `string` | Optional | | XDM Graph Schema (this schema) | +| [xdm:label](#xdmlabel) | `string` | Optional | | XDM Graph Schema (this schema) | +| [xdm:lastModifiedTimestamp](#xdmlastmodifiedtimestamp) | `string` | Optional | | XDM Graph Schema (this schema) | +| [xdm:modifiedByBatchID](#xdmmodifiedbybatchid) | `string` | Optional | | [Audit trail](../../datatypes/auditable.schema.md#xdmmodifiedbybatchid) | +| [xdm:repositoryCreatedBy](#xdmrepositorycreatedby) | `string` | Optional | | [Audit trail](../../datatypes/auditable.schema.md#xdmrepositorycreatedby) | +| [xdm:repositoryLastModifiedBy](#xdmrepositorylastmodifiedby) | `string` | Optional | | [Audit trail](../../datatypes/auditable.schema.md#xdmrepositorylastmodifiedby) | +| `*` | any | Additional | this schema *allows* additional properties | + +## repo:createDate + +The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:createDate` +* is optional +* type: `string` +* defined in [Audit trail](../../datatypes/auditable.schema.md#repocreatedate) + +### repo:createDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:createDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## repo:modifyDate + +The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00". + +`repo:modifyDate` +* is optional +* type: `string` +* defined in [Audit trail](../../datatypes/auditable.schema.md#repomodifydate) + +### repo:modifyDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + +### repo:modifyDate Example + +```json +"2004-10-23T12:00:00-06:00" +``` + + +## xdm:createdByBatchID +### Created by batch identifier + +The dataset files in Catalog which has been originating the creation of the record. + +`xdm:createdByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](../../datatypes/auditable.schema.md#xdmcreatedbybatchid) + +### xdm:createdByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:directed +### Directed Graph Indicator + +Directed graph indicator. + +`xdm:directed` +* is optional +* type: `boolean` +* default: `true` +* defined in this schema + +### xdm:directed Type + + +`boolean` + + + + + +## xdm:firstCreatedTimestamp +### Graph Created Date And Time + +Time and date this graph was created. + +`xdm:firstCreatedTimestamp` +* is optional +* type: `string` +* defined in this schema + +### xdm:firstCreatedTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:graphId +### Graph Identifier + +The unique identifier of the identity associated with this graph. + +`xdm:graphId` +* is optional +* type: `string` +* defined in this schema + +### xdm:graphId Type + + +`string` + + + + + + +## xdm:graphType +### Graph Type + +Graph type. Examples - Person graph, Third party graph, Private graph etc. + +`xdm:graphType` +* is optional +* type: `string` +* defined in this schema + +### xdm:graphType Type + + +`string` + + + + + + +## xdm:label +### Graph Label + +Graph label. + +`xdm:label` +* is optional +* type: `string` +* defined in this schema + +### xdm:label Type + + +`string` + + + + + + +## xdm:lastModifiedTimestamp +### Graph Last Modified Date And Time + +Time and date this graph was last modified. + +`xdm:lastModifiedTimestamp` +* is optional +* type: `string` +* defined in this schema + +### xdm:lastModifiedTimestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:modifiedByBatchID +### Modified by batch identifier + +The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`. + +`xdm:modifiedByBatchID` +* is optional +* type: `string` +* defined in [Audit trail](../../datatypes/auditable.schema.md#xdmmodifiedbybatchid) + +### xdm:modifiedByBatchID Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:repositoryCreatedBy +### Created by user identifier + +User ID of who created the record. + +`xdm:repositoryCreatedBy` +* is optional +* type: `string` +* defined in [Audit trail](../../datatypes/auditable.schema.md#xdmrepositorycreatedby) + +### xdm:repositoryCreatedBy Type + + +`string` + + + + + + +## xdm:repositoryLastModifiedBy +### Modified by user identifier + +User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`. + +`xdm:repositoryLastModifiedBy` +* is optional +* type: `string` +* defined in [Audit trail](../../datatypes/auditable.schema.md#xdmrepositorylastmodifiedby) + +### xdm:repositoryLastModifiedBy Type + + +`string` + + + + + diff --git a/docs/reference/mixins/opportunity-contact-role/opportunity-contact-role-details.schema.json b/docs/reference/mixins/opportunity-contact-role/opportunity-contact-role-details.schema.json new file mode 100644 index 000000000..179655c68 --- /dev/null +++ b/docs/reference/mixins/opportunity-contact-role/opportunity-contact-role-details.schema.json @@ -0,0 +1,60 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/opportunity-contact-role-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Buying Group Additional Properties", + "type": "object", + "meta:extensible": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/opportunity-contact-role" + ], + "description": "Opportunity Contact Role additional properties", + "definitions": { + "opportunity-contact-role-details": { + "properties": { + "xdm:roleID": { + "title": "Contact Role ID", + "description": "Contact role unique identifier.", + "type": "string" + }, + "xdm:opportunityContactRole": { + "title": "Opportunity Contact Role", + "description": "Role of the opportunity contact like finance , sales .", + "type": "string" + }, + "xdm:isPrimary": { + "title": "Primary Flag", + "description": "A flag to signify that this is the primary opportunity contact", + "type": "boolean" + }, + "xdm:isDeleted": { + "title": "Deleted Flag", + "description": "A flag to signify that this opportunity is in deleted state.", + "type": "boolean" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/opportunity-contact-role-details" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:roleID": "1234", + "xdm:role": "finance", + "xdm:isPrimary": false, + "xdm:isDeleted": false + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/opportunity-contact-role/opportunity-contact-role-details.schema.md b/docs/reference/mixins/opportunity-contact-role/opportunity-contact-role-details.schema.md new file mode 100644 index 000000000..22f1b0914 --- /dev/null +++ b/docs/reference/mixins/opportunity-contact-role/opportunity-contact-role-details.schema.md @@ -0,0 +1,115 @@ + +# XDM Buying Group Additional Properties Schema + +``` +https://ns.adobe.com/xdm/context/opportunity-contact-role-details +``` + +Opportunity Contact Role additional properties + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [mixins/opportunity-contact-role/opportunity-contact-role-details.schema.json](mixins/opportunity-contact-role/opportunity-contact-role-details.schema.json) | +## Schema Hierarchy + +* XDM Buying Group Additional Properties `https://ns.adobe.com/xdm/context/opportunity-contact-role-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## XDM Buying Group Additional Properties Example +```json +{ + "xdm:roleID": "1234", + "xdm:role": "finance", + "xdm:isPrimary": false, + "xdm:isDeleted": false +} +``` + +# XDM Buying Group Additional Properties Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:isDeleted](#xdmisdeleted) | `boolean` | Optional | XDM Buying Group Additional Properties (this schema) | +| [xdm:isPrimary](#xdmisprimary) | `boolean` | Optional | XDM Buying Group Additional Properties (this schema) | +| [xdm:opportunityContactRole](#xdmopportunitycontactrole) | `string` | Optional | XDM Buying Group Additional Properties (this schema) | +| [xdm:roleID](#xdmroleid) | `string` | Optional | XDM Buying Group Additional Properties (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:isDeleted +### Deleted Flag + +A flag to signify that this opportunity is in deleted state. + +`xdm:isDeleted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isDeleted Type + + +`boolean` + + + + + +## xdm:isPrimary +### Primary Flag + +A flag to signify that this is the primary opportunity contact + +`xdm:isPrimary` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isPrimary Type + + +`boolean` + + + + + +## xdm:opportunityContactRole +### Opportunity Contact Role + +Role of the opportunity contact like finance , sales . + +`xdm:opportunityContactRole` +* is optional +* type: `string` +* defined in this schema + +### xdm:opportunityContactRole Type + + +`string` + + + + + + +## xdm:roleID +### Contact Role ID + +Contact role unique identifier. + +`xdm:roleID` +* is optional +* type: `string` +* defined in this schema + +### xdm:roleID Type + + +`string` + + + + + diff --git a/docs/reference/mixins/opportunity/opportunity-crm.schema.json b/docs/reference/mixins/opportunity/opportunity-crm.schema.json new file mode 100644 index 000000000..f086c89f0 --- /dev/null +++ b/docs/reference/mixins/opportunity/opportunity-crm.schema.json @@ -0,0 +1,187 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/opportunity-crm", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "B2B Opportunity Additional Properties", + "type": "object", + "meta:extensible": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/opportunity" + ], + "description": "B2B specific opportunity properties.", + "definitions": { + "opportunity-crm": { + "properties": { + "xdm:opportunityName": { + "title": "Opportunity Name", + "description": "Subject or descriptive name, such as the expected order or company name, for the opportunity.", + "type": "string" + }, + "xdm:sourceType": { + "title": "Opportunity Source Type", + "description": "Opportunity source type such as Existing Business or New Business", + "type": "string" + }, + "xdm:opportunityDescription": { + "title": "Opportunity Description", + "description": "Additional information to describe the opportunity, such as possible products to sell or past purchases from the customer.", + "type": "string" + }, + "xdm:ownerID": { + "title": "Opportunity Owner", + "description": "Assigned owner for this opportunity.", + "type": "string" + }, + "xdm:leadSource": { + "title": "Lead Source", + "description": "Source of the opportunity such as Advertisement, Partner, or Web.", + "type": "string" + }, + "xdm:stage": { + "title": "Opportunity Stage", + "description": "Sales stage of this opportunity to aid the sales team in their efforts to win this opportunity.", + "type": "string" + }, + "xdm:amount": { + "title": "Opportunity Amount", + "description": "Estimated total sale amount.", + "type": "number", + "minimum": 0, + "default": 0 + }, + "xdm:currencyCode": { + "title": "Currency Code", + "description": "Standard ISO code(ISO 4217) for currency.", + "type": "string", + "pattern": "^([A-Z]{3})$" + }, + "xdm:quantity": { + "title": "Opportunity Quantity", + "description": "Total of all quantity field values for all products in the Products related list for this opportunity.", + "type": "integer", + "minimum": 0, + "default": 0 + }, + "xdm:fiscalYear": { + "title": "Fiscal Year", + "description": "The fiscal year this opportunity is targeted.", + "type": "integer", + "pattern": "^([0-9]{4})$" + }, + "xdm:fiscalQuarter": { + "title": "Fiscal Quarter", + "description": "The fiscal quarter this opportunity is targeted..", + "type": "string", + "pattern": "^([1-4]{1})$|^([Qq][1-4]{1})$" + }, + "xdm:hasOpportunityLineItem": { + "title": "Has Opportunity Line Item Flag", + "description": "Flag to indicate whether this opportunity have more line items.", + "type": "boolean" + }, + "xdm:probabilityPercentage": { + "title": "Probability Percentage", + "description": "Likelihood that opportunity will close, stated as a percentage.", + "type": "integer", + "minimum": 0, + "maximum": 100 + }, + "xdm:isClosed": { + "title": "Closed Flag", + "description": "Flag indicating if this opportunity is closed.", + "type": "boolean" + }, + "xdm:isWon": { + "title": "Won Flag", + "description": "Flag indicating if this opportunity is Won.", + "type": "boolean" + }, + "xdm:isDeleted": { + "title": "Deleted Flag", + "description": "Flag indicating if this opportunity is deleted.", + "type": "boolean" + }, + "xdm:closeDate": { + "title": "Close Date", + "description": "Date of closure for this opportunity.", + "type": "string", + "format": "date-time" + }, + "xdm:nextStep": { + "title": "Next Step", + "description": "Description of next task in closing opportunity.", + "type": "string" + }, + "xdm:isPrivate": { + "title": "Private Flag", + "description": "Indicates that the opportunity is private.", + "type": "boolean" + }, + "xdm:contractID": { + "title": "Contract ID", + "description": "Contract unique Identifier reference that this opportunity is linked to.", + "type": "string" + }, + "xdm:forecastCategory": { + "title": "Forecast Category", + "description": "Forecast Category determined by the opportunity Stage value eg: omitted,pipeline,bestcase,commit,closed.", + "type": "string" + }, + "xdm:forecastCategoryName": { + "title": "Forecast Category Name", + "description": "Forecast category name that is displayed in reports for a perticular forecast category.", + "type": "string" + }, + "xdm:expectedRevenue": { + "title": "Expected Revenue", + "description": "Calculated revenue based on the Amount and Probability.", + "type": "number", + "minimum": 0, + "default": 0 + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/opportunity-crm" + } + ], + "required": [ + "xdm:stage" + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:opportunityName": "Apple_opportunity", + "xdm:description": "Apple corporation AEP opportunity", + "xdm:ownerID": "test", + "xdm:leadSource": "salesforce", + "xdm:stage": "initial", + "xdm:amount": 1000000, + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:fiscalYear": 2020, + "xdm:fiscalQuarter": "1", + "xdm:hasOpportunityLineItem": false, + "xdm:probabilityPercentage": 90, + "xdm:isClosed": false, + "xdm:isWon": true, + "xdm:isDeleted": false, + "xdm:closeDate": "2019-01-20T15:52:25+00:00", + "xdm:isPrivate": true, + "xdm:contractID": "12345", + "xdm:forecastCategory": "pipeline", + "xdm:forecastCategoryName": "AEP_pipeline", + "xdm:expectedRevenue": 900000 + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/opportunity/opportunity-crm.schema.md b/docs/reference/mixins/opportunity/opportunity-crm.schema.md new file mode 100644 index 000000000..ac7b55cb3 --- /dev/null +++ b/docs/reference/mixins/opportunity/opportunity-crm.schema.md @@ -0,0 +1,550 @@ + +# B2B Opportunity Additional Properties Schema + +``` +https://ns.adobe.com/xdm/context/opportunity-crm +``` + +B2B specific opportunity properties. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [mixins/opportunity/opportunity-crm.schema.json](mixins/opportunity/opportunity-crm.schema.json) | +## Schema Hierarchy + +* B2B Opportunity Additional Properties `https://ns.adobe.com/xdm/context/opportunity-crm` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## B2B Opportunity Additional Properties Example +```json +{ + "xdm:opportunityName": "Apple_opportunity", + "xdm:description": "Apple corporation AEP opportunity", + "xdm:ownerID": "test", + "xdm:leadSource": "salesforce", + "xdm:stage": "initial", + "xdm:amount": 1000000, + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:fiscalYear": 2020, + "xdm:fiscalQuarter": "1", + "xdm:hasOpportunityLineItem": false, + "xdm:probabilityPercentage": 90, + "xdm:isClosed": false, + "xdm:isWon": true, + "xdm:isDeleted": false, + "xdm:closeDate": "2019-01-20T15:52:25+00:00", + "xdm:isPrivate": true, + "xdm:contractID": "12345", + "xdm:forecastCategory": "pipeline", + "xdm:forecastCategoryName": "AEP_pipeline", + "xdm:expectedRevenue": 900000 +} +``` + +# B2B Opportunity Additional Properties Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:amount](#xdmamount) | `number` | Optional | `0` | B2B Opportunity Additional Properties (this schema) | +| [xdm:closeDate](#xdmclosedate) | `string` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:contractID](#xdmcontractid) | `string` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:currencyCode](#xdmcurrencycode) | `string` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:expectedRevenue](#xdmexpectedrevenue) | `number` | Optional | `0` | B2B Opportunity Additional Properties (this schema) | +| [xdm:fiscalQuarter](#xdmfiscalquarter) | `string` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:fiscalYear](#xdmfiscalyear) | `integer` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:forecastCategory](#xdmforecastcategory) | `string` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:forecastCategoryName](#xdmforecastcategoryname) | `string` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:hasOpportunityLineItem](#xdmhasopportunitylineitem) | `boolean` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:isClosed](#xdmisclosed) | `boolean` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:isDeleted](#xdmisdeleted) | `boolean` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:isPrivate](#xdmisprivate) | `boolean` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:isWon](#xdmiswon) | `boolean` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:leadSource](#xdmleadsource) | `string` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:nextStep](#xdmnextstep) | `string` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:opportunityDescription](#xdmopportunitydescription) | `string` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:opportunityName](#xdmopportunityname) | `string` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:ownerID](#xdmownerid) | `string` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:probabilityPercentage](#xdmprobabilitypercentage) | `integer` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:quantity](#xdmquantity) | `integer` | Optional | `0` | B2B Opportunity Additional Properties (this schema) | +| [xdm:sourceType](#xdmsourcetype) | `string` | Optional | | B2B Opportunity Additional Properties (this schema) | +| [xdm:stage](#xdmstage) | `string` | **Required** | | B2B Opportunity Additional Properties (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:amount +### Opportunity Amount + +Estimated total sale amount. + +`xdm:amount` +* is optional +* type: `number` +* default: `0` +* defined in this schema + +### xdm:amount Type + + +`number` +* minimum value: `0` + + + + + + +## xdm:closeDate +### Close Date + +Date of closure for this opportunity. + +`xdm:closeDate` +* is optional +* type: `string` +* defined in this schema + +### xdm:closeDate Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + +## xdm:contractID +### Contract ID + +Contract unique Identifier reference that this opportunity is linked to. + +`xdm:contractID` +* is optional +* type: `string` +* defined in this schema + +### xdm:contractID Type + + +`string` + + + + + + +## xdm:currencyCode +### Currency Code + +Standard ISO code(ISO 4217) for currency. + +`xdm:currencyCode` +* is optional +* type: `string` +* defined in this schema + +### xdm:currencyCode Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E(%5BA-Z%5D%7B3%7D)%24)): +```regex +^([A-Z]{3})$ +``` + + + + + + +## xdm:expectedRevenue +### Expected Revenue + +Calculated revenue based on the Amount and Probability. + +`xdm:expectedRevenue` +* is optional +* type: `number` +* default: `0` +* defined in this schema + +### xdm:expectedRevenue Type + + +`number` +* minimum value: `0` + + + + + + +## xdm:fiscalQuarter +### Fiscal Quarter + +The fiscal quarter this opportunity is targeted.. + +`xdm:fiscalQuarter` +* is optional +* type: `string` +* defined in this schema + +### xdm:fiscalQuarter Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E(%5B1-4%5D%7B1%7D)%24%7C%5E(%5BQq%5D%5B1-4%5D%7B1%7D)%24)): +```regex +^([1-4]{1})$|^([Qq][1-4]{1})$ +``` + + + + + + +## xdm:fiscalYear +### Fiscal Year + +The fiscal year this opportunity is targeted. + +`xdm:fiscalYear` +* is optional +* type: `integer` +* defined in this schema + +### xdm:fiscalYear Type + + +`integer` + + + + + + +## xdm:forecastCategory +### Forecast Category + +Forecast Category determined by the opportunity Stage value eg: omitted,pipeline,bestcase,commit,closed. + +`xdm:forecastCategory` +* is optional +* type: `string` +* defined in this schema + +### xdm:forecastCategory Type + + +`string` + + + + + + +## xdm:forecastCategoryName +### Forecast Category Name + +Forecast category name that is displayed in reports for a perticular forecast category. + +`xdm:forecastCategoryName` +* is optional +* type: `string` +* defined in this schema + +### xdm:forecastCategoryName Type + + +`string` + + + + + + +## xdm:hasOpportunityLineItem +### Has Opportunity Line Item Flag + +Flag to indicate whether this opportunity have more line items. + +`xdm:hasOpportunityLineItem` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:hasOpportunityLineItem Type + + +`boolean` + + + + + +## xdm:isClosed +### Closed Flag + +Flag indicating if this opportunity is closed. + +`xdm:isClosed` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isClosed Type + + +`boolean` + + + + + +## xdm:isDeleted +### Deleted Flag + +Flag indicating if this opportunity is deleted. + +`xdm:isDeleted` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isDeleted Type + + +`boolean` + + + + + +## xdm:isPrivate +### Private Flag + +Indicates that the opportunity is private. + +`xdm:isPrivate` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isPrivate Type + + +`boolean` + + + + + +## xdm:isWon +### Won Flag + +Flag indicating if this opportunity is Won. + +`xdm:isWon` +* is optional +* type: `boolean` +* defined in this schema + +### xdm:isWon Type + + +`boolean` + + + + + +## xdm:leadSource +### Lead Source + +Source of the opportunity such as Advertisement, Partner, or Web. + +`xdm:leadSource` +* is optional +* type: `string` +* defined in this schema + +### xdm:leadSource Type + + +`string` + + + + + + +## xdm:nextStep +### Next Step + +Description of next task in closing opportunity. + +`xdm:nextStep` +* is optional +* type: `string` +* defined in this schema + +### xdm:nextStep Type + + +`string` + + + + + + +## xdm:opportunityDescription +### Opportunity Description + +Additional information to describe the opportunity, such as possible products to sell or past purchases from the customer. + +`xdm:opportunityDescription` +* is optional +* type: `string` +* defined in this schema + +### xdm:opportunityDescription Type + + +`string` + + + + + + +## xdm:opportunityName +### Opportunity Name + +Subject or descriptive name, such as the expected order or company name, for the opportunity. + +`xdm:opportunityName` +* is optional +* type: `string` +* defined in this schema + +### xdm:opportunityName Type + + +`string` + + + + + + +## xdm:ownerID +### Opportunity Owner + +Assigned owner for this opportunity. + +`xdm:ownerID` +* is optional +* type: `string` +* defined in this schema + +### xdm:ownerID Type + + +`string` + + + + + + +## xdm:probabilityPercentage +### Probability Percentage + +Likelihood that opportunity will close, stated as a percentage. + +`xdm:probabilityPercentage` +* is optional +* type: `integer` +* defined in this schema + +### xdm:probabilityPercentage Type + + +`integer` +* minimum value: `0` +* maximum value: `100` + + + + + +## xdm:quantity +### Opportunity Quantity + +Total of all quantity field values for all products in the Products related list for this opportunity. + +`xdm:quantity` +* is optional +* type: `integer` +* default: `0` +* defined in this schema + +### xdm:quantity Type + + +`integer` +* minimum value: `0` + + + + + + +## xdm:sourceType +### Opportunity Source Type + +Opportunity source type such as Existing Business or New Business + +`xdm:sourceType` +* is optional +* type: `string` +* defined in this schema + +### xdm:sourceType Type + + +`string` + + + + + + +## xdm:stage +### Opportunity Stage + +Sales stage of this opportunity to aid the sales team in their efforts to win this opportunity. + +`xdm:stage` +* is **required** +* type: `string` +* defined in this schema + +### xdm:stage Type + + +`string` + + + + + diff --git a/docs/reference/mixins/profile/profile-contact-crm.schema.json b/docs/reference/mixins/profile/profile-contact-crm.schema.json new file mode 100644 index 000000000..21a1cc1fc --- /dev/null +++ b/docs/reference/mixins/profile/profile-contact-crm.schema.json @@ -0,0 +1,208 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-contact-crm", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Contact", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/profile-person-details", + "https://ns.adobe.com/xdm/context/profile-personal-details", + "https://ns.adobe.com/xdm/context/profile-work-details", + "https://ns.adobe.com/xdm/context/profile-other-work-details", + "https://ns.adobe.com/xdm/context/profile-owning-entities" + ], + "description": "This mixin is used to capture information regarding person details in context of Business to Business contact.", + "definitions": { + "profile-contact-crm": { + "properties": { + "xdm:contact": { + "title": "Contact Details", + "description": "Holds properties for a person to be recognized as a contact in the business-to-business space.", + "$ref": "https://ns.adobe.com/xdm/common/b2b-contact" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-person-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-work-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-other-work-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-owning-entities" + }, + { + "$ref": "#/definitions/profile-contact-crm" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:contact": { + "xdm:ID": "11110000", + "xdm:accountID": "", + "xdm:leadSource": "Lead Source", + "xdm:extendedContact": { + "xdm:type": "", + "xdm:ownerID": "", + "xdm:isDeleted": false, + "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00", + "xdm:emailBouncedReason": "Bounced Reason Here", + "xdm:isEmailBounced": true, + "xdm:description": "Contact/Lead description here", + "xdm:status": "Status", + "xdm:timezone": "", + "xdm:jigsaw": "12345" + }, + "xdm:identityMap": { + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:preferences": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false, + "xdm:optOutDetails": { + "xdm:email": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:phone": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + } + } + }, + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-20T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-20T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDate": "1996-10-28", + "xdm:homePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:workAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + }, + "xdm:workEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active" + }, + "xdm:workPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:otherAddress": { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": false, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "xdm:otherPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + }, + "xdm:extendedWorkDetails": { + "xdm:assistantDetails": { + "xdm:name": { + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" + }, + "xdm:phone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + } + }, + "xdm:reportsToID": "RPT10000", + "xdm:departments": [ + "Finance", + "Marketing" + ], + "xdm:jobTitle": "", + "xdm:photoUrl": "https://PersonOrg.com/personPhoto.jpg" + }, + "xdm:photoUrl": "https://PersonOrg.com/personPhoto.jpg", + "xdm:orgUnit": { + "@id": "https://data.adobe.io/org-apparals-men" + }, + "xdm:geoUnit": { + "@id": "https://data.adobe.io/geo-france" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-contact-crm.schema.md b/docs/reference/mixins/profile/profile-contact-crm.schema.md new file mode 100644 index 000000000..8bdce5554 --- /dev/null +++ b/docs/reference/mixins/profile/profile-contact-crm.schema.md @@ -0,0 +1,683 @@ + +# XDM Business Contact Schema + +``` +https://ns.adobe.com/xdm/context/profile-contact-crm +``` + +This mixin is used to capture information regarding person details in context of Business to Business contact. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [mixins/profile/profile-contact-crm.schema.json](mixins/profile/profile-contact-crm.schema.json) | +## Schema Hierarchy + +* XDM Business Contact `https://ns.adobe.com/xdm/context/profile-contact-crm` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [External Source System Audit Details Mixin](../shared/external-source-system-audit-details.schema.md) `https://ns.adobe.com/xdm/common/external-source-system-audit-details` + * [IdentityMap](../shared/identitymap.schema.md) `https://ns.adobe.com/xdm/context/identitymap` + * [Profile person details](profile-person-details.schema.md) `https://ns.adobe.com/xdm/context/profile-person-details` + * [Profile personal details](profile-personal-details.schema.md) `https://ns.adobe.com/xdm/context/profile-personal-details` + * [Profile work details](profile-work-details.schema.md) `https://ns.adobe.com/xdm/context/profile-work-details` + * [Profile Other Work Details](profile-other-work-details.schema.md) `https://ns.adobe.com/xdm/context/profile-other-work-details` + * [Profile owning entity details](profile-owning-entities.schema.md) `https://ns.adobe.com/xdm/context/profile-owning-entities` + * [B2B Contact](../../datatypes/b2b-contact.schema.md) `https://ns.adobe.com/xdm/common/b2b-contact` + + +## XDM Business Contact Example +```json +{ + "xdm:contact": { + "xdm:ID": "11110000", + "xdm:accountID": "", + "xdm:leadSource": "Lead Source", + "xdm:extendedContact": { + "xdm:type": "", + "xdm:ownerID": "", + "xdm:isDeleted": false, + "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00", + "xdm:emailBouncedReason": "Bounced Reason Here", + "xdm:isEmailBounced": true, + "xdm:description": "Contact/Lead description here", + "xdm:status": "Status", + "xdm:timezone": "", + "xdm:jigsaw": "12345" + }, + "xdm:identityMap": { + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:preferences": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false, + "xdm:optOutDetails": { + "xdm:email": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:phone": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + } + } + }, + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-20T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-20T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDate": "1996-10-28", + "xdm:homePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:workAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + }, + "xdm:workEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active" + }, + "xdm:workPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:otherAddress": { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": false, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "xdm:otherPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + }, + "xdm:extendedWorkDetails": { + "xdm:assistantDetails": { + "xdm:name": { + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" + }, + "xdm:phone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + } + }, + "xdm:reportsToID": "RPT10000", + "xdm:departments": [ + "Finance", + "Marketing" + ], + "xdm:jobTitle": "", + "xdm:photoUrl": "https://PersonOrg.com/personPhoto.jpg" + }, + "xdm:photoUrl": "https://PersonOrg.com/personPhoto.jpg", + "xdm:orgUnit": { + "@id": "https://data.adobe.io/org-apparals-men" + }, + "xdm:geoUnit": { + "@id": "https://data.adobe.io/geo-france" + } +} +``` + +# XDM Business Contact Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:contact](#xdmcontact) | B2B Contact | Optional | XDM Business Contact (this schema) | +| [xdm:extSourceSystemAudit](#xdmextsourcesystemaudit) | External Source System Audit Attributes | Optional | [External Source System Audit Details Mixin](../shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) | +| [xdm:extendedWorkDetails](#xdmextendedworkdetails) | `object` | Optional | [Profile Other Work Details](profile-other-work-details.schema.md#xdmextendedworkdetails) | +| [xdm:faxPhone](#xdmfaxphone) | Phone number | Optional | [Profile personal details](profile-personal-details.schema.md#xdmfaxphone) | +| [xdm:geoUnit](#xdmgeounit) | Geographical unit | Optional | [Profile owning entity details](profile-owning-entities.schema.md#xdmgeounit) | +| [xdm:homeAddress](#xdmhomeaddress) | Postal address | Optional | [Profile personal details](profile-personal-details.schema.md#xdmhomeaddress) | +| [xdm:homePhone](#xdmhomephone) | Phone number | Optional | [Profile personal details](profile-personal-details.schema.md#xdmhomephone) | +| [xdm:identityMap](#xdmidentitymap) | `object` | Optional | [IdentityMap](../shared/identitymap.schema.md#xdmidentitymap) | +| [xdm:mobilePhone](#xdmmobilephone) | Phone number | Optional | [Profile personal details](profile-personal-details.schema.md#xdmmobilephone) | +| [xdm:orgUnit](#xdmorgunit) | Organizational unit | Optional | [Profile owning entity details](profile-owning-entities.schema.md#xdmorgunit) | +| [xdm:organizations](#xdmorganizations) | `string[]` | Optional | [Profile work details](profile-work-details.schema.md#xdmorganizations) | +| [xdm:otherAddress](#xdmotheraddress) | Postal address | Optional | [Profile Other Work Details](profile-other-work-details.schema.md#xdmotheraddress) | +| [xdm:otherPhone](#xdmotherphone) | Phone number | Optional | [Profile Other Work Details](profile-other-work-details.schema.md#xdmotherphone) | +| [xdm:person](#xdmperson) | Person | Optional | [Profile person details](profile-person-details.schema.md#xdmperson) | +| [xdm:personalEmail](#xdmpersonalemail) | Email address | Optional | [Profile personal details](profile-personal-details.schema.md#xdmpersonalemail) | +| [xdm:workAddress](#xdmworkaddress) | Postal address | Optional | [Profile work details](profile-work-details.schema.md#xdmworkaddress) | +| [xdm:workEmail](#xdmworkemail) | Email address | Optional | [Profile work details](profile-work-details.schema.md#xdmworkemail) | +| [xdm:workPhone](#xdmworkphone) | Phone number | Optional | [Profile work details](profile-work-details.schema.md#xdmworkphone) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:contact +### Contact Details + +Holds properties for a person to be recognized as a contact in the business-to-business space. + +`xdm:contact` +* is optional +* type: B2B Contact +* defined in this schema + +### xdm:contact Type + + +* [B2B Contact](../../datatypes/b2b-contact.schema.md) – `https://ns.adobe.com/xdm/common/b2b-contact` + + + + + +## xdm:extSourceSystemAudit +### External Source System Audit Properties + +Audit attributes for external sources. + +`xdm:extSourceSystemAudit` +* is optional +* type: External Source System Audit Attributes +* defined in [External Source System Audit Details Mixin](../shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) + +### xdm:extSourceSystemAudit Type + + +* [External Source System Audit Attributes](../../datatypes/external-source-system-audit.schema.md) – `https://ns.adobe.com/xdm/common/external-source-system-audit` + + + + + +## xdm:extendedWorkDetails +### Some Additional Person Work Details + +`xdm:extendedWorkDetails` +* is optional +* type: `object` +* defined in [Profile Other Work Details](profile-other-work-details.schema.md#xdmextendedworkdetails) + +### xdm:extendedWorkDetails Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:assistantDetails`| object | Optional | +| `xdm:departments`| array | Optional | +| `xdm:jobTitle`| string | Optional | +| `xdm:photoUrl`| string | Optional | +| `xdm:reportsToID`| string | Optional | + + + +#### xdm:assistantDetails +##### Assitant Details + +undefined + +`xdm:assistantDetails` +* is optional +* type: `object` + +##### xdm:assistantDetails Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "Assitant Details", + "properties": { + "xdm:name": { + "title": "Assistant Name", + "$ref": "https://ns.adobe.com/xdm/context/person-name", + "description": "Person's assistant full name." + }, + "xdm:phone": { + "title": "Assistant Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Person's assistant phone number." + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:departments +##### Department Name + +Department name where the person works. + +`xdm:departments` +* is optional +* type: `string[]` + + +##### xdm:departments Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + + + + + + +#### xdm:jobTitle +##### Job Title + +Job title of the person. + +`xdm:jobTitle` +* is optional +* type: `string` + +##### xdm:jobTitle Type + + +`string` + + + + + + + + +#### xdm:photoUrl +##### Photo Url + +Photo url of the person. + +`xdm:photoUrl` +* is optional +* type: `string` + +##### xdm:photoUrl Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + + + +#### xdm:reportsToID +##### Reports To Id + +Identifier of the Reporting Manager. + +`xdm:reportsToID` +* is optional +* type: `string` + +##### xdm:reportsToID Type + + +`string` + + + + + + + + + + + +## xdm:faxPhone +### Fax phone + +Fax phone number. + +`xdm:faxPhone` +* is optional +* type: Phone number +* defined in [Profile personal details](profile-personal-details.schema.md#xdmfaxphone) + +### xdm:faxPhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:geoUnit +### Geographical unit + +The geographical unit within the organization owning the profile. This can be used to reference the geographical information maintained in another dataset. + +`xdm:geoUnit` +* is optional +* type: Geographical unit +* defined in [Profile owning entity details](profile-owning-entities.schema.md#xdmgeounit) + +### xdm:geoUnit Type + + +* [Geographical unit](../../datatypes/geounit.schema.md) – `https://ns.adobe.com/xdm/common/geounit` + + + + + +## xdm:homeAddress +### Home address + +A home postal address. + +`xdm:homeAddress` +* is optional +* type: Postal address +* defined in [Profile personal details](profile-personal-details.schema.md#xdmhomeaddress) + +### xdm:homeAddress Type + + +* [Postal address](../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + +## xdm:homePhone +### Home phone + +Home phone number. + +`xdm:homePhone` +* is optional +* type: Phone number +* defined in [Profile personal details](profile-personal-details.schema.md#xdmhomephone) + +### xdm:homePhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:identityMap + + +`xdm:identityMap` +* is optional +* type: `object` +* defined in [IdentityMap](../shared/identitymap.schema.md#xdmidentitymap) + +### xdm:identityMap Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:mobilePhone +### Mobile phone + +Mobile phone number. + +`xdm:mobilePhone` +* is optional +* type: Phone number +* defined in [Profile personal details](profile-personal-details.schema.md#xdmmobilephone) + +### xdm:mobilePhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:orgUnit +### Organizational unit + +The unit within the organization owning the profile. This can be used to reference the organization details maintained in another dataset. + +`xdm:orgUnit` +* is optional +* type: Organizational unit +* defined in [Profile owning entity details](profile-owning-entities.schema.md#xdmorgunit) + +### xdm:orgUnit Type + + +* [Organizational unit](../../datatypes/orgunit.schema.md) – `https://ns.adobe.com/xdm/common/orgunit` + + + + + +## xdm:organizations +### Organizations + +`xdm:organizations` +* is optional +* type: `string[]` + +* defined in [Profile work details](profile-work-details.schema.md#xdmorganizations) + +### xdm:organizations Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + + + + +## xdm:otherAddress +### Other Address + +Other/Alternate postal address of the person. + +`xdm:otherAddress` +* is optional +* type: Postal address +* defined in [Profile Other Work Details](profile-other-work-details.schema.md#xdmotheraddress) + +### xdm:otherAddress Type + + +* [Postal address](../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + +## xdm:otherPhone +### Other Phone + +Other/Alternate phone number of the person. + +`xdm:otherPhone` +* is optional +* type: Phone number +* defined in [Profile Other Work Details](profile-other-work-details.schema.md#xdmotherphone) + +### xdm:otherPhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:person +### Person + +An individual actor, contact, or owner. + +`xdm:person` +* is optional +* type: Person +* defined in [Profile person details](profile-person-details.schema.md#xdmperson) + +### xdm:person Type + + +* [Person](../../datatypes/person.schema.md) – `https://ns.adobe.com/xdm/context/person` + + + + + +## xdm:personalEmail +### Personal email + +A personal email address. + +`xdm:personalEmail` +* is optional +* type: Email address +* defined in [Profile personal details](profile-personal-details.schema.md#xdmpersonalemail) + +### xdm:personalEmail Type + + +* [Email address](../../datatypes/emailaddress.schema.md) – `https://ns.adobe.com/xdm/context/emailaddress` + + + + + +## xdm:workAddress +### Work Address + +A work postal address. + +`xdm:workAddress` +* is optional +* type: Postal address +* defined in [Profile work details](profile-work-details.schema.md#xdmworkaddress) + +### xdm:workAddress Type + + +* [Postal address](../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + +## xdm:workEmail +### Work Email + +A work email address. + +`xdm:workEmail` +* is optional +* type: Email address +* defined in [Profile work details](profile-work-details.schema.md#xdmworkemail) + +### xdm:workEmail Type + + +* [Email address](../../datatypes/emailaddress.schema.md) – `https://ns.adobe.com/xdm/context/emailaddress` + + + + + +## xdm:workPhone +### Work Phone + +Work phone number. + +`xdm:workPhone` +* is optional +* type: Phone number +* defined in [Profile work details](profile-work-details.schema.md#xdmworkphone) + +### xdm:workPhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + diff --git a/docs/reference/mixins/profile/profile-directmarketing.schema.json b/docs/reference/mixins/profile/profile-directmarketing.schema.json new file mode 100644 index 000000000..3686b476e --- /dev/null +++ b/docs/reference/mixins/profile/profile-directmarketing.schema.json @@ -0,0 +1,82 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-directmarketing", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile direct marketing", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "This mixin is used to capture information regarding addresses, emails, and phone numbers to be used for direct marketing activities.", + "definitions": { + "profile-directmarketing": { + "properties": { + "xdm:directMarketingAddress": { + "title": "Direct marketing address", + "$ref": "https://ns.adobe.com/xdm/context/directmarketing-address", + "description": "Direct marketing postal address." + }, + "xdm:directMarketingEmail": { + "title": "Direct marketing email", + "$ref": "https://ns.adobe.com/xdm/context/directmarketing-emailaddress", + "description": "Direct marketing email address." + }, + "xdm:directMarketingPhone": { + "title": "Direct marketing phone", + "$ref": "https://ns.adobe.com/xdm/context/directmarketing-phonenumber", + "description": "Direct marketing phone number." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-directmarketing" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:directMarketingPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active", + "xdm:errorCount": 0 + }, + "xdm:directMarketingAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02", + "xdm:errorCount": 0, + "xdm:quality": "Fully-recognized street" + }, + "xdm:directMarketingEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active", + "xdm:errorCount": 0 + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-directmarketing.schema.md b/docs/reference/mixins/profile/profile-directmarketing.schema.md new file mode 100644 index 000000000..fb9056eb7 --- /dev/null +++ b/docs/reference/mixins/profile/profile-directmarketing.schema.md @@ -0,0 +1,122 @@ + +# Profile direct marketing Schema + +``` +https://ns.adobe.com/xdm/context/profile-directmarketing +``` + +This mixin is used to capture information regarding addresses, emails, and phone numbers to be used for direct marketing activities. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/profile/profile-directmarketing.schema.json](mixins/profile/profile-directmarketing.schema.json) | +## Schema Hierarchy + +* Profile direct marketing `https://ns.adobe.com/xdm/context/profile-directmarketing` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Direct marketing postal address](../../datatypes/directmarketing-address.schema.md) `https://ns.adobe.com/xdm/context/directmarketing-address` + * [Direct marketing email address](../../datatypes/directmarketing-emailaddress.schema.md) `https://ns.adobe.com/xdm/context/directmarketing-emailaddress` + * [Direct marketing phone number](../../datatypes/directmarketing-phonenumber.schema.md) `https://ns.adobe.com/xdm/context/directmarketing-phonenumber` + + +## Profile direct marketing Example +```json +{ + "xdm:directMarketingPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active", + "xdm:errorCount": 0 + }, + "xdm:directMarketingAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": 121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02", + "xdm:errorCount": 0, + "xdm:quality": "Fully-recognized street" + }, + "xdm:directMarketingEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active", + "xdm:errorCount": 0 + } +} +``` + +# Profile direct marketing Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:directMarketingAddress](#xdmdirectmarketingaddress) | Direct marketing postal address | Optional | Profile direct marketing (this schema) | +| [xdm:directMarketingEmail](#xdmdirectmarketingemail) | Direct marketing email address | Optional | Profile direct marketing (this schema) | +| [xdm:directMarketingPhone](#xdmdirectmarketingphone) | Direct marketing phone number | Optional | Profile direct marketing (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:directMarketingAddress +### Direct marketing address + +Direct marketing postal address. + +`xdm:directMarketingAddress` +* is optional +* type: Direct marketing postal address +* defined in this schema + +### xdm:directMarketingAddress Type + + +* [Direct marketing postal address](../../datatypes/directmarketing-address.schema.md) – `https://ns.adobe.com/xdm/context/directmarketing-address` + + + + + +## xdm:directMarketingEmail +### Direct marketing email + +Direct marketing email address. + +`xdm:directMarketingEmail` +* is optional +* type: Direct marketing email address +* defined in this schema + +### xdm:directMarketingEmail Type + + +* [Direct marketing email address](../../datatypes/directmarketing-emailaddress.schema.md) – `https://ns.adobe.com/xdm/context/directmarketing-emailaddress` + + + + + +## xdm:directMarketingPhone +### Direct marketing phone + +Direct marketing phone number. + +`xdm:directMarketingPhone` +* is optional +* type: Direct marketing phone number +* defined in this schema + +### xdm:directMarketingPhone Type + + +* [Direct marketing phone number](../../datatypes/directmarketing-phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/directmarketing-phonenumber` + + + + diff --git a/docs/reference/mixins/profile/profile-identities-deprecated.schema.json b/docs/reference/mixins/profile/profile-identities-deprecated.schema.json new file mode 100644 index 000000000..00e0bf7cc --- /dev/null +++ b/docs/reference/mixins/profile/profile-identities-deprecated.schema.json @@ -0,0 +1,55 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-identities-deprecated", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Identities array for profile (deprecated)", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "Identities array for profile (deprecated).", + "definitions": { + "profile-identities-deprecated": { + "properties": { + "xdm:identities": { + "meta:status": "deprecated", + "title": "All user identities (deprecated)", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/identity" + }, + "minItems": 1, + "description": "Array of identities. Condensed, normalized encapsulation of all end-user identifiers. Deprecated, use `xdm:identityMap` instead." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-identities-deprecated" + } + ], + "meta:status": "deprecated", + "examples": [ + { + "xdm:identities": [ + { + "xdm:id": "someone@example.com", + "xdm:namespace": { + "xdm:code": "Email" + } + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-identities-deprecated.schema.md b/docs/reference/mixins/profile/profile-identities-deprecated.schema.md new file mode 100644 index 000000000..71a997437 --- /dev/null +++ b/docs/reference/mixins/profile/profile-identities-deprecated.schema.md @@ -0,0 +1,64 @@ + +# Identities array for profile (deprecated) Schema + +``` +https://ns.adobe.com/xdm/context/profile-identities-deprecated +``` + +Identities array for profile (deprecated). + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Deprecated | No | Forbidden | Permitted | [mixins/profile/profile-identities-deprecated.schema.json](mixins/profile/profile-identities-deprecated.schema.json) | +## Schema Hierarchy + +* Identities array for profile (deprecated) `https://ns.adobe.com/xdm/context/profile-identities-deprecated` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Identities array for profile (deprecated) Example +```json +{ + "xdm:identities": [ + { + "xdm:id": "someone@example.com", + "xdm:namespace": { + "xdm:code": "Email" + } + } + ] +} +``` + +# Identities array for profile (deprecated) Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:identities](#xdmidentities) | Identity | Optional | Identities array for profile (deprecated) (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:identities +### All user identities (deprecated) + +Array of identities. Condensed, normalized encapsulation of all end-user identifiers. Deprecated, use `xdm:identityMap` instead. + +`xdm:identities` +* is optional +* type: Identity +* at least `1` items in the array +* defined in this schema + +### xdm:identities Type + + +Array type: Identity + +All items must be of the type: +* [Identity](../../datatypes/identity.schema.md) – `https://ns.adobe.com/xdm/context/identity` + + + + + + + diff --git a/docs/reference/mixins/profile/profile-lead-crm.schema.json b/docs/reference/mixins/profile/profile-lead-crm.schema.json new file mode 100644 index 000000000..aa2dd31ee --- /dev/null +++ b/docs/reference/mixins/profile/profile-lead-crm.schema.json @@ -0,0 +1,227 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-lead-crm", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Lead ", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/profile-work-details", + "https://ns.adobe.com/xdm/context/profile-other-work-details", + "https://ns.adobe.com/xdm/context/profile-personal-details", + "https://ns.adobe.com/xdm/context/profile-person-details", + "https://ns.adobe.com/xdm/context/profile-owning-entities" + ], + "description": "This mixin is used to capture information regarding a B2B Lead.", + "definitions": { + "profile-lead-crm": { + "properties": { + "xdm:lead": { + "title": "Lead Details", + "description": "Holds properties for a person to be recognized as a lead in the business-to-business space.", + "$ref": "https://ns.adobe.com/xdm/common/b2b-lead" + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-lead-crm" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-person-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-work-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-other-work-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-owning-entities" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:lead": { + "xdm:ID": "", + "xdm:isConverted": true, + "xdm:convertedAccountID": "", + "xdm:convertedContactID": "", + "xdm:convertedDate": "2018-12-20T15:52:25+00:00", + "xdm:convertedOpportunityID": "", + "xdm:jigsawContactID": "", + "xdm:lastTransferDate": "2018-12-20T15:52:25+00:00", + "xdm:source": "", + "xdm:isUnReadByOwner": false, + "xdm:extendedLead": { + "xdm:type": "", + "xdm:ownerID": "", + "xdm:isDeleted": false, + "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00", + "xdm:emailBouncedReason": "Bounced Reason Here", + "xdm:isEmailBounced": true, + "xdm:description": "Contact description here", + "xdm:status": "Contacted", + "xdm:timezone": "" + }, + "xdm:identityMap": { + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:preferences": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false, + "xdm:optOutDetails": { + "xdm:email": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:phone": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + } + }, + "xdm:organization": { + "xdm:legalName": "ABC Stores", + "xdm:numberOfEmployees": 200, + "xdm:annualRevenue": 1000000, + "xdm:industry": "Retail", + "xdm:website": "http://www.abcstores.com" + } + }, + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-20T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-20T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:identityMap": { + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDate": "1996-10-28", + "xdm:homePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:workAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + }, + "xdm:workEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active" + }, + "xdm:workPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:otherAddress": { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": false, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "xdm:otherPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + }, + "xdm:extendedWorkDetails": { + "xdm:assistantDetails": { + "xdm:name": { + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" + }, + "xdm:phone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + } + }, + "xdm:reportsToID": "RPT10000", + "xdm:departments": [ + "Finance", + "Marketing" + ], + "xdm:jobTitle": "", + "xdm:photoUrl": "https://PersonOrg.com/personPhoto.jpg" + }, + "xdm:orgUnit": { + "@id": "https://data.adobe.io/org-apparals-men" + }, + "xdm:geoUnit": { + "@id": "https://data.adobe.io/geo-france" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-lead-crm.schema.md b/docs/reference/mixins/profile/profile-lead-crm.schema.md new file mode 100644 index 000000000..d3770873a --- /dev/null +++ b/docs/reference/mixins/profile/profile-lead-crm.schema.md @@ -0,0 +1,702 @@ + +# XDM Business Lead Schema + +``` +https://ns.adobe.com/xdm/context/profile-lead-crm +``` + +This mixin is used to capture information regarding a B2B Lead. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [mixins/profile/profile-lead-crm.schema.json](mixins/profile/profile-lead-crm.schema.json) | +## Schema Hierarchy + +* XDM Business Lead `https://ns.adobe.com/xdm/context/profile-lead-crm` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [B2B Lead](../../datatypes/b2b-lead.schema.md) `https://ns.adobe.com/xdm/common/b2b-lead` + * [IdentityMap](../shared/identitymap.schema.md) `https://ns.adobe.com/xdm/context/identitymap` + * [External Source System Audit Details Mixin](../shared/external-source-system-audit-details.schema.md) `https://ns.adobe.com/xdm/common/external-source-system-audit-details` + * [Profile person details](profile-person-details.schema.md) `https://ns.adobe.com/xdm/context/profile-person-details` + * [Profile personal details](profile-personal-details.schema.md) `https://ns.adobe.com/xdm/context/profile-personal-details` + * [Profile work details](profile-work-details.schema.md) `https://ns.adobe.com/xdm/context/profile-work-details` + * [Profile Other Work Details](profile-other-work-details.schema.md) `https://ns.adobe.com/xdm/context/profile-other-work-details` + * [Profile owning entity details](profile-owning-entities.schema.md) `https://ns.adobe.com/xdm/context/profile-owning-entities` + + +## XDM Business Lead Example +```json +{ + "xdm:lead": { + "xdm:ID": "", + "xdm:isConverted": true, + "xdm:convertedAccountID": "", + "xdm:convertedContactID": "", + "xdm:convertedDate": "2018-12-20T15:52:25+00:00", + "xdm:convertedOpportunityID": "", + "xdm:jigsawContactID": "", + "xdm:lastTransferDate": "2018-12-20T15:52:25+00:00", + "xdm:source": "", + "xdm:isUnReadByOwner": false, + "xdm:extendedLead": { + "xdm:type": "", + "xdm:ownerID": "", + "xdm:isDeleted": false, + "xdm:emailBouncedDate": "2018-12-20T15:52:25+00:00", + "xdm:emailBouncedReason": "Bounced Reason Here", + "xdm:isEmailBounced": true, + "xdm:description": "Contact description here", + "xdm:status": "Contacted", + "xdm:timezone": "" + }, + "xdm:identityMap": { + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:preferences": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false, + "xdm:optOutDetails": { + "xdm:email": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:phone": { + "xdm:optOutReason": "Reason here", + "xdm:optOutDate": "2018-01-20T15:52:25+00:00" + } + } + }, + "xdm:organization": { + "xdm:legalName": "ABC Stores", + "xdm:numberOfEmployees": 200, + "xdm:annualRevenue": 1000000, + "xdm:industry": "Retail", + "xdm:website": "http://www.abcstores.com" + } + }, + "xdm:extSourceSystemAudit": { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-20T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-20T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-20T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-20T15:52:25+00:00" + }, + "xdm:identityMap": { + "EMAIL": [ + { + "xdm:id": "jane@doe.com" + } + ] + }, + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDate": "1996-10-28", + "xdm:homePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:workAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-12-20" + }, + "xdm:workEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active" + }, + "xdm:workPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:otherAddress": { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": false, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "xdm:otherPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + }, + "xdm:extendedWorkDetails": { + "xdm:assistantDetails": { + "xdm:name": { + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" + }, + "xdm:phone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + } + }, + "xdm:reportsToID": "RPT10000", + "xdm:departments": [ + "Finance", + "Marketing" + ], + "xdm:jobTitle": "", + "xdm:photoUrl": "https://PersonOrg.com/personPhoto.jpg" + }, + "xdm:orgUnit": { + "@id": "https://data.adobe.io/org-apparals-men" + }, + "xdm:geoUnit": { + "@id": "https://data.adobe.io/geo-france" + } +} +``` + +# XDM Business Lead Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:extSourceSystemAudit](#xdmextsourcesystemaudit) | External Source System Audit Attributes | Optional | [External Source System Audit Details Mixin](../shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) | +| [xdm:extendedWorkDetails](#xdmextendedworkdetails) | `object` | Optional | [Profile Other Work Details](profile-other-work-details.schema.md#xdmextendedworkdetails) | +| [xdm:faxPhone](#xdmfaxphone) | Phone number | Optional | [Profile personal details](profile-personal-details.schema.md#xdmfaxphone) | +| [xdm:geoUnit](#xdmgeounit) | Geographical unit | Optional | [Profile owning entity details](profile-owning-entities.schema.md#xdmgeounit) | +| [xdm:homeAddress](#xdmhomeaddress) | Postal address | Optional | [Profile personal details](profile-personal-details.schema.md#xdmhomeaddress) | +| [xdm:homePhone](#xdmhomephone) | Phone number | Optional | [Profile personal details](profile-personal-details.schema.md#xdmhomephone) | +| [xdm:identityMap](#xdmidentitymap) | `object` | Optional | [IdentityMap](../shared/identitymap.schema.md#xdmidentitymap) | +| [xdm:lead](#xdmlead) | B2B Lead | Optional | XDM Business Lead (this schema) | +| [xdm:mobilePhone](#xdmmobilephone) | Phone number | Optional | [Profile personal details](profile-personal-details.schema.md#xdmmobilephone) | +| [xdm:orgUnit](#xdmorgunit) | Organizational unit | Optional | [Profile owning entity details](profile-owning-entities.schema.md#xdmorgunit) | +| [xdm:organizations](#xdmorganizations) | `string[]` | Optional | [Profile work details](profile-work-details.schema.md#xdmorganizations) | +| [xdm:otherAddress](#xdmotheraddress) | Postal address | Optional | [Profile Other Work Details](profile-other-work-details.schema.md#xdmotheraddress) | +| [xdm:otherPhone](#xdmotherphone) | Phone number | Optional | [Profile Other Work Details](profile-other-work-details.schema.md#xdmotherphone) | +| [xdm:person](#xdmperson) | Person | Optional | [Profile person details](profile-person-details.schema.md#xdmperson) | +| [xdm:personalEmail](#xdmpersonalemail) | Email address | Optional | [Profile personal details](profile-personal-details.schema.md#xdmpersonalemail) | +| [xdm:workAddress](#xdmworkaddress) | Postal address | Optional | [Profile work details](profile-work-details.schema.md#xdmworkaddress) | +| [xdm:workEmail](#xdmworkemail) | Email address | Optional | [Profile work details](profile-work-details.schema.md#xdmworkemail) | +| [xdm:workPhone](#xdmworkphone) | Phone number | Optional | [Profile work details](profile-work-details.schema.md#xdmworkphone) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:extSourceSystemAudit +### External Source System Audit Properties + +Audit attributes for external sources. + +`xdm:extSourceSystemAudit` +* is optional +* type: External Source System Audit Attributes +* defined in [External Source System Audit Details Mixin](../shared/external-source-system-audit-details.schema.md#xdmextsourcesystemaudit) + +### xdm:extSourceSystemAudit Type + + +* [External Source System Audit Attributes](../../datatypes/external-source-system-audit.schema.md) – `https://ns.adobe.com/xdm/common/external-source-system-audit` + + + + + +## xdm:extendedWorkDetails +### Some Additional Person Work Details + +`xdm:extendedWorkDetails` +* is optional +* type: `object` +* defined in [Profile Other Work Details](profile-other-work-details.schema.md#xdmextendedworkdetails) + +### xdm:extendedWorkDetails Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:assistantDetails`| object | Optional | +| `xdm:departments`| array | Optional | +| `xdm:jobTitle`| string | Optional | +| `xdm:photoUrl`| string | Optional | +| `xdm:reportsToID`| string | Optional | + + + +#### xdm:assistantDetails +##### Assitant Details + +undefined + +`xdm:assistantDetails` +* is optional +* type: `object` + +##### xdm:assistantDetails Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "Assitant Details", + "properties": { + "xdm:name": { + "title": "Assistant Name", + "$ref": "https://ns.adobe.com/xdm/context/person-name", + "description": "Person's assistant full name." + }, + "xdm:phone": { + "title": "Assistant Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Person's assistant phone number." + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:departments +##### Department Name + +Department name where the person works. + +`xdm:departments` +* is optional +* type: `string[]` + + +##### xdm:departments Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + + + + + + +#### xdm:jobTitle +##### Job Title + +Job title of the person. + +`xdm:jobTitle` +* is optional +* type: `string` + +##### xdm:jobTitle Type + + +`string` + + + + + + + + +#### xdm:photoUrl +##### Photo Url + +Photo url of the person. + +`xdm:photoUrl` +* is optional +* type: `string` + +##### xdm:photoUrl Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + + + +#### xdm:reportsToID +##### Reports To Id + +Identifier of the Reporting Manager. + +`xdm:reportsToID` +* is optional +* type: `string` + +##### xdm:reportsToID Type + + +`string` + + + + + + + + + + + +## xdm:faxPhone +### Fax phone + +Fax phone number. + +`xdm:faxPhone` +* is optional +* type: Phone number +* defined in [Profile personal details](profile-personal-details.schema.md#xdmfaxphone) + +### xdm:faxPhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:geoUnit +### Geographical unit + +The geographical unit within the organization owning the profile. This can be used to reference the geographical information maintained in another dataset. + +`xdm:geoUnit` +* is optional +* type: Geographical unit +* defined in [Profile owning entity details](profile-owning-entities.schema.md#xdmgeounit) + +### xdm:geoUnit Type + + +* [Geographical unit](../../datatypes/geounit.schema.md) – `https://ns.adobe.com/xdm/common/geounit` + + + + + +## xdm:homeAddress +### Home address + +A home postal address. + +`xdm:homeAddress` +* is optional +* type: Postal address +* defined in [Profile personal details](profile-personal-details.schema.md#xdmhomeaddress) + +### xdm:homeAddress Type + + +* [Postal address](../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + +## xdm:homePhone +### Home phone + +Home phone number. + +`xdm:homePhone` +* is optional +* type: Phone number +* defined in [Profile personal details](profile-personal-details.schema.md#xdmhomephone) + +### xdm:homePhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:identityMap + + +`xdm:identityMap` +* is optional +* type: `object` +* defined in [IdentityMap](../shared/identitymap.schema.md#xdmidentitymap) + +### xdm:identityMap Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:lead +### Lead Details + +Holds properties for a person to be recognized as a lead in the business-to-business space. + +`xdm:lead` +* is optional +* type: B2B Lead +* defined in this schema + +### xdm:lead Type + + +* [B2B Lead](../../datatypes/b2b-lead.schema.md) – `https://ns.adobe.com/xdm/common/b2b-lead` + + + + + +## xdm:mobilePhone +### Mobile phone + +Mobile phone number. + +`xdm:mobilePhone` +* is optional +* type: Phone number +* defined in [Profile personal details](profile-personal-details.schema.md#xdmmobilephone) + +### xdm:mobilePhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:orgUnit +### Organizational unit + +The unit within the organization owning the profile. This can be used to reference the organization details maintained in another dataset. + +`xdm:orgUnit` +* is optional +* type: Organizational unit +* defined in [Profile owning entity details](profile-owning-entities.schema.md#xdmorgunit) + +### xdm:orgUnit Type + + +* [Organizational unit](../../datatypes/orgunit.schema.md) – `https://ns.adobe.com/xdm/common/orgunit` + + + + + +## xdm:organizations +### Organizations + +`xdm:organizations` +* is optional +* type: `string[]` + +* defined in [Profile work details](profile-work-details.schema.md#xdmorganizations) + +### xdm:organizations Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + + + + +## xdm:otherAddress +### Other Address + +Other/Alternate postal address of the person. + +`xdm:otherAddress` +* is optional +* type: Postal address +* defined in [Profile Other Work Details](profile-other-work-details.schema.md#xdmotheraddress) + +### xdm:otherAddress Type + + +* [Postal address](../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + +## xdm:otherPhone +### Other Phone + +Other/Alternate phone number of the person. + +`xdm:otherPhone` +* is optional +* type: Phone number +* defined in [Profile Other Work Details](profile-other-work-details.schema.md#xdmotherphone) + +### xdm:otherPhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:person +### Person + +An individual actor, contact, or owner. + +`xdm:person` +* is optional +* type: Person +* defined in [Profile person details](profile-person-details.schema.md#xdmperson) + +### xdm:person Type + + +* [Person](../../datatypes/person.schema.md) – `https://ns.adobe.com/xdm/context/person` + + + + + +## xdm:personalEmail +### Personal email + +A personal email address. + +`xdm:personalEmail` +* is optional +* type: Email address +* defined in [Profile personal details](profile-personal-details.schema.md#xdmpersonalemail) + +### xdm:personalEmail Type + + +* [Email address](../../datatypes/emailaddress.schema.md) – `https://ns.adobe.com/xdm/context/emailaddress` + + + + + +## xdm:workAddress +### Work Address + +A work postal address. + +`xdm:workAddress` +* is optional +* type: Postal address +* defined in [Profile work details](profile-work-details.schema.md#xdmworkaddress) + +### xdm:workAddress Type + + +* [Postal address](../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + +## xdm:workEmail +### Work Email + +A work email address. + +`xdm:workEmail` +* is optional +* type: Email address +* defined in [Profile work details](profile-work-details.schema.md#xdmworkemail) + +### xdm:workEmail Type + + +* [Email address](../../datatypes/emailaddress.schema.md) – `https://ns.adobe.com/xdm/context/emailaddress` + + + + + +## xdm:workPhone +### Work Phone + +Work phone number. + +`xdm:workPhone` +* is optional +* type: Phone number +* defined in [Profile work details](profile-work-details.schema.md#xdmworkphone) + +### xdm:workPhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + diff --git a/docs/reference/mixins/profile/profile-other-work-details.schema.json b/docs/reference/mixins/profile/profile-other-work-details.schema.json new file mode 100644 index 000000000..9d17e0354 --- /dev/null +++ b/docs/reference/mixins/profile/profile-other-work-details.schema.json @@ -0,0 +1,134 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-other-work-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile Other Work Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "This mixin is used to capture information regarding additional/other work-related details of the individual such as work address, work email, work phone number, and organizations to which the profile belongs.", + "definitions": { + "profile-other-work-details": { + "properties": { + "xdm:otherAddress": { + "title": "Other Address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "Other/Alternate postal address of the person." + }, + "xdm:otherPhone": { + "title": "Other Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Other/Alternate phone number of the person." + }, + "xdm:extendedWorkDetails": { + "type": "object", + "title": "Some Additional Person Work Details", + "properties": { + "xdm:assistantDetails": { + "type": "object", + "title": "Assitant Details", + "properties": { + "xdm:name": { + "title": "Assistant Name", + "$ref": "https://ns.adobe.com/xdm/context/person-name", + "description": "Person's assistant full name." + }, + "xdm:phone": { + "title": "Assistant Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Person's assistant phone number." + } + } + }, + "xdm:reportsToID": { + "title": "Reports To Id", + "description": "Identifier of the Reporting Manager.", + "type": "string" + }, + "xdm:departments": { + "title": "Department Name", + "description": "Department name where the person works.", + "type": "array", + "items": { + "type": "string" + } + }, + "xdm:jobTitle": { + "title": "Job Title", + "description": "Job title of the person.", + "type": "string" + }, + "xdm:photoUrl": { + "title": "Photo Url", + "description": "Photo url of the person.", + "type": "string", + "format": "uri" + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-other-work-details" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:otherAddress": { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": false, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "xdm:otherPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + }, + "xdm:extendedWorkDetails": { + "xdm:assistantDetails": { + "xdm:name": { + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" + }, + "xdm:phone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + } + }, + "xdm:reportsToID": "RPT10000", + "xdm:departments": [ + "Finance", + "Marketing" + ], + "xdm:jobTitle": "", + "xdm:photoUrl": "https://PersonOrg.com/personPhoto.jpg" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-other-work-details.schema.md b/docs/reference/mixins/profile/profile-other-work-details.schema.md new file mode 100644 index 000000000..9bb376207 --- /dev/null +++ b/docs/reference/mixins/profile/profile-other-work-details.schema.md @@ -0,0 +1,271 @@ + +# Profile Other Work Details Schema + +``` +https://ns.adobe.com/xdm/context/profile-other-work-details +``` + +This mixin is used to capture information regarding additional/other work-related details of the individual such as work address, work email, work phone number, and organizations to which the profile belongs. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [mixins/profile/profile-other-work-details.schema.json](mixins/profile/profile-other-work-details.schema.json) | +## Schema Hierarchy + +* Profile Other Work Details `https://ns.adobe.com/xdm/context/profile-other-work-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Postal address](../../datatypes/address.schema.md) `https://ns.adobe.com/xdm/common/address` + * [Phone number](../../datatypes/phonenumber.schema.md) `https://ns.adobe.com/xdm/context/phonenumber` + + +## Profile Other Work Details Example +```json +{ + "xdm:otherAddress": { + "@id": "https://data.adobe.io/entities/address/234", + "xdm:primary": false, + "xdm:street1": "100 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "xdm:otherPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + }, + "xdm:extendedWorkDetails": { + "xdm:assistantDetails": { + "xdm:name": { + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" + }, + "xdm:phone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + } + }, + "xdm:reportsToID": "RPT10000", + "xdm:departments": [ + "Finance", + "Marketing" + ], + "xdm:jobTitle": "", + "xdm:photoUrl": "https://PersonOrg.com/personPhoto.jpg" + } +} +``` + +# Profile Other Work Details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:extendedWorkDetails](#xdmextendedworkdetails) | `object` | Optional | Profile Other Work Details (this schema) | +| [xdm:otherAddress](#xdmotheraddress) | Postal address | Optional | Profile Other Work Details (this schema) | +| [xdm:otherPhone](#xdmotherphone) | Phone number | Optional | Profile Other Work Details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:extendedWorkDetails +### Some Additional Person Work Details + +`xdm:extendedWorkDetails` +* is optional +* type: `object` +* defined in this schema + +### xdm:extendedWorkDetails Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:assistantDetails`| object | Optional | +| `xdm:departments`| array | Optional | +| `xdm:jobTitle`| string | Optional | +| `xdm:photoUrl`| string | Optional | +| `xdm:reportsToID`| string | Optional | + + + +#### xdm:assistantDetails +##### Assitant Details + +undefined + +`xdm:assistantDetails` +* is optional +* type: `object` + +##### xdm:assistantDetails Type + +Unknown type `object`. + +```json +{ + "type": "object", + "title": "Assitant Details", + "properties": { + "xdm:name": { + "title": "Assistant Name", + "$ref": "https://ns.adobe.com/xdm/context/person-name", + "description": "Person's assistant full name." + }, + "xdm:phone": { + "title": "Assistant Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Person's assistant phone number." + } + }, + "simpletype": "`object`" +} +``` + + + + + + + +#### xdm:departments +##### Department Name + +Department name where the person works. + +`xdm:departments` +* is optional +* type: `string[]` + + +##### xdm:departments Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + + + + + + +#### xdm:jobTitle +##### Job Title + +Job title of the person. + +`xdm:jobTitle` +* is optional +* type: `string` + +##### xdm:jobTitle Type + + +`string` + + + + + + + + +#### xdm:photoUrl +##### Photo Url + +Photo url of the person. + +`xdm:photoUrl` +* is optional +* type: `string` + +##### xdm:photoUrl Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + + + + +#### xdm:reportsToID +##### Reports To Id + +Identifier of the Reporting Manager. + +`xdm:reportsToID` +* is optional +* type: `string` + +##### xdm:reportsToID Type + + +`string` + + + + + + + + + + + +## xdm:otherAddress +### Other Address + +Other/Alternate postal address of the person. + +`xdm:otherAddress` +* is optional +* type: Postal address +* defined in this schema + +### xdm:otherAddress Type + + +* [Postal address](../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + +## xdm:otherPhone +### Other Phone + +Other/Alternate phone number of the person. + +`xdm:otherPhone` +* is optional +* type: Phone number +* defined in this schema + +### xdm:otherPhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + diff --git a/docs/reference/mixins/profile/profile-owning-entities.schema.json b/docs/reference/mixins/profile/profile-owning-entities.schema.json new file mode 100644 index 000000000..0c32525db --- /dev/null +++ b/docs/reference/mixins/profile/profile-owning-entities.schema.json @@ -0,0 +1,53 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-owning-entities", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile owning entity details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "This mixin is used to capture information regarding a particular organization or geographical unit to which the individual belongs.", + "definitions": { + "profile-owning-entities": { + "properties": { + "xdm:orgUnit": { + "title": "Organizational unit", + "$ref": "https://ns.adobe.com/xdm/common/orgunit", + "description": "The unit within the organization owning the profile. This can be used to reference the organization details maintained in another dataset." + }, + "xdm:geoUnit": { + "title": "Geographical unit", + "$ref": "https://ns.adobe.com/xdm/common/geounit", + "description": "The geographical unit within the organization owning the profile. This can be used to reference the geographical information maintained in another dataset." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-owning-entities" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:orgUnit": { + "@id": "https://data.adobe.io/org-apparals-men" + }, + "xdm:geoUnit": { + "@id": "https://data.adobe.io/geo-france" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-owning-entities.schema.md b/docs/reference/mixins/profile/profile-owning-entities.schema.md new file mode 100644 index 000000000..05a7beefa --- /dev/null +++ b/docs/reference/mixins/profile/profile-owning-entities.schema.md @@ -0,0 +1,77 @@ + +# Profile owning entity details Schema + +``` +https://ns.adobe.com/xdm/context/profile-owning-entities +``` + +This mixin is used to capture information regarding a particular organization or geographical unit to which the individual belongs. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/profile/profile-owning-entities.schema.json](mixins/profile/profile-owning-entities.schema.json) | +## Schema Hierarchy + +* Profile owning entity details `https://ns.adobe.com/xdm/context/profile-owning-entities` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Organizational unit](../../datatypes/orgunit.schema.md) `https://ns.adobe.com/xdm/common/orgunit` + * [Geographical unit](../../datatypes/geounit.schema.md) `https://ns.adobe.com/xdm/common/geounit` + + +## Profile owning entity details Example +```json +{ + "xdm:orgUnit": { + "@id": "https://data.adobe.io/org-apparals-men" + }, + "xdm:geoUnit": { + "@id": "https://data.adobe.io/geo-france" + } +} +``` + +# Profile owning entity details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:geoUnit](#xdmgeounit) | Geographical unit | Optional | Profile owning entity details (this schema) | +| [xdm:orgUnit](#xdmorgunit) | Organizational unit | Optional | Profile owning entity details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:geoUnit +### Geographical unit + +The geographical unit within the organization owning the profile. This can be used to reference the geographical information maintained in another dataset. + +`xdm:geoUnit` +* is optional +* type: Geographical unit +* defined in this schema + +### xdm:geoUnit Type + + +* [Geographical unit](../../datatypes/geounit.schema.md) – `https://ns.adobe.com/xdm/common/geounit` + + + + + +## xdm:orgUnit +### Organizational unit + +The unit within the organization owning the profile. This can be used to reference the organization details maintained in another dataset. + +`xdm:orgUnit` +* is optional +* type: Organizational unit +* defined in this schema + +### xdm:orgUnit Type + + +* [Organizational unit](../../datatypes/orgunit.schema.md) – `https://ns.adobe.com/xdm/common/orgunit` + + + + diff --git a/docs/reference/mixins/profile/profile-person-details.schema.json b/docs/reference/mixins/profile/profile-person-details.schema.json new file mode 100644 index 000000000..18b8317e7 --- /dev/null +++ b/docs/reference/mixins/profile/profile-person-details.schema.json @@ -0,0 +1,52 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-person-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile person details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "This mixin is used to capture information regarding name, gender, and birth date of an individual.", + "definitions": { + "profile-person-details": { + "properties": { + "xdm:person": { + "title": "Person", + "$ref": "https://ns.adobe.com/xdm/context/person", + "description": "An individual actor, contact, or owner." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-person-details" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:person": { + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDayAndMonth": "01-03", + "xdm:gender": "female" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-person-details.schema.md b/docs/reference/mixins/profile/profile-person-details.schema.md new file mode 100644 index 000000000..1929cfa5c --- /dev/null +++ b/docs/reference/mixins/profile/profile-person-details.schema.md @@ -0,0 +1,60 @@ + +# Profile person details Schema + +``` +https://ns.adobe.com/xdm/context/profile-person-details +``` + +This mixin is used to capture information regarding name, gender, and birth date of an individual. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/profile/profile-person-details.schema.json](mixins/profile/profile-person-details.schema.json) | +## Schema Hierarchy + +* Profile person details `https://ns.adobe.com/xdm/context/profile-person-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Person](../../datatypes/person.schema.md) `https://ns.adobe.com/xdm/context/person` + + +## Profile person details Example +```json +{ + "xdm:person": { + "xdm:name": { + "xdm:firstName": "Jane", + "xdm:middleName": "F", + "xdm:lastName": "Doe", + "xdm:fullName": "Jane F. Doe" + }, + "xdm:birthDayAndMonth": "01-03", + "xdm:gender": "female" + } +} +``` + +# Profile person details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:person](#xdmperson) | Person | Optional | Profile person details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:person +### Person + +An individual actor, contact, or owner. + +`xdm:person` +* is optional +* type: Person +* defined in this schema + +### xdm:person Type + + +* [Person](../../datatypes/person.schema.md) – `https://ns.adobe.com/xdm/context/person` + + + + diff --git a/docs/reference/mixins/profile/profile-personal-details.schema.json b/docs/reference/mixins/profile/profile-personal-details.schema.json new file mode 100644 index 000000000..1b2690840 --- /dev/null +++ b/docs/reference/mixins/profile/profile-personal-details.schema.json @@ -0,0 +1,67 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-personal-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile personal details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "This mixin is used to capture information regarding home address, home phone, mobile phone, fax, and personal email.", + "definitions": { + "profile-personal-details": { + "properties": { + "xdm:homeAddress": { + "title": "Home address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "A home postal address." + }, + "xdm:personalEmail": { + "title": "Personal email", + "$ref": "https://ns.adobe.com/xdm/context/emailaddress", + "description": "A personal email address." + }, + "xdm:homePhone": { + "title": "Home phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Home phone number." + }, + "xdm:mobilePhone": { + "title": "Mobile phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Mobile phone number." + }, + "xdm:faxPhone": { + "title": "Fax phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Fax phone number." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-personal-details" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:mobilePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-personal-details.schema.md b/docs/reference/mixins/profile/profile-personal-details.schema.md new file mode 100644 index 000000000..0b9b96187 --- /dev/null +++ b/docs/reference/mixins/profile/profile-personal-details.schema.md @@ -0,0 +1,137 @@ + +# Profile personal details Schema + +``` +https://ns.adobe.com/xdm/context/profile-personal-details +``` + +This mixin is used to capture information regarding home address, home phone, mobile phone, fax, and personal email. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/profile/profile-personal-details.schema.json](mixins/profile/profile-personal-details.schema.json) | +## Schema Hierarchy + +* Profile personal details `https://ns.adobe.com/xdm/context/profile-personal-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Postal address](../../datatypes/address.schema.md) `https://ns.adobe.com/xdm/common/address` + * [Email address](../../datatypes/emailaddress.schema.md) `https://ns.adobe.com/xdm/context/emailaddress` + * [Phone number](../../datatypes/phonenumber.schema.md) `https://ns.adobe.com/xdm/context/phonenumber` + + +## Profile personal details Example +```json +{ + "xdm:mobilePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + } +} +``` + +# Profile personal details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:faxPhone](#xdmfaxphone) | Phone number | Optional | Profile personal details (this schema) | +| [xdm:homeAddress](#xdmhomeaddress) | Postal address | Optional | Profile personal details (this schema) | +| [xdm:homePhone](#xdmhomephone) | Phone number | Optional | Profile personal details (this schema) | +| [xdm:mobilePhone](#xdmmobilephone) | Phone number | Optional | Profile personal details (this schema) | +| [xdm:personalEmail](#xdmpersonalemail) | Email address | Optional | Profile personal details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:faxPhone +### Fax phone + +Fax phone number. + +`xdm:faxPhone` +* is optional +* type: Phone number +* defined in this schema + +### xdm:faxPhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:homeAddress +### Home address + +A home postal address. + +`xdm:homeAddress` +* is optional +* type: Postal address +* defined in this schema + +### xdm:homeAddress Type + + +* [Postal address](../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + +## xdm:homePhone +### Home phone + +Home phone number. + +`xdm:homePhone` +* is optional +* type: Phone number +* defined in this schema + +### xdm:homePhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:mobilePhone +### Mobile phone + +Mobile phone number. + +`xdm:mobilePhone` +* is optional +* type: Phone number +* defined in this schema + +### xdm:mobilePhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:personalEmail +### Personal email + +A personal email address. + +`xdm:personalEmail` +* is optional +* type: Email address +* defined in this schema + +### xdm:personalEmail Type + + +* [Email address](../../datatypes/emailaddress.schema.md) – `https://ns.adobe.com/xdm/context/emailaddress` + + + + diff --git a/docs/reference/mixins/profile/profile-phones.schema.json b/docs/reference/mixins/profile/profile-phones.schema.json new file mode 100644 index 000000000..085ccf81d --- /dev/null +++ b/docs/reference/mixins/profile/profile-phones.schema.json @@ -0,0 +1,77 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-phones", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile Phones", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "Contains the various phone numbers a single profile can contain", + "definitions": { + "profile-phones": { + "properties": { + "xdm:homePhone": { + "title": "Home Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Home phone number." + }, + "xdm:mobilePhone": { + "title": "Mobile Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Mobile phone number." + }, + "xdm:workPhone": { + "title": "Work Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Work phone number." + }, + "xdm:faxPhone": { + "title": "Fax Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Fax phone number." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-phones" + } + ], + "meta:status": "experimental", + "examples": [ + { + "xdm:homePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:mobilePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:workPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:faxPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-phones.schema.md b/docs/reference/mixins/profile/profile-phones.schema.md new file mode 100644 index 000000000..d7793a1c4 --- /dev/null +++ b/docs/reference/mixins/profile/profile-phones.schema.md @@ -0,0 +1,130 @@ + +# Profile Phones Schema + +``` +https://ns.adobe.com/xdm/context/profile-phones +``` + +Contains the various phone numbers a single profile can contain + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [mixins/profile/profile-phones.schema.json](mixins/profile/profile-phones.schema.json) | +## Schema Hierarchy + +* Profile Phones `https://ns.adobe.com/xdm/context/profile-phones` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Phone number](../../datatypes/phonenumber.schema.md) `https://ns.adobe.com/xdm/context/phonenumber` + + +## Profile Phones Example +```json +{ + "xdm:homePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:mobilePhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:workPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:faxPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + } +} +``` + +# Profile Phones Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:faxPhone](#xdmfaxphone) | Phone number | Optional | Profile Phones (this schema) | +| [xdm:homePhone](#xdmhomephone) | Phone number | Optional | Profile Phones (this schema) | +| [xdm:mobilePhone](#xdmmobilephone) | Phone number | Optional | Profile Phones (this schema) | +| [xdm:workPhone](#xdmworkphone) | Phone number | Optional | Profile Phones (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:faxPhone +### Fax Phone + +Fax phone number. + +`xdm:faxPhone` +* is optional +* type: Phone number +* defined in this schema + +### xdm:faxPhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:homePhone +### Home Phone + +Home phone number. + +`xdm:homePhone` +* is optional +* type: Phone number +* defined in this schema + +### xdm:homePhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:mobilePhone +### Mobile Phone + +Mobile phone number. + +`xdm:mobilePhone` +* is optional +* type: Phone number +* defined in this schema + +### xdm:mobilePhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + + +## xdm:workPhone +### Work Phone + +Work phone number. + +`xdm:workPhone` +* is optional +* type: Phone number +* defined in this schema + +### xdm:workPhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + diff --git a/docs/reference/mixins/profile/profile-preferences-details.schema.json b/docs/reference/mixins/profile/profile-preferences-details.schema.json new file mode 100644 index 000000000..a334fe947 --- /dev/null +++ b/docs/reference/mixins/profile/profile-preferences-details.schema.json @@ -0,0 +1,86 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-preferences-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile preferences details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "This mixin is used to capture information regarding individual preferences in the profile, such as time zone, preferred language, and email format (rich text or plain text).", + "definitions": { + "profile-preferences-details": { + "properties": { + "xdm:preferredLanguage": { + "title": "Preferred language", + "type": "string", + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "examples": [ + "en-GB", + "de-DE", + "yue-HK" + ], + "description": "Describes the preferred system of communication used by the profile. Language codes are expressed in BCP 47 format." + }, + "xdm:profilePictureLink": { + "title": "Profile picture link", + "type": "string", + "description": "Link to profile's picture." + }, + "xdm:emailFormat": { + "title": "Email format", + "type": "string", + "description": "Email format preferred by the profile. This can be rich text or plain text.", + "meta:enum": { + "html": "Rich text", + "plaintext": "Plain text" + } + }, + "xdm:timeZone": { + "title": "Time zone", + "type": "string", + "examples": [ + "America/Barbados", + "Antarctica/Davis", + "Asia/Calcutta" + ], + "description": "Describes which time zone the profile is present in, most frequently the time zone preferred by the profile. Time zones are expressed according to the IETF tz database: https://www.ietf.org/timezones/tzdb-2016i/tz-link.htm" + }, + "xdm:optInOut": { + "title": "OptInOut", + "$ref": "https://ns.adobe.com/xdm/context/optinout", + "description": "Describes a users opting in and out preferences for communication by medium and communication type." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-preferences-details" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:optInOut": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-preferences-details.schema.md b/docs/reference/mixins/profile/profile-preferences-details.schema.md new file mode 100644 index 000000000..908f79ba3 --- /dev/null +++ b/docs/reference/mixins/profile/profile-preferences-details.schema.md @@ -0,0 +1,188 @@ + +# Profile preferences details Schema + +``` +https://ns.adobe.com/xdm/context/profile-preferences-details +``` + +This mixin is used to capture information regarding individual preferences in the profile, such as time zone, preferred language, and email format (rich text or plain text). + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/profile/profile-preferences-details.schema.json](mixins/profile/profile-preferences-details.schema.json) | +## Schema Hierarchy + +* Profile preferences details `https://ns.adobe.com/xdm/context/profile-preferences-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [OptInOut](../../datatypes/optinout.schema.md) `https://ns.adobe.com/xdm/context/optinout` + + +## Profile preferences details Example +```json +{ + "xdm:optInOut": { + "https://ns.adobe.com/xdm/channels/email": "pending", + "https://ns.adobe.com/xdm/channels/phone": "out", + "https://ns.adobe.com/xdm/channels/sms": "in", + "https://ns.adobe.com/xdm/channels/fax": "not_provided", + "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", + "https://ns.adobe.com/xdm/channels/apns": "not_provided", + "xdm:globalOptout": false + } +} +``` + +# Profile preferences details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:emailFormat](#xdmemailformat) | `string` | Optional | Profile preferences details (this schema) | +| [xdm:optInOut](#xdmoptinout) | OptInOut | Optional | Profile preferences details (this schema) | +| [xdm:preferredLanguage](#xdmpreferredlanguage) | `string` | Optional | Profile preferences details (this schema) | +| [xdm:profilePictureLink](#xdmprofilepicturelink) | `string` | Optional | Profile preferences details (this schema) | +| [xdm:timeZone](#xdmtimezone) | `string` | Optional | Profile preferences details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:emailFormat +### Email format + +Email format preferred by the profile. This can be rich text or plain text. + +`xdm:emailFormat` +* is optional +* type: `string` +* defined in this schema + +### xdm:emailFormat Type + + +`string` + + + +### xdm:emailFormat Known Values +| Value | Description | +|-------|-------------| +| `html` | Rich text | +| `plaintext` | Plain text | + + + + +## xdm:optInOut +### OptInOut + +Describes a users opting in and out preferences for communication by medium and communication type. + +`xdm:optInOut` +* is optional +* type: OptInOut +* defined in this schema + +### xdm:optInOut Type + + +* [OptInOut](../../datatypes/optinout.schema.md) – `https://ns.adobe.com/xdm/context/optinout` + + + + + +## xdm:preferredLanguage +### Preferred language + +Describes the preferred system of communication used by the profile. Language codes are expressed in BCP 47 format. + +`xdm:preferredLanguage` +* is optional +* type: `string` +* defined in this schema + +### xdm:preferredLanguage Type + + +`string` + + +All instances must conform to this regular expression +```regex +^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$ +``` + +* test example: [en-GB](https://regexr.com/?expression=%5E((((%5BA-Za-z%5D%7B2%2C3%7D(-(%5BA-Za-z%5D%7B3%7D(-%5BA-Za-z%5D%7B3%7D)%7B0%2C2%7D))%3F)%7C%5BA-Za-z%5D%7B4%7D%7C%5BA-Za-z%5D%7B5%2C8%7D)(-(%5BA-Za-z%5D%7B4%7D))%3F(-(%5BA-Za-z%5D%7B2%7D%7C%5B0-9%5D%7B3%7D))%3F(-(%5BA-Za-z0-9%5D%7B5%2C8%7D%7C%5B0-9%5D%5BA-Za-z0-9%5D%7B3%7D))*(-(%5B0-9A-WY-Za-wy-z%5D(-%5BA-Za-z0-9%5D%7B2%2C8%7D)%2B))*(-(x(-%5BA-Za-z0-9%5D%7B1%2C8%7D)%2B))%3F)%7C(x(-%5BA-Za-z0-9%5D%7B1%2C8%7D)%2B)%7C((en-GB-oed%7Ci-ami%7Ci-bnn%7Ci-default%7Ci-enochian%7Ci-hak%7Ci-klingon%7Ci-lux%7Ci-mingo%7Ci-navajo%7Ci-pwn%7Ci-tao%7Ci-tay%7Ci-tsu%7Csgn-BE-FR%7Csgn-BE-NL%7Csgn-CH-DE)%7C(art-lojban%7Ccel-gaulish%7Cno-bok%7Cno-nyn%7Czh-guoyu%7Czh-hakka%7Czh-min%7Czh-min-nan%7Czh-xiang)))%24&text=en-GB) +* test example: [de-DE](https://regexr.com/?expression=%5E((((%5BA-Za-z%5D%7B2%2C3%7D(-(%5BA-Za-z%5D%7B3%7D(-%5BA-Za-z%5D%7B3%7D)%7B0%2C2%7D))%3F)%7C%5BA-Za-z%5D%7B4%7D%7C%5BA-Za-z%5D%7B5%2C8%7D)(-(%5BA-Za-z%5D%7B4%7D))%3F(-(%5BA-Za-z%5D%7B2%7D%7C%5B0-9%5D%7B3%7D))%3F(-(%5BA-Za-z0-9%5D%7B5%2C8%7D%7C%5B0-9%5D%5BA-Za-z0-9%5D%7B3%7D))*(-(%5B0-9A-WY-Za-wy-z%5D(-%5BA-Za-z0-9%5D%7B2%2C8%7D)%2B))*(-(x(-%5BA-Za-z0-9%5D%7B1%2C8%7D)%2B))%3F)%7C(x(-%5BA-Za-z0-9%5D%7B1%2C8%7D)%2B)%7C((en-GB-oed%7Ci-ami%7Ci-bnn%7Ci-default%7Ci-enochian%7Ci-hak%7Ci-klingon%7Ci-lux%7Ci-mingo%7Ci-navajo%7Ci-pwn%7Ci-tao%7Ci-tay%7Ci-tsu%7Csgn-BE-FR%7Csgn-BE-NL%7Csgn-CH-DE)%7C(art-lojban%7Ccel-gaulish%7Cno-bok%7Cno-nyn%7Czh-guoyu%7Czh-hakka%7Czh-min%7Czh-min-nan%7Czh-xiang)))%24&text=de-DE) +* test example: [yue-HK](https://regexr.com/?expression=%5E((((%5BA-Za-z%5D%7B2%2C3%7D(-(%5BA-Za-z%5D%7B3%7D(-%5BA-Za-z%5D%7B3%7D)%7B0%2C2%7D))%3F)%7C%5BA-Za-z%5D%7B4%7D%7C%5BA-Za-z%5D%7B5%2C8%7D)(-(%5BA-Za-z%5D%7B4%7D))%3F(-(%5BA-Za-z%5D%7B2%7D%7C%5B0-9%5D%7B3%7D))%3F(-(%5BA-Za-z0-9%5D%7B5%2C8%7D%7C%5B0-9%5D%5BA-Za-z0-9%5D%7B3%7D))*(-(%5B0-9A-WY-Za-wy-z%5D(-%5BA-Za-z0-9%5D%7B2%2C8%7D)%2B))*(-(x(-%5BA-Za-z0-9%5D%7B1%2C8%7D)%2B))%3F)%7C(x(-%5BA-Za-z0-9%5D%7B1%2C8%7D)%2B)%7C((en-GB-oed%7Ci-ami%7Ci-bnn%7Ci-default%7Ci-enochian%7Ci-hak%7Ci-klingon%7Ci-lux%7Ci-mingo%7Ci-navajo%7Ci-pwn%7Ci-tao%7Ci-tay%7Ci-tsu%7Csgn-BE-FR%7Csgn-BE-NL%7Csgn-CH-DE)%7C(art-lojban%7Ccel-gaulish%7Cno-bok%7Cno-nyn%7Czh-guoyu%7Czh-hakka%7Czh-min%7Czh-min-nan%7Czh-xiang)))%24&text=yue-HK) + + + + +### xdm:preferredLanguage Examples + +```json +"en-GB" +``` + +```json +"de-DE" +``` + +```json +"yue-HK" +``` + + + +## xdm:profilePictureLink +### Profile picture link + +Link to profile's picture. + +`xdm:profilePictureLink` +* is optional +* type: `string` +* defined in this schema + +### xdm:profilePictureLink Type + + +`string` + + + + + + +## xdm:timeZone +### Time zone + +Describes which time zone the profile is present in, most frequently the time zone preferred by the profile. Time zones are expressed according to the IETF tz database: https://www.ietf.org/timezones/tzdb-2016i/tz-link.htm + +`xdm:timeZone` +* is optional +* type: `string` +* defined in this schema + +### xdm:timeZone Type + + +`string` + + + + + +### xdm:timeZone Examples + +```json +"America/Barbados" +``` + +```json +"Antarctica/Davis" +``` + +```json +"Asia/Calcutta" +``` + + diff --git a/docs/reference/mixins/profile/profile-privacy.schema.json b/docs/reference/mixins/profile/profile-privacy.schema.json new file mode 100644 index 000000000..93f02b7cc --- /dev/null +++ b/docs/reference/mixins/profile/profile-privacy.schema.json @@ -0,0 +1,153 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-privacy", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile privacy", + "description": "Profile privacy schema captures general and sales sharing opt-out signals.", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "definitions": { + "profile-privacy": { + "properties": { + "xdm:optOutConsentLevel": { + "type": "object", + "title": "Opt-out consent level", + "description": "Opt-out consent level.", + "properties": { + "xdm:privacyOptOuts": { + "title": "Privacy opt-outs", + "description": "Encapsulates different opt-out types for data privacy.", + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:optOutType": { + "title": "Opt-out type", + "type": "string", + "description": "The type of opt-out.", + "enum": [ + "general_opt_out", + "sales_sharing_opt_out" + ], + "meta:enum": { + "general_opt_out": "General opt-out", + "sales_sharing_opt_out": "Sales sharing opt-out" + } + }, + "xdm:optOutValue": { + "title": "Opt-out value", + "type": "string", + "description": "The value of opt-out signal.", + "enum": [ + "not_provided", + "pending", + "in", + "out" + ], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in", + "out": "Opt-out" + } + }, + "xdm:timestamp": { + "title": "Opt-out timestamp", + "description": "Timestamp of the received opt-out signal.", + "type": "string", + "format": "date-time" + } + } + } + } + } + }, + "xdm:identityPrivacyInfo": { + "title": "Identity level privacy information", + "description": "Captured privacy information for identities in profile.", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "title": "User namespace", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "type": "object", + "title": "User Identity", + "properties": { + "xdm:identityIABConsent": { + "type": "object", + "title": "Identity level consent information", + "description": "Consent collected for an identity via consent management services.", + "properties": { + "xdm:consentTimestamp": { + "title": "Timestamp of consent", + "description": "Timestamp (RFC3339) when this identity presented consent information", + "type": "string", + "format": "date-time" + }, + "xdm:consentString": { + "title": "Captured consent information", + "description": "Consent string and its specification. This can help reading application to use appropriate library.", + "$ref": "https://ns.adobe.com/xdm/context/consentstring" + } + }, + "required": [ + "xdm:consentTimestamp" + ] + } + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-privacy" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:optOutConsentLevel": { + "xdm:privacyOptOuts": [ + { + "xdm:optOutType": "general_opt_out", + "xdm:optOutValue": "out", + "xdm:timestamp": "2019-01-01T15:52:25+00:00" + } + ] + }, + "xdm:identityPrivacyInfo": { + "ECID": { + "11112222233333444": { + "xdm:identityIABConsent": { + "xdm:consentTimestamp": "2020-04-11T05:05:05Z", + "xdm:consentString": { + "xdm:consentStandard": "IAB TCF", + "xdm:consentStandardVersion": "2.0", + "xdm:consentStringValue": "BObdrPUOevsguAfDqFENCNAAAAAmeAAA.PVAfDObdrA.DqFENCAmeAENCDA", + "xdm:gdprApplies": true, + "xdm:containsPersonalData": false + } + } + } + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-privacy.schema.md b/docs/reference/mixins/profile/profile-privacy.schema.md new file mode 100644 index 000000000..cec1484df --- /dev/null +++ b/docs/reference/mixins/profile/profile-privacy.schema.md @@ -0,0 +1,207 @@ + +# Profile privacy Schema + +``` +https://ns.adobe.com/xdm/context/profile-privacy +``` + +Profile privacy schema captures general and sales sharing opt-out signals. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/profile/profile-privacy.schema.json](mixins/profile/profile-privacy.schema.json) | +## Schema Hierarchy + +* Profile privacy `https://ns.adobe.com/xdm/context/profile-privacy` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Profile privacy Example +```json +{ + "xdm:optOutConsentLevel": { + "xdm:privacyOptOuts": [ + { + "xdm:optOutType": "general_opt_out", + "xdm:optOutValue": "out", + "xdm:timestamp": "2019-01-01T15:52:25+00:00" + } + ] + }, + "xdm:identityPrivacyInfo": { + "ECID": { + "11112222233333444": { + "xdm:identityIABConsent": { + "xdm:consentTimestamp": "2020-04-11T05:05:05Z", + "xdm:consentString": { + "xdm:consentStandard": "IAB TCF", + "xdm:consentStandardVersion": "2.0", + "xdm:consentStringValue": "BObdrPUOevsguAfDqFENCNAAAAAmeAAA.PVAfDObdrA.DqFENCAmeAENCDA", + "xdm:gdprApplies": true, + "xdm:containsPersonalData": false + } + } + } + } + } +} +``` + +# Profile privacy Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:identityPrivacyInfo](#xdmidentityprivacyinfo) | `object` | Optional | Profile privacy (this schema) | +| [xdm:optOutConsentLevel](#xdmoptoutconsentlevel) | `object` | Optional | Profile privacy (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:identityPrivacyInfo +### Identity level privacy information + +Captured privacy information for identities in profile. + +`xdm:identityPrivacyInfo` +* is optional +* type: `object` +* defined in this schema + +### xdm:identityPrivacyInfo Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:optOutConsentLevel +### Opt-out consent level + +Opt-out consent level. + +`xdm:optOutConsentLevel` +* is optional +* type: `object` +* defined in this schema + +### xdm:optOutConsentLevel Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:privacyOptOuts`| array | Optional | + + + +#### xdm:privacyOptOuts +##### Privacy opt-outs + +Encapsulates different opt-out types for data privacy. + +`xdm:privacyOptOuts` +* is optional +* type: `object[]` + + +##### xdm:privacyOptOuts Type + + +Array type: `object[]` + +All items must be of the type: +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:optOutType`| string | Optional | +| `xdm:optOutValue`| string | Optional | +| `xdm:timestamp`| string | Optional | + + + +#### xdm:optOutType +##### Opt-out type + +The type of opt-out. + +`xdm:optOutType` +* is optional +* type: `enum` + +The value of this property **must** be equal to one of the [known values below](#xdmoptoutconsentlevel-known-values). + +##### xdm:optOutType Known Values +| Value | Description | +|-------|-------------| +| `general_opt_out` | General opt-out | +| `sales_sharing_opt_out` | Sales sharing opt-out | + + + + + + +#### xdm:optOutValue +##### Opt-out value + +The value of opt-out signal. + +`xdm:optOutValue` +* is optional +* type: `enum` + +The value of this property **must** be equal to one of the [known values below](#xdmoptoutconsentlevel-known-values). + +##### xdm:optOutValue Known Values +| Value | Description | +|-------|-------------| +| `not_provided` | Not provided | +| `pending` | Pending verification | +| `in` | Opt-in | +| `out` | Opt-out | + + + + + + +#### xdm:timestamp +##### Opt-out timestamp + +Timestamp of the received opt-out signal. + +`xdm:timestamp` +* is optional +* type: `string` + +##### xdm:timestamp Type + + +`string` +* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) + + + + + + + + + + + + + + + + + diff --git a/docs/reference/mixins/profile/profile-push-details.schema.json b/docs/reference/mixins/profile/profile-push-details.schema.json new file mode 100644 index 000000000..73a34efaf --- /dev/null +++ b/docs/reference/mixins/profile/profile-push-details.schema.json @@ -0,0 +1,89 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-push-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile push details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "This mixin is used to capture information regarding push notifications including device details and registration date. Push addressing details are used to communicate with applications that are installed on devices or SaaS application accounts.", + "definitions": { + "profile-push-details": { + "properties": { + "xdm:pushNotificationTokens": { + "title": "Push notification tokens", + "type": "array", + "description": "Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts.", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/pushnotificationtoken" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-push-details" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:pushNotificationTokens": [ + { + "xdm:token": "ABC123DEFG", + "xdm:registrationDate": "2017-09-26T15:52:25+00:00", + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 600, + "xdm:viewportWidth": 300 + }, + "xdm:operatingSystem": "iOS", + "xdm:operatingSystemVersion": "11.2.1", + "xdm:connectionType": "mobile" + }, + "xdm:device": { + "xdm:typeId": "TypeIdentifier-111", + "xdm:typeIdService": "deviceAtlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216 + }, + "xdm:application": { + "xdm:id": "Abc123", + "xdm:name": "facebook", + "xdm:version": "153.0" + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/facebook-feed", + "@type": "https://ns.adobe.com/xdm/channel-types/social" + } + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-push-details.schema.md b/docs/reference/mixins/profile/profile-push-details.schema.md new file mode 100644 index 000000000..1b6d0e9e3 --- /dev/null +++ b/docs/reference/mixins/profile/profile-push-details.schema.md @@ -0,0 +1,100 @@ + +# Profile push details Schema + +``` +https://ns.adobe.com/xdm/context/profile-push-details +``` + +This mixin is used to capture information regarding push notifications including device details and registration date. Push addressing details are used to communicate with applications that are installed on devices or SaaS application accounts. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/profile/profile-push-details.schema.json](mixins/profile/profile-push-details.schema.json) | +## Schema Hierarchy + +* Profile push details `https://ns.adobe.com/xdm/context/profile-push-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Profile push details Example +```json +{ + "xdm:pushNotificationTokens": [ + { + "xdm:token": "ABC123DEFG", + "xdm:registrationDate": "2017-09-26T15:52:25+00:00", + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 600, + "xdm:viewportWidth": 300 + }, + "xdm:operatingSystem": "iOS", + "xdm:operatingSystemVersion": "11.2.1", + "xdm:connectionType": "mobile" + }, + "xdm:device": { + "xdm:typeId": "TypeIdentifier-111", + "xdm:typeIdService": "deviceAtlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216 + }, + "xdm:application": { + "xdm:id": "Abc123", + "xdm:name": "facebook", + "xdm:version": "153.0" + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/facebook-feed", + "@type": "https://ns.adobe.com/xdm/channel-types/social" + } + } + ] +} +``` + +# Profile push details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:pushNotificationTokens](#xdmpushnotificationtokens) | Push notification token | Optional | Profile push details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:pushNotificationTokens +### Push notification tokens + +Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts. + +`xdm:pushNotificationTokens` +* is optional +* type: Push notification token + +* defined in this schema + +### xdm:pushNotificationTokens Type + + +Array type: Push notification token + +All items must be of the type: +* [Push notification token](../../datatypes/pushnotificationtoken.schema.md) – `https://ns.adobe.com/xdm/context/pushnotificationtoken` + + + + + + + diff --git a/docs/reference/mixins/profile/profile-push-notification-details.schema.json b/docs/reference/mixins/profile/profile-push-notification-details.schema.json new file mode 100644 index 000000000..629e284f5 --- /dev/null +++ b/docs/reference/mixins/profile/profile-push-notification-details.schema.json @@ -0,0 +1,59 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-push-notification-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Push notification details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "This mixin is used to capture information regarding push notifications including mobile application and device details.", + "definitions": { + "profile-push-notification-details": { + "properties": { + "xdm:pushNotificationDetails": { + "title": "Push details", + "type": "array", + "description": "Push details array containing notification info required to send mobile push notification to a specific mobile application on a given device.", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/pushdetail" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-push-notification-details" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:pushNotificationDetails": [ + { + "xdm:appID": "75eafb7e-fa44-4514-86fc-221e32c5aef9", + "xdm:token": "99156313-c9df-4e54-9c6c-5740f940c3ca", + "xdm:platform": "apns", + "xdm:blocklisted": false, + "xdm:identity": { + "xdm:namespace": { + "xdm:code": "ECID" + }, + "xdm:xid": "92312748749128" + } + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-push-notification-details.schema.md b/docs/reference/mixins/profile/profile-push-notification-details.schema.md new file mode 100644 index 000000000..76c8079fb --- /dev/null +++ b/docs/reference/mixins/profile/profile-push-notification-details.schema.md @@ -0,0 +1,70 @@ + +# Push notification details Schema + +``` +https://ns.adobe.com/xdm/context/profile-push-notification-details +``` + +This mixin is used to capture information regarding push notifications including mobile application and device details. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/profile/profile-push-notification-details.schema.json](mixins/profile/profile-push-notification-details.schema.json) | +## Schema Hierarchy + +* Push notification details `https://ns.adobe.com/xdm/context/profile-push-notification-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Push notification details Example +```json +{ + "xdm:pushNotificationDetails": [ + { + "xdm:appID": "75eafb7e-fa44-4514-86fc-221e32c5aef9", + "xdm:token": "99156313-c9df-4e54-9c6c-5740f940c3ca", + "xdm:platform": "apns", + "xdm:blocklisted": false, + "xdm:identity": { + "xdm:namespace": { + "xdm:code": "ECID" + }, + "xdm:xid": "92312748749128" + } + } + ] +} +``` + +# Push notification details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:pushNotificationDetails](#xdmpushnotificationdetails) | Push notification detail | Optional | Push notification details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:pushNotificationDetails +### Push details + +Push details array containing notification info required to send mobile push notification to a specific mobile application on a given device. + +`xdm:pushNotificationDetails` +* is optional +* type: Push notification detail + +* defined in this schema + +### xdm:pushNotificationDetails Type + + +Array type: Push notification detail + +All items must be of the type: +* [Push notification detail](../../datatypes/pushdetail.schema.md) – `https://ns.adobe.com/xdm/context/pushdetail` + + + + + + + diff --git a/docs/reference/mixins/profile/profile-segmentation.schema.json b/docs/reference/mixins/profile/profile-segmentation.schema.json new file mode 100644 index 000000000..1ca4d950b --- /dev/null +++ b/docs/reference/mixins/profile/profile-segmentation.schema.json @@ -0,0 +1,82 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-segmentation", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile segmentation", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "This mixin is used to capture information regarding segment membership, including which segments the individual belongs to, the last qualification time, and when the membership is valid until.", + "definitions": { + "profile-segmentation": { + "properties": { + "xdm:segments": { + "title": "Segment membership", + "meta:status": "deprecated", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/segmentmembership" + } + }, + "xdm:segmentMembership": { + "title": "Segment membership map", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "title": "Segment membership per namespace", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "$ref": "https://ns.adobe.com/xdm/context/segmentmembership" + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-segmentation" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:segmentMembership": { + "AAM": { + "04a81716-43d6-4e7a-a49c-f1d8b3129ba9": { + "xdm:version": "15", + "xdm:timestamp": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2019-04-26T15:52:25+00:00", + "xdm:status": "existing" + }, + "53cba6b2-a23b-454a-8069-fc41308f1c0f": { + "xdm:version": "3", + "xdm:lastQualificationTime": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2018-04-27T15:52:25+00:00", + "xdm:status": "realized" + } + }, + "Email": { + "abcd@adobe.com": { + "xdm:version": "1", + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "exited" + } + } + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-segmentation.schema.md b/docs/reference/mixins/profile/profile-segmentation.schema.md new file mode 100644 index 000000000..a3b63f022 --- /dev/null +++ b/docs/reference/mixins/profile/profile-segmentation.schema.md @@ -0,0 +1,101 @@ + +# Profile segmentation Schema + +``` +https://ns.adobe.com/xdm/context/profile-segmentation +``` + +This mixin is used to capture information regarding segment membership, including which segments the individual belongs to, the last qualification time, and when the membership is valid until. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/profile/profile-segmentation.schema.json](mixins/profile/profile-segmentation.schema.json) | +## Schema Hierarchy + +* Profile segmentation `https://ns.adobe.com/xdm/context/profile-segmentation` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Profile segmentation Example +```json +{ + "xdm:segmentMembership": { + "AAM": { + "04a81716-43d6-4e7a-a49c-f1d8b3129ba9": { + "xdm:version": "15", + "xdm:timestamp": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2019-04-26T15:52:25+00:00", + "xdm:status": "existing" + }, + "53cba6b2-a23b-454a-8069-fc41308f1c0f": { + "xdm:version": "3", + "xdm:lastQualificationTime": "2018-04-26T15:52:25+00:00", + "xdm:validUntil": "2018-04-27T15:52:25+00:00", + "xdm:status": "realized" + } + }, + "Email": { + "abcd@adobe.com": { + "xdm:version": "1", + "xdm:lastQualificationTime": "2017-09-26T15:52:25+00:00", + "xdm:validUntil": "2017-12-26T15:52:25+00:00", + "xdm:status": "exited" + } + } + } +} +``` + +# Profile segmentation Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:segmentMembership](#xdmsegmentmembership) | `object` | Optional | Profile segmentation (this schema) | +| [xdm:segments](#xdmsegments) | Segment membership | Optional | Profile segmentation (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:segmentMembership +### Segment membership map + +`xdm:segmentMembership` +* is optional +* type: `object` +* defined in this schema + +### xdm:segmentMembership Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + + +## xdm:segments +### Segment membership + +`xdm:segments` +* is optional +* type: Segment membership + +* defined in this schema + +### xdm:segments Type + + +Array type: Segment membership + +All items must be of the type: +* [Segment membership](../../datatypes/segmentmembership.schema.md) – `https://ns.adobe.com/xdm/context/segmentmembership` + + + + + + + diff --git a/docs/reference/mixins/profile/profile-subscriptions.schema.json b/docs/reference/mixins/profile/profile-subscriptions.schema.json new file mode 100644 index 000000000..933dfa23e --- /dev/null +++ b/docs/reference/mixins/profile/profile-subscriptions.schema.json @@ -0,0 +1,83 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-subscriptions", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile subscriptions", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "This mixin is used to capture information regarding an individual's subscriptions, such as the billing period, contract ID, start date, and end date. Profile subscriptions include commercial or licensed services, and entitlements.", + "definitions": { + "profile-subscriptions": { + "properties": { + "xdm:subscriptions": { + "title": "Subscriptions", + "type": "array", + "description": "Subscriptions that the profile is entitled to including terminated, expired, or exhausted subscriptions.", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/subscription" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-subscriptions" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:subscriptions": [ + { + "@id": "https://data.adobe.io/subscriptionid-123", + "xdm:subscriber": { + "xdm:firstName": "John", + "xdm:lastName": "Smith", + "xdm:courtesyTitle": "Mr.", + "xdm:birthDay": 1, + "xdm:birthMonth": 1, + "xdm:birthYear": 2000, + "xdm:gender": "male" + }, + "xdm:device": { + "xdm:typeId": "TypeIdentifier-111", + "xdm:typeIdService": "deviceAtlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216 + }, + "xdm:SKU": "12345678", + "xdm:planName": "PS+ 12 Month Membership", + "xdm:country": "USA", + "xdm:startDate": "2001-01-01", + "xdm:endDate": "2002-01-01", + "xdm:term": 12, + "xdm:termUnitOfTime": "Month", + "xdm:status": "active", + "xdm:contractId": "contractid-123", + "xdm:paymentMethod": "creditCard", + "xdm:billingPeriod": "Month", + "xdm:billingStartDate": "2001-01-01", + "xdm:paymentStatus": "paid" + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-subscriptions.schema.md b/docs/reference/mixins/profile/profile-subscriptions.schema.md new file mode 100644 index 000000000..21cd640b7 --- /dev/null +++ b/docs/reference/mixins/profile/profile-subscriptions.schema.md @@ -0,0 +1,94 @@ + +# Profile subscriptions Schema + +``` +https://ns.adobe.com/xdm/context/profile-subscriptions +``` + +This mixin is used to capture information regarding an individual's subscriptions, such as the billing period, contract ID, start date, and end date. Profile subscriptions include commercial or licensed services, and entitlements. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/profile/profile-subscriptions.schema.json](mixins/profile/profile-subscriptions.schema.json) | +## Schema Hierarchy + +* Profile subscriptions `https://ns.adobe.com/xdm/context/profile-subscriptions` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Profile subscriptions Example +```json +{ + "xdm:subscriptions": [ + { + "@id": "https://data.adobe.io/subscriptionid-123", + "xdm:subscriber": { + "xdm:firstName": "John", + "xdm:lastName": "Smith", + "xdm:courtesyTitle": "Mr.", + "xdm:birthDay": 1, + "xdm:birthMonth": 1, + "xdm:birthYear": 2000, + "xdm:gender": "male" + }, + "xdm:device": { + "xdm:typeId": "TypeIdentifier-111", + "xdm:typeIdService": "deviceAtlas", + "xdm:type": "mobile", + "xdm:manufacturer": "Apple", + "xdm:model": "iPhone 6", + "xdm:modelNumber": "A1586", + "xdm:screenHeight": 667, + "xdm:screenWidth": 375, + "xdm:colorDepth": 16777216 + }, + "xdm:SKU": "12345678", + "xdm:planName": "PS+ 12 Month Membership", + "xdm:country": "USA", + "xdm:startDate": "2001-01-01", + "xdm:endDate": "2002-01-01", + "xdm:term": 12, + "xdm:termUnitOfTime": "Month", + "xdm:status": "active", + "xdm:contractId": "contractid-123", + "xdm:paymentMethod": "creditCard", + "xdm:billingPeriod": "Month", + "xdm:billingStartDate": "2001-01-01", + "xdm:paymentStatus": "paid" + } + ] +} +``` + +# Profile subscriptions Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:subscriptions](#xdmsubscriptions) | Subscription | Optional | Profile subscriptions (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:subscriptions +### Subscriptions + +Subscriptions that the profile is entitled to including terminated, expired, or exhausted subscriptions. + +`xdm:subscriptions` +* is optional +* type: Subscription + +* defined in this schema + +### xdm:subscriptions Type + + +Array type: Subscription + +All items must be of the type: +* [Subscription](../../datatypes/subscription.schema.md) – `https://ns.adobe.com/xdm/context/subscription` + + + + + + + diff --git a/docs/reference/mixins/profile/profile-test-profile.schema.json b/docs/reference/mixins/profile/profile-test-profile.schema.json new file mode 100644 index 000000000..b4265d7b2 --- /dev/null +++ b/docs/reference/mixins/profile/profile-test-profile.schema.json @@ -0,0 +1,44 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-test-profile", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile test details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "This mixin is used for indicating that the profile record is in use for testing/verification purposes and should not be automatically included in normal operations.", + "definitions": { + "profile-test-profile": { + "properties": { + "xdm:testProfile": { + "title": "Test profile", + "type": "boolean", + "description": "Indicates the `profile` record is for use in testing and verification purposes and should not be automatically included in normal operations.", + "default": false + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-test-profile" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:testProfile": false + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-test-profile.schema.md b/docs/reference/mixins/profile/profile-test-profile.schema.md new file mode 100644 index 000000000..ac88591ee --- /dev/null +++ b/docs/reference/mixins/profile/profile-test-profile.schema.md @@ -0,0 +1,51 @@ + +# Profile test details Schema + +``` +https://ns.adobe.com/xdm/context/profile-test-profile +``` + +This mixin is used for indicating that the profile record is in use for testing/verification purposes and should not be automatically included in normal operations. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/profile/profile-test-profile.schema.json](mixins/profile/profile-test-profile.schema.json) | +## Schema Hierarchy + +* Profile test details `https://ns.adobe.com/xdm/context/profile-test-profile` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Profile test details Example +```json +{ + "xdm:testProfile": false +} +``` + +# Profile test details Properties + +| Property | Type | Required | Default | Defined by | +|----------|------|----------|---------|------------| +| [xdm:testProfile](#xdmtestprofile) | `boolean` | Optional | `false` | Profile test details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:testProfile +### Test profile + +Indicates the `profile` record is for use in testing and verification purposes and should not be automatically included in normal operations. + +`xdm:testProfile` +* is optional +* type: `boolean` +* default: `false` +* defined in this schema + +### xdm:testProfile Type + + +`boolean` + + + + diff --git a/docs/reference/mixins/profile/profile-work-details.schema.json b/docs/reference/mixins/profile/profile-work-details.schema.json new file mode 100644 index 000000000..f80425118 --- /dev/null +++ b/docs/reference/mixins/profile/profile-work-details.schema.json @@ -0,0 +1,104 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-work-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile work details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "This mixin is used to capture information regarding work-related details of the individual such as work address, work email, work phone number, and organizations to which the profile belongs.", + "definitions": { + "profile-work-details": { + "properties": { + "xdm:workAddress": { + "title": "Work Address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "A work postal address." + }, + "xdm:workEmail": { + "title": "Work Email", + "$ref": "https://ns.adobe.com/xdm/context/emailaddress", + "description": "A work email address." + }, + "xdm:workPhone": { + "title": "Work Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Work phone number." + }, + "xdm:organizations": { + "title": "Organizations", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-work-details" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:workAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "xdm:workEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active" + }, + "xdm:workPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:assistantDetails": { + "xdm:name": { + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" + }, + "xdm:phone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + } + }, + "xdm:reportsToID": "RPT10000", + "xdm:departments": [ + "Finance", + "Marketing" + ], + "xdm:jobTitle": "Account manager" + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/profile/profile-work-details.schema.md b/docs/reference/mixins/profile/profile-work-details.schema.md new file mode 100644 index 000000000..3f0a6189b --- /dev/null +++ b/docs/reference/mixins/profile/profile-work-details.schema.md @@ -0,0 +1,163 @@ + +# Profile work details Schema + +``` +https://ns.adobe.com/xdm/context/profile-work-details +``` + +This mixin is used to capture information regarding work-related details of the individual such as work address, work email, work phone number, and organizations to which the profile belongs. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/profile/profile-work-details.schema.json](mixins/profile/profile-work-details.schema.json) | +## Schema Hierarchy + +* Profile work details `https://ns.adobe.com/xdm/context/profile-work-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Postal address](../../datatypes/address.schema.md) `https://ns.adobe.com/xdm/common/address` + * [Email address](../../datatypes/emailaddress.schema.md) `https://ns.adobe.com/xdm/context/emailaddress` + * [Phone number](../../datatypes/phonenumber.schema.md) `https://ns.adobe.com/xdm/context/phonenumber` + + +## Profile work details Example +```json +{ + "xdm:workAddress": { + "@id": "https://data.adobe.io/entities/address/123", + "xdm:primary": false, + "xdm:street1": "345 Park Ave", + "xdm:city": "San Jose", + "xdm:stateProvince": "US-CA", + "xdm:postalCode": "95110", + "xdm:country": "United States", + "xdm:countryCode": "US", + "schema:latitude": 37.3382, + "schema:longitude": -121.8863, + "xdm:status": "active", + "xdm:lastVerifiedDate": "2018-01-02" + }, + "xdm:workEmail": { + "xdm:primary": false, + "xdm:address": "jsmith@xyzinc.com", + "xdm:label": "John Smith", + "xdm:type": "work", + "xdm:status": "active" + }, + "xdm:workPhone": { + "xdm:primary": true, + "xdm:number": "1-408-888-8888", + "xdm:status": "active" + }, + "xdm:assistantDetails": { + "xdm:name": { + "xdm:firstName": "John", + "xdm:middleName": "S", + "xdm:lastName": "Doe", + "xdm:fullName": "John S. Doe" + }, + "xdm:phone": { + "xdm:primary": true, + "xdm:number": "1-408-888-7777", + "xdm:status": "active" + } + }, + "xdm:reportsToID": "RPT10000", + "xdm:departments": [ + "Finance", + "Marketing" + ], + "xdm:jobTitle": "Account manager" +} +``` + +# Profile work details Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:organizations](#xdmorganizations) | `string[]` | Optional | Profile work details (this schema) | +| [xdm:workAddress](#xdmworkaddress) | Postal address | Optional | Profile work details (this schema) | +| [xdm:workEmail](#xdmworkemail) | Email address | Optional | Profile work details (this schema) | +| [xdm:workPhone](#xdmworkphone) | Phone number | Optional | Profile work details (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:organizations +### Organizations + +`xdm:organizations` +* is optional +* type: `string[]` + +* defined in this schema + +### xdm:organizations Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + + + + + + +## xdm:workAddress +### Work Address + +A work postal address. + +`xdm:workAddress` +* is optional +* type: Postal address +* defined in this schema + +### xdm:workAddress Type + + +* [Postal address](../../datatypes/address.schema.md) – `https://ns.adobe.com/xdm/common/address` + + + + + +## xdm:workEmail +### Work Email + +A work email address. + +`xdm:workEmail` +* is optional +* type: Email address +* defined in this schema + +### xdm:workEmail Type + + +* [Email address](../../datatypes/emailaddress.schema.md) – `https://ns.adobe.com/xdm/context/emailaddress` + + + + + +## xdm:workPhone +### Work Phone + +Work phone number. + +`xdm:workPhone` +* is optional +* type: Phone number +* defined in this schema + +### xdm:workPhone Type + + +* [Phone number](../../datatypes/phonenumber.schema.md) – `https://ns.adobe.com/xdm/context/phonenumber` + + + + diff --git a/docs/reference/mixins/segment-definition/segmentdefinition-expression.schema.json b/docs/reference/mixins/segment-definition/segmentdefinition-expression.schema.json new file mode 100644 index 000000000..77d1adbb4 --- /dev/null +++ b/docs/reference/mixins/segment-definition/segmentdefinition-expression.schema.json @@ -0,0 +1,69 @@ +{ + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/segmentdefinition-expression", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment expression", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/segmentdefinition" + ], + "description": "This mixin helps capture the qualifying expression for a segment.", + "definitions": { + "segmentdefinition-expression": { + "properties": { + "xdm:segmentExpression": { + "title": "Segment expression", + "type": "object", + "properties": { + "xdm:expressionType": { + "title": "Type", + "type": "string", + "description": "Type of expression, for example, PQL, Query Service, or Adobe Audience Manager.", + "meta:enum": [ + "PQL", + "AAM", + "QUERYSERVICE" + ] + }, + "xdm:mimeType": { + "title": "Expression mime type", + "type": "string", + "description": "Mime type of the expression. For example, pql/text or application/sql.", + "pattern": "\\w+/[-.\\w]+(?:\\+[-.\\w]+)?" + }, + "xdm:value": { + "title": "Value", + "type": "string", + "description": "Actual expression string. The syntax of expression will depend upon specified mime type." + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/segmentdefinition-expression" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:segmentExpression": { + "xdm:expressionType": "PQL", + "xdm:mimeType": "pql/text", + "xdm:value": "personalEmail.address.endsWith(\"testxdmmail.com\", false)" + } + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/segment-definition/segmentdefinition-expression.schema.md b/docs/reference/mixins/segment-definition/segmentdefinition-expression.schema.md new file mode 100644 index 000000000..a79c942b7 --- /dev/null +++ b/docs/reference/mixins/segment-definition/segmentdefinition-expression.schema.md @@ -0,0 +1,137 @@ + +# Segment expression Schema + +``` +https://ns.adobe.com/xdm/context/segmentdefinition-expression +``` + +This mixin helps capture the qualifying expression for a segment. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/segment-definition/segmentdefinition-expression.schema.json](mixins/segment-definition/segmentdefinition-expression.schema.json) | +## Schema Hierarchy + +* Segment expression `https://ns.adobe.com/xdm/context/segmentdefinition-expression` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + + +## Segment expression Example +```json +{ + "xdm:segmentExpression": { + "xdm:expressionType": "PQL", + "xdm:mimeType": "pql/text", + "xdm:value": "personalEmail.address.endsWith(\"testxdmmail.com\", false)" + } +} +``` + +# Segment expression Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:segmentExpression](#xdmsegmentexpression) | `object` | Optional | Segment expression (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:segmentExpression +### Segment expression + +`xdm:segmentExpression` +* is optional +* type: `object` +* defined in this schema + +### xdm:segmentExpression Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:expressionType`| string | Optional | +| `xdm:mimeType`| string | Optional | +| `xdm:value`| string | Optional | + + + +#### xdm:expressionType +##### Type + +Type of expression, for example, PQL, Query Service, or Adobe Audience Manager. + +`xdm:expressionType` +* is optional +* type: `string` + +##### xdm:expressionType Type + + +`string` + + + +##### xdm:expressionType Known Values +| Value | Description | +|-------|-------------| +| `0` | PQL | +| `1` | AAM | +| `2` | QUERYSERVICE | + + + + + + +#### xdm:mimeType +##### Expression mime type + +Mime type of the expression. For example, pql/text or application/sql. + +`xdm:mimeType` +* is optional +* type: `string` + +##### xdm:mimeType Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5Cw%2B%2F%5B-.%5Cw%5D%2B(%3F%3A%5C%2B%5B-.%5Cw%5D%2B)%3F)): +```regex +\w+/[-.\w]+(?:\+[-.\w]+)? +``` + + + + + + + + +#### xdm:value +##### Value + +Actual expression string. The syntax of expression will depend upon specified mime type. + +`xdm:value` +* is optional +* type: `string` + +##### xdm:value Type + + +`string` + + + + + + + + + + diff --git a/docs/reference/mixins/shared/external-source-system-audit-details.schema.json b/docs/reference/mixins/shared/external-source-system-audit-details.schema.json new file mode 100644 index 000000000..281f6c425 --- /dev/null +++ b/docs/reference/mixins/shared/external-source-system-audit-details.schema.json @@ -0,0 +1,52 @@ +{ + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/external-source-system-audit-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "External Source System Audit Details Mixin", + "type": "object", + "meta:extensible": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/opportunity", + "https://ns.adobe.com/xdm/context/account", + "https://ns.adobe.com/xdm/context/opportunity-contactrole", + "https://ns.adobe.com/xdm/context/activitylog", + "https://ns.adobe.com/xdm/context/profile" + ], + "description": "Mixin which defines a set a audit properties for extenal sources.", + "definitions": { + "externalSourceSystemAuditDetails": { + "properties": { + "xdm:extSourceSystemAudit": { + "title": "External Source System Audit Properties", + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit", + "description": "Audit attributes for external sources." + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/externalSourceSystemAuditDetails" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-02T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-02T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-02T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-02T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-02T15:52:25+00:00" + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/shared/external-source-system-audit-details.schema.md b/docs/reference/mixins/shared/external-source-system-audit-details.schema.md new file mode 100644 index 000000000..70da58c37 --- /dev/null +++ b/docs/reference/mixins/shared/external-source-system-audit-details.schema.md @@ -0,0 +1,57 @@ + +# External Source System Audit Details Mixin Schema + +``` +https://ns.adobe.com/xdm/common/external-source-system-audit-details +``` + +Mixin which defines a set a audit properties for extenal sources. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/shared/external-source-system-audit-details.schema.json](mixins/shared/external-source-system-audit-details.schema.json) | +## Schema Hierarchy + +* External Source System Audit Details Mixin `https://ns.adobe.com/xdm/common/external-source-system-audit-details` + * [Extensibility base schema](../../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [External Source System Audit Attributes](../../datatypes/external-source-system-audit.schema.md) `https://ns.adobe.com/xdm/common/external-source-system-audit` + + +## External Source System Audit Details Mixin Example +```json +{ + "xdm:createdBy": "USER111", + "xdm:createdDate": "2018-01-02T15:52:25+00:00", + "xdm:lastUpdatedBy": "USER2222", + "xdm:lastUpdatedDate": "2018-01-02T15:52:25+00:00", + "xdm:lastActivityDate": "2018-01-02T15:52:25+00:00", + "xdm:lastReferencedDate": "2018-01-02T15:52:25+00:00", + "xdm:lastViewedDate": "2018-01-02T15:52:25+00:00" +} +``` + +# External Source System Audit Details Mixin Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:extSourceSystemAudit](#xdmextsourcesystemaudit) | External Source System Audit Attributes | Optional | External Source System Audit Details Mixin (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:extSourceSystemAudit +### External Source System Audit Properties + +Audit attributes for external sources. + +`xdm:extSourceSystemAudit` +* is optional +* type: External Source System Audit Attributes +* defined in this schema + +### xdm:extSourceSystemAudit Type + + +* [External Source System Audit Attributes](../../datatypes/external-source-system-audit.schema.md) – `https://ns.adobe.com/xdm/common/external-source-system-audit` + + + + diff --git a/docs/reference/mixins/shared/identitymap.schema.json b/docs/reference/mixins/shared/identitymap.schema.json new file mode 100644 index 000000000..b583e0591 --- /dev/null +++ b/docs/reference/mixins/shared/identitymap.schema.json @@ -0,0 +1,81 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/identitymap", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "IdentityMap", + "type": "object", + "meta:extensible": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile", + "https://ns.adobe.com/xdm/context/experienceevent", + "https://ns.adobe.com/xdm/context/segmentdefinition", + "https://ns.adobe.com/experience/audiencemanager/segmentfolder" + ], + "description": "Defines a map containing a set of end user identities, keyed on either namespace integration code or the namespace ID of the identity. The values of the map are an array, meaning that more than one identity of each namespace may be carried.", + "definitions": { + "identitymap": { + "properties": { + "xdm:identityMap": { + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/identityitem" + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/identitymap" + } + ], + "meta:status": "stable", + "examples": [ + { + "EMAIL": [ + { + "xdm:id": "92312748749128" + }, + { + "xdm:id": "92312748749239" + } + ], + "CRM": [ + { + "xdm:id": "2394509340-30453470347", + "xdm:authenticatedState": "authenticated" + } + ] + }, + { + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + }, + { + "xdm:id": "92312748749239" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2394509340-30453470347", + "xdm:authenticatedState": "authenticated" + } + ], + "https://data.adobe.io/entities/namespace/9": [ + { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/mixins/shared/identitymap.schema.md b/docs/reference/mixins/shared/identitymap.schema.md new file mode 100644 index 000000000..a8a7f0ac5 --- /dev/null +++ b/docs/reference/mixins/shared/identitymap.schema.md @@ -0,0 +1,87 @@ + +# IdentityMap Schema + +``` +https://ns.adobe.com/xdm/context/identitymap +``` + +Defines a map containing a set of end user identities, keyed on either namespace integration code or the namespace ID of the identity. The values of the map are an array, meaning that more than one identity of each namespace may be carried. + +| [Abstract](../../../abstract.md) | [Extensible](../../../extensions.md) | [Status](../../../status.md) | [Identifiable](../../../id.md) | [Custom Properties](../../../extensions.md) | [Additional Properties](../../../extensions.md) | Defined In | +|----------------------------------|--------------------------------------|------------------------------|--------------------------------|---------------------------------------------|-------------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [mixins/shared/identitymap.schema.json](mixins/shared/identitymap.schema.json) | + +## IdentityMap Examples + +```json +{ + "EMAIL": [ + { + "xdm:id": "92312748749128" + }, + { + "xdm:id": "92312748749239" + } + ], + "CRM": [ + { + "xdm:id": "2394509340-30453470347", + "xdm:authenticatedState": "authenticated" + } + ] +} +``` + +```json +{ + "https://data.adobe.io/entities/namespace/4": [ + { + "xdm:id": "92312748749128" + }, + { + "xdm:id": "92312748749239" + } + ], + "https://data.adobe.io/entities/namespace/10": [ + { + "xdm:id": "2394509340-30453470347", + "xdm:authenticatedState": "authenticated" + } + ], + "https://data.adobe.io/entities/namespace/9": [ + { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d" + } + ] +} +``` + + +# IdentityMap Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [xdm:identityMap](#xdmidentitymap) | `object` | Optional | IdentityMap (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## xdm:identityMap + + +`xdm:identityMap` +* is optional +* type: `object` +* defined in this schema + +### xdm:identityMap Type + + +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| + + + + + diff --git a/docs/reference/notifications/ingestion.schema.json b/docs/reference/notifications/ingestion.schema.json new file mode 100644 index 000000000..815002c4d --- /dev/null +++ b/docs/reference/notifications/ingestion.schema.json @@ -0,0 +1,182 @@ +{ + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/notifications/ingestion", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Customer Data Ingestion Notifications Event", + "type": "object", + "meta:extensible": false, + "meta:abstract": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record" + ], + "description": "Customer notification events for data ingestion processes.", + "definitions": { + "ingestion-notification": { + "properties": { + "xdm:eventType": { + "title": "Event Type", + "type": "string", + "description": "Event type of customer data ingestion notification.", + "enum": [ + "ing_load_success", + "ing_load_failure", + "ps_load_success", + "ps_load_failure", + "ig_load_success", + "ig_load_failure" + ], + "meta:enum": { + "ing_load_success": "Ing Load Success", + "ing_load_failure": "Ing Load Failure", + "ps_load_success": "Ps Load Success", + "ps_load_failure": "Ps Load Lailure", + "ig_load_success": "Ig Load Success", + "ig_load_failure": "Ig Load Failure" + } + }, + "xdm:status": { + "title": "Ingestion Status", + "type": "string", + "description": "The current status of this ingestion process.", + "enum": [ + "success", + "failure" + ], + "meta:enum": { + "success": "Sucess Status", + "failure": "Failure Status" + } + }, + "xdm:ingestionId": { + "title": "Ingestion ID", + "type": "string", + "description": "System generates Unique Identifier for a data ingestion instance." + }, + "xdm:parentIngestionId": { + "title": "Parent Ingestion ID", + "type": "string", + "description": "In a flow where multiple insgestion stage, each stage employs its own ingestion identifier, this value represents the parent stage that resulted in the initiation of this ingestion. This can be used to correlate ingestion processes over multiple stages." + }, + "xdm:customerIngestionId": { + "title": "Customer Batch Identifier", + "type": "string", + "pattern": "^[0-9A-Za-z\\.\\-\\_/@]+$", + "description": "Customers can specify an externally generated identifier for this ingestion." + }, + "xdm:datasetId": { + "title": "Dataset ID", + "type": "string", + "description": "Dataset id of data ingestion." + }, + "xdm:sandboxName": { + "title": "Sandbox Name", + "type": "string", + "description": "Name of the sandbox where data is ingested." + }, + "xdm:inputFormat": { + "title": "Input File Format", + "description": "Metadata describing the INGEST format of the data being loaded (e.g. Parquet, CSV, JSON).", + "enum": [ + "csv", + "parquet", + "json" + ], + "meta:enum": { + "csv": "CSV format of the file", + "parquet": "Parquet format of the file", + "json": "JSON format of the file" + } + }, + "xdm:imsOrg": { + "description": "The owning IMS organization identifier.", + "type": "string", + "pattern": "^[0-9A-Za-z]*@[Aa]dobe[Oo]rg$" + }, + "xdm:startTime": { + "type": "integer", + "description": "The unix timestamp (in milliseconds) when the batch processing action was started." + }, + "xdm:completionTime": { + "type": "integer", + "description": "The unix timestamp (in milliseconds) when the batch processing action was completed. Completed - Started should yield the total processing time.", + "maximum": 14500000000000 + }, + "xdm:succesfulRecords": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Number of records successfully ingested." + }, + "xdm:failedRecords": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Number of records failed to ingest." + }, + "xdm:errors": { + "type": "array", + "description": "A list of problems encountered during this ingestion process.", + "meta:status": "deprecated", + "items": { + "type": "object", + "properties": { + "xdm:code": { + "type": "string", + "description": "An enumerated code that details the type of error encountered. This value should be understandable by the reader and writer and eventually allow for localized error message (and solution) descriptions." + }, + "xdm:rows": { + "type": "array", + "description": "Indicates which rows exhibit this error. Could be a single number, or a hyphen-delimited range.", + "items": { + "type": "string", + "description": "Row or range of rows this error was encountered on." + } + }, + "xdm:description": { + "type": "string", + "description": "A human-readable description of the error. This message may be transmitted to clients, but isn't meant for customer-facing UIS." + } + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/ingestion-notification" + } + ], + "meta:status": "stable", + "examples": [ + { + "xdm:eventType": "ig_load_success", + "xdm:status": "success", + "xdm:ingestionId": "batch1234", + "xdm:customerIngestionId": "1234@adobe", + "xdm:datasetId": "1234", + "xdm:sandboxName": "test", + "xdm:inputFormat": "csv", + "xdm:imsOrg": "D13A1E7053E46A220A4C86E1@AdobeOrg", + "xdm:startTime": 123456, + "xdm:completionTime": 12345678, + "xdm:errors": [ + { + "xdm:code": "err1234", + "xdm:rows": [ + "1", + "2" + ], + "xdm:description": "error" + } + ] + } + ] +} \ No newline at end of file diff --git a/docs/reference/notifications/ingestion.schema.md b/docs/reference/notifications/ingestion.schema.md new file mode 100644 index 000000000..ec92c6fbe --- /dev/null +++ b/docs/reference/notifications/ingestion.schema.md @@ -0,0 +1,464 @@ + +# Customer Data Ingestion Notifications Event Schema + +``` +https://ns.adobe.com/xdm/common/notifications/ingestion +``` + +Customer notification events for data ingestion processes. + +| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | +|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| +| Can be instantiated | Yes | Stable | No | Forbidden | Permitted | [notifications/ingestion.schema.json](notifications/ingestion.schema.json) | +## Schema Hierarchy + +* Customer Data Ingestion Notifications Event `https://ns.adobe.com/xdm/common/notifications/ingestion` + * [Record Schema](../behaviors/record.schema.md) `https://ns.adobe.com/xdm/data/record` + * [Extensibility base schema](../datatypes/extensible.schema.md) `https://ns.adobe.com/xdm/common/extensible` + * [Measure](../datatypes/data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` + + +## Customer Data Ingestion Notifications Event Example +```json +{ + "xdm:eventType": "ig_load_success", + "xdm:status": "success", + "xdm:ingestionId": "batch1234", + "xdm:customerIngestionId": "1234@adobe", + "xdm:datasetId": "1234", + "xdm:sandboxName": "test", + "xdm:inputFormat": "csv", + "xdm:imsOrg": "D13A1E7053E46A220A4C86E1@AdobeOrg", + "xdm:startTime": 123456, + "xdm:completionTime": 12345678, + "xdm:errors": [ + { + "xdm:code": "err1234", + "xdm:rows": [ + "1", + "2" + ], + "xdm:description": "error" + } + ] +} +``` + +# Customer Data Ingestion Notifications Event Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [@id](#id) | `string` | Optional | [Record Schema](../behaviors/record.schema.md#id) | +| [xdm:completionTime](#xdmcompletiontime) | `integer` | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:customerIngestionId](#xdmcustomeringestionid) | `string` | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:datasetId](#xdmdatasetid) | `string` | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:errors](#xdmerrors) | `object[]` | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:eventType](#xdmeventtype) | `enum` | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:failedRecords](#xdmfailedrecords) | Measure | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:imsOrg](#xdmimsorg) | `string` | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:ingestionId](#xdmingestionid) | `string` | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:inputFormat](#xdminputformat) | `enum` | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:parentIngestionId](#xdmparentingestionid) | `string` | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:sandboxName](#xdmsandboxname) | `string` | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:startTime](#xdmstarttime) | `integer` | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:status](#xdmstatus) | `enum` | Optional | Customer Data Ingestion Notifications Event (this schema) | +| [xdm:succesfulRecords](#xdmsuccesfulrecords) | Measure | Optional | Customer Data Ingestion Notifications Event (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## @id +### Identifier + +A unique identifier for the record. + +`@id` +* is optional +* type: `string` +* defined in [Record Schema](../behaviors/record.schema.md#id) + +### @id Type + + +`string` +* format: `uri-reference` – URI Reference (according to [RFC3986](https://tools.ietf.org/html/rfc3986)) + + + + + + +## xdm:completionTime + +The unix timestamp (in milliseconds) when the batch processing action was completed. Completed - Started should yield the total processing time. + +`xdm:completionTime` +* is optional +* type: `integer` +* defined in this schema + +### xdm:completionTime Type + + +`integer` +* maximum value: `14500000000000` + + + + + +## xdm:customerIngestionId +### Customer Batch Identifier + +Customers can specify an externally generated identifier for this ingestion. + +`xdm:customerIngestionId` +* is optional +* type: `string` +* defined in this schema + +### xdm:customerIngestionId Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E%5B0-9A-Za-z%5C.%5C-%5C_%2F%40%5D%2B%24)): +```regex +^[0-9A-Za-z\.\-\_/@]+$ +``` + + + + + + +## xdm:datasetId +### Dataset ID + +Dataset id of data ingestion. + +`xdm:datasetId` +* is optional +* type: `string` +* defined in this schema + +### xdm:datasetId Type + + +`string` + + + + + + +## xdm:errors + +A list of problems encountered during this ingestion process. + +`xdm:errors` +* is optional +* type: `object[]` + +* defined in this schema + +### xdm:errors Type + + +Array type: `object[]` + +All items must be of the type: +`object` with following properties: + + +| Property | Type | Required | +|----------|------|----------| +| `xdm:code`| string | Optional | +| `xdm:description`| string | Optional | +| `xdm:rows`| array | Optional | + + + +#### xdm:code + +An enumerated code that details the type of error encountered. This value should be understandable by the reader and writer and eventually allow for localized error message (and solution) descriptions. + +`xdm:code` +* is optional +* type: `string` + +##### xdm:code Type + + +`string` + + + + + + + + +#### xdm:description + +A human-readable description of the error. This message may be transmitted to clients, but isn't meant for customer-facing UIS. + +`xdm:description` +* is optional +* type: `string` + +##### xdm:description Type + + +`string` + + + + + + + + +#### xdm:rows + +Indicates which rows exhibit this error. Could be a single number, or a hyphen-delimited range. + +`xdm:rows` +* is optional +* type: `string[]` + + +##### xdm:rows Type + + +Array type: `string[]` + +All items must be of the type: +`string` + + + + +Row or range of rows this error was encountered on. + + + + + + + + + + + + + + +## xdm:eventType +### Event Type + +Event type of customer data ingestion notification. + +`xdm:eventType` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmeventtype-known-values). + +### xdm:eventType Known Values +| Value | Description | +|-------|-------------| +| `ing_load_success` | Ing Load Success | +| `ing_load_failure` | Ing Load Failure | +| `ps_load_success` | Ps Load Success | +| `ps_load_failure` | Ps Load Lailure | +| `ig_load_success` | Ig Load Success | +| `ig_load_failure` | Ig Load Failure | + + + + +## xdm:failedRecords + +Number of records failed to ingest. + +`xdm:failedRecords` +* is optional +* type: Measure +* defined in this schema + +### xdm:failedRecords Type + + +* [Measure](../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + + + +## xdm:imsOrg + +The owning IMS organization identifier. + +`xdm:imsOrg` +* is optional +* type: `string` +* defined in this schema + +### xdm:imsOrg Type + + +`string` + + +All instances must conform to this regular expression +(test examples [here](https://regexr.com/?expression=%5E%5B0-9A-Za-z%5D*%40%5BAa%5Ddobe%5BOo%5Drg%24)): +```regex +^[0-9A-Za-z]*@[Aa]dobe[Oo]rg$ +``` + + + + + + +## xdm:ingestionId +### Ingestion ID + +System generates Unique Identifier for a data ingestion instance. + +`xdm:ingestionId` +* is optional +* type: `string` +* defined in this schema + +### xdm:ingestionId Type + + +`string` + + + + + + +## xdm:inputFormat +### Input File Format + +Metadata describing the INGEST format of the data being loaded (e.g. Parquet, CSV, JSON). + +`xdm:inputFormat` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdminputformat-known-values). + +### xdm:inputFormat Known Values +| Value | Description | +|-------|-------------| +| `csv` | CSV format of the file | +| `parquet` | Parquet format of the file | +| `json` | JSON format of the file | + + + + +## xdm:parentIngestionId +### Parent Ingestion ID + +In a flow where multiple insgestion stage, each stage employs its own ingestion identifier, this value represents the parent stage that resulted in the initiation of this ingestion. This can be used to correlate ingestion processes over multiple stages. + +`xdm:parentIngestionId` +* is optional +* type: `string` +* defined in this schema + +### xdm:parentIngestionId Type + + +`string` + + + + + + +## xdm:sandboxName +### Sandbox Name + +Name of the sandbox where data is ingested. + +`xdm:sandboxName` +* is optional +* type: `string` +* defined in this schema + +### xdm:sandboxName Type + + +`string` + + + + + + +## xdm:startTime + +The unix timestamp (in milliseconds) when the batch processing action was started. + +`xdm:startTime` +* is optional +* type: `integer` +* defined in this schema + +### xdm:startTime Type + + +`integer` + + + + + + +## xdm:status +### Ingestion Status + +The current status of this ingestion process. + +`xdm:status` +* is optional +* type: `enum` +* defined in this schema + +The value of this property **must** be equal to one of the [known values below](#xdmstatus-known-values). + +### xdm:status Known Values +| Value | Description | +|-------|-------------| +| `success` | Sucess Status | +| `failure` | Failure Status | + + + + +## xdm:succesfulRecords + +Number of records successfully ingested. + +`xdm:succesfulRecords` +* is optional +* type: Measure +* defined in this schema + +### xdm:succesfulRecords Type + + +* [Measure](../datatypes/data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` + + + +