Google Ads API มีกลไกการดึงข้อมูลแอตทริบิวต์และเมตริกแบบรวมที่ช่วยให้คุณสร้างคำค้นหาโดยใช้ภาษาคำค้นหาของ Google Ads ได้ ซึ่งทำให้เกิดการค้นหาที่ซับซ้อนซึ่งสามารถแสดงข้อมูลจำนวนมากเกี่ยวกับบัญชี Google Ads แต่ละบัญชี
คุณสามารถสร้างการค้นหาได้โดยใช้เมธอด Search หรือ SearchStream
ทั้ง 2 วิธีรองรับคำค้นหาเดียวกันและแสดงผลลัพธ์ที่เทียบเท่ากัน เมธอด Search จะแสดงผลข้อมูลเป็นขนาดหน้าที่ปรับแต่งได้ ซึ่งช่วยให้คุณทำซ้ำชุดผลลัพธ์ได้โดยใช้การใส่เลขหน้า ซึ่งอาจเป็นข้อได้เปรียบในแบนด์วิดท์ต่ำหรือเงื่อนไขของเครือข่ายที่ไม่เสถียร เช่น ในการแบ่งกลุ่มผลลัพธ์ขนาดใหญ่เป็นคำตอบที่เล็กลงซึ่งสามารถดึงข้อมูลใหม่ได้ในกรณีที่การเชื่อมต่อขาดหาย ในทางกลับกัน เมธอด SearchStream จะสตรีมผลลัพธ์ทั้งหมดที่ตั้งค่าย้อนกลับในคำตอบเดียว ซึ่งมีประสิทธิภาพมากกว่าสำหรับการดึงข้อมูลจำนวนมาก
ทั้ง Search และ SearchStream ใช้ URL ฐานเดียวกัน:
https://googleads.googleapis.com/v17/customers/CUSTOMER_ID/googleAds
วิธีการค้นหาตามหน้าเว็บจะใช้พารามิเตอร์ pageSize (ไม่บังคับ) ซึ่งจะจำกัดจำนวนผลลัพธ์ที่จะแสดงในการตอบสนองของ API รายการเดียว
POST /v17/customers/CUSTOMER_ID/googleAds:search HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
{
"pageSize": 10000,
"query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'"
}
หากมีแถวมากกว่า pageSize แถวในผลลัพธ์ ระบบจะแสดงผล nextPageToken ในคำตอบ
{
"results": [
// ...
// ...
// ...
],
"nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B",
"fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status"
}
การใช้คำค้นหาเดียวกันซ้ำโดยเพิ่ม pageToken ด้วยค่าข้างต้นจะดึงผลการค้นหาหน้าถัดไป:
POST /v17/customers/CUSTOMER_ID/googleAds:search HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
{
"pageSize": 10000,
"query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'",
"pageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B"
}
หากต้องการใช้เมธอด SearchStream ซึ่งแสดงผลลัพธ์ทั้งหมดในการตอบกลับแบบสตรีมรายการเดียว แค่เปลี่ยนเมธอดบริการใน URL เป็น searchStream (SearchStream และ pageToken ไม่จำเป็นต้องใช้ pageSize):
POST /v17/customers/CUSTOMER_ID/googleAds:searchStream HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
{
"query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'"
}