Method: customers.googleAds.search

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

รายการข้อผิดพลาด: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

คำขอ HTTP

POST https://googleads.googleapis.com/v17/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)
  },
  "queryResourceConsumption": string
}
ช่อง
results[]

object (GoogleAdsRow)

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

string

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

string (int64 format)

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

string (FieldMask format)

FieldMask ที่แสดงช่องที่ผู้ใช้ขอ

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

object (GoogleAdsRow)

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

string (int64 format)

จำนวนทรัพยากรที่ใช้เพื่อแสดงคำค้นหา

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0