Updating DFA Reporting API examples for v1.3 https://codereview.appspot.com/11577043/

Author: Joseph DiLallo

dfareporting-cmdline-sample/pom.xml

@@ -109,7 +109,7 @@
     <dependency>
       <groupId>com.google.apis</groupId>
       <artifactId>google-api-services-dfareporting</artifactId>
-      <version>v1.2-rev4-1.16.0-rc</version>
+      <version>v1.3-rev3-1.16.0-rc</version>
     </dependency>
     <dependency>
       <groupId>com.google.http-client</groupId>

dfareporting-cmdline-sample/src/main/java/com/google/api/services/samples/dfareporting/cmdline/DfaReportingSample.java

@@ -66,10 +66,9 @@ public class DfaReportingSample {
    * globally shared instance across your application.
    */
   private static FileDataStoreFactory DATA_STORE_FACTORY;
-  
+
   private static final List<String> SCOPES = ImmutableList.of(
-      "https://www.googleapis.com/auth/dfareporting",
-      "https://www.googleapis.com/auth/devstorage.read_only");
+      "https://www.googleapis.com/auth/dfareporting");
 
   private static HttpTransport TRANSPORT;
   private static final JsonFactory JSON_FACTORY = new JacksonFactory();
@@ -145,6 +144,7 @@ public static void main(String[] args) {
 
         Report standardReport = CreateStandardReport.insert(reporting, userProfileId,
             advertiser, startDate, endDate);
+        GetCompatibleFields.run(reporting, userProfileId, standardReport);
         File file = GenerateReportFile.run(reporting, userProfileId, standardReport, true);
 
         if (file != null) {

dfareporting-cmdline-sample/src/main/java/com/google/api/services/samples/dfareporting/cmdline/DownloadReportFile.java

@@ -14,9 +14,6 @@
 
 package com.google.api.services.samples.dfareporting.cmdline;
 
-import com.google.api.client.http.GenericUrl;
-import com.google.api.client.http.HttpRequest;
-import com.google.api.client.http.HttpRequestFactory;
 import com.google.api.client.http.HttpResponse;
 import com.google.api.client.util.Charsets;
 import com.google.api.services.dfareporting.Dfareporting;
@@ -33,7 +30,7 @@
 public class DownloadReportFile {
 
   /**
-   * Fetchs the contents of a report file.
+   * Fetches the contents of a report file.
    *
    * @param reporting Dfareporting service object on which to run the requests.
    * @param reportFile The completed report file to download.
@@ -47,16 +44,19 @@ public static void run(Dfareporting reporting, File reportFile)
     System.out.printf("The ID number of this report file is %s%n", reportFile.getId());
     System.out.println("=================================================================");
 
-    String url = reportFile.getUrls().getApiUrl();
-    GenericUrl genericUrl = new GenericUrl(url);
-    HttpRequestFactory httpRequestFactory = reporting.getRequestFactory();
-    HttpRequest httpRequest = httpRequestFactory.buildGetRequest(genericUrl);
-    HttpResponse response = httpRequest.execute();
-    BufferedReader reader = new BufferedReader(
-        new InputStreamReader(response.getContent(), Charsets.UTF_8));
-    String line;
-    while ((line = reader.readLine()) != null) {
-      System.out.println(line);
+    HttpResponse fileContents = reporting.files()
+        .get(reportFile.getReportId(), reportFile.getId())
+        .executeMedia();
+
+    try {
+      BufferedReader reader = new BufferedReader(
+          new InputStreamReader(fileContents.getContent(), Charsets.UTF_8));
+      String line;
+      while ((line = reader.readLine()) != null) {
+        System.out.println(line);
+      }
+    } finally {
+      fileContents.disconnect();
     }
   }
 }

dfareporting-cmdline-sample/src/main/java/com/google/api/services/samples/dfareporting/cmdline/GetCompatibleFields.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright (c) 2013 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package com.google.api.services.samples.dfareporting.cmdline;
+
+import com.google.api.services.dfareporting.Dfareporting;
+import com.google.api.services.dfareporting.model.CompatibleFields;
+import com.google.api.services.dfareporting.model.Dimension;
+import com.google.api.services.dfareporting.model.Metric;
+import com.google.api.services.dfareporting.model.Report;
+import com.google.api.services.dfareporting.model.ReportCompatibleFields;
+
+/**
+ * This example fetches and displays the compatible fields for the given standard report. There
+ * are two reasons why metrics and/or dimensions may be incompatible with your report:
+ *
+ * <ul><li>Your user profile doesn't have permission to view those fields</li>
+ * <li>Your report contains a field which is incompatible with certain other fields</li></ul>
+ *
+ * Tags: compatibleFields.query
+ *
+ * @author [email protected] (Joseph DiLallo)
+ */
+public class GetCompatibleFields {
+
+  /**
+   * Fetches and displays the compatible fields for the given standard report.
+   *
+   * @param reporting Dfareporting service object on which to run the requests.
+   * @param userProfileId The ID number of the DFA user profile to run this request as.
+   * @param report Displays additional fields compatible with this report.
+   */
+  public static void run(Dfareporting reporting, Long userProfileId, Report report)
+      throws Exception {
+    System.out.println("=================================================================");
+    System.out.printf("Getting compatible fields for standard report with ID %s%n",
+        report.getId());
+    System.out.println("=================================================================");
+
+    CompatibleFields compatibleFields = reporting.reports().compatibleFields()
+        .query(userProfileId, report).execute();
+
+    // Since this is a standard report, we check the "reportCompatibleFields" property.
+    // For other reports, we would check that report type's specific property.
+    ReportCompatibleFields standardReportCompatibleFields =
+        compatibleFields.getReportCompatibleFields();
+
+    for (Dimension compatibleDimension : standardReportCompatibleFields.getDimensions()) {
+      System.out.printf("Dimension \"%s\" is compatible.%n", compatibleDimension.getName());
+    }
+
+    for (Metric compatibleMetric : standardReportCompatibleFields.getMetrics()) {
+      System.out.printf("Metric \"%s\" is compatible.%n", compatibleMetric.getName());
+    }
+
+    for (Dimension compatibleDimension : standardReportCompatibleFields.getDimensionFilters()) {
+      System.out.printf("Dimension Filter \"%s\" is compatible.%n", compatibleDimension.getName());
+    }
+
+    for (Metric compatibleMetric : standardReportCompatibleFields.getPivotedActivityMetrics()) {
+      System.out.printf("Pivoted Activity Metric \"%s\" is compatible.%n",
+          compatibleMetric.getName());
+    }
+
+    System.out.println();
+  }
+}