Appearance
@line/bot-sdk / Exports / manageAudience
Namespace: manageAudience
Table of contents
Namespaces
- AudienceGroup
- AudienceGroupJob
- CreateAudienceGroupResponse
- CreateClickBasedAudienceGroupResponse
- CreateImpBasedAudienceGroupResponse
- GetAudienceGroupAuthorityLevelResponse
- UpdateAudienceGroupAuthorityLevelRequest
Classes
Type Aliases
- AddAudienceToAudienceGroupRequest
- Audience
- AudienceGroup
- AudienceGroupAuthorityLevel
- AudienceGroupCreateRoute
- AudienceGroupFailedType
- AudienceGroupJob
- AudienceGroupJobFailedType
- AudienceGroupJobStatus
- AudienceGroupJobType
- AudienceGroupPermission
- AudienceGroupStatus
- AudienceGroupType
- CreateAudienceGroupRequest
- CreateAudienceGroupResponse
- CreateClickBasedAudienceGroupRequest
- CreateClickBasedAudienceGroupResponse
- CreateImpBasedAudienceGroupRequest
- CreateImpBasedAudienceGroupResponse
- ErrorDetail
- ErrorResponse
- GetAudienceDataResponse
- GetAudienceGroupAuthorityLevelResponse
- GetAudienceGroupsResponse
- UpdateAudienceGroupAuthorityLevelRequest
- UpdateAudienceGroupDescriptionRequest
Type Aliases
AddAudienceToAudienceGroupRequest
Ƭ AddAudienceToAudienceGroupRequest: Object
Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)
Type declaration
| Name | Type | Description |
|---|---|---|
audienceGroupId? | number | The audience ID. See audienceGroupId Documentation |
audiences? | Audience[] | An array of up to 10,000 user IDs or IFAs. See audiences Documentation |
uploadDescription? | string | The audience's name. See uploadDescription Documentation |
Defined in
lib/manage-audience/model/addAudienceToAudienceGroupRequest.ts:18
Audience
Ƭ Audience: Object
Audience
Type declaration
| Name | Type | Description |
|---|---|---|
id? | string | A user ID or IFA. You can specify an empty array. |
Defined in
lib/manage-audience/model/audience.ts:16
AudienceGroup
Ƭ AudienceGroup: Object
Audience group
Type declaration
| Name | Type | Description |
|---|---|---|
audienceCount? | number | The number of users included in the audience. |
audienceGroupId? | number | The audience ID. |
clickUrl? | string | The URL that was specified when the audience was created. This is only included when audienceGroup.type is CLICK and link URL is specified. |
createRoute? | AudienceGroupCreateRoute | |
created? | number | When the audience was created (in UNIX time). |
description? | string | The audience's name. |
failedType? | AudienceGroupFailedType | null | |
isIfaAudience? | boolean | The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. |
permission? | AudienceGroupPermission | |
requestId? | string | The request ID that was specified when the audience was created. This is only included when audienceGroup.type is CLICK or IMP. |
status? | AudienceGroupStatus | |
type? | AudienceGroupType |
Defined in
lib/manage-audience/model/audienceGroup.ts:22
lib/manage-audience/model/audienceGroup.ts:68
AudienceGroupAuthorityLevel
Ƭ AudienceGroupAuthorityLevel: "PUBLIC" | "PRIVATE"
authority level
Defined in
lib/manage-audience/model/audienceGroupAuthorityLevel.ts:17
AudienceGroupCreateRoute
Ƭ AudienceGroupCreateRoute: "OA_MANAGER" | "MESSAGING_API" | "POINT_AD" | "AD_MANAGER"
How the audience was created. One of: - OA_MANAGER: Audience created with LINE Official Account Manager. - MESSAGING_API: Audience created with Messaging API. - POINT_AD: Audience created with LINE Points Ads (Japanese only). - AD_MANAGER: Audience created with LINE Ads.
Defined in
lib/manage-audience/model/audienceGroupCreateRoute.ts:17
AudienceGroupFailedType
Ƭ AudienceGroupFailedType: "AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT" | "INTERNAL_ERROR" | "null"
Failed type
Defined in
lib/manage-audience/model/audienceGroupFailedType.ts:17
AudienceGroupJob
Ƭ AudienceGroupJob: Object
Audience group job
Type declaration
| Name | Type | Description |
|---|---|---|
audienceCount? | number | The number of accounts (recipients) that were added or removed. See audienceCount Documentation |
audienceGroupId? | number | An audience ID. See audienceGroupId Documentation |
audienceGroupJobId? | number | A job ID. See audienceGroupJobId Documentation |
created? | number | When the job was created (in UNIX time). See created Documentation |
description? | string | The job's description. See description Documentation |
failedType? | AudienceGroupJobFailedType | See failedType Documentation |
jobStatus? | AudienceGroupJobStatus | See jobStatus Documentation |
type? | AudienceGroupJobType | See type Documentation |
Defined in
lib/manage-audience/model/audienceGroupJob.ts:20
lib/manage-audience/model/audienceGroupJob.ts:68
AudienceGroupJobFailedType
Ƭ AudienceGroupJobFailedType: "INTERNAL_ERROR" | "AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT"
Failed type
Defined in
lib/manage-audience/model/audienceGroupJobFailedType.ts:17
AudienceGroupJobStatus
Ƭ AudienceGroupJobStatus: "QUEUED" | "WORKING" | "FINISHED" | "FAILED"
Job status
Defined in
lib/manage-audience/model/audienceGroupJobStatus.ts:17
AudienceGroupJobType
Ƭ AudienceGroupJobType: "DIFF_ADD"
Job Type
Defined in
lib/manage-audience/model/audienceGroupJobType.ts:17
AudienceGroupPermission
Ƭ AudienceGroupPermission: "READ" | "READ_WRITE"
Permission
Defined in
lib/manage-audience/model/audienceGroupPermission.ts:17
AudienceGroupStatus
Ƭ AudienceGroupStatus: "IN_PROGRESS" | "READY" | "FAILED" | "EXPIRED" | "INACTIVE" | "ACTIVATING"
Status
Defined in
lib/manage-audience/model/audienceGroupStatus.ts:17
AudienceGroupType
Ƭ AudienceGroupType: "UPLOAD" | "CLICK" | "IMP" | "CHAT_TAG" | "FRIEND_PATH" | "RESERVATION" | "APP_EVENT" | "VIDEO_VIEW" | "WEBTRAFFIC" | "IMAGE_CLICK" | "RICHMENU_IMP" | "RICHMENU_CLICK"
Audience group type
Defined in
lib/manage-audience/model/audienceGroupType.ts:17
CreateAudienceGroupRequest
Ƭ CreateAudienceGroupRequest: Object
Create audience for uploading user IDs (by JSON)
Type declaration
| Name | Type | Description |
|---|---|---|
audiences? | Audience[] | An array of user IDs or IFAs. Max number: 10,000 See audiences Documentation |
description? | string | The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation |
isIfaAudience? | boolean | To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property. See isIfaAudience Documentation |
uploadDescription? | string | The description to register for the job (in jobs[].description). See uploadDescription Documentation |
Defined in
lib/manage-audience/model/createAudienceGroupRequest.ts:18
CreateAudienceGroupResponse
Ƭ CreateAudienceGroupResponse: Object
Create audience for uploading user IDs (by JSON)
Type declaration
| Name | Type | Description |
|---|---|---|
audienceGroupId? | number | The audience ID. See audienceGroupId Documentation |
createRoute? | CreateRouteEnum | How the audience was created. MESSAGING_API: An audience created with Messaging API. See createRoute Documentation |
created? | number | When the audience was created (in UNIX time). See created Documentation |
description? | string | The audience's name. See description Documentation |
expireTimestamp? | number | Time of audience expiration. Only returned for specific audiences. See expireTimestamp Documentation |
isIfaAudience? | boolean | The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. See isIfaAudience Documentation |
permission? | PermissionEnum | Audience's update permission. Audiences linked to the same channel will be READ_WRITE. READ: Can use only. READ_WRITE: Can use and update. See permission Documentation |
type? | AudienceGroupType | See type Documentation |
Defined in
lib/manage-audience/model/createAudienceGroupResponse.ts:18
lib/manage-audience/model/createAudienceGroupResponse.ts:68
CreateClickBasedAudienceGroupRequest
Ƭ CreateClickBasedAudienceGroupRequest: Object
Create audience for click-based retargeting
Type declaration
| Name | Type | Description |
|---|---|---|
clickUrl? | string | The URL clicked by the user. If empty, users who clicked any URL in the message are added to the list of recipients. Max character limit: 2,000 See clickUrl Documentation |
description? | string | The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation |
requestId? | string | The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. See requestId Documentation |
Defined in
lib/manage-audience/model/createClickBasedAudienceGroupRequest.ts:16
CreateClickBasedAudienceGroupResponse
Ƭ CreateClickBasedAudienceGroupResponse: Object
Create audience for click-based retargeting
Type declaration
| Name | Type | Description |
|---|---|---|
audienceGroupId? | number | The audience ID. See audienceGroupId Documentation |
clickUrl? | string | The URL that was specified when the audience was created. See clickUrl Documentation |
createRoute? | CreateRouteEnum | How the audience was created. MESSAGING_API: An audience created with Messaging API. See createRoute Documentation |
created? | number | When the audience was created (in UNIX time). See created Documentation |
description? | string | The audience's name. See description Documentation |
expireTimestamp? | number | Time of audience expiration. Only returned for specific audiences. See expireTimestamp Documentation |
isIfaAudience? | boolean | The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. One of: true: Accounts are specified with IFAs. false (default): Accounts are specified with user IDs. See isIfaAudience Documentation |
permission? | PermissionEnum | Audience's update permission. Audiences linked to the same channel will be READ_WRITE. - READ: Can use only. - READ_WRITE: Can use and update. See permission Documentation |
requestId? | string | The request ID that was specified when the audience was created. See requestId Documentation |
type? | AudienceGroupType | See type Documentation |
Defined in
lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:18
lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts:80
CreateImpBasedAudienceGroupRequest
Ƭ CreateImpBasedAudienceGroupRequest: Object
Create audience for impression-based retargeting
Type declaration
| Name | Type | Description |
|---|---|---|
description? | string | The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation |
requestId? | string | The request ID of a broadcast or narrowcast message sent in the past 60 days. Each Messaging API request has a request ID. See requestId Documentation |
Defined in
lib/manage-audience/model/createImpBasedAudienceGroupRequest.ts:16
CreateImpBasedAudienceGroupResponse
Ƭ CreateImpBasedAudienceGroupResponse: Object
Create audience for impression-based retargeting
Type declaration
| Name | Type | Description |
|---|---|---|
audienceGroupId? | number | The audience ID. See audienceGroupId Documentation |
created? | number | When the audience was created (in UNIX time). See created Documentation |
description? | string | The audience's name. See description Documentation |
requestId? | string | The request ID that was specified when the audience was created. See requestId Documentation |
type? | AudienceGroupType | See type Documentation |
Defined in
lib/manage-audience/model/createImpBasedAudienceGroupResponse.ts:18
lib/manage-audience/model/createImpBasedAudienceGroupResponse.ts:50
ErrorDetail
Ƭ ErrorDetail: Object
LINE Messaging API This document describes LINE Messaging API.
The version of the OpenAPI document: 0.0.1
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.
Type declaration
| Name | Type | Description |
|---|---|---|
message? | string | Details of the error. Not included in the response under certain situations. |
property? | string | Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations. |
Defined in
lib/manage-audience/model/errorDetail.ts:13
ErrorResponse
Ƭ ErrorResponse: Object
Type declaration
| Name | Type | Description |
|---|---|---|
details? | ErrorDetail[] | An array of error details. If the array is empty, this property will not be included in the response. See details Documentation |
message | string | Message containing information about the error. See message Documentation |
Defined in
lib/manage-audience/model/errorResponse.ts:15
GetAudienceDataResponse
Ƭ GetAudienceDataResponse: Object
Get audience data
Type declaration
| Name | Type | Description |
|---|---|---|
audienceGroup? | AudienceGroup | See audienceGroup Documentation |
jobs? | AudienceGroupJob[] | An array of jobs. This array is used to keep track of each attempt to add new user IDs or IFAs to an audience for uploading user IDs. Empty array is returned for any other type of audience. Max: 50 See jobs Documentation |
Defined in
lib/manage-audience/model/getAudienceDataResponse.ts:19
GetAudienceGroupAuthorityLevelResponse
Ƭ GetAudienceGroupAuthorityLevelResponse: Object
Get the authority level of the audience
Type declaration
| Name | Type | Description |
|---|---|---|
authorityLevel? | AudienceGroupAuthorityLevel | See authorityLevel Documentation |
Defined in
lib/manage-audience/model/getAudienceGroupAuthorityLevelResponse.ts:18
lib/manage-audience/model/getAudienceGroupAuthorityLevelResponse.ts:26
GetAudienceGroupsResponse
Ƭ GetAudienceGroupsResponse: Object
Gets data for more than one audience.
Type declaration
| Name | Type | Description |
|---|---|---|
audienceGroups? | AudienceGroup[] | An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned. See audienceGroups Documentation |
hasNextPage? | boolean | true when this is not the last page. See hasNextPage Documentation |
page? | number | The current page number. See page Documentation |
readWriteAudienceGroupTotalCount? | number | Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE. See readWriteAudienceGroupTotalCount Documentation |
size? | number | The maximum number of audiences on the current page. See size Documentation |
totalCount? | number | The total number of audiences that can be returned with the specified filter. See totalCount Documentation |
Defined in
lib/manage-audience/model/getAudienceGroupsResponse.ts:18
UpdateAudienceGroupAuthorityLevelRequest
Ƭ UpdateAudienceGroupAuthorityLevelRequest: Object
Change the authority level of the audience
Type declaration
| Name | Type | Description |
|---|---|---|
authorityLevel? | AudienceGroupAuthorityLevel | See authorityLevel Documentation |
Defined in
lib/manage-audience/model/updateAudienceGroupAuthorityLevelRequest.ts:18
lib/manage-audience/model/updateAudienceGroupAuthorityLevelRequest.ts:26
UpdateAudienceGroupDescriptionRequest
Ƭ UpdateAudienceGroupDescriptionRequest: Object
Rename an audience
Type declaration
| Name | Type | Description |
|---|---|---|
description? | string | The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120 See description Documentation |
Defined in
lib/manage-audience/model/updateAudienceGroupDescriptionRequest.ts:16