Method: customers.searchAds360.searchStream

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

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

คำขอ HTTP

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream

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

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

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

string

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

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

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

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

string

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

batchSize

integer

จํานวนแถวที่แสดงผลในแต่ละกลุ่มการตอบกลับสตรีม เมื่อมีการขอกลุ่มที่มีขนาดใหญ่เกินไป เซิร์ฟเวอร์อาจตัดสินใจจำกัดจำนวนแถวที่แสดงผลเพิ่มเติม

summaryRowSetting

enum (SummaryRowSetting)

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

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

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

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

การแสดง JSON
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
ช่อง
results[]

object (SearchAds360Row)

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

fieldMask

string (FieldMask format)

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

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

summaryRow

object (SearchAds360Row)

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

customColumnHeaders[]

object (CustomColumnHeader)

ส่วนหัวของคอลัมน์ที่กำหนดเองในผลการค้นหา

conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

ส่วนหัวของเมตริกที่กําหนดเองของ Conversion ในผลลัพธ์

conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

ส่วนหัวของมิติข้อมูลที่กำหนดเองของ Conversion ในผลลัพธ์

rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

ส่วนหัวของเมตริก Conversion เหตุการณ์ดิบในผลลัพธ์

rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

ส่วนหัวของมิติข้อมูล Conversion เหตุการณ์ดิบในผลลัพธ์

requestId

string

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

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

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

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