Class CustomTargetingKeyServiceClient (0.44.0)

Service Description: Provides methods for handling CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   CustomTargetingKeyName name =
       CustomTargetingKeyName.of("[NETWORK_CODE]", "[CUSTOM_TARGETING_KEY]");
   CustomTargetingKey response = customTargetingKeyServiceClient.getCustomTargetingKey(name);
 }

Note: close() needs to be called on the CustomTargetingKeyServiceClient 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
GetCustomTargetingKey	API to retrieve a `CustomTargetingKey` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getCustomTargetingKey(GetCustomTargetingKeyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getCustomTargetingKey(CustomTargetingKeyName name) getCustomTargetingKey(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCustomTargetingKeyCallable()
ListCustomTargetingKeys	API to retrieve a list of `CustomTargetingKey` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listCustomTargetingKeys(ListCustomTargetingKeysRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCustomTargetingKeys(NetworkName parent) listCustomTargetingKeys(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCustomTargetingKeysPagedCallable() listCustomTargetingKeysCallable()
CreateCustomTargetingKey	API to create a `CustomTargetingKey` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createCustomTargetingKey(CreateCustomTargetingKeyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createCustomTargetingKey(NetworkName parent, CustomTargetingKey customTargetingKey) createCustomTargetingKey(String parent, CustomTargetingKey customTargetingKey) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createCustomTargetingKeyCallable()
BatchCreateCustomTargetingKeys	API to batch create `CustomTargetingKey` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchCreateCustomTargetingKeys(NetworkName parent, List<CreateCustomTargetingKeyRequest> requests) batchCreateCustomTargetingKeys(String parent, List<CreateCustomTargetingKeyRequest> requests) batchCreateCustomTargetingKeys(BatchCreateCustomTargetingKeysRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchCreateCustomTargetingKeysCallable()
UpdateCustomTargetingKey	API to update a `CustomTargetingKey` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateCustomTargetingKey(UpdateCustomTargetingKeyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateCustomTargetingKey(CustomTargetingKey customTargetingKey, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateCustomTargetingKeyCallable()
BatchUpdateCustomTargetingKeys	API to batch update `CustomTargetingKey` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchUpdateCustomTargetingKeys(NetworkName parent, List<UpdateCustomTargetingKeyRequest> requests) batchUpdateCustomTargetingKeys(String parent, List<UpdateCustomTargetingKeyRequest> requests) batchUpdateCustomTargetingKeys(BatchUpdateCustomTargetingKeysRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchUpdateCustomTargetingKeysCallable()
BatchActivateCustomTargetingKeys	API to batch activate `CustomTargetingKey` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchActivateCustomTargetingKeys(BatchActivateCustomTargetingKeysRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. batchActivateCustomTargetingKeys(NetworkName parent, List<String> names) batchActivateCustomTargetingKeys(String parent, List<String> names) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchActivateCustomTargetingKeysCallable()
BatchDeactivateCustomTargetingKeys	Deactivates a list of `CustomTargetingKey` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchDeactivateCustomTargetingKeys(BatchDeactivateCustomTargetingKeysRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. batchDeactivateCustomTargetingKeys(NetworkName parent, List<String> names) batchDeactivateCustomTargetingKeys(String parent, List<String> names) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchDeactivateCustomTargetingKeysCallable()

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 CustomTargetingKeyServiceSettings 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
 CustomTargetingKeyServiceSettings customTargetingKeyServiceSettings =
     CustomTargetingKeyServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create(customTargetingKeyServiceSettings);

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
 CustomTargetingKeyServiceSettings customTargetingKeyServiceSettings =
     CustomTargetingKeyServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create(customTargetingKeyServiceSettings);

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

Inheritance

java.lang.Object > CustomTargetingKeyServiceClient

Static Methods

create()

public static final CustomTargetingKeyServiceClient create()

Constructs an instance of CustomTargetingKeyServiceClient with default settings.

Returns
Type	Description
`CustomTargetingKeyServiceClient`

Exceptions
Type	Description
`IOException`

create(CustomTargetingKeyServiceSettings settings)

public static final CustomTargetingKeyServiceClient create(CustomTargetingKeyServiceSettings settings)

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

Parameter
Name	Description
`settings`	`CustomTargetingKeyServiceSettings`

Returns
Type	Description
`CustomTargetingKeyServiceClient`

Exceptions
Type	Description
`IOException`

create(CustomTargetingKeyServiceStub stub)

public static final CustomTargetingKeyServiceClient create(CustomTargetingKeyServiceStub stub)

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

Parameter
Name	Description
`stub`	`CustomTargetingKeyServiceStub`

Returns
Type	Description
`CustomTargetingKeyServiceClient`

Constructors

CustomTargetingKeyServiceClient(CustomTargetingKeyServiceSettings settings)

protected CustomTargetingKeyServiceClient(CustomTargetingKeyServiceSettings settings)

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

Parameter
Name	Description
`settings`	`CustomTargetingKeyServiceSettings`

CustomTargetingKeyServiceClient(CustomTargetingKeyServiceStub stub)

protected CustomTargetingKeyServiceClient(CustomTargetingKeyServiceStub stub)

Parameter
Name	Description
`stub`	`CustomTargetingKeyServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

batchActivateCustomTargetingKeys(BatchActivateCustomTargetingKeysRequest request)

public final BatchActivateCustomTargetingKeysResponse batchActivateCustomTargetingKeys(BatchActivateCustomTargetingKeysRequest request)

API to batch activate CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   BatchActivateCustomTargetingKeysRequest request =
       BatchActivateCustomTargetingKeysRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   BatchActivateCustomTargetingKeysResponse response =
       customTargetingKeyServiceClient.batchActivateCustomTargetingKeys(request);
 }

Parameter
Name	Description
`request`	`BatchActivateCustomTargetingKeysRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BatchActivateCustomTargetingKeysResponse`

batchActivateCustomTargetingKeys(NetworkName parent, List<String> names)

public final BatchActivateCustomTargetingKeysResponse batchActivateCustomTargetingKeys(NetworkName parent, List<String> names)

API to batch activate CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<String> names = new ArrayList<>();
   BatchActivateCustomTargetingKeysResponse response =
       customTargetingKeyServiceClient.batchActivateCustomTargetingKeys(parent, names);
 }

Parameters
Name	Description
`parent`	`NetworkName` Required. Format: `networks/{network_code}`
`names`	`List<String>` Required. The resource names of the `CustomTargetingKey`s to activate. Format: `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`

Returns
Type	Description
`BatchActivateCustomTargetingKeysResponse`

batchActivateCustomTargetingKeys(String parent, List<String> names)

public final BatchActivateCustomTargetingKeysResponse batchActivateCustomTargetingKeys(String parent, List<String> names)

API to batch activate CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<String> names = new ArrayList<>();
   BatchActivateCustomTargetingKeysResponse response =
       customTargetingKeyServiceClient.batchActivateCustomTargetingKeys(parent, names);
 }

Parameters
Name	Description
`parent`	`String` Required. Format: `networks/{network_code}`
`names`	`List<String>` Required. The resource names of the `CustomTargetingKey`s to activate. Format: `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`

Returns
Type	Description
`BatchActivateCustomTargetingKeysResponse`

batchActivateCustomTargetingKeysCallable()

public final UnaryCallable<BatchActivateCustomTargetingKeysRequest,BatchActivateCustomTargetingKeysResponse> batchActivateCustomTargetingKeysCallable()

API to batch activate CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   BatchActivateCustomTargetingKeysRequest request =
       BatchActivateCustomTargetingKeysRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   ApiFuture<BatchActivateCustomTargetingKeysResponse> future =
       customTargetingKeyServiceClient
           .batchActivateCustomTargetingKeysCallable()
           .futureCall(request);
   // Do something.
   BatchActivateCustomTargetingKeysResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchActivateCustomTargetingKeysRequest,BatchActivateCustomTargetingKeysResponse>`

batchCreateCustomTargetingKeys(BatchCreateCustomTargetingKeysRequest request)

public final BatchCreateCustomTargetingKeysResponse batchCreateCustomTargetingKeys(BatchCreateCustomTargetingKeysRequest request)

API to batch create CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   BatchCreateCustomTargetingKeysRequest request =
       BatchCreateCustomTargetingKeysRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<CreateCustomTargetingKeyRequest>())
           .build();
   BatchCreateCustomTargetingKeysResponse response =
       customTargetingKeyServiceClient.batchCreateCustomTargetingKeys(request);
 }

Parameter
Name	Description
`request`	`BatchCreateCustomTargetingKeysRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BatchCreateCustomTargetingKeysResponse`

batchCreateCustomTargetingKeys(NetworkName parent, List<CreateCustomTargetingKeyRequest> requests)

public final BatchCreateCustomTargetingKeysResponse batchCreateCustomTargetingKeys(NetworkName parent, List<CreateCustomTargetingKeyRequest> requests)

API to batch create CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<CreateCustomTargetingKeyRequest> requests = new ArrayList<>();
   BatchCreateCustomTargetingKeysResponse response =
       customTargetingKeyServiceClient.batchCreateCustomTargetingKeys(parent, requests);
 }

Parameters
Name	Description
`parent`	`NetworkName` Required. The parent resource where `CustomTargetingKeys` will be created. Format: `networks/{network_code}` The parent field in the CreateCustomTargetingKeyRequest must match this field.
`requests`	`List<CreateCustomTargetingKeyRequest>` Required. The `CustomTargetingKey` objects to create. A maximum of 100 objects can be created in a batch.

Returns
Type	Description
`BatchCreateCustomTargetingKeysResponse`

batchCreateCustomTargetingKeys(String parent, List<CreateCustomTargetingKeyRequest> requests)

public final BatchCreateCustomTargetingKeysResponse batchCreateCustomTargetingKeys(String parent, List<CreateCustomTargetingKeyRequest> requests)

API to batch create CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<CreateCustomTargetingKeyRequest> requests = new ArrayList<>();
   BatchCreateCustomTargetingKeysResponse response =
       customTargetingKeyServiceClient.batchCreateCustomTargetingKeys(parent, requests);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where `CustomTargetingKeys` will be created. Format: `networks/{network_code}` The parent field in the CreateCustomTargetingKeyRequest must match this field.
`requests`	`List<CreateCustomTargetingKeyRequest>` Required. The `CustomTargetingKey` objects to create. A maximum of 100 objects can be created in a batch.

Returns
Type	Description
`BatchCreateCustomTargetingKeysResponse`

batchCreateCustomTargetingKeysCallable()

public final UnaryCallable<BatchCreateCustomTargetingKeysRequest,BatchCreateCustomTargetingKeysResponse> batchCreateCustomTargetingKeysCallable()

API to batch create CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   BatchCreateCustomTargetingKeysRequest request =
       BatchCreateCustomTargetingKeysRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<CreateCustomTargetingKeyRequest>())
           .build();
   ApiFuture<BatchCreateCustomTargetingKeysResponse> future =
       customTargetingKeyServiceClient
           .batchCreateCustomTargetingKeysCallable()
           .futureCall(request);
   // Do something.
   BatchCreateCustomTargetingKeysResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchCreateCustomTargetingKeysRequest,BatchCreateCustomTargetingKeysResponse>`

batchDeactivateCustomTargetingKeys(BatchDeactivateCustomTargetingKeysRequest request)

public final BatchDeactivateCustomTargetingKeysResponse batchDeactivateCustomTargetingKeys(BatchDeactivateCustomTargetingKeysRequest request)

Deactivates a list of CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   BatchDeactivateCustomTargetingKeysRequest request =
       BatchDeactivateCustomTargetingKeysRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   BatchDeactivateCustomTargetingKeysResponse response =
       customTargetingKeyServiceClient.batchDeactivateCustomTargetingKeys(request);
 }

Parameter
Name	Description
`request`	`BatchDeactivateCustomTargetingKeysRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BatchDeactivateCustomTargetingKeysResponse`

batchDeactivateCustomTargetingKeys(NetworkName parent, List<String> names)

public final BatchDeactivateCustomTargetingKeysResponse batchDeactivateCustomTargetingKeys(NetworkName parent, List<String> names)

Deactivates a list of CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<String> names = new ArrayList<>();
   BatchDeactivateCustomTargetingKeysResponse response =
       customTargetingKeyServiceClient.batchDeactivateCustomTargetingKeys(parent, names);
 }

Parameters
Name	Description
`parent`	`NetworkName` Required. Format: `networks/{network_code}`
`names`	`List<String>` Required. The resource names of the `CustomTargetingKey`s to deactivate. Format: `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`

Returns
Type	Description
`BatchDeactivateCustomTargetingKeysResponse`

batchDeactivateCustomTargetingKeys(String parent, List<String> names)

public final BatchDeactivateCustomTargetingKeysResponse batchDeactivateCustomTargetingKeys(String parent, List<String> names)

Deactivates a list of CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<String> names = new ArrayList<>();
   BatchDeactivateCustomTargetingKeysResponse response =
       customTargetingKeyServiceClient.batchDeactivateCustomTargetingKeys(parent, names);
 }

Parameters
Name	Description
`parent`	`String` Required. Format: `networks/{network_code}`
`names`	`List<String>` Required. The resource names of the `CustomTargetingKey`s to deactivate. Format: `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`

Returns
Type	Description
`BatchDeactivateCustomTargetingKeysResponse`

batchDeactivateCustomTargetingKeysCallable()

public final UnaryCallable<BatchDeactivateCustomTargetingKeysRequest,BatchDeactivateCustomTargetingKeysResponse> batchDeactivateCustomTargetingKeysCallable()

Deactivates a list of CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   BatchDeactivateCustomTargetingKeysRequest request =
       BatchDeactivateCustomTargetingKeysRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   ApiFuture<BatchDeactivateCustomTargetingKeysResponse> future =
       customTargetingKeyServiceClient
           .batchDeactivateCustomTargetingKeysCallable()
           .futureCall(request);
   // Do something.
   BatchDeactivateCustomTargetingKeysResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchDeactivateCustomTargetingKeysRequest,BatchDeactivateCustomTargetingKeysResponse>`

batchUpdateCustomTargetingKeys(BatchUpdateCustomTargetingKeysRequest request)

public final BatchUpdateCustomTargetingKeysResponse batchUpdateCustomTargetingKeys(BatchUpdateCustomTargetingKeysRequest request)

API to batch update CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   BatchUpdateCustomTargetingKeysRequest request =
       BatchUpdateCustomTargetingKeysRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<UpdateCustomTargetingKeyRequest>())
           .build();
   BatchUpdateCustomTargetingKeysResponse response =
       customTargetingKeyServiceClient.batchUpdateCustomTargetingKeys(request);
 }

Parameter
Name	Description
`request`	`BatchUpdateCustomTargetingKeysRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BatchUpdateCustomTargetingKeysResponse`

batchUpdateCustomTargetingKeys(NetworkName parent, List<UpdateCustomTargetingKeyRequest> requests)

public final BatchUpdateCustomTargetingKeysResponse batchUpdateCustomTargetingKeys(NetworkName parent, List<UpdateCustomTargetingKeyRequest> requests)

API to batch update CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<UpdateCustomTargetingKeyRequest> requests = new ArrayList<>();
   BatchUpdateCustomTargetingKeysResponse response =
       customTargetingKeyServiceClient.batchUpdateCustomTargetingKeys(parent, requests);
 }

Parameters
Name	Description
`parent`	`NetworkName` Required. The parent resource where `CustomTargetingKeys` will be updated. Format: `networks/{network_code}` The parent field in the UpdateCustomTargetingKeyRequest must match this field.
`requests`	`List<UpdateCustomTargetingKeyRequest>` Required. The `CustomTargetingKey` objects to update. A maximum of 100 objects can be updated in a batch.

Returns
Type	Description
`BatchUpdateCustomTargetingKeysResponse`

batchUpdateCustomTargetingKeys(String parent, List<UpdateCustomTargetingKeyRequest> requests)

public final BatchUpdateCustomTargetingKeysResponse batchUpdateCustomTargetingKeys(String parent, List<UpdateCustomTargetingKeyRequest> requests)

API to batch update CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<UpdateCustomTargetingKeyRequest> requests = new ArrayList<>();
   BatchUpdateCustomTargetingKeysResponse response =
       customTargetingKeyServiceClient.batchUpdateCustomTargetingKeys(parent, requests);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where `CustomTargetingKeys` will be updated. Format: `networks/{network_code}` The parent field in the UpdateCustomTargetingKeyRequest must match this field.
`requests`	`List<UpdateCustomTargetingKeyRequest>` Required. The `CustomTargetingKey` objects to update. A maximum of 100 objects can be updated in a batch.

Returns
Type	Description
`BatchUpdateCustomTargetingKeysResponse`

batchUpdateCustomTargetingKeysCallable()

public final UnaryCallable<BatchUpdateCustomTargetingKeysRequest,BatchUpdateCustomTargetingKeysResponse> batchUpdateCustomTargetingKeysCallable()

API to batch update CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   BatchUpdateCustomTargetingKeysRequest request =
       BatchUpdateCustomTargetingKeysRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<UpdateCustomTargetingKeyRequest>())
           .build();
   ApiFuture<BatchUpdateCustomTargetingKeysResponse> future =
       customTargetingKeyServiceClient
           .batchUpdateCustomTargetingKeysCallable()
           .futureCall(request);
   // Do something.
   BatchUpdateCustomTargetingKeysResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchUpdateCustomTargetingKeysRequest,BatchUpdateCustomTargetingKeysResponse>`

close()

public final void close()

createCustomTargetingKey(CreateCustomTargetingKeyRequest request)

public final CustomTargetingKey createCustomTargetingKey(CreateCustomTargetingKeyRequest request)

API to create a CustomTargetingKey object.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   CreateCustomTargetingKeyRequest request =
       CreateCustomTargetingKeyRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setCustomTargetingKey(CustomTargetingKey.newBuilder().build())
           .build();
   CustomTargetingKey response =
       customTargetingKeyServiceClient.createCustomTargetingKey(request);
 }

Parameter
Name	Description
`request`	`CreateCustomTargetingKeyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CustomTargetingKey`

createCustomTargetingKey(NetworkName parent, CustomTargetingKey customTargetingKey)

public final CustomTargetingKey createCustomTargetingKey(NetworkName parent, CustomTargetingKey customTargetingKey)

API to create a CustomTargetingKey object.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   CustomTargetingKey customTargetingKey = CustomTargetingKey.newBuilder().build();
   CustomTargetingKey response =
       customTargetingKeyServiceClient.createCustomTargetingKey(parent, customTargetingKey);
 }

Parameters
Name	Description
`parent`	`NetworkName` Required. The parent resource where this `CustomTargetingKey` will be created. Format: `networks/{network_code}`
`customTargetingKey`	`CustomTargetingKey` Required. The `CustomTargetingKey` to create.

Returns
Type	Description
`CustomTargetingKey`

createCustomTargetingKey(String parent, CustomTargetingKey customTargetingKey)

public final CustomTargetingKey createCustomTargetingKey(String parent, CustomTargetingKey customTargetingKey)

API to create a CustomTargetingKey object.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   CustomTargetingKey customTargetingKey = CustomTargetingKey.newBuilder().build();
   CustomTargetingKey response =
       customTargetingKeyServiceClient.createCustomTargetingKey(parent, customTargetingKey);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource where this `CustomTargetingKey` will be created. Format: `networks/{network_code}`
`customTargetingKey`	`CustomTargetingKey` Required. The `CustomTargetingKey` to create.

Returns
Type	Description
`CustomTargetingKey`

createCustomTargetingKeyCallable()

public final UnaryCallable<CreateCustomTargetingKeyRequest,CustomTargetingKey> createCustomTargetingKeyCallable()

API to create a CustomTargetingKey object.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   CreateCustomTargetingKeyRequest request =
       CreateCustomTargetingKeyRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setCustomTargetingKey(CustomTargetingKey.newBuilder().build())
           .build();
   ApiFuture<CustomTargetingKey> future =
       customTargetingKeyServiceClient.createCustomTargetingKeyCallable().futureCall(request);
   // Do something.
   CustomTargetingKey response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateCustomTargetingKeyRequest,CustomTargetingKey>`

getCustomTargetingKey(CustomTargetingKeyName name)

public final CustomTargetingKey getCustomTargetingKey(CustomTargetingKeyName name)

API to retrieve a CustomTargetingKey object.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   CustomTargetingKeyName name =
       CustomTargetingKeyName.of("[NETWORK_CODE]", "[CUSTOM_TARGETING_KEY]");
   CustomTargetingKey response = customTargetingKeyServiceClient.getCustomTargetingKey(name);
 }

Parameter
Name	Description
`name`	`CustomTargetingKeyName` Required. The resource name of the CustomTargetingKey. Format: `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`

Returns
Type	Description
`CustomTargetingKey`

getCustomTargetingKey(GetCustomTargetingKeyRequest request)

public final CustomTargetingKey getCustomTargetingKey(GetCustomTargetingKeyRequest request)

API to retrieve a CustomTargetingKey object.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   GetCustomTargetingKeyRequest request =
       GetCustomTargetingKeyRequest.newBuilder()
           .setName(
               CustomTargetingKeyName.of("[NETWORK_CODE]", "[CUSTOM_TARGETING_KEY]").toString())
           .build();
   CustomTargetingKey response = customTargetingKeyServiceClient.getCustomTargetingKey(request);
 }

Parameter
Name	Description
`request`	`GetCustomTargetingKeyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CustomTargetingKey`

getCustomTargetingKey(String name)

public final CustomTargetingKey getCustomTargetingKey(String name)

API to retrieve a CustomTargetingKey object.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   String name =
       CustomTargetingKeyName.of("[NETWORK_CODE]", "[CUSTOM_TARGETING_KEY]").toString();
   CustomTargetingKey response = customTargetingKeyServiceClient.getCustomTargetingKey(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the CustomTargetingKey. Format: `networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}`

Returns
Type	Description
`CustomTargetingKey`

getCustomTargetingKeyCallable()

public final UnaryCallable<GetCustomTargetingKeyRequest,CustomTargetingKey> getCustomTargetingKeyCallable()

API to retrieve a CustomTargetingKey object.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   GetCustomTargetingKeyRequest request =
       GetCustomTargetingKeyRequest.newBuilder()
           .setName(
               CustomTargetingKeyName.of("[NETWORK_CODE]", "[CUSTOM_TARGETING_KEY]").toString())
           .build();
   ApiFuture<CustomTargetingKey> future =
       customTargetingKeyServiceClient.getCustomTargetingKeyCallable().futureCall(request);
   // Do something.
   CustomTargetingKey response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetCustomTargetingKeyRequest,CustomTargetingKey>`

getSettings()

public final CustomTargetingKeyServiceSettings getSettings()

Returns
Type	Description
`CustomTargetingKeyServiceSettings`

getStub()

public CustomTargetingKeyServiceStub getStub()

Returns
Type	Description
`CustomTargetingKeyServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listCustomTargetingKeys(ListCustomTargetingKeysRequest request)

public final CustomTargetingKeyServiceClient.ListCustomTargetingKeysPagedResponse listCustomTargetingKeys(ListCustomTargetingKeysRequest request)

API to retrieve a list of CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   ListCustomTargetingKeysRequest request =
       ListCustomTargetingKeysRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (CustomTargetingKey element :
       customTargetingKeyServiceClient.listCustomTargetingKeys(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListCustomTargetingKeysRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CustomTargetingKeyServiceClient.ListCustomTargetingKeysPagedResponse`

listCustomTargetingKeys(NetworkName parent)

public final CustomTargetingKeyServiceClient.ListCustomTargetingKeysPagedResponse listCustomTargetingKeys(NetworkName parent)

API to retrieve a list of CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (CustomTargetingKey element :
       customTargetingKeyServiceClient.listCustomTargetingKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`NetworkName` Required. The parent, which owns this collection of CustomTargetingKeys. Format: `networks/{network_code}`

Returns
Type	Description
`CustomTargetingKeyServiceClient.ListCustomTargetingKeysPagedResponse`

listCustomTargetingKeys(String parent)

public final CustomTargetingKeyServiceClient.ListCustomTargetingKeysPagedResponse listCustomTargetingKeys(String parent)

API to retrieve a list of CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (CustomTargetingKey element :
       customTargetingKeyServiceClient.listCustomTargetingKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of CustomTargetingKeys. Format: `networks/{network_code}`

Returns
Type	Description
`CustomTargetingKeyServiceClient.ListCustomTargetingKeysPagedResponse`

listCustomTargetingKeysCallable()

public final UnaryCallable<ListCustomTargetingKeysRequest,ListCustomTargetingKeysResponse> listCustomTargetingKeysCallable()

API to retrieve a list of CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   ListCustomTargetingKeysRequest request =
       ListCustomTargetingKeysRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListCustomTargetingKeysResponse response =
         customTargetingKeyServiceClient.listCustomTargetingKeysCallable().call(request);
     for (CustomTargetingKey element : response.getCustomTargetingKeysList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListCustomTargetingKeysRequest,ListCustomTargetingKeysResponse>`

listCustomTargetingKeysPagedCallable()

public final UnaryCallable<ListCustomTargetingKeysRequest,CustomTargetingKeyServiceClient.ListCustomTargetingKeysPagedResponse> listCustomTargetingKeysPagedCallable()

API to retrieve a list of CustomTargetingKey objects.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   ListCustomTargetingKeysRequest request =
       ListCustomTargetingKeysRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<CustomTargetingKey> future =
       customTargetingKeyServiceClient
           .listCustomTargetingKeysPagedCallable()
           .futureCall(request);
   // Do something.
   for (CustomTargetingKey element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListCustomTargetingKeysRequest,ListCustomTargetingKeysPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateCustomTargetingKey(CustomTargetingKey customTargetingKey, FieldMask updateMask)

public final CustomTargetingKey updateCustomTargetingKey(CustomTargetingKey customTargetingKey, FieldMask updateMask)

API to update a CustomTargetingKey object.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   CustomTargetingKey customTargetingKey = CustomTargetingKey.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CustomTargetingKey response =
       customTargetingKeyServiceClient.updateCustomTargetingKey(customTargetingKey, updateMask);
 }

Parameters

Name Description

customTargetingKey

CustomTargetingKey

Required. The CustomTargetingKey to update.

The CustomTargetingKey's name is used to identify the CustomTargetingKey to update.

updateMask

FieldMask

Required. The list of fields to update.

Returns
Type	Description
`CustomTargetingKey`

updateCustomTargetingKey(UpdateCustomTargetingKeyRequest request)

public final CustomTargetingKey updateCustomTargetingKey(UpdateCustomTargetingKeyRequest request)

API to update a CustomTargetingKey object.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   UpdateCustomTargetingKeyRequest request =
       UpdateCustomTargetingKeyRequest.newBuilder()
           .setCustomTargetingKey(CustomTargetingKey.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   CustomTargetingKey response =
       customTargetingKeyServiceClient.updateCustomTargetingKey(request);
 }

Parameter
Name	Description
`request`	`UpdateCustomTargetingKeyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CustomTargetingKey`

updateCustomTargetingKeyCallable()

public final UnaryCallable<UpdateCustomTargetingKeyRequest,CustomTargetingKey> updateCustomTargetingKeyCallable()

API to update a CustomTargetingKey object.

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 (CustomTargetingKeyServiceClient customTargetingKeyServiceClient =
     CustomTargetingKeyServiceClient.create()) {
   UpdateCustomTargetingKeyRequest request =
       UpdateCustomTargetingKeyRequest.newBuilder()
           .setCustomTargetingKey(CustomTargetingKey.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<CustomTargetingKey> future =
       customTargetingKeyServiceClient.updateCustomTargetingKeyCallable().futureCall(request);
   // Do something.
   CustomTargetingKey response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateCustomTargetingKeyRequest,CustomTargetingKey>`

Class CustomTargetingKeyServiceClient (0.44.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(CustomTargetingKeyServiceSettings settings)

create(CustomTargetingKeyServiceStub stub)

Constructors

CustomTargetingKeyServiceClient(CustomTargetingKeyServiceSettings settings)

CustomTargetingKeyServiceClient(CustomTargetingKeyServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

batchActivateCustomTargetingKeys(BatchActivateCustomTargetingKeysRequest request)

batchActivateCustomTargetingKeys(NetworkName parent, List<String> names)

batchActivateCustomTargetingKeys(String parent, List<String> names)

batchActivateCustomTargetingKeysCallable()

batchCreateCustomTargetingKeys(BatchCreateCustomTargetingKeysRequest request)

batchCreateCustomTargetingKeys(NetworkName parent, List<CreateCustomTargetingKeyRequest> requests)

batchCreateCustomTargetingKeys(String parent, List<CreateCustomTargetingKeyRequest> requests)

batchCreateCustomTargetingKeysCallable()

batchDeactivateCustomTargetingKeys(BatchDeactivateCustomTargetingKeysRequest request)

batchDeactivateCustomTargetingKeys(NetworkName parent, List<String> names)

batchDeactivateCustomTargetingKeys(String parent, List<String> names)

batchDeactivateCustomTargetingKeysCallable()

batchUpdateCustomTargetingKeys(BatchUpdateCustomTargetingKeysRequest request)

batchUpdateCustomTargetingKeys(NetworkName parent, List<UpdateCustomTargetingKeyRequest> requests)

batchUpdateCustomTargetingKeys(String parent, List<UpdateCustomTargetingKeyRequest> requests)

batchUpdateCustomTargetingKeysCallable()

close()

createCustomTargetingKey(CreateCustomTargetingKeyRequest request)

createCustomTargetingKey(NetworkName parent, CustomTargetingKey customTargetingKey)

createCustomTargetingKey(String parent, CustomTargetingKey customTargetingKey)

createCustomTargetingKeyCallable()

getCustomTargetingKey(CustomTargetingKeyName name)

getCustomTargetingKey(GetCustomTargetingKeyRequest request)

getCustomTargetingKey(String name)

getCustomTargetingKeyCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listCustomTargetingKeys(ListCustomTargetingKeysRequest request)

listCustomTargetingKeys(NetworkName parent)

listCustomTargetingKeys(String parent)

listCustomTargetingKeysCallable()

listCustomTargetingKeysPagedCallable()

shutdown()

shutdownNow()

updateCustomTargetingKey(CustomTargetingKey customTargetingKey, FieldMask updateMask)

updateCustomTargetingKey(UpdateCustomTargetingKeyRequest request)

updateCustomTargetingKeyCallable()

Class CustomTargetingKeyServiceClient (0.44.0)