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

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

リソース指向の設計

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

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

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

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

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

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