Method: customers.googleAds.search

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

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

คำขอ HTTP

POST https://googleads.googleapis.com/v14/customers/{customerId}/googleAds: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)

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

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

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

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

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

object (GoogleAdsRow)

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

string

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

string (int64 format)

จำนวนผลลัพธ์ทั้งหมดที่ตรงกับข้อความค้นหาโดยไม่สนใจอนุประโยค LIMIT
fieldMask

string (FieldMask format)

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

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

object (GoogleAdsRow)

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

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

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

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0