- Action ID
actions.intent.CREATE_SOCIAL_MEDIA_POSTING
- Description
-
Construct a post or update in a social media app. Populate the post with content from the
socialMediaPosting.articleBody
intent parameter. Common forms of media, like images and video, are designated in thesocialMediaPosting.sharedContent.disambiguatingDescription
intent parameter, which uses supported text field values.To distinguish between a generic post and posts for a story, use the
socialMediaPosting.disambiguatingDescription
intent parameter, if available.Your app must confirm with the user before posting content.
Locale support
Functionality | Locales |
---|---|
Preview creation using App Actions test tool | en-US |
User invocation from Google Assistant | en-US |
Example queries
Recommended fields
The following fields represent essential information that users often provide in queries that trigger this built-in intent:
socialMediaPosting.articleBody
socialMediaPosting.sharedContent.@type
socialMediaPosting.sharedContent.disambiguatingDescription
Other supported fields
The following fields represent information that users often provide to disambiguate their needs or otherwise improve their results:
socialMediaPosting.@type
socialMediaPosting.disambiguatingDescription
Supported text values by field
Inventory availability by field
Sample XML files
For information about the shortcuts.xml
schema, see Create shortcuts.xml.
Handle BII parameters
shortcuts.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample shortcuts.xml -->
<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
<capability android:name="actions.intent.CREATE_SOCIAL_MEDIA_POSTING">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<!-- Eg. articleBody = "Having fun with friends" -->
<parameter
android:name="socialMediaPosting.articleBody"
android:key="articleBody"/>
<!-- Eg. socialMediaPostingDisambiguatingdescription = "Post" -->
<parameter
android:name="socialMediaPosting.disambiguatingDescription"
android:key="socialMediaPostingDisambiguatingdescription"/>
<!-- Eg. sharedContentDisambiguatingdescription = "Image" -->
<parameter
android:name="socialMediaPosting.sharedContent.disambiguatingDescription"
android:key="sharedContentDisambiguatingdescription"/>
</intent>
</capability>
</shortcuts>
actions.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.CREATE_SOCIAL_MEDIA_POSTING">
<fulfillment urlTemplate="myapp://custom-deeplink{?articleBody,socialMediaPostingDisambiguatingdescription,sharedContentDisambiguatingdescription}">
<!-- e.g. articleBody = "Having fun with friends" -->
<!-- (Optional) Require a field eg.articleBody for fulfillment with required="true" -->
<parameter-mapping urlParameter="articleBody" intentParameter="socialMediaPosting.articleBody" required="true" />
<!-- e.g. socialMediaPostingDisambiguatingdescription = "Post" -->
<parameter-mapping urlParameter="socialMediaPostingDisambiguatingdescription" intentParameter="socialMediaPosting.disambiguatingDescription" />
<!-- e.g. sharedContentDisambiguatingdescription = "Image" -->
<parameter-mapping urlParameter="sharedContentDisambiguatingdescription" intentParameter="socialMediaPosting.sharedContent.disambiguatingDescription" />
</fulfillment>
<!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
<fulfillment urlTemplate="myapp://deeplink" />
</action>
</actions>
Use inline inventory
shortcuts.xml
socialMediaPosting.sharedContent.disambiguatingDescription
is an
intent parameter that supports inline inventory.
By defining a <shortcut>
for socialMediaPosting.sharedContent.disambiguatingDescription
,
you can uniquely identify entities that are of interest to your app or restrict
fulfillment to the set of supported entities.
In the following example, when the user query matches the
sharedContentDisambiguatingdescription_one
shortcut, Assistant provides the associated shorcut identifier, ID_ONE
, as
the URL parameter sharedContentDisambiguatingdescription
to fulfillment.
If there is no inventory match, the text value received in the query for
socialMediaPosting.sharedContent.disambiguatingDescription
is passed
as-is.
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample shortcuts.xml -->
<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
<capability android:name="actions.intent.CREATE_SOCIAL_MEDIA_POSTING">
<intent
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<parameter
android:name="socialMediaPosting.articleBody"
android:key="articleBody"/>
<parameter
android:name="socialMediaPosting.disambiguatingDescription"
android:key="socialMediaPostingDisambiguatingdescription"/>
<parameter
android:name="socialMediaPosting.sharedContent.disambiguatingDescription"
android:key="sharedContentDisambiguatingdescription"/>
</intent>
</capability>
<!-- Short and long labels must be @string resource. -->
<shortcut
android:shortcutId="ID_ONE"
android:shortcutShortLabel="@string/shortcut_short_label"
android:shortcutLongLabel="@string/shortcut_long_label">
<capability-binding android:key="actions.intent.CREATE_SOCIAL_MEDIA_POSTING">
<parameter-binding
android:value="sharedContentDisambiguatingdescription"
android:key="socialMediaPosting.sharedContent.disambiguatingDescription"/>
</capability-binding>
</shortcut>
</shortcuts>
actions.xml
socialMediaPosting.sharedContent.disambiguatingDescription
is an
intent parameter that supports inline inventory.
By defining an <entity-set>
for socialMediaPosting.sharedContent.disambiguatingDescription
,
you can uniquely identify entities that are of interest to your app or restrict
fulfillment to the set of supported entities.
In the following example, when the user query matches the
sharedContentDisambiguatingdescription_one
entity, Assistant provides the associated identifier, ID_ONE
, as
the URL parameter sharedContentDisambiguatingdescription
to fulfillment.
If there is no inventory match, the text value received in the query for
socialMediaPosting.sharedContent.disambiguatingDescription
is passed
as-is.
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.CREATE_SOCIAL_MEDIA_POSTING">
<fulfillment urlTemplate="myapp://deeplink{?sharedContentDisambiguatingdescription}" >
<!-- sharedContentDisambiguatingdescription = "ID_ONE" or "ID_TWO" -->
<!-- If no inventory match, sharedContentDisambiguatingdescription is a text value, such as "Image" -->
<!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
<parameter-mapping urlParameter="sharedContentDisambiguatingdescription" intentParameter="socialMediaPosting.sharedContent.disambiguatingDescription" />
</fulfillment>
<!-- Define parameters with inventories here -->
<parameter name="socialMediaPosting.sharedContent.disambiguatingDescription">
<entity-set-reference entitySetId="sharedContentDisambiguatingdescriptionEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="sharedContentDisambiguatingdescriptionEntitySet">
<!-- Provide an identifier per entity -->
<entity identifier="ID_ONE" name="sharedContentDisambiguatingdescription_one" alternateName="@array/sharedContentDisambiguatingdescription_one_synonyms"/>
<entity identifier="ID_TWO" name="sharedContentDisambiguatingdescription_two" alternateName="@array/sharedContentDisambiguatingdescription_two_synonyms"/>
</entity-set>
</actions>
The url
attribute associated with the entity can be used to
determine the fulfillment URL if there is an inventory match. In the following
example, when the user query matches the
sharedContentDisambiguatingdescription_one
entity, Assistant provides myapp://deeplink/one
as the fulfillment
URL.
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.CREATE_SOCIAL_MEDIA_POSTING">
<!-- Use url from inventory match for deep link fulfillment -->
<fulfillment urlTemplate="{@url}" />
<!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
<fulfillment urlTemplate="myapp://deeplink" />
<!-- Define parameters with inventories here -->
<parameter name="socialMediaPosting.sharedContent.disambiguatingDescription">
<entity-set-reference entitySetId="sharedContentDisambiguatingdescriptionEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="sharedContentDisambiguatingdescriptionEntitySet">
<!-- Provide a URL per entity -->
<entity url="myapp://deeplink/one" name="sharedContentDisambiguatingdescription_one" alternateName="@array/sharedContentDisambiguatingdescription_one_synonyms"/>
<entity url="myapp://deeplink/two" name="sharedContentDisambiguatingdescription_two" alternateName="@array/sharedContentDisambiguatingdescription_two_synonyms"/>
</entity-set>
</actions>
JSON-LD sample
The following JSON-LD sample provides some example values that you can use in the App Actions test tool:
{ "@context": "http://schema.org", "@type": "SocialMediaPosting", "articleBody": "Having fun with friends", "disambiguatingDescription": "Post", "sharedContent": { "@type": "CreativeWork", "disambiguatingDescription": "Image" } }