Search in sources :

Example 1 with SavedQuery

use of com.google.api.ads.admanager.axis.v202108.SavedQuery in project googleads-java-lib by googleads.

the class RunSavedQuery method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param savedQueryId the ID of the saved query to run. This ID is part of the URL in the Ad
 *     Manager UI.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 * @throws IOException if unable to write the response to a file.
 * @throws InterruptedException if the thread is interrupted while waiting for the report to
 *     complete.
 */
public static void runExample(AdManagerServices adManagerServices, AdManagerSession session, long savedQueryId) throws IOException, InterruptedException {
    // Get the ReportService.
    ReportServiceInterface reportService = adManagerServices.get(session, ReportServiceInterface.class);
    // Create statement to retrieve the saved query.
    StatementBuilder statementBuilder = new StatementBuilder().where("id = :id").orderBy("id ASC").limit(1).withBindVariableValue("id", savedQueryId);
    SavedQueryPage page = reportService.getSavedQueriesByStatement(statementBuilder.toStatement());
    SavedQuery savedQuery = Iterables.getOnlyElement(Arrays.asList(page.getResults()));
    if (!savedQuery.getIsCompatibleWithApiVersion()) {
        throw new IllegalStateException("The saved query is not compatible with this API version.");
    }
    // Optionally modify the query.
    ReportQuery reportQuery = savedQuery.getReportQuery();
    reportQuery.setAdUnitView(ReportQueryAdUnitView.HIERARCHICAL);
    // Create report job using the saved query.
    ReportJob reportJob = new ReportJob();
    reportJob.setReportQuery(reportQuery);
    // Run report job.
    reportJob = reportService.runReportJob(reportJob);
    // Create report downloader.
    ReportDownloader reportDownloader = new ReportDownloader(reportService, reportJob.getId());
    // Wait for the report to be ready.
    reportDownloader.waitForReportReady();
    // Change to your file location.
    File file = File.createTempFile("inventory-report-", ".csv.gz");
    System.out.printf("Downloading report to %s ...", file.toString());
    // Download the report.
    ReportDownloadOptions options = new ReportDownloadOptions();
    options.setExportFormat(ExportFormat.CSV_DUMP);
    options.setUseGzipCompression(true);
    URL url = reportDownloader.getDownloadUrl(options);
    Resources.asByteSource(url).copyTo(Files.asByteSink(file));
    System.out.println("done.");
}
Also used : ReportDownloader(com.google.api.ads.admanager.axis.utils.v202202.ReportDownloader) ReportDownloadOptions(com.google.api.ads.admanager.axis.v202202.ReportDownloadOptions) ReportQuery(com.google.api.ads.admanager.axis.v202202.ReportQuery) ReportServiceInterface(com.google.api.ads.admanager.axis.v202202.ReportServiceInterface) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202202.StatementBuilder) SavedQueryPage(com.google.api.ads.admanager.axis.v202202.SavedQueryPage) ReportJob(com.google.api.ads.admanager.axis.v202202.ReportJob) File(java.io.File) URL(java.net.URL) SavedQuery(com.google.api.ads.admanager.axis.v202202.SavedQuery)

Example 2 with SavedQuery

use of com.google.api.ads.admanager.axis.v202108.SavedQuery in project googleads-java-lib by googleads.

the class RunSavedQuery method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param savedQueryId the ID of the saved query to run. This ID is part of the URL in the Ad
 *     Manager UI.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 * @throws IOException if unable to write the response to a file.
 * @throws InterruptedException if the thread is interrupted while waiting for the report to
 *     complete.
 */
public static void runExample(AdManagerServices adManagerServices, AdManagerSession session, long savedQueryId) throws IOException, InterruptedException {
    // Get the ReportService.
    ReportServiceInterface reportService = adManagerServices.get(session, ReportServiceInterface.class);
    // Create statement to retrieve the saved query.
    StatementBuilder statementBuilder = new StatementBuilder().where("id = :id").orderBy("id ASC").limit(1).withBindVariableValue("id", savedQueryId);
    SavedQueryPage page = reportService.getSavedQueriesByStatement(statementBuilder.toStatement());
    SavedQuery savedQuery = Iterables.getOnlyElement(Arrays.asList(page.getResults()));
    if (!savedQuery.getIsCompatibleWithApiVersion()) {
        throw new IllegalStateException("The saved query is not compatible with this API version.");
    }
    // Optionally modify the query.
    ReportQuery reportQuery = savedQuery.getReportQuery();
    reportQuery.setAdUnitView(ReportQueryAdUnitView.HIERARCHICAL);
    // Create report job using the saved query.
    ReportJob reportJob = new ReportJob();
    reportJob.setReportQuery(reportQuery);
    // Run report job.
    reportJob = reportService.runReportJob(reportJob);
    // Create report downloader.
    ReportDownloader reportDownloader = new ReportDownloader(reportService, reportJob.getId());
    // Wait for the report to be ready.
    reportDownloader.waitForReportReady();
    // Change to your file location.
    File file = File.createTempFile("inventory-report-", ".csv.gz");
    System.out.printf("Downloading report to %s ...", file.toString());
    // Download the report.
    ReportDownloadOptions options = new ReportDownloadOptions();
    options.setExportFormat(ExportFormat.CSV_DUMP);
    options.setUseGzipCompression(true);
    URL url = reportDownloader.getDownloadUrl(options);
    Resources.asByteSource(url).copyTo(Files.asByteSink(file));
    System.out.println("done.");
}
Also used : ReportDownloader(com.google.api.ads.admanager.axis.utils.v202108.ReportDownloader) ReportDownloadOptions(com.google.api.ads.admanager.axis.v202108.ReportDownloadOptions) ReportQuery(com.google.api.ads.admanager.axis.v202108.ReportQuery) ReportServiceInterface(com.google.api.ads.admanager.axis.v202108.ReportServiceInterface) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202108.StatementBuilder) SavedQueryPage(com.google.api.ads.admanager.axis.v202108.SavedQueryPage) ReportJob(com.google.api.ads.admanager.axis.v202108.ReportJob) File(java.io.File) URL(java.net.URL) SavedQuery(com.google.api.ads.admanager.axis.v202108.SavedQuery)

Example 3 with SavedQuery

use of com.google.api.ads.admanager.axis.v202108.SavedQuery in project googleads-java-lib by googleads.

the class RunSavedQuery method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param savedQueryId the ID of the saved query to run. This ID is part of the URL in the Ad
 *     Manager UI.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 * @throws IOException if unable to write the response to a file.
 * @throws InterruptedException if the thread is interrupted while waiting for the report to
 *     complete.
 */
public static void runExample(AdManagerServices adManagerServices, AdManagerSession session, long savedQueryId) throws IOException, InterruptedException {
    // Get the ReportService.
    ReportServiceInterface reportService = adManagerServices.get(session, ReportServiceInterface.class);
    // Create statement to retrieve the saved query.
    StatementBuilder statementBuilder = new StatementBuilder().where("id = :id").orderBy("id ASC").limit(1).withBindVariableValue("id", savedQueryId);
    SavedQueryPage page = reportService.getSavedQueriesByStatement(statementBuilder.toStatement());
    SavedQuery savedQuery = Iterables.getOnlyElement(Arrays.asList(page.getResults()));
    if (!savedQuery.getIsCompatibleWithApiVersion()) {
        throw new IllegalStateException("The saved query is not compatible with this API version.");
    }
    // Optionally modify the query.
    ReportQuery reportQuery = savedQuery.getReportQuery();
    reportQuery.setAdUnitView(ReportQueryAdUnitView.HIERARCHICAL);
    // Create report job using the saved query.
    ReportJob reportJob = new ReportJob();
    reportJob.setReportQuery(reportQuery);
    // Run report job.
    reportJob = reportService.runReportJob(reportJob);
    // Create report downloader.
    ReportDownloader reportDownloader = new ReportDownloader(reportService, reportJob.getId());
    // Wait for the report to be ready.
    reportDownloader.waitForReportReady();
    // Change to your file location.
    File file = File.createTempFile("inventory-report-", ".csv.gz");
    System.out.printf("Downloading report to %s ...", file.toString());
    // Download the report.
    ReportDownloadOptions options = new ReportDownloadOptions();
    options.setExportFormat(ExportFormat.CSV_DUMP);
    options.setUseGzipCompression(true);
    URL url = reportDownloader.getDownloadUrl(options);
    Resources.asByteSource(url).copyTo(Files.asByteSink(file));
    System.out.println("done.");
}
Also used : ReportDownloader(com.google.api.ads.admanager.axis.utils.v202111.ReportDownloader) ReportDownloadOptions(com.google.api.ads.admanager.axis.v202111.ReportDownloadOptions) ReportQuery(com.google.api.ads.admanager.axis.v202111.ReportQuery) ReportServiceInterface(com.google.api.ads.admanager.axis.v202111.ReportServiceInterface) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202111.StatementBuilder) SavedQueryPage(com.google.api.ads.admanager.axis.v202111.SavedQueryPage) ReportJob(com.google.api.ads.admanager.axis.v202111.ReportJob) File(java.io.File) URL(java.net.URL) SavedQuery(com.google.api.ads.admanager.axis.v202111.SavedQuery)

Aggregations

File (java.io.File)3 URL (java.net.URL)3 ReportDownloader (com.google.api.ads.admanager.axis.utils.v202108.ReportDownloader)1 StatementBuilder (com.google.api.ads.admanager.axis.utils.v202108.StatementBuilder)1 ReportDownloader (com.google.api.ads.admanager.axis.utils.v202111.ReportDownloader)1 StatementBuilder (com.google.api.ads.admanager.axis.utils.v202111.StatementBuilder)1 ReportDownloader (com.google.api.ads.admanager.axis.utils.v202202.ReportDownloader)1 StatementBuilder (com.google.api.ads.admanager.axis.utils.v202202.StatementBuilder)1 ReportDownloadOptions (com.google.api.ads.admanager.axis.v202108.ReportDownloadOptions)1 ReportJob (com.google.api.ads.admanager.axis.v202108.ReportJob)1 ReportQuery (com.google.api.ads.admanager.axis.v202108.ReportQuery)1 ReportServiceInterface (com.google.api.ads.admanager.axis.v202108.ReportServiceInterface)1 SavedQuery (com.google.api.ads.admanager.axis.v202108.SavedQuery)1 SavedQueryPage (com.google.api.ads.admanager.axis.v202108.SavedQueryPage)1 ReportDownloadOptions (com.google.api.ads.admanager.axis.v202111.ReportDownloadOptions)1 ReportJob (com.google.api.ads.admanager.axis.v202111.ReportJob)1 ReportQuery (com.google.api.ads.admanager.axis.v202111.ReportQuery)1 ReportServiceInterface (com.google.api.ads.admanager.axis.v202111.ReportServiceInterface)1 SavedQuery (com.google.api.ads.admanager.axis.v202111.SavedQuery)1 SavedQueryPage (com.google.api.ads.admanager.axis.v202111.SavedQueryPage)1