video.rates Open Graph Action Type - Documentation

video.rates

Returns no data as of April 4, 2018.

An action representing someone rating a movie, TV show, episode or another piece of video content.

Create

/* make the API call */
FB.api(
    "/me/video.rates",
    "POST",
    {
        "rating:value": 3.1415926535,
        "rating:scale": 42,
        "episode": "http:\/\/samples.ogp.me\/335419676534648",
        "movie": "http:\/\/samples.ogp.me\/453907197960619",
        "tv_show": "http:\/\/samples.ogp.me\/413802348663468",
        "other": "http:\/\/samples.ogp.me\/467235199955838"
    },
    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,
  @"episode": @"http://samples.ogp.me/335419676534648",
  @"movie": @"http://samples.ogp.me/453907197960619",
  @"tv_show": @"http://samples.ogp.me/413802348663468",
  @"other": @"http://samples.ogp.me/467235199955838",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/me/video.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("episode", "http://samples.ogp.me/335419676534648");
params.putString("movie", "http://samples.ogp.me/453907197960619");
params.putString("tv_show", "http://samples.ogp.me/413802348663468");
params.putString("other", "http://samples.ogp.me/467235199955838");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/me/video.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 */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->post(
    '/me/video.rates',
    array (
      'rating:value' => 3.1415926535,
      'rating:scale' => 42,
      'episode' => 'http://samples.ogp.me/335419676534648',
      'movie' => 'http://samples.ogp.me/453907197960619',
      'tv_show' => 'http://samples.ogp.me/413802348663468',
      'other' => 'http://samples.ogp.me/467235199955838',
    ),
    '{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 */

POST /v3.2/me/video.rates HTTP/1.1
Host: graph.facebook.com

rating%3Avalue=3.1415926535&rating%3Ascale=42&episode=http%3A%2F%2Fsamples.ogp.me%2F335419676534648&movie=http%3A%2F%2Fsamples.ogp.me%2F453907197960619&tv_show=http%3A%2F%2Fsamples.ogp.me%2F413802348663468&other=http%3A%2F%2Fsamples.ogp.me%2F467235199955838

curl -X POST \
     -d "rating%3Avalue=3.1415926535" \
     -d "rating%3Ascale=42" \
     -d "episode=http%3A%2F%2Fsamples.ogp.me%2F335419676534648" \
     -d "movie=http%3A%2F%2Fsamples.ogp.me%2F453907197960619" \
     -d "tv_show=http%3A%2F%2Fsamples.ogp.me%2F413802348663468" \
     -d "other=http%3A%2F%2Fsamples.ogp.me%2F467235199955838" \
        https://graph.facebook.com/v3.2/me/video.rates

Request

Name	Type	Description
FIELDS
`episode`	Reference	An object representing an episode of a show
`is_draft`	Boolean
`is_hidden`	Boolean
`language`	String
`movie`	Reference	An object representing a movie
`other`	Reference	An object representing any other type of video
`rating`	Rating	A struct describing the rating given to the video
`rating:value`	Float	The value of the rating given
`rating:scale`	Integer	The highest value possible in the rating scale
`rating:normalized_value`	Float	Deprecated
`recommendation_type`	String
`review_link`	Reference
`review_text`	String	The text content of the review
`tv_show`	Reference	An object representing a TV show
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`	Rate	A Rate action id

Read

/* make the API call */
FB.api(
    "/me/video.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/video.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/video.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 */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/me/video.rates',
    '{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 */

GET /v3.2/me/video.rates HTTP/1.1
Host: graph.facebook.com

curl https://graph.facebook.com/v3.2/me/video.rates

Request

Name	Type	Description
`id`	Rate	A Rate action id

Response

Name	Type	Description
FIELDS
`episode`	Reference	An object representing an episode of a show
`is_draft`	Boolean
`is_hidden`	Boolean
`language`	String
`movie`	Reference	An object representing a movie
`other`	Reference	An object representing any other type of video
`rating`	Rating	A struct describing the rating given to the video
`rating:value`	Float	The value of the rating given
`rating:scale`	Integer	The highest value possible in the rating scale
`rating:normalized_value`	Float	Deprecated
`recommendation_type`	String
`review_link`	Reference
`review_text`	String	The text content of the review
`tv_show`	Reference	An object representing a TV show
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",
    {
        "rating:value": 3.1415926535,
        "rating:scale": 42,
        "episode": "http:\/\/samples.ogp.me\/335419676534648",
        "movie": "http:\/\/samples.ogp.me\/453907197960619",
        "tv_show": "http:\/\/samples.ogp.me\/413802348663468",
        "other": "http:\/\/samples.ogp.me\/467235199955838"
    },
    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,
  @"episode": @"http://samples.ogp.me/335419676534648",
  @"movie": @"http://samples.ogp.me/453907197960619",
  @"tv_show": @"http://samples.ogp.me/413802348663468",
  @"other": @"http://samples.ogp.me/467235199955838",
};
/* 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("episode", "http://samples.ogp.me/335419676534648");
params.putString("movie", "http://samples.ogp.me/453907197960619");
params.putString("tv_show", "http://samples.ogp.me/413802348663468");
params.putString("other", "http://samples.ogp.me/467235199955838");
/* 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 */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->post(
    '/id_from_create_call',
    array (
      'rating:value' => 3.1415926535,
      'rating:scale' => 42,
      'episode' => 'http://samples.ogp.me/335419676534648',
      'movie' => 'http://samples.ogp.me/453907197960619',
      'tv_show' => 'http://samples.ogp.me/413802348663468',
      'other' => 'http://samples.ogp.me/467235199955838',
    ),
    '{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 */

POST /v3.2/id_from_create_call HTTP/1.1
Host: graph.facebook.com

rating%3Avalue=3.1415926535&rating%3Ascale=42&episode=http%3A%2F%2Fsamples.ogp.me%2F335419676534648&movie=http%3A%2F%2Fsamples.ogp.me%2F453907197960619&tv_show=http%3A%2F%2Fsamples.ogp.me%2F413802348663468&other=http%3A%2F%2Fsamples.ogp.me%2F467235199955838

curl -X POST \
     -d "rating%3Avalue=3.1415926535" \
     -d "rating%3Ascale=42" \
     -d "episode=http%3A%2F%2Fsamples.ogp.me%2F335419676534648" \
     -d "movie=http%3A%2F%2Fsamples.ogp.me%2F453907197960619" \
     -d "tv_show=http%3A%2F%2Fsamples.ogp.me%2F413802348663468" \
     -d "other=http%3A%2F%2Fsamples.ogp.me%2F467235199955838" \
        https://graph.facebook.com/v3.2/id_from_create_call

Request

Name	Type	Description
FIELDS
`episode`	Reference	An object representing an episode of a show
`is_draft`	Boolean
`is_hidden`	Boolean
`language`	String
`movie`	Reference	An object representing a movie
`other`	Reference	An object representing any other type of video
`rating`	Rating	A struct describing the rating given to the video
`rating:value`	Float	The value of the rating given
`rating:scale`	Integer	The highest value possible in the rating scale
`rating:normalized_value`	Float	Deprecated
`recommendation_type`	String
`review_link`	Reference
`review_text`	String	The text content of the review
`tv_show`	Reference	An object representing a TV show
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`	Rate	A 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 */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->delete(
    '/id_from_create_call',
    array (),
    '{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 */

DELETE /v3.2/id_from_create_call HTTP/1.1
Host: graph.facebook.com

curl -X DELETE \
        https://graph.facebook.com/v3.2/id_from_create_call

Request

Name	Type	Description
`id`	Rate	A 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
  }
}