Method: accounts.reports.search

یک گزارش تعریف شده توسط یک عبارت جستجو را بازیابی می کند. پاسخ ممکن است دارای ردیف های کمتری نسبت به pageSize باشد. برای تعیین اینکه آیا ردیف های بیشتری برای درخواست وجود دارد یا خیر، به nextPageToken تکیه کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
parent

string

مورد نیاز. شناسه حسابی که تماس برقرار می کند. باید یک حساب مستقل یا یک حساب فرعی MCA باشد. قالب: حساب‌ها/{حساب}

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
فیلدها
query

string

مورد نیاز. کوئری که گزارشی را برای بازیابی تعریف می کند.

برای جزئیات در مورد نحوه ساخت پرس و جو، به راهنمای زبان پرس و جو مراجعه کنید. برای لیست کامل جداول و فیلدهای موجود، به فیلدهای موجود مراجعه کنید.

page Size

integer

اختیاری. تعداد ReportRows برای بازیابی در یک صفحه. پیش‌فرض 1000 است. مقادیر بالای 5000 به 5000 تبدیل می‌شوند.

page Token

string

اختیاری. نشانه صفحه برای بازیابی. اگر مشخص نشده باشد، صفحه اول نتایج برگردانده می شود. برای درخواست صفحه بعدی نتایج، باید از مقدار بدست آمده از nextPageToken در پاسخ قبلی استفاده شود.

بدن پاسخگو

پیام پاسخ برای روش ReportService.Search .

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
فیلدها
results[]

object ( ReportRow )

ردیف هایی که با عبارت جستجو مطابقت دارند.

next Page Token

string

نشانه ای که می تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر حذف شود، هیچ صفحه بعدی وجود ندارد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.