コンテンツへスキップ
NextAuth.js v4 からの移行ですか? 移行ガイドをお読みください.

providers/tiktok

組み込みのTikTok連携。

TiktokProfile

詳細

拡張

プロパティ

data

data: {
  user: {
     avatar_large_url: string;
     avatar_url: string;
     avatar_url_100: string;
     bio_description: string;
     display_name: string;
     email: string;
     follower_count: number;
     following_count: number;
     is_verified: boolean;
     likes_count: number;
     open_id: string;
     profile_deep_link: string;
     union_id: string;
     username: string;
     video_count: number;
  };
};
user
user: {
  avatar_large_url: string;
  avatar_url: string;
  avatar_url_100: string;
  bio_description: string;
  display_name: string;
  email: string;
  follower_count: number;
  following_count: number;
  is_verified: boolean;
  likes_count: number;
  open_id: string;
  profile_deep_link: string;
  union_id: string;
  username: string;
  video_count: number;
};
user.avatar_large_url?
optional avatar_large_url: string;

ユーザーの高解像度プロフィール画像

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=avatar_url_100を追加してください。

user.avatar_url
avatar_url: string;

ユーザーのプロフィール画像。

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=avatar_urlを追加してください。

user.avatar_url_100?
optional avatar_url_100: string;

100x100サイズのユーザーのプロフィール画像。

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=avatar_url_100を追加してください。

user.bio_description?
optional bio_description: string;

有効なユーザーの自己紹介文。

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=bio_descriptionを追加してください。

user.display_name
display_name: string;

ユーザーのプロフィール名

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=display_nameを追加してください。

user.email?
optional email: string;
注意

現在、TikTokではメールはサポートされていません

user.follower_count?
optional follower_count: number;

ユーザーのフォロワー数。

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=follower_countを追加してください。

user.following_count?
optional following_count: number;

ユーザーがフォローしているアカウントの数。

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=following_countを追加してください。

user.is_verified?
optional is_verified: boolean;

それがユーザーが代表するアカウントに属していることを確認した後、TikTokがアカウントに認証済みバッジを提供したかどうか。

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=is_verifiedを追加してください。

user.likes_count?
optional likes_count: number;

ユーザーのすべての動画で受け取ったいいねの総数。

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=likes_countを追加してください。

user.open_id
open_id: string;

現在のアプリケーションにおけるユーザーの一意の識別子。クライアントのオープンID。

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=open_idを追加してください。

optional profile_deep_link: string;

ユーザーのTikTokプロフィールページへのリンク。

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=profile_deep_linkを追加してください。

user.union_id?
optional union_id: string;

同じ開発者の異なるアプリ間でユーザーを識別する一意の識別子。たとえば、パートナーがX個のクライアントを持っている場合、同じTikTokユーザーに対してX個のopen_idを取得しますが、特定のユーザーに対して1つの永続的なunion_idを取得します。

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=union_idを追加してください。

user.username
username: string;

ユーザーのユーザー名。

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=usernameを追加してください。

user.video_count?
optional video_count: number;

ユーザーが公開投稿した動画の総数。

このフィールドを返すには、ユーザープロファイルリクエストのクエリパラメータにfields=video_countを追加してください。

error

error: {
  code: string;
  log_id: string;
  message: string;
};
code
code: string;

文字列のエラーカテゴリ。

log_id
log_id: string;

文字列のエラーメッセージ。

メッセージ
message: string;

文字列のエラーメッセージ。


デフォルト()

default<P>(options): OAuthConfig<P>

TikTokログインをページに追加します。

セットアップ

コールバックURL

https://example.com/api/auth/callback/tiktok

設定

import { Auth } from "@auth/core"
import TikTok from "@auth/core/providers/tiktok"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    TikTok({ clientId: TIKTOK_CLIENT_KEY, clientSecret: TIKTOK_CLIENT_SECRET }),
  ],
})

リソース

注記

💡

本番アプリケーションでは、TikTokへのサインインにlocalhost URLを使用できません。TikTokアプリにドメインとコールバック/リダイレクトURLを追加し、TikTokチームによるレビューと承認を受ける必要があります。

💡

メールアドレスはTikTokでサポートされていません。

💡

Client_IDはTikTokアプリケーションのクライアントキーになります。

デフォルトでは、Auth.jsはTikTokプロバイダーがOAuth 2仕様に基づいていると想定します。

💡

TikTokプロバイダーにはデフォルト設定が付属しています。ユースケースに合わせてデフォルトをオーバーライドするには、組み込みのOAuthプロバイダーのカスタマイズをご確認ください。

免責事項 デフォルト設定にバグを見つけたと思われる場合は、問題を提起できます。

Auth.jsは仕様を厳格に遵守しており、プロバイダーによる仕様からの逸脱については責任を負いかねます。問題を提起することはできますが、問題が仕様への不適合である場合は、解決を追求しない可能性があります。ディスカッションでより詳しいヘルプを求めることができます。

型パラメータ

型パラメータ
P extends TiktokProfile

パラメータ

パラメータ
optionsOAuthUserConfig<P>

戻り値

OAuthConfig<P>

Auth.js © Balázs Orbán and Team -2024