Method: customers.searchAds360.search

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

รายการข้อผิดพลาดที่เกิดขึ้น: AuthenticationError, AuthorizationError, ChangeEventError, ChangeStatusError, ClickViewError, 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 ไว้ในการตอบกลับ ค่าเริ่มต้นคือ "เท็จ"
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