Method: customers.googleAds.searchStream

แสดงผลแถวทั้งหมดที่ตรงกับคำค้นหาสตรีมการค้นหา

รายการข้อผิดพลาดที่แสดง: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

คำขอ HTTP

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
customerId

string

ต้องระบุ รหัสของลูกค้าที่ค้นหา

เนื้อหาของคำขอ

เนื้อความของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "query": string,
  "summaryRowSetting": enum (SummaryRowSetting)
}
ช่อง
query

string

ต้องระบุ สตริงการค้นหา
summaryRowSetting

enum (SummaryRowSetting)

กำหนดว่าจะแสดงแถวสรุปหรือไม่ ระบบจะไม่แสดงแถวข้อมูลสรุปโดยค่าเริ่มต้น หากมีการขอ ระบบจะส่งแถวข้อมูลสรุปในการตอบกลับแยกต่างหากหลังจากที่แสดงผลลัพธ์การค้นหาอื่นๆ ทั้งหมดแล้ว

เนื้อหาการตอบกลับ

ข้อความตอบกลับสำหรับ GoogleAdsService.SearchStream

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
ช่อง
results[]

object (GoogleAdsRow)

รายการแถวที่ตรงกับคําค้นหา
fieldMask

string (FieldMask format)

FieldMask ที่แสดงฟิลด์ที่ผู้ใช้ขอ

ซึ่งเป็นรายการชื่อฟิลด์ที่สมบูรณ์ในตัวเองที่คั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"
summaryRow

object (GoogleAdsRow)

แถวสรุปที่มีสรุปเมตริกในผลลัพธ์ สรุปเมตริกหมายถึงการรวมเมตริกจากผลลัพธ์ทั้งหมด ซึ่งการรวมอาจเป็นผลรวม ค่าเฉลี่ย อัตรา เป็นต้น
requestId

string

รหัสที่ไม่ซ้ำกันของคําขอที่ใช้สําหรับการแก้ไขข้อบกพร่อง
queryResourceConsumption

string (int64 format)

ปริมาณทรัพยากรที่ใช้เพื่อแสดงคําค้นหา ระบบจะแสดงค่า queryResourceConsumption สําหรับแถวข้อมูลสรุปและการตอบกลับที่ไม่ใช่ข้อมูลสรุปแยกกันในแถวที่เกี่ยวข้อง ระบบจะแสดงค่า queryResourceConsumption สําหรับการตอบกลับที่ไม่ใช่ข้อมูลสรุปในผลลัพธ์กลุ่มสุดท้าย

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview

SummaryRowSetting

Enum ที่อธิบายการตั้งค่าแถวข้อมูลสรุปการคืนสินค้า

Enum
UNSPECIFIED ไม่ได้ระบุ
UNKNOWN แสดงค่าที่ไม่รู้จักของแถวข้อมูลสรุปการคืนสินค้า
NO_SUMMARY_ROW ไม่แสดงแถวสรุป
SUMMARY_ROW_WITH_RESULTS แสดงแถวข้อมูลสรุปพร้อมกับผลลัพธ์ ระบบจะแสดงผลแถวข้อมูลสรุปในกลุ่มสุดท้ายเพียงกลุ่มเดียว (กลุ่มสุดท้ายจะไม่มีผลลัพธ์)
SUMMARY_ROW_ONLY แสดงเฉพาะแถวข้อมูลสรุปและไม่มีการแสดงผลลัพธ์