リソース名

名前の階層

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

リソース リソース名
お客様 customers/1234567890
キャンペーン customers/1234567890/campaigns/8765432109
広告グループ customers/1234567890/adGroups/54321098765
広告グループ広告 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 のほとんどのオブジェクトは、Google 広告の特定の 1 人のユーザーに関連付けられています。ただし、複数のアカウントで共有できるオブジェクト タイプもあります。実際には、除外キーワード リストやクロスアカウント コンバージョン アクションなどが通常はマネージャーによって作成され、多くのクライアント アカウントと共有されます。

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

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

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

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

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

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

これは、基礎となるコンバージョン アクションと同じですが、リソース名は、アクセスに使用されるアカウントに相対するものです。

前へ
概要
次へ
サービス メソッド