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

このページは、リソース指向設計リソース名のデベロッパー ガイドに精通していることを前提としています。また、Search Ads 360 Reporting API の実装の詳細についても説明します。

リソース指向の設計

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

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

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

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

Search Ads 360 Reporting API では、listget などの標準 REST メソッドを使用する従来の REST API とは異なり、カスタム メソッドを多用しています。Search Ads 360 Reporting API には、searchsearchStream の 2 つのカスタム メソッドが含まれています。

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