com.google.ads.googleads.v9.services.CampaignBidModifierServiceClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v9 Show documentation
Stubs for GAAPI version google-ads-stubs-v9
The newest version!
/*
 * 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.CampaignBidModifier;
import com.google.ads.googleads.v9.resources.CampaignBidModifierName;
import com.google.ads.googleads.v9.services.stub.CampaignBidModifierServiceStub;
import com.google.ads.googleads.v9.services.stub.CampaignBidModifierServiceStubSettings;
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 campaign bid modifiers.
 *
 * 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 (CampaignBidModifierServiceClient campaignBidModifierServiceClient =
 *     CampaignBidModifierServiceClient.create()) {
 *   CampaignBidModifierName resourceName =
 *       CampaignBidModifierName.of("[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[CRITERION_ID]");
 *   CampaignBidModifier response =
 *       campaignBidModifierServiceClient.getCampaignBidModifier(resourceName);
 * }
 * }
 *
 * Note: close() needs to be called on the CampaignBidModifierServiceClient 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
 * CampaignBidModifierServiceSettings to create(). For example:
 *
 * 
To customize credentials:
 *
 * 
{@code
 * CampaignBidModifierServiceSettings campaignBidModifierServiceSettings =
 *     CampaignBidModifierServiceSettings.newBuilder()
 *         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
 *         .build();
 * CampaignBidModifierServiceClient campaignBidModifierServiceClient =
 *     CampaignBidModifierServiceClient.create(campaignBidModifierServiceSettings);
 * }
 *
 * To customize the endpoint:
 *
 * 
{@code
 * CampaignBidModifierServiceSettings campaignBidModifierServiceSettings =
 *     CampaignBidModifierServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 * CampaignBidModifierServiceClient campaignBidModifierServiceClient =
 *     CampaignBidModifierServiceClient.create(campaignBidModifierServiceSettings);
 * }
 *
 * Please refer to the GitHub repository's samples for more quickstart code snippets.
 */
@Generated("by gapic-generator-java")
public class CampaignBidModifierServiceClient implements BackgroundResource {
  private final CampaignBidModifierServiceSettings settings;
  private final CampaignBidModifierServiceStub stub;

  /** Constructs an instance of CampaignBidModifierServiceClient with default settings. */
  public static final CampaignBidModifierServiceClient create() throws IOException {
    return create(CampaignBidModifierServiceSettings.newBuilder().build());
  }

  /**
   * Constructs an instance of CampaignBidModifierServiceClient, 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 CampaignBidModifierServiceClient create(
      CampaignBidModifierServiceSettings settings) throws IOException {
    return new CampaignBidModifierServiceClient(settings);
  }

  /**
   * Constructs an instance of CampaignBidModifierServiceClient, using the given stub for making
   * calls. This is for advanced usage - prefer using create(CampaignBidModifierServiceSettings).
   */
  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
  public static final CampaignBidModifierServiceClient create(CampaignBidModifierServiceStub stub) {
    return new CampaignBidModifierServiceClient(stub);
  }

  /**
   * Constructs an instance of CampaignBidModifierServiceClient, 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 CampaignBidModifierServiceClient(CampaignBidModifierServiceSettings settings)
      throws IOException {
    this.settings = settings;
    this.stub = ((CampaignBidModifierServiceStubSettings) settings.getStubSettings()).createStub();
  }

  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
  protected CampaignBidModifierServiceClient(CampaignBidModifierServiceStub stub) {
    this.settings = null;
    this.stub = stub;
  }

  public final CampaignBidModifierServiceSettings getSettings() {
    return settings;
  }

  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
  public CampaignBidModifierServiceStub getStub() {
    return stub;
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Returns the requested campaign bid modifier in full detail.
   *
   * 
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
   * [InternalError]() [QuotaError]() [RequestError]()
   *
   * 
Sample code:
   *
   * 
{@code
   * try (CampaignBidModifierServiceClient campaignBidModifierServiceClient =
   *     CampaignBidModifierServiceClient.create()) {
   *   CampaignBidModifierName resourceName =
   *       CampaignBidModifierName.of("[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[CRITERION_ID]");
   *   CampaignBidModifier response =
   *       campaignBidModifierServiceClient.getCampaignBidModifier(resourceName);
   * }
   * }
   *
   * @param resourceName Required. The resource name of the campaign bid modifier to fetch.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final CampaignBidModifier getCampaignBidModifier(CampaignBidModifierName resourceName) {
    GetCampaignBidModifierRequest request =
        GetCampaignBidModifierRequest.newBuilder()
            .setResourceName(resourceName == null ? null : resourceName.toString())
            .build();
    return getCampaignBidModifier(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Returns the requested campaign bid modifier in full detail.
   *
   * List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
   * [InternalError]() [QuotaError]() [RequestError]()
   *
   * 
Sample code:
   *
   * 
{@code
   * try (CampaignBidModifierServiceClient campaignBidModifierServiceClient =
   *     CampaignBidModifierServiceClient.create()) {
   *   String resourceName =
   *       CampaignBidModifierName.of("[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[CRITERION_ID]").toString();
   *   CampaignBidModifier response =
   *       campaignBidModifierServiceClient.getCampaignBidModifier(resourceName);
   * }
   * }
   *
   * @param resourceName Required. The resource name of the campaign bid modifier to fetch.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final CampaignBidModifier getCampaignBidModifier(String resourceName) {
    GetCampaignBidModifierRequest request =
        GetCampaignBidModifierRequest.newBuilder().setResourceName(resourceName).build();
    return getCampaignBidModifier(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Returns the requested campaign bid modifier in full detail.
   *
   * List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
   * [InternalError]() [QuotaError]() [RequestError]()
   *
   * 
Sample code:
   *
   * 
{@code
   * try (CampaignBidModifierServiceClient campaignBidModifierServiceClient =
   *     CampaignBidModifierServiceClient.create()) {
   *   GetCampaignBidModifierRequest request =
   *       GetCampaignBidModifierRequest.newBuilder()
   *           .setResourceName(
   *               CampaignBidModifierName.of("[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[CRITERION_ID]")
   *                   .toString())
   *           .build();
   *   CampaignBidModifier response =
   *       campaignBidModifierServiceClient.getCampaignBidModifier(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 CampaignBidModifier getCampaignBidModifier(GetCampaignBidModifierRequest request) {
    return getCampaignBidModifierCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Returns the requested campaign bid modifier in full detail.
   *
   * List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
   * [InternalError]() [QuotaError]() [RequestError]()
   *
   * 
Sample code:
   *
   * 
{@code
   * try (CampaignBidModifierServiceClient campaignBidModifierServiceClient =
   *     CampaignBidModifierServiceClient.create()) {
   *   GetCampaignBidModifierRequest request =
   *       GetCampaignBidModifierRequest.newBuilder()
   *           .setResourceName(
   *               CampaignBidModifierName.of("[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[CRITERION_ID]")
   *                   .toString())
   *           .build();
   *   ApiFuture future =
   *       campaignBidModifierServiceClient.getCampaignBidModifierCallable().futureCall(request);
   *   // Do something.
   *   CampaignBidModifier response = future.get();
   * }
   * }
   */
  public final UnaryCallable
      getCampaignBidModifierCallable() {
    return stub.getCampaignBidModifierCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates, updates, or removes campaign bid modifiers. Operation statuses are returned.
   *
   * List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ContextError]()
   * [CriterionError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]()
   * [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]()
   * [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]()
   * [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
   *
   * 
Sample code:
   *
   * 
{@code
   * try (CampaignBidModifierServiceClient campaignBidModifierServiceClient =
   *     CampaignBidModifierServiceClient.create()) {
   *   String customerId = "customerId-1581184615";
   *   List operations = new ArrayList<>();
   *   MutateCampaignBidModifiersResponse response =
   *       campaignBidModifierServiceClient.mutateCampaignBidModifiers(customerId, operations);
   * }
   * }
   *
   * @param customerId Required. ID of the customer whose campaign bid modifiers are being modified.
   * @param operations Required. The list of operations to perform on individual campaign bid
   *     modifiers.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final MutateCampaignBidModifiersResponse mutateCampaignBidModifiers(
      String customerId, List operations) {
    MutateCampaignBidModifiersRequest request =
        MutateCampaignBidModifiersRequest.newBuilder()
            .setCustomerId(customerId)
            .addAllOperations(operations)
            .build();
    return mutateCampaignBidModifiers(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates, updates, or removes campaign bid modifiers. Operation statuses are returned.
   *
   * List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ContextError]()
   * [CriterionError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]()
   * [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]()
   * [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]()
   * [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
   *
   * 
Sample code:
   *
   * 
{@code
   * try (CampaignBidModifierServiceClient campaignBidModifierServiceClient =
   *     CampaignBidModifierServiceClient.create()) {
   *   MutateCampaignBidModifiersRequest request =
   *       MutateCampaignBidModifiersRequest.newBuilder()
   *           .setCustomerId("customerId-1581184615")
   *           .addAllOperations(new ArrayList())
   *           .setPartialFailure(true)
   *           .setValidateOnly(true)
   *           .build();
   *   MutateCampaignBidModifiersResponse response =
   *       campaignBidModifierServiceClient.mutateCampaignBidModifiers(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 MutateCampaignBidModifiersResponse mutateCampaignBidModifiers(
      MutateCampaignBidModifiersRequest request) {
    return mutateCampaignBidModifiersCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates, updates, or removes campaign bid modifiers. Operation statuses are returned.
   *
   * List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ContextError]()
   * [CriterionError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]()
   * [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]()
   * [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]()
   * [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
   *
   * 
Sample code:
   *
   * 
{@code
   * try (CampaignBidModifierServiceClient campaignBidModifierServiceClient =
   *     CampaignBidModifierServiceClient.create()) {
   *   MutateCampaignBidModifiersRequest request =
   *       MutateCampaignBidModifiersRequest.newBuilder()
   *           .setCustomerId("customerId-1581184615")
   *           .addAllOperations(new ArrayList())
   *           .setPartialFailure(true)
   *           .setValidateOnly(true)
   *           .build();
   *   ApiFuture future =
   *       campaignBidModifierServiceClient.mutateCampaignBidModifiersCallable().futureCall(request);
   *   // Do something.
   *   MutateCampaignBidModifiersResponse response = future.get();
   * }
   * }
   */
  public final UnaryCallable
      mutateCampaignBidModifiersCallable() {
    return stub.mutateCampaignBidModifiersCallable();
  }

  @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);
  }
}