Package com.linecorp.bot.client

Interface ManageAudienceClient

public interface ManageAudienceClient

  • Method Summary

    Modifier and Type
    Method
    Description
    CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>
    addAudienceToAudienceGroup(com.linecorp.bot.model.manageaudience.request.AddAudienceToAudienceGroupRequest request)
    Adds new user IDs or IFAs to an audience for uploading user IDs.
    static ManageAudienceClientBuilder
    builder()
     
    CompletableFuture<com.linecorp.bot.model.manageaudience.response.CreateAudienceGroupResponse>
    createAudienceGroup(com.linecorp.bot.model.manageaudience.request.CreateAudienceGroupRequest request)
    Creates an audience for uploading user IDs.
    CompletableFuture<com.linecorp.bot.model.manageaudience.response.CreateClickBasedAudienceGroupResponse>
    createClickBasedAudienceGroup(com.linecorp.bot.model.manageaudience.request.CreateClickBasedAudienceGroupRequest request)
    Creates an audience for click-based retargeting.
    CompletableFuture<com.linecorp.bot.model.manageaudience.response.CreateImpBasedAudienceGroupResponse>
    createImpBasedAudienceGroup(com.linecorp.bot.model.manageaudience.request.CreateImpBasedAudienceGroupRequest request)
    Creates an audience for impression-based retargeting.
    CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>
    deleteAudienceGroup(long audienceGroupId)
    Deletes an audience.
    CompletableFuture<com.linecorp.bot.model.manageaudience.response.GetAudienceDataResponse>
    getAudienceData(long audienceGroupId)
    Gets audience data.
    CompletableFuture<com.linecorp.bot.model.manageaudience.response.GetAudienceGroupAuthorityLevelResponse>
    getAudienceGroupAuthorityLevel()
    Get audience group authority level.
    CompletableFuture<com.linecorp.bot.model.manageaudience.response.GetAudienceGroupsResponse>
    getAudienceGroups(long page, String description, com.linecorp.bot.model.manageaudience.AudienceGroupStatus status, Long size, Boolean includesExternalPublicGroups, com.linecorp.bot.model.manageaudience.AudienceGroupCreateRoute createRoute)
    Gets data for more than one audience.
    CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>
    updateAudienceGroupAuthorityLevel(com.linecorp.bot.model.manageaudience.request.UpdateAudienceGroupAuthorityLevelRequest request)
    Update audience group authority level.
    CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>
    updateAudienceGroupDescription(long audienceGroupId, com.linecorp.bot.model.manageaudience.request.UpdateAudienceGroupDescriptionRequest request)
    Renames an existing audience.

  • Method Details

    • createAudienceGroup

      CompletableFuture<com.linecorp.bot.model.manageaudience.response.CreateAudienceGroupResponse> createAudienceGroup(com.linecorp.bot.model.manageaudience.request.CreateAudienceGroupRequest request)
      Creates an audience for uploading user IDs. You can create up to 1,000 audiences.
      See Also:

    • addAudienceToAudienceGroup

      CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> addAudienceToAudienceGroup(com.linecorp.bot.model.manageaudience.request.AddAudienceToAudienceGroupRequest request)
      Adds new user IDs or IFAs to an audience for uploading user IDs.
      See Also:

    • createClickBasedAudienceGroup

      CompletableFuture<com.linecorp.bot.model.manageaudience.response.CreateClickBasedAudienceGroupResponse> createClickBasedAudienceGroup(com.linecorp.bot.model.manageaudience.request.CreateClickBasedAudienceGroupRequest request)
      Creates an audience for click-based retargeting.
      See Also:

    • createImpBasedAudienceGroup

      CompletableFuture<com.linecorp.bot.model.manageaudience.response.CreateImpBasedAudienceGroupResponse> createImpBasedAudienceGroup(com.linecorp.bot.model.manageaudience.request.CreateImpBasedAudienceGroupRequest request)
      Creates an audience for impression-based retargeting.
      See Also:

    • updateAudienceGroupDescription

      CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> updateAudienceGroupDescription(long audienceGroupId, com.linecorp.bot.model.manageaudience.request.UpdateAudienceGroupDescriptionRequest request)
      Renames an existing audience.
      Parameters:
      audienceGroupId - The audience ID.
      See Also:

    • deleteAudienceGroup

      CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> deleteAudienceGroup(long audienceGroupId)
      Deletes an audience.
      Parameters:
      audienceGroupId - The audience ID.
      See Also:

    • getAudienceData

      CompletableFuture<com.linecorp.bot.model.manageaudience.response.GetAudienceDataResponse> getAudienceData(long audienceGroupId)
      Gets audience data.
      Parameters:
      audienceGroupId - The audience ID.
      See Also:

    • getAudienceGroups

      CompletableFuture<com.linecorp.bot.model.manageaudience.response.GetAudienceGroupsResponse> getAudienceGroups(long page, String description, com.linecorp.bot.model.manageaudience.AudienceGroupStatus status, Long size, Boolean includesExternalPublicGroups, com.linecorp.bot.model.manageaudience.AudienceGroupCreateRoute createRoute)
      Gets data for more than one audience.
      Parameters:
      page - The page to return when getting (paginated) results. Specify a value of 1 or more.
      description - The name of the audience(s) to return. You can search for partial matches. Comparisons are case-insensitive, so the names AUDIENCE and audience are considered identical.
      status - The audience's status.
      size - The number of audiences per page. This is 20 by default. Max: 40
      See Also:

    • getAudienceGroupAuthorityLevel

      CompletableFuture<com.linecorp.bot.model.manageaudience.response.GetAudienceGroupAuthorityLevelResponse> getAudienceGroupAuthorityLevel()
      Get audience group authority level.
      See Also:

    • updateAudienceGroupAuthorityLevel

      CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> updateAudienceGroupAuthorityLevel(@Body com.linecorp.bot.model.manageaudience.request.UpdateAudienceGroupAuthorityLevelRequest request)
      Update audience group authority level.
      See Also:

    • builder

      static ManageAudienceClientBuilder builder()