Versioning in the Search Ads 360 Reporting API

The Search Ads 360 Reporting API uses semantic versioning.

There are major and minor versions, formatted as vMAJOR_MINOR. For example, v0_0 is the first major version, and v0_1 the first minor version. The suffix of the version number indicates the version type: for major versions it is always zero, and for minor versions it is always greater than zero.

Major versions

Major releases introduce breaking changes, that is, changes that are not backwards compatible.

Each major version has a separate endpoint, for example:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

When upgrading from one major version to another, you may need to change your code before switching to the new major version endpoint.

If you use a client library, you need to upgrade to the newest version. New major versions provide a migration guide to help you fix any breaking changes in your code.

Examples of breaking changes include:

  • Removing or renaming a service, interface, field, method or enum value.
  • Changing the type of a field.
  • Changing a resource name format.
  • Changing the URL format in the HTTP definition.
  • Changing output formats, such as, changing 0 to -- as the default value.
  • Changing the error reason returned from A to B.

Minor versions

Minor versions introduce only backwards-compatible changes.

When a minor version is released, the endpoint that is already in use is automatically updated. This does not cause your code to break. You can continue to use your existing client library.

Minor versions include new features or updates that do not affect your existing code. If you want to use the new features, you need to upgrade your client library to the latest version.

Sunsets

When an older Search Ads 360 Reporting API version is scheduled to sunset, we post a notice on the searchads-api-announcements Google group.