admin.setRestrictionInfo

Please note: We are in the process of deprecating the REST API, have added equivalent support to the Graph API for this method. You can retrieve and modify the Restrictions for your App by working with the 'restrictions' connection of the Application object

Sets the demographic restrictions for the application. This call lets you restrict users at the application level. If you want to restrict only a portion of your application's content, use the fb:restricted-to tag instead.

If the user doesn't match the age and location requirements, then the user cannot see the application at all. If the user's age is hidden for privacy reasons, Facebook still determines whether or not the application is visible to the user.

You should make this call only as needed, when you need to set demographic restrictions. If the restrictions don't change, you don't need to make this call.

Parameters

Name Type Description

callback

string

Name	Type	Description
callback	string	Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter.
restriction_str	string	A JSON-encoded string of the restricting attributes. Restrictions include `age`, `location`, `age_distribution`, and `type`. If you use the Facebook PHP client library, you can actually pass an associative array and Facebook automatically handles the JSON encoding. For example: `{"age_distribution":"{\"CA,US\":\"16-25\",\"IN\":\"15-20,30+\"}"}`. When specifying the `age` or `age_distribution`, you can use plus (+) and minus (-) to restrict content to that age or older/younger (like 21+ for 21 and older or 18- for younger than 19). You can also specify a range of ages, like 18-35 so anyone between the ages of 18 and 35 (inclusive) can see the content. You can also specify multiple age ranges (like 19-,30+ — if you want to exclude people in their 20s, for example). Every specified age must be an integer. When specifying the `location`, specify the country or countries (using a comma-separated list) from the ISO 3166 alpha 2 code list. This list is not necessarily the same as the IANA ccTLD (country code top level domain) list. For example, the ISO 3166 entry for England is `.gb`, while the IANA entry is `.uk`. Specifying a `type` allows you to target users based on age and location for custom made categories like `alcohol` (currently the only type available). Before rendering your FBML, we run a check against the `type` on Facebook, and if the user meets the age and location requirements, we'll render the content. Specifying an empty restriction_str resets all restrictions.

Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter.

restriction_str

string

A JSON-encoded string of the restricting attributes. Restrictions include age, location, age_distribution, and type. If you use the Facebook PHP client library, you can actually pass an associative array and Facebook automatically handles the JSON encoding. For example: {"age_distribution":"{\"CA,US\":\"16-25\",\"IN\":\"15-20,30+\"}"}.

When specifying the age or age_distribution, you can use plus (+) and minus (-) to restrict content to that age or older/younger (like 21+ for 21 and older or 18- for younger than 19). You can also specify a range of ages, like 18-35 so anyone between the ages of 18 and 35 (inclusive) can see the content. You can also specify multiple age ranges (like 19-,30+ — if you want to exclude people in their 20s, for example). Every specified age must be an integer.

When specifying the location, specify the country or countries (using a comma-separated list) from the ISO 3166 alpha 2 code list. This list is not necessarily the same as the IANA ccTLD (country code top level domain) list. For example, the ISO 3166 entry for England is .gb, while the IANA entry is .uk.

Specifying a type allows you to target users based on age and location for custom made categories like alcohol (currently the only type available). Before rendering your FBML, we run a check against the type on Facebook, and if the user meets the age and location requirements, we'll render the content.

Specifying an empty restriction_str resets all restrictions.

Response

This method returns true if the restrictions are successfully set.

Updated about 6 months ago

Administrative Methods

Login/Auth Methods

Data Retrieval Methods

Publishing Methods

Facebook Connect Methods

Mobile Methods

Dashboard API Methods

Events API Methods

Custom Tags API Methods

Ads Methods

admin.setRestrictionInfo

Parameters

Response