com.echobox.api.tiktok.model.EventReason Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebx-tiktok-sdk Show documentation
ebx-tiktok-sdk is a pure Java TikTok API client. It implements the v1.3 API.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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.echobox.api.tiktok.model;

import com.google.gson.annotations.SerializedName;
import lombok.AllArgsConstructor;
import lombok.Getter;

/**
 * Enumeration of the authorization.removed and share.video.publish_failed reasons, see
 * https://ads.tiktok.com/marketing_api/docs?id=1739958821010434
 *
 * @author lukemartin
 */
@AllArgsConstructor
@Getter
public enum EventReason {
  @SerializedName("0")
  UNKNOWN("Unknown"),
  @SerializedName("1")
  USER_DISCONNECT("User disconects from TikTok app"),
  @SerializedName("2")
  USER_ACCOUNT_DELETED("User's account got deleted"),
  @SerializedName("3")
  USER_AGE_CHANGED("User's age changed"),
  @SerializedName("4")
  USER_ACCOUNT_BANNED("User's account got banned"),
  @SerializedName("video_pull_failed")
  VIDEO_PULL_FAILED("TikTok server encountered a connection error while downloading the "
      + "specified video resource. Or the download is terminated since it cannot be completed "
      + "within the one hour timeout. Check if the supplied URL is publicly accessible or "
      + "bandwidth-limited. If partner is certain that the URL is valid, retry is recommended."),
  @SerializedName("file_format_check_failed")
  FILE_FORMAT_CHECK_FAILED("TikTok server is able to download the video material "
      + "but identifies that the video file format did not meet the file format specifications "
      + "- .mp4 or .mov."),
  @SerializedName("duration_check")
  DURATION_CHECK("TikTok server is able to download the video material but identifies that the "
      + "video file format did not meet the duration constraint."),
  @SerializedName("duration_check_failed")
  DURATION_CHECK_FAILED("TikTok server is able to download the video material "
      + "but identifies that the video file format did not meet the duration constraint "
      + "- min 3 seconds long, max 60 seconds long."),
  @SerializedName("picture_size_check_failed")
  PICTURE_SIZE_CHECK_FAILED("TikTok server is able to download the video material "
      + "but identifies that the video file format did not meet the resolution specifications "
      + "- min height and width being 360p."),
  @SerializedName("frame_rate_check_failed")
  FRAME_RATE_CHECK_FAILED("TikTok server is able to download the video material "
      + "but identifies that the video file format did not meet the frame rate specifications "
      + "- min 23 FPS, max 60 FPS."),
  @SerializedName("spam_risk_too_many_posts")
  SPAM_RISK_TOO_MANY_POSTS("This TikTok creator has created too many posts within the last 24 "
      + "hours via API. Try to post the videos from the TikTok Mobile App."),
  @SerializedName("spam_risk_user_banned_from_posting")
  SPAM_RISK_USER_BANNED_FROM_POSTING("This TikTok creator is banned from making new posts."),
  @SerializedName("spam_risk_text")
  SPAM_RISK_TEXT("The description text has risky or spammy contents, so the publishing attempt is"
      + " terminated."),
  @SerializedName("publish_cancelled")
  PUBLISH_CANCELLED("The ongoing upload or download has been successfully cancelled."),
  @SerializedName("internal")
  INTERNAL("Some parts of TikTok server may be currently unavailable."),
  @SerializedName("auth_removed")
  AUTH_REMOVED("This TikTok creator has removed the developer's access while the "
      + "download/uploading is being processed, so the publishing effort must be terminated.");
  
  private final String message;
}