Struct YandexWebmasterClient 

pub struct YandexWebmasterClient { /* private fields */ }

Client for interacting with the Yandex Webmaster API

Implementations

impl YandexWebmasterClient

pub fn oauth_url(client_id: &str) -> String

Create OAuth url to get token

pub async fn new(oauth_token: String) -> Result<Self>

Creates a new Yandex Webmaster API client

Arguments

• oauth_token - OAuth token for authentication

Errors

Returns an error if:

• The HTTP client cannot be created
• The user information cannot be fetched
• The OAuth token is invalid

pub async fn with_client( oauth_token: String, client: ClientBuilder, ) -> Result<Self>

Creates a new Yandex Webmaster API client

Arguments

• oauth_token - OAuth token for authentication
• client - Client builder with preconfigured middleware

Errors

Returns an error if:

• The HTTP client cannot be created
• The user information cannot be fetched
• The OAuth token is invalid

pub fn user_id(&self) -> i64

Returns the user ID

pub async fn get_hosts(&self) -> Result<Vec<HostInfo>>

List all sites for the user

pub async fn add_host( &self, host_url: &str, verification_type: VerificationType, ) -> Result<AddHostResponse>

Add a new site

pub async fn get_host(&self, host_id: &str) -> Result<FullHostInfo>

Get information about a specific site

pub async fn delete_host(&self, host_id: &str) -> Result<()>

Delete a site

pub async fn get_verification_status( &self, host_id: &str, ) -> Result<HostVerificationResponse>

Get verification status for a site

pub async fn verify_host( &self, host_id: &str, verification_type: ExplicitVerificationType, ) -> Result<HostVerificationResponse>

Initiate verification procedure for a site

pub async fn get_owners(&self, host_id: &str) -> Result<Vec<Owner>>

Get list of verified owners for a site

pub async fn get_host_summary( &self, host_id: &str, ) -> Result<HostSummaryResponse>

Get site summary statistics

pub async fn get_sqi_history( &self, host_id: &str, req: SqiHistoryRequest, ) -> Result<Vec<SqiPoint>>

Get site quality index history

pub async fn get_popular_queries( &self, host_id: &str, request: &PopularQueriesRequest, ) -> Result<PopularQueriesResponse>

Get popular search queries for a site

pub async fn get_query_analytics( &self, host_id: &str, request: &QueryAnalyticsRequest, ) -> Result<QueryAnalyticsResponse>

Get overall query statistics history

pub async fn get_query_history( &self, host_id: &str, query_id: &str, request: &QueryHistoryRequest, ) -> Result<QueryHistoryResponse>

Get statistics for a specific query

pub async fn get_sitemaps( &self, host_id: &str, request: &GetSitemapsRequest, ) -> Result<SitemapsResponse>

Get list of all sitemap files

pub async fn get_sitemap( &self, host_id: &str, sitemap_id: &str, ) -> Result<SitemapInfo>

Get details of a specific sitemap

pub async fn get_user_sitemaps( &self, host_id: &str, request: &GetUserSitemapsRequest, ) -> Result<UserSitemapsResponse>

Get list of user-submitted sitemaps

pub async fn add_sitemap( &self, host_id: &str, url: &str, ) -> Result<AddSitemapResponse>

Add a new sitemap file

pub async fn get_user_sitemap( &self, host_id: &str, sitemap_id: &str, ) -> Result<UserSitemapInfo>

Get user-submitted sitemap details

pub async fn delete_sitemap( &self, host_id: &str, sitemap_id: &str, ) -> Result<()>

Delete a user-submitted sitemap

pub async fn get_indexing_history( &self, host_id: &str, request: &IndexingHistoryRequest, ) -> Result<IndexingHistoryResponse>

Get indexing history

pub async fn get_indexing_samples( &self, host_id: &str, request: &GetIndexingSamplesRequest, ) -> Result<IndexingSamplesResponse>

Get sample indexed pages

pub async fn get_search_urls_history( &self, host_id: &str, request: &IndexingHistoryRequest, ) -> Result<SearchUrlsHistoryResponse>

Get pages in search history

pub async fn get_search_urls_samples( &self, host_id: &str, request: &GetSearchUrlsSamplesRequest, ) -> Result<SearchUrlsSamplesResponse>

Get sample pages in search

pub async fn get_search_events_history( &self, host_id: &str, request: &IndexingHistoryRequest, ) -> Result<SearchEventsHistoryResponse>

Get page appearance/removal history

pub async fn get_search_events_samples( &self, host_id: &str, request: &GetSearchEventsSamplesRequest, ) -> Result<SearchEventsSamplesResponse>

Get sample page changes

pub async fn get_important_urls( &self, host_id: &str, ) -> Result<ImportantUrlsResponse>

Get list of important URLs

pub async fn get_important_urls_history( &self, host_id: &str, url_param: &str, ) -> Result<ImportantUrlHistoryResponse>

Get important URLs history

pub async fn recrawl_urls( &self, host_id: &str, url: &str, ) -> Result<RecrawlResponse>

Request page recrawl

pub async fn get_recrawl_tasks( &self, host_id: &str, request: &GetRecrawlTasksRequest, ) -> Result<RecrawlTasksResponse>

Get list of recrawl tasks

pub async fn get_recrawl_task( &self, host_id: &str, task_id: &str, ) -> Result<RecrawlTask>

Get recrawl task status

pub async fn get_recrawl_quota( &self, host_id: &str, ) -> Result<RecrawlQuotaResponse>

Get recrawl quota

pub async fn get_broken_links( &self, host_id: &str, request: &BrokenLinksRequest, ) -> Result<BrokenLinksResponse>

Get broken internal links samples

pub async fn get_broken_links_history( &self, host_id: &str, request: &BrokenLinkHistoryRequest, ) -> Result<BrokenLinkHistoryResponse>

Get broken links history

pub async fn get_external_links( &self, host_id: &str, request: &ExternalLinksRequest, ) -> Result<ExternalLinksResponse>

Get external backlinks samples

pub async fn get_external_links_history( &self, host_id: &str, ) -> Result<ExternalLinksHistoryResponse>

Get backlinks history

pub async fn get_diagnostics( &self, host_id: &str, ) -> Result<DiagnosticsResponse>

Get site diagnostic report

Trait Implementations

impl Clone for YandexWebmasterClient

fn clone(&self) -> YandexWebmasterClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for YandexWebmasterClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.