UNPKG

3.36 kBTypeScriptView Raw
1/**
2 * LINE Messaging API
3 * This document describes LINE Messaging API.
4 *
5 * The version of the OpenAPI document: 0.0.1
6 *
7 *
8 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9 * https://openapi-generator.tech
10 * Do not edit the class manually.
11 */
12import { AudienceGroupType } from "./audienceGroupType";
13/**
14 * Create audience for click-based retargeting
15 */
16export type CreateClickBasedAudienceGroupResponse = {
17 /**
18 * The audience ID.
19 *
20 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">audienceGroupId Documentation</a>
21 */
22 audienceGroupId?: number;
23 /**
24 *
25 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">type Documentation</a>
26 */
27 type?: AudienceGroupType;
28 /**
29 * The audience\'s name.
30 *
31 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">description Documentation</a>
32 */
33 description?: string;
34 /**
35 * When the audience was created (in UNIX time).
36 *
37 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">created Documentation</a>
38 */
39 created?: number;
40 /**
41 * The request ID that was specified when the audience was created.
42 *
43 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">requestId Documentation</a>
44 */
45 requestId?: string;
46 /**
47 * The URL that was specified when the audience was created.
48 *
49 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">clickUrl Documentation</a>
50 */
51 clickUrl?: string;
52 /**
53 * How the audience was created. `MESSAGING_API`: An audience created with Messaging API.
54 *
55 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">createRoute Documentation</a>
56 */
57 createRoute?: CreateClickBasedAudienceGroupResponse.CreateRouteEnum;
58 /**
59 * Audience\'s update permission. Audiences linked to the same channel will be READ_WRITE. - `READ`: Can use only. - `READ_WRITE`: Can use and update.
60 *
61 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">permission Documentation</a>
62 */
63 permission?: CreateClickBasedAudienceGroupResponse.PermissionEnum;
64 /**
65 * Time of audience expiration. Only returned for specific audiences.
66 *
67 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">expireTimestamp Documentation</a>
68 */
69 expireTimestamp?: number;
70 /**
71 * 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.
72 *
73 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">isIfaAudience Documentation</a>
74 */
75 isIfaAudience?: boolean;
76};
77export declare namespace CreateClickBasedAudienceGroupResponse {
78 type CreateRouteEnum = "MESSAGING_API";
79 type PermissionEnum = "READ" | "READ_WRITE";
80}