Endpoint that return the home listings that were added to the catalog
GET /v18.0/{product-catalog-id}/home_listings HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
// Returns a `Facebook\FacebookResponse` object
$response = $fb->get(
'/{product-catalog-id}/home_listings',
'{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 */
/* make the API call */
FB.api(
"/{product-catalog-id}/home_listings",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/{product-catalog-id}/home_listings",
null,
HttpMethod.GET,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"/{product-catalog-id}/home_listings"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];
Parameter | Description |
---|---|
bulk_pagination boolean | Used for iterating over the edge in large chunks |
filter A JSON-encoded rule | JSON-encoded WCA rule expression representing the filter to be applied for the edge |
Reading from this edge will return a JSON formatted result:
{ "
data
": [], "paging
": {}, "summary
": {} }
data
paging
summary
Aggregated information about the edge, such as counts. Specify the fields to fetch in the summary param (like summary=total_count
).
Field | Description |
---|---|
total_count unsigned int32 | Total number of home listings returned by the query |
Error | Description |
---|---|
100 | Invalid parameter |
home_listings
edge from the following paths: Parameter | Description |
---|---|
address Object | The address of the home listing Required |
availability string | The availability of the home listing Required |
currency ISO 4217 Currency Code | Currency for the listing Required |
description string | Description of the home listing |
home_listing_id string | ID of the home listing Required |
images list<Object> | Links to home listing images. Please note that carousel format utilizes a square 1:1 aspect ratio images (recommended size - 600x600px) while single hotel ad uses 1.91:1 aspect ratio image(recommended size - 1200x630px). Please provide at least one image. Required |
listing_type string | Listing type of the property |
name string | Name of the home listing Required |
num_baths float | Number of baths for the home listing |
num_beds float | Number of beds for the home listing |
num_units float | Number of units for the home listing |
price float | The price for this home listing Required |
property_type string | Property type of the home listing |
url URL | Link to the external site where you can view the listing Required |
year_built int64 | Year built Required |
id
in the return type.id
: numeric string, Error | Description |
---|---|
100 | Invalid parameter |
200 | Permissions error |