Skip to content

Commit bc181f4

Browse files
authored
Add includesOwnedAudienceGroups Parameter to Audience API (#105)
# Enhancement to Shared Audiences API This PR introduces a new query parameter `includesOwnedAudienceGroups` to the `/v2/bot/audienceGroup/shared/list` endpoint in the Business Manager API. This enhancement allows users to specify whether to include audience groups owned by the user in the response. ## Changes Made - Added the `includesOwnedAudienceGroups` parameter to the API endpoint. - **Type**: Boolean - **Default**: false - **Description**: - `true`: Include audience groups owned by the LINE Official Account Manager. - `false`: Respond only with audience groups shared by Business Manager. - Removed the `/v2/bot/audienceGroup/{audienceGroupId}/activate` and `/v2/bot/audienceGroup/authorityLevel` endpoints. ## Purpose This update provides more flexibility in retrieving audience groups by allowing users to filter based on ownership. It is especially useful for users who manage both shared and owned audience groups. The removal of certain endpoints is part of a cleanup effort to streamline the API. Please review the changes and let me know if there are any questions or further modifications needed. ## Documents and Reference - [Get List of Shared Audiences](https://developers.line.biz/en/reference/messaging-api/#get-shared-audience-list) - [Removed Endpoints](https://developers.line.biz/en/news/2025/03/26/cross-targeting-closing/) For more information, please refer to the links provided above.
1 parent 2f38058 commit bc181f4

File tree

1 file changed

+9
-77
lines changed

1 file changed

+9
-77
lines changed

manage-audience.yml

Lines changed: 9 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -256,26 +256,6 @@ paths:
256256
"200":
257257
description: "OK"
258258

259-
"/v2/bot/audienceGroup/{audienceGroupId}/activate":
260-
put:
261-
externalDocs:
262-
url: https://developers.line.biz/en/reference/messaging-api/#activate-audience-group
263-
tags:
264-
- manage-audience
265-
operationId: activateAudienceGroup
266-
description: "Activate audience"
267-
parameters:
268-
- name: audienceGroupId
269-
in: path
270-
required: true
271-
description: "The audience ID."
272-
schema:
273-
type: integer
274-
format: int64
275-
responses:
276-
"202":
277-
description: "Accepted"
278-
279259
"/v2/bot/audienceGroup/{audienceGroupId}":
280260
parameters:
281261
- name: audienceGroupId
@@ -495,41 +475,6 @@ paths:
495475
size: 40
496476
page: 1
497477

498-
"/v2/bot/audienceGroup/authorityLevel":
499-
get:
500-
externalDocs:
501-
url: https://developers.line.biz/en/reference/messaging-api/#get-authority-level
502-
tags:
503-
- manage-audience
504-
operationId: getAudienceGroupAuthorityLevel
505-
description: "Get the authority level of the audience"
506-
responses:
507-
"200":
508-
description: "OK"
509-
content:
510-
"application/json":
511-
schema:
512-
"$ref": "#/components/schemas/GetAudienceGroupAuthorityLevelResponse"
513-
example:
514-
authorityLevel: PUBLIC
515-
put:
516-
externalDocs:
517-
url: https://developers.line.biz/en/reference/messaging-api/#change-authority-level
518-
tags:
519-
- manage-audience
520-
operationId: updateAudienceGroupAuthorityLevel
521-
description: "Change the authority level of the audience"
522-
requestBody:
523-
content:
524-
application/json:
525-
schema:
526-
"$ref": "#/components/schemas/UpdateAudienceGroupAuthorityLevelRequest"
527-
required: true
528-
responses:
529-
"200":
530-
description: "OK"
531-
# empty json response
532-
533478
"/v2/bot/audienceGroup/shared/{audienceGroupId}":
534479
parameters:
535480
- name: audienceGroupId
@@ -681,6 +626,15 @@ paths:
681626
682627
`OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window).
683628
`MESSAGING_API`: Return only audiences created with Messaging API.
629+
- name: includesOwnedAudienceGroups
630+
in: query
631+
required: false
632+
schema:
633+
type: boolean
634+
default: false
635+
description: |+
636+
true: Include audienceGroups owned by LINE Official Account Manager
637+
false: Respond only audienceGroups shared by Business Manager
684638
responses:
685639
"200":
686640
description: "OK"
@@ -1251,28 +1205,6 @@ components:
12511205
type: integer
12521206
format: int64
12531207
description: "The maximum number of audiences on the current page."
1254-
GetAudienceGroupAuthorityLevelResponse:
1255-
externalDocs:
1256-
url: https://developers.line.biz/en/reference/messaging-api/#get-authority-level
1257-
type: object
1258-
description: "Get the authority level of the audience"
1259-
properties:
1260-
authorityLevel:
1261-
"$ref": "#/components/schemas/AudienceGroupAuthorityLevel"
1262-
AudienceGroupAuthorityLevel:
1263-
description: "authority level"
1264-
type: string
1265-
enum:
1266-
- PUBLIC
1267-
- PRIVATE
1268-
UpdateAudienceGroupAuthorityLevelRequest:
1269-
externalDocs:
1270-
url: https://developers.line.biz/en/reference/messaging-api/#change-authority-level
1271-
type: object
1272-
description: "Change the authority level of the audience"
1273-
properties:
1274-
authorityLevel:
1275-
"$ref": "#/components/schemas/AudienceGroupAuthorityLevel"
12761208

12771209
ErrorResponse:
12781210
externalDocs:

0 commit comments

Comments
 (0)