Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 25 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,40 @@
# Data Manager API utility library and samples for Java

[![Maven Central](https://img.shields.io/maven-central/v/com.google.api-ads/data-manager-util.svg)](https://central.sonatype.com/artifact/com.google.api-ads/data-manager-util)

Utility library and code samples for working with the
[Data Manager API](https://developers.google.com/data-manager/api) and Java.

## Setup instructions

https://developers.google.com/data-manager/api/get-started/set-up-access#java

## Add dependencies to your project

To use the utility library in your Java project, add the following dependency:
## Requirements

### Gradle
- Java 8+

```groovy
implementation 'com.google.api-ads:data-manager-util:0.4.0'
```
## Setup instructions

### Maven
The `com.google.api-ads:data-manager-util` utility library is published to
[Maven Central](https://central.sonatype.com/artifact/com.google.api-ads/data-manager-util).

```xml
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>data-manager-util</artifactId>
<version>0.4.0</version>
</dependency>
```
For complete instructions on setting up API access and installing the client and
utility libraries in your Maven or Gradle project, see the
[Set up API access](https://developers.google.com/data-manager/api/devguides/quickstart/set-up-access)
and
[Install a client library](https://developers.google.com/data-manager/api/devguides/quickstart/install-library#java)
guides.

## Repository structure

- [`data-manager-util`](data-manager-util): Source code for the utility library.

Follow the setup instructions to declare a dependency on the current version
of `com.google.api-ads:data-manager-util` in your project. Use the utilities
in the library to help with common tasks like formatting, hashing, encrypting,
- [`data-manager-util`](data-manager-util): Source code and tests for the
`com.google.api-ads:data-manager-util` Maven artifact. Use the utilities in
the library to help with common tasks like formatting, hashing, encrypting,
and encoding data for Data Manager API requests.

- [`data-manager-samples`](data-manager-samples): Code samples for working with
the Data Manager API and the utility library.

The `data-manager-samples` project demonstrates how to set up a project that
depends on the Data Manager API client library and the `data-manager-util`
library. Check out the
- [`data-manager-samples`](data-manager-samples): Code samples demonstrating how
to construct and send requests to the Data Manager API using the
[`com.google.api-ads:data-manager`](https://central.sonatype.com/artifact/com.google.api-ads/data-manager)
client library and the `com.google.api-ads:data-manager-util` utility library.
Check out the
[samples](data-manager-samples/src/main/java/com/google/ads/datamanager/samples/)
directory for code samples that construct and send requests to the Data Manager
API.
directory for runnable examples.

## Run samples

Expand All @@ -54,7 +44,7 @@ line. The first argument should be the simple class name of the sample, such as

You can pass arguments to a sample in one of two ways:

### 1. Explicitly, on the command line
### 1. Explicitly, on the command line

```shell
./gradlew run --args="IngestEvents
Expand All @@ -66,7 +56,7 @@ You can pass arguments to a sample in one of two ways:

Quote any argument that contains a space.

### 2. Using an arguments file
### 2. Using an arguments file

You can also save arguments in a file. Don't quote argument values in your
arguments file, even if the value contains a space.
Expand Down Expand Up @@ -112,3 +102,4 @@ Contributions welcome! See the [Contributing Guide](CONTRIBUTING.md).
## Authors

- [Josh Radcliff](https://github.com/jradcliff)
- [Lindsey Volta](https://github.com/lindsey-volta)
Loading