Package com.google.ads.googleads.v18.services

Class AdGroupAdServiceClient

java.lang.Object

com.google.ads.googleads.v18.services.AdGroupAdServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated("by gapic-generator-java")
public class AdGroupAdServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service to manage ads in an ad group.

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:

 // 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 (AdGroupAdServiceClient adGroupAdServiceClient = AdGroupAdServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<AdGroupAdOperation> operations = new ArrayList<>();
   MutateAdGroupAdsResponse response =
       adGroupAdServiceClient.mutateAdGroupAds(customerId, operations);
 }
 

Note: close() needs to be called on the AdGroupAdServiceClient 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
MutateAdGroupAds	Creates, updates, or removes ads. Operation statuses are returned. List of thrown errors: [AdCustomizerError]() [AdError]() [AdGroupAdError]() [AdSharingError]() [AdxError]() [AssetError]() [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [ContextError]() [DatabaseError]() [DateError]() [DistinctError]() [FeedAttributeReferenceError]() [FieldError]() [FieldMaskError]() [FunctionError]() [FunctionParsingError]() [HeaderError]() [IdError]() [ImageError]() [InternalError]() [ListOperationError]() [MediaBundleError]() [MediaFileError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [PolicyFindingError]() [PolicyValidationParameterError]() [PolicyViolationError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()	Request object method variants only take one parameter, a request object, which must be constructed before the call. mutateAdGroupAds(MutateAdGroupAdsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. mutateAdGroupAds(String customerId, List<AdGroupAdOperation> operations) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. mutateAdGroupAdsCallable()
RemoveAutomaticallyCreatedAssets	Remove automatically created assets from an ad. List of thrown errors: [AdError]() [AuthenticationError]() [AuthorizationError]() [AutomaticallyCreatedAssetRemovalError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()	Request object method variants only take one parameter, a request object, which must be constructed before the call. removeAutomaticallyCreatedAssets(RemoveAutomaticallyCreatedAssetsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. removeAutomaticallyCreatedAssets(AdGroupAdName adGroupAd, List<AssetsWithFieldType> assetsWithFieldType) removeAutomaticallyCreatedAssets(String adGroupAd, List<AssetsWithFieldType> assetsWithFieldType) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeAutomaticallyCreatedAssetsCallable()

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 AdGroupAdServiceSettings to create(). For example:

To customize credentials:

 // 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
 AdGroupAdServiceSettings adGroupAdServiceSettings =
     AdGroupAdServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AdGroupAdServiceClient adGroupAdServiceClient =
     AdGroupAdServiceClient.create(adGroupAdServiceSettings);
 

To customize the endpoint:

 // 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
 AdGroupAdServiceSettings adGroupAdServiceSettings =
     AdGroupAdServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AdGroupAdServiceClient adGroupAdServiceClient =
     AdGroupAdServiceClient.create(adGroupAdServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AdGroupAdServiceClient(AdGroupAdServiceSettings settings)	Constructs an instance of AdGroupAdServiceClient, using the given settings.
protected	AdGroupAdServiceClient(AdGroupAdServiceStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, TimeUnit unit)
final void	close()
static final AdGroupAdServiceClient	create()	Constructs an instance of AdGroupAdServiceClient with default settings.
static final AdGroupAdServiceClient	create(AdGroupAdServiceSettings settings)	Constructs an instance of AdGroupAdServiceClient, using the given settings.
static final AdGroupAdServiceClient	create(AdGroupAdServiceStub stub)	Constructs an instance of AdGroupAdServiceClient, using the given stub for making calls.
final AdGroupAdServiceSettings	getSettings()
AdGroupAdServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
final MutateAdGroupAdsResponse	mutateAdGroupAds(MutateAdGroupAdsRequest request)	Creates, updates, or removes ads.
final MutateAdGroupAdsResponse	mutateAdGroupAds(String customerId, List<AdGroupAdOperation> operations)	Creates, updates, or removes ads.
final com.google.api.gax.rpc.UnaryCallable<MutateAdGroupAdsRequest,MutateAdGroupAdsResponse>	mutateAdGroupAdsCallable()	Creates, updates, or removes ads.
final void	removeAutomaticallyCreatedAssets(AdGroupAdName adGroupAd, List<AssetsWithFieldType> assetsWithFieldType)	Remove automatically created assets from an ad.
final void	removeAutomaticallyCreatedAssets(RemoveAutomaticallyCreatedAssetsRequest request)	Remove automatically created assets from an ad.
final void	removeAutomaticallyCreatedAssets(String adGroupAd, List<AssetsWithFieldType> assetsWithFieldType)	Remove automatically created assets from an ad.
final com.google.api.gax.rpc.UnaryCallable<RemoveAutomaticallyCreatedAssetsRequest,com.google.protobuf.Empty>	removeAutomaticallyCreatedAssetsCallable()	Remove automatically created assets from an ad.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AdGroupAdServiceClient

protected AdGroupAdServiceClient(AdGroupAdServiceSettings settings)
                          throws IOException

Constructs an instance of AdGroupAdServiceClient, 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.

Throws:

IOException

AdGroupAdServiceClient

protected AdGroupAdServiceClient(AdGroupAdServiceStub stub)

Method Details

create

public static final AdGroupAdServiceClient create()
                                           throws IOException

Constructs an instance of AdGroupAdServiceClient with default settings.

Throws:

IOException

create

public static final AdGroupAdServiceClient create(AdGroupAdServiceSettings settings)
                                           throws IOException

Constructs an instance of AdGroupAdServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

public static final AdGroupAdServiceClient create(AdGroupAdServiceStub stub)

Constructs an instance of AdGroupAdServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AdGroupAdServiceSettings).

getSettings

public final AdGroupAdServiceSettings getSettings()

getStub

public AdGroupAdServiceStub getStub()

mutateAdGroupAds

public final MutateAdGroupAdsResponse mutateAdGroupAds(String customerId,
 List<AdGroupAdOperation> operations)

Creates, updates, or removes ads. Operation statuses are returned.

List of thrown errors: [AdCustomizerError]() [AdError]() [AdGroupAdError]() [AdSharingError]() [AdxError]() [AssetError]() [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [ContextError]() [DatabaseError]() [DateError]() [DistinctError]() [FeedAttributeReferenceError]() [FieldError]() [FieldMaskError]() [FunctionError]() [FunctionParsingError]() [HeaderError]() [IdError]() [ImageError]() [InternalError]() [ListOperationError]() [MediaBundleError]() [MediaFileError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [PolicyFindingError]() [PolicyValidationParameterError]() [PolicyViolationError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()

Sample 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 (AdGroupAdServiceClient adGroupAdServiceClient = AdGroupAdServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<AdGroupAdOperation> operations = new ArrayList<>();
   MutateAdGroupAdsResponse response =
       adGroupAdServiceClient.mutateAdGroupAds(customerId, operations);
 }
 

Parameters:

customerId - Required. The ID of the customer whose ads are being modified.

operations - Required. The list of operations to perform on individual ads.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

mutateAdGroupAds

public final MutateAdGroupAdsResponse mutateAdGroupAds(MutateAdGroupAdsRequest request)

Creates, updates, or removes ads. Operation statuses are returned.

List of thrown errors: [AdCustomizerError]() [AdError]() [AdGroupAdError]() [AdSharingError]() [AdxError]() [AssetError]() [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [ContextError]() [DatabaseError]() [DateError]() [DistinctError]() [FeedAttributeReferenceError]() [FieldError]() [FieldMaskError]() [FunctionError]() [FunctionParsingError]() [HeaderError]() [IdError]() [ImageError]() [InternalError]() [ListOperationError]() [MediaBundleError]() [MediaFileError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [PolicyFindingError]() [PolicyValidationParameterError]() [PolicyViolationError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()

Sample 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 (AdGroupAdServiceClient adGroupAdServiceClient = AdGroupAdServiceClient.create()) {
   MutateAdGroupAdsRequest request =
       MutateAdGroupAdsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<AdGroupAdOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateAdGroupAdsResponse response = adGroupAdServiceClient.mutateAdGroupAds(request);
 }
 

Parameters:

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

mutateAdGroupAdsCallable

public final com.google.api.gax.rpc.UnaryCallable<MutateAdGroupAdsRequest,MutateAdGroupAdsResponse> mutateAdGroupAdsCallable()

Creates, updates, or removes ads. Operation statuses are returned.

List of thrown errors: [AdCustomizerError]() [AdError]() [AdGroupAdError]() [AdSharingError]() [AdxError]() [AssetError]() [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [ContextError]() [DatabaseError]() [DateError]() [DistinctError]() [FeedAttributeReferenceError]() [FieldError]() [FieldMaskError]() [FunctionError]() [FunctionParsingError]() [HeaderError]() [IdError]() [ImageError]() [InternalError]() [ListOperationError]() [MediaBundleError]() [MediaFileError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [PolicyFindingError]() [PolicyValidationParameterError]() [PolicyViolationError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()

Sample 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 (AdGroupAdServiceClient adGroupAdServiceClient = AdGroupAdServiceClient.create()) {
   MutateAdGroupAdsRequest request =
       MutateAdGroupAdsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<AdGroupAdOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateAdGroupAdsResponse> future =
       adGroupAdServiceClient.mutateAdGroupAdsCallable().futureCall(request);
   // Do something.
   MutateAdGroupAdsResponse response = future.get();
 }
 

removeAutomaticallyCreatedAssets

public final void removeAutomaticallyCreatedAssets(AdGroupAdName adGroupAd,
 List<AssetsWithFieldType> assetsWithFieldType)

Remove automatically created assets from an ad.

List of thrown errors: [AdError]() [AuthenticationError]() [AuthorizationError]() [AutomaticallyCreatedAssetRemovalError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

Sample 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 (AdGroupAdServiceClient adGroupAdServiceClient = AdGroupAdServiceClient.create()) {
   AdGroupAdName adGroupAd = AdGroupAdName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[AD_ID]");
   List<AssetsWithFieldType> assetsWithFieldType = new ArrayList<>();
   adGroupAdServiceClient.removeAutomaticallyCreatedAssets(adGroupAd, assetsWithFieldType);
 }
 

Parameters:

adGroupAd - Required. The resource name of the AdGroupAd from which to remove automatically created assets.

assetsWithFieldType - Required. List of assets with field type to be removed from the AdGroupAd.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

removeAutomaticallyCreatedAssets

public final void removeAutomaticallyCreatedAssets(String adGroupAd,
 List<AssetsWithFieldType> assetsWithFieldType)

Remove automatically created assets from an ad.

List of thrown errors: [AdError]() [AuthenticationError]() [AuthorizationError]() [AutomaticallyCreatedAssetRemovalError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

Sample 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 (AdGroupAdServiceClient adGroupAdServiceClient = AdGroupAdServiceClient.create()) {
   String adGroupAd = AdGroupAdName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[AD_ID]").toString();
   List<AssetsWithFieldType> assetsWithFieldType = new ArrayList<>();
   adGroupAdServiceClient.removeAutomaticallyCreatedAssets(adGroupAd, assetsWithFieldType);
 }
 

Parameters:

adGroupAd - Required. The resource name of the AdGroupAd from which to remove automatically created assets.

assetsWithFieldType - Required. List of assets with field type to be removed from the AdGroupAd.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

removeAutomaticallyCreatedAssets

public final void removeAutomaticallyCreatedAssets(RemoveAutomaticallyCreatedAssetsRequest request)

Remove automatically created assets from an ad.

List of thrown errors: [AdError]() [AuthenticationError]() [AuthorizationError]() [AutomaticallyCreatedAssetRemovalError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

Sample 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 (AdGroupAdServiceClient adGroupAdServiceClient = AdGroupAdServiceClient.create()) {
   RemoveAutomaticallyCreatedAssetsRequest request =
       RemoveAutomaticallyCreatedAssetsRequest.newBuilder()
           .setAdGroupAd(
               AdGroupAdName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[AD_ID]").toString())
           .addAllAssetsWithFieldType(new ArrayList<AssetsWithFieldType>())
           .build();
   adGroupAdServiceClient.removeAutomaticallyCreatedAssets(request);
 }
 

Parameters:

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

removeAutomaticallyCreatedAssetsCallable

public final com.google.api.gax.rpc.UnaryCallable<RemoveAutomaticallyCreatedAssetsRequest,com.google.protobuf.Empty> removeAutomaticallyCreatedAssetsCallable()

Remove automatically created assets from an ad.

List of thrown errors: [AdError]() [AuthenticationError]() [AuthorizationError]() [AutomaticallyCreatedAssetRemovalError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

Sample 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 (AdGroupAdServiceClient adGroupAdServiceClient = AdGroupAdServiceClient.create()) {
   RemoveAutomaticallyCreatedAssetsRequest request =
       RemoveAutomaticallyCreatedAssetsRequest.newBuilder()
           .setAdGroupAd(
               AdGroupAdName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[AD_ID]").toString())
           .addAllAssetsWithFieldType(new ArrayList<AssetsWithFieldType>())
           .build();
   ApiFuture<Empty> future =
       adGroupAdServiceClient.removeAutomaticallyCreatedAssetsCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
 TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException