Difference between revisions of "OpenSocial RequiredFields"

From VZ Developer Wiki
Jump to: navigation, search
(OpenSocial Required Fields (Available (Will be released on 2011-01-17))
(OpenSocial Required Fields (Available (Will be released on 2011-01-17))
Line 35: Line 35:
 
* platform
 
* platform
 
However, including one or more of these fields within the 'RequiredFields' section will enhance the user experience by not showing unused information.  
 
However, including one or more of these fields within the 'RequiredFields' section will enhance the user experience by not showing unused information.  
Conclusion: '''Always specify your required fields!'''
+
Conclusion: '''Always specify your field requirements!'''
  
 
=== What's in for me? ===
 
=== What's in for me? ===

Revision as of 13:28, 20 December 2010

OpenSocial Required Fields (Available (Will be released on 2011-01-17)

If your gadget is taking advantage of OpenSocial functionalities and is therefore declared as a social gadget with 'opensocial-x.x' as required:

 <Require feature="opensocial-0.9"/>

you might consider restricting the vCard fields your gadget is requesting from the user's personal data. The available field names are

  • gender
  • birthday
  • emails
  • addresses
  • phoneNumbers
  • thumbnailUrl
  • photos

Applied in a gadget.xml snipplet, requesting the fields gender, emails, and the thumbnail URL will look as follows

 <Require feature="opensocial-0.8">
        <RequiredFields>
                <Field>gender</Field>
                <Field>emails</Field>
                <Field>thumbnailUrl</Field>
        </RequiredFields>
</Require>

The following fields will be available right away since they are within the implicit minimal field requirements

  • id
  • name
  • profileUrl
  • published
  • updated
  • name
  • platform

However, including one or more of these fields within the 'RequiredFields' section will enhance the user experience by not showing unused information. Conclusion: Always specify your field requirements!

What's in for me?

Specifying your field requirements upfront has the following advantages

  • Higher conversion rate
    • During installation only the requested fields will be shown. The less fields he/she is asked to fill out, the more likely he/she will install your gadget as opposed to leave the installation process because of being overwhelmed by too many questions.
  • You can ask for more at any time
    • If your business logic changes or you want to ask the user's permission for other fields any time later, you can simply request those fields in future. The user will only be asked to fill out the field(s) you ask for as complementary data to the already existing information.