名前の階層
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 |
|
個々の ID を解析することで、広告グループ広告の顧客(customers/1234567890
)またはその広告グループ(customers/1234567890/adGroupAds/54321098765
)を参照するための新しいリソース名を取得できます。
共有オブジェクトの識別子
API のほとんどのオブジェクトは、Google 広告の 1 人のユーザーに関連付けられています。ただし、一部のオブジェクト タイプは複数のアカウント間で共有できます。具体的には、除外キーワード リストやクロスアカウント コンバージョン アクションなどがこれに該当します。これらは通常、管理者が作成して、多くのクライアント アカウントと共有します。
このようなオブジェクトのリソース名は、API 呼び出しの送信先アカウントによって異なります。
例: クロスアカウント コンバージョン アクション
たとえば、MCC アカウント 987-654-3210
が、いずれかのクライアント顧客アカウント 123-456-7890
とクロスアカウント コンバージョン アクションを共有しているとします。
MCC アカウントに対して API 呼び出しを行い、たとえばコンバージョン アクションのルックバック ウィンドウを更新すると、リソース名 customers/9876543210/conversionActions/257733534
を使用して共有オブジェクトが参照されます。
クライアント アカウントに対して API 呼び出しを行い、共有コンバージョン アクションの使用を有効にするには、リソース名 customers/1234567890/conversionActions/257733534
を使用して参照します。
これは基になるコンバージョン アクションと同じですが、リソース名はアクセスに使用したアカウントに関連する名前になります。