| GitHub Repository | Product Reference |
Service Description: Provides methods for handling AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
AudienceSegmentName name = AudienceSegmentName.of("[NETWORK_CODE]", "[AUDIENCE_SEGMENT]");
AudienceSegment response = audienceSegmentServiceClient.getAudienceSegment(name);
}
Note: close() needs to be called on the AudienceSegmentServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
GetAudienceSegment |
Retrieves an |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListAudienceSegments |
Lists |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateAudienceSegment |
Creates an |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
BatchCreateAudienceSegments |
Creates |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
BatchActivateAudienceSegments |
Activates |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
BatchDeactivateAudienceSegments |
Deactivates |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
BatchApproveAudienceSegments |
Approves |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
BatchRejectAudienceSegments |
Rejects |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
BatchPopulateAudienceSegments |
Populates |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AudienceSegmentServiceSettings 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
AudienceSegmentServiceSettings audienceSegmentServiceSettings =
AudienceSegmentServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create(audienceSegmentServiceSettings);
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
AudienceSegmentServiceSettings audienceSegmentServiceSettings =
AudienceSegmentServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create(audienceSegmentServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final AudienceSegmentServiceClient create()Constructs an instance of AudienceSegmentServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
AudienceSegmentServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(AudienceSegmentServiceSettings settings)
public static final AudienceSegmentServiceClient create(AudienceSegmentServiceSettings settings)Constructs an instance of AudienceSegmentServiceClient, 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 |
AudienceSegmentServiceSettings |
| Returns | |
|---|---|
| Type | Description |
AudienceSegmentServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(AudienceSegmentServiceStub stub)
public static final AudienceSegmentServiceClient create(AudienceSegmentServiceStub stub)Constructs an instance of AudienceSegmentServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AudienceSegmentServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
AudienceSegmentServiceStub |
| Returns | |
|---|---|
| Type | Description |
AudienceSegmentServiceClient |
|
Constructors
AudienceSegmentServiceClient(AudienceSegmentServiceSettings settings)
protected AudienceSegmentServiceClient(AudienceSegmentServiceSettings settings)Constructs an instance of AudienceSegmentServiceClient, 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 |
AudienceSegmentServiceSettings |
AudienceSegmentServiceClient(AudienceSegmentServiceStub stub)
protected AudienceSegmentServiceClient(AudienceSegmentServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
AudienceSegmentServiceStub |
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 |
|
batchActivateAudienceSegments(@Nullable NetworkName parent, List<String> names)
public final BatchActivateAudienceSegmentsResponse batchActivateAudienceSegments(@Nullable NetworkName parent, List<String> names)Activates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
NetworkName parent = NetworkName.of("[NETWORK_CODE]");
List<String> names = new ArrayList<>();
BatchActivateAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchActivateAudienceSegments(parent, names);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkNameRequired. Format: |
names |
List<String>Required. Resource names for the AudienceSegments. Format:
|
| Returns | |
|---|---|
| Type | Description |
BatchActivateAudienceSegmentsResponse |
|
batchActivateAudienceSegments(BatchActivateAudienceSegmentsRequest request)
public final BatchActivateAudienceSegmentsResponse batchActivateAudienceSegments(BatchActivateAudienceSegmentsRequest request)Activates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
BatchActivateAudienceSegmentsRequest request =
BatchActivateAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllNames(new ArrayList<String>())
.build();
BatchActivateAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchActivateAudienceSegments(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
BatchActivateAudienceSegmentsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
BatchActivateAudienceSegmentsResponse |
|
batchActivateAudienceSegments(String parent, List<String> names)
public final BatchActivateAudienceSegmentsResponse batchActivateAudienceSegments(String parent, List<String> names)Activates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
String parent = NetworkName.of("[NETWORK_CODE]").toString();
List<String> names = new ArrayList<>();
BatchActivateAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchActivateAudienceSegments(parent, names);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. Format: |
names |
List<String>Required. Resource names for the AudienceSegments. Format:
|
| Returns | |
|---|---|
| Type | Description |
BatchActivateAudienceSegmentsResponse |
|
batchActivateAudienceSegmentsCallable()
public final UnaryCallable<BatchActivateAudienceSegmentsRequest,BatchActivateAudienceSegmentsResponse> batchActivateAudienceSegmentsCallable()Activates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
BatchActivateAudienceSegmentsRequest request =
BatchActivateAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllNames(new ArrayList<String>())
.build();
ApiFuture<BatchActivateAudienceSegmentsResponse> future =
audienceSegmentServiceClient.batchActivateAudienceSegmentsCallable().futureCall(request);
// Do something.
BatchActivateAudienceSegmentsResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<BatchActivateAudienceSegmentsRequest,BatchActivateAudienceSegmentsResponse> |
|
batchApproveAudienceSegments(@Nullable NetworkName parent, List<String> names)
public final BatchApproveAudienceSegmentsResponse batchApproveAudienceSegments(@Nullable NetworkName parent, List<String> names)Approves AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
NetworkName parent = NetworkName.of("[NETWORK_CODE]");
List<String> names = new ArrayList<>();
BatchApproveAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchApproveAudienceSegments(parent, names);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkNameRequired. Format: |
names |
List<String>Required. Resource names for the AudienceSegments. Format:
|
| Returns | |
|---|---|
| Type | Description |
BatchApproveAudienceSegmentsResponse |
|
batchApproveAudienceSegments(BatchApproveAudienceSegmentsRequest request)
public final BatchApproveAudienceSegmentsResponse batchApproveAudienceSegments(BatchApproveAudienceSegmentsRequest request)Approves AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
BatchApproveAudienceSegmentsRequest request =
BatchApproveAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllNames(new ArrayList<String>())
.build();
BatchApproveAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchApproveAudienceSegments(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
BatchApproveAudienceSegmentsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
BatchApproveAudienceSegmentsResponse |
|
batchApproveAudienceSegments(String parent, List<String> names)
public final BatchApproveAudienceSegmentsResponse batchApproveAudienceSegments(String parent, List<String> names)Approves AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
String parent = NetworkName.of("[NETWORK_CODE]").toString();
List<String> names = new ArrayList<>();
BatchApproveAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchApproveAudienceSegments(parent, names);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. Format: |
names |
List<String>Required. Resource names for the AudienceSegments. Format:
|
| Returns | |
|---|---|
| Type | Description |
BatchApproveAudienceSegmentsResponse |
|
batchApproveAudienceSegmentsCallable()
public final UnaryCallable<BatchApproveAudienceSegmentsRequest,BatchApproveAudienceSegmentsResponse> batchApproveAudienceSegmentsCallable()Approves AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
BatchApproveAudienceSegmentsRequest request =
BatchApproveAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllNames(new ArrayList<String>())
.build();
ApiFuture<BatchApproveAudienceSegmentsResponse> future =
audienceSegmentServiceClient.batchApproveAudienceSegmentsCallable().futureCall(request);
// Do something.
BatchApproveAudienceSegmentsResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<BatchApproveAudienceSegmentsRequest,BatchApproveAudienceSegmentsResponse> |
|
batchCreateAudienceSegments(@Nullable NetworkName parent, List<CreateAudienceSegmentRequest> requests)
public final BatchCreateAudienceSegmentsResponse batchCreateAudienceSegments(@Nullable NetworkName parent, List<CreateAudienceSegmentRequest> requests)Creates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
NetworkName parent = NetworkName.of("[NETWORK_CODE]");
List<CreateAudienceSegmentRequest> requests = new ArrayList<>();
BatchCreateAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchCreateAudienceSegments(parent, requests);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkNameRequired. The parent resource where |
requests |
List<CreateAudienceSegmentRequest>Required. The |
| Returns | |
|---|---|
| Type | Description |
BatchCreateAudienceSegmentsResponse |
|
batchCreateAudienceSegments(BatchCreateAudienceSegmentsRequest request)
public final BatchCreateAudienceSegmentsResponse batchCreateAudienceSegments(BatchCreateAudienceSegmentsRequest request)Creates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
BatchCreateAudienceSegmentsRequest request =
BatchCreateAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllRequests(new ArrayList<CreateAudienceSegmentRequest>())
.build();
BatchCreateAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchCreateAudienceSegments(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
BatchCreateAudienceSegmentsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
BatchCreateAudienceSegmentsResponse |
|
batchCreateAudienceSegments(String parent, List<CreateAudienceSegmentRequest> requests)
public final BatchCreateAudienceSegmentsResponse batchCreateAudienceSegments(String parent, List<CreateAudienceSegmentRequest> requests)Creates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
String parent = NetworkName.of("[NETWORK_CODE]").toString();
List<CreateAudienceSegmentRequest> requests = new ArrayList<>();
BatchCreateAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchCreateAudienceSegments(parent, requests);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent resource where |
requests |
List<CreateAudienceSegmentRequest>Required. The |
| Returns | |
|---|---|
| Type | Description |
BatchCreateAudienceSegmentsResponse |
|
batchCreateAudienceSegmentsCallable()
public final UnaryCallable<BatchCreateAudienceSegmentsRequest,BatchCreateAudienceSegmentsResponse> batchCreateAudienceSegmentsCallable()Creates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
BatchCreateAudienceSegmentsRequest request =
BatchCreateAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllRequests(new ArrayList<CreateAudienceSegmentRequest>())
.build();
ApiFuture<BatchCreateAudienceSegmentsResponse> future =
audienceSegmentServiceClient.batchCreateAudienceSegmentsCallable().futureCall(request);
// Do something.
BatchCreateAudienceSegmentsResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<BatchCreateAudienceSegmentsRequest,BatchCreateAudienceSegmentsResponse> |
|
batchDeactivateAudienceSegments(@Nullable NetworkName parent, List<String> names)
public final BatchDeactivateAudienceSegmentsResponse batchDeactivateAudienceSegments(@Nullable NetworkName parent, List<String> names)Deactivates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
NetworkName parent = NetworkName.of("[NETWORK_CODE]");
List<String> names = new ArrayList<>();
BatchDeactivateAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchDeactivateAudienceSegments(parent, names);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkNameRequired. Format: |
names |
List<String>Required. Resource names for the AudienceSegments. Format:
|
| Returns | |
|---|---|
| Type | Description |
BatchDeactivateAudienceSegmentsResponse |
|
batchDeactivateAudienceSegments(BatchDeactivateAudienceSegmentsRequest request)
public final BatchDeactivateAudienceSegmentsResponse batchDeactivateAudienceSegments(BatchDeactivateAudienceSegmentsRequest request)Deactivates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
BatchDeactivateAudienceSegmentsRequest request =
BatchDeactivateAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllNames(new ArrayList<String>())
.build();
BatchDeactivateAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchDeactivateAudienceSegments(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
BatchDeactivateAudienceSegmentsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
BatchDeactivateAudienceSegmentsResponse |
|
batchDeactivateAudienceSegments(String parent, List<String> names)
public final BatchDeactivateAudienceSegmentsResponse batchDeactivateAudienceSegments(String parent, List<String> names)Deactivates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
String parent = NetworkName.of("[NETWORK_CODE]").toString();
List<String> names = new ArrayList<>();
BatchDeactivateAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchDeactivateAudienceSegments(parent, names);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. Format: |
names |
List<String>Required. Resource names for the AudienceSegments. Format:
|
| Returns | |
|---|---|
| Type | Description |
BatchDeactivateAudienceSegmentsResponse |
|
batchDeactivateAudienceSegmentsCallable()
public final UnaryCallable<BatchDeactivateAudienceSegmentsRequest,BatchDeactivateAudienceSegmentsResponse> batchDeactivateAudienceSegmentsCallable()Deactivates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
BatchDeactivateAudienceSegmentsRequest request =
BatchDeactivateAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllNames(new ArrayList<String>())
.build();
ApiFuture<BatchDeactivateAudienceSegmentsResponse> future =
audienceSegmentServiceClient
.batchDeactivateAudienceSegmentsCallable()
.futureCall(request);
// Do something.
BatchDeactivateAudienceSegmentsResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<BatchDeactivateAudienceSegmentsRequest,BatchDeactivateAudienceSegmentsResponse> |
|
batchPopulateAudienceSegments(@Nullable NetworkName parent, List<String> names)
public final BatchPopulateAudienceSegmentsResponse batchPopulateAudienceSegments(@Nullable NetworkName parent, List<String> names)Populates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
NetworkName parent = NetworkName.of("[NETWORK_CODE]");
List<String> names = new ArrayList<>();
BatchPopulateAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchPopulateAudienceSegments(parent, names);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkNameRequired. Format: |
names |
List<String>Required. Resource names for the AudienceSegments. Format:
|
| Returns | |
|---|---|
| Type | Description |
BatchPopulateAudienceSegmentsResponse |
|
batchPopulateAudienceSegments(BatchPopulateAudienceSegmentsRequest request)
public final BatchPopulateAudienceSegmentsResponse batchPopulateAudienceSegments(BatchPopulateAudienceSegmentsRequest request)Populates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
BatchPopulateAudienceSegmentsRequest request =
BatchPopulateAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllNames(new ArrayList<String>())
.build();
BatchPopulateAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchPopulateAudienceSegments(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
BatchPopulateAudienceSegmentsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
BatchPopulateAudienceSegmentsResponse |
|
batchPopulateAudienceSegments(String parent, List<String> names)
public final BatchPopulateAudienceSegmentsResponse batchPopulateAudienceSegments(String parent, List<String> names)Populates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
String parent = NetworkName.of("[NETWORK_CODE]").toString();
List<String> names = new ArrayList<>();
BatchPopulateAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchPopulateAudienceSegments(parent, names);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. Format: |
names |
List<String>Required. Resource names for the AudienceSegments. Format:
|
| Returns | |
|---|---|
| Type | Description |
BatchPopulateAudienceSegmentsResponse |
|
batchPopulateAudienceSegmentsCallable()
public final UnaryCallable<BatchPopulateAudienceSegmentsRequest,BatchPopulateAudienceSegmentsResponse> batchPopulateAudienceSegmentsCallable()Populates AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
BatchPopulateAudienceSegmentsRequest request =
BatchPopulateAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllNames(new ArrayList<String>())
.build();
ApiFuture<BatchPopulateAudienceSegmentsResponse> future =
audienceSegmentServiceClient.batchPopulateAudienceSegmentsCallable().futureCall(request);
// Do something.
BatchPopulateAudienceSegmentsResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<BatchPopulateAudienceSegmentsRequest,BatchPopulateAudienceSegmentsResponse> |
|
batchRejectAudienceSegments(@Nullable NetworkName parent, List<String> names)
public final BatchRejectAudienceSegmentsResponse batchRejectAudienceSegments(@Nullable NetworkName parent, List<String> names)Rejects AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
NetworkName parent = NetworkName.of("[NETWORK_CODE]");
List<String> names = new ArrayList<>();
BatchRejectAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchRejectAudienceSegments(parent, names);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkNameRequired. Format: |
names |
List<String>Required. Resource names for the AudienceSegments. Format:
|
| Returns | |
|---|---|
| Type | Description |
BatchRejectAudienceSegmentsResponse |
|
batchRejectAudienceSegments(BatchRejectAudienceSegmentsRequest request)
public final BatchRejectAudienceSegmentsResponse batchRejectAudienceSegments(BatchRejectAudienceSegmentsRequest request)Rejects AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
BatchRejectAudienceSegmentsRequest request =
BatchRejectAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllNames(new ArrayList<String>())
.build();
BatchRejectAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchRejectAudienceSegments(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
BatchRejectAudienceSegmentsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
BatchRejectAudienceSegmentsResponse |
|
batchRejectAudienceSegments(String parent, List<String> names)
public final BatchRejectAudienceSegmentsResponse batchRejectAudienceSegments(String parent, List<String> names)Rejects AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
String parent = NetworkName.of("[NETWORK_CODE]").toString();
List<String> names = new ArrayList<>();
BatchRejectAudienceSegmentsResponse response =
audienceSegmentServiceClient.batchRejectAudienceSegments(parent, names);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. Format: |
names |
List<String>Required. Resource names for the AudienceSegments. Format:
|
| Returns | |
|---|---|
| Type | Description |
BatchRejectAudienceSegmentsResponse |
|
batchRejectAudienceSegmentsCallable()
public final UnaryCallable<BatchRejectAudienceSegmentsRequest,BatchRejectAudienceSegmentsResponse> batchRejectAudienceSegmentsCallable()Rejects AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
BatchRejectAudienceSegmentsRequest request =
BatchRejectAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.addAllNames(new ArrayList<String>())
.build();
ApiFuture<BatchRejectAudienceSegmentsResponse> future =
audienceSegmentServiceClient.batchRejectAudienceSegmentsCallable().futureCall(request);
// Do something.
BatchRejectAudienceSegmentsResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<BatchRejectAudienceSegmentsRequest,BatchRejectAudienceSegmentsResponse> |
|
close()
public final void close()createAudienceSegment(@Nullable NetworkName parent, AudienceSegment audienceSegment)
public final AudienceSegment createAudienceSegment(@Nullable NetworkName parent, AudienceSegment audienceSegment)Creates an AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
NetworkName parent = NetworkName.of("[NETWORK_CODE]");
AudienceSegment audienceSegment = AudienceSegment.newBuilder().build();
AudienceSegment response =
audienceSegmentServiceClient.createAudienceSegment(parent, audienceSegment);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkNameRequired. The parent resource where this |
audienceSegment |
AudienceSegmentRequired. The |
| Returns | |
|---|---|
| Type | Description |
AudienceSegment |
|
createAudienceSegment(CreateAudienceSegmentRequest request)
public final AudienceSegment createAudienceSegment(CreateAudienceSegmentRequest request)Creates an AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
CreateAudienceSegmentRequest request =
CreateAudienceSegmentRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.setAudienceSegment(AudienceSegment.newBuilder().build())
.build();
AudienceSegment response = audienceSegmentServiceClient.createAudienceSegment(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateAudienceSegmentRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AudienceSegment |
|
createAudienceSegment(String parent, AudienceSegment audienceSegment)
public final AudienceSegment createAudienceSegment(String parent, AudienceSegment audienceSegment)Creates an AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
String parent = NetworkName.of("[NETWORK_CODE]").toString();
AudienceSegment audienceSegment = AudienceSegment.newBuilder().build();
AudienceSegment response =
audienceSegmentServiceClient.createAudienceSegment(parent, audienceSegment);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent resource where this |
audienceSegment |
AudienceSegmentRequired. The |
| Returns | |
|---|---|
| Type | Description |
AudienceSegment |
|
createAudienceSegmentCallable()
public final UnaryCallable<CreateAudienceSegmentRequest,AudienceSegment> createAudienceSegmentCallable()Creates an AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
CreateAudienceSegmentRequest request =
CreateAudienceSegmentRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.setAudienceSegment(AudienceSegment.newBuilder().build())
.build();
ApiFuture<AudienceSegment> future =
audienceSegmentServiceClient.createAudienceSegmentCallable().futureCall(request);
// Do something.
AudienceSegment response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateAudienceSegmentRequest,AudienceSegment> |
|
getAudienceSegment(@Nullable AudienceSegmentName name)
public final AudienceSegment getAudienceSegment(@Nullable AudienceSegmentName name)Retrieves an AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
AudienceSegmentName name = AudienceSegmentName.of("[NETWORK_CODE]", "[AUDIENCE_SEGMENT]");
AudienceSegment response = audienceSegmentServiceClient.getAudienceSegment(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.AudienceSegmentNameRequired. The resource name of the AudienceSegment. Format:
|
| Returns | |
|---|---|
| Type | Description |
AudienceSegment |
|
getAudienceSegment(GetAudienceSegmentRequest request)
public final AudienceSegment getAudienceSegment(GetAudienceSegmentRequest request)Retrieves an AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
GetAudienceSegmentRequest request =
GetAudienceSegmentRequest.newBuilder()
.setName(AudienceSegmentName.of("[NETWORK_CODE]", "[AUDIENCE_SEGMENT]").toString())
.build();
AudienceSegment response = audienceSegmentServiceClient.getAudienceSegment(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetAudienceSegmentRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AudienceSegment |
|
getAudienceSegment(String name)
public final AudienceSegment getAudienceSegment(String name)Retrieves an AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
String name = AudienceSegmentName.of("[NETWORK_CODE]", "[AUDIENCE_SEGMENT]").toString();
AudienceSegment response = audienceSegmentServiceClient.getAudienceSegment(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The resource name of the AudienceSegment. Format:
|
| Returns | |
|---|---|
| Type | Description |
AudienceSegment |
|
getAudienceSegmentCallable()
public final UnaryCallable<GetAudienceSegmentRequest,AudienceSegment> getAudienceSegmentCallable()Retrieves an AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
GetAudienceSegmentRequest request =
GetAudienceSegmentRequest.newBuilder()
.setName(AudienceSegmentName.of("[NETWORK_CODE]", "[AUDIENCE_SEGMENT]").toString())
.build();
ApiFuture<AudienceSegment> future =
audienceSegmentServiceClient.getAudienceSegmentCallable().futureCall(request);
// Do something.
AudienceSegment response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetAudienceSegmentRequest,AudienceSegment> |
|
getSettings()
public final @Nullable AudienceSegmentServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.AudienceSegmentServiceSettings |
|
getStub()
public AudienceSegmentServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
AudienceSegmentServiceStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listAudienceSegments(@Nullable NetworkName parent)
public final AudienceSegmentServiceClient.ListAudienceSegmentsPagedResponse listAudienceSegments(@Nullable NetworkName parent)Lists AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
NetworkName parent = NetworkName.of("[NETWORK_CODE]");
for (AudienceSegment element :
audienceSegmentServiceClient.listAudienceSegments(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.NetworkNameRequired. The parent publisher network associated with these audience segments.
Format: |
| Returns | |
|---|---|
| Type | Description |
AudienceSegmentServiceClient.ListAudienceSegmentsPagedResponse |
|
listAudienceSegments(ListAudienceSegmentsRequest request)
public final AudienceSegmentServiceClient.ListAudienceSegmentsPagedResponse listAudienceSegments(ListAudienceSegmentsRequest request)Lists AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
ListAudienceSegmentsRequest request =
ListAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.setSkip(3532159)
.build();
for (AudienceSegment element :
audienceSegmentServiceClient.listAudienceSegments(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListAudienceSegmentsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AudienceSegmentServiceClient.ListAudienceSegmentsPagedResponse |
|
listAudienceSegments(String parent)
public final AudienceSegmentServiceClient.ListAudienceSegmentsPagedResponse listAudienceSegments(String parent)Lists AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
String parent = NetworkName.of("[NETWORK_CODE]").toString();
for (AudienceSegment element :
audienceSegmentServiceClient.listAudienceSegments(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent publisher network associated with these audience segments.
Format: |
| Returns | |
|---|---|
| Type | Description |
AudienceSegmentServiceClient.ListAudienceSegmentsPagedResponse |
|
listAudienceSegmentsCallable()
public final UnaryCallable<ListAudienceSegmentsRequest,ListAudienceSegmentsResponse> listAudienceSegmentsCallable()Lists AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
ListAudienceSegmentsRequest request =
ListAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.setSkip(3532159)
.build();
while (true) {
ListAudienceSegmentsResponse response =
audienceSegmentServiceClient.listAudienceSegmentsCallable().call(request);
for (AudienceSegment element : response.getAudienceSegmentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListAudienceSegmentsRequest,ListAudienceSegmentsResponse> |
|
listAudienceSegmentsPagedCallable()
public final UnaryCallable<ListAudienceSegmentsRequest,AudienceSegmentServiceClient.ListAudienceSegmentsPagedResponse> listAudienceSegmentsPagedCallable()Lists AudienceSegment 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 (AudienceSegmentServiceClient audienceSegmentServiceClient =
AudienceSegmentServiceClient.create()) {
ListAudienceSegmentsRequest request =
ListAudienceSegmentsRequest.newBuilder()
.setParent(NetworkName.of("[NETWORK_CODE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.setSkip(3532159)
.build();
ApiFuture<AudienceSegment> future =
audienceSegmentServiceClient.listAudienceSegmentsPagedCallable().futureCall(request);
// Do something.
for (AudienceSegment element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListAudienceSegmentsRequest,ListAudienceSegmentsPagedResponse> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()