検索広告 360 Reporting API の構造

Search Ads 360 Reporting API の主なコンポーネントは、リソースとサービスです。リソースは検索広告 360 のエンティティを表し、サービスを使って検索広告 360 のエンティティを取得します。

オブジェクト階層

検索広告 360 アカウントはオブジェクトの階層構造になっています。

  • アカウントの最上位のリソースはお客様です。

  • 各アカウントには、有効なキャンペーンが 1 つ以上含まれています。

  • 各 Campaign には、広告を論理コレクションにまとめる 1 つ以上の広告グループが含まれます。

  • 各 AdGroup には、1 つまたは複数の広告グループ広告が含まれます。

  • 1 つ以上の AdGroupCriterion または CampaignCriterion を広告グループまたはキャンペーンに設定できます。条件では、広告の表示方法を定義します。

    • 条件タイプには、キーワード、年齢層、地域など、さまざまな種類があります。キャンペーン レベルで定義された条件は、キャンペーン内の他のすべてのリソースに影響します。キャンペーン全体の予算と期間を指定することもできます。

関連情報

リソースは、検索広告 360 アカウントのエンティティを表します。リソースの例としては、Customer、Campaign、AdGroup があります。

オブジェクト ID

検索広告 360 内のオブジェクトは、それぞれ固有の ID で識別されます。ID には、すべての検索広告 360 アカウント間でグローバルに一意なものと、特定の範囲内でのみ一意であるものがあります。

オブジェクト ID の一意性のスコープ
予算 ID グローバル
キャンペーン ID グローバル
広告グループ ID グローバル
広告 ID 広告グループ

AdGroupId と AdId の各ペアは、グローバルに一意です。
AdGroupCriterion ID 広告グループ

AdGroupId と CriterionId の各ペアは、グローバルに一意です。
CampaignCriterion ID キャンペーン

CampaignId と CriterionId の各ペアは、グローバルに一意です。
広告表示オプション キャンペーン

CampaignId と AdExtensionId の各ペアは、グローバルに一意です。
フィード ID グローバル
Feed Item ID グローバル
Feed Attribute ID フィード
Feed Mapping ID グローバル
ラベル ID グローバル
ユーザーリスト ID グローバル

これらの ID ルールは、検索広告 360 オブジェクトのローカル ストレージを設計する際に便利です。

オブジェクト型

一部のオブジェクトは、複数のエンティティ タイプに使用できます。その場合、オブジェクトにはコンテンツを説明する type フィールドが含まれます。たとえば AdGroupAd は、テキスト広告、ホテル広告、ローカル広告のいずれかを指します。タイプの値には AdGroupAd.ad.type フィールドからアクセスできます。この値は AdType 列挙型で返されます。

リソース名

各リソースは、リソースとその親をパスに連結した resource_name 文字列によって一意に識別されます。

たとえば、キャンペーンのリソース名の形式は次のようになります。

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

検索広告 360 アカウント（お客様 ID 1234567）の ID が 987654 のキャンペーンに、resource_name が設定されています。

customers/1234567/campaigns/987654

サービス

サービスを使用すると、検索広告 360 のエンティティとメタデータを取得できます。サービスには次の 3 つのタイプがあります。

検索サービス
SearchAds360Service は、すべてのリソース オブジェクトとパフォーマンス統計情報を取得するための単一の統合サービスです。これには、Search と SearchStream の 2 つのメソッドがあります。どちらの方法でも、クエリするリソース、取得するリソース属性とパフォーマンス指標、リクエストのフィルタリングに使用する述語、パフォーマンス統計情報をさらに分類するために使用するセグメントを指定するクエリが必要です。詳しくは、検索レポートを作成すると検索広告 360 のクエリ言語をご覧ください。
フィールド サービス
SearchAds360FieldService は、リソースに関するメタデータ（リソースとそのデータ型で使用可能な属性など）を取得します。SearchAds360Service 検索メソッドで使用可能なリソース、リソース フィールド、セグメンテーション キー、指標のカタログをリクエストできます。詳細については、リソース メタデータを取得するをご覧ください。
エンティティ固有のサービス

これらのサービスは、単一のリソース インスタンスを取得する GET リクエスト メソッドを備えています。これは、リソースの構造を調べるのに役立ちます。

エンティティ固有のサービスの例: