페이지 이동경로
  • Docs>
  • Kakao Moment>
  • Bizboard landing settings

Kakao Moment

Bizboard landing settings

This document describes how to use the Bizboard landing settings API.

View list of Business Forms for landing settings

This API enables you to retrieve a list of Business Forms that can be used to set as a Business Form's landing type when you create or edit a creative.

Send a GET request with the issued access token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the list of detailed information about each Business Form, including its ID and title in JSON format. You can use a specific Business Form's information passed in the response for the Business Form landing type when creating or editing a creative. If failed, refer to Error code to figure out its failure cause.

Request
URL
GET /openapi/v4/creatives/landing/talkBizForms HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String Pass an access token in Bearer ${ACCESS_TOKEN} format. O
adAccountId Long Ad account's ID. O
Response
Name Type Description
- BusinessForm[] Business Form information.
BusinessForm
Name Type Description
id Long ID.
adAccountId Long Ad account's ID.
bizFormId Long Business Form's ID.
Set landingInfo.bizFormId to this value when creating or editing a creative.
dspAccountEmail String Email address of DSP account.
title String Title.
flowType String Type.
Either APPLY (Immediately apply type) or SURVEY (Survey type).
linkedDate String Date and time when permission is granted for Business Form.
In yyyy-MM-dd'T'HH:mm:ss format.
beginDate String Start date of Business Form.
In yyyy-MM-dd'T'HH:mm:ss format.
endDate String End date of Business Form.
In yyyy-MM-dd'T'HH:mm:ss format.
Sample
Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/creatives/landing/talkBizForms" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "id": 2617,
        "adAccountId": 1334,
        "bizFormId": 5678,
        "dspAccountEmail": "ad@daum.net",
        "title": "Business Form",
        "flowType": "SURVEY",
        "linkedDate": "2020-01-01 01:00:00",
        "beginDateTime": "2020-01-01 00:00",
        "endDateTime": "2020-01-01 00:00"
    }
]

View list of Ad Views for landing settings

This API enables you to retrieve a list of Ad Views that can be used to set as an Ad View's landing type when you create or edit a creative.

Send a GET request with the issued access token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the list of Ad Views in JSON format. You can use a specific Ad View's information passed in the response for the Ad View landing type when creating or editing a creative. If failed, refer to Error code to figure out its failure cause.

Request
URL
GET /openapi/v4/creatives/landing/adViews HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String Pass an access token in Bearer ${ACCESS_TOKEN} format. O
adAccountId Long Ad account's ID. O
Response
Name Type Description
- AdView[] Ad View information.
AdView
Name Type Description
id Long Ad View's ID.
Set landingInfo.adViewItem.id to this value when creating or editing a creative.
name String Ad View's name.
type String Ad View's type.
Either of FULL (Full view) or COMPACT (Compact view).
templateType String Template type.
One of the followings:
IMAGE
VIDEO
CAROUSEL
SCROLL
Sample
Request
curl -X GET
"https://apis.moment.kakao.com/openapi/v4/creatives/landing/adViews" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "id": 5678,
        "name": "first_ad_view",
        "type": "COMPACT",
        "templateType": "IMAGE"
    },
    {
        "id": 5679,
        "name": "second_ad_view",
        "type": "FULL",
        "templateType": "SCROLL"
    }
]

View list of Channel Posts for landing settings

This API enables you to retrieve a list of Channel Posts that can be used to set as a Channel Post's landing type when you create or edit a creative.

Send a GET request with the issued access token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the list of detailed information about each Channel Post in JSON format. You can use a specific Channel Post's information passed in the response for the Channel Post landing type when creating or editing a creative. If failed, refer to Error code to figure out its failure cause.

Request
URL
GET /openapi/v4/creatives/landing/channelPosts/{profileId} HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String Pass an access token in Bearer ${ACCESS_TOKEN} format. O
adAccountId Long Ad account's ID. O
Parameter
Name Type Description Required
profileId Integer Profile ID. O
Response
Name Type Description
items ChannelPost[] Information of Channel Post.
ChannelPost
Name Type Description
id Long Post ID.
title String Post Title.
postStatus String Post status.
permalink String Post URL.
media Media[] Media information.
Sample
Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/creatives/landing/channelPosts/{profileId}" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "items": [
        {
            "id": 1,
            "title": "Post",
            "status": "published",
            "permalink": "http://kakao.com/_xxxx/1",
            "media": [],
            "createdDate": "2020-01-01 00:00:00",
            "publishedDate": "2020-01-01 00:00:00"
        }
    ]
}

See more