リソース メタデータ

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

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

リクエストは、次の URL にある検索広告 360 Reporting API サーバーへの HTTP GET で構成されています。

https://searchads360.googleapis.com/v0/searchAds360Fields/{resource_or_field}

次のサンプル リクエストでは、ad_group リソースに対して SearchAds360FieldService から返されたレスポンスが後に続きます。

リクエスト

https://searchads360.googleapis.com/v0/searchAds360Fields/ad_group

レスポンス

{
  "resourceName": "searchAds360Fields/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 が含まれていることを確認する必要があります。

メタデータの詳細

SearchAds360FieldService を使用して、次の単位でカタログをリクエストできます。

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

クエリを使用してフィールドの詳細を取得する

フィールドの詳細は、

https://searchads360.googleapis.com/v0/searchAds360Fields:search

例 1: 正規表現を使用する。

SELECT
  name,
  category,
  selectable,
  filterable,
  sortable,
  selectable_with,
  data_type,
  is_repeated
WHERE name LIKE 'ad_group.%'"

例 2: 特定のフィールド、指標、セグメントをクエリする。

SELECT
  name,
  category,
  selectable,
  filterable,
  sortable,
  selectable_with,
  data_type,
  is_repeated
WHERE
  name IN (
    "ad_group.id",
    "ad_group.name",
    "segments.date",
    "customer.id",
    "customer.manager",
    "metrics.clicks"
  )