Skip to content

Commit

Permalink
feat: [admanager] new module for admanager (#10750)
Browse files Browse the repository at this point in the history
Co-authored-by: cloud-java-bot <cloud-java-bot@google.com>
  • Loading branch information
lqiu96 and cloud-java-bot authored Apr 25, 2024
1 parent 2f30165 commit afdbb64
Show file tree
Hide file tree
Showing 642 changed files with 199,112 additions and 16 deletions.
32 changes: 16 additions & 16 deletions generation_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,21 @@ libraries:
- proto_path: google/identity/accesscontextmanager/v1
- proto_path: google/identity/accesscontextmanager/type

- api_shortname: admanager
name_pretty: Google Ad Manager API
product_documentation: https://developers.google.com/ad-manager/api/beta
api_description: The Ad Manager API enables an app to integrate with Google Ad Manager.
You can read Ad Manager data and run reports using the API.
client_documentation: https://cloud.google.com/java/docs/reference/ad-manager/latest/overview
release_level: preview
distribution_name: com.google.api-ads:ad-manager
api_id: admanager.googleapis.com
library_type: GAPIC_AUTO
group_id: com.google.api-ads
cloud_api: false
GAPICs:
- proto_path: google/ads/admanager/v1
requires_billing: true
- api_shortname: advisorynotifications
name_pretty: Advisory Notifications API
product_documentation: https://cloud.google.com/advisory-notifications/
Expand Down Expand Up @@ -1769,6 +1784,7 @@ libraries:
GAPICs:
- proto_path: google/shopping/merchant/conversions/v1beta
requires_billing: true

- api_shortname: merchantapi
name_pretty: Merchant API
product_documentation: https://developers.google.com/merchant/api
Expand All @@ -1779,22 +1795,6 @@ libraries:
GAPICs:
- proto_path: google/shopping/merchant/inventories/v1beta

- api_shortname: shopping-merchant-conversions
name_pretty: Merchant Conversions API
product_documentation: https://developers.google.com/merchant/api
api_description: Programmatically manage your Merchant Center accounts.
client_documentation:
https://cloud.google.com/java/docs/reference/google-shopping-merchant-conversions/latest/overview
release_level: preview
distribution_name: com.google.shopping:google-shopping-merchant-conversions
api_id: shopping-merchant-conversions.googleapis.com
library_type: GAPIC_AUTO
group_id: com.google.shopping
cloud_api: false
GAPICs:
- proto_path: google/shopping/merchant/conversions/v1beta
requires_billing: true

- api_shortname: shopping-merchant-lfp
name_pretty: Merchant LFP API
product_documentation: https://developers.google.com/merchant/api
Expand Down
35 changes: 35 additions & 0 deletions java-admanager/.OwlBot-hermetic.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


deep-remove-regex:
- "/java-admanager/grpc-google-.*/src"
- "/java-admanager/proto-google-.*/src"
- "/java-admanager/google-.*/src"
- "/java-admanager/samples/snippets/generated"

deep-preserve-regex:
- "/java-admanager/google-.*/src/test/java/com/google/cloud/.*/v.*/it/IT.*Test.java"

deep-copy-regex:
- source: "/google/ads/admanager/(v.*)/.*-java/proto-google-.*/src"
dest: "/owl-bot-staging/java-admanager/$1/proto-ad-manager-$1/src"
- source: "/google/ads/admanager/(v.*)/.*-java/grpc-google-.*/src"
dest: "/owl-bot-staging/java-admanager/$1/grpc-ad-manager-$1/src"
- source: "/google/ads/admanager/(v.*)/.*-java/gapic-google-.*/src"
dest: "/owl-bot-staging/java-admanager/$1/ad-manager/src"
- source: "/google/ads/admanager/(v.*)/.*-java/samples/snippets/generated"
dest: "/owl-bot-staging/java-admanager/$1/samples/snippets/generated"

api-name: admanager
16 changes: 16 additions & 0 deletions java-admanager/.repo-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"api_shortname": "admanager",
"name_pretty": "Google Ad Manager API",
"product_documentation": "https://developers.google.com/ad-manager/api/beta",
"api_description": "The Ad Manager API enables an app to integrate with Google Ad Manager. You can read Ad Manager data and run reports using the API.",
"client_documentation": "https://cloud.google.com/java/docs/reference/ad-manager/latest/overview",
"release_level": "preview",
"transport": "http",
"language": "java",
"repo": "googleapis/google-cloud-java",
"repo_short": "java-admanager",
"distribution_name": "com.google.api-ads:ad-manager",
"api_id": "admanager.googleapis.com",
"library_type": "GAPIC_AUTO",
"requires_billing": true
}
225 changes: 225 additions & 0 deletions java-admanager/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
# Google Google Ad Manager API Client for Java

Java idiomatic client for [Google Ad Manager API][product-docs].

[![Maven][maven-version-image]][maven-version-link]
![Stability][stability-image]

- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]

> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.

## Quickstart


If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:

```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>26.37.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependencies>
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>ad-manager</artifactId>
</dependency>
```

If you are using Maven without the BOM, add this to your dependencies:

<!-- {x-version-update-start:ad-manager:released} -->

```xml
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>ad-manager</artifactId>
<version>0.0.0</version>
</dependency>
```

If you are using Gradle without BOM, add this to your dependencies:

```Groovy
implementation 'com.google.api-ads:ad-manager:0.0.0'
```

If you are using SBT, add this to your dependencies:

```Scala
libraryDependencies += "com.google.api-ads" % "ad-manager" % "0.0.0"
```
<!-- {x-version-update-end} -->

## Authentication

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

## Authorization

The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Google Ad Manager API APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Google Ad Manager API API calls.

## Getting Started

### Prerequisites

You will need a [Google Cloud Platform Console][developer-console] project with the Google Ad Manager API [API enabled][enable-api].
You will need to [enable billing][enable-billing] to use Google Google Ad Manager API.
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
[installing the Google Cloud Command Line Interface][cloud-cli] and running the following commands in command line:
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.

### Installation and setup

You'll need to obtain the `ad-manager` library. See the [Quickstart](#quickstart) section
to add `ad-manager` as a dependency in your code.

## About Google Ad Manager API


[Google Ad Manager API][product-docs] The Ad Manager API enables an app to integrate with Google Ad Manager. You can read Ad Manager data and run reports using the API.

See the [Google Ad Manager API client library docs][javadocs] to learn how to
use this Google Ad Manager API Client Library.






## Troubleshooting

To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].

## Transport

Google Ad Manager API uses HTTP/JSON for the transport layer.

## Supported Java Versions

Java 8 or above is required for using this client.

Google's Java client libraries,
[Google Cloud Client Libraries][cloudlibs]
and
[Google Cloud API Libraries][apilibs],
follow the
[Oracle Java SE support roadmap][oracle]
(see the Oracle Java SE Product Releases section).

### For new development

In general, new feature development occurs with support for the lowest Java
LTS version covered by Oracle's Premier Support (which typically lasts 5 years
from initial General Availability). If the minimum required JVM for a given
library is changed, it is accompanied by a [semver][semver] major release.

Java 11 and (in September 2021) Java 17 are the best choices for new
development.

### Keeping production systems current

Google tests its client libraries with all current LTS versions covered by
Oracle's Extended Support (which typically lasts 8 years from initial
General Availability).

#### Legacy support

Google's client libraries support legacy versions of Java runtimes with long
term stable libraries that don't receive feature updates on a best efforts basis
as it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to use
Java 7, though apps might need to upgrade to current versions of the library
that supports their JVM.

#### Where to find specific information

The latest versions and the supported Java versions are identified on
the individual GitHub repository `github.com/GoogleAPIs/java-SERVICENAME`
and on [google-cloud-java][g-c-j].

## Versioning


This library follows [Semantic Versioning](http://semver.org/).


It is currently in major version zero (``0.y.z``), which means that anything may change at any time
and the public API should not be considered stable.


## Contributing


Contributions to this library are always welcome and highly encouraged.

See [CONTRIBUTING][contributing] for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
information.


## License

Apache 2.0 - See [LICENSE][license] for more information.

## CI Status

Java Version | Status
------------ | ------
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]

Java is a registered trademark of Oracle and/or its affiliates.

[product-docs]: https://developers.google.com/ad-manager/api/beta
[javadocs]: https://cloud.google.com/java/docs/reference/ad-manager/latest/overview
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
[stability-image]: https://img.shields.io/badge/stability-preview-yellow
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.api-ads/ad-manager.svg
[maven-version-link]: https://central.sonatype.com/artifact/com.google.api-ads/ad-manager/0.0.0
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
[developer-console]: https://console.developers.google.com/
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
[cloud-cli]: https://cloud.google.com/cli
[troubleshooting]: https://github.com/googleapis/google-cloud-java/blob/main/TROUBLESHOOTING.md
[contributing]: https://github.com/googleapis/google-cloud-java/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/google-cloud-java/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/google-cloud-java/blob/main/LICENSE
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=admanager.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png

[semver]: https://semver.org/
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
[g-c-j]: http://github.com/googleapis/google-cloud-java
38 changes: 38 additions & 0 deletions java-admanager/ad-manager-bom/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?xml version='1.0' encoding='UTF-8'?>
<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">
<modelVersion>4.0.0</modelVersion>
<groupId>com.google.api-ads</groupId>
<artifactId>ad-manager-bom</artifactId>
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:ad-manager:current} -->
<packaging>pom</packaging>
<parent>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-pom-parent</artifactId>
<version>1.36.0-SNAPSHOT</version><!-- {x-version-update:google-cloud-java:current} -->
<relativePath>../../google-cloud-pom-parent/pom.xml</relativePath>
</parent>

<name>Google Google Ad Manager API BOM</name>
<description>
BOM for Google Ad Manager API
</description>

<properties>
<maven.antrun.skip>true</maven.antrun.skip>
</properties>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>ad-manager</artifactId>
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:ad-manager:current} -->
</dependency>
<dependency>
<groupId>com.google.api-ads.api.grpc</groupId>
<artifactId>proto-ad-manager-v1</artifactId>
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:proto-ad-manager-v1:current} -->
</dependency>
</dependencies>
</dependencyManagement>
</project>
Loading

0 comments on commit afdbb64

Please sign in to comment.