Interface ManageAudienceClient


  • public interface ManageAudienceClient
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.concurrent.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()  
      java.util.concurrent.CompletableFuture<com.linecorp.bot.model.manageaudience.response.CreateAudienceGroupResponse> createAudienceGroup​(com.linecorp.bot.model.manageaudience.request.CreateAudienceGroupRequest request)
      Creates an audience for uploading user IDs.
      java.util.concurrent.CompletableFuture<com.linecorp.bot.model.manageaudience.response.CreateClickBasedAudienceGroupResponse> createClickBasedAudienceGroup​(com.linecorp.bot.model.manageaudience.request.CreateClickBasedAudienceGroupRequest request)
      Creates an audience for click-based retargeting.
      java.util.concurrent.CompletableFuture<com.linecorp.bot.model.manageaudience.response.CreateImpBasedAudienceGroupResponse> createImpBasedAudienceGroup​(com.linecorp.bot.model.manageaudience.request.CreateImpBasedAudienceGroupRequest request)
      Creates an audience for impression-based retargeting.
      java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> deleteAudienceGroup​(long audienceGroupId)
      Deletes an audience.
      java.util.concurrent.CompletableFuture<com.linecorp.bot.model.manageaudience.response.GetAudienceDataResponse> getAudienceData​(long audienceGroupId)
      Gets audience data.
      java.util.concurrent.CompletableFuture<com.linecorp.bot.model.manageaudience.response.GetAudienceGroupAuthorityLevelResponse> getAudienceGroupAuthorityLevel()
      Get audience group authority level.
      java.util.concurrent.CompletableFuture<com.linecorp.bot.model.manageaudience.response.GetAudienceGroupsResponse> getAudienceGroups​(long page, java.lang.String description, com.linecorp.bot.model.manageaudience.AudienceGroupStatus status, java.lang.Long size, java.lang.Boolean includesExternalPublicGroups, com.linecorp.bot.model.manageaudience.AudienceGroupCreateRoute createRoute)
      Gets data for more than one audience.
      java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> updateAudienceGroupAuthorityLevel​(com.linecorp.bot.model.manageaudience.request.UpdateAudienceGroupAuthorityLevelRequest request)
      Update audience group authority level.
      java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> updateAudienceGroupDescription​(long audienceGroupId, com.linecorp.bot.model.manageaudience.request.UpdateAudienceGroupDescriptionRequest request)
      Renames an existing audience.
    • Method Detail

      • createAudienceGroup

        java.util.concurrent.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:
        Create audience for uploading user IDs
      • createClickBasedAudienceGroup

        java.util.concurrent.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:
        Create audience for click-based retargeting
      • createImpBasedAudienceGroup

        java.util.concurrent.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:
        Create audience for impression-based retargeting
      • updateAudienceGroupDescription

        java.util.concurrent.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:
        Rename an audience
      • deleteAudienceGroup

        java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> deleteAudienceGroup​(long audienceGroupId)
        Deletes an audience.
        Parameters:
        audienceGroupId - The audience ID.
        See Also:
        Delete audience
      • getAudienceData

        java.util.concurrent.CompletableFuture<com.linecorp.bot.model.manageaudience.response.GetAudienceDataResponse> getAudienceData​(long audienceGroupId)
        Gets audience data.
        Parameters:
        audienceGroupId - The audience ID.
        See Also:
        Get audience data
      • getAudienceGroups

        java.util.concurrent.CompletableFuture<com.linecorp.bot.model.manageaudience.response.GetAudienceGroupsResponse> getAudienceGroups​(long page,
                                                                                                                                           java.lang.String description,
                                                                                                                                           com.linecorp.bot.model.manageaudience.AudienceGroupStatus status,
                                                                                                                                           java.lang.Long size,
                                                                                                                                           java.lang.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:
        Get data for multiple audiences
      • getAudienceGroupAuthorityLevel

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

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