Method: accounts.reports.search

אחזור דוח שמוגדר על ידי שאילתת חיפוש. התשובה עשויה להכיל פחות שורות ממה שצוין ב-pageSize. אפשר להסתמך על nextPageToken כדי לקבוע אם יש עוד שורות שצריך לבקש.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. המזהה של החשבון שמבצע את הקריאה. החשבון חייב להיות חשבון עצמאי או חשבון משנה של חשבון MCA. פורמט: accounts/{account}

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
שדות
query

string

חובה. שאילתה שמגדירה דוח לאחזור.

פרטים על בניית השאילתה מופיעים במדריך לשפת השאילתות. ברשימה 'שדות זמינים' מפורטת רשימה מלאה של הטבלאות והשדות הזמינים.
pageSize

integer

זה שינוי אופציונלי. מספר ה-ReportRows שרוצים לאחזר בדף אחד. ברירת המחדל היא 1,000. ערכים מעל 5,000 מוגדרים כ-5,000.
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.