serpstat sdk
1.0.0
هذه هي مكتبة SDK الرسمية لـ Serpstat API v3
يستخدم API Serpstat رمز المستخدم لمصادقة الطلبات. يمكنك إنشاء رمز مميز على صفحة ملفك الشخصي.
افتح وحدة تحكم الأوامر، وأدخل دليل المشروع الخاص بك وقم بتنفيذ الأمر التالي لتنزيل أحدث إصدار ثابت من هذه الحزمة:
$ composer require serpstat/sdk
يتطلب هذا الأمر تثبيت Composer عالميًا، كما هو موضح في فصل التثبيت في وثائق Composer.
<?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 ();
}
فصل | طريقة واجهة برمجة التطبيقات | وصف |
---|---|---|
CheckLimitsMethod | / احصائيات | يمكنك التحقق من عدد الطلبات التي يمكنك تنفيذها ضمن الحد اليومي الخاص بك باستخدام إحصائيات الأمر |
DomainInfoMethod | /domain_info | يزودك هذا التقرير بعدد الكلمات الرئيسية التي يستخدمها النطاق في تحسين محركات البحث (SEO) والدفع لكل نقرة (PPC)، ويوضح مدى ظهوره عبر الإنترنت ومقاييس أخرى. |
DomainHistoryMethod | /domain_history | يزودك هذا التقرير بالبيانات التاريخية حول عدد الكلمات الرئيسية ومستوى الرؤية الخاص بالنطاق. |
طريقة الكلمات الرئيسية للمجال | /domain_keywords | يعرض هذا التقرير الكلمات الرئيسية التي يتم تصنيف المجال لها في أفضل 100 نتيجة بحث في Google. |
DomainUrlsMethod | /domain_urls | إرجاع قائمة عناوين URL داخل المجال الذي تم تحليله. يعرض أيضًا عدد الكلمات الرئيسية من أفضل 100 كلمة رئيسية لكل عنوان URL. |
طريقة تقاطع المجالات | /domains_intersection | يعرض الكلمات الرئيسية الشائعة لما يصل إلى 3 مجالات |
DomainsUniqKeywordsMethod | /domains_uniq_keywords | يعرض الكلمات الرئيسية الفريدة للمجال. تتم إزالة الكلمات الأساسية التي يشترك فيها المجال الذي تم الاستعلام عنه مع مجال أو مجالين آخرين من القائمة. |
GetTopUrlsMethod | /get_top_urls | يظهر أعلى عناوين URL حسب المجال. |
طريقة المنافسين | /المنافسين | يسرد التقرير جميع النطاقات التي تم تصنيفها للكلمة الرئيسية المحددة في أفضل 20 نتيجة في Google |
طريقة الكلمات الرئيسية | / الكلمات الرئيسية | تستخدم هذه الطريقة البحث عن النص الكامل للعثور على جميع الكلمات الرئيسية التي تطابق المصطلح الذي تم الاستعلام عنه. مقابل كل كلمة رئيسية يتم العثور عليها، سترى حجمها وتكلفة النقرة (CPC) ومستوى المنافسة. |
KeywordInfoMethod | /keyword_info | يزودك هذا التقرير بنظرة عامة على الكلمات الرئيسية توضح حجمها وتكلفة النقرة (CPC) ومستوى المنافسة |
طريقة الاقتراحات | /اقتراحات | يسرد هذا التقرير اقتراحات الإكمال التلقائي للكلمة الرئيسية التي طلبتها (يتم العثور عليها من خلال البحث عن النص الكامل). |
طريقة الكلمات الرئيسية ذات الصلة | /connect_keywords | يمنحك هذا التقرير قائمة شاملة بالكلمات الرئيسية ذات الصلة التي يتشابه برنامج SERP الخاص بها مع الكلمة الرئيسية المطلوبة (فقط لأنواع الحسابات القياسية والمحترفة). |
KeywordTopMethod | /keyword_top | يعرض لك هذا التقرير أفضل 100 نتيجة بحث عضوية في Google للكلمة الرئيسية التي طلبتها. |
طريقة الكلمات الرئيسية الإعلانية | /ad_keywords | يعرض لك هذا التقرير نسخ الإعلانات التي تظهر للكلمة الرئيسية التي تم الاستعلام عنها في نتائج البحث المدفوعة من Google. |
UrlKeywordsMethod | /url_keywords | يسرد التقرير الكلمات الرئيسية التي يتم تصنيف عنوان URL لها في نتائج بحث Google. |
UrlCompetitorsMethod | /url_competitors | يعرض قائمة عناوين URL التي تتنافس مع عنوان URL الذي تم الاستعلام عنه في البحث العضوي. |
UrlMissingKeywordsMethod | /url_missing_keywords | يعرض قائمة بالكلمات الرئيسية التي تم تصنيف عناوين URL الخاصة بالمنافسين ضمن أفضل 10 كلمات رئيسية ولكنها مفقودة من الصفحة التي تم الاستعلام عنها. |
فئة الاستثناء | شفرة | رسالة |
---|---|---|
APIException | - | - |
ApiInvalidRequestException | 400 | طلب غير صالح |
ApiLimitExceededException | 402 | تجاوزت حدود التعريفة |
ApiAccessErrorException | 403 | مشاكل التفويض (رمز مميز خاطئ، إجراء محظور، أو حظر المستخدم) |
ApiNoResultsException | 404 | لا توجد نتائج |
ApiFrequencyExceededException | 429 | تم تجاوز تكرار الطلب (زيادة المهلة بين الطلبات) |
ApiServerException | 500 | خطأ في الخادم |
InvalidParamException | 500 | معلمة غير صالحة |
ParseResponseException | 500 | غير قادر على تحليل الاستجابة |