마케팅 API
그래프 API 버전

Ad Creative Link Data Image Layer Spec

읽기

How to render text and frame overlays on an image for a dynamic item in Dynamic Ads

예

Graph API Explorer
GET v21.0/...?fields={fieldname_of_type_AdCreativeLinkDataImageLayerSpec} 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(
    '...?fields={fieldname_of_type_AdCreativeLinkDataImageLayerSpec}',
    '{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(
    "...?fields={fieldname_of_type_AdCreativeLinkDataImageLayerSpec}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "...?fields={fieldname_of_type_AdCreativeLinkDataImageLayerSpec}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"...?fields={fieldname_of_type_AdCreativeLinkDataImageLayerSpec}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
그래프 API를 사용하는 방법을 알아보려면 그래프 API 사용 가이드를 읽어보세요.

매개변수

이 엔드포인트는 매개변수가 없습니다.

필드

필드설명
blending_mode
enum {lighten, multiply, normal}

Combine the product image and frame image together using a certain blend mode. This field is only valid for frame_overlay.

기본
content
AdCreativeLinkDataImageTextOverlayContent

The content of text_overlay. It includes five fields, type, price, low_price, high_price and auto_show_enroll_status.

기본
frame_auto_show_enroll_status
enum

This field indicates whether the ad is eligible for frame overlay automation which could conditionally not display frame for some users if it predicts that doing so would increase ad engagement.

기본
frame_image_hash
string

The hash string for a frame image that you can use in creatives.This field is required for frame_overlay.

기본
frame_source
enum {custom}

The source of the frame image. Currently, we only support custom. This field is required for frame_overlay.

기본
image_source
enum {catalog}

The source of the product image. Currently, we only support catalog. This field is required for image layer.

기본
layer_type
enum {frame_overlay, image, text_overlay}

Each layer can be a layer of image, frame_overlay or text_overlay. This field is required for each layer.

기본
opacity
int32

The opacity of the text or frame image. This field is valid for both text_overlay and frame_overlayFor text, the valid values are 75 and 100, For frame image, the valid value is from 10 to 100. The bigger number means more opaque.

기본
overlay_position
enum {bottom, bottom_left, bottom_right, center, left, right, top, top_left, top_right}

Position for overlay on an image. This field is valid for both text_overlay and frame_overlay

기본
overlay_shape
enum {circle, none, pill, rectangle, triangle}

The background shape of text_overlay. The value none means no shape underneath the text.

기본
scale
int32

The scale resizes the frame image by multiples of ten from 10 to 100. 100 means the original size of frame image, 10 means the smallest size.This field is only valid for frame_overlay.

기본
shape_color
string

The color of the background in text_overlay. It should be represented as a three-digit or six-digit hexadecimal number. For example, 09C, FFFFFF.

기본
text_color
string

The color of the text in text_overlay. It should be represented as a three-digit or six-digit hexadecimal number. For example, 09C, FFFFFF.

기본
text_font
enum {droid_serif_regular, lato_regular, noto_sans_regular, nunito_sans_bold, open_sans_bold, open_sans_condensed_bold, pt_serif_bold, roboto_condensed_regular, roboto_medium}

Font type for text strings. If you choose a text font which does not support the language you are using, it will fallback to the default font.This field is only valid for text_overlay.

기본

만들기

이 엔드포인트에서 수행할 수 없는 작업입니다.

업데이트 중

이 엔드포인트에서 수행할 수 없는 작업입니다.

삭제 중

이 엔드포인트에서 수행할 수 없는 작업입니다.