com.google.ads.googleads.v17.services.GoogleAdsFieldServiceClient 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.resources.GoogleAdsField;
import com.google.ads.googleads.v17.resources.GoogleAdsFieldName;
import com.google.ads.googleads.v17.services.stub.GoogleAdsFieldServiceStub;
import com.google.ads.googleads.v17.services.stub.GoogleAdsFieldServiceStubSettings;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.common.util.concurrent.MoreExecutors;
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 fetch Google Ads API fields.
*
* 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 (GoogleAdsFieldServiceClient googleAdsFieldServiceClient =
* GoogleAdsFieldServiceClient.create()) {
* GoogleAdsFieldName resourceName = GoogleAdsFieldName.of("[GOOGLE_ADS_FIELD]");
* GoogleAdsField response = googleAdsFieldServiceClient.getGoogleAdsField(resourceName);
* }
* }
*
* Note: close() needs to be called on the GoogleAdsFieldServiceClient 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
*
*
* GetGoogleAdsField
Returns just the requested field.
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getGoogleAdsField(GetGoogleAdsFieldRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getGoogleAdsField(GoogleAdsFieldName resourceName)
*
getGoogleAdsField(String resourceName)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getGoogleAdsFieldCallable()
*
*
*
*
* SearchGoogleAdsFields
Returns all fields that match the search query.
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* searchGoogleAdsFields(SearchGoogleAdsFieldsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* searchGoogleAdsFields(String query)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* searchGoogleAdsFieldsPagedCallable()
*
searchGoogleAdsFieldsCallable()
*
*
*
*
*
* 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 GoogleAdsFieldServiceSettings
* 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
* GoogleAdsFieldServiceSettings googleAdsFieldServiceSettings =
* GoogleAdsFieldServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* GoogleAdsFieldServiceClient googleAdsFieldServiceClient =
* GoogleAdsFieldServiceClient.create(googleAdsFieldServiceSettings);
* }
*
* 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
* GoogleAdsFieldServiceSettings googleAdsFieldServiceSettings =
* GoogleAdsFieldServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* GoogleAdsFieldServiceClient googleAdsFieldServiceClient =
* GoogleAdsFieldServiceClient.create(googleAdsFieldServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class GoogleAdsFieldServiceClient implements BackgroundResource {
private final GoogleAdsFieldServiceSettings settings;
private final GoogleAdsFieldServiceStub stub;
/** Constructs an instance of GoogleAdsFieldServiceClient with default settings. */
public static final GoogleAdsFieldServiceClient create() throws IOException {
return create(GoogleAdsFieldServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of GoogleAdsFieldServiceClient, 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 GoogleAdsFieldServiceClient create(GoogleAdsFieldServiceSettings settings)
throws IOException {
return new GoogleAdsFieldServiceClient(settings);
}
/**
* Constructs an instance of GoogleAdsFieldServiceClient, using the given stub for making calls.
* This is for advanced usage - prefer using create(GoogleAdsFieldServiceSettings).
*/
public static final GoogleAdsFieldServiceClient create(GoogleAdsFieldServiceStub stub) {
return new GoogleAdsFieldServiceClient(stub);
}
/**
* Constructs an instance of GoogleAdsFieldServiceClient, 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 GoogleAdsFieldServiceClient(GoogleAdsFieldServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((GoogleAdsFieldServiceStubSettings) settings.getStubSettings()).createStub();
}
protected GoogleAdsFieldServiceClient(GoogleAdsFieldServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final GoogleAdsFieldServiceSettings getSettings() {
return settings;
}
public GoogleAdsFieldServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns just the requested field.
*
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (GoogleAdsFieldServiceClient googleAdsFieldServiceClient =
* GoogleAdsFieldServiceClient.create()) {
* GoogleAdsFieldName resourceName = GoogleAdsFieldName.of("[GOOGLE_ADS_FIELD]");
* GoogleAdsField response = googleAdsFieldServiceClient.getGoogleAdsField(resourceName);
* }
* }
*
* @param resourceName Required. The resource name of the field to get.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final GoogleAdsField getGoogleAdsField(GoogleAdsFieldName resourceName) {
GetGoogleAdsFieldRequest request =
GetGoogleAdsFieldRequest.newBuilder()
.setResourceName(resourceName == null ? null : resourceName.toString())
.build();
return getGoogleAdsField(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns just the requested field.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (GoogleAdsFieldServiceClient googleAdsFieldServiceClient =
* GoogleAdsFieldServiceClient.create()) {
* String resourceName = GoogleAdsFieldName.of("[GOOGLE_ADS_FIELD]").toString();
* GoogleAdsField response = googleAdsFieldServiceClient.getGoogleAdsField(resourceName);
* }
* }
*
* @param resourceName Required. The resource name of the field to get.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final GoogleAdsField getGoogleAdsField(String resourceName) {
GetGoogleAdsFieldRequest request =
GetGoogleAdsFieldRequest.newBuilder().setResourceName(resourceName).build();
return getGoogleAdsField(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns just the requested field.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (GoogleAdsFieldServiceClient googleAdsFieldServiceClient =
* GoogleAdsFieldServiceClient.create()) {
* GetGoogleAdsFieldRequest request =
* GetGoogleAdsFieldRequest.newBuilder()
* .setResourceName(GoogleAdsFieldName.of("[GOOGLE_ADS_FIELD]").toString())
* .build();
* GoogleAdsField response = googleAdsFieldServiceClient.getGoogleAdsField(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 GoogleAdsField getGoogleAdsField(GetGoogleAdsFieldRequest request) {
return getGoogleAdsFieldCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns just the requested field.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (GoogleAdsFieldServiceClient googleAdsFieldServiceClient =
* GoogleAdsFieldServiceClient.create()) {
* GetGoogleAdsFieldRequest request =
* GetGoogleAdsFieldRequest.newBuilder()
* .setResourceName(GoogleAdsFieldName.of("[GOOGLE_ADS_FIELD]").toString())
* .build();
* ApiFuture future =
* googleAdsFieldServiceClient.getGoogleAdsFieldCallable().futureCall(request);
* // Do something.
* GoogleAdsField response = future.get();
* }
* }
*/
public final UnaryCallable getGoogleAdsFieldCallable() {
return stub.getGoogleAdsFieldCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns all fields that match the search query.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
*
*
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 (GoogleAdsFieldServiceClient googleAdsFieldServiceClient =
* GoogleAdsFieldServiceClient.create()) {
* String query = "query107944136";
* for (GoogleAdsField element :
* googleAdsFieldServiceClient.searchGoogleAdsFields(query).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param query Required. The query string.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchGoogleAdsFieldsPagedResponse searchGoogleAdsFields(String query) {
SearchGoogleAdsFieldsRequest request =
SearchGoogleAdsFieldsRequest.newBuilder().setQuery(query).build();
return searchGoogleAdsFields(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns all fields that match the search query.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
*
*
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 (GoogleAdsFieldServiceClient googleAdsFieldServiceClient =
* GoogleAdsFieldServiceClient.create()) {
* SearchGoogleAdsFieldsRequest request =
* SearchGoogleAdsFieldsRequest.newBuilder()
* .setQuery("query107944136")
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* for (GoogleAdsField element :
* googleAdsFieldServiceClient.searchGoogleAdsFields(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @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 SearchGoogleAdsFieldsPagedResponse searchGoogleAdsFields(
SearchGoogleAdsFieldsRequest request) {
return searchGoogleAdsFieldsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns all fields that match the search query.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
*
*
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 (GoogleAdsFieldServiceClient googleAdsFieldServiceClient =
* GoogleAdsFieldServiceClient.create()) {
* SearchGoogleAdsFieldsRequest request =
* SearchGoogleAdsFieldsRequest.newBuilder()
* .setQuery("query107944136")
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* ApiFuture future =
* googleAdsFieldServiceClient.searchGoogleAdsFieldsPagedCallable().futureCall(request);
* // Do something.
* for (GoogleAdsField element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
searchGoogleAdsFieldsPagedCallable() {
return stub.searchGoogleAdsFieldsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns all fields that match the search query.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QueryError]() [QuotaError]() [RequestError]()
*
*
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 (GoogleAdsFieldServiceClient googleAdsFieldServiceClient =
* GoogleAdsFieldServiceClient.create()) {
* SearchGoogleAdsFieldsRequest request =
* SearchGoogleAdsFieldsRequest.newBuilder()
* .setQuery("query107944136")
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* while (true) {
* SearchGoogleAdsFieldsResponse response =
* googleAdsFieldServiceClient.searchGoogleAdsFieldsCallable().call(request);
* for (GoogleAdsField element : response.getResultsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
searchGoogleAdsFieldsCallable() {
return stub.searchGoogleAdsFieldsCallable();
}
@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);
}
public static class SearchGoogleAdsFieldsPagedResponse
extends AbstractPagedListResponse<
SearchGoogleAdsFieldsRequest,
SearchGoogleAdsFieldsResponse,
GoogleAdsField,
SearchGoogleAdsFieldsPage,
SearchGoogleAdsFieldsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
SearchGoogleAdsFieldsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new SearchGoogleAdsFieldsPagedResponse(input),
MoreExecutors.directExecutor());
}
private SearchGoogleAdsFieldsPagedResponse(SearchGoogleAdsFieldsPage page) {
super(page, SearchGoogleAdsFieldsFixedSizeCollection.createEmptyCollection());
}
}
public static class SearchGoogleAdsFieldsPage
extends AbstractPage<
SearchGoogleAdsFieldsRequest,
SearchGoogleAdsFieldsResponse,
GoogleAdsField,
SearchGoogleAdsFieldsPage> {
private SearchGoogleAdsFieldsPage(
PageContext
context,
SearchGoogleAdsFieldsResponse response) {
super(context, response);
}
private static SearchGoogleAdsFieldsPage createEmptyPage() {
return new SearchGoogleAdsFieldsPage(null, null);
}
@Override
protected SearchGoogleAdsFieldsPage createPage(
PageContext
context,
SearchGoogleAdsFieldsResponse response) {
return new SearchGoogleAdsFieldsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class SearchGoogleAdsFieldsFixedSizeCollection
extends AbstractFixedSizeCollection<
SearchGoogleAdsFieldsRequest,
SearchGoogleAdsFieldsResponse,
GoogleAdsField,
SearchGoogleAdsFieldsPage,
SearchGoogleAdsFieldsFixedSizeCollection> {
private SearchGoogleAdsFieldsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static SearchGoogleAdsFieldsFixedSizeCollection createEmptyCollection() {
return new SearchGoogleAdsFieldsFixedSizeCollection(null, 0);
}
@Override
protected SearchGoogleAdsFieldsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new SearchGoogleAdsFieldsFixedSizeCollection(pages, collectionSize);
}
}
}