Skip to content

Commit dee4727

Browse files
github-actions[bot]github-actions
andauthored
Add new AudienceGroupType POP_AD_IMP to Audience Group API (#650)
line/line-openapi#113 # Add `POP_AD_IMP` to **AudienceGroupType** Enum We have supported for the new audience‑group type **`POP_AD_IMP`** (POP ad impression audience) to the OpenAPI schema. ## Changes Made * **Updated `AudienceGroupType` enumeration** * **New value**: `POP_AD_IMP` * **Description**: Audience groups generated from impressions of *LINE Beacon Network* (POP) ads. * **Region**: **Taiwan‑only** at launch ## Purpose This update enables correct identification and handling of audience groups built from POP ad impressions, a feature that will be released for the Taiwan market. ## Documents and Reference - [Managing Audience](https://developers.line.biz/en/reference/messaging-api/#manage-audience-group) For more information, please refer to the links provided above. Co-authored-by: github-actions <[email protected]>
1 parent 0ed4f46 commit dee4727

9 files changed

+21
-21
lines changed

lib/line/bot/v2/manage_audience/model/audience_group.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class AudienceGroup
1717
# @return [Integer,nil] The audience ID.
1818
attr_accessor :audience_group_id
1919
# @!attribute [rw] type
20-
# @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK')
20+
# @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP')
2121
attr_accessor :type
2222
# @!attribute [rw] description
2323
# @return [String,nil] The audience's name.
@@ -51,7 +51,7 @@ class AudienceGroup
5151
attr_accessor :create_route
5252

5353
# @param audience_group_id [Integer,nil] The audience ID.
54-
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK')
54+
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP')
5555
# @param description [String,nil] The audience's name.
5656
# @param status [String,nil] ('IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING')
5757
# @param failed_type [String,nil] ('AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'|'INTERNAL_ERROR'|'')

lib/line/bot/v2/manage_audience/model/create_audience_group_response.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class CreateAudienceGroupResponse
2121
# @return [String,nil] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API.
2222
attr_accessor :create_route
2323
# @!attribute [rw] type
24-
# @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK')
24+
# @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP')
2525
attr_accessor :type
2626
# @!attribute [rw] description
2727
# @return [String,nil] The audience's name.
@@ -41,7 +41,7 @@ class CreateAudienceGroupResponse
4141

4242
# @param audience_group_id [Integer,nil] The audience ID.
4343
# @param create_route [String,nil] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API.
44-
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK')
44+
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP')
4545
# @param description [String,nil] The audience's name.
4646
# @param created [Integer,nil] When the audience was created (in UNIX time).
4747
# @param permission [String,nil] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. `READ`: Can use only. `READ_WRITE`: Can use and update.

lib/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class CreateClickBasedAudienceGroupResponse
1818
# @return [Integer,nil] The audience ID.
1919
attr_accessor :audience_group_id
2020
# @!attribute [rw] type
21-
# @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK')
21+
# @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP')
2222
attr_accessor :type
2323
# @!attribute [rw] description
2424
# @return [String,nil] The audience's name.
@@ -46,7 +46,7 @@ class CreateClickBasedAudienceGroupResponse
4646
attr_accessor :is_ifa_audience
4747

4848
# @param audience_group_id [Integer,nil] The audience ID.
49-
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK')
49+
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP')
5050
# @param description [String,nil] The audience's name.
5151
# @param created [Integer,nil] When the audience was created (in UNIX time).
5252
# @param request_id [String,nil] The request ID that was specified when the audience was created.

lib/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class CreateImpBasedAudienceGroupResponse
1818
# @return [Integer,nil] The audience ID.
1919
attr_accessor :audience_group_id
2020
# @!attribute [rw] type
21-
# @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK')
21+
# @return [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP')
2222
attr_accessor :type
2323
# @!attribute [rw] description
2424
# @return [String,nil] The audience's name.
@@ -31,7 +31,7 @@ class CreateImpBasedAudienceGroupResponse
3131
attr_accessor :request_id
3232

3333
# @param audience_group_id [Integer,nil] The audience ID.
34-
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK')
34+
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP')
3535
# @param description [String,nil] The audience's name.
3636
# @param created [Integer,nil] When the audience was created (in UNIX time).
3737
# @param request_id [String,nil] The request ID that was specified when the audience was created.

line-openapi

sig/line/bot/v2/manage_audience/model/audience_group.rbs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ module Line
1414
# Audience group
1515
class AudienceGroup
1616
attr_accessor audience_group_id: Integer?
17-
attr_accessor type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'?
17+
attr_accessor type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP'?
1818
attr_accessor description: String?
1919
attr_accessor status: 'IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING'?
2020
attr_accessor failed_type: 'AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'|'INTERNAL_ERROR'|''?
@@ -28,7 +28,7 @@ module Line
2828

2929

3030
# @param audience_group_id [Integer,nil] The audience ID.
31-
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK')
31+
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP')
3232
# @param description [String,nil] The audience's name.
3333
# @param status [String,nil] ('IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING')
3434
# @param failed_type [String,nil] ('AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'|'INTERNAL_ERROR'|'')
@@ -41,7 +41,7 @@ module Line
4141
# @param create_route [String,nil] ('OA_MANAGER'|'MESSAGING_API'|'POINT_AD'|'AD_MANAGER')
4242
def initialize: (
4343
?audience_group_id: Integer?,
44-
?type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'?,
44+
?type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP'?,
4545
?description: String?,
4646
?status: 'IN_PROGRESS'|'READY'|'FAILED'|'EXPIRED'|'INACTIVE'|'ACTIVATING'?,
4747
?failed_type: 'AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT'|'INTERNAL_ERROR'|''?,

sig/line/bot/v2/manage_audience/model/create_audience_group_response.rbs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ module Line
1616
class CreateAudienceGroupResponse
1717
attr_accessor audience_group_id: Integer?
1818
attr_accessor create_route: 'MESSAGING_API'?
19-
attr_accessor type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'?
19+
attr_accessor type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP'?
2020
attr_accessor description: String?
2121
attr_accessor created: Integer?
2222
attr_accessor permission: 'READ'|'READ_WRITE'?
@@ -26,7 +26,7 @@ module Line
2626

2727
# @param audience_group_id [Integer,nil] The audience ID.
2828
# @param create_route [String,nil] ('MESSAGING_API') How the audience was created. `MESSAGING_API`: An audience created with Messaging API.
29-
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK')
29+
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP')
3030
# @param description [String,nil] The audience's name.
3131
# @param created [Integer,nil] When the audience was created (in UNIX time).
3232
# @param permission [String,nil] ('READ'|'READ_WRITE') Audience's update permission. Audiences linked to the same channel will be READ_WRITE. `READ`: Can use only. `READ_WRITE`: Can use and update.
@@ -35,7 +35,7 @@ module Line
3535
def initialize: (
3636
?audience_group_id: Integer?,
3737
?create_route: 'MESSAGING_API'?,
38-
?type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'?,
38+
?type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP'?,
3939
?description: String?,
4040
?created: Integer?,
4141
?permission: 'READ'|'READ_WRITE'?,

sig/line/bot/v2/manage_audience/model/create_click_based_audience_group_response.rbs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ module Line
1515
# @see https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group
1616
class CreateClickBasedAudienceGroupResponse
1717
attr_accessor audience_group_id: Integer?
18-
attr_accessor type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'?
18+
attr_accessor type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP'?
1919
attr_accessor description: String?
2020
attr_accessor created: Integer?
2121
attr_accessor request_id: String?
@@ -27,7 +27,7 @@ module Line
2727

2828

2929
# @param audience_group_id [Integer,nil] The audience ID.
30-
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK')
30+
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP')
3131
# @param description [String,nil] The audience's name.
3232
# @param created [Integer,nil] When the audience was created (in UNIX time).
3333
# @param request_id [String,nil] The request ID that was specified when the audience was created.
@@ -38,7 +38,7 @@ module Line
3838
# @param is_ifa_audience [bool,nil] The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs.
3939
def initialize: (
4040
?audience_group_id: Integer?,
41-
?type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'?,
41+
?type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP'?,
4242
?description: String?,
4343
?created: Integer?,
4444
?request_id: String?,

sig/line/bot/v2/manage_audience/model/create_imp_based_audience_group_response.rbs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,20 @@ module Line
1515
# @see https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group
1616
class CreateImpBasedAudienceGroupResponse
1717
attr_accessor audience_group_id: Integer?
18-
attr_accessor type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'?
18+
attr_accessor type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP'?
1919
attr_accessor description: String?
2020
attr_accessor created: Integer?
2121
attr_accessor request_id: String?
2222

2323

2424
# @param audience_group_id [Integer,nil] The audience ID.
25-
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK')
25+
# @param type [String,nil] ('UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP')
2626
# @param description [String,nil] The audience's name.
2727
# @param created [Integer,nil] When the audience was created (in UNIX time).
2828
# @param request_id [String,nil] The request ID that was specified when the audience was created.
2929
def initialize: (
3030
?audience_group_id: Integer?,
31-
?type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'?,
31+
?type: 'UPLOAD'|'CLICK'|'IMP'|'CHAT_TAG'|'FRIEND_PATH'|'RESERVATION'|'APP_EVENT'|'VIDEO_VIEW'|'WEBTRAFFIC'|'IMAGE_CLICK'|'RICHMENU_IMP'|'RICHMENU_CLICK'|'POP_AD_IMP'?,
3232
?description: String?,
3333
?created: Integer?,
3434
?request_id: String?,

0 commit comments

Comments
 (0)