このページでは、リソース指向 の設計とリソース 名のデベロッパー ガイドを理解していることを前提として、 Google Ads API の具体的な実装の詳細について説明します。
リソース指向の設計
一般に、Google Ads API はリソース指向の設計に従い、 個別にアドレス指定可能なリソース（API の名詞）のコレクションとしてモデル化されます。 リソースはそのリソース名で参照され、少数の メソッド（動詞やオペレーションとも呼ばれる）によって操作されます。 これらのリソース名とメソッドは、特定のAPI バージョン プレフィックスと組み合わせて、REST インターフェースの URL を構成します。たとえば、次の表に示すように、この URL の例は個々のコンポーネントに分解できます。
https://googleads.googleapis.com/v24/customers/1234567890:mutate
| API バージョン プレフィックス | リソース名（相対） | メソッド |
|---|---|---|
https://googleads.googleapis.com/v24
|
customers/1234567890
|
mutate
|
特定のバージョンの API（v24 など）のすべての REST URL は、共通の API バージョン プレフィックスを共有します。リソース名とメソッドを組み合わせることで、呼び出される API サービスを特定できます。
Google Ads API では、list、get、
create、update、delete などの標準の REST メソッドを使用するほとんどの
REST API とは異なり、カスタム メソッドが多用されています。Google Ads API のカスタム メソッドの例としては、search、searchStream、mutate などがあります。
以降のページでは、Google Ads API のリソース 名、サービス メソッド、 JSON の命名規則について詳しく説明し、それらを組み合わせて REST インターフェース エンドポイントを定義する方法を示します。
エラーの管理
発生したエラーの分析とデバッグの方法については、API エラーについてを ご覧ください。
ディスカバリ ドキュメント
Google Ads API で使用可能なメソッドの検出を容易かつ自動化するために、各バージョン用に公開されているディスカバリ ドキュメントを使用できます。
これは
https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>で入手できます。
たとえば、これは Google Ads API の最新バージョンの
ディスカバリ ドキュメント
です。