com.google.ads.googleads.v17.services.CampaignServiceClient Maven / Gradle / Ivy
Show all versions of google-ads-stubs-v17 Show documentation
/*
* 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
*
* 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.v17.services;
import com.google.ads.googleads.v17.services.stub.CampaignServiceStub;
import com.google.ads.googleads.v17.services.stub.CampaignServiceStubSettings;
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 campaigns.
*
* 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
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (CampaignServiceClient campaignServiceClient = CampaignServiceClient.create()) {
* String customerId = "customerId-1581184615";
* List operations = new ArrayList<>();
* MutateCampaignsResponse response =
* campaignServiceClient.mutateCampaigns(customerId, operations);
* }
* }
*
* Note: close() needs to be called on the CampaignServiceClient object to clean up resources
* such as threads. In the example above, try-with-resources is used, which automatically calls
* close().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* MutateCampaigns
Creates, updates, or removes campaigns. Operation statuses are returned.
*
List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [CampaignBudgetError]() [CampaignError]() [ContextError]() [DatabaseError]() [DateError]() [DateRangeError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotAllowlistedError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RegionCodeError]() [RequestError]() [ResourceCountLimitExceededError]() [SettingError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* mutateCampaigns(MutateCampaignsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* mutateCampaigns(String customerId, List<CampaignOperation> operations)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* mutateCampaignsCallable()
*
*
*
*
*
* 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 CampaignServiceSettings to
* create(). For example:
*
*
To customize credentials:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* CampaignServiceSettings campaignServiceSettings =
* CampaignServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* CampaignServiceClient campaignServiceClient =
* CampaignServiceClient.create(campaignServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* CampaignServiceSettings campaignServiceSettings =
* CampaignServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* CampaignServiceClient campaignServiceClient =
* CampaignServiceClient.create(campaignServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class CampaignServiceClient implements BackgroundResource {
private final CampaignServiceSettings settings;
private final CampaignServiceStub stub;
/** Constructs an instance of CampaignServiceClient with default settings. */
public static final CampaignServiceClient create() throws IOException {
return create(CampaignServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of CampaignServiceClient, 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 CampaignServiceClient create(CampaignServiceSettings settings)
throws IOException {
return new CampaignServiceClient(settings);
}
/**
* Constructs an instance of CampaignServiceClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(CampaignServiceSettings).
*/
public static final CampaignServiceClient create(CampaignServiceStub stub) {
return new CampaignServiceClient(stub);
}
/**
* Constructs an instance of CampaignServiceClient, 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 CampaignServiceClient(CampaignServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((CampaignServiceStubSettings) settings.getStubSettings()).createStub();
}
protected CampaignServiceClient(CampaignServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final CampaignServiceSettings getSettings() {
return settings;
}
public CampaignServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates, updates, or removes campaigns. Operation statuses are returned.
*
*
List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]()
* [BiddingError]() [BiddingStrategyError]() [CampaignBudgetError]() [CampaignError]()
* [ContextError]() [DatabaseError]() [DateError]() [DateRangeError]() [DistinctError]()
* [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]()
* [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotAllowlistedError]()
* [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]()
* [RangeError]() [RegionCodeError]() [RequestError]() [ResourceCountLimitExceededError]()
* [SettingError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
* [UrlFieldError]()
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (CampaignServiceClient campaignServiceClient = CampaignServiceClient.create()) {
* String customerId = "customerId-1581184615";
* List operations = new ArrayList<>();
* MutateCampaignsResponse response =
* campaignServiceClient.mutateCampaigns(customerId, operations);
* }
* }
*
* @param customerId Required. The ID of the customer whose campaigns are being modified.
* @param operations Required. The list of operations to perform on individual campaigns.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final MutateCampaignsResponse mutateCampaigns(
String customerId, List operations) {
MutateCampaignsRequest request =
MutateCampaignsRequest.newBuilder()
.setCustomerId(customerId)
.addAllOperations(operations)
.build();
return mutateCampaigns(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates, updates, or removes campaigns. Operation statuses are returned.
*
* List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]()
* [BiddingError]() [BiddingStrategyError]() [CampaignBudgetError]() [CampaignError]()
* [ContextError]() [DatabaseError]() [DateError]() [DateRangeError]() [DistinctError]()
* [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]()
* [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotAllowlistedError]()
* [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]()
* [RangeError]() [RegionCodeError]() [RequestError]() [ResourceCountLimitExceededError]()
* [SettingError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
* [UrlFieldError]()
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (CampaignServiceClient campaignServiceClient = CampaignServiceClient.create()) {
* MutateCampaignsRequest request =
* MutateCampaignsRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .addAllOperations(new ArrayList())
* .setPartialFailure(true)
* .setValidateOnly(true)
* .build();
* MutateCampaignsResponse response = campaignServiceClient.mutateCampaigns(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 MutateCampaignsResponse mutateCampaigns(MutateCampaignsRequest request) {
return mutateCampaignsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates, updates, or removes campaigns. Operation statuses are returned.
*
* List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]()
* [BiddingError]() [BiddingStrategyError]() [CampaignBudgetError]() [CampaignError]()
* [ContextError]() [DatabaseError]() [DateError]() [DateRangeError]() [DistinctError]()
* [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]()
* [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotAllowlistedError]()
* [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]()
* [RangeError]() [RegionCodeError]() [RequestError]() [ResourceCountLimitExceededError]()
* [SettingError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
* [UrlFieldError]()
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (CampaignServiceClient campaignServiceClient = CampaignServiceClient.create()) {
* MutateCampaignsRequest request =
* MutateCampaignsRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .addAllOperations(new ArrayList())
* .setPartialFailure(true)
* .setValidateOnly(true)
* .build();
* ApiFuture future =
* campaignServiceClient.mutateCampaignsCallable().futureCall(request);
* // Do something.
* MutateCampaignsResponse response = future.get();
* }
* }
*/
public final UnaryCallable
mutateCampaignsCallable() {
return stub.mutateCampaignsCallable();
}
@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);
}
}