Skip to content
This repository was archived by the owner on Sep 9, 2023. It is now read-only.

Commit 163d3db

Browse files
chore(docs): add Authorization section to Java README template (#1161) (#247)
as a part of the PR 582 for java-logging an authorization section is added to the Java README template. Fixing googleapis/java-logging#570. Source-Link: googleapis/synthtool@3d32990 Post-Processor: gcr.io/repo-automation-bots/owlbot-java:latest@sha256:2904b9ad921ecc1343d1cf815bfaafbcc1115c1f39593aef9f8e333ffda552f7
1 parent d22e529 commit 163d3db

2 files changed

Lines changed: 14 additions & 1 deletion

File tree

.github/.OwlBot.lock.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
docker:
22
image: gcr.io/repo-automation-bots/owlbot-java:latest
3-
digest: sha256:8aaf4b4336ac8ca344681866b3a78f73be5999750179022393ecbedd7069acb5
3+
digest: sha256:2904b9ad921ecc1343d1cf815bfaafbcc1115c1f39593aef9f8e333ffda552f7

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ Java idiomatic client for [Analytics Admin][product-docs].
1111
> Note: This client is a work-in-progress, and may occasionally
1212
> make backwards-incompatible changes.
1313
14+
1415
## Quickstart
1516

1617

1718
If you are using Maven, add this to your pom.xml file:
1819

20+
1921
```xml
2022
<dependency>
2123
<groupId>com.google.analytics</groupId>
@@ -25,11 +27,13 @@ If you are using Maven, add this to your pom.xml file:
2527
```
2628

2729
If you are using Gradle without BOM, add this to your dependencies
30+
2831
```Groovy
2932
compile 'com.google.analytics:google-analytics-admin:0.4.0'
3033
```
3134

3235
If you are using SBT, add this to your dependencies
36+
3337
```Scala
3438
libraryDependencies += "com.google.analytics" % "google-analytics-admin" % "0.4.0"
3539
```
@@ -38,6 +42,10 @@ libraryDependencies += "com.google.analytics" % "google-analytics-admin" % "0.4.
3842

3943
See the [Authentication][authentication] section in the base directory's README.
4044

45+
## Authorization
46+
47+
The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Analytics Admin APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Analytics Admin API calls.
48+
4149
## Getting Started
4250

4351
### Prerequisites
@@ -136,6 +144,7 @@ This library follows [Semantic Versioning](http://semver.org/).
136144
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
137145
and the public API should not be considered stable.
138146

147+
139148
## Contributing
140149

141150

@@ -147,6 +156,7 @@ Please note that this project is released with a Contributor Code of Conduct. By
147156
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
148157
information.
149158

159+
150160
## License
151161

152162
Apache 2.0 - See [LICENSE][license] for more information.
@@ -179,6 +189,9 @@ Java is a registered trademark of Oracle and/or its affiliates.
179189
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.analytics/google-analytics-admin.svg
180190
[maven-version-link]: https://search.maven.org/search?q=g:com.google.analytics%20AND%20a:google-analytics-admin&core=gav
181191
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
192+
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
193+
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
194+
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
182195
[developer-console]: https://console.developers.google.com/
183196
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
184197
[cloud-sdk]: https://cloud.google.com/sdk/

0 commit comments

Comments
 (0)