Class ReportServiceClient (0.19.0)

Version latest

• 0.19.0 (latest)
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product Reference

Service Description: Service for retrieving reports and insights about your products, their performance, and their competitive environment on Google.

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 (ReportServiceClient reportServiceClient = ReportServiceClient.create()) {
   String parent = "parent-995424086";
   for (ReportRow element : reportServiceClient.search(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Note: close() needs to be called on the ReportServiceClient 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
Search	Retrieves a report defined by a search query. The response might contain fewer rows than specified by page_size. Rely on next_page_token to determine if there are more rows to be requested.	Request object method variants only take one parameter, a request object, which must be constructed before the call. search(SearchRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. search(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. searchPagedCallable() searchCallable()

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 ReportServiceSettings 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
 ReportServiceSettings reportServiceSettings =
     ReportServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ReportServiceClient reportServiceClient = ReportServiceClient.create(reportServiceSettings);
 

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
 ReportServiceSettings reportServiceSettings =
     ReportServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ReportServiceClient reportServiceClient = ReportServiceClient.create(reportServiceSettings);
 

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
 ReportServiceSettings reportServiceSettings =
     ReportServiceSettings.newHttpJsonBuilder().build();
 ReportServiceClient reportServiceClient = ReportServiceClient.create(reportServiceSettings);
 

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

Inheritance

java.lang.Object > ReportServiceClient

Static Methods

create()

public static final ReportServiceClient create()

Constructs an instance of ReportServiceClient with default settings.

Returns
Type	Description
ReportServiceClient

Exceptions
Type	Description
IOException

create(ReportServiceSettings settings)

public static final ReportServiceClient create(ReportServiceSettings settings)

Constructs an instance of ReportServiceClient, 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	ReportServiceSettings

Returns
Type	Description
ReportServiceClient

Exceptions
Type	Description
IOException

create(ReportServiceStub stub)

public static final ReportServiceClient create(ReportServiceStub stub)

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

Parameter
Name	Description
stub	ReportServiceStub

Returns
Type	Description
ReportServiceClient

Constructors

ReportServiceClient(ReportServiceSettings settings)

protected ReportServiceClient(ReportServiceSettings settings)

Constructs an instance of ReportServiceClient, 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	ReportServiceSettings

ReportServiceClient(ReportServiceStub stub)

protected ReportServiceClient(ReportServiceStub stub)

Parameter
Name	Description
stub	ReportServiceStub

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 ReportServiceSettings getSettings()

Returns
Type	Description
ReportServiceSettings

getStub()

public ReportServiceStub getStub()

Returns
Type	Description
ReportServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

search(SearchRequest request)

public final ReportServiceClient.SearchPagedResponse search(SearchRequest request)

Retrieves a report defined by a search query. The response might contain fewer rows than specified by page_size. Rely on next_page_token to determine if there are more rows to be requested.

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 (ReportServiceClient reportServiceClient = ReportServiceClient.create()) {
   SearchRequest request =
       SearchRequest.newBuilder()
           .setParent("parent-995424086")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ReportRow element : reportServiceClient.search(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
ReportServiceClient.SearchPagedResponse

search(String parent)

public final ReportServiceClient.SearchPagedResponse search(String parent)

Retrieves a report defined by a search query. The response might contain fewer rows than specified by page_size. Rely on next_page_token to determine if there are more rows to be requested.

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 (ReportServiceClient reportServiceClient = ReportServiceClient.create()) {
   String parent = "parent-995424086";
   for (ReportRow element : reportServiceClient.search(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}

Returns
Type	Description
ReportServiceClient.SearchPagedResponse

searchCallable()

public final UnaryCallable<SearchRequest,SearchResponse> searchCallable()

Retrieves a report defined by a search query. The response might contain fewer rows than specified by page_size. Rely on next_page_token to determine if there are more rows to be requested.

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 (ReportServiceClient reportServiceClient = ReportServiceClient.create()) {
   SearchRequest request =
       SearchRequest.newBuilder()
           .setParent("parent-995424086")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SearchResponse response = reportServiceClient.searchCallable().call(request);
     for (ReportRow element : response.getResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<SearchRequest,SearchResponse>

searchPagedCallable()

public final UnaryCallable<SearchRequest,ReportServiceClient.SearchPagedResponse> searchPagedCallable()

Retrieves a report defined by a search query. The response might contain fewer rows than specified by page_size. Rely on next_page_token to determine if there are more rows to be requested.

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 (ReportServiceClient reportServiceClient = ReportServiceClient.create()) {
   SearchRequest request =
       SearchRequest.newBuilder()
           .setParent("parent-995424086")
           .setQuery("query107944136")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ReportRow> future = reportServiceClient.searchPagedCallable().futureCall(request);
   // Do something.
   for (ReportRow element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<SearchRequest,SearchPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()