Appearance
@line/bot-sdk • Docs
@line/bot-sdk / manageAudience / ManageAudienceClient
Class: ManageAudienceClient
Constructors
new ManageAudienceClient()
new ManageAudienceClient(
config):ManageAudienceClient
Parameters
• config: httpClientConfig
Returns
Defined in
lib/manage-audience/api/manageAudienceClient.ts:51
Methods
activateAudienceGroup()
activateAudienceGroup(
audienceGroupId):Promise<MessageAPIResponseBase>
Activate audience
Parameters
• audienceGroupId: number
The audience ID.
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:80
activateAudienceGroupWithHttpInfo()
activateAudienceGroupWithHttpInfo(
audienceGroupId):Promise<ApiResponseType<MessageAPIResponseBase>>
Activate audience. This method includes HttpInfo object to return additional information.
Parameters
• audienceGroupId: number
The audience ID.
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:93
addAudienceToAudienceGroup()
addAudienceToAudienceGroup(
addAudienceToAudienceGroupRequest):Promise<MessageAPIResponseBase>
Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)
Parameters
• addAudienceToAudienceGroupRequest: AddAudienceToAudienceGroupRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:110
addAudienceToAudienceGroupWithHttpInfo()
addAudienceToAudienceGroupWithHttpInfo(
addAudienceToAudienceGroupRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
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
Defined in
lib/manage-audience/api/manageAudienceClient.ts:127
createAudienceGroup()
createAudienceGroup(
createAudienceGroupRequest):Promise<CreateAudienceGroupResponse>
Create audience for uploading user IDs (by JSON)
Parameters
• createAudienceGroupRequest: CreateAudienceGroupRequest
Returns
Promise<CreateAudienceGroupResponse>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:144
createAudienceGroupWithHttpInfo()
createAudienceGroupWithHttpInfo(
createAudienceGroupRequest):Promise<ApiResponseType<CreateAudienceGroupResponse>>
Create audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.
Parameters
• createAudienceGroupRequest: CreateAudienceGroupRequest
Returns
Promise<ApiResponseType<CreateAudienceGroupResponse>>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:159
createClickBasedAudienceGroup()
createClickBasedAudienceGroup(
createClickBasedAudienceGroupRequest):Promise<CreateClickBasedAudienceGroupResponse>
Create audience for click-based retargeting
Parameters
• createClickBasedAudienceGroupRequest: CreateClickBasedAudienceGroupRequest
Returns
Promise<CreateClickBasedAudienceGroupResponse>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:176
createClickBasedAudienceGroupWithHttpInfo()
createClickBasedAudienceGroupWithHttpInfo(
createClickBasedAudienceGroupRequest):Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>
Create audience for click-based retargeting. This method includes HttpInfo object to return additional information.
Parameters
• createClickBasedAudienceGroupRequest: CreateClickBasedAudienceGroupRequest
Returns
Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:193
createImpBasedAudienceGroup()
createImpBasedAudienceGroup(
createImpBasedAudienceGroupRequest):Promise<CreateImpBasedAudienceGroupResponse>
Create audience for impression-based retargeting
Parameters
• createImpBasedAudienceGroupRequest: CreateImpBasedAudienceGroupRequest
Returns
Promise<CreateImpBasedAudienceGroupResponse>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:210
createImpBasedAudienceGroupWithHttpInfo()
createImpBasedAudienceGroupWithHttpInfo(
createImpBasedAudienceGroupRequest):Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>
Create audience for impression-based retargeting. This method includes HttpInfo object to return additional information.
Parameters
• createImpBasedAudienceGroupRequest: CreateImpBasedAudienceGroupRequest
Returns
Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:227
deleteAudienceGroup()
deleteAudienceGroup(
audienceGroupId):Promise<MessageAPIResponseBase>
Delete audience
Parameters
• audienceGroupId: number
The audience ID.
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:241
deleteAudienceGroupWithHttpInfo()
deleteAudienceGroupWithHttpInfo(
audienceGroupId):Promise<ApiResponseType<MessageAPIResponseBase>>
Delete audience. This method includes HttpInfo object to return additional information.
Parameters
• audienceGroupId: number
The audience ID.
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:254
getAudienceData()
getAudienceData(
audienceGroupId):Promise<GetAudienceDataResponse>
Gets audience data.
Parameters
• audienceGroupId: number
The audience ID.
Returns
Promise<GetAudienceDataResponse>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:271
getAudienceDataWithHttpInfo()
getAudienceDataWithHttpInfo(
audienceGroupId):Promise<ApiResponseType<GetAudienceDataResponse>>
Gets audience data.. This method includes HttpInfo object to return additional information.
Parameters
• audienceGroupId: number
The audience ID.
Returns
Promise<ApiResponseType<GetAudienceDataResponse>>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:284
getAudienceGroupAuthorityLevel()
getAudienceGroupAuthorityLevel():
Promise<GetAudienceGroupAuthorityLevelResponse>
Get the authority level of the audience
Returns
Promise<GetAudienceGroupAuthorityLevelResponse>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:300
getAudienceGroupAuthorityLevelWithHttpInfo()
getAudienceGroupAuthorityLevelWithHttpInfo():
Promise<ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>
Get the authority level of the audience. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:310
getAudienceGroups()
getAudienceGroups(
page,description?,status?,size?,includesExternalPublicGroups?,createRoute?):Promise<GetAudienceGroupsResponse>
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?: 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.
• 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?: 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.
Returns
Promise<GetAudienceGroupsResponse>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:329
getAudienceGroupsWithHttpInfo()
getAudienceGroupsWithHttpInfo(
page,description?,status?,size?,includesExternalPublicGroups?,createRoute?):Promise<ApiResponseType<GetAudienceGroupsResponse>>
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?: 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.
• 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?: 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.
Returns
Promise<ApiResponseType<GetAudienceGroupsResponse>>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:361
updateAudienceGroupAuthorityLevel()
updateAudienceGroupAuthorityLevel(
updateAudienceGroupAuthorityLevelRequest):Promise<MessageAPIResponseBase>
Change the authority level of the audience
Parameters
• updateAudienceGroupAuthorityLevelRequest: UpdateAudienceGroupAuthorityLevelRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:395
updateAudienceGroupAuthorityLevelWithHttpInfo()
updateAudienceGroupAuthorityLevelWithHttpInfo(
updateAudienceGroupAuthorityLevelRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Change the authority level of the audience. This method includes HttpInfo object to return additional information.
Parameters
• updateAudienceGroupAuthorityLevelRequest: UpdateAudienceGroupAuthorityLevelRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:412
updateAudienceGroupDescription()
updateAudienceGroupDescription(
audienceGroupId,updateAudienceGroupDescriptionRequest):Promise<MessageAPIResponseBase>
Renames an existing audience.
Parameters
• audienceGroupId: number
The audience ID.
• updateAudienceGroupDescriptionRequest: UpdateAudienceGroupDescriptionRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/manage-audience/api/manageAudienceClient.ts:430
updateAudienceGroupDescriptionWithHttpInfo()
updateAudienceGroupDescriptionWithHttpInfo(
audienceGroupId,updateAudienceGroupDescriptionRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
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>>