Search in sources :

Example 61 with ApiException

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

the class RunDeliveryReportForOrder method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @param orderId the ID of the order to run the report for.
 * @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 orderId) throws IOException, InterruptedException {
    // Get the ReportService.
    ReportServiceInterface reportService = adManagerServices.get(session, ReportServiceInterface.class);
    // Create report query.
    ReportQuery reportQuery = new ReportQuery();
    reportQuery.setDimensions(new Dimension[] { Dimension.DATE, Dimension.ORDER_ID });
    reportQuery.setColumns(new Column[] { Column.AD_SERVER_IMPRESSIONS, Column.AD_SERVER_CLICKS, Column.AD_SERVER_CTR, Column.AD_SERVER_CPM_AND_CPC_REVENUE });
    reportQuery.setDimensionAttributes(new DimensionAttribute[] { DimensionAttribute.ORDER_TRAFFICKER, DimensionAttribute.ORDER_START_DATE_TIME, DimensionAttribute.ORDER_END_DATE_TIME });
    // Create statement to filter for an order.
    StatementBuilder statementBuilder = new StatementBuilder().where("ORDER_ID = :orderId").withBindVariableValue("orderId", orderId);
    // Set the filter statement.
    reportQuery.setStatement(statementBuilder.toStatement());
    // Set the start and end dates or choose a dynamic date range type.
    reportQuery.setDateRangeType(DateRangeType.CUSTOM_DATE);
    reportQuery.setStartDate(DateTimes.toDateTime("2013-05-01T00:00:00", "America/New_York").getDate());
    reportQuery.setEndDate(DateTimes.toDateTime("2013-05-31T00:00:00", "America/New_York").getDate());
    // Create report job.
    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("delivery-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) ReportJob(com.google.api.ads.admanager.axis.v202108.ReportJob) File(java.io.File) URL(java.net.URL)

Example 62 with ApiException

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

the class CreateOrders method main.

public static void main(String[] args) {
    AdManagerSession session;
    try {
        // Generate a refreshable OAuth2 credential.
        Credential oAuth2Credential = new OfflineCredentials.Builder().forApi(Api.AD_MANAGER).fromFile().build().generateCredential();
        // Construct a AdManagerSession.
        session = new AdManagerSession.Builder().fromFile().withOAuth2Credential(oAuth2Credential).build();
    } catch (ConfigurationLoadException cle) {
        System.err.printf("Failed to load configuration from the %s file. Exception: %s%n", DEFAULT_CONFIGURATION_FILENAME, cle);
        return;
    } catch (ValidationException ve) {
        System.err.printf("Invalid configuration in the %s file. Exception: %s%n", DEFAULT_CONFIGURATION_FILENAME, ve);
        return;
    } catch (OAuthException oe) {
        System.err.printf("Failed to create OAuth credentials. Check OAuth settings in the %s file. " + "Exception: %s%n", DEFAULT_CONFIGURATION_FILENAME, oe);
        return;
    }
    AdManagerServices adManagerServices = new AdManagerServices();
    CreateOrdersParams params = new CreateOrdersParams();
    if (!params.parseArguments(args)) {
        // Either pass the required parameters for this example on the command line, or insert them
        // into the code here. See the parameter class definition above for descriptions.
        params.advertiserId = Long.parseLong("INSERT_ADVERTISER_ID_HERE");
        params.traffickerId = Long.parseLong("INSERT_TRAFFICKER_ID_HERE");
    }
    try {
        runExample(adManagerServices, session, params.advertiserId, params.traffickerId);
    } catch (ApiException apiException) {
        // ApiException is the base class for most exceptions thrown by an API request. Instances
        // of this exception have a message and a collection of ApiErrors that indicate the
        // type and underlying cause of the exception. Every exception object in the admanager.axis
        // packages will return a meaningful value from toString
        // 
        // ApiException extends RemoteException, so this catch block must appear before the
        // catch block for RemoteException.
        System.err.println("Request failed due to ApiException. Underlying ApiErrors:");
        if (apiException.getErrors() != null) {
            int i = 0;
            for (ApiError apiError : apiException.getErrors()) {
                System.err.printf("  Error %d: %s%n", i++, apiError);
            }
        }
    } catch (RemoteException re) {
        System.err.printf("Request failed unexpectedly due to RemoteException: %s%n", re);
    }
}
Also used : Credential(com.google.api.client.auth.oauth2.Credential) ValidationException(com.google.api.ads.common.lib.exception.ValidationException) ConfigurationLoadException(com.google.api.ads.common.lib.conf.ConfigurationLoadException) OAuthException(com.google.api.ads.common.lib.exception.OAuthException) ApiError(com.google.api.ads.admanager.axis.v202108.ApiError) RemoteException(java.rmi.RemoteException) AdManagerSession(com.google.api.ads.admanager.lib.client.AdManagerSession) AdManagerServices(com.google.api.ads.admanager.axis.factory.AdManagerServices) ApiException(com.google.api.ads.admanager.axis.v202108.ApiException)

Example 63 with ApiException

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

the class GetOrdersStartingSoon method main.

public static void main(String[] args) {
    AdManagerSession session;
    try {
        // Generate a refreshable OAuth2 credential.
        Credential oAuth2Credential = new OfflineCredentials.Builder().forApi(Api.AD_MANAGER).fromFile().build().generateCredential();
        // Construct a AdManagerSession.
        session = new AdManagerSession.Builder().fromFile().withOAuth2Credential(oAuth2Credential).build();
    } catch (ConfigurationLoadException cle) {
        System.err.printf("Failed to load configuration from the %s file. Exception: %s%n", DEFAULT_CONFIGURATION_FILENAME, cle);
        return;
    } catch (ValidationException ve) {
        System.err.printf("Invalid configuration in the %s file. Exception: %s%n", DEFAULT_CONFIGURATION_FILENAME, ve);
        return;
    } catch (OAuthException oe) {
        System.err.printf("Failed to create OAuth credentials. Check OAuth settings in the %s file. " + "Exception: %s%n", DEFAULT_CONFIGURATION_FILENAME, oe);
        return;
    }
    AdManagerServices adManagerServices = new AdManagerServices();
    try {
        runExample(adManagerServices, session);
    } catch (ApiException apiException) {
        // ApiException is the base class for most exceptions thrown by an API request. Instances
        // of this exception have a message and a collection of ApiErrors that indicate the
        // type and underlying cause of the exception. Every exception object in the admanager.axis
        // packages will return a meaningful value from toString
        // 
        // ApiException extends RemoteException, so this catch block must appear before the
        // catch block for RemoteException.
        System.err.println("Request failed due to ApiException. Underlying ApiErrors:");
        if (apiException.getErrors() != null) {
            int i = 0;
            for (ApiError apiError : apiException.getErrors()) {
                System.err.printf("  Error %d: %s%n", i++, apiError);
            }
        }
    } catch (RemoteException re) {
        System.err.printf("Request failed unexpectedly due to RemoteException: %s%n", re);
    }
}
Also used : Credential(com.google.api.client.auth.oauth2.Credential) ValidationException(com.google.api.ads.common.lib.exception.ValidationException) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202108.StatementBuilder) ConfigurationLoadException(com.google.api.ads.common.lib.conf.ConfigurationLoadException) OAuthException(com.google.api.ads.common.lib.exception.OAuthException) ApiError(com.google.api.ads.admanager.axis.v202108.ApiError) RemoteException(java.rmi.RemoteException) AdManagerSession(com.google.api.ads.admanager.lib.client.AdManagerSession) AdManagerServices(com.google.api.ads.admanager.axis.factory.AdManagerServices) ApiException(com.google.api.ads.admanager.axis.v202108.ApiException)

Example 64 with ApiException

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

the class CreatePlacements method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 */
public static void runExample(AdManagerServices adManagerServices, AdManagerSession session) throws RemoteException {
    // Get the PlacementService.
    PlacementServiceInterface placementService = adManagerServices.get(session, PlacementServiceInterface.class);
    // Get all ad units.
    List<AdUnit> adUnits = getAllAdUnits(adManagerServices, session);
    // Partition ad units by their size.
    Set<String> mediumSquareAdUnitIds = Sets.newHashSet();
    Set<String> skyscraperAdUnitIds = Sets.newHashSet();
    Set<String> bannerAdUnitIds = Sets.newHashSet();
    for (AdUnit adUnit : adUnits) {
        if (adUnit.getParentId() != null && adUnit.getAdUnitSizes() != null) {
            for (AdUnitSize adUnitSize : adUnit.getAdUnitSizes()) {
                Size size = adUnitSize.getSize();
                if (size.getWidth() == 300 && size.getHeight() == 250) {
                    mediumSquareAdUnitIds.add(adUnit.getId());
                } else if (size.getWidth() == 120 && size.getHeight() == 600) {
                    skyscraperAdUnitIds.add(adUnit.getId());
                } else if (size.getWidth() == 468 && size.getHeight() == 60) {
                    bannerAdUnitIds.add(adUnit.getId());
                }
            }
        }
    }
    List<Placement> placementsToCreate = new ArrayList<>();
    // Only create placements with one or more ad unit.
    if (!mediumSquareAdUnitIds.isEmpty()) {
        // Create medium square placement.
        Placement mediumSquareAdUnitPlacement = new Placement();
        mediumSquareAdUnitPlacement.setName("Medium Square AdUnit Placement #" + new Random().nextInt(Integer.MAX_VALUE));
        mediumSquareAdUnitPlacement.setDescription("Contains ad units that can hold creatives of size 300x250");
        mediumSquareAdUnitPlacement.setTargetedAdUnitIds(mediumSquareAdUnitIds.toArray(new String[] {}));
        placementsToCreate.add(mediumSquareAdUnitPlacement);
    }
    if (!skyscraperAdUnitIds.isEmpty()) {
        // Create skyscraper placement.
        Placement skyscraperAdUnitPlacement = new Placement();
        skyscraperAdUnitPlacement.setName("Skyscraper AdUnit Placement #" + new Random().nextInt(Integer.MAX_VALUE));
        skyscraperAdUnitPlacement.setDescription("Contains ad units that can hold creatives of size 120x600");
        skyscraperAdUnitPlacement.setTargetedAdUnitIds(skyscraperAdUnitIds.toArray(new String[] {}));
        placementsToCreate.add(skyscraperAdUnitPlacement);
    }
    if (!bannerAdUnitIds.isEmpty()) {
        // Create banner placement.
        Placement bannerAdUnitPlacement = new Placement();
        bannerAdUnitPlacement.setName("Banner AdUnit Placement #" + new Random().nextInt(Integer.MAX_VALUE));
        bannerAdUnitPlacement.setDescription("Contains ad units that can hold creatives of size 468x60");
        bannerAdUnitPlacement.setTargetedAdUnitIds(bannerAdUnitIds.toArray(new String[] {}));
        placementsToCreate.add(bannerAdUnitPlacement);
    }
    if (!placementsToCreate.isEmpty()) {
        // Create the placements on the server.
        Placement[] placements = placementService.createPlacements(placementsToCreate.toArray(new Placement[] {}));
        for (Placement createdPlacement : placements) {
            System.out.printf("A placement with ID %d, name '%s', and containing ad units [%s] was created.%n", createdPlacement.getId(), createdPlacement.getName(), Joiner.on(", ").join(createdPlacement.getTargetedAdUnitIds()));
        }
    } else {
        System.out.println("No placements were created.");
    }
}
Also used : AdUnitSize(com.google.api.ads.admanager.axis.v202108.AdUnitSize) AdUnit(com.google.api.ads.admanager.axis.v202108.AdUnit) Random(java.util.Random) Placement(com.google.api.ads.admanager.axis.v202108.Placement) Size(com.google.api.ads.admanager.axis.v202108.Size) AdUnitSize(com.google.api.ads.admanager.axis.v202108.AdUnitSize) ArrayList(java.util.ArrayList) PlacementServiceInterface(com.google.api.ads.admanager.axis.v202108.PlacementServiceInterface)

Example 65 with ApiException

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

the class GetActivePlacements method runExample.

/**
 * Runs the example.
 *
 * @param adManagerServices the services factory.
 * @param session the session.
 * @throws ApiException if the API request failed with one or more service errors.
 * @throws RemoteException if the API request failed due to other errors.
 */
public static void runExample(AdManagerServices adManagerServices, AdManagerSession session) throws RemoteException {
    PlacementServiceInterface placementService = adManagerServices.get(session, PlacementServiceInterface.class);
    // Create a statement to select placements.
    StatementBuilder statementBuilder = new StatementBuilder().where("status = :status").orderBy("id ASC").limit(StatementBuilder.SUGGESTED_PAGE_LIMIT).withBindVariableValue("status", InventoryStatus.ACTIVE.toString());
    // Retrieve a small amount of placements at a time, paging through
    // until all placements have been retrieved.
    int totalResultSetSize = 0;
    do {
        PlacementPage page = placementService.getPlacementsByStatement(statementBuilder.toStatement());
        if (page.getResults() != null) {
            // Print out some information for each placement.
            totalResultSetSize = page.getTotalResultSetSize();
            int i = page.getStartIndex();
            for (Placement placement : page.getResults()) {
                System.out.printf("%d) Placement with ID %d and name '%s' was found.%n", i++, placement.getId(), placement.getName());
            }
        }
        statementBuilder.increaseOffsetBy(StatementBuilder.SUGGESTED_PAGE_LIMIT);
    } while (statementBuilder.getOffset() < totalResultSetSize);
    System.out.printf("Number of results found: %d%n", totalResultSetSize);
}
Also used : PlacementPage(com.google.api.ads.admanager.axis.v202108.PlacementPage) Placement(com.google.api.ads.admanager.axis.v202108.Placement) StatementBuilder(com.google.api.ads.admanager.axis.utils.v202108.StatementBuilder) PlacementServiceInterface(com.google.api.ads.admanager.axis.v202108.PlacementServiceInterface)

Aggregations

ConfigurationLoadException (com.google.api.ads.common.lib.conf.ConfigurationLoadException)490 OAuthException (com.google.api.ads.common.lib.exception.OAuthException)490 ValidationException (com.google.api.ads.common.lib.exception.ValidationException)490 RemoteException (java.rmi.RemoteException)490 AdManagerServices (com.google.api.ads.admanager.axis.factory.AdManagerServices)487 AdManagerSession (com.google.api.ads.admanager.lib.client.AdManagerSession)487 Credential (com.google.api.client.auth.oauth2.Credential)487 StatementBuilder (com.google.api.ads.admanager.axis.utils.v202108.StatementBuilder)233 ApiException (com.google.api.ads.admanager.axis.v202202.ApiException)164 ApiException (com.google.api.ads.admanager.axis.v202108.ApiException)163 ApiException (com.google.api.ads.admanager.axis.v202111.ApiException)163 ApiError (com.google.api.ads.admanager.axis.v202202.ApiError)163 ApiError (com.google.api.ads.admanager.axis.v202108.ApiError)162 ApiError (com.google.api.ads.admanager.axis.v202111.ApiError)162 StatementBuilder (com.google.api.ads.admanager.axis.utils.v202111.StatementBuilder)117 StatementBuilder (com.google.api.ads.admanager.axis.utils.v202202.StatementBuilder)117 IOException (java.io.IOException)59 Random (java.util.Random)25 UpdateResult (com.google.api.ads.admanager.axis.v202108.UpdateResult)18 NetworkServiceInterface (com.google.api.ads.admanager.axis.v202108.NetworkServiceInterface)15