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 では、カスタム メソッドを多用します。一方、従来の REST API のほとんどは、listget などの標準の REST メソッドを使用しています。Search Ads 360 Reporting API には、searchsearchStream の 2 つのカスタム メソッドが含まれています。

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