Graph API-Version

Canvas Template Video

Wird gelesen

A template video inside canvas (Instance Experience)

Beispiel

Graph API Explorer
GET /v21.0/{canvas-template-video-id} 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(
    '/{canvas-template-video-id}',
    '{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(
    "/{canvas-template-video-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{canvas-template-video-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{canvas-template-video-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
Weitere Informationen zur Verwendung der Graph API findest du in unserem Graph API-Leitfaden.

Parameter

Dieser Endpunkt hat keine Parameter.

Felder

FeldBeschreibung
id
numeric string

The id of the element

bottom_padding
numeric string

The padding below the element

config_id
numeric string

The config id for this template video

element_group_key
string

The element group key to bundle multiple elements in editing

element_type
enum

The type of the element

name
string

The name of the element

preview_ready
bool

Whether a video for preview is ready

product_set_id
numeric string

The product set id for this template video

template_video_spec

The presentation style of the template video

top_padding
numeric string

The padding above the element

Error Codes

FehlerBeschreibung
100Invalid parameter

Wird erstellt

Diese Handlung kann auf diesem Endpunkt nicht durchgeführt werden.

Wird aktualisiert

You can update a CanvasTemplateVideo by making a POST request to /{canvas_template_video_id}.

Parameter

ParameterBeschreibung
bottom_padding
float

The padding below the template video

name
string

Name of the template video element

product_set_id
numeric string

Product set ID to generate the template video

template_video_spec
Object

The spec to configure a template video. Including video template and customization

customization
JSON object {string : string}

top_padding
float

The padding above the template video

Rückgabetyp

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

Error Codes

FehlerBeschreibung
100Invalid parameter

Wird gelöscht

Diese Handlung kann auf diesem Endpunkt nicht durchgeführt werden.