میتوانید از SearchAds360FieldService
برای درخواست پویا کاتالوگ برای منابع، فیلدهای منبع، کلیدهای بخشبندی و معیارهای موجود در روشهای SearchAds360Service
Search
و SearchStream
استفاده کنید. این کاتالوگ ابردادههایی را ارائه میکند که میتوانند توسط سرویسگیرندگان Search Ads 360 Reporting API برای اعتبارسنجی و ساخت عبارتهای Search Ads 360 Query Language استفاده شوند.
نمونه درخواست و پاسخ 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"
)