books.wants_to_read Open Graph Action Type - Documentation

books.wants_to_read

An action representing someone wanting to read a book.

Create

/* make the API call */
FB.api(
    "/me/books.wants_to_read",
    "POST",
    {
        "book": "http:\/\/samples.ogp.me\/344468272304428"
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
NSDictionary *params = @{
  @"book": @"http://samples.ogp.me/344468272304428",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/me/books.wants_to_read"
                                      parameters:params
                                      HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Bundle params = new Bundle();
params.putString("book", "http://samples.ogp.me/344468272304428");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/me/books.wants_to_read",
    params,
    HttpMethod.POST,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'POST',
  '/me/books.wants_to_read',
  array (
    'book' => 'http://samples.ogp.me/344468272304428',
  )
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */

POST /v2.9/me/books.wants_to_read HTTP/1.1
Host: graph.facebook.com

book=http%3A%2F%2Fsamples.ogp.me%2F344468272304428

curl -X POST \
     -d "book=http%3A%2F%2Fsamples.ogp.me%2F344468272304428" \
        https://graph.facebook.com/v2.9/me/books.wants_to_read

Request

Name	Type	Description
FIELDS
`book`	Reference	The object representing the book
INHERITED FIELDS
`created_time`	DateTime	The time that the action was created
`end_time`	DateTime	The time that the user ended
`expires_in`	Integer	The amount of time from the publish_time that the action will expire
`fb:explicitly_shared`	Boolean	The user is explicitly sharing this action
`message`	String	A message attached to this action
`no_feed_story`	Boolean	Do not post this action to the feed
`place`	Place	The place that the action took place
`ref`	String	A <50 character string identifier for tracking and insights
`start_time`	DateTime	The time that the user started
`tags`	Array<Profile>	Any other users that performed the action

Response

Name	Type	Description
`id`	Want To Read	A Want To Read action id

Read

/* make the API call */
FB.api(
    "/me/books.wants_to_read",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/me/books.wants_to_read"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/me/books.wants_to_read",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/me/books.wants_to_read'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */

GET /v2.9/me/books.wants_to_read HTTP/1.1
Host: graph.facebook.com

curl https://graph.facebook.com/v2.9/me/books.wants_to_read

Request

Name	Type	Description
`id`	Want To Read	A Want To Read action id

Response

Name	Type	Description
FIELDS
`book`	Reference	The object representing the book
INHERITED FIELDS
`end_time`	DateTime	The time that the user ended
`image`	Array<ActionImage>
`image:url`	URL
`image:secure_url`	URL
`image:type`	String
`image:width`	Integer
`image:height`	Integer
`image:alt`	String
`image:user_generated`	Boolean
`message`	String	A message attached to this action
`no_feed_story`	Boolean	Do not post this action to the feed
`place`	Place	The place that the action took place
`publish_time`	DateTime	The time that the action was published
`ref`	String	A <50 character string identifier for tracking and insights
`start_time`	DateTime	The time that the user started
`tags`	Array<Profile>	Any other users that performed the action

Update

/* make the API call */
FB.api(
    "/id_from_create_call",
    "POST",
    {
        "book": "http:\/\/samples.ogp.me\/344468272304428"
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
NSDictionary *params = @{
  @"book": @"http://samples.ogp.me/344468272304428",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/id_from_create_call"
                                      parameters:params
                                      HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Bundle params = new Bundle();
params.putString("book", "http://samples.ogp.me/344468272304428");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/id_from_create_call",
    params,
    HttpMethod.POST,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'POST',
  '/id_from_create_call',
  array (
    'book' => 'http://samples.ogp.me/344468272304428',
  )
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */

POST /v2.9/id_from_create_call HTTP/1.1
Host: graph.facebook.com

book=http%3A%2F%2Fsamples.ogp.me%2F344468272304428

curl -X POST \
     -d "book=http%3A%2F%2Fsamples.ogp.me%2F344468272304428" \
        https://graph.facebook.com/v2.9/id_from_create_call

Request

Name	Type	Description
FIELDS
`book`	Reference	The object representing the book
INHERITED FIELDS
`end_time`	DateTime	The time that the user ended
`expires_in`	Integer	The amount of time from the publish_time that the action will expire
`message`	String	A message attached to this action
`place`	Place	The place that the action took place
`ref`	String	A <50 character string identifier for tracking and insights
`tags`	Array<Profile>	Any other users that performed the action

Response

Name	Type	Description
`id`	Want To Read	A Want To Read action id

Delete

/* make the API call */
FB.api(
    "/id_from_create_call",
    "DELETE",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/id_from_create_call"
                                      parameters:params
                                      HTTPMethod:@"DELETE"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/id_from_create_call",
    null,
    HttpMethod.DELETE,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'DELETE',
  '/id_from_create_call'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */

DELETE /v2.9/id_from_create_call HTTP/1.1
Host: graph.facebook.com

curl -X DELETE \
     -d "" \
        https://graph.facebook.com/v2.9/id_from_create_call

Request

Name	Type	Description
`id`	Want To Read	A Want To Read action id

Response

If successful, returns boolean true

true

If not successful, returns an error JSON object

{
  "error":
  {
    "message":ERROR_MESSAGE,
    "type":ERROR_TYPE,
    "code":ERROR_CODE
  }
}