このページは、リソース指向設計とリソース名のデベロッパー ガイドを理解していることを前提としており、Google Ads API の具体的な実装の詳細を補足しています。
リソース指向の設計
一般に、Google Ads API はリソース指向の設計に従っており、個別にアドレス指定可能なリソース（API の名詞）のコレクションとしてモデル化されています。リソースはリソース名で参照され、少数のメソッド（動詞またはオペレーションとも呼ばれます）を使用して操作されます。これらのリソース名とメソッドを、特定の API バージョン接頭辞と組み合わせることで、REST インターフェースの URL が構成されます。たとえば、次の表に示すように、この URL の例は個々のコンポーネントに分割できます。
https://googleads.googleapis.com/v26/customers/1234567890:mutate
| API バージョンの接頭辞 | リソース名（相対） | メソッド |
|---|---|---|
https://googleads.googleapis.com/v26
|
customers/1234567890
|
mutate
|
特定のバージョンの API（v26 など）のすべての 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 の最新バージョンのディスカバリ ドキュメントです。
ディスカバリ ドキュメントには、Google Ads API で使用されるすべてのサービス、メソッド、リソース、エンティティに関する情報が、リファレンス ドキュメントと同様に、機械で読み取り可能な JSON 形式で含まれています。