Graph API Version

Canvas Store Locator

Reading

A store locator inside the canvas

Example

use FacebookAds\Api;
use FacebookAds\Http\RequestInterface;

$params = array(
  'fields' => array(
    'id',
    'name',
  ),
);

$data = Api::instance()->call(
  '/' . <CANVAS_STORE_LOCATOR_ID>,
  RequestInterface::METHOD_GET,
  $params)->getContent();
curl -G \
  -d 'fields=["id","name"]' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v2.11/<CANVAS_STORE_LOCATOR_ID>

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

The id of the element

bottom_padding
numeric string

The padding below the element

element_group_key
string

The element group key to bundle multiple elements in editing

element_type
enum

The type of the element

header_background_color
string

Header background color for the store locator

name
string

The name of the element

theme
enum

Theme of the store locator

top_padding
numeric string

The padding above the element

typeface
string

Font used to display info about the store

Error Codes

ErrorDescription
100Invalid parameter

Creating

You can't perform this operation on this endpoint.

Updating

You can update a CanvasStoreLocator by making a POST request to /{canvas_store_locator_id}.

Parameters

ParameterDescription
header_background_color
string

Header background color for the store locator

name
string

Name of the store locator element

typeface
string

Font used to display info about the store

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Error Codes

ErrorDescription
100Invalid parameter

Deleting

You can delete a CanvasStoreLocator by making a DELETE request to /{canvas_store_locator_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {
success: bool,
}

Error Codes

ErrorDescription
210User not visible