Method: accounts.reports.search

يسترجع تقريرًا محدّدًا من خلال طلب بحث. قد يحتوي الردّ على صفوف أقلّ من تلك المحدّدة في pageSize. استخدِم nextPageToken لتحديد ما إذا كان هناك المزيد من الصفوف المطلوب طلبها.

طلب HTTP

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
parent

string

مطلوب. رقم تعريف الحساب الذي يجري المكالمة يجب أن يكون حسابًا مستقلاً أو حسابًا فرعيًا لحساب متعدّد العملاء. التنسيق: accounts/{account}

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
الحقول
query

string

مطلوب. طلب بحث يحدِّد التقرير المطلوب استرجاعه

لمعرفة التفاصيل حول كيفية إنشاء طلب البحث، اطّلِع على دليل لغة طلبات البحث. للحصول على القائمة الكاملة بالجداول والحقول المتاحة، اطّلِع على "الحقول المتاحة".
pageSize

integer

اختيارية: عدد ReportRows التي سيتم استرجاعها في صفحة واحدة القيمة التلقائية هي 1000. يتم فرض القيم التي تزيد عن 5000 لتكون 5000.
pageToken

string

اختيارية: الرمز المميّز للصفحة المطلوب استردادها إذا لم يتم تحديدها، يتم عرض الصفحة الأولى من النتائج. لطلب الصفحة التالية من النتائج، يجب استخدام القيمة التي تم الحصول عليها من nextPageToken في الاستجابة السابقة.

نص الاستجابة

رسالة الردّ على طريقة ReportService.Search

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
الحقول
results[]

object (ReportRow)

الصفوف التي تطابقت مع طلب البحث
nextPageToken

string

رمز مميّز يمكن إرساله على شكل pageToken لاسترداد الصفحة التالية. في حال حذفها، لن تظهر أي صفحات لاحقة.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/content

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.