serpstat sdk

serpstat/SDK

これは Serpstat API v3 の公式 SDK ライブラリです

はじめる

ステップ 1: 認証トークンを作成する

API Serpstat は、ユーザー トークンを使用してリクエストを認証します。プロフィール ページでトークンを作成できます。

ステップ 2: パッケージをインストールする

コマンド コンソールを開き、プロジェクト ディレクトリを入力し、次のコマンドを実行して、このバンドルの最新の安定バージョンをダウンロードします。

$ composer require serpstat/sdk

このコマンドでは、Composer ドキュメントのインストールの章で説明されているように、Composer をグローバルにインストールする必要があります。

ステップ 3: アプリケーションで使用する

 <?php
require_once __DIR__ . ' /../vendor/autoload.php ' ;

// configure your application
$ config = [
    ' token ' => ' 19666fc1ae1724da1d5ea2f3a99d5f5a ' ,
];

$ domain = ' example.com ' ;
$ keywords = ' keywords ' ;
$ url = ' http://example.com/page1/ ' ;

// init client with your serpstat api token
$ apiClient = new  Serpstat  Sdk  Core  ApiGuzzleHttpClient ( $ config [ ' token ' ]);

// create instance of any api method class
// e.g. DomainKeywordsMethod
// list of methods classes in folder srcMethods
$ apiMethod = new  Serpstat  Sdk  Methods  DomainKeywordsMethod (
    $ keywords , 
     Serpstat  Sdk  Interfaces  IApiClient :: SE_GOOGLE_RU
);

try {
    // try call api method
    $ response = $ apiClient -> call ( $ apiMethod );
} catch (  Exception $ e ) {
    // catch api error 
    $ response = $ e -> getMessage ();
}

SDK APIメソッドのリスト

クラス	APIメソッド	説明
CheckLimitsメソッド	/統計	コマンド stats を使用すると、1 日の制限内で実行できるリクエストの数を確認できます。
ドメイン情報メソッド	/ドメイン情報	このレポートは、ドメインが SEO と PPC で使用するキーワードの数を提供し、オンラインでの可視性やその他の指標を示します。
ドメイン履歴メソッド	/ドメイン_履歴	このレポートは、ドメインのキーワード数と可視性に関する履歴データを提供します。
ドメインキーワードメソッド	/ドメインキーワード	このレポートには、Google の検索結果トップ 100 でドメインがランク付けされているキーワードが表示されます。
ドメインURLメソッド	/ドメイン_urls	分析されたドメイン内の URL のリストを返します。各 URL の上位 100 位からのキーワード数も表示されます。
ドメイン交差メソッド	/domains_intersection	最大 3 つのドメインの共通キーワードを表示します
ドメイン固有キーワードメソッド	/domains_uniq_keywords	ドメインの一意のキーワードを表示します。クエリされたドメインが他の 1 つまたは 2 つのドメインと共通するキーワードはリストから削除されます。
GetTopUrlsメソッド	/get_top_urls	ドメインごとに上位の URL を表示します。
競合他社方法	/競合他社	このレポートには、Google の結果トップ 20 で特定のキーワードでランク付けされたすべてのドメインがリストされます。
キーワード方法	/キーワード	この方法では、全文検索を使用して、クエリされた用語に一致するすべてのキーワードを検索します。見つかったすべてのキーワードについて、そのボリューム、クリック単価、競合レベルが表示されます。
キーワード情報メソッド	/キーワード情報	このレポートでは、キーワードのボリューム、クリック単価、競合レベルを示すキーワードの概要が提供されます。
提案方法	/提案	このレポートには、リクエストしたキーワードに対するオートコンプリートの候補がリストされます (これらは全文検索で見つかります)。
関連キーワード方法	/関連キーワード	このレポートには、リクエストされたキーワードの SERP と類似した SERP を持つ関連キーワードの包括的なリストが表示されます (アカウント タイプがスタンダードおよびプロフェッショナルの場合のみ)。
キーワードトップメソッド	/キーワード_トップ	このレポートには、リクエストしたキーワードに対する Google のオーガニック検索結果のトップ 100 が表示されます。
広告キーワードメソッド	/ad_キーワード	このレポートには、Google 有料検索結果でクエリされたキーワードに対してポップアップ表示される広告コピーが表示されます。
URLキーワードメソッド	/url_キーワード	このレポートには、Google 検索結果で URL がランク付けされているキーワードがリストされます。
URL競合他社方法	/url_competitors	オーガニック検索でクエリされた URL と競合する URL のリストを表示します。
URL がありませんキーワードメソッド	/url_missing_keywords	競合他社の URL が上位 10 位にランクされているが、クエリされたページには含まれていないキーワードのリストを表示します。

SDKの例外

例外クラス	コード	メッセージ
API例外	-	-
APIInvalidRequestException	400	無効なリクエスト
APILimitExceededException	402	関税制限を超えた
APIAccessErrorException	403	認証の問題 (間違ったトークン、禁止されたアクション、またはユーザーのブロック)
APINoResultsException	404	結果はありません
APIFrequencyExceededException	429	リクエスト頻度を超えました (リクエスト間のタイムアウトを増やします)
APIサーバー例外	500	サーバーエラー
InvalidParamException	500	無効なパラメータ
ParseResponseException	500	応答を解析できません