Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

リソース名

名前の階層

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

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

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

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

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

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

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

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

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