REST インターフェースの設計

このページは、リソース指向設計リソース名のデベロッパー ガイドを理解していることを前提としています。また、Google 広告 API の実装に関する詳細な説明も提供しています。

リソース指向の設計

通常、Google Ads API はリソース指向の設計に従い、個別にアドレス指定可能なリソース(API の名詞)のコレクションとしてモデル化されます。リソースはリソース名で参照され、少数のメソッド(動詞やオペレーションとも呼ばれる)を使用して操作されます。

これらのリソース名メソッドを特定の API バージョン プレフィックスと組み合わせて、REST インターフェースの URL を構成します。たとえば、次の URL は次の表に従って個々のコンポーネントに分割できます。

https://googleads.googleapis.com/v18/customers/1234567890:mutate
API バージョンの接頭辞 リソース名(相対) メソッド
https://googleads.googleapis.com/v18 customers/1234567890 mutate

特定のバージョンの API のすべての REST URL(v18)は、共通の API バージョン接頭辞を共有します。リソース名とメソッドを組み合わせることで、呼び出される API サービスが特定されます。

Google Ads API は、listgetcreateupdatedelete などの標準 REST メソッドを使用する従来の REST API とは異なり、カスタム メソッドを多用します。Google Ads API のカスタム メソッドの例には、searchsearchStreammutate などがあります。

以降のページでは、Google Ads API のリソース名サービス メソッドJSON 命名規則について詳しく説明します。また、これらを組み合わせて REST インターフェース エンドポイントを定義する方法についても説明します。