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 では、カスタム メソッドがよく使用されますが、 標準の REST メソッドを使用する従来の REST API(listgetcreateupdatedelete。Google Ads API のカスタム メソッドの例 searchsearchStreammutate などがあります。

以降のページでは、Google Ads API のリソース サービス メソッド、 使用方法を示す JSON 命名規則 REST インターフェース エンドポイントを定義します。