twitter4jads.api.TwitterAdsVideoApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twitter4j-ads Show documentation
The newest version!
package twitter4jads.api;

import twitter4jads.BaseAdsResponse;
import twitter4jads.internal.models4j.TwitterException;
import twitter4jads.models.video.AssociateVideoToAccountResponse;
import twitter4jads.models.video.TwitterAccountMediaResponse;
import twitter4jads.models.video.TwitterCreativeType;
import twitter4jads.models.video.UploadMediaObjectResponse;

/**
 * User: abhay
 * Date: 4/5/16
 * Time: 10:40 AM
 */
public interface TwitterAdsVideoApi {

    /**
     * @param accountId             The identifier for the leveraged account.
     * @param mediaId               The media ID to be used.
     * @param videoId               The video ID to be used.
     * @param twitterCreativeType   An enum of creative type being used (e.g. INTERSTITIAL).
     * @return response of transforming media in account to promoted video
     * @see https://dev.twitter.com/ads/reference/post/accounts/%3Aaccount_id/account_media
     */
    BaseAdsResponse transformMediaInAccount(String accountId, String mediaId, String videoId,
                                                                         TwitterCreativeType twitterCreativeType) throws TwitterException;

    /**
     * @param accountId             The identifier for the leveraged account.
     * @param mediaId               The media ID being used to create promoted video.
     * @param title                 Title of video creative being created.
     * @param description           Description of video creative being created.
     * @return response of associating promoted video with account
     * @see https://dev.twitter.com/ads/reference/post/accounts/%3Aaccount_id/videos
     */
    BaseAdsResponse associateVideoWithAccount(String accountId, String mediaId, String title, String description)
            throws TwitterException;
}