books.rates

An action representing someone rating a book.

Create
/* make the API call */
FB.api(
    "/me/books.rates",
    "POST",
    {
        "rating:value": 3.1415926535,
        "rating:scale": 42,
        "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 = @{
  @"rating:value": @3.1415926535,
  @"rating:scale": @42,
  @"book": @"http://samples.ogp.me/344468272304428",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/me/books.rates"
                                      parameters:params
                                      HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
Bundle params = new Bundle();
params.putDouble("rating:value", 3.1415926535);
params.putInt("rating:scale", 42);
params.putString("book", "http://samples.ogp.me/344468272304428");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/me/books.rates",
    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.rates',
  array (
    'rating:value' => 3.1415926535,
    'rating:scale' => 42,
    'book' => 'http://samples.ogp.me/344468272304428',
  )
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
POST /v2.8/me/books.rates HTTP/1.1
Host: graph.facebook.com

rating%3Avalue=3.1415926535&rating%3Ascale=42&book=http%3A%2F%2Fsamples.ogp.me%2F344468272304428
curl -X POST \
     -d "rating%3Avalue=3.1415926535&rating%3Ascale=42&book=http%3A%2F%2Fsamples.ogp.me%2F344468272304428" \
        https://graph.facebook.com/v2.8/me/books.rates

Request

NameTypeDescription
FIELDS
bookReferenceAn object representing the book
is_draftBoolean
languageString
ratingRatingA struct describing the rating given to the b book
rating:valueFloatThe value of the rating given to the book
rating:scaleIntegerThe highest value possible in the rating scale
rating:normalized_valueFloatDeprecated
review_linkReference
review_textStringThe text content of the review
INHERITED FIELDS
created_timeDateTimeThe time that the action was created
end_timeDateTimeThe time that the user ended
expires_inIntegerThe amount of time from the publish_time that the action will expire
fb:explicitly_sharedBooleanThe user is explicitly sharing this action
messageStringA message attached to this action
no_feed_storyBooleanDo not post this action to the feed
placePlaceThe place that the action took place
refStringA <50 character string identifier for tracking and insights
start_timeDateTimeThe time that the user started
tagsArray<Profile>Any other users that performed the action

Response

NameTypeDescription
idRateA Rate action id
Read
/* make the API call */
FB.api(
    "/me/books.rates",
    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.rates"
                                      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.rates",
    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.rates'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
GET /v2.8/me/books.rates HTTP/1.1
Host: graph.facebook.com
curl https://graph.facebook.com/v2.8/me/books.rates

Request

NameTypeDescription
idRateA Rate action id

Response

NameTypeDescription
FIELDS
bookReferenceAn object representing the book
is_draftBoolean
languageString
ratingRatingA struct describing the rating given to the b book
rating:valueFloatThe value of the rating given to the book
rating:scaleIntegerThe highest value possible in the rating scale
rating:normalized_valueFloatDeprecated
review_linkReference
review_textStringThe text content of the review
INHERITED FIELDS
end_timeDateTimeThe time that the user ended
imageArray<ActionImage>
image:urlURL
image:secure_urlURL
image:typeString
image:widthInteger
image:heightInteger
image:altString
image:user_generatedBoolean
messageStringA message attached to this action
no_feed_storyBooleanDo not post this action to the feed
placePlaceThe place that the action took place
publish_timeDateTimeThe time that the action was published
refStringA <50 character string identifier for tracking and insights
start_timeDateTimeThe time that the user started
tagsArray<Profile>Any other users that performed the action
Update
/* make the API call */
FB.api(
    "/id_from_create_call",
    "POST",
    {
        "rating:value": 3.1415926535,
        "rating:scale": 42,
        "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 = @{
  @"rating:value": @3.1415926535,
  @"rating:scale": @42,
  @"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.putDouble("rating:value", 3.1415926535);
params.putInt("rating:scale", 42);
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 (
    'rating:value' => 3.1415926535,
    'rating:scale' => 42,
    'book' => 'http://samples.ogp.me/344468272304428',
  )
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
POST /v2.8/id_from_create_call HTTP/1.1
Host: graph.facebook.com

rating%3Avalue=3.1415926535&rating%3Ascale=42&book=http%3A%2F%2Fsamples.ogp.me%2F344468272304428
curl -X POST \
     -d "rating%3Avalue=3.1415926535&rating%3Ascale=42&book=http%3A%2F%2Fsamples.ogp.me%2F344468272304428" \
        https://graph.facebook.com/v2.8/id_from_create_call

Request

NameTypeDescription
FIELDS
bookReferenceAn object representing the book
is_draftBoolean
languageString
ratingRatingA struct describing the rating given to the b book
rating:valueFloatThe value of the rating given to the book
rating:scaleIntegerThe highest value possible in the rating scale
rating:normalized_valueFloatDeprecated
review_linkReference
review_textStringThe text content of the review
INHERITED FIELDS
end_timeDateTimeThe time that the user ended
expires_inIntegerThe amount of time from the publish_time that the action will expire
messageStringA message attached to this action
placePlaceThe place that the action took place
refStringA <50 character string identifier for tracking and insights
tagsArray<Profile>Any other users that performed the action

Response

NameTypeDescription
idRateA Rate 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.8/id_from_create_call HTTP/1.1
Host: graph.facebook.com
curl -X DELETE \
     -d "" \
        https://graph.facebook.com/v2.8/id_from_create_call

Request

NameTypeDescription
idRateA Rate 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
  }
}