Facebook SDK for Python¶

get_object¶

Returns the given object from the graph as a dict. A list of supported objects can be found here.

Parameters

• id – A string that is a unique ID for that particular resource.
• **args (optional) - keyword args to be passed as query params

Example

post = graph.get_object(id='post_id')
print(post['message'])

event = graph.get_object(id='event_id', fields='attending_count,declined_count')
print(event['attending_count'])
print(event['declined_count'])

get_objects¶

Returns all of the given objects from the graph as a dict. Each given ID maps to an object.

Parameters

• ids – A list containing IDs for multiple resources.
• **args (optional) - keyword args to be passed as query params

Example

post_ids = ['post_id_1', 'post_id_2']
posts = graph.get_objects(ids=post_ids)

# Each given id maps to an object.
for post_id in post_ids:
    print(posts[post_id]['created_time'])

event_ids = ['event_id_1', 'event_id_2']
events = graph.get_objects(ids=event_ids, fields='attending_count,declined_count')

# Each given id maps to an object the contains the requested fields.
for event_id in event_ids:
    print(posts[event_id]['declined_count'])

get_connections¶

Returns all connections for a given object as a dict.

Parameters

• id – A string that is a unique ID for that particular resource.
• connection_name - A string that specifies the connection or edge between objects, e.g., feed, friends, groups, likes, posts. If left empty, get_connections will simply return the authenticated user’s basic information.

Example

# Get all of the authenticated user's friends
friends = graph.get_connections(id='me', connection_name='friends')

# Get all the comments from a post
comments = graph.get_connections(id='post_id', connection_name='comments')

put_object¶

Writes the given object to the graph, connected to the given parent.

Parameters

• parent_object – A string that is a unique ID for that particular resource. The parent_object is the parent of a connection or edge. E.g., profile is the parent of a feed, and a post is the parent of a comment.
• connection_name - A string that specifies the connection or edge between objects, e.g., feed, friends, groups, likes, posts.

Example

# Writes 'Hello, world' to the active user's wall.
graph.put_object(parent_object='me', connection_name='feed',
                 message='Hello, world')

# Writes a comment on a post
graph.put_object(parent_object='post_id', connection_name='comments',
                 message='First!')

put_wall_post¶

Writes a wall post to the given profile’s wall. It defaults to writing to the authenticated user’s wall if no profile_id is specified.

Parameters

• message - A string that will be posted to the user’s wall.
• attachment - A dict that adds a structured attachment to the message being posted to the Wall. If you are sharing a URL, you will want to use the attachment parameter so that a thumbnail preview appears in the post. It should be a dict of the form:

 attachment =  {
     'name': '',
     'link': '',
     'caption': '',
     'description': '',
     'picture': ''
}

• profile_id - A string that is a unique ID for that particular user. Defaults to the authenticated user’s wall.

Example

attachment =  {
    'name': 'Link name'
    'link': 'https://www.example.com/',
    'caption': 'Check out this example',
    'description': 'This is a longer description of the attachment',
    'picture': 'https://www.example.com/thumbnail.jpg'
}

graph.put_wall_post(message='Check this out...', attachment=attachment)

put_comment¶

Writes the given message as a comment on an object.

Parameters

• object_id - A string that is a unique id for a particular resource.
• message - A string that will be posted as the comment.

Example

graph.put_comment(object_id='post_id', message='Great post...')

put_like¶

Writes a like to the given object.

Parameters

• object_id - A string that is a unique id for a particular resource.

Example

graph.put_like(object_id='comment_id')

put_photo¶

https://developers.facebook.com/docs/graph-api/reference/user/photos#publish

Upload an image using multipart/form-data. Returns JSON with the IDs of the photo and its post.

Parameters

• image - A file object representing the image to be uploaded.
• album_path - A path representing where the image should be uploaded. Defaults to /me/photos which creates/uses a custom album for each Facebook application.

Example

# Upload an image with a caption.
graph.put_photo(image=open('img.jpg', 'rb'), message='Look at this cool photo!')
# Upload a photo to an album.
graph.put_photo(image=open("img.jpg", 'rb'), album_path=album_id + "/photos")
# Upload a profile photo for a Page.
graph.put_photo(image=open("img.jpg", 'rb'), album_path=page_id + "/picture")

delete_object¶

Deletes the object with the given ID from the graph.

Parameters

• id - A string that is a unique ID for a particular resource.

Example

graph.delete_object(id='post_id')