LINE.Bot.ManageAudienceBlob (line_bot_sdk v0.1.0)

Copy Markdown

API calls for all endpoints tagged ManageAudienceBlob.

Summary

Functions

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).

Create a new ManageAudienceBlob client.

Functions

add_user_ids_to_audience(client, file, optional_args \\ [], client_opts \\ [])

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).

Parameters

  • client (Req.Request.t/0): Client to make request with
  • file (String.t/0): 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
  • optional_args (keyword): Optional parameters
    • :audience_group_id (integer()/0): The audience ID.
    • :upload_description (String.t/0): The description to register with the job
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

create_audience_for_uploading_user_ids(client, file, optional_args \\ [], client_opts \\ [])

Create audience for uploading user IDs (by file).

Parameters

  • client (Req.Request.t/0): Client to make request with
  • file (String.t/0): 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
  • optional_args (keyword): Optional parameters
    • :description (String.t/0): The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
    • :is_ifa_audience (boolean()/0): To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.
    • :upload_description (String.t/0): The description to register for the job (in jobs[].description).
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.CreateAudienceGroupResponse.t} on success
  • {:error, Req.Response.t} on failure

new(options \\ [])

Create a new ManageAudienceBlob client.

Options

  • :base_url - base URL for requests (default: "https://api.line.me")
  • :channel_token (required) - channel access token for Bearer authorization
  • :plug - plug to use for testing (see Req.new/1)