リソース名

名前の階層

検索広告 360 レポート API で使用されるリソース名は階層構造になっており、検索広告 360 内のエンティティの構成を反映しています。ほとんどのリソースは Customer リソースのサブリソースです。これは、ほぼすべての API 呼び出しが特定の検索広告 360 アカウントをターゲットにする必要があるという事実を反映しています。たとえば、キャンペーン、広告グループ、広告、キーワードはすべてルート顧客リソースのサブリソースです。

リソース リソース名
お客様 customers/1234567890
キャンペーン customers/1234567890/campaigns/8765432109
AdGroup customers/1234567890/adGroups/54321098765
AdGroupAd customers/1234567890/adGroupAds/54321098765~2109876543210

リソース ID

検索広告 360 Reporting API エンティティ(顧客、キャンペーンなど)は、API 全体でリソース名で参照されます。ただし、リソース名自体に、階層内の各オブジェクトを識別する一意の数値のリソース ID が含まれている場合があることに注意してください。このような場合は、リソース名を解析してこれらのリソース ID を抽出し、新しいリソース ID を組み立てると便利です。

たとえば、前の表の AdGroupAd リソース名を調べます。

customers/1234567890/adGroupAds/54321098765~2109876543210

これは、次のように個々のリソース ID(コレクション ID で区切られたもの)に分割できます。

リソース名のコンポーネント
リソース ID
お客様 ID:
"1234567890"
広告グループ ID:
"54321098765"
広告グループ広告 ID:
"2109876543210"
コレクション ID
"customers"
"adGroupAds"

個々の ID を解析すると、広告グループ広告の顧客(customers/1234567890)または広告グループ(customers/1234567890/adGroupAds/54321098765)を参照する新しいリソース名を取得できます。