info

The <info> entity specifies the alert's details. At least one <info> block is required for an alert. If you support multiple languages, we recommend that you use one <info> block for each language for the same <alert> entity.

info entity elements

The following table describes the sub-element values for the <info> entity:

Element name Optionality Type CAP and Google notes and requirements
<language> OPTIONAL language

For the <language> code value, we recommend that you use a valid RFC 3066.

If the <language> element isn't present, then the default value is en-US.

<category> REQUIRED InfoCategory The <category> code denotes the category of the subject event of the alert message. To identify the right categories for your events, refer to the OASIS Event Terms List. Proper categorization can help Google surface the alert more accurately to users.
<event> REQUIRED string

The <event> element denotes the type of the subject event of the alert message.

Google requirements for the <event> element are as follows:

  • Make the length less than 35 characters.
  • List a set of predefined <event> types in a CSV or Google spreadsheet (see this Google Sheets example).
<responseType> OPTIONAL responseType

To denote the type of action recommended for the correct audience, when applicable, we strongly recommend a <responseType> element, along with the <instruction> element value that it corresponds to.

<urgency> REQUIRED urgency

Don't use the value Unknown for the <urgency> element because that value makes it difficult to index alerts and relative ranks.

It's important for Google to know how the <urgency> field is set and by whom. However, that information is outside of the scope of the formal profile.

Preferably, the publisher sets the <urgency> value on a case-by-case basis and follows clear trigger guidelines. However, an <event> element might fix the <urgency> value, and thereby, reduce the flexibility of alert authors. As an example, NOAA in the US sets urgency statically based on event type.

<severity> REQUIRED severity

Don't use the value Unknown for the <severity> element because that value makes it difficult to index alerts and relative ranks.

It's important for Google to know how the <severity> field is set and by whom. However, that information is outside of the scope of the formal profile.

Preferably, the publisher sets the <severity> value on a case-by-case basis and follows clear trigger guidelines. However, an <event> element might fix the <severity> value, and thereby, reduce the flexibility of alert authors. As an example, NOAA in the US sets urgency statically based on event type.

<certainty> REQUIRED certainty

Don't use the value Unknown for the <certainty> element because that value makes it difficult to index alerts and relative ranks.

It's important for Google to know how the <certainty> field is set and by whom. However, that information is outside of the scope of the formal profile.

Preferably, the publisher sets the <certainty> value on a case-by-case basis and follows clear trigger guidelines. However, an <event> element might fix the <certainty> value, and thereby, reduce the flexibility of alert authors. As an example, NOAA in the US sets urgency statically based on event type.

<audience> OPTIONAL string The value of the <audience> element is text that describes the intended audience of the alert message.
<eventCode> OPTIONAL string

The <eventCode> element contains system-specific code that identifies the event type of the alert message in the following form.

        <eventCode>
          <valueName>valueName</valueName>
          <value>value</value>
        </eventCode>

where:

  • valueName = A user-assigned string that designates the domain of the code. If those strings are acronyms, then represent them in all capital letters without periods. Examples are SAME, FIPS, and ZIP.
  • value = A string that denotes the value of the <eventCode> element.

Multiple instances of <eventCode> elements can occur within an <info> block.

We strongly recommend that you get the <eventCode> element values from the OASIS Event Terms List. If you use the OASIS event term list, then use OET:v1.0 as the value name, as shown in this example:

        <eventCode>
          <valueName>OET:v1.0</valueName>
          <value>OET-003</value>
        </eventCode>
<effective> OPTIONAL dateTime

The value of the <effective> element is the effective time of the information in the alert message.

You must include time zone fields in all dateTime values. If the location cited in the <area> block falls within a single time zone, we recommend that the <effective> element specifies time in that zone. When applicable, include an allowance for Daylight Savings time.

When the content of a message applies across multiple time zones, we recommend that the message producer uses UTC times in preference to local times.

Example:

2002-05-24T16:49:00-07:00 represents May 24, 2002 at 16:49 PDT.

<onset> OPTIONAL dateTime

The value of the <onset> element is the expected time when the subject event of the alert message begins. You must include time zone fields in all dateTime values.

If the location cited in the <area> block falls within a single time zone, we recommend that the <effective> element specifies time in that zone. When applicable, include an allowance for Daylight Savings time.

When the content of a message applies across multiple time zones, we recommend that the message producer uses UTC times in preference to local times.

Example:

2002-05-24T16:49:00-07:00 represents May 24, 2002 at 16:49 PDT.

<expires>

REQUIRED*

dateTime

The value of the <expires> element is the expiry time of the subject event of the alert message. An <expires> element must come after an <effective> element in time order.

If you can't set an expiry time for all your alerts, provide Google with a default expiry time for any alerts that don't have an <expires> element. For example, you can state that by default, all your alerts are set to expire after 48 hours if there's no <expires> element.

You must include time zone fields in all dateTime values. If the location cited in the <area> block falls within a single time zone, we recommend that the <effective> element specifies time in that zone. When applicable, include an allowance for Daylight Savings time.

When the content of a message applies across multiple time zones, we recommend that the message producer uses UTC times in preference to local times.

Example:

2002-05-24T16:49:00-07:00 represents May 24, 2002 at 16:49 PDT.

<senderName> OPTIONAL string

A <senderName> element is optional but strongly recommended.

When the sender has a human-readable name, the <web> link can show in a user-friendly way, according to the publisher or sender's preferences. In addition, the <senderName> element allows alert aggregators to publish from multiple authorities.

<headline> OPTIONAL string

Make the length of <headline> element strings less than 140 characters.

A <headline> string can be open text, but we recommend that it consists of less than 140 characters. (CAP 1.2 suggests less than 160 for text messages.) Begin this string with a few descriptive words that explain the core of the alert. An example is "Pontoon bridge closure...."

Don't use the same values for the <headline> and <description> elements. Provide more detail in the <description> element than in the <headline> element.

<description>

REQUIRED*

string

The value of the <description> element is text that describes the subject of the event of the alert message.

We recommend human-readable and informative content that answers these questions:

  • What is happening or about to happen?
  • Where is it happening?
  • How bad is it?

Google uses the <description> element to populate the Message section of our page and uses the <instruction> element to populate the Recommended actions section. Both fields are visible to users.

You can use these supported Markdown tags: <newline>, <b>, and <a href>.

<instruction> OPTIONAL string

The value of the <instruction> element is text that describes the recommended actions for recipients of the alert message. We recommend human-readable and informative content.

List actions that fit the level of the alert severity and that aren't general. Use succinct, case-sensitive sentences and include safety tips that readers can act on, with the most important tip first.

The <instruction> element is optional, but we strongly recommend it. Google Public Alerts uses the <instruction> field to populate the Recommended actions section in alert details pages. Make the <instruction> and <description> field values different because they serve different purposes.

<web>

OPTIONAL

string

Link the <web> element to a working URL that provides more information about your alert.

<contact> OPTIONAL string

The <contact> field is optional, but we strongly recommend that it be present because it provides a way for users to provide feedback and respond to the alert. For example, "For emergencies, call 911."

<parameter> OPTIONAL string

The <parameter> element contains system-specific data in the following form:

        <parameter>
          <valueName>valueName</valueName>
          <value>value</value>
        </parameter>

where:

valueName = A user-assigned string that designates the domain of the code.

value = A string value.

Multiple instances of a <parameter> element can occur within an <info> block.

<resource> OPTIONAL resource

The <resource> element provides any additional supplemental information related to the parent <info> element. Multiple instances of a <resource> element can occur within an <info> block.

<area>

REQUIRED*

area

The <area> element contains information about the alerting area of the event, not the incident area. <area> blocks must include at least one <circle>, <polygon>, or <geocode> element.

We strongly recommend the use of a <polygon> or <circle> element instead of a <geocode> element.

* Google requires elements that have a bold and red REQUIRED optionality, but those elements are optional in the CAP standard.

Example

<info>
    <language>en-CA</language>
    <category>Met</category>
    <event>blowing snow</event>
    <responseType>Monitor</responseType>
    <urgency>Future</urgency>
    <severity>Moderate</severity>
    <certainty>Possible</certainty>
    <audience>general public</audience>
    <eventCode>
        <valueName>profile:CAP-CP:Event:0.4</valueName>
        <value>blowingSnow</value>
    </eventCode>
    <effective>2023-04-13T23:16:53-00:00</effective>
    <expires>2023-04-14T15:11:38-00:00</expires>
    <senderName>Environment Canada</senderName>
    <headline>blowing snow advisory in effect</headline>
    <description>
    Periods of poor visibility in blowing snow.

    When: Tonight through this weekend.

    Impacts: Poor visibility due to blowing snow.

    Remarks: Strong easterly winds are expected to continue through the
    Richardson Mountains through at least this weekend. Gusty northeasterly
    winds are also possible near the Ogilvie Mountains during the same
    timeframe. These strong winds will likely generate periods of blowing
    snow through the mountain passes and visibility will at times be
    significantly reduced.
    </description>
    <instruction>Be prepared to adjust your driving with changing road
    conditions.</instruction>
    <web>http://weather.gc.ca/warnings/index_e.html?prov=yt</web>
    <area>
        <areaDesc>Dempster</areaDesc>
        <polygon>65.4581,-137.8443 64.3417,-137.8311 64.3385,
        -137.911 64.3497,-138.0022 64.415,-138.4948 64.5198,-138.9891 65.53,
        -139.0095 66.6721,-137.1316 67.0102,-136.6048 67.1424,
        -136.3737 67.2766,-136.136 67.2657,-135.9251 67.1757,-136.0889 67.0,
        -136.012 67.0,-135.9999 67.0133,-135.4962 67.0,-134.9833 65.4581,
        -137.8443</polygon>
        <geocode>
            <valueName>layer:EC-MSC-SMC:1.0:CLC</valueName>
            <value>093100</value>
        </geocode>
        <geocode>
            <valueName>profile:CAP-CP:Location:0.3</valueName>
            <value>6001045</value>
        </geocode>
    </area>
</info>