SearchStream

تتضمّن واجهة برمجة التطبيقات Search Ads 360 Reporting API آلية موحّدة لاسترداد السمات وإعداد تقارير المقاييس تتيح لك إنشاء طلبات بحث باستخدام لغة طلبات البحث في "إعلانات شبكة البحث 360". يتيح ذلك تنفيذ طلبات بحث معقّدة يمكن أن تعرض كميات كبيرة من البيانات حول حسابات فردية على "إعلانات شبكة البحث 360".

يمكنك إنشاء طلبات بحث باستخدام إحدى الطريقتين Search أو SearchStream. تتيح كلتا الطريقتين طلبات البحث نفسها وتعرضان نتائج مكافئة. تعرض الطريقة Search البيانات بأحجام صفحات قابلة للتخصيص، ما يتيح لك تكرار مجموعة نتائج باستخدام تقسيم الصفحات. قد يكون ذلك مفيدًا في حال توفّر معدّل نقل بيانات منخفض أو في حال عدم استقرار الشبكة، مثلاً لتقسيم مجموعة نتائج كبيرة إلى ردود أصغر يمكن إعادة جلبها في حال فقدان الاتصال. في المقابل، تعرض الطريقة SearchStream مجموعة النتائج بأكملها في ردّ واحد، ما قد يكون أكثر فعالية لاسترداد البيانات المجمّعة.

يستخدم كل من Search وSearchStream عنوان URL الأساسي نفسه:

    https://searchAds360.googleapis.com/v0/customers/CUSTOMER_ID/searchAds360

تتضمّن طريقة البحث المستندة إلى الصفحة المَعلمة الاختيارية pageSize التي تحدّ من عدد النتائج التي يتم عرضها في ردّ واحد من واجهة برمجة التطبيقات.

POST /v0/customers/CUSTOMER_ID/searchAds360:search HTTP/1.1
Host: searchAds360.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN

{
"pageSize": 10000,
"query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'"
}

إذا كان عدد الصفوف في النتائج أكبر من pageSize، سيتم عرض nextPageToken في الرد:

{
  "results": [
    // ...
    // ...
    // ...
  ],
  "nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B",
  "fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status"
}

يؤدي تكرار طلب البحث نفسه مع إضافة pageToken بالقيمة أعلاه إلى عرض الصفحة التالية من النتائج:

POST /v0/customers/CUSTOMER_ID/searchAds360:search HTTP/1.1
Host: searchads360.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN


{
"pageSize": 10000,
"query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'",
"pageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B"
}

لاستخدام طريقة SearchStream، التي تعرض جميع النتائج في استجابة واحدة يتم بثها، ما عليك سوى تغيير طريقة الخدمة في عنوان URL إلى searchStream (لا تتطلّب SearchStream استخدام pageSize وpageToken):

POST /v0/customers/CUSTOMER_ID/searchAds360:searchStream HTTP/1.1
Host: searchads360.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN

{
    "query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'"
}