| GitHub Repository | Product Reference | RPC Documentation |
Service Description: Service to return insights on marketing data.
This feature is only available to data partners.
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 (MarketingDataInsightsServiceClient marketingDataInsightsServiceClient =
MarketingDataInsightsServiceClient.create()) {
RetrieveInsightsRequest request =
RetrieveInsightsRequest.newBuilder()
.setParent("parent-995424086")
.setBaseline(Baseline.newBuilder().build())
.setUserListId("userListId1381604868")
.build();
RetrieveInsightsResponse response =
marketingDataInsightsServiceClient.retrieveInsights(request);
}
Note: close() needs to be called on the MarketingDataInsightsServiceClient 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 |
|---|---|---|
RetrieveInsights |
Retrieves marketing data insights for a given user list. This feature is only available to data partners. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request:
|
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.
|
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 MarketingDataInsightsServiceSettings 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
MarketingDataInsightsServiceSettings marketingDataInsightsServiceSettings =
MarketingDataInsightsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
MarketingDataInsightsServiceClient marketingDataInsightsServiceClient =
MarketingDataInsightsServiceClient.create(marketingDataInsightsServiceSettings);
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
MarketingDataInsightsServiceSettings marketingDataInsightsServiceSettings =
MarketingDataInsightsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
MarketingDataInsightsServiceClient marketingDataInsightsServiceClient =
MarketingDataInsightsServiceClient.create(marketingDataInsightsServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
MarketingDataInsightsServiceSettings marketingDataInsightsServiceSettings =
MarketingDataInsightsServiceSettings.newHttpJsonBuilder().build();
MarketingDataInsightsServiceClient marketingDataInsightsServiceClient =
MarketingDataInsightsServiceClient.create(marketingDataInsightsServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final MarketingDataInsightsServiceClient create()Constructs an instance of MarketingDataInsightsServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
MarketingDataInsightsServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(MarketingDataInsightsServiceSettings settings)
public static final MarketingDataInsightsServiceClient create(MarketingDataInsightsServiceSettings settings)Constructs an instance of MarketingDataInsightsServiceClient, 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 |
MarketingDataInsightsServiceSettings |
| Returns | |
|---|---|
| Type | Description |
MarketingDataInsightsServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(MarketingDataInsightsServiceStub stub)
public static final MarketingDataInsightsServiceClient create(MarketingDataInsightsServiceStub stub)Constructs an instance of MarketingDataInsightsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(MarketingDataInsightsServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
MarketingDataInsightsServiceStub |
| Returns | |
|---|---|
| Type | Description |
MarketingDataInsightsServiceClient |
|
Constructors
MarketingDataInsightsServiceClient(MarketingDataInsightsServiceSettings settings)
protected MarketingDataInsightsServiceClient(MarketingDataInsightsServiceSettings settings)Constructs an instance of MarketingDataInsightsServiceClient, 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 |
MarketingDataInsightsServiceSettings |
MarketingDataInsightsServiceClient(MarketingDataInsightsServiceStub stub)
protected MarketingDataInsightsServiceClient(MarketingDataInsightsServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
MarketingDataInsightsServiceStub |
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 |
|
close()
public final void close()getSettings()
public final MarketingDataInsightsServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
MarketingDataInsightsServiceSettings |
|
getStub()
public MarketingDataInsightsServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
MarketingDataInsightsServiceStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
retrieveInsights(RetrieveInsightsRequest request)
public final RetrieveInsightsResponse retrieveInsights(RetrieveInsightsRequest request)Retrieves marketing data insights for a given user list.
This feature is only available to data partners.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId}linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
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 (MarketingDataInsightsServiceClient marketingDataInsightsServiceClient =
MarketingDataInsightsServiceClient.create()) {
RetrieveInsightsRequest request =
RetrieveInsightsRequest.newBuilder()
.setParent("parent-995424086")
.setBaseline(Baseline.newBuilder().build())
.setUserListId("userListId1381604868")
.build();
RetrieveInsightsResponse response =
marketingDataInsightsServiceClient.retrieveInsights(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
RetrieveInsightsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
RetrieveInsightsResponse |
|
retrieveInsightsCallable()
public final UnaryCallable<RetrieveInsightsRequest,RetrieveInsightsResponse> retrieveInsightsCallable()Retrieves marketing data insights for a given user list.
This feature is only available to data partners.
Authorization Headers:
This method supports the following optional headers to define how the API authorizes access for the request:
login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format:accountTypes/{loginAccountType}/accounts/{loginAccountId}linked-account: (Optional) The resource name of the account with an established product link to thelogin-account. Format:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
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 (MarketingDataInsightsServiceClient marketingDataInsightsServiceClient =
MarketingDataInsightsServiceClient.create()) {
RetrieveInsightsRequest request =
RetrieveInsightsRequest.newBuilder()
.setParent("parent-995424086")
.setBaseline(Baseline.newBuilder().build())
.setUserListId("userListId1381604868")
.build();
ApiFuture<RetrieveInsightsResponse> future =
marketingDataInsightsServiceClient.retrieveInsightsCallable().futureCall(request);
// Do something.
RetrieveInsightsResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<RetrieveInsightsRequest,RetrieveInsightsResponse> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()