คุณสามารถใช้ GoogleAdsFieldService
เพื่อขอแคตตาล็อกทรัพยากร ฟิลด์ของทรัพยากร คีย์การแบ่งกลุ่ม และเมตริกแบบไดนามิกที่มีอยู่ในเมธอด Search และ SearchStream ของ GoogleAdsService
แคตตาล็อกมีข้อมูลเมตาที่ไคลเอ็นต์ Google Ads API สามารถใช้เพื่อตรวจสอบและสร้างคำสั่งภาษาการค้นหาของ Google Ads
ตัวอย่างคำขอและการตอบกลับ HTTP
คําขอประกอบด้วย HTTP GET
ไปยังเซิร์ฟเวอร์ Google Ads API ที่ URL ต่อไปนี้
https://googleads.googleapis.com/v20/googleAdsFields/{resource_or_field}
ตัวอย่างต่อไปนี้แสดงคําขอตามด้วยการตอบกลับจาก GoogleAdsFieldService
สําหรับทรัพยากร ad_group
ส่งคำขอ
https://googleads.googleapis.com/v20/googleAdsFields/ad_group
การตอบกลับ
{
"resourceName": "googleAdsFields/ad_group",
"name": "ad_group",
"category": "RESOURCE",
"selectable": false,
"filterable": false,
"sortable": false,
"selectableWith": [
"campaign",
"customer",
"metrics.average_cpc",
"segments.device",
...
],
"attributeResources": [
"customer",
"campaign"
],
"metrics": [
"metrics.conversions",
"metrics.search_budget_lost_impression_share",
"metrics.average_cost",
"metrics.clicks",
...
],
"segments": [
"segments.date",
"segments.ad_network_type",
"segments.device",
...
]
}
ในตัวอย่างนี้ อาร์เรย์ที่สําคัญ ได้แก่
attributeResources
- ทรัพยากรที่รวมเข้ากับทรัพยากรใน
FROM
clause ได้โดยนัย metrics
- เมตริกที่พร้อมให้เลือกใช้กับทรัพยากรในประโยค
FROM
จะมีการป้อนข้อมูลสำหรับช่องที่category
เป็นRESOURCE
เท่านั้น segments
- คีย์กลุ่มที่เลือกได้พร้อมกับทรัพยากรในประโยค
FROM
ซึ่งจะแบ่งกลุ่มเมตริกที่ระบุในการค้นหา มีการป้อนข้อมูลสำหรับช่องที่มีcategory
เป็นRESOURCE
เท่านั้น selectableWith
- ฟิลด์ที่เลือกพร้อมกับฟิลด์หนึ่งๆ ได้ ในกรณีที่ไม่ได้อยู่ในประโยค
FROM
แอตทริบิวต์นี้เกี่ยวข้องเฉพาะเมื่อระบุทรัพยากรหรือกลุ่มที่สามารถเลือกได้ในข้อความค้นหาซึ่งทรัพยากรในประโยคFROM
ไม่ได้รวมไว้ ตัวอย่างเช่น หากเราเลือกad_group.id
และsegments.date
จากad_group
และต้องการรวมแอตทริบิวต์จากcampaign
เราต้องตรวจสอบว่าsegments.date
อยู่ในแอตทริบิวต์selectableWith
สําหรับแคมเปญ เนื่องจากมีการเลือกแอตทริบิวต์ดังกล่าวควบคู่ไปกับช่องsegments.date
ที่มีอยู่
รายละเอียดข้อมูลเมตา
คุณขอแคตตาล็อกได้โดยใช้ GoogleAdsFieldService
ที่ระดับต่อไปนี้
- ทรัพยากร
- เช่น
googleAdsFields/campaign
- ฟิลด์ของทรัพยากร
- เช่น
googleAdsFields/campaign.name
- ฟิลด์การแบ่งกลุ่ม
- เช่น
googleAdsFields/segments.ad_network_type
- เมตริก
- เช่น
googleAdsFields/metrics.clicks