検索広告 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

お客様 ID が 1234567 の検索広告 360 アカウントの ID が 987654 のキャンペーンの resource_name は次のとおりです。

customers/1234567/campaigns/987654

サービス

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

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

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

エンティティ固有のサービスには、次のものがあります。