Share

Kakao. Namespace

Share

Description:

  • 카카오톡 공유와 관련된 함수들이 포함되어 있습니다.
    주의! 이 문서는 JavaScript SDK v1 레퍼런스입니다. 최신 버전은 JavaScript SDK 레퍼런스를 참고합니다.

Methods

(static) cleanup()

Description:

  • 카카오톡 공유와 관련된 리소스를 해제합니다.

(static) createCustomButton(settings)

Description:
See:
Parameters:
Name Type Description
settings Object

카카오톡 공유와 관련된 설정을 key/value로 전달합니다.

Properties
Name Type Attributes Default Description
container String | HTMLElement

DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 카카오톡 공유가 됩니다.
templateId Number

메시지 템플릿 아이디, [내 애플리케이션 > 메시지 > 메시지 템플릿]에서 확인
templateArgs Object <optional>

메시지 템플릿에서 활용할 arguments, ex) {'name':'kakao', 'url':'https://developers.kakao.com'}
installTalk Boolean <optional>
 false

카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동
callback function <optional>

데스크톱 환경에서 카카오톡 공유를 완료했을 때 호출되는 콜백 함수 (IE 미지원)
serverCallbackArgs Object | String <optional>

카카오톡 공유 시 전송되는 알림에 포함되는 파라미터 (전송 성공 알림 설정하기)

(static) createDefaultButton(settings)

Description:

  • 기본 템플릿 타입 (Feed, List, Location, Commerce, Text)에 따라 메시지를 구성하여 카카오톡 공유를 하는 기능입니다.

See:
Parameters:
Name Type Description
settings DefaultFeedSettings | DefaultListSettings | DefaultLocationSettings | DefaultCommerceSettings | DefaultTextSettings

카카오톡 공유와 관련된 설정을 key/value로 전달합니다.

Properties
Name Type Description
container String | HTMLElement

DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 카카오톡 공유가 됩니다.

(static) createScrapButton(settings)

Description:

  • 사이트의 메타 정보를 활용하여 카카오톡 공유를 하는 기능입니다.

See:
Parameters:
Name Type Description
settings Object

카카오톡 공유와 관련된 설정을 key/value로 전달합니다.

Properties
Name Type Attributes Default Description
container String | HTMLElement

DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 카카오톡 공유가 됩니다.
requestUrl String

스크랩할 사이트 URL, 해당 사이트의 메타 정보를 토대로 메시지 생성
templateId Number <optional>

메시지 템플릿 아이디, [내 애플리케이션 > 메시지 > 메시지 템플릿]에서 확인
templateArgs Object <optional>

메시지 템플릿에서 활용할 arguments, ex) {'name':'kakao', 'url':'https://developers.kakao.com'}
installTalk Boolean <optional>
 false

카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동
callback function <optional>

데스크톱 환경에서 카카오톡 공유를 완료했을 때 호출되는 콜백 함수 (IE 미지원)
serverCallbackArgs Object | String <optional>

카카오톡 공유 시 전송되는 알림에 포함되는 파라미터 (전송 성공 알림 설정하기)

(static) deleteImage(settings) → {Promise}

Description:

  • 업로드된 이미지의 경로를 전달하면 이미지를 삭제할 수 있습니다.

Parameters:
Name Type Description
settings Object

이미지와 관련된 설정을 key/value로 전달합니다.

Properties
Name Type Description
imageUrl String

삭제할 이미지 URL
Returns:
Type
Promise

(static) scrapImage(settings) → {Promise.<ImageInfos>}

Description:

  • 스크랩하고 싶은 이미지의 경로를 전달하면 스크랩 후 업로드합니다. (이미지는 20일 동안 보관됩니다.)

Parameters:
Name Type Description
settings Object

이미지와 관련된 설정을 key/value로 전달합니다.

Properties
Name Type Description
imageUrl String

스크랩할 이미지 URL
Returns:
Type
Promise.<ImageInfos>

(static) sendCustom(settings)

Description:
See:
Parameters:
Name Type Description
settings Object

카카오톡 공유와 관련된 설정을 key/value로 전달합니다.

Properties
Name Type Attributes Default Description
templateId Number

메시지 템플릿 아이디, [내 애플리케이션 > 메시지 > 메시지 템플릿]에서 확인
templateArgs Object <optional>

메시지 템플릿에서 활용할 arguments, ex) {'name':'kakao', 'url':'https://developers.kakao.com'}
installTalk Boolean <optional>
 false

카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동
callback function <optional>

데스크톱 환경에서 카카오톡 공유를 완료했을 때 호출되는 콜백 함수 (IE 미지원)
serverCallbackArgs Object | String <optional>

카카오톡 공유 시 전송되는 알림에 포함되는 파라미터 (전송 성공 알림 설정하기)

(static) sendDefault(settings)

Description:

  • 기본 템플릿 타입 (Feed, List, Location, Commerce, Text)에 따라 메시지를 구성하여 카카오톡 공유를 하는 기능입니다.

See:
Parameters:
Name Type Description
settings DefaultFeedSettings | DefaultListSettings | DefaultLocationSettings | DefaultCommerceSettings | DefaultTextSettings

카카오톡 공유와 관련된 설정을 key/value로 전달합니다.

(static) sendScrap(settings)

Description:

  • 사이트의 메타 정보를 활용하여 카카오톡 공유를 하는 기능입니다.

See:
Parameters:
Name Type Description
settings Object

카카오톡 공유와 관련된 설정을 key/value로 전달합니다.

Properties
Name Type Attributes Default Description
requestUrl String

스크랩할 사이트 URL, 해당 사이트의 메타 정보를 토대로 메시지 생성
templateId Number <optional>

메시지 템플릿 아이디, [내 애플리케이션 > 메시지 > 메시지 템플릿]에서 확인
templateArgs Object <optional>

메시지 템플릿에서 활용할 arguments, ex) {'name':'kakao', 'url':'https://developers.kakao.com'}
installTalk Boolean <optional>
 false

카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동
callback function <optional>

데스크톱 환경에서 카카오톡 공유를 완료했을 때 호출되는 콜백 함수 (IE 미지원)
serverCallbackArgs Object | String <optional>

카카오톡 공유 시 전송되는 알림에 포함되는 파라미터 (전송 성공 알림 설정하기)

(static) uploadImage(settings) → {Promise.<ImageInfos>}

Description:

  • 카카오톡 공유에 필요한 이미지를 업로드 합니다. (이미지는 20일 동안 보관됩니다.)

Parameters:
Name Type Description
settings Object

이미지와 관련된 설정을 key/value로 전달합니다.

Properties
Name Type Description
file FileList

HTMLInputElement의 files property
Returns:
Type
Promise.<ImageInfos>

Type Definitions

ButtonObject

Description:

  • 메시지 하단에 추가되는 버튼 오브젝트입니다.

Properties:
Name Type Description
title String

버튼의 타이틀
link LinkObject

버튼 클릭 시 이동할 링크 정보

메시지 하단에 추가되는 버튼 오브젝트입니다.

Type:
  • Object

CommerceObject

Description:

  • 가격 정보를 표현하기 위해 사용되는 오브젝트입니다.

Properties:
Name Type Attributes Default Description
regularPrice Number

정상 가격
discountPrice Number <optional>

할인 가격
discountRate Number <optional>

할인율
fixedDiscountPrice Number <optional>

정액 할인액 (할인율과 동시 사용 불가)
currencyUnit String <optional>
 "원"

화폐 단위
currencyUnitPosition Number <optional>
 0

화폐 단위 표기 위치 (0: 가격 뒤에 표기, 1: 가격 앞에 표기)
productName String <optional>

상품 이름

가격 정보를 표현하기 위해 사용되는 오브젝트입니다.

Type:
  • Object

ContentObject

Description:

  • 콘텐츠의 내용을 담고 있는 오브젝트입니다.

Properties:
Name Type Attributes Description
title String

콘텐츠의 타이틀
imageUrl String

콘텐츠의 이미지 URL
link LinkObject

콘텐츠 클릭 시 이동할 링크 정보
imageWidth Number <optional>

콘텐츠의 이미지 너비 (단위: px)
imageHeight Number <optional>

콘텐츠의 이미지 높이 (단위: px)
description String <optional>

콘텐츠의 상세 설명

콘텐츠의 내용을 담고 있는 오브젝트입니다.

Type:
  • Object

DefaultCommerceSettings

Properties:
Name Type Attributes Default Description
objectType String

고정값 "commerce"
content ContentObject

메인 콘텐츠
commerce CommerceObject

가격 정보
buttonTitle String <optional>

기본 버튼 타이틀 변경, [내 애플리케이션 > 플랫폼 > 사이트 도메인]의 첫 번째 주소 링크 (buttonTitle 보다 buttons가 우선순위 높음)
buttons Array.<ButtonObject> <optional>

버튼 타이틀 및 링크 설정 가능, 최대 2개의 버튼 지원
installTalk Boolean <optional>
 false

카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동
callback function <optional>

데스크톱 환경에서 카카오톡 공유를 완료했을 때 호출되는 콜백 함수 (IE 미지원)
serverCallbackArgs Object | String <optional>

카카오톡 공유 시 전송되는 알림에 포함되는 파라미터 (전송 성공 알림 설정하기)
Type:
  • Object

DefaultFeedSettings

Properties:
Name Type Attributes Default Description
objectType String

고정값 "feed"
content ContentObject

메시지의 메인 콘텐츠 정보
itemContent ItemContentObject <optional>

아이템 영역에 포함할 콘텐츠
social SocialObject <optional>

콘텐츠에 대한 소셜 정보
buttonTitle String <optional>

기본 버튼 타이틀 변경, [내 애플리케이션 > 플랫폼 > 사이트 도메인]의 첫 번째 주소 링크 (buttonTitle 보다 buttons가 우선순위 높음)
buttons Array.<ButtonObject> <optional>

버튼 타이틀 및 링크 설정 가능, 최대 2개의 버튼 지원
installTalk Boolean <optional>
 false

카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동
callback function <optional>

데스크톱 환경에서 카카오톡 공유를 완료했을 때 호출되는 콜백 함수 (IE 미지원)
serverCallbackArgs Object | String <optional>

카카오톡 공유 시 전송되는 알림에 포함되는 파라미터 (전송 성공 알림 설정하기)
Type:
  • Object

DefaultListSettings

Properties:
Name Type Attributes Default Description
objectType String

고정값 "list"
headerTitle String

헤더 타이틀
headerLink LinkObject

헤더 링크
contents Array.<ContentObject>

메인 콘텐츠
buttonTitle String <optional>

기본 버튼 타이틀 변경, [내 애플리케이션 > 플랫폼 > 사이트 도메인]의 첫 번째 주소 링크 (buttonTitle 보다 buttons가 우선순위 높음)
buttons Array.<ButtonObject> <optional>

버튼 타이틀 및 링크 설정 가능, 최대 2개의 버튼 지원
installTalk Boolean <optional>
 false

카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동
callback function <optional>

데스크톱 환경에서 카카오톡 공유를 완료했을 때 호출되는 콜백 함수 (IE 미지원)
serverCallbackArgs Object | String <optional>

카카오톡 공유 시 전송되는 알림에 포함되는 파라미터 (전송 성공 알림 설정하기)
Type:
  • Object

DefaultLocationSettings

Properties:
Name Type Attributes Default Description
objectType String

고정값 "location"
content ContentObject

메인 콘텐츠
address String

지도 뷰에서 사용 할 주소, ex) 성남시 분당구 판교역로 235
addressTitle String <optional>

지도 뷰에서 사용될 주소명, ex) 카카오 본사
social SocialObject <optional>

소셜 정보
buttonTitle String <optional>

기본 버튼 타이틀 변경, [내 애플리케이션 > 플랫폼 > 사이트 도메인]의 첫 번째 주소 링크 (buttonTitle 보다 buttons가 우선순위 높음)
buttons Array.<ButtonObject> <optional>

버튼 타이틀 및 링크 설정 가능, 최대 2개의 버튼 지원
installTalk Boolean <optional>
 false

카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동
callback function <optional>

데스크톱 환경에서 카카오톡 공유를 완료했을 때 호출되는 콜백 함수 (IE 미지원)
serverCallbackArgs Object | String <optional>

카카오톡 공유 시 전송되는 알림에 포함되는 파라미터 (전송 성공 알림 설정하기)
Type:
  • Object

DefaultTextSettings

Properties:
Name Type Attributes Default Description
objectType String

고정값 "text"
text String

최대 200자의 텍스트
link LinkObject

텍스트 클릭 시 이동할 링크 정보
buttonTitle String <optional>

기본 버튼 타이틀 변경, [내 애플리케이션 > 플랫폼 > 사이트 도메인]의 첫 번째 주소 링크 (buttonTitle 보다 buttons가 우선순위 높음)
buttons Array.<ButtonObject> <optional>

버튼 타이틀 및 링크 설정 가능, 최대 2개의 버튼 지원
installTalk Boolean <optional>
 false

카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동
callback function <optional>

데스크톱 환경에서 카카오톡 공유를 완료했을 때 호출되는 콜백 함수 (IE 미지원)
serverCallbackArgs Object | String <optional>

카카오톡 공유 시 전송되는 알림에 포함되는 파라미터 (전송 성공 알림 설정하기)
Type:
  • Object

ImageInfos

Description:

  • 이미지 정보

Properties:
Name Type Description
original Object
Properties
Name Type Description
url String

이미지 Full URL
length Number

이미지 사이즈, 단위: Byte
content_type String

이미지 포맷
width Number

이미지 가로 크기
height Number

이미지 세로 크기

이미지 정보

ItemContentObject

Description:

  • 아이템 목록 형태의 콘텐츠를 표현할 때 사용하는 오브젝트입니다.

Properties:
Name Type Attributes Description
profileText String <optional>

헤더 또는 프로필 영역에 출력될 텍스트
profileImageUrl String <optional>

프로필 영역에 출력될 이미지
titleImageText String <optional>

이미지 아이템의 제목
titleImageUrl String <optional>

이미지 아이템의 이미지
titleImageCategory String <optional>

이미지 아이템의 제목 아래에 회색 글씨로 출력되는 카테고리 정보
items Array.<ItemObject> <optional>

각 텍스트 아이템 정보, 최대 5개의 아이템 지원
sum String <optional>

주문금액, 결제금액 등 아이템 영역의 요약 정보 제목
sumOp String <optional>

아이템 영역의 가격 합산 정보

아이템 목록 형태의 콘텐츠를 표현할 때 사용하는 오브젝트입니다.

Type:
  • Object

ItemObject

Description:

  • 텍스트 아이템 정보

Properties:
Name Type Description
item String

아이템 이름
itemOp String

아이템 가격

텍스트 아이템 정보

Type:
  • Object

LinkObject

Description:

  • 메시지에서 콘텐츠 영역이나 버튼 클릭 시에 이동되는 링크 정보 오브젝트입니다. 오브젝트 내 프로퍼티 중 하나 이상은 반드시 존재해야 합니다.

Properties:
Name Type Attributes Description
webUrl String <optional>

PC 버전 카카오톡에서 사용하는 웹 링크 URL
mobileWebUrl String <optional>

모바일 카카오톡에서 사용하는 웹 링크 URL
androidExecutionParams String <optional>

안드로이드 카카오톡에서 사용하는 앱 링크 URL에 사용될 파라미터
iosExecutionParams String <optional>

iOS 카카오톡에서 사용하는 앱 링크 URL에 사용될 파라미터

메시지에서 콘텐츠 영역이나 버튼 클릭 시에 이동되는 링크 정보 오브젝트입니다. 오브젝트 내 프로퍼티 중 하나 이상은 반드시 존재해야 합니다.

Type:
  • Object

SocialObject

Description:

  • 좋아요 수, 댓글 수 등의 소셜 정보를 표현하기 위해 사용되는 오브젝트입니다.

Properties:
Name Type Attributes Description
likeCount Number <optional>

콘텐츠의 좋아요 수
commentCount Number <optional>

콘텐츠의 댓글 수
sharedCount Number <optional>

콘텐츠의 공유 수
viewCount Number <optional>

콘텐츠의 조회 수
subscriberCount Number <optional>

콘텐츠의 구독 수

좋아요 수, 댓글 수 등의 소셜 정보를 표현하기 위해 사용되는 오브젝트입니다.

Type:
  • Object