sendgo 1.1.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +64 -2
- data/lib/sendgo/client.rb +1 -0
- data/lib/sendgo/friendtalk.rb +10 -0
- data/lib/sendgo/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b284db84cf34d157e88508177769ef77a16544aef167a94c24e5760c724dd92a
|
|
4
|
+
data.tar.gz: 5fe6a34c4feea8876c6ccd87f80100d1072e4a1eec7ddfc16bcd8ebe8a96ab8d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f3657ed33b9adfbe67a300afed3ef8550700eb24f4d678e53b5c404612d38fa2b172cefe185d17eed1cb8e60ac314e4041754434ff87f19b9672b4c63eeebd8b
|
|
7
|
+
data.tar.gz: f2cdbb4f5f441e6b629a6acef33548fa13c63c9a453407c4d42dffdace8f85f92aa39fa4901e29af00662d0c79b21f391d4e0875a9e36d7544585d3fbc84a1b2
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# sendgo
|
|
2
2
|
|
|
3
|
-
> **Ruby에서 카카오 알림톡,
|
|
3
|
+
> **Ruby에서 카카오 알림톡, 브랜드메시지, SMS를 가장 쉽게 발송하는 공식 Ruby SDK**
|
|
4
4
|
|
|
5
5
|
[](https://rubygems.org/gems/sendgo)
|
|
6
6
|
[](https://ruby-lang.org)
|
|
@@ -99,6 +99,19 @@ client.alimtalk.send(
|
|
|
99
99
|
|
|
100
100
|
## 친구톡 사용법
|
|
101
101
|
|
|
102
|
+
> ⚠️ **Deprecated — 친구톡은 카카오 정책에 따라 2025-12-31 종료되었습니다.**
|
|
103
|
+
> 2026-01-01 부터 친구톡 발송 요청은 카카오 측에서 **브랜드메시지(자유형)** 로 자동 대체 발송됩니다.
|
|
104
|
+
> 호출은 계속 성공하며, 자유 본문 타입(`FT`/`FI`/`FW`)을 개별 수신자에게 보내는 경로는
|
|
105
|
+
> 현재 이것뿐이므로 기존 코드를 당장 바꿀 필요는 없습니다.
|
|
106
|
+
>
|
|
107
|
+
> 다음의 경우에는 **브랜드메시지**를 사용하세요.
|
|
108
|
+
> - 템플릿 기반 리치 타입 (`FL`/`FC`/`FM`/`FP`/`FA`)
|
|
109
|
+
> - 채널 친구가 **아닌** 수신자 (`targeting` = `N` / `I`)
|
|
110
|
+
> - 수신 동의한 전체 채널 친구 동보 (`targeting` = `F`)
|
|
111
|
+
>
|
|
112
|
+
> 메시지 타입은 1:1 대응되며 변환은 서버가 처리합니다 — `FT`→`BT`, `FI`→`BI`, `FW`→`BW`,
|
|
113
|
+
> `FL`→`BL`, `FC`→`BC`, `FM`→`BM`, `FP`→`BP`, `FA`→`BA`.
|
|
114
|
+
|
|
102
115
|
```ruby
|
|
103
116
|
# 텍스트형
|
|
104
117
|
client.friendtalk.send(
|
|
@@ -137,7 +150,7 @@ client.friendtalk.send(
|
|
|
137
150
|
- 수신 동의한 **전체 채널 친구 동보** 발송 (`targeting: F`, 수신자 목록 불필요)
|
|
138
151
|
- 리스트·캐러셀·커머스·동영상 등 **템플릿 기반 리치 메시지**
|
|
139
152
|
|
|
140
|
-
> v2 전용입니다. `FT`/`FI`/`FW
|
|
153
|
+
> v2 전용입니다. 자유 본문 타입(`FT`/`FI`/`FW`)을 개별 수신자에게 보낼 때는 여전히 친구톡 API 를 쓰세요 — 이 엔드포인트는 그 조합에 `NOT_A_BRAND_MESSAGE` 를 반환합니다. 친구톡 요청은 카카오 측에서 브랜드메시지(자유형)로 대체 발송됩니다.
|
|
141
154
|
|
|
142
155
|
```ruby
|
|
143
156
|
# 단건 발송 — 채널 친구 대상
|
|
@@ -315,6 +328,55 @@ end
|
|
|
315
328
|
|
|
316
329
|
---
|
|
317
330
|
|
|
331
|
+
## 짧은 URL
|
|
332
|
+
|
|
333
|
+
짧은 URL 은 메시지 본문의 링크를 줄이고, 그 링크가 실제로 눌렸는지 집계합니다.
|
|
334
|
+
문자는 바이트 수가 요금과 직결되므로 링크를 줄이면 그만큼 본문을 더 쓸 수 있습니다.
|
|
335
|
+
|
|
336
|
+
같은 원본 URL 을 다시 줄이면 **기존 링크가 그대로 반환**됩니다. 캠페인별로 반응을
|
|
337
|
+
따로 집계하려면 `forceNew` 로 새 코드를 만드세요.
|
|
338
|
+
|
|
339
|
+
`deactivate` 는 링크를 삭제하지 않고 리다이렉트만 중지합니다. 이미 발송한 메시지의
|
|
340
|
+
링크를 무효화할 때 쓰며, 누적 통계는 남고 이후 접속은 `410 Gone` 이 됩니다.
|
|
341
|
+
|
|
342
|
+
```ruby
|
|
343
|
+
# 짧은 URL 생성 (v2 전용)
|
|
344
|
+
created = sendgo.short_url.create(
|
|
345
|
+
target_url: "https://example.com/promotions/summer-sale",
|
|
346
|
+
title: "여름 세일 랜딩"
|
|
347
|
+
)
|
|
348
|
+
|
|
349
|
+
code = created.dig("data", "code")
|
|
350
|
+
link = created.dig("data", "shortUrl")
|
|
351
|
+
|
|
352
|
+
# 반응 통계 — 일별 추이 + 디바이스/유입경로/국가별 분해
|
|
353
|
+
stats = sendgo.short_url.stats(code, from: "2026-08-01")
|
|
354
|
+
|
|
355
|
+
sendgo.short_url.list(count: 10)
|
|
356
|
+
sendgo.short_url.show(code)
|
|
357
|
+
sendgo.short_url.deactivate(code) # 리다이렉트만 중지, 통계는 남는다
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
`stats` 는 일별 추이(`daily`)와 디바이스(`byDevice`)·유입경로(`byReferer`)·국가(`byCountry`)별
|
|
361
|
+
분해를 반환합니다. 일별 추이는 사전 집계 표에서 읽으므로 클릭이 많아도 응답 시간이 일정합니다.
|
|
362
|
+
|
|
363
|
+
## 변경 사항
|
|
364
|
+
|
|
365
|
+
### 1.2.0 (2026-08-14)
|
|
366
|
+
|
|
367
|
+
- **친구톡 Deprecated 표기** — 친구톡은 카카오 정책에 따라 2025-12-31 종료되었고,
|
|
368
|
+
2026-01-01 부터 발송 요청이 브랜드메시지(자유형)로 자동 대체 발송됩니다.
|
|
369
|
+
관련 API 에 각 언어의 표준 deprecation 표기를 달았습니다.
|
|
370
|
+
- 자유 본문 타입(`FT`/`FI`/`FW`)의 개별 발송 경로는 아직 친구톡 API 뿐이라는 점을
|
|
371
|
+
문서에 명시했습니다 — 브랜드메시지 API 는 그 조합에 `NOT_A_BRAND_MESSAGE` 를 반환합니다.
|
|
372
|
+
- 브랜드메시지 전환 안내와 메시지 타입 1:1 대응표를 README 에 추가했습니다.
|
|
373
|
+
|
|
374
|
+
### 1.1.0 (2026-08-11)
|
|
375
|
+
|
|
376
|
+
- 짧은 URL 추가 — `client.short_url`
|
|
377
|
+
- `HttpClient#delete` 추가
|
|
378
|
+
- **버그 수정** — `request()` 가 Get/Post 만 만들어 `:delete` 가 조용히 POST 로 나가고 있었다. `Net::HTTP::Delete` 분기 추가.
|
|
379
|
+
|
|
318
380
|
## 라이선스
|
|
319
381
|
|
|
320
382
|
MIT License © 2026 [Sendgo](https://sendgo.io)
|
data/lib/sendgo/client.rb
CHANGED
|
@@ -11,6 +11,7 @@ module Sendgo
|
|
|
11
11
|
# )
|
|
12
12
|
class Client
|
|
13
13
|
# brand_message: 카카오 브랜드메시지 — 친구톡의 후속 채널. v2 전용.
|
|
14
|
+
# friendtalk: @deprecated 2025-12-31 종료. brand_message 를 사용하세요.
|
|
14
15
|
attr_reader :alimtalk, :friendtalk, :brand_message, :short_url, :sms
|
|
15
16
|
|
|
16
17
|
def initialize(access_key:, secret_key:, kakao_sender_key: nil, sms_sender_key: nil,
|
data/lib/sendgo/friendtalk.rb
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
module Sendgo
|
|
2
2
|
# 카카오 친구톡 전송 서비스.
|
|
3
|
+
#
|
|
4
|
+
# @deprecated 친구톡은 카카오 정책에 따라 2025-12-31 종료되었습니다.
|
|
5
|
+
# 2026-01-01 부터 친구톡 발송 요청은 카카오 측에서 브랜드메시지(자유형)로
|
|
6
|
+
# 자동 대체 발송되므로, 이 서비스를 호출해도 실제로 나가는 것은 브랜드메시지입니다.
|
|
7
|
+
# 신규 연동은 {BrandMessageService} (+client.brand_message+) 를 사용하세요.
|
|
8
|
+
# 다만 자유 본문 타입(FT/FI/FW)을 개별 수신자에게 보내는 경로는 아직 이
|
|
9
|
+
# 서비스뿐입니다 — 브랜드메시지 API 는 그 조합에 NOT_A_BRAND_MESSAGE 를 반환합니다.
|
|
10
|
+
# 메시지 타입은 1:1 대응됩니다 — FT→BT, FI→BI, FW→BW, FL→BL,
|
|
11
|
+
# FC→BC, FM→BM, FP→BP, FA→BA.
|
|
3
12
|
class FriendtalkService
|
|
4
13
|
def initialize(http:, kakao_sender_key:, sms_sender_key:)
|
|
5
14
|
@http = http
|
|
@@ -7,6 +16,7 @@ module Sendgo
|
|
|
7
16
|
@sms_sender_key = sms_sender_key
|
|
8
17
|
end
|
|
9
18
|
|
|
19
|
+
# @deprecated 2025-12-31 종료. +client.brand_message.send+ 를 사용하세요.
|
|
10
20
|
def send(content:, contacts:, message_type: "FT", schedule_type: "DIRECTLY",
|
|
11
21
|
at: nil, buttons: [], image_url: nil, image_link: nil,
|
|
12
22
|
ad_flag: "Y", wide: "N", adult: "N", header: nil,
|
data/lib/sendgo/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: sendgo
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Sendgo
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-08-
|
|
11
|
+
date: 2026-08-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies: []
|
|
13
13
|
description: Sendgo API를 Ruby에서 간편하게 사용하기 위한 공식 SDK
|
|
14
14
|
email:
|