SAMX

Simple Advertisement Metadata Exchange
Specification Version 1.0


SAMX is a document format specification for the transfer of advertisement metadata to or from a SIMS service. An SAMX document may be in either XML or JSON syntax.

Each response must include samx as the first element with a version attribute indicating the specification version in the format #.#. See the SAMX XML Schema for a complete specification of the SAMX data structure.

If an SAMX document is saved to a filesystem, the recommended file name suffix is “*.samx”. Using “*.xml” in the case of XML format, or “*.json” in the case of JSON format, as the file name suffix is also acceptable.

SAMX XML Schema

SIMS Ad Data XML Schema

SIMS Metadata XML Schema

SIMS Admin Data XML Schema

Example SAMX document in XML:

<samx version="x.x" xmlns="http://simsapi.org">

    <advertisements>
        <advertisement>
            <name>Launch Campaign Ad</name>
            <advertiser>Doe
                <name>Big Company</name>
                <eid>WEF323S</eid>
            </advertiser>
            <eid>W34DF</eid>
        </advertisement>
        ...
    </advertisements>

</samx>

Note: Defined values for each element are required to be understood. Additional vendor-specific values may be included using a “x_” prefix. Elements should have names in snake case (ie. “element_name” instead of “elementName”) and must not include a period (“.”) in the name. A basic implementation is not required to support vendor-specific values.