com.vk.api.sdk.queries.ads.AdsGetClientsQuery Maven / Gradle / Ivy

Go to download
package com.vk.api.sdk.queries.ads;

import com.vk.api.sdk.client.AbstractQueryBuilder;
import com.vk.api.sdk.client.Utils;
import com.vk.api.sdk.client.VkApiClient;
import com.vk.api.sdk.client.actors.UserActor;
import com.vk.api.sdk.objects.ads.responses.GetClientsResponse;
import java.util.Arrays;
import java.util.List;

/**
 * Query for Ads.getClients method
 */
public class AdsGetClientsQuery extends AbstractQueryBuilder> {
    /**
     * Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
     *
     * @param client VK API client
     * @param actor actor with access token
     * @param accountId value of "account id" parameter.
     */
    public AdsGetClientsQuery(VkApiClient client, UserActor actor, int accountId) {
        super(client, "ads.getClients", Utils.buildParametrizedType(List.class, GetClientsResponse.class));
        accessToken(actor.getAccessToken());
        accountId(accountId);
    }

    /**
     * Advertising account ID.
     *
     * @param value value of "account id" parameter.
     * @return a reference to this {@code AbstractQueryBuilder} object to fulfill the "Builder" pattern.
     */
    protected AdsGetClientsQuery accountId(int value) {
        return unsafeParam("account_id", value);
    }

    @Override
    protected AdsGetClientsQuery getThis() {
        return this;
    }

    @Override
    protected List essentialKeys() {
        return Arrays.asList("account_id", "access_token");
    }
}