Schema.org Query Pattern Types

The following table lists the Schema.org-defined query pattern types for Custom Device Actions. The name of each type starts with $SchemaOrg. These types correspond to the standard types defined in Schema.org.

Some of these types return structured data rather than a single value. These types are indicated in the table. See structured data for more information.

Supported Schema.org types

Structured data

Some types support structured data being passed back instead of a single value. In the deviceExecution section, add .structured to the parameter name to receive structured data back for these types:

"my-param-name": "$parameter-name.structured"

where my-param-name is the user-defined name that is passed back in the params and parameter-name identifies the parameter in the query pattern.

See the following example:

Place

Query

Write review for New York

Action package

...

"intent": {
    "name": "com.example.intents.Review",
    "parameters": [
        {
            "name": "place",
            "type": "SchemaOrg_Place"
        }
    ],
    "trigger": {
        "queryPatterns": [
            "write review for $SchemaOrg_Place:place"
        ]
    }
},

...

"deviceExecution": {
    "command": "com.example.commands.Review",
    "params": {
        "placeName": "$place.structured"
    }
}

...

Returned params

See LatLng for more information.

"placeName": {
    "latitude": 40.7128,
    "longitude": 74.0060
}

Date

See Date for more information.

Returned params:

{
    "year": 2018,
    "month": 12,
    "day": 2
}

Time

See TimeOfDay for more information.

Returned params:

{
    "hours": 12,
    "minutes": 0,
    "seconds": 0,
    "nanos": 0
}

DateTime

See DateTime for more information.

Returned params:

{
    "date": {
      "year": 2018,
      "month": 11,
      "day": 30
    },
    "time": {
      "hours": 12,
      "minutes": 0,
      "seconds": 0,
      "nanos": 0
    }
}