Facebook Methods description: photos.addTag
Adds a tag with the given information to a photo. See photo uploads for a description of the upload workflow.
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. |
| int | pid | The photo id of the photo to be tagged. |
| int | tag_uid | The user id of the user being tagged. Either tag_uid or tag_text must be specified. |
| string | tag_text | Some text identifying the person being tagged. Either tag_uid or tag_text must be specified. This parameter is ignored if tag_uid is specified. |
| float | x | The horizontal position of the tag, as a percentage from 0 to 100, from the left of the photo. |
| float | y | The vertical position of the tag, as a percentage from 0 to 100, from the top of the photo. |
| string | tags | A JSON-serialized array representing a list of tags to be added to the photo. If the tags parameter is specified, the x, y, tag_uid, and tag_text parameters are ignored. Each tag in the list must specify: “x”, “y”, and either the user id “tag_uid” or free-form “tag_text” identifying the person being tagged. An example of this is the string[{"x":"30.0","y":"30.0","tag_uid":1234567890}, {"x":"70.0","y":"70.0","tag_text":"some person"}]. |
Tags can only be added to pending photos owned by the current session user. Once a photo has been approved or rejected, it can no longer be tagged with this method. There is a limit of 20 tags per pending photo.
Example Return XML
<?xml version="1.0" encoding="UTF-8"?> <photos_addTag_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">1</photos_addTag_response>
Error codes
| 1 | An unknown error occurred. Please resubmit the request. |
| 2 | The service is not available at this time. |
| 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. |
| 110 | Invalid user id. |
| 121 | Invalid photo id. |
| 322 | Invalid photo tag subject. |
| 323 | Cannot tag photo already visible on Facebook. |
| 326 | Too many photo tags pending. |
Tags: methods, photos.addTag()
Related Post
No Comments
No comments yet.
Comments RSS TrackBack Identifier URI
Leave a comment