คุณสามารถใช้ GoogleAdsFieldService
เพื่อขอแคตตาล็อกแบบไดนามิกสำหรับทรัพยากร ฟิลด์ของทรัพยากร
คีย์การแบ่งกลุ่ม และเมตริกที่มีอยู่ใน
GoogleAdsService Search และ
เมธอด SearchStream แคตตาล็อกมีข้อมูลเมตาที่ไคลเอ็นต์ Google Ads API ใช้ได้สําหรับการตรวจสอบและการสร้างคําสั่ง Google Ads Query Language
ตัวอย่างคำขอและการตอบกลับ HTTP
คำขอประกอบด้วย HTTP GET ไปยังเซิร์ฟเวอร์ Google Ads API ที่ URL ต่อไปนี้
https://googleads.googleapis.com/v23/googleAdsFields/{resource_or_field}
ตัวอย่างต่อไปนี้แสดงคำขอและคำตอบที่ส่งคืนจาก
GoogleAdsFieldService สำหรับทรัพยากร ad_group
ส่งคำขอ
https://googleads.googleapis.com/v23/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อนุประโยค โดยนัย
metrics- เมตริกที่เลือกได้พร้อมกับแหล่งข้อมูลใน
FROMข้อความ จะมีการป้อนข้อมูลสำหรับฟิลด์ที่categoryเป็นRESOURCEเท่านั้น segments- คีย์กลุ่มที่เลือกได้กับทรัพยากรในข้อกำหนด
FROMซึ่งจะแบ่งกลุ่มเมตริกที่ระบุในการค้นหา จะมีการป้อนข้อมูลสำหรับฟิลด์ ที่categoryเป็นRESOURCEเท่านั้น selectableWith-
แอตทริบิวต์
selectableWithในฟิลด์ทรัพยากรหรือฟิลด์กลุ่มจะระบุ ทรัพยากร กลุ่ม หรือเมตริกอื่นๆ ที่เลือกได้ในคำค้นหา GAQL เดียวกัน แอตทริบิวต์นี้มีความสําคัญอย่างยิ่งเมื่อคุณต้องการรวมฟิลด์จากแหล่งข้อมูลหรือกลุ่มที่ไม่ได้ระบุไว้ในFROMข้อความเมื่อสร้างคําค้นหา GAQL ให้ทําดังนี้
- ทรัพยากรในข้อกำหนด
FROMคือเอนทิตีหลัก คุณเลือกฟิลด์จากทรัพยากรนี้ได้ทุกเมื่อ - นอกจากนี้ คุณยังเลือกเมตริกและกลุ่มที่เข้ากันได้ซึ่งใช้ได้กับเอนทิตีหลักได้ด้วย
- หากคุณรวมฟิลด์จากแหล่งข้อมูลหรือกลุ่มใดๆ นอก
FROMข้อกำหนด คุณต้องตรวจสอบว่าแหล่งข้อมูลหรือกลุ่มที่ไม่ใช่FROMนี้ เข้ากันได้กับฟิลด์ กลุ่ม และเมตริกอื่นๆ ทั้งหมดที่เลือกใน คําค้นหา
- ทรัพยากรในข้อกำหนด
selectableWithรายการสำหรับทรัพยากรที่เฉพาะเจาะจง (สมมติว่าชื่อทรัพยากร A) ประกอบด้วยทรัพยากรอื่นๆ ทั้งหมด กลุ่ม และเมตริกที่เลือกได้ พร้อมกับช่องจากทรัพยากร A เมื่อทรัพยากร A ไม่ใช่เอนทิตีหลักตัวอย่างเช่น
ลองดูตัวอย่างคำค้นหานี้
SELECT ad_group.id, segments.date, campaign.name FROM ad_groupข้อกำหนด
FROMระบุad_groupการค้นหานี้จะเลือก
ad_group.id(จากทรัพยากรFROM)segments.dateและcampaign.nameเนื่องจากมีการเลือก
campaign.nameแต่campaignไม่อยู่ในข้อกำหนดFROMคุณจึงต้องยืนยันความเข้ากันได้กับองค์ประกอบอื่นๆ ที่เลือกเพื่อให้มั่นใจว่าการค้นหานี้ถูกต้อง
campaignต้อง เข้ากันได้กับsegments.date(ฟิลด์อื่นที่เลือก) ดังนั้น คุณต้องตรวจสอบแอตทริบิวต์selectableWithสำหรับทรัพยากรcampaignหากsegments.dateอยู่ในรายการselectableWithของcampaignแสดงว่าคำค้นหาถูกต้อง
หากคุณเลือกฟิลด์จากแหล่งข้อมูลที่ไม่ได้อยู่ใน
FROMข้อกำหนด รายการselectableWithของแหล่งข้อมูลนั้นต้องรวมกลุ่มและแหล่งข้อมูลอื่นๆ ทั้งหมดที่อยู่ในSELECTข้อกำหนด
รายละเอียดข้อมูลเมตา
คุณขอแคตตาล็อกได้โดยใช้ GoogleAdsFieldService ที่ระดับต่อไปนี้
- ทรัพยากร
- เช่น
googleAdsFields/campaign - ฟิลด์ของทรัพยากร
- เช่น
googleAdsFields/campaign.name - ฟิลด์การแบ่งกลุ่ม
- เช่น
googleAdsFields/segments.ad_network_type - เมตริก
- เช่น
googleAdsFields/metrics.clicks