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

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

リソース指向の設計

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

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

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

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

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

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