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

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

キーポイント: このガイドの例では、HTTP プロトコルを使用して API を呼び出す方法を示しています。curl コマンドライン ユーティリティを使用して、これらの 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 では、list や get などの標準 REST メソッドを使用する従来の REST API とは異なり、カスタム メソッドを多用しています。Search Ads 360 Reporting API には、search と searchStream の 2 つのカスタム メソッドが含まれています。

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