リソース メタデータ

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

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

注: この例では、基盤となる HTTP/JSON リクエストをガイドとして示していますが、gRPC に基づくクライアント ライブラリのいずれかを使用してリクエストを送信することを強くおすすめします。

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

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 の属性を含める場合、キャンペーンの selectableWith 属性に segments.date が含まれていることを確認する必要があります。これは、segments.date が既存の segments.date フィールドとともに選択されるためです。

メタデータの詳細

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

リソース

例: googleAdsFields/campaign

リソースのフィールド

例: googleAdsFields/campaign.name

セグメント フィールド

例: googleAdsFields/segments.ad_network_type

指標

例: googleAdsFields/metrics.clicks