Represents an individual photo on Facebook.
This represents a Photo on Facebook.
user_photos
or user_posts
permission.user_photos
or user_posts
permission. However, in some cases the photo's owner's privacy settings may not allow your application to access it.Name | Description |
---|---|
Page Public Content Access | This feature permission may be required. |
GET /v21.0/{photo-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
// Returns a `Facebook\FacebookResponse` object
$response = $fb->get(
'/{photo-id}',
'{access-token}'
);
} catch(Facebook\Exceptions\FacebookResponseException $e) {
echo 'Graph returned an error: ' . $e->getMessage();
exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
echo 'Facebook SDK returned an error: ' . $e->getMessage();
exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
"/{photo-id}",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/{photo-id}",
null,
HttpMethod.GET,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"/{photo-id}"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];
Field | Description |
---|---|
id numeric string | The photo ID |
alt_text string | Accessible alternative description for an image |
alt_text_custom string | User provided accessible alternative description for an image |
backdated_time datetime | A user-specified time for when this object was created |
backdated_time_granularity enum | How accurate the backdated time is |
can_backdate bool | Indicates whether the viewer can backdate the photo |
can_delete bool | Indicates whether the viewer can delete the photo |
can_tag bool | Indicates whether the viewer can tag the photo |
created_time datetime | The time this photo was published |
If this object has a place, the event associated with the place | |
from User|Page | The profile (user or page) that uploaded this photo |
height unsigned int32 | The height of this photo in pixels |
icon string | The icon that Facebook displays when photos are published to News Feed |
images | The different stored representations of the photo. Can vary in number based upon the size of the original photo. |
link string | A link to the photo on Facebook |
name string | The user-provided caption given to this photo. Corresponds to |
name_tags | An array containing an array of objects mentioned in the name field which contain the id, name, and type of each object as well as the offset and length which can be used to match it up with its corresponding string in the name field |
page_story_id string | ID of the page story this corresponds to. May not be on all photos. Applies only to published photos |
place | Place info |
position unsigned int32 | Deprecated. Returns 0 Deprecated |
source string | Deprecated. Use Deprecated |
target | The target this photo is published to |
updated_time datetime | The last time the photo was updated |
webp_images | The different stored representations of the photo in webp format. Can vary in number based upon the size of the original photo. |
width unsigned int32 | The width of this photo in pixels |
Edge | Description |
---|---|
Edge<InsightsResult> | Insights data |
Edge<Profile> | People who like this |
Edge<ProfilePictureSource> | Link to the 100px wide representation of this photo |
Edge<Page> | Sponsor pages tagged in the photo. |
Error | Description |
---|---|
100 | Invalid parameter |
200 | Permissions error |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
80001 | There have been too many calls to this Page account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting. |
190 | Invalid OAuth 2.0 Access Token |
104 | Incorrect signature |
3001 | Invalid query |
459 | The session is invalid because the user has been checkpointed |
2500 | Error parsing graph query |
Animated photos are not supported, and a photo must be less than 10MB in size.
Note: the post_id
value is not returned for photos added to Albums.
photos
edge from the following paths: Parameter | Description |
---|---|
aid string | Legacy album ID. Deprecated |
allow_spherical_photo boolean | Default value: false Indicates that we should allow this photo to be treated as a spherical photo. This will not change the behavior unless the server is able to interpret the photo as spherical, such as via Photosphere XMP metadata. Regular non-spherical photos will still be treated as regular photos even if this parameter is true. |
alt_text_custom string | Accessible alternative description for an image |
android_key_hash string | Android key hash |
application_id non-empty string | iTunes App ID. This is used by the native Share dialog that's part of iOS |
attempt int64 | Default value: 0 Number of attempts that have been made to upload this photo |
audience_exp boolean | Default value: false Audience exp |
backdated_time datetime/timestamp | A user-specified creation time for this photo |
backdated_time_granularity enum{year, month, day, hour, min, none} | Default value: none Use only the part of the |
caption string | The description of the photo |
composer_session_id string | Composer session ID |
direct_share_status int64 | The status to allow sponsor directly boost the post. |
feed_targeting feed target | Object that controls News Feed targeting for this post. Anyone in these groups will be more likely to see this post. People not in these groups will be less likely to see this post, but may still see it anyway. Any of the targeting fields shown here can be used, but none are required. |
filter_type int64 | Default value: -1 Unused? |
full_res_is_coming_later boolean | Default value: false Full res is coming later |
initial_view_heading_override_degrees int64 | Manually specify the initial view heading in degrees from 0 to 360. This overrides any value present in the photo embedded metadata or provided in the spherical_metadata parameter |
initial_view_pitch_override_degrees int64 | Manually specify the initial view pitch in degrees from -90 to 90. This overrides any value present in the photo embedded metadata or provided in the spherical_metadata parameter |
initial_view_vertical_fov_override_degrees int64 | Manually specify the initial view vertical FOV in degrees from 60 to 120. This overrides any value present in the photo embedded metadata or provided in the spherical_metadata parameter |
ios_bundle_id string | iOS Bundle ID |
is_explicit_location boolean | Is this an explicit location? |
is_explicit_place boolean | If set to |
manual_privacy boolean | Default value: false Manual privacy |
message string | Deprecated. Please use the caption param instead. |
name string | Deprecated. Please use the caption param instead. |
no_story boolean | If set to |
offline_id int64 | Default value: 0 Offline ID |
og_action_type_id numeric string | The Open Graph action type |
og_icon_id numeric string | The Open Graph icon |
og_object_id OG object ID or URL string | The Open Graph object ID |
og_phrase string | The Open Graph phrase |
og_set_profile_badge boolean | Default value: false Flag to set if the post should create a profile badge |
og_suggestion_mechanism string | The Open Graph suggestion |
place place tag | Page ID of a place associated with the photo |
privacy Privacy Parameter | Determines the privacy settings of the photo. If not supplied, this defaults to the privacy level granted to the app in the Login dialog. This field cannot be used to set a more open privacy setting than the one granted |
profile_id int | Deprecated. Use Deprecated |
proxied_app_id numeric string or integer | Proxied app ID |
published boolean | Default value: true Set to |
qn string | Photos waterfall ID |
spherical_metadata JSON object | A set of params describing an uploaded spherical photo. This field is not required; if it is not present we will try to generate spherical metadata from the metadata embedded in the image. If it is present, it takes precedence over any embedded metadata. Please click to the left to expand this list and see more information on each parameter. See also the Google Photo Sphere spec for more info on the meaning of the params: https://developers.google.com/streetview/spherical-metadata |
sponsor_id numeric string or integer | Facebook Page id that is tagged as sponsor in the photo post |
sponsor_relationship int64 | Sponsor Relationship, such as Presented By or Paid PartnershipWith |
tags list<Object> | Tags on this photo |
target_id int | Don't use this. Specifying a |
targeting target | Allows you to target posts to specific audiences. Applies to Pages only |
time_since_original_post int64 | Same as |
uid int | Deprecated |
unpublished_content_type enum {SCHEDULED, SCHEDULED_RECURRING, DRAFT, ADS_POST, INLINE_CREATED, PUBLISHED, REVIEWABLE_BRANDED_CONTENT} | Content type of the unpublished content type |
url string | The URL of a photo that is already uploaded to the Internet. You must specify this or a file attachment |
user_selected_tags boolean | Default value: false User selected tags |
vault_image_id numeric string or integer | A vault image ID to use for a photo. You can use only one of |
id
in the return type.id
: numeric string, post_id
: token with structure: Post ID, Error | Description |
---|---|
190 | Invalid OAuth 2.0 Access Token |
321 | Album is full |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
200 | Permissions error |
220 | Album or albums not visible |
100 | Invalid parameter |
324 | Missing or invalid image file |
photos
edge from the following paths: Parameter | Description |
---|---|
aid string | Legacy album ID. Deprecated |
allow_spherical_photo boolean | Default value: false Indicates that we should allow this photo to be treated as a spherical photo. This will not change the behavior unless the server is able to interpret the photo as spherical, such as via Photosphere XMP metadata. Regular non-spherical photos will still be treated as regular photos even if this parameter is true. |
alt_text_custom string | Accessible alternative description for an image |
android_key_hash string | Android key hash |
application_id non-empty string | iTunes App ID. This is used by the native Share dialog that's part of iOS |
attempt int64 | Default value: 0 Number of attempts that have been made to upload this photo |
audience_exp boolean | Default value: false Audience exp |
backdated_time datetime | A user-specified creation time for this photo |
backdated_time_granularity enum{year, month, day, hour, min, none} | Default value: none Use only the part of the |
caption UTF-8 string | The description of the photo Supports Emoji |
composer_session_id string | Composer session ID |
direct_share_status int64 | The status to allow sponsor directly boost the post. |
feed_targeting feed target | Object that controls News Feed targeting for this post. Anyone in these groups will be more likely to see this post. People not in these groups will be less likely to see this post, but may still see it anyway. Any of the targeting fields shown here can be used, but none are required. |
filter_type int64 | Default value: -1 Unused? |
full_res_is_coming_later boolean | Default value: false Full res is coming later |
initial_view_heading_override_degrees int64 | Manually specify the initial view heading in degrees from 0 to 360. This overrides any value present in the photo embedded metadata or provided in the spherical_metadata parameter |
initial_view_pitch_override_degrees int64 | Manually specify the initial view pitch in degrees from -90 to 90. This overrides any value present in the photo embedded metadata or provided in the spherical_metadata parameter |
initial_view_vertical_fov_override_degrees int64 | Manually specify the initial view vertical FOV in degrees from 60 to 120. This overrides any value present in the photo embedded metadata or provided in the spherical_metadata parameter |
ios_bundle_id string | iOS Bundle ID |
is_explicit_location boolean | Is this an explicit location? |
is_explicit_place boolean | If set to |
location_source_id numeric string or integer | ID of a page or a page set that provides location informationto enable Local Extensions |
manual_privacy boolean | Default value: false Manual privacy |
message string | Deprecated. Please use the caption param instead. |
name string | Deprecated. Please use the caption param instead. |
nectar_module string | Nectar module. Internal apps only |
no_story boolean | If set to |
offline_id int64 | Default value: 0 Offline ID |
og_action_type_id numeric string or integer | The Open Graph action type |
og_icon_id numeric string or integer | The Open Graph icon |
og_object_id OG object ID or URL string | The Open Graph object ID |
og_phrase string | The Open Graph phrase |
og_set_profile_badge boolean | Default value: false Flag to set if the post should create a profile badge |
og_suggestion_mechanism string | The Open Graph suggestion |
place place tag | Page ID of a place associated with the photo |
privacy Privacy Parameter | Determines the privacy settings of the photo. If not supplied, this defaults to the privacy level granted to the app in the Login dialog. This field cannot be used to set a more open privacy setting than the one granted |
profile_id int | Deprecated. Use Deprecated |
proxied_app_id numeric string or integer | Proxied app ID |
published boolean | Default value: true Set to |
qn string | Photos waterfall ID |
scheduled_publish_time int64 | Time at which an unpublished post should be published (Unix timestamp). Applies to Pages only |
spherical_metadata JSON object | A set of params describing an uploaded spherical photo. This field is not required; if it is not present we will try to generate spherical metadata from the metadata embedded in the image. If it is present, it takes precedence over any embedded metadata. Please click to the left to expand this list and see more information on each parameter. See also the Google Photo Sphere spec for more info on the meaning of the params: https://developers.google.com/streetview/spherical-metadata |
sponsor_id numeric string or integer | Facebook Page id that is tagged as sponsor in the photo post |
sponsor_relationship int64 | Sponsor Relationship, such as Presented By or Paid PartnershipWith |
tags list<Object> | Default value: Vec Tags on this photo |
target_id int | Don't use this. Specifying a |
targeting target | Allows you to target posts to specific audiences. Applies to Pages only |
temporary boolean | Default value: false This is a temporary photo. |
time_since_original_post int64 | Same as |
uid int | Deprecated |
unpublished_content_type enum {SCHEDULED, SCHEDULED_RECURRING, DRAFT, ADS_POST, INLINE_CREATED, PUBLISHED, REVIEWABLE_BRANDED_CONTENT} | Content type of the unpublished content type |
url URL | The URL of a photo that is already uploaded to the Internet. You must specify this or a file attachment |
user_selected_tags boolean | Default value: false User selected tags |
vault_image_id numeric string or integer | A vault image ID to use for a photo. You can use only one of |
id
in the return type.id
: numeric string, post_id
: string, Error | Description |
---|---|
368 | The action attempted has been deemed abusive or is otherwise disallowed |
190 | Invalid OAuth 2.0 Access Token |
200 | Permissions error |
100 | Invalid parameter |
324 | Missing or invalid image file |
80001 | There have been too many calls to this Page account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting. |
240 | Desktop applications cannot call this function for other users |
An app can delete any photos it published, or a page-management app can delete a Photo published to a page that the app manages.
publish_actions
permission is required.publish_pages
permission is required. /{photo_id}
.success
: bool, Error | Description |
---|---|
100 | Invalid parameter |
190 | Invalid OAuth 2.0 Access Token |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
200 | Permissions error |