Skip to content

Commit 236c782

Browse files
github-actions[bot]github-actions
and
github-actions
authored
Add includesOwnedAudienceGroups Parameter to Audience API (#800)
line/line-openapi#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. Co-authored-by: github-actions <[email protected]>
1 parent c103cc6 commit 236c782

9 files changed

+35
-1282
lines changed

line-openapi

linebot/v3/audience/__init__.py

-3
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@
3939
from linebot.v3.audience.models.add_audience_to_audience_group_request import AddAudienceToAudienceGroupRequest
4040
from linebot.v3.audience.models.audience import Audience
4141
from linebot.v3.audience.models.audience_group import AudienceGroup
42-
from linebot.v3.audience.models.audience_group_authority_level import AudienceGroupAuthorityLevel
4342
from linebot.v3.audience.models.audience_group_create_route import AudienceGroupCreateRoute
4443
from linebot.v3.audience.models.audience_group_failed_type import AudienceGroupFailedType
4544
from linebot.v3.audience.models.audience_group_job import AudienceGroupJob
@@ -59,9 +58,7 @@
5958
from linebot.v3.audience.models.error_detail import ErrorDetail
6059
from linebot.v3.audience.models.error_response import ErrorResponse
6160
from linebot.v3.audience.models.get_audience_data_response import GetAudienceDataResponse
62-
from linebot.v3.audience.models.get_audience_group_authority_level_response import GetAudienceGroupAuthorityLevelResponse
6361
from linebot.v3.audience.models.get_audience_groups_response import GetAudienceGroupsResponse
6462
from linebot.v3.audience.models.get_shared_audience_data_response import GetSharedAudienceDataResponse
6563
from linebot.v3.audience.models.get_shared_audience_groups_response import GetSharedAudienceGroupsResponse
66-
from linebot.v3.audience.models.update_audience_group_authority_level_request import UpdateAudienceGroupAuthorityLevelRequest
6764
from linebot.v3.audience.models.update_audience_group_description_request import UpdateAudienceGroupDescriptionRequest

linebot/v3/audience/api/async_manage_audience.py

+16-450
Large diffs are not rendered by default.

linebot/v3/audience/api/manage_audience.py

+14-418
Large diffs are not rendered by default.

linebot/v3/audience/docs/ManageAudience.md

+4-221
Original file line numberDiff line numberDiff line change
@@ -4,93 +4,18 @@ All URIs are relative to *https://api.line.me*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**activate_audience_group**](ManageAudience.md#activate_audience_group) | **PUT** /v2/bot/audienceGroup/{audienceGroupId}/activate |
87
[**add_audience_to_audience_group**](ManageAudience.md#add_audience_to_audience_group) | **PUT** /v2/bot/audienceGroup/upload |
98
[**create_audience_group**](ManageAudience.md#create_audience_group) | **POST** /v2/bot/audienceGroup/upload |
109
[**create_click_based_audience_group**](ManageAudience.md#create_click_based_audience_group) | **POST** /v2/bot/audienceGroup/click |
1110
[**create_imp_based_audience_group**](ManageAudience.md#create_imp_based_audience_group) | **POST** /v2/bot/audienceGroup/imp |
1211
[**delete_audience_group**](ManageAudience.md#delete_audience_group) | **DELETE** /v2/bot/audienceGroup/{audienceGroupId} |
1312
[**get_audience_data**](ManageAudience.md#get_audience_data) | **GET** /v2/bot/audienceGroup/{audienceGroupId} |
14-
[**get_audience_group_authority_level**](ManageAudience.md#get_audience_group_authority_level) | **GET** /v2/bot/audienceGroup/authorityLevel |
1513
[**get_audience_groups**](ManageAudience.md#get_audience_groups) | **GET** /v2/bot/audienceGroup/list |
1614
[**get_shared_audience_data**](ManageAudience.md#get_shared_audience_data) | **GET** /v2/bot/audienceGroup/shared/{audienceGroupId} |
1715
[**get_shared_audience_groups**](ManageAudience.md#get_shared_audience_groups) | **GET** /v2/bot/audienceGroup/shared/list |
18-
[**update_audience_group_authority_level**](ManageAudience.md#update_audience_group_authority_level) | **PUT** /v2/bot/audienceGroup/authorityLevel |
1916
[**update_audience_group_description**](ManageAudience.md#update_audience_group_description) | **PUT** /v2/bot/audienceGroup/{audienceGroupId}/updateDescription |
2017

2118

22-
# **activate_audience_group**
23-
> activate_audience_group(audience_group_id)
24-
25-
26-
27-
Activate audience
28-
29-
### Example
30-
31-
* Bearer Authentication (Bearer):
32-
```python
33-
import time
34-
import os
35-
import linebot.v3.audience
36-
from linebot.v3.audience.rest import ApiException
37-
from pprint import pprint
38-
39-
# Defining the host is optional and defaults to https://api.line.me
40-
# See configuration.py for a list of all supported configuration parameters.
41-
configuration = linebot.v3.audience.Configuration(
42-
host = "https://api.line.me"
43-
)
44-
45-
# The client must configure the authentication and authorization parameters
46-
# in accordance with the API server security policy.
47-
# Examples for each auth method are provided below, use the example that
48-
# satisfies your auth use case.
49-
50-
# Configure Bearer authorization: Bearer
51-
configuration = linebot.v3.audience.Configuration(
52-
access_token = os.environ["BEARER_TOKEN"]
53-
)
54-
55-
# Enter a context with an instance of the API client
56-
with linebot.v3.audience.ApiClient(configuration) as api_client:
57-
# Create an instance of the API class
58-
api_instance = linebot.v3.audience.ManageAudience(api_client)
59-
audience_group_id = 56 # int | The audience ID.
60-
61-
try:
62-
api_instance.activate_audience_group(audience_group_id)
63-
except Exception as e:
64-
print("Exception when calling ManageAudience->activate_audience_group: %s\n" % e)
65-
```
66-
67-
68-
### Parameters
69-
70-
Name | Type | Description | Notes
71-
------------- | ------------- | ------------- | -------------
72-
**audience_group_id** | **int**| The audience ID. |
73-
74-
### Return type
75-
76-
void (empty response body)
77-
78-
### Authorization
79-
80-
[Bearer](../README.md#Bearer)
81-
82-
### HTTP request headers
83-
84-
- **Content-Type**: Not defined
85-
- **Accept**: Not defined
86-
87-
### HTTP response details
88-
| Status code | Description | Response headers |
89-
|-------------|-------------|------------------|
90-
**202** | Accepted | - |
91-
92-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
93-
9419
# **add_audience_to_audience_group**
9520
> add_audience_to_audience_group(add_audience_to_audience_group_request)
9621
@@ -540,77 +465,6 @@ Name | Type | Description | Notes
540465

541466
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
542467

543-
# **get_audience_group_authority_level**
544-
> GetAudienceGroupAuthorityLevelResponse get_audience_group_authority_level()
545-
546-
547-
548-
Get the authority level of the audience
549-
550-
### Example
551-
552-
* Bearer Authentication (Bearer):
553-
```python
554-
import time
555-
import os
556-
import linebot.v3.audience
557-
from linebot.v3.audience.models.get_audience_group_authority_level_response import GetAudienceGroupAuthorityLevelResponse
558-
from linebot.v3.audience.rest import ApiException
559-
from pprint import pprint
560-
561-
# Defining the host is optional and defaults to https://api.line.me
562-
# See configuration.py for a list of all supported configuration parameters.
563-
configuration = linebot.v3.audience.Configuration(
564-
host = "https://api.line.me"
565-
)
566-
567-
# The client must configure the authentication and authorization parameters
568-
# in accordance with the API server security policy.
569-
# Examples for each auth method are provided below, use the example that
570-
# satisfies your auth use case.
571-
572-
# Configure Bearer authorization: Bearer
573-
configuration = linebot.v3.audience.Configuration(
574-
access_token = os.environ["BEARER_TOKEN"]
575-
)
576-
577-
# Enter a context with an instance of the API client
578-
with linebot.v3.audience.ApiClient(configuration) as api_client:
579-
# Create an instance of the API class
580-
api_instance = linebot.v3.audience.ManageAudience(api_client)
581-
582-
try:
583-
api_response = api_instance.get_audience_group_authority_level()
584-
print("The response of ManageAudience->get_audience_group_authority_level:\n")
585-
pprint(api_response)
586-
except Exception as e:
587-
print("Exception when calling ManageAudience->get_audience_group_authority_level: %s\n" % e)
588-
```
589-
590-
591-
### Parameters
592-
This endpoint does not need any parameter.
593-
594-
### Return type
595-
596-
[**GetAudienceGroupAuthorityLevelResponse**](GetAudienceGroupAuthorityLevelResponse.md)
597-
598-
### Authorization
599-
600-
[Bearer](../README.md#Bearer)
601-
602-
### HTTP request headers
603-
604-
- **Content-Type**: Not defined
605-
- **Accept**: application/json
606-
607-
### HTTP response details
608-
| Status code | Description | Response headers |
609-
|-------------|-------------|------------------|
610-
**200** | OK | - |
611-
612-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
613-
614468
# **get_audience_groups**
615469
> GetAudienceGroupsResponse get_audience_groups(page, description=description, status=status, size=size, includes_external_public_groups=includes_external_public_groups, create_route=create_route)
616470
@@ -775,7 +629,7 @@ Name | Type | Description | Notes
775629
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
776630

777631
# **get_shared_audience_groups**
778-
> GetSharedAudienceGroupsResponse get_shared_audience_groups(page, description=description, status=status, size=size, create_route=create_route)
632+
> GetSharedAudienceGroupsResponse get_shared_audience_groups(page, description=description, status=status, size=size, create_route=create_route, includes_owned_audience_groups=includes_owned_audience_groups)
779633
780634

781635

@@ -819,9 +673,10 @@ with linebot.v3.audience.ApiClient(configuration) as api_client:
819673
status = linebot.v3.audience.AudienceGroupStatus() # AudienceGroupStatus | The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion. (optional)
820674
size = 20 # int | The number of audiences per page. Default: 20 Max: 40 (optional)
821675
create_route = linebot.v3.audience.AudienceGroupCreateRoute() # AudienceGroupCreateRoute | How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API. (optional)
676+
includes_owned_audience_groups = False # bool | true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager (optional) (default to False)
822677

823678
try:
824-
api_response = api_instance.get_shared_audience_groups(page, description=description, status=status, size=size, create_route=create_route)
679+
api_response = api_instance.get_shared_audience_groups(page, description=description, status=status, size=size, create_route=create_route, includes_owned_audience_groups=includes_owned_audience_groups)
825680
print("The response of ManageAudience->get_shared_audience_groups:\n")
826681
pprint(api_response)
827682
except Exception as e:
@@ -838,6 +693,7 @@ Name | Type | Description | Notes
838693
**status** | [**AudienceGroupStatus**](.md)| The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion. | [optional]
839694
**size** | **int**| The number of audiences per page. Default: 20 Max: 40 | [optional]
840695
**create_route** | [**AudienceGroupCreateRoute**](.md)| How the audience was created. If omitted, all audiences are included. &#x60;OA_MANAGER&#x60;: Return only audiences created with LINE Official Account Manager (opens new window). &#x60;MESSAGING_API&#x60;: Return only audiences created with Messaging API. | [optional]
696+
**includes_owned_audience_groups** | **bool**| true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager | [optional] [default to False]
841697

842698
### Return type
843699

@@ -859,79 +715,6 @@ Name | Type | Description | Notes
859715

860716
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
861717

862-
# **update_audience_group_authority_level**
863-
> update_audience_group_authority_level(update_audience_group_authority_level_request)
864-
865-
866-
867-
Change the authority level of the audience
868-
869-
### Example
870-
871-
* Bearer Authentication (Bearer):
872-
```python
873-
import time
874-
import os
875-
import linebot.v3.audience
876-
from linebot.v3.audience.models.update_audience_group_authority_level_request import UpdateAudienceGroupAuthorityLevelRequest
877-
from linebot.v3.audience.rest import ApiException
878-
from pprint import pprint
879-
880-
# Defining the host is optional and defaults to https://api.line.me
881-
# See configuration.py for a list of all supported configuration parameters.
882-
configuration = linebot.v3.audience.Configuration(
883-
host = "https://api.line.me"
884-
)
885-
886-
# The client must configure the authentication and authorization parameters
887-
# in accordance with the API server security policy.
888-
# Examples for each auth method are provided below, use the example that
889-
# satisfies your auth use case.
890-
891-
# Configure Bearer authorization: Bearer
892-
configuration = linebot.v3.audience.Configuration(
893-
access_token = os.environ["BEARER_TOKEN"]
894-
)
895-
896-
# Enter a context with an instance of the API client
897-
with linebot.v3.audience.ApiClient(configuration) as api_client:
898-
# Create an instance of the API class
899-
api_instance = linebot.v3.audience.ManageAudience(api_client)
900-
update_audience_group_authority_level_request = linebot.v3.audience.UpdateAudienceGroupAuthorityLevelRequest() # UpdateAudienceGroupAuthorityLevelRequest |
901-
902-
try:
903-
api_instance.update_audience_group_authority_level(update_audience_group_authority_level_request)
904-
except Exception as e:
905-
print("Exception when calling ManageAudience->update_audience_group_authority_level: %s\n" % e)
906-
```
907-
908-
909-
### Parameters
910-
911-
Name | Type | Description | Notes
912-
------------- | ------------- | ------------- | -------------
913-
**update_audience_group_authority_level_request** | [**UpdateAudienceGroupAuthorityLevelRequest**](UpdateAudienceGroupAuthorityLevelRequest.md)| |
914-
915-
### Return type
916-
917-
void (empty response body)
918-
919-
### Authorization
920-
921-
[Bearer](../README.md#Bearer)
922-
923-
### HTTP request headers
924-
925-
- **Content-Type**: application/json
926-
- **Accept**: Not defined
927-
928-
### HTTP response details
929-
| Status code | Description | Response headers |
930-
|-------------|-------------|------------------|
931-
**200** | OK | - |
932-
933-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
934-
935718
# **update_audience_group_description**
936719
> update_audience_group_description(audience_group_id, update_audience_group_description_request)
937720

linebot/v3/audience/models/__init__.py

-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
from linebot.v3.audience.models.add_audience_to_audience_group_request import AddAudienceToAudienceGroupRequest
1919
from linebot.v3.audience.models.audience import Audience
2020
from linebot.v3.audience.models.audience_group import AudienceGroup
21-
from linebot.v3.audience.models.audience_group_authority_level import AudienceGroupAuthorityLevel
2221
from linebot.v3.audience.models.audience_group_create_route import AudienceGroupCreateRoute
2322
from linebot.v3.audience.models.audience_group_failed_type import AudienceGroupFailedType
2423
from linebot.v3.audience.models.audience_group_job import AudienceGroupJob
@@ -38,9 +37,7 @@
3837
from linebot.v3.audience.models.error_detail import ErrorDetail
3938
from linebot.v3.audience.models.error_response import ErrorResponse
4039
from linebot.v3.audience.models.get_audience_data_response import GetAudienceDataResponse
41-
from linebot.v3.audience.models.get_audience_group_authority_level_response import GetAudienceGroupAuthorityLevelResponse
4240
from linebot.v3.audience.models.get_audience_groups_response import GetAudienceGroupsResponse
4341
from linebot.v3.audience.models.get_shared_audience_data_response import GetSharedAudienceDataResponse
4442
from linebot.v3.audience.models.get_shared_audience_groups_response import GetSharedAudienceGroupsResponse
45-
from linebot.v3.audience.models.update_audience_group_authority_level_request import UpdateAudienceGroupAuthorityLevelRequest
4643
from linebot.v3.audience.models.update_audience_group_description_request import UpdateAudienceGroupDescriptionRequest

linebot/v3/audience/models/audience_group_authority_level.py

-40
This file was deleted.

0 commit comments

Comments
 (0)