Facebook Methods description: photos.getTags
Returns the set of user tags on all photos specified.
Parameters
| string | api_key | The application key associated with the calling application. |
| string | session_key | The session key of the logged in user. |
| float | call_id | The request’s sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP’s microtime(true) function. |
| string | sig | An MD5 hash of the current request and your secret key, as described in the authentication guide. |
| string | v | This must be set to 1.0 to use this version of the API. |
| string | format | Optional - desired response format. Either “XML” (default) or “JSON”. |
| string | callback | Optional - wrap the response inside a function call. This is primarily to enable cross-domain javascript requests using the <script> tag, sometimes known as “JSONP“. This works with both XML and JSON. |
| array | pids | The list of photos from which to extract photo tags. This is a comma-separated list of pids. |
Example Return XML
<?xml version="1.0" encoding="UTF-8"?>
<photos_getTags_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd" list="true">
<photo_tag>
<pid>34995991612795</pid>
<subject>1240078</subject>
<text>Person McTagged</text>
<xcoord>51.4901</xcoord>
<ycoord>23.6203</ycoord>
<created>1189113563</created>
</photo_tag>
</photos_getTags_response>
Response
If no photo tags are found, the method will return an empty photos_getTags_response element. Text tags not corresponding to a user are not currently returned. Note that some tags may be text-only and will have an empty subect element. This occurs in the case where a user did not specifically tag another account, but just supplied text information.
Privacy note: A tag of a user will be visible to an application only if that user has not turned off access to the Facebook Platform.
FQL Equivalent
This function is similar to doing the following FQL query, with the appropriate parameters filled in:
SELECT pid, subject, text, xcoord, ycoord, created FROM photo_tag WHERE pid IN (pids)
Error codes
| 1 | An unknown error occurred. Please resubmit the request. |
| 2 | The service is not available at this time. |
| 4 | The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed. |
| 5 | The request came from a remote address not allowed by this application. |
| 100 | One of the parameters specified was missing or invalid. |
| 101 | The api key submitted is not associated with any known application. |
| 102 | The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key. |
| 103 | The submitted call_id was not greater than the previous call_id for this session. |
| 104 | Incorrect signature. |
Tags: methods, photos.getTags()
Related Post
No Comments
No comments yet.
Comments RSS TrackBack Identifier URI
Leave a comment