Class AssetServiceClient
- java.lang.Object
-
- com.google.ads.googleads.v10.services.AssetServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource,java.lang.AutoCloseable
@Generated("by gapic-generator-java") public class AssetServiceClient extends java.lang.Object implements com.google.api.gax.core.BackgroundResourceService Description: Service to manage assets. Asset types can be created with AssetService are YoutubeVideoAsset, MediaBundleAsset and ImageAsset. TextAsset should be created with Ad inline.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:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) { String customerId = "customerId-1581184615"; List<AssetOperation> operations = new ArrayList<>(); MutateAssetsResponse response = assetServiceClient.mutateAssets(customerId, operations); }Note: close() needs to be called on the AssetServiceClient 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 AssetServiceSettings to create(). For example:
To customize credentials:
AssetServiceSettings assetServiceSettings = AssetServiceSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);To customize the endpoint:
AssetServiceSettings assetServiceSettings = AssetServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAssetServiceClient(AssetServiceSettings settings)Constructs an instance of AssetServiceClient, using the given settings.protectedAssetServiceClient(AssetServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanawaitTermination(long duration, java.util.concurrent.TimeUnit unit)voidclose()static AssetServiceClientcreate()Constructs an instance of AssetServiceClient with default settings.static AssetServiceClientcreate(AssetServiceSettings settings)Constructs an instance of AssetServiceClient, using the given settings.static AssetServiceClientcreate(AssetServiceStub stub)Constructs an instance of AssetServiceClient, using the given stub for making calls.AssetServiceSettingsgetSettings()AssetServiceStubgetStub()booleanisShutdown()booleanisTerminated()MutateAssetsResponsemutateAssets(MutateAssetsRequest request)Creates assets.MutateAssetsResponsemutateAssets(java.lang.String customerId, java.util.List<AssetOperation> operations)Creates assets.com.google.api.gax.rpc.UnaryCallable<MutateAssetsRequest,MutateAssetsResponse>mutateAssetsCallable()Creates assets.voidshutdown()voidshutdownNow()
-
-
-
Constructor Detail
-
AssetServiceClient
protected AssetServiceClient(AssetServiceSettings settings) throws java.io.IOException
Constructs an instance of AssetServiceClient, 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:
java.io.IOException
-
AssetServiceClient
@BetaApi("A restructuring of stub classes is planned, so this may break in the future") protected AssetServiceClient(AssetServiceStub stub)
-
-
Method Detail
-
create
public static final AssetServiceClient create() throws java.io.IOException
Constructs an instance of AssetServiceClient with default settings.- Throws:
java.io.IOException
-
create
public static final AssetServiceClient create(AssetServiceSettings settings) throws java.io.IOException
Constructs an instance of AssetServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.- Throws:
java.io.IOException
-
create
@BetaApi("A restructuring of stub classes is planned, so this may break in the future") public static final AssetServiceClient create(AssetServiceStub stub)Constructs an instance of AssetServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AssetServiceSettings).
-
getSettings
public final AssetServiceSettings getSettings()
-
getStub
@BetaApi("A restructuring of stub classes is planned, so this may break in the future") public AssetServiceStub getStub()
-
mutateAssets
public final MutateAssetsResponse mutateAssets(java.lang.String customerId, java.util.List<AssetOperation> operations)
Creates assets. Operation statuses are returned.List of thrown errors: [AssetError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [CurrencyCodeError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MediaUploadError]() [MutateError]() [NotAllowlistedError]() [NotEmptyError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]() [YoutubeVideoRegistrationError]()
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) { String customerId = "customerId-1581184615"; List<AssetOperation> operations = new ArrayList<>(); MutateAssetsResponse response = assetServiceClient.mutateAssets(customerId, operations); }- Parameters:
customerId- Required. The ID of the customer whose assets are being modified.operations- Required. The list of operations to perform on individual assets.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
mutateAssets
public final MutateAssetsResponse mutateAssets(MutateAssetsRequest request)
Creates assets. Operation statuses are returned.List of thrown errors: [AssetError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [CurrencyCodeError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MediaUploadError]() [MutateError]() [NotAllowlistedError]() [NotEmptyError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]() [YoutubeVideoRegistrationError]()
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) { MutateAssetsRequest request = MutateAssetsRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<AssetOperation>()) .setPartialFailure(true) .setValidateOnly(true) .build(); MutateAssetsResponse response = assetServiceClient.mutateAssets(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
-
mutateAssetsCallable
public final com.google.api.gax.rpc.UnaryCallable<MutateAssetsRequest,MutateAssetsResponse> mutateAssetsCallable()
Creates assets. Operation statuses are returned.List of thrown errors: [AssetError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [CurrencyCodeError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MediaUploadError]() [MutateError]() [NotAllowlistedError]() [NotEmptyError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]() [YoutubeVideoRegistrationError]()
Sample code:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) { MutateAssetsRequest request = MutateAssetsRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<AssetOperation>()) .setPartialFailure(true) .setValidateOnly(true) .build(); ApiFuture<MutateAssetsResponse> future = assetServiceClient.mutateAssetsCallable().futureCall(request); // Do something. MutateAssetsResponse response = future.get(); }
-
close
public final void close()
- Specified by:
closein interfacejava.lang.AutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdownin interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdownin interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminatedin interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNowin interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException- Specified by:
awaitTerminationin interfacecom.google.api.gax.core.BackgroundResource- Throws:
java.lang.InterruptedException
-
-