@line/bot-sdk/lib/manage-audience/model/createClickBasedAudienceGroupResponse.ts

Node.js SDK for LINE Messaging API

/**
 * 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.
 */

import { AudienceGroupType } from "./audienceGroupType.js";

/**
 * Create audience for click-based retargeting
 */
export type CreateClickBasedAudienceGroupResponse = {
  /**
   * The audience ID.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">audienceGroupId Documentation</a>
   */
  audienceGroupId?: number /**/;
  /**
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">type Documentation</a>
   */
  type?: AudienceGroupType /**/;
  /**
   * The audience\'s name.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">description Documentation</a>
   */
  description?: string /**/;
  /**
   * When the audience was created (in UNIX time).
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">created Documentation</a>
   */
  created?: number /**/;
  /**
   * The request ID that was specified when the audience was created.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">requestId Documentation</a>
   */
  requestId?: string /**/;
  /**
   * The URL that was specified when the audience was created.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">clickUrl Documentation</a>
   */
  clickUrl?: string /**/;
  /**
   * How the audience was created. `MESSAGING_API`: An audience created with Messaging API.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">createRoute Documentation</a>
   */
  createRoute?: CreateClickBasedAudienceGroupResponse.CreateRouteEnum /**/;
  /**
   * 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 <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">permission Documentation</a>
   */
  permission?: CreateClickBasedAudienceGroupResponse.PermissionEnum /**/;
  /**
   * Time of audience expiration. Only returned for specific audiences.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">expireTimestamp Documentation</a>
   */
  expireTimestamp?: number /**/;
  /**
   * 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 <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group">isIfaAudience Documentation</a>
   */
  isIfaAudience?: boolean /* = false*/;
};

export namespace CreateClickBasedAudienceGroupResponse {
  export type CreateRouteEnum = "MESSAGING_API";

  export type PermissionEnum = "READ" | "READ_WRITE";
}