リソース メタデータ

GoogleAdsFieldService を使用すると、GoogleAdsService の Search メソッドと SearchStream メソッドで使用可能なリソース、リソースのフィールド、セグメンテーション キー、指標のカタログを動的にリクエストできます。このカタログによって、Google Ads API クライアントが Google 広告クエリ言語ステートメントの検証や作成に使用できるメタデータが提供されます。

HTTP リクエストとレスポンスのサンプル

リクエストは、次の URL にある Google Ads API サーバーへの HTTP GET で構成されています。

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

次のサンプル リクエストでは、ad_group リソースに対して GoogleAdsFieldService から返されたレスポンスが後に続きます。

リクエスト

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

FROM 句にない場合、特定のフィールドとともに選択できるフィールド。この属性は、クエリで選択できるリソースまたはセグメントが FROM 句内のリソースに含まれていない場合にそれらを特定する際にのみ関係します。たとえば、ad_group から ad_group.id と segments.date を選択し、campaign の属性を含める場合は、既存の segments.date フィールドとともに選択されるため、キャンペーンの selectableWith 属性に segments.date が含まれていることを確認する必要があります。

メタデータの詳細

GoogleAdsFieldService を使用して、次の単位でカタログをリクエストできます。

リソース

例: googleAdsFields/campaign。

リソースのフィールド

例: googleAdsFields/campaign.name。

セグメント フィールド

例: googleAdsFields/segments.ad_network_type。

指標

例: googleAdsFields/metrics.clicks。