Skip to content

Commit c2d44dc

Browse files
cloud-java-botzhumin8
cloud-java-bot
and
zhumin8
authored
feat: [marketingplatformadminapi] new module for marketingplatformadminapi (#11225)
* feat: [marketingplatformadminapi] new module for marketingplatformadminapi * chore: generate libraries at Mon Oct 7 18:29:58 UTC 2024 * chore: generate libraries at Mon Oct 7 18:35:04 UTC 2024 --------- Co-authored-by: Min Zhu <zhumin@google.com>
1 parent 1c83c78 commit c2d44dc

File tree

80 files changed

+19097
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+19097
-0
lines changed

‎generation_config.yaml

+18
Original file line numberDiff line numberDiff line change
@@ -1352,6 +1352,24 @@ libraries:
13521352
- proto_path: google/maps/solar/v1
13531353
requires_billing: true
13541354
rpc_documentation: https://developers.google.com/maps/documentation/solar/reference/rest
1355+
- api_shortname: marketingplatformadminapi
1356+
name_pretty: Google Marketing Platform Admin API
1357+
product_documentation: https://developers.google.com/analytics/devguides/config/gmp/v1
1358+
api_description: The Google Marketing Platform Admin API allows for programmatic
1359+
access to the Google Marketing Platform configuration data. You can use the Google
1360+
Marketing Platform Admin API to manage links between your Google Marketing Platform
1361+
organization and Google Analytics accounts, and to set the service level of your
1362+
GA4 properties.
1363+
client_documentation: https://cloud.google.com/java/docs/reference/admin/latest/overview
1364+
release_level: preview
1365+
distribution_name: com.google.ads-marketingplatform:admin
1366+
api_id: marketingplatformadminapi.googleapis.com
1367+
library_type: GAPIC_AUTO
1368+
group_id: com.google.ads-marketingplatform
1369+
cloud_api: false
1370+
GAPICs:
1371+
- proto_path: google/marketingplatform/admin/v1alpha
1372+
requires_billing: true
13551373
- api_shortname: mediatranslation
13561374
name_pretty: Media Translation API
13571375
product_documentation: https://cloud.google.com/

‎java-marketingplatformadminapi/.OwlBot-hermetic.yaml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Copyright 2024 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
16+
deep-remove-regex:
17+
- "/java-marketingplatformadminapi/grpc-google-.*/src"
18+
- "/java-marketingplatformadminapi/proto-google-.*/src"
19+
- "/java-marketingplatformadminapi/google-.*/src"
20+
- "/java-marketingplatformadminapi/samples/snippets/generated"
21+
22+
deep-preserve-regex:
23+
- "/java-marketingplatformadminapi/google-.*/src/test/java/com/google/cloud/.*/v.*/it/IT.*Test.java"
24+
25+
deep-copy-regex:
26+
- source: "/google/marketingplatform/admin/(v.*)/.*-java/proto-google-.*/src"
27+
dest: "/owl-bot-staging/java-marketingplatformadminapi/$1/proto-admin-$1/src"
28+
- source: "/google/marketingplatform/admin/(v.*)/.*-java/grpc-google-.*/src"
29+
dest: "/owl-bot-staging/java-marketingplatformadminapi/$1/grpc-admin-$1/src"
30+
- source: "/google/marketingplatform/admin/(v.*)/.*-java/gapic-google-.*/src"
31+
dest: "/owl-bot-staging/java-marketingplatformadminapi/$1/admin/src"
32+
- source: "/google/marketingplatform/admin/(v.*)/.*-java/samples/snippets/generated"
33+
dest: "/owl-bot-staging/java-marketingplatformadminapi/$1/samples/snippets/generated"
34+
35+
api-name: marketingplatformadminapi

‎java-marketingplatformadminapi/.repo-metadata.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"api_shortname": "marketingplatformadminapi",
3+
"name_pretty": "Google Marketing Platform Admin API",
4+
"product_documentation": "https://developers.google.com/analytics/devguides/config/gmp/v1",
5+
"api_description": "The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, and to set the service level of your GA4 properties.",
6+
"client_documentation": "https://cloud.google.com/java/docs/reference/admin/latest/overview",
7+
"release_level": "preview",
8+
"transport": "both",
9+
"language": "java",
10+
"repo": "googleapis/google-cloud-java",
11+
"repo_short": "java-marketingplatformadminapi",
12+
"distribution_name": "com.google.ads-marketingplatform:admin",
13+
"api_id": "marketingplatformadminapi.googleapis.com",
14+
"library_type": "GAPIC_AUTO",
15+
"requires_billing": true
16+
}

‎java-marketingplatformadminapi/README.md

+226
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,226 @@
1+
# Google Google Marketing Platform Admin API Client for Java
2+
3+
Java idiomatic client for [Google Marketing Platform Admin API][product-docs].
4+
5+
[![Maven][maven-version-image]][maven-version-link]
6+
![Stability][stability-image]
7+
8+
- [Product Documentation][product-docs]
9+
- [Client Library Documentation][javadocs]
10+
11+
> Note: This client is a work-in-progress, and may occasionally
12+
> make backwards-incompatible changes.
13+
14+
15+
## Quickstart
16+
17+
18+
If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
19+
20+
```xml
21+
<dependencyManagement>
22+
<dependencies>
23+
<dependency>
24+
<groupId>com.google.cloud</groupId>
25+
<artifactId>libraries-bom</artifactId>
26+
<version>26.47.0</version>
27+
<type>pom</type>
28+
<scope>import</scope>
29+
</dependency>
30+
</dependencies>
31+
</dependencyManagement>
32+
33+
<dependencies>
34+
<dependency>
35+
<groupId>com.google.ads-marketingplatform</groupId>
36+
<artifactId>admin</artifactId>
37+
</dependency>
38+
</dependencies>
39+
```
40+
41+
If you are using Maven without the BOM, add this to your dependencies:
42+
43+
<!-- {x-version-update-start:admin:released} -->
44+
45+
```xml
46+
<dependency>
47+
<groupId>com.google.ads-marketingplatform</groupId>
48+
<artifactId>admin</artifactId>
49+
<version>0.0.0</version>
50+
</dependency>
51+
```
52+
53+
If you are using Gradle without BOM, add this to your dependencies:
54+
55+
```Groovy
56+
implementation 'com.google.ads-marketingplatform:admin:0.0.0'
57+
```
58+
59+
If you are using SBT, add this to your dependencies:
60+
61+
```Scala
62+
libraryDependencies += "com.google.ads-marketingplatform" % "admin" % "0.0.0"
63+
```
64+
<!-- {x-version-update-end} -->
65+
66+
## Authentication
67+
68+
See the [Authentication][authentication] section in the base directory's README.
69+
70+
## Authorization
71+
72+
The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Google Marketing Platform Admin API APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Google Marketing Platform Admin API API calls.
73+
74+
## Getting Started
75+
76+
### Prerequisites
77+
78+
You will need a [Google Cloud Platform Console][developer-console] project with the Google Marketing Platform Admin API [API enabled][enable-api].
79+
You will need to [enable billing][enable-billing] to use Google Google Marketing Platform Admin API.
80+
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
81+
[installing the Google Cloud Command Line Interface][cloud-cli] and running the following commands in command line:
82+
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
83+
84+
### Installation and setup
85+
86+
You'll need to obtain the `admin` library. See the [Quickstart](#quickstart) section
87+
to add `admin` as a dependency in your code.
88+
89+
## About Google Marketing Platform Admin API
90+
91+
92+
[Google Marketing Platform Admin API][product-docs] The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, and to set the service level of your GA4 properties.
93+
94+
See the [Google Marketing Platform Admin API client library docs][javadocs] to learn how to
95+
use this Google Marketing Platform Admin API Client Library.
96+
97+
98+
99+
100+
101+
102+
## Troubleshooting
103+
104+
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
105+
106+
## Transport
107+
108+
Google Marketing Platform Admin API uses both gRPC and HTTP/JSON for the transport layer.
109+
110+
## Supported Java Versions
111+
112+
Java 8 or above is required for using this client.
113+
114+
Google's Java client libraries,
115+
[Google Cloud Client Libraries][cloudlibs]
116+
and
117+
[Google Cloud API Libraries][apilibs],
118+
follow the
119+
[Oracle Java SE support roadmap][oracle]
120+
(see the Oracle Java SE Product Releases section).
121+
122+
### For new development
123+
124+
In general, new feature development occurs with support for the lowest Java
125+
LTS version covered by Oracle's Premier Support (which typically lasts 5 years
126+
from initial General Availability). If the minimum required JVM for a given
127+
library is changed, it is accompanied by a [semver][semver] major release.
128+
129+
Java 11 and (in September 2021) Java 17 are the best choices for new
130+
development.
131+
132+
### Keeping production systems current
133+
134+
Google tests its client libraries with all current LTS versions covered by
135+
Oracle's Extended Support (which typically lasts 8 years from initial
136+
General Availability).
137+
138+
#### Legacy support
139+
140+
Google's client libraries support legacy versions of Java runtimes with long
141+
term stable libraries that don't receive feature updates on a best efforts basis
142+
as it may not be possible to backport all patches.
143+
144+
Google provides updates on a best efforts basis to apps that continue to use
145+
Java 7, though apps might need to upgrade to current versions of the library
146+
that supports their JVM.
147+
148+
#### Where to find specific information
149+
150+
The latest versions and the supported Java versions are identified on
151+
the individual GitHub repository `github.com/GoogleAPIs/java-SERVICENAME`
152+
and on [google-cloud-java][g-c-j].
153+
154+
## Versioning
155+
156+
157+
This library follows [Semantic Versioning](http://semver.org/).
158+
159+
160+
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
161+
and the public API should not be considered stable.
162+
163+
164+
## Contributing
165+
166+
167+
Contributions to this library are always welcome and highly encouraged.
168+
169+
See [CONTRIBUTING][contributing] for more information how to get started.
170+
171+
Please note that this project is released with a Contributor Code of Conduct. By participating in
172+
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
173+
information.
174+
175+
176+
## License
177+
178+
Apache 2.0 - See [LICENSE][license] for more information.
179+
180+
## CI Status
181+
182+
Java Version | Status
183+
------------ | ------
184+
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
185+
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
186+
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
187+
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
188+
189+
Java is a registered trademark of Oracle and/or its affiliates.
190+
191+
[product-docs]: https://developers.google.com/analytics/devguides/config/gmp/v1
192+
[javadocs]: https://cloud.google.com/java/docs/reference/admin/latest/overview
193+
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.svg
194+
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.html
195+
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.svg
196+
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.html
197+
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.svg
198+
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.html
199+
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.svg
200+
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.html
201+
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.svg
202+
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
203+
[stability-image]: https://img.shields.io/badge/stability-preview-yellow
204+
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.ads-marketingplatform/admin.svg
205+
[maven-version-link]: https://central.sonatype.com/artifact/com.google.ads-marketingplatform/admin/0.0.0
206+
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
207+
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
208+
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
209+
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
210+
[developer-console]: https://console.developers.google.com/
211+
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
212+
[cloud-cli]: https://cloud.google.com/cli
213+
[troubleshooting]: https://github.com/googleapis/google-cloud-java/blob/main/TROUBLESHOOTING.md
214+
[contributing]: https://github.com/googleapis/google-cloud-java/blob/main/CONTRIBUTING.md
215+
[code-of-conduct]: https://github.com/googleapis/google-cloud-java/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
216+
[license]: https://github.com/googleapis/google-cloud-java/blob/main/LICENSE
217+
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
218+
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=marketingplatformadminapi.googleapis.com
219+
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
220+
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
221+
222+
[semver]: https://semver.org/
223+
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
224+
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
225+
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
226+
[g-c-j]: http://github.com/googleapis/google-cloud-java

‎java-marketingplatformadminapi/admin-bom/pom.xml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
3+
<modelVersion>4.0.0</modelVersion>
4+
<groupId>com.google.ads-marketingplatform</groupId>
5+
<artifactId>admin-bom</artifactId>
6+
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:admin:current} -->
7+
<packaging>pom</packaging>
8+
<parent>
9+
<groupId>com.google.cloud</groupId>
10+
<artifactId>google-cloud-pom-parent</artifactId>
11+
<version>1.46.0-SNAPSHOT</version><!-- {x-version-update:google-cloud-java:current} -->
12+
<relativePath>../../google-cloud-pom-parent/pom.xml</relativePath>
13+
</parent>
14+
15+
<name>Google Google Marketing Platform Admin API BOM</name>
16+
<description>
17+
BOM for Google Marketing Platform Admin API
18+
</description>
19+
20+
<properties>
21+
<maven.antrun.skip>true</maven.antrun.skip>
22+
</properties>
23+
24+
<dependencyManagement>
25+
<dependencies>
26+
<dependency>
27+
<groupId>com.google.ads-marketingplatform</groupId>
28+
<artifactId>admin</artifactId>
29+
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:admin:current} -->
30+
</dependency>
31+
<dependency>
32+
<groupId>com.google.ads-marketingplatform.api.grpc</groupId>
33+
<artifactId>grpc-admin-v1alpha</artifactId>
34+
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:grpc-admin-v1alpha:current} -->
35+
</dependency>
36+
<dependency>
37+
<groupId>com.google.ads-marketingplatform.api.grpc</groupId>
38+
<artifactId>proto-admin-v1alpha</artifactId>
39+
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:proto-admin-v1alpha:current} -->
40+
</dependency>
41+
</dependencies>
42+
</dependencyManagement>
43+
</project>

0 commit comments

Comments
 (0)