リソース メタデータ

GoogleAdsFieldService を使用すると、GoogleAdsService 検索メソッドと SearchStream メソッドで利用可能なリソース、リソースのフィールド、セグメンテーション キー、指標のカタログを動的にリクエストできます。カタログには、Google Ads API クライアントが Google Ads Query Language ステートメントの検証と構築に使用できるメタデータが用意されています。

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

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

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

次に、ad_group リソースの GoogleAdsFieldService から返されるリクエストの例を示します。

リクエスト

https://googleads.googleapis.com/v13/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 フィールドとともに選択されているため、キャンペーンの selectableWith 属性に含まれていることを確認する必要があります。

メタデータの詳細

次のレベルで GoogleAdsFieldService を使用してカタログをリクエストできます。

リソース

例: googleAdsFields/campaign

リソースのフィールド

例: googleAdsFields/campaign.name

セグメント フィールド

例: googleAdsFields/segments.ad_network_type

指標

例: googleAdsFields/metrics.clicks