リソース名

名前階層

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

API 全体を通して、Google 広告のエンティティ(顧客、キャンペーンなど)はリソース名で参照されます。ただし、リソース名自体には、階層内の各オブジェクトを識別する一意の数値リソース 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 のほとんどのオブジェクトは、Google 広告の特定の 1 人のユーザーに関連付けられています。ただし、複数のアカウントで共有できるオブジェクト タイプもあります。実際には、除外キーワード リストクロスアカウント コンバージョン アクションなどがこれに該当します。通常は管理者が作成し、多くのクライアント アカウントと共有します。

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

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

たとえば、クライアント センター(MCC)アカウント 987-654-3210 が、クライアント アカウントの 1 つ(123-456-7890)とクロスアカウント コンバージョン アクションを共有しているとします。

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

たとえば、コンバージョン アクションのルックバック ウィンドウを更新するために MCC アカウントに対して API 呼び出しを行うと、リソース名 customers/9876543210/conversionActions/257733534 を使用して共有オブジェクトが参照されます。

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

これは基礎となるコンバージョン アクションと同じですが、リソース名はアクセスに使用するアカウントに関連する名前になります。