com.google.ads.googleads.v9.services.AdGroupServiceClient Maven / Gradle / Ivy
Show all versions of google-ads-stubs-v9 Show documentation
/*
* Copyright 2021 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
*
* https://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.
*/
package com.google.ads.googleads.v9.services;
import com.google.ads.googleads.v9.resources.AdGroup;
import com.google.ads.googleads.v9.resources.AdGroupName;
import com.google.ads.googleads.v9.services.stub.AdGroupServiceStub;
import com.google.ads.googleads.v9.services.stub.AdGroupServiceStubSettings;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.UnaryCallable;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service to manage ad groups.
*
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
*
{@code
* try (AdGroupServiceClient adGroupServiceClient = AdGroupServiceClient.create()) {
* AdGroupName resourceName = AdGroupName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]");
* AdGroup response = adGroupServiceClient.getAdGroup(resourceName);
* }
* }
*
* Note: close() needs to be called on the AdGroupServiceClient object to clean up resources such
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
*
The surface of this class includes several types of Java methods for each of the API's
* methods:
*
*
* - A "flattened" method. With this type of method, the fields of the request type have been
* converted into function parameters. It may be the case that not all fields are available as
* parameters, and not every API method will have a flattened method entry point.
*
- A "request object" method. This type of method only takes one parameter, a request object,
* which must be constructed before the call. Not every API method will have a request object
* method.
*
- A "callable" method. This type of method takes no parameters and returns an immutable API
* callable object, which can be used to initiate calls to the service.
*
*
* See the individual methods for example code.
*
*
Many parameters require resource names to be formatted in a particular way. To assist with
* these names, this class includes a format method for each type of name, and additionally a parse
* method to extract the individual identifiers contained within names that are returned.
*
*
This class can be customized by passing in a custom instance of AdGroupServiceSettings to
* create(). For example:
*
*
To customize credentials:
*
*
{@code
* AdGroupServiceSettings adGroupServiceSettings =
* AdGroupServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* AdGroupServiceClient adGroupServiceClient = AdGroupServiceClient.create(adGroupServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@code
* AdGroupServiceSettings adGroupServiceSettings =
* AdGroupServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* AdGroupServiceClient adGroupServiceClient = AdGroupServiceClient.create(adGroupServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class AdGroupServiceClient implements BackgroundResource {
private final AdGroupServiceSettings settings;
private final AdGroupServiceStub stub;
/** Constructs an instance of AdGroupServiceClient with default settings. */
public static final AdGroupServiceClient create() throws IOException {
return create(AdGroupServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of AdGroupServiceClient, using the given settings. The channels are
* created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final AdGroupServiceClient create(AdGroupServiceSettings settings)
throws IOException {
return new AdGroupServiceClient(settings);
}
/**
* Constructs an instance of AdGroupServiceClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(AdGroupServiceSettings).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final AdGroupServiceClient create(AdGroupServiceStub stub) {
return new AdGroupServiceClient(stub);
}
/**
* Constructs an instance of AdGroupServiceClient, using the given settings. This is protected so
* that it is easy to make a subclass, but otherwise, the static factory methods should be
* preferred.
*/
protected AdGroupServiceClient(AdGroupServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((AdGroupServiceStubSettings) settings.getStubSettings()).createStub();
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected AdGroupServiceClient(AdGroupServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final AdGroupServiceSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public AdGroupServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the requested ad group in full detail.
*
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
Sample code:
*
*
{@code
* try (AdGroupServiceClient adGroupServiceClient = AdGroupServiceClient.create()) {
* AdGroupName resourceName = AdGroupName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]");
* AdGroup response = adGroupServiceClient.getAdGroup(resourceName);
* }
* }
*
* @param resourceName Required. The resource name of the ad group to fetch.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AdGroup getAdGroup(AdGroupName resourceName) {
GetAdGroupRequest request =
GetAdGroupRequest.newBuilder()
.setResourceName(resourceName == null ? null : resourceName.toString())
.build();
return getAdGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the requested ad group in full detail.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
Sample code:
*
*
{@code
* try (AdGroupServiceClient adGroupServiceClient = AdGroupServiceClient.create()) {
* String resourceName = AdGroupName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]").toString();
* AdGroup response = adGroupServiceClient.getAdGroup(resourceName);
* }
* }
*
* @param resourceName Required. The resource name of the ad group to fetch.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AdGroup getAdGroup(String resourceName) {
GetAdGroupRequest request =
GetAdGroupRequest.newBuilder().setResourceName(resourceName).build();
return getAdGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the requested ad group in full detail.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
Sample code:
*
*
{@code
* try (AdGroupServiceClient adGroupServiceClient = AdGroupServiceClient.create()) {
* GetAdGroupRequest request =
* GetAdGroupRequest.newBuilder()
* .setResourceName(AdGroupName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]").toString())
* .build();
* AdGroup response = adGroupServiceClient.getAdGroup(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AdGroup getAdGroup(GetAdGroupRequest request) {
return getAdGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the requested ad group in full detail.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
Sample code:
*
*
{@code
* try (AdGroupServiceClient adGroupServiceClient = AdGroupServiceClient.create()) {
* GetAdGroupRequest request =
* GetAdGroupRequest.newBuilder()
* .setResourceName(AdGroupName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]").toString())
* .build();
* ApiFuture future = adGroupServiceClient.getAdGroupCallable().futureCall(request);
* // Do something.
* AdGroup response = future.get();
* }
* }
*/
public final UnaryCallable getAdGroupCallable() {
return stub.getAdGroupCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates, updates, or removes ad groups. Operation statuses are returned.
*
* List of thrown errors: [AdGroupError]() [AdxError]() [AuthenticationError]()
* [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [DatabaseError]()
* [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]()
* [InternalError]() [ListOperationError]() [MultiplierError]() [MutateError]()
* [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]()
* [OperatorError]() [QuotaError]() [RangeError]() [RequestError]()
* [ResourceCountLimitExceededError]() [SettingError]() [SizeLimitError]() [StringFormatError]()
* [StringLengthError]() [UrlFieldError]()
*
*
Sample code:
*
*
{@code
* try (AdGroupServiceClient adGroupServiceClient = AdGroupServiceClient.create()) {
* String customerId = "customerId-1581184615";
* List operations = new ArrayList<>();
* MutateAdGroupsResponse response = adGroupServiceClient.mutateAdGroups(customerId, operations);
* }
* }
*
* @param customerId Required. The ID of the customer whose ad groups are being modified.
* @param operations Required. The list of operations to perform on individual ad groups.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final MutateAdGroupsResponse mutateAdGroups(
String customerId, List operations) {
MutateAdGroupsRequest request =
MutateAdGroupsRequest.newBuilder()
.setCustomerId(customerId)
.addAllOperations(operations)
.build();
return mutateAdGroups(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates, updates, or removes ad groups. Operation statuses are returned.
*
* List of thrown errors: [AdGroupError]() [AdxError]() [AuthenticationError]()
* [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [DatabaseError]()
* [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]()
* [InternalError]() [ListOperationError]() [MultiplierError]() [MutateError]()
* [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]()
* [OperatorError]() [QuotaError]() [RangeError]() [RequestError]()
* [ResourceCountLimitExceededError]() [SettingError]() [SizeLimitError]() [StringFormatError]()
* [StringLengthError]() [UrlFieldError]()
*
*
Sample code:
*
*
{@code
* try (AdGroupServiceClient adGroupServiceClient = AdGroupServiceClient.create()) {
* MutateAdGroupsRequest request =
* MutateAdGroupsRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .addAllOperations(new ArrayList())
* .setPartialFailure(true)
* .setValidateOnly(true)
* .build();
* MutateAdGroupsResponse response = adGroupServiceClient.mutateAdGroups(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final MutateAdGroupsResponse mutateAdGroups(MutateAdGroupsRequest request) {
return mutateAdGroupsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates, updates, or removes ad groups. Operation statuses are returned.
*
* List of thrown errors: [AdGroupError]() [AdxError]() [AuthenticationError]()
* [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [DatabaseError]()
* [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]()
* [InternalError]() [ListOperationError]() [MultiplierError]() [MutateError]()
* [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]()
* [OperatorError]() [QuotaError]() [RangeError]() [RequestError]()
* [ResourceCountLimitExceededError]() [SettingError]() [SizeLimitError]() [StringFormatError]()
* [StringLengthError]() [UrlFieldError]()
*
*
Sample code:
*
*
{@code
* try (AdGroupServiceClient adGroupServiceClient = AdGroupServiceClient.create()) {
* MutateAdGroupsRequest request =
* MutateAdGroupsRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .addAllOperations(new ArrayList())
* .setPartialFailure(true)
* .setValidateOnly(true)
* .build();
* ApiFuture future =
* adGroupServiceClient.mutateAdGroupsCallable().futureCall(request);
* // Do something.
* MutateAdGroupsResponse response = future.get();
* }
* }
*/
public final UnaryCallable
mutateAdGroupsCallable() {
return stub.mutateAdGroupsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
}