@google-analytics/admin
v9.0.1TypeScript
Admin client for Node.js
google apis clientgoogle api clientgoogle apisgoogle apigooglegoogle cloud platformgoogle cloudcloudgoogle adminadmin
20.1K/weekUpdated 3 months agoApache-2.0Unpacked: 14.6 MB
Published by Google LLC
npm install @google-analytics/admin[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
[//]: # "The comments you see below are used to generate those parts of the template in later states."
[Google Analytics Admin API: Nodejs Client][homepage]
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 Analytics Admin API client for Node.js
[//]: # "partials.introduction"
A comprehensive list of changes in each version may be found in
[the CHANGELOG][homepage_changelog].
* Google Analytics Admin API Nodejs Client API Reference
Read more about the client libraries for Cloud APIs, including the older
Google APIs Client Libraries, in [Client Libraries Explained][explained].
[explained]: https://cloud.google.com/apis/docs/client-libraries-explained
Table of contents:
* Quickstart
* Before you begin
* Installing the client library
* Versioning
* Contributing
* License
Quickstart
$3
1. [Select or create a Cloud Platform project][projects].
1. [Enable billing for your project][billing].
1. [Enable the Google Analytics Admin API API][enable_api].
1. [Set up authentication][auth] so you can access the
API from your local workstation.
$3
``bash`
npm install @google-cloud/admin
[//]: # "partials.body"
Samples
Samples are in the [samples/][homepage_samples] directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
| --------------------------- | --------------------------------- |
| acknowledge user data collection | source code |
| approve display video360 advertiser link proposal | source code |
| archive audience | source code |
| archive custom dimension | source code |
| archive custom metric | source code |
| batch create access bindings | source code |
| batch delete access bindings | source code |
| batch get access bindings | source code |
| batch update access bindings | source code |
| cancel display video360 advertiser link proposal | source code |
| create access binding | source code |
| create ad sense link | source code |
| create audience | source code |
| create big query link | source code |
| create calculated metric | source code |
| create channel group | source code |
| create conversion event | source code |
| create custom dimension | source code |
| create custom metric | source code |
| create data stream | source code |
| create display video360 advertiser link | source code |
| create display video360 advertiser link proposal | source code |
| create event create rule | source code |
| create event edit rule | source code |
| create expanded data set | source code |
| create firebase link | source code |
| create google ads link | source code |
| create key event | source code |
| create measurement protocol secret | source code |
| create property | source code |
| create reporting data annotation | source code |
| create rollup property | source code |
| create rollup property source link | source code |
| create s k ad network conversion value schema | source code |
| create search ads360 link | source code |
| create subproperty event filter | source code |
| delete access binding | source code |
| delete account | source code |
| delete ad sense link | source code |
| delete big query link | source code |
| delete calculated metric | source code |
| delete channel group | source code |
| delete conversion event | source code |
| delete data stream | source code |
| delete display video360 advertiser link | source code |
| delete display video360 advertiser link proposal | source code |
| delete event create rule | source code |
| delete event edit rule | source code |
| delete expanded data set | source code |
| delete firebase link | source code |
| delete google ads link | source code |
| delete key event | source code |
| delete measurement protocol secret | source code |
| delete property | source code |
| delete reporting data annotation | source code |
| delete rollup property source link | source code |
| delete s k ad network conversion value schema | source code |
| delete search ads360 link | source code |
| delete subproperty event filter | source code |
| get access binding | source code |
| get account | source code |
| get ad sense link | source code |
| get attribution settings | source code |
| get audience | source code |
| get big query link | source code |
| get calculated metric | source code |
| get channel group | source code |
| get conversion event | source code |
| get custom dimension | source code |
| get custom metric | source code |
| get data redaction settings | source code |
| get data retention settings | source code |
| get data sharing settings | source code |
| get data stream | source code |
| get display video360 advertiser link | source code |
| get display video360 advertiser link proposal | source code |
| get enhanced measurement settings | source code |
| get event create rule | source code |
| get event edit rule | source code |
| get expanded data set | source code |
| get global site tag | source code |
| get google signals settings | source code |
| get key event | source code |
| get measurement protocol secret | source code |
| get property | source code |
| get reporting data annotation | source code |
| get reporting identity settings | source code |
| get rollup property source link | source code |
| get s k ad network conversion value schema | source code |
| get search ads360 link | source code |
| get subproperty event filter | source code |
| get subproperty sync config | source code |
| list access bindings | source code |
| list account summaries | source code |
| list accounts | source code |
| list ad sense links | source code |
| list audiences | source code |
| list big query links | source code |
| list calculated metrics | source code |
| list channel groups | source code |
| list conversion events | source code |
| list custom dimensions | source code |
| list custom metrics | source code |
| list data streams | source code |
| list display video360 advertiser link proposals | source code |
| list display video360 advertiser links | source code |
| list event create rules | source code |
| list event edit rules | source code |
| list expanded data sets | source code |
| list firebase links | source code |
| list google ads links | source code |
| list key events | source code |
| list measurement protocol secrets | source code |
| list properties | source code |
| list reporting data annotations | source code |
| list rollup property source links | source code |
| list s k ad network conversion value schemas | source code |
| list search ads360 links | source code |
| list subproperty event filters | source code |
| list subproperty sync configs | source code |
| provision account ticket | source code |
| provision subproperty | source code |
| reorder event edit rules | source code |
| run access report | source code |
| search change history events | source code |
| submit user deletion | source code |
| update access binding | source code |
| update account | source code |
| update attribution settings | source code |
| update audience | source code |
| update big query link | source code |
| update calculated metric | source code |
| update channel group | source code |
| update conversion event | source code |
| update custom dimension | source code |
| update custom metric | source code |
| update data redaction settings | source code |
| update data retention settings | source code |
| update data stream | source code |
| update display video360 advertiser link | source code |
| update enhanced measurement settings | source code |
| update event create rule | source code |
| update event edit rule | source code |
| update expanded data set | source code |
| update google ads link | source code |
| update google signals settings | source code |
| update key event | source code |
| update measurement protocol secret | source code |
| update property | source code |
| update reporting data annotation | source code |
| update s k ad network conversion value schema | source code |
| update search ads360 link | source code |
| update subproperty event filter | source code |
| update subproperty sync config | source code |
| analytics | source code |
| acknowledge user data collection | source code |
| archive custom dimension | source code |
| archive custom metric | source code |
| create conversion event | source code |
| create custom dimension | source code |
| create custom metric | source code |
| create data stream | source code |
| create firebase link | source code |
| create google ads link | source code |
| create key event | source code |
| create measurement protocol secret | source code |
| create property | source code |
| delete account | source code |
| delete conversion event | source code |
| delete data stream | source code |
| delete firebase link | source code |
| delete google ads link | source code |
| delete key event | source code |
| delete measurement protocol secret | source code |
| delete property | source code |
| get account | source code |
| get conversion event | source code |
| get custom dimension | source code |
| get custom metric | source code |
| get data retention settings | source code |
| get data sharing settings | source code |
| get data stream | source code |
| get key event | source code |
| get measurement protocol secret | source code |
| get property | source code |
| list account summaries | source code |
| list accounts | source code |
| list conversion events | source code |
| list custom dimensions | source code |
| list custom metrics | source code |
| list data streams | source code |
| list firebase links | source code |
| list google ads links | source code |
| list key events | source code |
| list measurement protocol secrets | source code |
| list properties | source code |
| provision account ticket | source code |
| run access report | source code |
| search change history events | source code |
| update account | source code |
| update conversion event | source code |
| update custom dimension | source code |
| update custom metric | source code |
| update data retention settings | source code |
| update data stream | source code |
| update google ads link | source code |
| update key event | source code |
| update measurement protocol secret | source code |
| update property | source code |
| analytics | source code |
Supported Node.js Versions
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).npm install @google-cloud/admin@legacy-8
For example, installs client libraries
for versions compatible with Node.js 8.
Versioning
This library follows Semantic Versioning.
More Information: [Google Cloud Platform Launch Stages][launch_stages]
[launch_stages]: https://cloud.google.com/terms/launch-stages
Contributing
Contributions welcome! See the Contributing Guide.
Please note that this README.md
and a variety of configuration files in this repository (including and tsconfig.json`)
are generated from a central template.
License
Apache Version 2.0
See LICENSE
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=analyticsadmin.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-admin/samples
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-admin/CHANGELOG.md
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-analytics-admin