فراداده منابع

شما می‌توانید از GoogleAdsFieldService برای درخواست پویا از کاتالوگ منابع، فیلدهای منابع، کلیدهای تقسیم‌بندی و معیارهای موجود در متدهای Search و SearchStream در GoogleAdsService استفاده کنید. این کاتالوگ، فراداده‌هایی را ارائه می‌دهد که می‌توانند توسط کلاینت‌های API گوگل ادز برای اعتبارسنجی و ساخت عبارات زبان جستجوی گوگل ادز مورد استفاده قرار گیرند.

نمونه درخواست و پاسخ HTTP

این درخواست شامل یک HTTP GET به سرور Google Ads API در URL زیر است:

https://googleads.googleapis.com/v22/googleAdsFields/{resource_or_field}

مثال زیر درخواستی را نشان می‌دهد که به دنبال آن پاسخی از GoogleAdsFieldService برای منبع ad_group برگردانده می‌شود:

درخواست

https://googleads.googleapis.com/v22/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:

1. منبع موجود در عبارت FROM ، موجودیت اصلی است. شما همیشه می‌توانید فیلدهایی را از این منبع انتخاب کنید.
2. همچنین می‌توانید معیارها و بخش‌های سازگار با موجودیت اصلی را انتخاب کنید.
3. اگر فیلدهایی از هر منبع یا بخشی خارج از عبارت 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 .