يمكنك استخدام SearchAds360FieldService
لطلب كتالوج الموارد وحقول الموارد بشكل ديناميكي
ومفاتيح التقسيم والمقاييس المتاحة في طريقتَي SearchAds360Service
Search
وSearchStream
. ويقدّم الكتالوج بيانات وصفية يمكن أن يستخدمها عملاء واجهة برمجة التطبيقات لإعداد التقارير في "إعلانات شبكة البحث 360" للتحقق من صحة عبارات طلب البحث في "إعلانات شبكة البحث 360" وإنشائها.
نموذج لطلب HTTP واستجابةه
يتكون الطلب من HTTP GET
يؤدي إلى خادم Search Ads 360 Reporting API على عنوان URL التالي:
https://searchads360.googleapis.com/v0/searchAds360Fields/{resource_or_field}
في ما يلي مثال على طلب متبوعًا بردّ من SearchAds360FieldService
لمورد ad_group:
الطلب
https://searchads360.googleapis.com/v0/searchAds360Fields/ad_group
الإجابة
{
"resourceName": "searchAds360Fields/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
- الحقول التي يمكن اختيارها بجانب حقل معيّن، عندما لا تكون مُدرَجة في عبارة
FROM
. هذه السمة مناسبة فقط عند تحديد الموارد أو الأقسام التي يمكن اختيارها في طلب بحث حيث لا يتم تضمينها في المورد في عبارةFROM
. على سبيل المثال، إذا اخترتad_group.id
وsegments.date
منad_group
وأردت تضمين سمات منcampaign
، عليك التأكّد من تضمينsegments.date
في السمةselectableWith
للحملة، لأنّه يتم اختيارها بجانب حقلsegments.date
الحالي.
تفاصيل البيانات الوصفية
يمكنك طلب الكتالوج باستخدام SearchAds360FieldService
على المستويات التالية:
- المورد
- على سبيل المثال،
searchAds360Fields/campaign
. - حقل المورد
- على سبيل المثال،
searchAds360Fields/campaign.name
. - حقل التصنيف
- على سبيل المثال،
searchAds360Fields/segments.ad_network_type
. - المقياس
- على سبيل المثال،
searchAds360Fields/metrics.clicks
.
استخدام طلب بحث للحصول على تفاصيل الحقول
يمكن الحصول على تفاصيل الحقل عن طريق إرسال استعلام إلى
https://searchads360.googleapis.com/v0/searchAds360Fields:search
المثال 1: استخدام تعبير عادي
SELECT
name,
category,
selectable,
filterable,
sortable,
selectable_with,
data_type,
is_repeated
WHERE name LIKE 'ad_group.%'"
المثال 2: طلب البحث عن حقول أو مقاييس أو شرائح محددة.
SELECT
name,
category,
selectable,
filterable,
sortable,
selectable_with,
data_type,
is_repeated
WHERE
name IN (
"ad_group.id",
"ad_group.name",
"segments.date",
"customer.id",
"customer.manager",
"metrics.clicks"
)