リソース メタデータ

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

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

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

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

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

リクエスト

https://googleads.googleapis.com/v11/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 句のリソースで選択できる指標。categoryRESOURCE のフィールドにのみ入力されます。
segments
FROM 句のリソースで選択できるセグメントキー。クエリで指定された指標をセグメント化します。categoryRESOURCE のフィールドにのみ入力されます。
selectableWith
FROM 句以外の場合に、特定のフィールドとともに選択できるフィールド。この属性は、FROM 句のリソースに含まれていないクエリ内で選択可能なリソースやセグメントを識別する場合にのみ関係します。たとえば、ad_group から ad_group.idsegments.date を選択し、campaign から属性を含める場合は、segments.date がキャンペーンの selectableWith 属性に含まれていることを確認する必要があります。これは、既存の segments.date フィールドとともに選択されているためです。

メタデータの詳細

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

リソース
例: googleAdsFields/campaign
リソースのフィールド
例: googleAdsFields/campaign.name
セグメント フィールド
例: googleAdsFields/segments.ad_network_type
指標
例: googleAdsFields/metrics.clicks