名前の階層
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 Ads エンティティ（顧客、キャンペーンなど）は、API 全体でリソース名で参照されます。ただし、リソース名自体に、階層内の各オブジェクトを識別する一意の数値のリソース ID が含まれている場合があることに注意してください。このような場合は、リソース名を解析してこれらのリソース ID を抽出し、新しいリソース ID を組み立てると便利です。
たとえば、前の表の AdGroupAd リソース名を調べます。
customers/1234567890/adGroupAds/54321098765~2109876543210
これは、次のように個々のリソース ID（コレクション ID で区切られたもの）に分割できます。
| リソース名のコンポーネント | |||||||
|---|---|---|---|---|---|---|---|
| リソース ID |
|
||||||
| コレクション ID |
|
||||||
個々の ID を解析すると、広告グループ広告の顧客（customers/1234567890）または広告グループ（customers/1234567890/adGroupAds/54321098765）を参照する新しいリソース名を取得できます。
共有オブジェクトの識別子
API のほとんどのオブジェクトは、特定の 1 つの Google 広告クライアントに関連付けられています。ただし、複数のアカウント間で共有できるオブジェクト タイプもあります。実際には、通常は管理者が作成し、多くのクライアント アカウントと共有する除外キーワード リストやアカウント横断コンバージョン アクションなどがこれに該当します。
このようなオブジェクトのリソース名は、API 呼び出しを送信するアカウントによって異なります。
例: クロスアカウント コンバージョン アクション
MCC アカウント 987-654-3210 が、クライアント カスタマー アカウント 123-456-7890 の 1 つとクロス アカウント コンバージョン アクションを共有しているとします。
たとえば、コンバージョン アクションのルックバック ウィンドウを更新するためにクライアント センター アカウントに API 呼び出しを行う場合、リソース名 customers/9876543210/conversionActions/257733534 を使用して共有オブジェクトを参照します。
共有コンバージョン アクションの使用を有効にするためにクライアント アカウントに API 呼び出しを行う場合は、リソース名 customers/1234567890/conversionActions/257733534 を使用して参照します。
これは同じ基盤となるコンバージョン アクションですが、リソース名はアクセスに使用されるアカウントに関連しています。