StructuredDataMapping

Declares the Google Cloud Search value type to use for a document field sent as structured data.

committer/googlecloudsearchJavadoc: StructuredDataMapping

Notes

Structured data lets you send fields beyond Google's standard metadata set, but each one has to be typed so Cloud Search can index, filter and sort it correctly. The type declared here must match the property's type in the schema registered for your data source — a mismatch is rejected at commit time.

Examples

Sends a price as a number and a publication date as a date, so both can be sorted and filtered on.

YAML

structuredDataMappings:
  - field: price
    type: DOUBLE
  - field: published
    type: DATE

JSON

{
  "structuredDataMappings": [
    {
      "field": "price",
      "type": "DOUBLE"
    },
    {
      "field": "published",
      "type": "DATE"
    }
  ]
}

XML

<structuredDataMappings>
  <field>price</field>
  <type>DOUBLE</type>
  <field>published</field>
  <type>DATE</type>
</structuredDataMappings>

Usage

Full configuration skeleton, with every option and its default

YAML

field: string
type: TEXT

JSON

{
  "field": "string",
  "type": "TEXT"
}

XML

<structuredDataMapping>
  <field>string</field>
  <type>TEXT</type>
</structuredDataMapping>

Properties

Property	Type	Required	Default
field	string	No	-
type	enum	No	TEXT

Property Details

field

Name of the document field this mapping applies to. It must also exist as a property in your data source's Cloud Search schema.

type

Value type of the field: TEXT (the default), INTEGER, DOUBLE, DATE, TIMESTAMP, BOOLEAN, ENUM or HTML.

Allowed Values

• TEXT
• INTEGER
• DOUBLE
• DATE
• TIMESTAMP
• BOOLEAN
• ENUM
• HTML