Photos.getAlbums
From Facebook Developer Wiki
Contents |
Description
Returns metadata about all of the photo albums uploaded by the specified user.
This method returns information from all visible albums satisfying the filters specified. The method can be used to return all photo albums created by a user, query a specific set of albums by a list of aids, or filter on any combination of these two.
This call does return a user's profile picture album. However, you cannot upload photos to this album using photos.upload. You can determine whether an album is the profile album by comparing the album cover pid with the user's profile picture pid. If they are the same pid, then that's the profile picture album. Also, see the Notes below for another way of returning the profile picture album.
You cannot store the values returned from this call.
Parameters
| Required | Name | Type | Description | |
| required | api_key | string | The application key associated with the calling application. If you specify the API key in your client, you don't need to pass it with every call. | |
|---|---|---|---|---|
| session_key | string | The session key of the logged in user. The session key is automatically included by our PHP client. | ||
| call_id | float | 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. If you specify the call ID in your client, you don't need to pass it with every call. | ||
| sig | string | An MD5 hash of the current request and your secret key, as described in the How Facebook Authenticates Your Application. Facebook computes the signature for you automatically. | ||
| v | string | This must be set to 1.0 to use this version of the API. If you specify the version in your client, you don't need to pass it with every call. | ||
| uid | int | Return albums created by this user. You must specify either uid or aids. The uid parameter has no default value. | ||
| aids | array | Return albums with aids in this list. This is a comma-separated list of aids. You must specify either uid or aids. The aids parameter has no default value. | ||
| optional | format | string | The desired response format, which can be either XML or JSON. (Default value is XML.) | |
| callback | string | Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter. |
Example Requests
This is using the PHP library
Response
The album IDs (aids) returned by this function can be passed in to photos.get.
Privacy note: In this call, an album owned by a user gets returned to an application if that user has not turned off access to the Facebook Platform.
Example Return XML
FQL Equivalent
FQL queries take the form: SELECT <fields> FROM <table> WHERE <conditions>
This function is similar to doing the following FQL query, with the appropriate parameters filled in (for example, using an actual user ID in place of <uid>):
Error Codes
| Code | Description | |
| 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. |
Notes
- You can return a user's Profile archive album -- the place where the user's profile pictures are stored -- by specifying -3 for the
aidparameter. - The
visiblefield indicates who can see the album. The values can befriends,friends-of-friends,networks,everyone, orcustom(if the visibility doesn't match any of these values). This information is available only to the album owner. - You can call this method using a session secret, and not the application secret (for example, for a Facebook Connect site or desktop application).
