リソース メタデータ

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

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

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

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

以下は、ad_group リソースに対して GoogleAdsFieldService から返されるレスポンスが後に続くリクエストの例です。

リクエスト

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