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

このページでは、リソース指向設計リソース名のデベロッパー ガイドを理解していることを前提として、Google Ads API の具体的な実装の詳細について補足します。

リソース指向の設計

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

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

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

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

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

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