Method: customers.searchAds360.search

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

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

คำขอ HTTP

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

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

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

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

string

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

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

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

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

string

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

string

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

integer

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

boolean

หากเป็นจริง ระบบจะตรวจสอบคำขอแต่ไม่ดำเนินการ
returnTotalResultsCount

boolean

หากเป็นจริง ระบบจะรวมจํานวนผลลัพธ์ทั้งหมดที่ตรงกับการค้นหาโดยไม่สนใจคำสั่ง LIMIT ไว้ในคําตอบ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้ที่ false
summaryRowSetting

enum (SummaryRowSetting)

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

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

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

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

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

object (SearchAds360Row)

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

string

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

string (int64 format)

จำนวนผลลัพธ์ทั้งหมดที่ตรงกับข้อความค้นหาโดยไม่คำนึงถึงข้อความ LIMIT
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 เหตุการณ์ดิบในผลลัพธ์

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

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

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