リソース名

名前の階層

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

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

リソース ID

Google 広告のエンティティ(お客様、キャンペーンなど)は、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)を参照する新しいリソース名を導出できます。

共有オブジェクトの識別子

API のほとんどのオブジェクトは、特定の 1 人の Google 広告のお客様に関連付けられています。ただし、複数のアカウント間で共有できるオブジェクト タイプもあります。具体的には、除外キーワード リストクロスアカウント コンバージョン アクションなどです。通常、これらの項目は MCC アカウントで作成され、多くのクライアント アカウントと共有されます。

このようなオブジェクトのリソース名は、API 呼び出しを送信するアカウントによって異なります。

例: クロスアカウント コンバージョン アクション

クライアント アカウント 123-456-7890 とクロスアカウント コンバージョン アクションを共有している MCC アカウント 987-654-3210 があるとします。

リソース名とアカウント階層の関係を示す図。

コンバージョン アクションのルックバック ウィンドウを更新するなど、マネージャー アカウントに対して API 呼び出しを行う場合は、リソース名 customers/9876543210/conversionActions/257733534 を使用して共有オブジェクトを参照します。

クライアント アカウントに対して API 呼び出しを行い、共有コンバージョン アクションの使用を有効にする場合、リソース名 customers/1234567890/conversionActions/257733534 を使用して参照します。

これは基盤となるコンバージョン アクションと同じですが、リソース名はアクセスに使用したアカウントを基準としています。