Graph API Version

Video Copyright Rule

For more information about the Rights Manager API, check out our Rights Manager API intro docs.

Reading

A video copyright rules

Examples

Graph API Explorer
GET /v2.10/{video-copyright-rule-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{video-copyright-rule-id}'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
/* make the API call */
FB.api(
    "/{video-copyright-rule-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{video-copyright-rule-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{video-copyright-rule-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription

id

numeric string

The id of video copyright rules object

condition_groups

list<VideoCopyrightConditionGroup>

Groups of conditions on the rules object

copyrights

list<numeric string>

Copyrights associated with this copyright rules object

created_date

datetime

The date on which the rule was created

creator

The person who created the match rule

is_in_migration

bool

Whether or not the rule is in migration

is_new_version_rule

bool

Whether or not the rule is version 2

name

string

Name of the video copyright rules object

Edges

No edges

Validation Rules

ErrorDescription
100Invalid parameter

Creating

You can make a POST request to video_copyright_rule edge from the following paths:
When posting to this edge, a VideoCopyrightRule will be created.

Parameters

NameDescription
condition_groups
list<Condition Group>

A list of condition groups that specify conditions for an action.

Required
action
enum {ALLOW, MANUAL_REVIEW, TRACK, BLOCK, TAKEDOWN, MONETIZE, ACQUIRE_VIEWS_AND_MONETIZE}

The action to be performed on a match if any of the conditions pass.

Required
conditions
list<Condition>

A list of conditions to be evaluated.

type
enum {GEO, MONITORING_TYPE, OVERLAP_DURATION, MATCH_OVERLAP_PERCENTAGE, REFERENCE_OVERLAP_PERCENTAGE, PRIVACY}

The type of condition to be evaluated.

Required
operator
enum {IS, IS_NOT, IN_SET, NOT_IN_SET, LESS_THAN, GREATER_THAN}

The operator for the evaluation, which varies depending on the condition type.

  • CONTENT_TYPE: IS
  • GEO: IN_SET, NOT_IN_SET
  • OVERLAP_DURATION: GREATER_THAN, LESS_THAN
  • Required
    value
    array<string> | int | string

    The value for this condition, which varies depending on the condition type.

  • CONTENT_TYPE: One or more of VIDEO_ONLY, AUDIO_ONLY or VIDEO_AND_AUDIO
  • GEO: A string array of ISO 3166 format country codes
  • OVERLAP_DURATION: An integer representing milliseconds of overlap
  • Required
    name
    string

    The name of the rule, as specified by the user.

    Required

    Return Type

    This endpoint supports read-after-write and will read the node represented by id in the return type.
    Struct {
    id: numeric string,
    }

    Validation Rules

    ErrorDescription
    100Invalid parameter

    Updating

    You can update a VideoCopyrightRule by making a POST request to /{video_copyright_rule_id}.

    Parameters

    NameDescription
    excluded_copyright_ids
    list<numeric string or integer>

    The IDs of the video copyrights user wants to exclude in the move.

    migration_rule_id
    numeric string or integer

    The ID of the rule to which all referenced assets of this rule will move.

    Return Type

    This endpoint supports read-after-write and will read the node represented by id in the return type.
    Struct {
    id: numeric string,
    }

    Validation Rules

    ErrorDescription
    100Invalid parameter

    Deleting

    You can delete a VideoCopyrightRule by making a DELETE request to /{video_copyright_rule_id}.

    Parameters

    This endpoint doesn't have any parameters.

    Return Type

    Struct {
    success: bool,
    }

    Validation Rules

    ErrorDescription
    100Invalid parameter