検索広告 360 Reporting API の構造

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

オブジェクト階層

検索広告 360 アカウントはオブジェクトの階層です。

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

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

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

• 各 AdGroup には、1 つ以上の広告グループ広告が含まれています。

• 1 つ以上の AdGroupCriterion または CampaignCriterion を広告グループまたはキャンペーンに適用できます。条件は、広告がトリガーされる方法を定義します。

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

リソース

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

オブジェクト ID

検索広告 360 のすべてのオブジェクトは、独自の ID で識別されます。ID には、すべての検索広告 360 アカウントで一意の 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 つのメソッドが用意されています。どちらの方法でも、クエリするリソース、取得するリソース属性とパフォーマンス指標、リクエストのフィルタリングに使用する述語、パフォーマンス統計情報をさらに細分化するために使用するセグメントを指定するクエリが必要です。詳しくは、検索レポートを作成すると Search Ads 360 クエリ言語をご覧ください。

フィールド サービス

SearchAds360FieldService は、リソースで使用可能な属性やそのデータ型など、リソースに関するメタデータを取得します。SearchAds360Service 検索メソッドで使用可能なリソース、リソース フィールド、セグメンテーション キー、指標のカタログをリクエストできます。詳細については、リソース メタデータを取得するをご覧ください。

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

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

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

• リクエストされたカスタム列の詳細を返す CustomColumnService。