REST Interface Design

  • The Search Ads 360 Reporting API uses a resource-oriented design, where data is organized into collections of resources that can be accessed and manipulated.

  • The API primarily uses custom methods like search and searchStream instead of traditional REST methods.

  • API endpoints are constructed using an API version prefix, resource name, and method, which are detailed further in linked documentation.

  • The guide's examples demonstrate API calls using HTTP, with further instructions available for using the curl command-line utility.

  • Developers should be familiar with Resource Oriented Design and Resource Names before using this API.

This page assumes a familiarity with the Resource Oriented Design and Resource Names developer guides and complements them with specific implementation details of the Search Ads 360 Reporting API.

Resource-oriented design

Generally, the Search Ads 360 Reporting API follows a resource-oriented design, modeled as collections of individually-addressable resources (the nouns of the API). Resources are referenced with their resource names and manipulated using a small set of methods (also known as verbs or operations).

These resource names and methods, combined with a specific API version prefix, comprise the URLs of the REST interface. For example, the URL below can be broken down into these individual components according to the following table:

https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
API Version Prefix Resource Name (relative) Method
https://searchads360.googleapis.com/v0 customers/1234567890 search

All REST URLs for a particular version of the API (e.g., v0) share a common API version prefix. The resource name and method together identifies which API service is being called.

The Search Ads 360 Reporting API makes heavy use of custom methods, as opposed to most traditional REST APIs that use standard REST methods such as list and get. The Search Ads 360 Reporting API includes two custom methods: search and searchStream.

The following pages go into more details about the Search Ads 360 Reporting API's resource names, service methods, and JSON naming conventions to illustrate how they're used together to define REST interface endpoints.