Merge pull request #215 from BingAds/v13.0.24

v13.0.24

Author: xinyuwen2

README.md

@@ -16,7 +16,7 @@ The Bing Ads Java SDK includes and depends on the microsoft.bingads Maven artifa
 <dependency>
   <groupId>com.microsoft.bingads</groupId>
   <artifactId>microsoft.bingads</artifactId>
-  <version>13.0.23.2</version>
+  <version>13.0.24</version>
 </dependency>
 ```
 If you are not using a Maven project, you must include the correct version of each dependency. You can review the complete list of Bing Ads Java SDK dependencies at the [Maven Repository](http://mvnrepository.com/artifact/com.microsoft.bingads/microsoft.bingads/).

examples/BingAdsDesktopApp/src/main/java/com/microsoft/bingads/examples/v13/ResponsiveAdRecommendation.java

@@ -0,0 +1,245 @@
+package com.microsoft.bingads.examples.v13;
+
+import com.microsoft.bingads.*;
+import com.microsoft.bingads.v13.campaignmanagement.*;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.UnsupportedEncodingException;
+import java.net.URL;
+import java.nio.file.Files;
+import java.rmi.RemoteException;
+import java.util.Base64;
+import java.util.Calendar;
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class ResponsiveAdRecommendation extends ExampleBase {
+    public static void main(java.lang.String[] args) {
+
+        // To run this example you'll need to provide a valid Ad Final URL
+        String AdFinalURL = "https://contoso.com";
+
+        // Set to false to disable cleanup of created entities at the end
+        boolean DoCleanup = true;
+
+        try {
+            authorizationData = getAuthorizationData();
+
+            CampaignManagementExampleHelper.CampaignManagementService = new ServiceClient<ICampaignManagementService>(
+                    authorizationData,
+                    API_ENVIRONMENT,
+                    ICampaignManagementService.class);
+
+            CreateResponsiveAdRecommendationRequest request = new CreateResponsiveAdRecommendationRequest();
+
+            request.setFinalUrls(new ArrayOfstring(Arrays.asList(AdFinalURL)));
+
+            System.out.println("Getting ad recommendation for URL " + AdFinalURL + " ...");
+
+            CreateResponsiveAdRecommendationResponse recommendationResponse =
+                CampaignManagementExampleHelper.CampaignManagementService.getService().createResponsiveAdRecommendation(request);
+
+            ResponsiveAd ad = recommendationResponse.getResponsiveAd();
+
+            List<AdRecommendationImageSuggestion> imageSuggestions = recommendationResponse
+                .getImageSuggestions()
+                .getAdRecommendationImageSuggestions();
+
+            // select a few images from the suggested list. This example picks first 5 images
+            List<AdRecommendationImageSuggestion> selectedImages = imageSuggestions.subList(0, 5);
+
+            // add selected images to your media library
+            saveImages(selectedImages);
+            
+            ad.setImages(new ArrayOfAssetLink(selectedImages.stream().map(x -> x.getAssetLink()).collect(Collectors.toList())));
+
+            ad.setBusinessName("Contoso");
+            ad.setCallToActionLanguage(LanguageName.ENGLISH);
+
+            // Create an Audience campaign with one ad group and a responsive ad.
+
+            ArrayOfCampaign campaigns = new ArrayOfCampaign();
+            Campaign campaign = new Campaign();
+            campaign.setBudgetType(BudgetLimitType.DAILY_BUDGET_STANDARD);
+            // CampaignType must be set for Audience campaigns
+            ArrayList<CampaignType> campaignTypes = new ArrayList<CampaignType>();
+            campaignTypes.add(CampaignType.AUDIENCE);
+            campaign.setCampaignType(campaignTypes);
+            campaign.setDailyBudget(50.00);
+            ArrayOfstring languages = new ArrayOfstring();
+            languages.getStrings().add("All");
+            campaign.setLanguages(languages);
+            campaign.setName("Ad recommendation test " + new java.util.Date());
+            campaign.setTimeZone("PacificTimeUSCanadaTijuana");
+            campaigns.getCampaigns().add(campaign);
+
+            outputStatusMessage("-----\nAddCampaigns:");
+            AddCampaignsResponse addCampaignsResponse = CampaignManagementExampleHelper.addCampaigns(
+                    authorizationData.getAccountId(),
+                    campaigns);
+            ArrayOfNullableOflong campaignIds = addCampaignsResponse.getCampaignIds();
+            ArrayOfBatchError campaignErrors = addCampaignsResponse.getPartialErrors();
+            outputStatusMessage("CampaignIds:");
+            CampaignManagementExampleHelper.outputArrayOfNullableOflong(campaignIds);
+            outputStatusMessage("PartialErrors:");
+            CampaignManagementExampleHelper.outputArrayOfBatchError(campaignErrors);
+
+            // Add an ad group within the campaign.
+
+            ArrayOfAdGroup adGroups = new ArrayOfAdGroup();
+            AdGroup adGroup = new AdGroup();
+            adGroup.setName("Holiday Sale");
+            adGroup.setStartDate(null);
+            Calendar calendar = Calendar.getInstance();
+            adGroup.setEndDate(new com.microsoft.bingads.v13.campaignmanagement.Date());
+            adGroup.getEndDate().setDay(31);
+            adGroup.getEndDate().setMonth(12);
+            adGroup.getEndDate().setYear(calendar.get(Calendar.YEAR));
+            Bid CpcBid = new Bid();
+            CpcBid.setAmount(0.09);
+            adGroup.setCpcBid(CpcBid);
+            // Network cannot be set for ad groups in Audience campaigns
+            adGroup.setNetwork(null);
+            adGroups.getAdGroups().add(adGroup);
+
+            outputStatusMessage("-----\nAddAdGroups:");
+            AddAdGroupsResponse addAdGroupsResponse = CampaignManagementExampleHelper.addAdGroups(
+                    campaignIds.getLongs().get(0),
+                    adGroups,
+                    false);
+            ArrayOfNullableOflong adGroupIds = addAdGroupsResponse.getAdGroupIds();
+            ArrayOfBatchError adGroupErrors = addAdGroupsResponse.getPartialErrors();
+            outputStatusMessage("AdGroupIds:");
+            CampaignManagementExampleHelper.outputArrayOfNullableOflong(adGroupIds);
+            outputStatusMessage("PartialErrors:");
+            CampaignManagementExampleHelper.outputArrayOfBatchError(adGroupErrors);
+
+            // Add a responsive ad within the ad group.
+
+            ArrayOfAd ads = new ArrayOfAd();
+
+            ads.getAds().add(ad);
+
+            outputStatusMessage("-----\nAddAds:");
+            AddAdsResponse addAdsResponse = CampaignManagementExampleHelper.addAds(
+                    adGroupIds.getLongs().get(0),
+                    ads);
+            ArrayOfNullableOflong adIds = addAdsResponse.getAdIds();
+            ArrayOfBatchError adErrors = addAdsResponse.getPartialErrors();
+            outputStatusMessage("AdIds:");
+            CampaignManagementExampleHelper.outputArrayOfNullableOflong(adIds);
+            outputStatusMessage("PartialErrors:");
+            CampaignManagementExampleHelper.outputArrayOfBatchError(adErrors);
+
+            System.out.println("\nCreated campaign: " + campaign.getName());
+
+            if (!DoCleanup) {
+                return;
+            }
+
+            // Delete the account's media.
+
+            ArrayOflong mediaIds = new ArrayOflong(ad.getImages().getAssetLinks().stream().map(x -> x.getAsset().getId()).collect(Collectors.toList()));
+
+            outputStatusMessage("-----\nDeleteMedia:");
+            CampaignManagementExampleHelper.deleteMedia(
+                    authorizationData.getAccountId(),
+                    mediaIds);
+
+            for (java.lang.Long id : mediaIds.getLongs()) {
+                outputStatusMessage(String.format("Deleted Media Id %s", id));
+            }
+
+            // Delete the campaign and everything it contains e.g., ad groups and ads.
+
+            outputStatusMessage("-----\nDeleteCampaigns:");
+            ArrayOflong deleteCampaignIds = new ArrayOflong();
+            deleteCampaignIds.getLongs().add(campaignIds.getLongs().get(0));
+            CampaignManagementExampleHelper.deleteCampaigns(
+                    authorizationData.getAccountId(),
+                    deleteCampaignIds);
+            outputStatusMessage(String.format("Deleted CampaignId %d", deleteCampaignIds.getLongs().get(0)));
+        } catch (Exception ex) {
+            String faultXml = ExampleExceptionHelper.getBingAdsExceptionFaultXml(ex, System.out);
+            outputStatusMessage(faultXml);
+            String message = ExampleExceptionHelper.handleBingAdsSDKException(ex, System.out);
+            outputStatusMessage(message);
+        }
+    }
+
+    // Get image media that can be managed with the Campaign Management API.
+
+    static Image getImageMedia(
+            java.lang.String mediaType,
+            java.lang.String imageFileName) throws UnsupportedEncodingException, IOException {
+        Image image = new Image();
+        image.setData(getBmpBase64String(imageFileName));
+        image.setMediaType(mediaType);
+        image.setType("Image");
+
+        return image;
+    }
+
+    // Get the image media as base64 string.
+
+    static java.lang.String getBmpBase64String(
+            java.lang.String imageFileName) throws UnsupportedEncodingException, IOException {
+        File fi = new File(imageFileName);
+        byte[] imageBytes = Files.readAllBytes(fi.toPath());
+        java.lang.String base64String = new java.lang.String(Base64.getEncoder().encode(imageBytes), "UTF-8");
+        return base64String;
+    }
+
+    private static void saveImages(List<AdRecommendationImageSuggestion> imageSuggestions) throws RemoteException, Exception {
+        ArrayOfMedia mediaToAdd = new ArrayOfMedia();
+
+        for (AdRecommendationImageSuggestion imageSuggestion : imageSuggestions) {
+            Image image = imageSuggestion.getImage();
+                           
+            byte[] imageBytes = downloadBytes(new URL(imageSuggestion.getImageUrl()));
+
+            String imageBase64 = new String(Base64.getEncoder().encode(imageBytes));   
+            
+            image.setData(imageBase64);
+
+            mediaToAdd.getMedias().add(image);
+        }
+
+        ArrayOflong mediaIds = CampaignManagementExampleHelper.addMedia(
+            authorizationData.getAccountId(),
+            mediaToAdd).getMediaIds();
+
+        for (int i = 0; i < mediaIds.getLongs().size(); i++) {
+            imageSuggestions.get(i).getAssetLink().getAsset().setId(mediaIds.getLongs().get(i));
+        }
+    }
+
+    private static byte[] downloadBytes(URL url) throws IOException {
+        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+
+        byte[] buffer = new byte[4096];
+
+        int bytesRead;
+
+        InputStream inputStream = null;
+
+        try {
+            inputStream = url.openStream();
+
+            while ((bytesRead = inputStream.read(buffer)) > 0) {
+                outputStream.write(buffer, 0, bytesRead);
+            }
+
+            return outputStream.toByteArray();
+        } finally {
+            if (inputStream != null) {
+                inputStream.close();
+            }
+        }
+    }
+}

pom.xml

@@ -1,7 +1,7 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.microsoft.bingads</groupId>
-    <version>13.0.23.2</version>
+    <version>13.0.24</version>
     <name>Bing Ads Java SDK</name>
     <description>The Bing Ads Java SDK is a library improving developer experience when working with the Bing Ads services by providing high-level access to features such as Bulk API, OAuth Authorization and SOAP API.</description>
     <url>https://github.com/BingAds/BingAds-Java-SDK</url>

proxies/com/microsoft/bingads/v13/bulk/DownloadEntity.java

@@ -197,6 +197,11 @@
  *     <enumeration value="CampaignImpressionBasedRemarketingListAssociations"/>
  *     <enumeration value="CampaignNegativeImpressionBasedRemarketingListAssociations"/>
  *     <enumeration value="AssetGroupUrlTargets"/>
+ *     <enumeration value="NewCustomerAcquisitionGoal"/>
+ *     <enumeration value="ConversionValueRule"/>
+ *     <enumeration value="AccountPlacementExclusionList"/>
+ *     <enumeration value="AccountPlacementExclusionListItem"/>
+ *     <enumeration value="CampaignAccountPlacementExclusionListAssociation"/>
  *   </restriction>
  * </simpleType>
  * }</pre>
@@ -573,7 +578,17 @@ public enum DownloadEntity {
     @XmlEnumValue("CampaignNegativeImpressionBasedRemarketingListAssociations")
     CAMPAIGN_NEGATIVE_IMPRESSION_BASED_REMARKETING_LIST_ASSOCIATIONS("CampaignNegativeImpressionBasedRemarketingListAssociations"),
     @XmlEnumValue("AssetGroupUrlTargets")
-    ASSET_GROUP_URL_TARGETS("AssetGroupUrlTargets");
+    ASSET_GROUP_URL_TARGETS("AssetGroupUrlTargets"),
+    @XmlEnumValue("NewCustomerAcquisitionGoal")
+    NEW_CUSTOMER_ACQUISITION_GOAL("NewCustomerAcquisitionGoal"),
+    @XmlEnumValue("ConversionValueRule")
+    CONVERSION_VALUE_RULE("ConversionValueRule"),
+    @XmlEnumValue("AccountPlacementExclusionList")
+    ACCOUNT_PLACEMENT_EXCLUSION_LIST("AccountPlacementExclusionList"),
+    @XmlEnumValue("AccountPlacementExclusionListItem")
+    ACCOUNT_PLACEMENT_EXCLUSION_LIST_ITEM("AccountPlacementExclusionListItem"),
+    @XmlEnumValue("CampaignAccountPlacementExclusionListAssociation")
+    CAMPAIGN_ACCOUNT_PLACEMENT_EXCLUSION_LIST_ASSOCIATION("CampaignAccountPlacementExclusionListAssociation");
     private final String value;
 
     DownloadEntity(String v) {

proxies/com/microsoft/bingads/v13/campaignmanagement/AccountPlacementExclusionList.java

@@ -0,0 +1,37 @@
+
+package com.microsoft.bingads.v13.campaignmanagement;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlType;
+
+
+/**
+ * <p>Java class for AccountPlacementExclusionList complex type.
+ * 
+ * <p>The following schema fragment specifies the expected content contained within this class.
+ * 
+ * <pre>{@code
+ * <complexType name="AccountPlacementExclusionList">
+ *   <complexContent>
+ *     <extension base="{https://bingads.microsoft.com/CampaignManagement/v13}SharedList">
+ *       <sequence>
+ *       </sequence>
+ *     </extension>
+ *   </complexContent>
+ * </complexType>
+ * }</pre>
+ * 
+ * 
+ */
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "AccountPlacementExclusionList")
+public class AccountPlacementExclusionList
+    extends SharedList
+{
+    public AccountPlacementExclusionList() {
+      this.type = "AccountPlacementExclusionList";
+    }
+
+
+}

proxies/com/microsoft/bingads/v13/campaignmanagement/AccountPlacementInclusionList.java

@@ -0,0 +1,37 @@
+
+package com.microsoft.bingads.v13.campaignmanagement;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlType;
+
+
+/**
+ * <p>Java class for AccountPlacementInclusionList complex type.
+ * 
+ * <p>The following schema fragment specifies the expected content contained within this class.
+ * 
+ * <pre>{@code
+ * <complexType name="AccountPlacementInclusionList">
+ *   <complexContent>
+ *     <extension base="{https://bingads.microsoft.com/CampaignManagement/v13}SharedList">
+ *       <sequence>
+ *       </sequence>
+ *     </extension>
+ *   </complexContent>
+ * </complexType>
+ * }</pre>
+ * 
+ * 
+ */
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "AccountPlacementInclusionList")
+public class AccountPlacementInclusionList
+    extends SharedList
+{
+    public AccountPlacementInclusionList() {
+      this.type = "AccountPlacementInclusionList";
+    }
+
+
+}