SearchAds360FieldService
を使用すると、SearchAds360Service
Search
メソッドと SearchStream
メソッドで使用可能なリソース、リソースのフィールド、セグメンテーション キー、指標のカタログを動的にリクエストできます。カタログは、検索広告 360 Reporting API クライアントが検索広告 360 のクエリ言語ステートメントの検証と構築に使用できるメタデータを提供します。
HTTP リクエストとレスポンスのサンプル
このリクエストには、次の URL にある Search Ads 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"
)