- Action ID
actions.intent.GET_SOCIAL_MEDIA_PROFILE
- Description
-
View the profile of a person or organization in a social media app. First, determine the person or organization using the
socialMediaProfile.profileOwner.name
intent parameter and (if available) thesocialMediaProfile.profileOwner.description
intent parameter. The profile description parameter can contain useful information for disambiguation like the location of a person as listed on their profile.Then, open specific sections of the profile like "Pictures" or "Friends" using information from the
socialMediaProfile.profileSection.name
intent parameter, if available. Present the default profile page when this parameter isn't populated or if your app is unable to determine which section it corresponds to.
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:
socialMediaProfile.profileOwner.name
Other supported fields
The following fields represent information that users often provide to disambiguate their needs or otherwise improve their results:
socialMediaProfile.@type
socialMediaProfile.profileOwner.@type
socialMediaProfile.profileOwner.description
socialMediaProfile.profileSection.@type
socialMediaProfile.profileSection.name
Android widgets and slices
We recommend implementing Android widgets for this built-in intent. A widget presents information or interaction options from your app to improve user engagement in Google Assistant. Widgets are available for App Actions implementations using shortcuts.xml.
If you have a legacy App Actions implementation using
actions.xml, use
Android slices instead. We recommend
migrating your
implementation to shortcuts.xml
to take advantage of widgets
fulfillment and other improvements.
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.GET_SOCIAL_MEDIA_PROFILE">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<!-- Eg. profileOwnerName = "John Doe" -->
<parameter
android:name="socialMediaProfile.profileOwner.name"
android:key="profileOwnerName"/>
<!-- Eg. profileSectionName = "Pictures" -->
<parameter
android:name="socialMediaProfile.profileSection.name"
android:key="profileSectionName"/>
<!-- Eg. description = "Philadelphia" -->
<parameter
android:name="socialMediaProfile.profileOwner.description"
android:key="description"/>
</intent>
</capability>
</shortcuts>
actions.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.GET_SOCIAL_MEDIA_PROFILE">
<fulfillment urlTemplate="myapp://custom-deeplink{?profileOwnerName,profileSectionName,description}">
<!-- e.g. profileOwnerName = "John Doe" -->
<!-- (Optional) Require a field eg.profileOwnerName for fulfillment with required="true" -->
<parameter-mapping urlParameter="profileOwnerName" intentParameter="socialMediaProfile.profileOwner.name" required="true" />
<!-- e.g. profileSectionName = "Pictures" -->
<parameter-mapping urlParameter="profileSectionName" intentParameter="socialMediaProfile.profileSection.name" />
<!-- e.g. description = "Philadelphia" -->
<parameter-mapping urlParameter="description" intentParameter="socialMediaProfile.profileOwner.description" />
</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
socialMediaProfile.profileSection.name
is an
intent parameter that supports inline inventory.
By defining a <shortcut>
for socialMediaProfile.profileSection.name
,
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
profileSectionName_one
shortcut, Assistant provides the associated shorcut identifier, ID_ONE
, as
the URL parameter profileSectionName
to fulfillment.
If there is no inventory match, the text value received in the query for
socialMediaProfile.profileSection.name
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.GET_SOCIAL_MEDIA_PROFILE">
<intent
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<parameter
android:name="socialMediaProfile.profileOwner.name"
android:key="profileOwnerName"/>
<parameter
android:name="socialMediaProfile.profileSection.name"
android:key="profileSectionName"/>
<parameter
android:name="socialMediaProfile.profileOwner.description"
android:key="description"/>
</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.GET_SOCIAL_MEDIA_PROFILE">
<parameter-binding
android:value="profileSectionName"
android:key="socialMediaProfile.profileSection.name"/>
</capability-binding>
</shortcut>
</shortcuts>
actions.xml
socialMediaProfile.profileSection.name
is an
intent parameter that supports inline inventory.
By defining an <entity-set>
for socialMediaProfile.profileSection.name
,
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
profileSectionName_one
entity, Assistant provides the associated identifier, ID_ONE
, as
the URL parameter profileSectionName
to fulfillment.
If there is no inventory match, the text value received in the query for
socialMediaProfile.profileSection.name
is passed
as-is.
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.GET_SOCIAL_MEDIA_PROFILE">
<fulfillment urlTemplate="myapp://deeplink{?profileSectionName}" >
<!-- profileSectionName = "ID_ONE" or "ID_TWO" -->
<!-- If no inventory match, profileSectionName is a text value, such as "Pictures" -->
<!-- (Optional) Use entityMatchRequired="true" to require inventory match for fulfillment -->
<parameter-mapping urlParameter="profileSectionName" intentParameter="socialMediaProfile.profileSection.name" />
</fulfillment>
<!-- Define parameters with inventories here -->
<parameter name="socialMediaProfile.profileSection.name">
<entity-set-reference entitySetId="profileSectionNameEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="profileSectionNameEntitySet">
<!-- Provide an identifier per entity -->
<entity identifier="ID_ONE" name="profileSectionName_one" alternateName="@array/profileSectionName_one_synonyms"/>
<entity identifier="ID_TWO" name="profileSectionName_two" alternateName="@array/profileSectionName_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
profileSectionName_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.GET_SOCIAL_MEDIA_PROFILE">
<!-- 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="socialMediaProfile.profileSection.name">
<entity-set-reference entitySetId="profileSectionNameEntitySet"/>
</parameter>
</action>
<entity-set entitySetId="profileSectionNameEntitySet">
<!-- Provide a URL per entity -->
<entity url="myapp://deeplink/one" name="profileSectionName_one" alternateName="@array/profileSectionName_one_synonyms"/>
<entity url="myapp://deeplink/two" name="profileSectionName_two" alternateName="@array/profileSectionName_two_synonyms"/>
</entity-set>
</actions>
Use web inventory
socialMediaProfile.profileOwner.name
is a field
that supports web inventory.
In the following example, Google Assistant performs a web search for the user
query and determines the fulfillment URL. Assistant filters for search results
that match the provided urlFilter
value of
https://www.mywebsite.com/link1/.*
.
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.GET_SOCIAL_MEDIA_PROFILE">
<intent
android:action="android.intent.action.VIEW"
android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
android:targetClass="YOUR_TARGET_CLASS">
<parameter android:name="socialMediaProfile.profileOwner.name">
<data android:pathPattern="https://www.mywebsite.com/link1/.*"/>
</parameter>
<parameter android:name="socialMediaProfile.profileSection.name">
<data android:pathPattern="https://www.mywebsite.com/link2/.*"/>
</parameter>
<parameter android:name="socialMediaProfile.profileOwner.description">
<data android:pathPattern="https://www.mywebsite.com/link3/.*"/>
</parameter>
</intent>
</capability>
</shortcuts>
actions.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
<action intentName="actions.intent.GET_SOCIAL_MEDIA_PROFILE">
<!-- Use URL from entity match for deep link fulfillment -->
<!-- Example: url = 'https://www.mywebsite.com/link1/item1' -->
<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 web inventories using urlFilter -->
<parameter name="socialMediaProfile.profileOwner.name">
<entity-set-reference urlFilter="https://www.mywebsite.com/link1/.*" />"/>
</parameter>
</action>
</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.googleapis.com", "@type": "SocialMediaProfile", "profileOwner": { "@type": "Person", "description": "Philadelphia", "name": "John Doe" }, "profileSection": { "@type": "CreativeWork", "name": "Pictures" } }