Hide
Search Results

Appendix A: Parameters

The following tables describe parameters passed by the YAP engine to an App at runtime.

User Information

Information Source HTTP Request Variable Description
Viewer Information Cookie in the Session POST yap_viewer_guid GUID of the person signed in to Yahoo! in the browser.
Owner Information Owner of the Profile POST yap_owner_guid GUID of the person whose identity information is in the Profile.
Page Language Requested Publisher HEADER Accept-Language Language priority list as defined in RFC 2616 section 14.4, with quality values assigned so as to maintain the priority order of the list provided by the publisher.
Page Language Requested Publisher GET/POST lang Use the lang query parameter to select the language used to display response data. The lang parameter has preference over the Accept-Language header. If the lang parameter is not present, the Accept-Language header is used.
Page Location Publisher GET/POST country The ISO 3166-1 alpha-2 country code identifying the region where the page is viewed.
Page Timezone Publisher POST yap_tz Timezone Identifier, e.g., ‘Asia/Seoul’.
Page Jurisdiction Publisher POST yap_jurisdiction ISO 3166 country code identifying the country whose rules should be used for content moderation.
Game Site URL Publisher GET/POST yap_game_site_url The game URL. Does not apply to My Yahoo! or Yahoo! Messenger drop zones.

Session Information

Information Source HTTP Request Variable Description
Viewer’s Access Token Registration and YAP GET yap_viewer_access_token OAuth 1.1 Access Token
Viewer’s Access Token Secret Registration and YAP GET yap_viewer_access_token_secret OAuth 1.1 Token Secret
AppID YAP POST yap_appid Application ID
Dropzone Publisher POST yap_dropzone_id

The ID of the Yahoo! property, such as Yahoo! Finance, where the application will appear. The following lists the dropzone IDs and the associated Yahoo! properties:

852096 - My Yahoo! 854400 - Yahoo! Messenger 854912 - Yahoo! Games

Authentication

Information Source HTTP Request Variable Description
Consumer Key YAP Engine POST yap_consumer_key OAuth 1.0a Consumer Key
Request Time YAP Engine POST yap_time Timestamp of the request in Unix time.
Request Signature Method YAP Engine POST oauth_signature_method HMAC_SHA1 signature method
Request Signature YAP Engine POST oauth_signature OAuth 1.0a Signature
OAuth Hash Algorithm YAP Engine GET oauth_body_hash The body hash algorithm is determined by the OAuth signature method used.If the OAuth signature method is HMAC-SHA1 or RSA-SHA1, SHA1 [RFC3174] MUST be used as the body hash algorithm.If the OAuth signature method is PLAINTEXT, use of this specification provides no security benefit and is NOT RECOMMENDED.
Consumer Key YAP Engine GET/POST oauth_consumer_key OAuth 1.0a Consumer Key
OAuth Nonce Value YAP Engine GET/POST oauth_nonce A random string used to uniquely identify a request and required by the OAuth Core 1.0 Spec, Section 8.
Request Signature YAP Engine GET/POST oauth_signature OAuth 1.0a Signature
Request Signature Method YAP Engine GET/POST oauth_signature_method The signature method used to sign the request.
Request Time YAP Engine GET/POST oauth_timestamp Current timestamp of the request. This value must be +-600 seconds of the current time.
OAuth Version YAP Engine GET/POST oauth_version The OAuth version being used. YAP uses OAuth 1.0 Revision A.

Browser Information

Information Source HTTP Request Variable Description
User Agent Browser HEADER HTTP_USER_AGENT Retrieves information about the users browser and computer operating system
Accept Browser HEADER HTTP_ACCEPT Contents of the Accept: header from the current request, if there is one.
Accept Encoding Browser HEADER HTTP_ACCEPT_ENCODING Retrieves a list of compression encodings that the browser supports.
User Agent Browser GET yui_ua Gets information about the browser and operating system of the user.

View Information

Information Source HTTP Request Variable Description
View Publisher POST yap_view The request is targeted to either the Small View or Canvas View.

OpenSocial Information

Information Source HTTP Request Variable Description
Application ID Registration and YAP GET opensocial_app_id The application ID that is obtained during application registration.
Gadget URL Registration and YAP GET opensocial_app_url The absolute URL to the gadget for the current view of the application.
Owner GUID Owner of the Profile GET opensocial_owner_id The GUID of the application owner.
Content Proxy YAP Engine GET opensocial_proxied_content Indicates if the gadget has proxied content. The value is 1 if there is proxied content and 0 if there is no proxied content.
User GUID Cookie in Session GET opensocial_viewer_id The GUID of the user viewing the application.

Table of Contents