Struct Service

Source

pub struct Service { /* private fields */ }

Implementations§

Source §

impl Service

Source

pub fn new() -> Self

Creates a new instance of the Service with the client key and secret from environment variables.

§Panics

Panics if the TIKTOK_CLIENT_KEY or TIKTOK_CLIENT_SECRET environment variables are not set.

Examples found in repository ?

examples/get_user_followers.rs (line 11)

9async fn main() -> Result<(), TikTokApiError> {
10    // Create a new Service instance
11    let research_service = research::Service::new();
12
13    let client_service = client::Service::new();
14
15    // Retrieve the access token You need to get permissions
16    let token = match client_service.get_access_token().await {
17        Ok(token_response) => {
18            println!("Access Token: {}", token_response.access_token);
19            println!("Expires In: {}", token_response.expires_in);
20            println!("Token Type: {}", token_response.token_type);
21            token_response.access_token
22        }
23        Err(e) => {
24            eprintln!("Error getting access token: {}", e);
25            "".to_string()
26        }
27    };
28
29    // Create a UserFollowersRequest
30    let request = ResearchUserFollowersRequest {
31        username: "luisf_m99".to_string(),
32        max_count: Some(20), // Number of followers to retrieve (adjust as needed)
33        cursor: Some(0),     // Starting point for pagination (0 for the first request)
34    };
35
36    // Query user followers
37    match research_service.query_user_followers(&token, request).await {
38        Ok(follower_data) => {
39            println!("Successfully retrieved follower data:");
40            println!("Cursor: {}", follower_data.cursor);
41            println!("Has more: {}", follower_data.has_more);
42
43            for follower in follower_data.user_followers {
44                println!("Username: {}", follower.username);
45                println!("Display name: {}", follower.display_name);
46                println!("------------------------");
47            }
48            Ok(())
49        }
50        Err(e) => {
51            eprintln!("Error querying user followers: {:?}", e);
52            Err(e)
53        }
54    }
55}

Source

pub fn with_base_url(self, base_url: &str) -> Self

Sets a custom base URL for the Service.

§Arguments

base_url - A string slice that holds the custom base URL.

Source §

impl Service

Source

pub async fn query_user_info( &self, token: &str, fields: &[ResearchVideoField], request: ResearchUserInfoRequest, ) -> Result<ResearchUserInfoData, TikTokApiError>

Queries user info using the TikTok API.

§Arguments

token - The client access token.
fields - A list of VideoField enums for the desired data.
request - A UserInfoRequest struct that holds the request parameters.

§Returns

A Result containing a UserInfoData on success, or a TikTokApiError on failure.

Source

pub async fn query_liked_videos( &self, token: &str, fields: &[ResearchVideoField], request: ResearchLikedVideosRequest, ) -> Result<ResearchUserLikedVideosData, TikTokApiError>

Queries liked videos using the TikTok API.

§Arguments

token - The client access token.
fields - A list of VideoField enums for the desired data.
request - A LikedVideosRequest struct that holds the request parameters.

§Returns

A Result containing a UserLikedVideosData on success, or a TikTokApiError on failure.

Source

pub async fn query_pinned_videos( &self, token: &str, fields: &[ResearchVideoField], request: ResearchPinnedVideosRequest, ) -> Result<ResearchPinnedVideosData, TikTokApiError>

Queries pinned videos using the TikTok API.

§Arguments

token - The client access token.
fields - A list of VideoField enums for the desired data.
request - A PinnedVideosRequest struct that holds the request parameters.

§Returns

A Result containing a PinnedVideosData on success, or a TikTokApiError on failure.

Source

pub async fn query_user_followers( &self, token: &str, request: ResearchUserFollowersRequest, ) -> Result<ResearchUserFollowerData, TikTokApiError>

Queries user followers using the TikTok API.

§Arguments

token - The client access token.
request - A UserFollowersRequest struct that holds the request parameters.

§Returns

A Result containing a UserFollowerData on success, or a TikTokApiError on failure.

Examples found in repository ?

examples/get_user_followers.rs (line 37)

9async fn main() -> Result<(), TikTokApiError> {
10    // Create a new Service instance
11    let research_service = research::Service::new();
12
13    let client_service = client::Service::new();
14
15    // Retrieve the access token You need to get permissions
16    let token = match client_service.get_access_token().await {
17        Ok(token_response) => {
18            println!("Access Token: {}", token_response.access_token);
19            println!("Expires In: {}", token_response.expires_in);
20            println!("Token Type: {}", token_response.token_type);
21            token_response.access_token
22        }
23        Err(e) => {
24            eprintln!("Error getting access token: {}", e);
25            "".to_string()
26        }
27    };
28
29    // Create a UserFollowersRequest
30    let request = ResearchUserFollowersRequest {
31        username: "luisf_m99".to_string(),
32        max_count: Some(20), // Number of followers to retrieve (adjust as needed)
33        cursor: Some(0),     // Starting point for pagination (0 for the first request)
34    };
35
36    // Query user followers
37    match research_service.query_user_followers(&token, request).await {
38        Ok(follower_data) => {
39            println!("Successfully retrieved follower data:");
40            println!("Cursor: {}", follower_data.cursor);
41            println!("Has more: {}", follower_data.has_more);
42
43            for follower in follower_data.user_followers {
44                println!("Username: {}", follower.username);
45                println!("Display name: {}", follower.display_name);
46                println!("------------------------");
47            }
48            Ok(())
49        }
50        Err(e) => {
51            eprintln!("Error querying user followers: {:?}", e);
52            Err(e)
53        }
54    }
55}