Class CustomFieldServiceClient (0.54.0)

Service Description: Provides methods for handling CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   CustomFieldName name = CustomFieldName.of("[NETWORK_CODE]", "[CUSTOM_FIELD]");
   CustomField response = customFieldServiceClient.getCustomField(name);
 }

Note: close() needs to be called on the CustomFieldServiceClient 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
GetCustomField	Retrieves a `CustomField` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getCustomField(GetCustomFieldRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getCustomField(CustomFieldName name) getCustomField(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. getCustomFieldCallable()
ListCustomFields	Lists `CustomField` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listCustomFields(ListCustomFieldsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCustomFields(NetworkName parent) listCustomFields(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. listCustomFieldsPagedCallable() listCustomFieldsCallable()
CreateCustomField	Creates a `CustomField` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createCustomField(CreateCustomFieldRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createCustomField(NetworkName parent, CustomField customField) createCustomField(String parent, CustomField customField) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createCustomFieldCallable()
BatchCreateCustomFields	Creates `CustomField` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchCreateCustomFields(NetworkName parent, List<CreateCustomFieldRequest> requests) batchCreateCustomFields(String parent, List<CreateCustomFieldRequest> requests) batchCreateCustomFields(BatchCreateCustomFieldsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchCreateCustomFieldsCallable()
UpdateCustomField	Updates a `CustomField` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateCustomField(UpdateCustomFieldRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateCustomField(CustomField customField, 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. updateCustomFieldCallable()
BatchUpdateCustomFields	Batch updates `CustomField` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchUpdateCustomFields(NetworkName parent, List<UpdateCustomFieldRequest> requests) batchUpdateCustomFields(String parent, List<UpdateCustomFieldRequest> requests) batchUpdateCustomFields(BatchUpdateCustomFieldsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchUpdateCustomFieldsCallable()
BatchActivateCustomFields	Activates a list of `CustomField` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchActivateCustomFields(BatchActivateCustomFieldsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. batchActivateCustomFields(NetworkName parent, List<String> names) batchActivateCustomFields(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. batchActivateCustomFieldsCallable()
BatchDeactivateCustomFields	Deactivates a list of `CustomField` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchDeactivateCustomFields(BatchDeactivateCustomFieldsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. batchDeactivateCustomFields(NetworkName parent, List<String> names) batchDeactivateCustomFields(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. batchDeactivateCustomFieldsCallable()

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 CustomFieldServiceSettings 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
 CustomFieldServiceSettings customFieldServiceSettings =
     CustomFieldServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CustomFieldServiceClient customFieldServiceClient =
     CustomFieldServiceClient.create(customFieldServiceSettings);

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
 CustomFieldServiceSettings customFieldServiceSettings =
     CustomFieldServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CustomFieldServiceClient customFieldServiceClient =
     CustomFieldServiceClient.create(customFieldServiceSettings);

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

Inheritance

java.lang.Object > CustomFieldServiceClient

Static Methods

create()

public static final CustomFieldServiceClient create()

Constructs an instance of CustomFieldServiceClient with default settings.

Returns
Type	Description
`CustomFieldServiceClient`

Exceptions
Type	Description
`IOException`

create(CustomFieldServiceSettings settings)

public static final CustomFieldServiceClient create(CustomFieldServiceSettings settings)

Constructs an instance of CustomFieldServiceClient, 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`	`CustomFieldServiceSettings`

Returns
Type	Description
`CustomFieldServiceClient`

Exceptions
Type	Description
`IOException`

create(CustomFieldServiceStub stub)

public static final CustomFieldServiceClient create(CustomFieldServiceStub stub)

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

Parameter
Name	Description
`stub`	`CustomFieldServiceStub`

Returns
Type	Description
`CustomFieldServiceClient`

Constructors

CustomFieldServiceClient(CustomFieldServiceSettings settings)

protected CustomFieldServiceClient(CustomFieldServiceSettings settings)

Constructs an instance of CustomFieldServiceClient, 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`	`CustomFieldServiceSettings`

CustomFieldServiceClient(CustomFieldServiceStub stub)

protected CustomFieldServiceClient(CustomFieldServiceStub stub)

Parameter
Name	Description
`stub`	`CustomFieldServiceStub`

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`

batchActivateCustomFields(@Nullable NetworkName parent, List<String> names)

public final BatchActivateCustomFieldsResponse batchActivateCustomFields(@Nullable NetworkName parent, List<String> names)

Activates a list of CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<String> names = new ArrayList<>();
   BatchActivateCustomFieldsResponse response =
       customFieldServiceClient.batchActivateCustomFields(parent, names);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. Format: `networks/{network_code}`
`names`	`List<String>` Required. The resource names of the `CustomField` objects to activate. Format: `networks/{network_code}/customFields/{custom_field_id}`

Returns
Type	Description
`BatchActivateCustomFieldsResponse`

batchActivateCustomFields(BatchActivateCustomFieldsRequest request)

public final BatchActivateCustomFieldsResponse batchActivateCustomFields(BatchActivateCustomFieldsRequest request)

Activates a list of CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   BatchActivateCustomFieldsRequest request =
       BatchActivateCustomFieldsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   BatchActivateCustomFieldsResponse response =
       customFieldServiceClient.batchActivateCustomFields(request);
 }

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

Returns
Type	Description
`BatchActivateCustomFieldsResponse`

batchActivateCustomFields(String parent, List<String> names)

public final BatchActivateCustomFieldsResponse batchActivateCustomFields(String parent, List<String> names)

Activates a list of CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<String> names = new ArrayList<>();
   BatchActivateCustomFieldsResponse response =
       customFieldServiceClient.batchActivateCustomFields(parent, names);
 }

Parameters
Name	Description
`parent`	`String` Required. Format: `networks/{network_code}`
`names`	`List<String>` Required. The resource names of the `CustomField` objects to activate. Format: `networks/{network_code}/customFields/{custom_field_id}`

Returns
Type	Description
`BatchActivateCustomFieldsResponse`

batchActivateCustomFieldsCallable()

public final UnaryCallable<BatchActivateCustomFieldsRequest,BatchActivateCustomFieldsResponse> batchActivateCustomFieldsCallable()

Activates a list of CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   BatchActivateCustomFieldsRequest request =
       BatchActivateCustomFieldsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   ApiFuture<BatchActivateCustomFieldsResponse> future =
       customFieldServiceClient.batchActivateCustomFieldsCallable().futureCall(request);
   // Do something.
   BatchActivateCustomFieldsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchActivateCustomFieldsRequest,BatchActivateCustomFieldsResponse>`

batchCreateCustomFields(@Nullable NetworkName parent, List<CreateCustomFieldRequest> requests)

public final BatchCreateCustomFieldsResponse batchCreateCustomFields(@Nullable NetworkName parent, List<CreateCustomFieldRequest> requests)

Creates CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<CreateCustomFieldRequest> requests = new ArrayList<>();
   BatchCreateCustomFieldsResponse response =
       customFieldServiceClient.batchCreateCustomFields(parent, requests);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. The parent resource where `CustomFields` will be created. Format: `networks/{network_code}` The parent field in the CreateCustomFieldRequest must match this field.
`requests`	`List<CreateCustomFieldRequest>` Required. The `CustomField` objects to create. A maximum of 100 objects can be created in a batch.

Returns
Type	Description
`BatchCreateCustomFieldsResponse`

batchCreateCustomFields(BatchCreateCustomFieldsRequest request)

public final BatchCreateCustomFieldsResponse batchCreateCustomFields(BatchCreateCustomFieldsRequest request)

Creates CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   BatchCreateCustomFieldsRequest request =
       BatchCreateCustomFieldsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<CreateCustomFieldRequest>())
           .build();
   BatchCreateCustomFieldsResponse response =
       customFieldServiceClient.batchCreateCustomFields(request);
 }

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

Returns
Type	Description
`BatchCreateCustomFieldsResponse`

batchCreateCustomFields(String parent, List<CreateCustomFieldRequest> requests)

public final BatchCreateCustomFieldsResponse batchCreateCustomFields(String parent, List<CreateCustomFieldRequest> requests)

Creates CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<CreateCustomFieldRequest> requests = new ArrayList<>();
   BatchCreateCustomFieldsResponse response =
       customFieldServiceClient.batchCreateCustomFields(parent, requests);
 }

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

Returns
Type	Description
`BatchCreateCustomFieldsResponse`

batchCreateCustomFieldsCallable()

public final UnaryCallable<BatchCreateCustomFieldsRequest,BatchCreateCustomFieldsResponse> batchCreateCustomFieldsCallable()

Creates CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   BatchCreateCustomFieldsRequest request =
       BatchCreateCustomFieldsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<CreateCustomFieldRequest>())
           .build();
   ApiFuture<BatchCreateCustomFieldsResponse> future =
       customFieldServiceClient.batchCreateCustomFieldsCallable().futureCall(request);
   // Do something.
   BatchCreateCustomFieldsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchCreateCustomFieldsRequest,BatchCreateCustomFieldsResponse>`

batchDeactivateCustomFields(@Nullable NetworkName parent, List<String> names)

public final BatchDeactivateCustomFieldsResponse batchDeactivateCustomFields(@Nullable NetworkName parent, List<String> names)

Deactivates a list of CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<String> names = new ArrayList<>();
   BatchDeactivateCustomFieldsResponse response =
       customFieldServiceClient.batchDeactivateCustomFields(parent, names);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. Format: `networks/{network_code}`
`names`	`List<String>` Required. The resource names of the `CustomField` objects to deactivate. Format: `networks/{network_code}/customFields/{custom_field_id}`

Returns
Type	Description
`BatchDeactivateCustomFieldsResponse`

batchDeactivateCustomFields(BatchDeactivateCustomFieldsRequest request)

public final BatchDeactivateCustomFieldsResponse batchDeactivateCustomFields(BatchDeactivateCustomFieldsRequest request)

Deactivates a list of CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   BatchDeactivateCustomFieldsRequest request =
       BatchDeactivateCustomFieldsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   BatchDeactivateCustomFieldsResponse response =
       customFieldServiceClient.batchDeactivateCustomFields(request);
 }

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

Returns
Type	Description
`BatchDeactivateCustomFieldsResponse`

batchDeactivateCustomFields(String parent, List<String> names)

public final BatchDeactivateCustomFieldsResponse batchDeactivateCustomFields(String parent, List<String> names)

Deactivates a list of CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<String> names = new ArrayList<>();
   BatchDeactivateCustomFieldsResponse response =
       customFieldServiceClient.batchDeactivateCustomFields(parent, names);
 }

Parameters
Name	Description
`parent`	`String` Required. Format: `networks/{network_code}`
`names`	`List<String>` Required. The resource names of the `CustomField` objects to deactivate. Format: `networks/{network_code}/customFields/{custom_field_id}`

Returns
Type	Description
`BatchDeactivateCustomFieldsResponse`

batchDeactivateCustomFieldsCallable()

public final UnaryCallable<BatchDeactivateCustomFieldsRequest,BatchDeactivateCustomFieldsResponse> batchDeactivateCustomFieldsCallable()

Deactivates a list of CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   BatchDeactivateCustomFieldsRequest request =
       BatchDeactivateCustomFieldsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   ApiFuture<BatchDeactivateCustomFieldsResponse> future =
       customFieldServiceClient.batchDeactivateCustomFieldsCallable().futureCall(request);
   // Do something.
   BatchDeactivateCustomFieldsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchDeactivateCustomFieldsRequest,BatchDeactivateCustomFieldsResponse>`

batchUpdateCustomFields(@Nullable NetworkName parent, List<UpdateCustomFieldRequest> requests)

public final BatchUpdateCustomFieldsResponse batchUpdateCustomFields(@Nullable NetworkName parent, List<UpdateCustomFieldRequest> requests)

Batch updates CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   List<UpdateCustomFieldRequest> requests = new ArrayList<>();
   BatchUpdateCustomFieldsResponse response =
       customFieldServiceClient.batchUpdateCustomFields(parent, requests);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. The parent resource where `CustomFields` will be updated. Format: `networks/{network_code}` The parent field in the UpdateCustomFieldRequest must match this field.
`requests`	`List<UpdateCustomFieldRequest>` Required. The `CustomField` objects to update. A maximum of 100 objects can be updated in a batch.

Returns
Type	Description
`BatchUpdateCustomFieldsResponse`

batchUpdateCustomFields(BatchUpdateCustomFieldsRequest request)

public final BatchUpdateCustomFieldsResponse batchUpdateCustomFields(BatchUpdateCustomFieldsRequest request)

Batch updates CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   BatchUpdateCustomFieldsRequest request =
       BatchUpdateCustomFieldsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<UpdateCustomFieldRequest>())
           .build();
   BatchUpdateCustomFieldsResponse response =
       customFieldServiceClient.batchUpdateCustomFields(request);
 }

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

Returns
Type	Description
`BatchUpdateCustomFieldsResponse`

batchUpdateCustomFields(String parent, List<UpdateCustomFieldRequest> requests)

public final BatchUpdateCustomFieldsResponse batchUpdateCustomFields(String parent, List<UpdateCustomFieldRequest> requests)

Batch updates CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   List<UpdateCustomFieldRequest> requests = new ArrayList<>();
   BatchUpdateCustomFieldsResponse response =
       customFieldServiceClient.batchUpdateCustomFields(parent, requests);
 }

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

Returns
Type	Description
`BatchUpdateCustomFieldsResponse`

batchUpdateCustomFieldsCallable()

public final UnaryCallable<BatchUpdateCustomFieldsRequest,BatchUpdateCustomFieldsResponse> batchUpdateCustomFieldsCallable()

Batch updates CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   BatchUpdateCustomFieldsRequest request =
       BatchUpdateCustomFieldsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .addAllRequests(new ArrayList<UpdateCustomFieldRequest>())
           .build();
   ApiFuture<BatchUpdateCustomFieldsResponse> future =
       customFieldServiceClient.batchUpdateCustomFieldsCallable().futureCall(request);
   // Do something.
   BatchUpdateCustomFieldsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<BatchUpdateCustomFieldsRequest,BatchUpdateCustomFieldsResponse>`

close()

public final void close()

createCustomField(@Nullable NetworkName parent, CustomField customField)

public final CustomField createCustomField(@Nullable NetworkName parent, CustomField customField)

Creates a CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   CustomField customField = CustomField.newBuilder().build();
   CustomField response = customFieldServiceClient.createCustomField(parent, customField);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. The parent resource where this `CustomField` will be created. Format: `networks/{network_code}`
`customField`	`CustomField` Required. The `CustomField` to create.

Returns
Type	Description
`CustomField`

createCustomField(CreateCustomFieldRequest request)

public final CustomField createCustomField(CreateCustomFieldRequest request)

Creates a CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   CreateCustomFieldRequest request =
       CreateCustomFieldRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setCustomField(CustomField.newBuilder().build())
           .build();
   CustomField response = customFieldServiceClient.createCustomField(request);
 }

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

Returns
Type	Description
`CustomField`

createCustomField(String parent, CustomField customField)

public final CustomField createCustomField(String parent, CustomField customField)

Creates a CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   CustomField customField = CustomField.newBuilder().build();
   CustomField response = customFieldServiceClient.createCustomField(parent, customField);
 }

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

Returns
Type	Description
`CustomField`

createCustomFieldCallable()

public final UnaryCallable<CreateCustomFieldRequest,CustomField> createCustomFieldCallable()

Creates a CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   CreateCustomFieldRequest request =
       CreateCustomFieldRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setCustomField(CustomField.newBuilder().build())
           .build();
   ApiFuture<CustomField> future =
       customFieldServiceClient.createCustomFieldCallable().futureCall(request);
   // Do something.
   CustomField response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateCustomFieldRequest,CustomField>`

getCustomField(@Nullable CustomFieldName name)

public final CustomField getCustomField(@Nullable CustomFieldName name)

Retrieves a CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   CustomFieldName name = CustomFieldName.of("[NETWORK_CODE]", "[CUSTOM_FIELD]");
   CustomField response = customFieldServiceClient.getCustomField(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.CustomFieldName` Required. The resource name of the CustomField. Format: `networks/{network_code}/customFields/{custom_field_id}`

Returns
Type	Description
`CustomField`

getCustomField(GetCustomFieldRequest request)

public final CustomField getCustomField(GetCustomFieldRequest request)

Retrieves a CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   GetCustomFieldRequest request =
       GetCustomFieldRequest.newBuilder()
           .setName(CustomFieldName.of("[NETWORK_CODE]", "[CUSTOM_FIELD]").toString())
           .build();
   CustomField response = customFieldServiceClient.getCustomField(request);
 }

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

Returns
Type	Description
`CustomField`

getCustomField(String name)

public final CustomField getCustomField(String name)

Retrieves a CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   String name = CustomFieldName.of("[NETWORK_CODE]", "[CUSTOM_FIELD]").toString();
   CustomField response = customFieldServiceClient.getCustomField(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the CustomField. Format: `networks/{network_code}/customFields/{custom_field_id}`

Returns
Type	Description
`CustomField`

getCustomFieldCallable()

public final UnaryCallable<GetCustomFieldRequest,CustomField> getCustomFieldCallable()

Retrieves a CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   GetCustomFieldRequest request =
       GetCustomFieldRequest.newBuilder()
           .setName(CustomFieldName.of("[NETWORK_CODE]", "[CUSTOM_FIELD]").toString())
           .build();
   ApiFuture<CustomField> future =
       customFieldServiceClient.getCustomFieldCallable().futureCall(request);
   // Do something.
   CustomField response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetCustomFieldRequest,CustomField>`

getSettings()

public final @Nullable CustomFieldServiceSettings getSettings()

Returns
Type	Description
`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.CustomFieldServiceSettings`

getStub()

public CustomFieldServiceStub getStub()

Returns
Type	Description
`CustomFieldServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listCustomFields(@Nullable NetworkName parent)

public final CustomFieldServiceClient.ListCustomFieldsPagedResponse listCustomFields(@Nullable NetworkName parent)

Lists CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (CustomField element : customFieldServiceClient.listCustomFields(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkName` Required. The parent, which owns this collection of CustomFields. Format: `networks/{network_code}`

Returns
Type	Description
`CustomFieldServiceClient.ListCustomFieldsPagedResponse`

listCustomFields(ListCustomFieldsRequest request)

public final CustomFieldServiceClient.ListCustomFieldsPagedResponse listCustomFields(ListCustomFieldsRequest request)

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

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

Returns
Type	Description
`CustomFieldServiceClient.ListCustomFieldsPagedResponse`

listCustomFields(String parent)

public final CustomFieldServiceClient.ListCustomFieldsPagedResponse listCustomFields(String parent)

Lists CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (CustomField element : customFieldServiceClient.listCustomFields(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`CustomFieldServiceClient.ListCustomFieldsPagedResponse`

listCustomFieldsCallable()

public final UnaryCallable<ListCustomFieldsRequest,ListCustomFieldsResponse> listCustomFieldsCallable()

Lists CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   ListCustomFieldsRequest request =
       ListCustomFieldsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListCustomFieldsResponse response =
         customFieldServiceClient.listCustomFieldsCallable().call(request);
     for (CustomField element : response.getCustomFieldsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListCustomFieldsRequest,ListCustomFieldsResponse>`

listCustomFieldsPagedCallable()

public final UnaryCallable<ListCustomFieldsRequest,CustomFieldServiceClient.ListCustomFieldsPagedResponse> listCustomFieldsPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListCustomFieldsRequest,ListCustomFieldsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateCustomField(CustomField customField, FieldMask updateMask)

public final CustomField updateCustomField(CustomField customField, FieldMask updateMask)

Updates a CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   CustomField customField = CustomField.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CustomField response = customFieldServiceClient.updateCustomField(customField, updateMask);
 }

Parameters

Name Description

customField

CustomField

Required. The CustomField to update.

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

updateMask

FieldMask

Optional. The list of fields to update.

Returns
Type	Description
`CustomField`

updateCustomField(UpdateCustomFieldRequest request)

public final CustomField updateCustomField(UpdateCustomFieldRequest request)

Updates a CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   UpdateCustomFieldRequest request =
       UpdateCustomFieldRequest.newBuilder()
           .setCustomField(CustomField.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   CustomField response = customFieldServiceClient.updateCustomField(request);
 }

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

Returns
Type	Description
`CustomField`

updateCustomFieldCallable()

public final UnaryCallable<UpdateCustomFieldRequest,CustomField> updateCustomFieldCallable()

Updates a CustomField 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 (CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.create()) {
   UpdateCustomFieldRequest request =
       UpdateCustomFieldRequest.newBuilder()
           .setCustomField(CustomField.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<CustomField> future =
       customFieldServiceClient.updateCustomFieldCallable().futureCall(request);
   // Do something.
   CustomField response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateCustomFieldRequest,CustomField>`

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

Inheritance

Static Methods

create()

create(CustomFieldServiceSettings settings)

create(CustomFieldServiceStub stub)

Constructors

CustomFieldServiceClient(CustomFieldServiceSettings settings)

CustomFieldServiceClient(CustomFieldServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

batchActivateCustomFields(@Nullable NetworkName parent, List<String> names)

batchActivateCustomFields(BatchActivateCustomFieldsRequest request)

batchActivateCustomFields(String parent, List<String> names)

batchActivateCustomFieldsCallable()

batchCreateCustomFields(@Nullable NetworkName parent, List<CreateCustomFieldRequest> requests)

batchCreateCustomFields(BatchCreateCustomFieldsRequest request)

batchCreateCustomFields(String parent, List<CreateCustomFieldRequest> requests)

batchCreateCustomFieldsCallable()

batchDeactivateCustomFields(@Nullable NetworkName parent, List<String> names)

batchDeactivateCustomFields(BatchDeactivateCustomFieldsRequest request)

batchDeactivateCustomFields(String parent, List<String> names)

batchDeactivateCustomFieldsCallable()

batchUpdateCustomFields(@Nullable NetworkName parent, List<UpdateCustomFieldRequest> requests)

batchUpdateCustomFields(BatchUpdateCustomFieldsRequest request)

batchUpdateCustomFields(String parent, List<UpdateCustomFieldRequest> requests)

batchUpdateCustomFieldsCallable()

close()

createCustomField(@Nullable NetworkName parent, CustomField customField)

createCustomField(CreateCustomFieldRequest request)

createCustomField(String parent, CustomField customField)

createCustomFieldCallable()

getCustomField(@Nullable CustomFieldName name)

getCustomField(GetCustomFieldRequest request)

getCustomField(String name)

getCustomFieldCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listCustomFields(@Nullable NetworkName parent)

listCustomFields(ListCustomFieldsRequest request)

listCustomFields(String parent)

listCustomFieldsCallable()

listCustomFieldsPagedCallable()

shutdown()

shutdownNow()

updateCustomField(CustomField customField, FieldMask updateMask)

updateCustomField(UpdateCustomFieldRequest request)

updateCustomFieldCallable()

Class CustomFieldServiceClient (0.54.0)