Appearance
@line/bot-sdk / manageAudience / ManageAudienceBlobClient
Class: ManageAudienceBlobClient
Defined in: lib/manage-audience/api/manageAudienceBlobClient.ts:34
Constructors
new ManageAudienceBlobClient()
new ManageAudienceBlobClient(
config
):ManageAudienceBlobClient
Defined in: lib/manage-audience/api/manageAudienceBlobClient.ts:37
Parameters
config
httpClientConfig
Returns
Methods
addUserIdsToAudience()
addUserIdsToAudience(
file
,audienceGroupId
?,uploadDescription
?):Promise
<MessageAPIResponseBase
>
Defined in: lib/manage-audience/api/manageAudienceBlobClient.ts:68
Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).
Parameters
file
Blob
A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
audienceGroupId?
number
The audience ID.
uploadDescription?
string
The description to register with the job
Returns
Promise
<MessageAPIResponseBase
>
See
addUserIdsToAudienceWithHttpInfo()
addUserIdsToAudienceWithHttpInfo(
file
,audienceGroupId
?,uploadDescription
?):Promise
<ApiResponseType
<MessageAPIResponseBase
>>
Defined in: lib/manage-audience/api/manageAudienceBlobClient.ts:91
Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).. This method includes HttpInfo object to return additional information.
Parameters
file
Blob
A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
audienceGroupId?
number
The audience ID.
uploadDescription?
string
The description to register with the job
Returns
Promise
<ApiResponseType
<MessageAPIResponseBase
>>
See
createAudienceForUploadingUserIds()
createAudienceForUploadingUserIds(
file
,description
?,isIfaAudience
?,uploadDescription
?):Promise
<CreateAudienceGroupResponse
>
Defined in: lib/manage-audience/api/manageAudienceBlobClient.ts:118
Create audience for uploading user IDs (by file).
Parameters
file
Blob
A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
description?
string
The audience\'s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
isIfaAudience?
boolean
To specify recipients by IFAs: set true
. To specify recipients by user IDs: set false
or omit isIfaAudience property.
uploadDescription?
string
The description to register for the job (in jobs[].description
).
Returns
Promise
<CreateAudienceGroupResponse
>
See
createAudienceForUploadingUserIdsWithHttpInfo()
createAudienceForUploadingUserIdsWithHttpInfo(
file
,description
?,isIfaAudience
?,uploadDescription
?):Promise
<ApiResponseType
<CreateAudienceGroupResponse
>>
Defined in: lib/manage-audience/api/manageAudienceBlobClient.ts:144
Create audience for uploading user IDs (by file).. This method includes HttpInfo object to return additional information.
Parameters
file
Blob
A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
description?
string
The audience\'s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
isIfaAudience?
boolean
To specify recipients by IFAs: set true
. To specify recipients by user IDs: set false
or omit isIfaAudience property.
uploadDescription?
string
The description to register for the job (in jobs[].description
).
Returns
Promise
<ApiResponseType
<CreateAudienceGroupResponse
>>