com.linecorp.bot.client.ManageAudienceClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of line-bot-api-client Show documentation
null
The newest version!
/*
 * Copyright 2020 LINE Corporation
 *
 * LINE Corporation licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */
package com.linecorp.bot.client;

import java.util.concurrent.CompletableFuture;

import com.linecorp.bot.model.manageaudience.AudienceGroupCreateRoute;
import com.linecorp.bot.model.manageaudience.AudienceGroupStatus;
import com.linecorp.bot.model.manageaudience.request.AddAudienceToAudienceGroupRequest;
import com.linecorp.bot.model.manageaudience.request.CreateAudienceGroupRequest;
import com.linecorp.bot.model.manageaudience.request.CreateClickBasedAudienceGroupRequest;
import com.linecorp.bot.model.manageaudience.request.CreateImpBasedAudienceGroupRequest;
import com.linecorp.bot.model.manageaudience.request.UpdateAudienceGroupAuthorityLevelRequest;
import com.linecorp.bot.model.manageaudience.request.UpdateAudienceGroupDescriptionRequest;
import com.linecorp.bot.model.manageaudience.response.CreateAudienceGroupResponse;
import com.linecorp.bot.model.manageaudience.response.CreateClickBasedAudienceGroupResponse;
import com.linecorp.bot.model.manageaudience.response.CreateImpBasedAudienceGroupResponse;
import com.linecorp.bot.model.manageaudience.response.GetAudienceDataResponse;
import com.linecorp.bot.model.manageaudience.response.GetAudienceGroupAuthorityLevelResponse;
import com.linecorp.bot.model.manageaudience.response.GetAudienceGroupsResponse;
import com.linecorp.bot.model.response.BotApiResponse;

import retrofit2.http.Body;

public interface ManageAudienceClient {

    /**
     * Creates an audience for uploading user IDs. You can create up to 1,000 audiences.
     *
     * @see 
     *         Create audience for uploading user IDs
     */
    CompletableFuture createAudienceGroup(CreateAudienceGroupRequest request);

    /**
     * Adds new user IDs or IFAs to an audience for uploading user IDs.
     *
     * @see 
     *         Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs
     */
    CompletableFuture addAudienceToAudienceGroup(
            AddAudienceToAudienceGroupRequest request);

    /**
     * Creates an audience for click-based retargeting.
     *
     * @see 
     *         Create audience for click-based retargeting
     */
    CompletableFuture createClickBasedAudienceGroup(
            CreateClickBasedAudienceGroupRequest request);

    /**
     * Creates an audience for impression-based retargeting.
     *
     * @see 
     *         Create audience for impression-based retargeting
     */
    CompletableFuture createImpBasedAudienceGroup(
            CreateImpBasedAudienceGroupRequest request);

    /**
     * Renames an existing audience.
     *
     * @param audienceGroupId The audience ID.
     * @see 
     *         Rename an audience
     */
    CompletableFuture updateAudienceGroupDescription(
            long audienceGroupId, UpdateAudienceGroupDescriptionRequest request);

    /**
     * Deletes an audience.
     *
     * @param audienceGroupId The audience ID.
     * @see 
     *         Delete audience
     */
    CompletableFuture deleteAudienceGroup(long audienceGroupId);

    /**
     * Gets audience data.
     *
     * @param audienceGroupId The audience ID.
     * @see 
     *         Get audience data
     */
    CompletableFuture getAudienceData(long audienceGroupId);

    /**
     * Gets data for more than one audience.
     *
     * @param page The page to return when getting (paginated) results. Specify a value of 1 or more.
     * @param 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.
     * @param status The audience's status.
     * @param size The number of audiences per page. This is 20 by default.
     *         Max: 40
     * @see 
     *         Get data for multiple audiences
     */
    CompletableFuture getAudienceGroups(
            long page, String description, AudienceGroupStatus status, Long size,
            Boolean includesExternalPublicGroups, AudienceGroupCreateRoute createRoute);

    /**
     * Get audience group authority level.
     *
     * @see 
     *         Get authority level
     */
    CompletableFuture getAudienceGroupAuthorityLevel();

    /**
     * Update audience group authority level.
     *
     * @see 
     *         Change authority level
     */
    CompletableFuture updateAudienceGroupAuthorityLevel(
            @Body UpdateAudienceGroupAuthorityLevelRequest request);

    static ManageAudienceClientBuilder builder() {
        return new ManageAudienceClientBuilder();
    }
}