فراداده منبع

می‌توانید از GoogleAdsFieldService (ازطریق GetGoogleAdsField یا SearchGoogleAdsFields) برای درخواست پویا از کاتالوگ منابع، فیلدهای منبع، کلیدهای بخش‌بندی، و سنجه‌های دردسترس در روش‌های GoogleAdsService Search و SearchStream استفاده کنید. کاتالوگ فراداده‌ای ارائه می‌دهد که می‌تواند توسط کارخواه‌های Google Ads API برای اعتبارسنجی و ساختن عبارت‌های «زبان پُرسمان Google Ads» استفاده شود.

نمونه درخواست و پاسخ اچ‌تی‌تی‌پی

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

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

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

درخواست

https://googleads.googleapis.com/v26/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 بدون بخش‌بندی سنجه‌ها بپیوندند. فقط برای فیلدهایی که category RESOURCE است درج می‌شود.
metrics
سنجه‌هایی که برای انتخاب با منبع در عبارت FROM دردسترس هستند. فقط برای فیلدهایی که category آن‌ها RESOURCE است درج می‌شود.
segments
کلیدهای بخش (فیلدهای segments.* و منابع بخش‌بندی) که می‌توانند با منبع در عبارت FROM انتخاب شوند. این‌ها سنجه‌های مشخص‌شده در پُرسمان را بخش‌بندی می‌کنند. فقط برای فیلدهایی که category RESOURCE است درج می‌شود.
selectableWith
منابع، بخش‌ها، یا سنجه‌هایی که می‌توانند در همان پُرسمان «زبان پُرسمان Google Ads» انتخاب شوند وقتی این منبع یا بخش منبع اصلی در بند FROM نباشد.

سازگاری پُرسمان با selectableWith

مشخصه selectableWith در فیلد منبع یا بخش، منابع، بخش‌ها، یا سنجه‌های دیگری را مشخص می‌کند که می‌توانند در همان پُرسمان «زبان پُرسمان Google Ads» انتخاب شوند. این مشخصه زمانی بسیار مهم است که می‌خواهید فیلدهایی را از منبع یا بخشی که در عبارت FROM مشخص نشده است اضافه کنید.

هنگام ساختن پرسمان «زبان پرسمان Google Ads»:

  1. منبع در عبارت FROM موجودیت اصلی است. همیشه می‌توانید فیلدها را از این منبع انتخاب کنید.
  2. همچنین می‌توانید سنجه‌ها و بخش‌های سازگار را که با نهاد اصلی دردسترس هستند انتخاب کنید.
  3. اگر فیلدهایی از هر منبع یا بخش خارج از عبارت FROM را اضافه کنید، باید مطمئن شوید که این منبع یا بخش غیرFROM با تمام فیلدها، بخش‌ها و معیارهای دیگری که در پُرسمان انتخاب شده‌اند سازگار است.

فهرست selectableWith برای یک منبع خاص (منبع الف) شامل همه منابع، بخش‌ها، و سنجه‌های دیگری است که می‌توانند در کنار فیلدهای منبع الف انتخاب شوند، زمانی که منبع الف موجودیت اصلی نیست.

مثال

این پُرسمان نمونه را درنظر بگیرید:

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 (با نام منبع با GetGoogleAdsField یا با پُرسمان با SearchGoogleAdsFields) در این سطوح GoogleAdsFieldCategory درخواست کنید:

منبع (RESOURCE)
برای مثال، googleAdsFields/campaign.
مشخصه منبع (ATTRIBUTE)
برای مثال، googleAdsFields/campaign.name.
فیلد بخش‌بندی (SEGMENT)
برای مثال، googleAdsFields/segments.ad_network_type.
سنجه (METRIC)
برای مثال، googleAdsFields/metrics.clicks.