This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.
Google Ad Manager API client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG.
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Google Ad Manager API API.
- Set up authentication so you can access the API from your local workstation.
npm install @google-ads/admanagerSamples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| create ad break | source code |
| delete ad break | source code |
| get ad break | source code |
| list ad breaks | source code |
| update ad break | source code |
| batch allow ad review center ads | source code |
| batch block ad review center ads | source code |
| search ad review center ads | source code |
| batch activate ad units | source code |
| batch archive ad units | source code |
| batch create ad units | source code |
| batch deactivate ad units | source code |
| batch update ad units | source code |
| create ad unit | source code |
| get ad unit | source code |
| list ad unit sizes | source code |
| list ad units | source code |
| update ad unit | source code |
| get application | source code |
| list applications | source code |
| get audience segment | source code |
| list audience segments | source code |
| get bandwidth group | source code |
| list bandwidth groups | source code |
| get browser language | source code |
| list browser languages | source code |
| get browser | source code |
| list browsers | source code |
| get cms metadata key | source code |
| list cms metadata keys | source code |
| get cms metadata value | source code |
| list cms metadata values | source code |
| get company | source code |
| list companies | source code |
| batch create contacts | source code |
| batch update contacts | source code |
| create contact | source code |
| get contact | source code |
| list contacts | source code |
| update contact | source code |
| get content bundle | source code |
| list content bundles | source code |
| get content label | source code |
| list content labels | source code |
| get content | source code |
| list content | source code |
| get creative template | source code |
| list creative templates | source code |
| batch activate custom fields | source code |
| batch create custom fields | source code |
| batch deactivate custom fields | source code |
| batch update custom fields | source code |
| create custom field | source code |
| get custom field | source code |
| list custom fields | source code |
| update custom field | source code |
| batch activate custom targeting keys | source code |
| batch create custom targeting keys | source code |
| batch deactivate custom targeting keys | source code |
| batch update custom targeting keys | source code |
| create custom targeting key | source code |
| get custom targeting key | source code |
| list custom targeting keys | source code |
| update custom targeting key | source code |
| get custom targeting value | source code |
| list custom targeting values | source code |
| get device capability | source code |
| list device capabilities | source code |
| get device category | source code |
| list device categories | source code |
| get device manufacturer | source code |
| list device manufacturers | source code |
| batch create entity signals mappings | source code |
| batch update entity signals mappings | source code |
| create entity signals mapping | source code |
| get entity signals mapping | source code |
| list entity signals mappings | source code |
| update entity signals mapping | source code |
| get geo target | source code |
| list geo targets | source code |
| get line item | source code |
| list line items | source code |
| get mobile carrier | source code |
| list mobile carriers | source code |
| get mobile device | source code |
| list mobile devices | source code |
| get mobile device submodel | source code |
| list mobile device submodels | source code |
| get network | source code |
| list networks | source code |
| get operating system | source code |
| list operating systems | source code |
| get operating system version | source code |
| list operating system versions | source code |
| get order | source code |
| list orders | source code |
| batch activate placements | source code |
| batch archive placements | source code |
| batch create placements | source code |
| batch deactivate placements | source code |
| batch update placements | source code |
| create placement | source code |
| get placement | source code |
| list placements | source code |
| update placement | source code |
| create private auction deal | source code |
| get private auction deal | source code |
| list private auction deals | source code |
| update private auction deal | source code |
| create private auction | source code |
| get private auction | source code |
| list private auctions | source code |
| update private auction | source code |
| get programmatic buyer | source code |
| list programmatic buyers | source code |
| create report | source code |
| fetch report result rows | source code |
| get report | source code |
| list reports | source code |
| run report | source code |
| update report | source code |
| get role | source code |
| list roles | source code |
| batch create sites | source code |
| batch deactivate sites | source code |
| batch submit sites for approval | source code |
| batch update sites | source code |
| create site | source code |
| get site | source code |
| list sites | source code |
| update site | source code |
| ads | source code |
| get taxonomy category | source code |
| list taxonomy categories | source code |
| batch activate teams | source code |
| batch create teams | source code |
| batch deactivate teams | source code |
| batch update teams | source code |
| create team | source code |
| get team | source code |
| list teams | source code |
| update team | source code |
| get user | source code |
Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:
- Legacy versions are not tested in continuous integration.
- Some security patches and features cannot be backported.
- Dependencies cannot be kept up-to-date.
Client libraries targeting some end-of-life versions of Node.js are available, and
can be installed through npm dist-tags.
The dist-tags follow the naming convention legacy-(version).
For example, npm install @google-ads/admanager@legacy-8 installs client libraries
for versions compatible with Node.js 8.
This library follows Semantic Versioning.
More Information: Google Cloud Platform Launch Stages
Contributions welcome! See the Contributing Guide.
Please note that this README.md
and a variety of configuration files in this repository (including .nycrc and tsconfig.json)
are generated from a central template.
Apache Version 2.0
See LICENSE