Appearance
@line/bot-sdk / manageAudience / ManageAudienceClient
Class: ManageAudienceClient
Defined in: lib/manage-audience/api/manageAudienceClient.ts:50
Constructors
new ManageAudienceClient()
new ManageAudienceClient(
config):ManageAudienceClient
Defined in: lib/manage-audience/api/manageAudienceClient.ts:53
Parameters
config
httpClientConfig
Returns
Methods
activateAudienceGroup()
activateAudienceGroup(
audienceGroupId):Promise<MessageAPIResponseBase>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:82
Activate audience
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<MessageAPIResponseBase>
See
activateAudienceGroupWithHttpInfo()
activateAudienceGroupWithHttpInfo(
audienceGroupId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:95
Activate audience. This method includes HttpInfo object to return additional information.
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
addAudienceToAudienceGroup()
addAudienceToAudienceGroup(
addAudienceToAudienceGroupRequest):Promise<MessageAPIResponseBase>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:114
Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)
Parameters
addAudienceToAudienceGroupRequest
AddAudienceToAudienceGroupRequest
Returns
Promise<MessageAPIResponseBase>
See
addAudienceToAudienceGroupWithHttpInfo()
addAudienceToAudienceGroupWithHttpInfo(
addAudienceToAudienceGroupRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:131
Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.
Parameters
addAudienceToAudienceGroupRequest
AddAudienceToAudienceGroupRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
createAudienceGroup()
createAudienceGroup(
createAudienceGroupRequest):Promise<CreateAudienceGroupResponse>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:150
Create audience for uploading user IDs (by JSON)
Parameters
createAudienceGroupRequest
Returns
Promise<CreateAudienceGroupResponse>
See
createAudienceGroupWithHttpInfo()
createAudienceGroupWithHttpInfo(
createAudienceGroupRequest):Promise<ApiResponseType<CreateAudienceGroupResponse>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:165
Create audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.
Parameters
createAudienceGroupRequest
Returns
Promise<ApiResponseType<CreateAudienceGroupResponse>>
See
createClickBasedAudienceGroup()
createClickBasedAudienceGroup(
createClickBasedAudienceGroupRequest):Promise<CreateClickBasedAudienceGroupResponse>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:184
Create audience for click-based retargeting
Parameters
createClickBasedAudienceGroupRequest
CreateClickBasedAudienceGroupRequest
Returns
Promise<CreateClickBasedAudienceGroupResponse>
See
createClickBasedAudienceGroupWithHttpInfo()
createClickBasedAudienceGroupWithHttpInfo(
createClickBasedAudienceGroupRequest):Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:201
Create audience for click-based retargeting. This method includes HttpInfo object to return additional information.
Parameters
createClickBasedAudienceGroupRequest
CreateClickBasedAudienceGroupRequest
Returns
Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>
See
createImpBasedAudienceGroup()
createImpBasedAudienceGroup(
createImpBasedAudienceGroupRequest):Promise<CreateImpBasedAudienceGroupResponse>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:220
Create audience for impression-based retargeting
Parameters
createImpBasedAudienceGroupRequest
CreateImpBasedAudienceGroupRequest
Returns
Promise<CreateImpBasedAudienceGroupResponse>
See
createImpBasedAudienceGroupWithHttpInfo()
createImpBasedAudienceGroupWithHttpInfo(
createImpBasedAudienceGroupRequest):Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:237
Create audience for impression-based retargeting. This method includes HttpInfo object to return additional information.
Parameters
createImpBasedAudienceGroupRequest
CreateImpBasedAudienceGroupRequest
Returns
Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>
See
deleteAudienceGroup()
deleteAudienceGroup(
audienceGroupId):Promise<MessageAPIResponseBase>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:253
Delete audience
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<MessageAPIResponseBase>
See
deleteAudienceGroupWithHttpInfo()
deleteAudienceGroupWithHttpInfo(
audienceGroupId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:266
Delete audience. This method includes HttpInfo object to return additional information.
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
getAudienceData()
getAudienceData(
audienceGroupId):Promise<GetAudienceDataResponse>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:285
Gets audience data.
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<GetAudienceDataResponse>
See
getAudienceDataWithHttpInfo()
getAudienceDataWithHttpInfo(
audienceGroupId):Promise<ApiResponseType<GetAudienceDataResponse>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:298
Gets audience data.. This method includes HttpInfo object to return additional information.
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<ApiResponseType<GetAudienceDataResponse>>
See
getAudienceGroupAuthorityLevel()
getAudienceGroupAuthorityLevel():
Promise<GetAudienceGroupAuthorityLevelResponse>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:316
Get the authority level of the audience
Returns
Promise<GetAudienceGroupAuthorityLevelResponse>
See
getAudienceGroupAuthorityLevelWithHttpInfo()
getAudienceGroupAuthorityLevelWithHttpInfo():
Promise<ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:326
Get the authority level of the audience. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>
See
getAudienceGroups()
getAudienceGroups(
page,description?,status?,size?,includesExternalPublicGroups?,createRoute?):Promise<GetAudienceGroupsResponse>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:347
Gets data for more than one audience.
Parameters
page
number
The page to return when getting (paginated) results. Must be 1 or higher.
description?
string
The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
status?
The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
size?
number
The number of audiences per page. Default: 20 Max: 40
includesExternalPublicGroups?
boolean
true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
createRoute?
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.
Returns
Promise<GetAudienceGroupsResponse>
See
getAudienceGroupsWithHttpInfo()
getAudienceGroupsWithHttpInfo(
page,description?,status?,size?,includesExternalPublicGroups?,createRoute?):Promise<ApiResponseType<GetAudienceGroupsResponse>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:379
Gets data for more than one audience.. This method includes HttpInfo object to return additional information.
Parameters
page
number
The page to return when getting (paginated) results. Must be 1 or higher.
description?
string
The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
status?
The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
size?
number
The number of audiences per page. Default: 20 Max: 40
includesExternalPublicGroups?
boolean
true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
createRoute?
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.
Returns
Promise<ApiResponseType<GetAudienceGroupsResponse>>
See
getSharedAudienceData()
getSharedAudienceData(
audienceGroupId):Promise<GetSharedAudienceDataResponse>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:415
Gets audience data.
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<GetSharedAudienceDataResponse>
See
getSharedAudienceDataWithHttpInfo()
getSharedAudienceDataWithHttpInfo(
audienceGroupId):Promise<ApiResponseType<GetSharedAudienceDataResponse>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:428
Gets audience data.. This method includes HttpInfo object to return additional information.
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<ApiResponseType<GetSharedAudienceDataResponse>>
See
getSharedAudienceGroups()
getSharedAudienceGroups(
page,description?,status?,size?,createRoute?):Promise<GetSharedAudienceGroupsResponse>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:451
Gets data for more than one audience, including those shared by the Business Manager.
Parameters
page
number
The page to return when getting (paginated) results. Must be 1 or higher.
description?
string
The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
status?
The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
size?
number
The number of audiences per page. Default: 20 Max: 40
createRoute?
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.
Returns
Promise<GetSharedAudienceGroupsResponse>
See
getSharedAudienceGroupsWithHttpInfo()
getSharedAudienceGroupsWithHttpInfo(
page,description?,status?,size?,createRoute?):Promise<ApiResponseType<GetSharedAudienceGroupsResponse>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:480
Gets data for more than one audience, including those shared by the Business Manager.. This method includes HttpInfo object to return additional information.
Parameters
page
number
The page to return when getting (paginated) results. Must be 1 or higher.
description?
string
The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
status?
The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
size?
number
The number of audiences per page. Default: 20 Max: 40
createRoute?
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.
Returns
Promise<ApiResponseType<GetSharedAudienceGroupsResponse>>
See
updateAudienceGroupAuthorityLevel()
updateAudienceGroupAuthorityLevel(
updateAudienceGroupAuthorityLevelRequest):Promise<MessageAPIResponseBase>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:514
Change the authority level of the audience
Parameters
updateAudienceGroupAuthorityLevelRequest
UpdateAudienceGroupAuthorityLevelRequest
Returns
Promise<MessageAPIResponseBase>
See
updateAudienceGroupAuthorityLevelWithHttpInfo()
updateAudienceGroupAuthorityLevelWithHttpInfo(
updateAudienceGroupAuthorityLevelRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:531
Change the authority level of the audience. This method includes HttpInfo object to return additional information.
Parameters
updateAudienceGroupAuthorityLevelRequest
UpdateAudienceGroupAuthorityLevelRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
updateAudienceGroupDescription()
updateAudienceGroupDescription(
audienceGroupId,updateAudienceGroupDescriptionRequest):Promise<MessageAPIResponseBase>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:551
Renames an existing audience.
Parameters
audienceGroupId
number
The audience ID.
updateAudienceGroupDescriptionRequest
UpdateAudienceGroupDescriptionRequest
Returns
Promise<MessageAPIResponseBase>
See
updateAudienceGroupDescriptionWithHttpInfo()
updateAudienceGroupDescriptionWithHttpInfo(
audienceGroupId,updateAudienceGroupDescriptionRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/manage-audience/api/manageAudienceClient.ts:571
Renames an existing audience.. This method includes HttpInfo object to return additional information.
Parameters
audienceGroupId
number
The audience ID.
updateAudienceGroupDescriptionRequest
UpdateAudienceGroupDescriptionRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>