リソース メタデータ

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

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

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

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

以下は、リクエストとそれに続くレスポンスの例です。 ad_group リソースの GoogleAdsFieldService:

リクエスト

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