Building the client library for Java from source

  • The Google Ads client library is best used through Maven, with binary distributions also available.

  • Building the library requires JDK 1.8 or later and is accomplished using the included Gradle wrapper.

  • After building, the library can be exported to a local Maven repository for use in other projects.

  • The library is built from the google-ads-java Github repository and can be used in Maven or Gradle projects.

We recommend using the client library through Maven. We also provide binary distributions on our releases page and through the Maven central repository (see our quick start guide for details). However, you can build the library yourself using the following build process described.

The client library is built with Gradle. Dependencies are downloaded from the Maven Central repository.

Install Java development kit

JDK 1.8 or later is required to build the library. We'll assume that Java is installed on your machine for the purposes of this guide.

Build with Gradle

We recommend using the included Gradle wrapper. See gradle/wrapper/gradle-wrapper.properties for the current version. You do not need a separate Gradle installation.

Build the library

  1. Clone this project in the directory of your choice. The .git suffix in the URL is optional.

    git clone https://github.com/googleads/google-ads-java.git
    
  2. Navigate to the google-ads-java directory.

    cd google-ads-java
    
  3. Run the following command to build the snapshot version of the library and examples project.

    ./gradlew build
    
  4. Export the client library to a local Maven repository.

    ./gradlew publishToMavenLocal
    

Use the client library in a local Maven repository

After a successful build and export, the artifacts for the client library are available to Maven/Gradle from the local repository (typically ~/.m2/repository/com/google/api-ads/google-ads/). Add a dependency on the SNAPSHOT version that was just built to any subsequent project build files. The version is defined in gradle.properties.