Method: accounts.reports.search

ดึงข้อมูลรายงานที่กําหนดโดยคําค้นหา การตอบกลับอาจมีแถวน้อยกว่าที่ pageSize ระบุ ใช้ nextPageToken เพื่อดูว่ามีแถวอื่นที่จะขอหรือไม่

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง 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