Event Type
Structured content of the type "Event" is the most complex type for the generation and maintenance of the data. With this type we use additional fields to define detailled data for our structured content. Remember from the introduction? "Structured content needs structured content" - yes, that's what we're dealing with now. So, another fresh cup of coffee and let's go!
Note:
The module refers to the Google defined specifications for Types / Schema & Required Information which can be found here:
https://developers.google.com/search/docs/data-types/event
Required fields
There is a whole set of "required fields" most of which you can skip if you want, but be warned: if you omit the wrong / too much information, all the work is for naught and search engines will ignore your structured content simply because it is "irrelevant". Of course it would be optimal if you fill every field with information, but this may not always be possible. Let's look at the fields in detail.
| Module Parameter | Description | Required? |
|---|---|---|
| Image | Image to be used for the structured content. Various types support the use of images such as products or books. options are: Intro Image or Fulltext Image | strongly recommendet |
| Start Date (CF) End Date (CF) |
Select the customfield that holds the start / end date in a regular datetime format. Field type calendar is recommendet to be used for this. | yes |
| Event Offer Valid from | Article field that holds the information from when on the offer / price is valid. | recommendet |
| Ticket URL (CF) | Customfield that holds the URL for Ticketing. Full URL is required here no relative URL's. | no |
| Module Parameter | Description | Required? |
|---|---|---|
| Performer x Type (CF) | For each performer you can define the type of performer. A performer type can be a "Person" or a "PerformingGroup". Based on the Schema. The Module takes the value (rawvalue) of the field. | yes |
| Performer x Name (CF) | Customfield that holds the Performer's name. The Module takes the value (rawvalue) of the field. | yes |
| Performer x URL (CF) | Customfield that holds the Performer's URL. The Module takes the value (rawvalue) of the field. | no |
| Organizer Type (CF) | An Organizer can be an "Organization" or a "Person" - This field contains the type declaration. The Module takes the value (rawvalue) of the field. | no, will be set automaticaly to 'Organization' if no data is given |
| Organizer Name (CF) | Name of the Organizer. The Module takes the value (rawvalue) of the field. | yes |
| Organizer URL (CF) | URL of the Organizer. The Module takes the value (rawvalue) of the field. | no |
| Module Parameter | Description | Required? |
|---|---|---|
| Eventstatus (CF) | The current event status as a scheme URL. Allowed values according to: https://schema.org/EventStatusType. The field value must contain the complete URL or the scheme value, i.e.: 'https://schema.org/EventScheduled' or 'EventScheduled'. | no, will be set automaticaly to EventScheduled if no data is given |
| Event Location Type (CF) | Customfield that holds the location type. Supported Location Types are 'Place' or 'VirtualLocation'. If this field is empty or not set Location Type 'Place' and all its necessary fields for address will be used. | yes |
| Event Location Name (CF) | Customfield that holds the location name as string value. Only needed for events of type 'Place'. | yes if Location Type is 'Place' |
| Event Location Street (CF) | Customfield that holds the location street address as string value. Only needed for events of type 'Place'. | yes if Location Type is 'Place' |
| Event Location ZIP (CF) | Customfield that holds the location town zip code as string value. Only needed for events of type 'Place'. | yes if Location Type is 'Place' |
| Event Location Town (CF) | Customfield that holds the location town as string value. Only needed for events of type 'Place'. | yes if Location Type is 'Place' |
| Event Location Region (CF) |
Customfield that holds the location region code as string value. Only needed for events of type 'Place'. States in the USA e.g. 'NY' or 'WS', federal states in Germany like 'NW', 'SH' etc. Field gets omitted when not set or empty. |
no |
| Event Location Country (CF) | Customfield that holds the location country in ISO 3166-1 Alpha-2 Format: 'US' for United States of America, 'CH' for Switzerland, 'DE' for Germany... | yes if Location Type is 'Place' |
| Event Location URL (CF) | Customfield that holds the url value for online events. | yes if Location Type is 'VirtualLocation' |
| Price | Select the custom field that contains the price information. | yes |
| Currency (CF) |
If the elements use different currencies, the field where the corresponding currency is stored can be selected here. This is only needed if no general currency is used for all elements. Then please enter the currency in the field below. | yes but see below |
| Price Currency | Specify the currency for the prices of your elements - for example USD for US Dollar. This is a Fallback value when the CF is not set or empty. | yes |
| Stock Information (CF) | The customfield that holds the information (schema link) for inStock type. Allowed values are: 'https://schema.org/InStock', 'https://schema.org/OutOfStock', or others as seen here: https://schema.org/ItemAvailability. If no field is selected the module will use the inStock Schema. If you are using this module with digital products you can ignore this field. We will take care of it and when there is no information available we set always inStock because we assume that you distribute digital products. | yes |