diff --git a/README.md b/README.md index 3a88123..9976f94 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,48 @@ # Data Manager API utility library and samples for Node.js +[![npm version](https://img.shields.io/npm/v/@google-ads/datamanager-util.svg)](https://www.npmjs.com/package/@google-ads/datamanager-util) + Utility library and code samples for working with the [Data Manager API](https://developers.google.com/data-manager/api) and Node.js. +## Requirements + +- Node.js 22+ + ## Setup instructions -https://developers.google.com/data-manager/api/devguides/quickstart/install-library#node.js +The `@google-ads/datamanager-util` utility library is published to +[npm](https://www.npmjs.com/package/@google-ads/datamanager-util). Install it +using `npm`: -## Repository structure +```shell +npm install @google-ads/datamanager-util +``` -- [`util`](util): Source code for the utility library (`@google-ads/datamanager-util`). +For complete instructions on setting up API access and installing the client and +utility libraries, 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#node.js) +guides. - Follow the setup instructions to declare a dependency on the current version - of the utility library in your project. Use the utilities in the library to - help with common tasks like formatting, hashing, encrypting, and encoding - data for Data Manager API requests. +## Repository structure -- [`samples`](samples): Code samples for working with - the Data Manager API and the utility library. +- [`util`](util): Source code and tests for the `@google-ads/datamanager-util` + npm package. Use the utilities in the library to help with common tasks like + formatting, hashing, and encoding data for Data Manager API requests. - This project demonstrates how to set up a project that - depends on the Data Manager API client library and the `@google-ads/datamanager-util` - library. +- [`samples`](samples): Code samples demonstrating how to construct and send + requests to the Data Manager API using the + [`@google-ads/datamanager`](https://www.npmjs.com/package/@google-ads/datamanager) + client library and the `@google-ads/datamanager-util` utility library. ## Run samples To run a sample, invoke the script using the command line. You can pass arguments to the script in one of two ways: -### 1. Explicitly, on the command line +### 1. Explicitly, on the command line ```shell npm run ingest-events -w samples \ @@ -38,7 +52,7 @@ npm run ingest-events -w samples \ --json_file='' ``` -### 2. Using an arguments file +### 2. Using an arguments file You can also save arguments in a file. @@ -70,3 +84,4 @@ Contributions welcome! See the [Contributing Guide](CONTRIBUTING.md). ## Authors - [Josh Radcliff](https://github.com/jradcliff) +- [Lindsey Volta](https://github.com/lindsey-volta) diff --git a/util/README.md b/util/README.md index b5de03c..fdb98e2 100644 --- a/util/README.md +++ b/util/README.md @@ -12,6 +12,9 @@ addresses) to meet Data Manager API ingestion requirements. ## Installation +The `@google-ads/datamanager-util` package is published to +[npm](https://www.npmjs.com/package/@google-ads/datamanager-util): + ```shell npm install @google-ads/datamanager-util ``` @@ -25,7 +28,8 @@ with the `@google-ads/datamanager` client library, see the ## Documentation & Resources - [Google Data Manager API Documentation](https://developers.google.com/data-manager/api) -- [Node.js Quickstart Guide](https://developers.google.com/data-manager/api/devguides/quickstart/install-library#node.js) +- [Set up API access](https://developers.google.com/data-manager/api/devguides/quickstart/set-up-access) +- [Install a client library](https://developers.google.com/data-manager/api/devguides/quickstart/install-library#node.js) - [GitHub Repository](https://github.com/googleads/data-manager-node) - [Issue Tracker](https://github.com/googleads/data-manager-node/issues)