Adding Python DFA Reporting API Samples.

Reviewed in https://codereview.appspot.com/26070044/.

.hgignore

@@ -19,3 +19,6 @@ google_api_python_client.egg-info/*
 dist/*
 snapshot/*
 MANIFEST
+.project
+.pydevproject
+.settings/*

samples/dfareporting/README

@@ -0,0 +1,5 @@
+A collection of command-line samples for the DFA Reporting REST API.
+
+api: dfareporting
+keywords: cmdline
+author: Jonathon Imperiosi (jimper@google.com)

samples/dfareporting/client_secrets.json

@@ -0,0 +1,9 @@
+{
+  "installed": {
+    "client_id": "[[INSERT CLIENT ID HERE]]",
+    "client_secret": "[[INSERT CLIENT SECRET HERE]]",
+    "redirect_uris": [],
+    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+    "token_uri": "https://accounts.google.com/o/oauth2/token"
+  }
+}

samples/dfareporting/create_report.py

@@ -0,0 +1,67 @@
+#!/usr/bin/python
+#
+# Copyright 2013 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""This example illustrates how to create a report.
+
+Tags: reports.insert
+"""
+
+__author__ = ('jimper@google.com (Jonathon Imperiosi)')
+
+import argparse
+import pprint
+import sys
+
+from apiclient import sample_tools
+from oauth2client import client
+
+# Declare command-line flags.
+argparser = argparse.ArgumentParser(add_help=False)
+argparser.add_argument('profile_id', type=int,
+                     help='The ID of the profile to create a report for')
+
+
+def main(argv):
+  # Authenticate and construct service.
+  service, flags = sample_tools.init(
+      argv, 'dfareporting', 'v1.3', __doc__, __file__, parents=[argparser],
+      scope='https://www.googleapis.com/auth/dfareporting')
+
+  profile_id = flags.profile_id
+
+  try:
+    # Create a new report resource to insert
+    report = {
+        'name': 'Example Standard Report',
+        'type': 'STANDARD',
+        'criteria': {
+            'dateRange': {'relativeDateRange': 'YESTERDAY'},
+            'dimensions': [{'name': 'dfa:campaign'}],
+            'metricNames': ['dfa:clicks']
+        }
+    }
+
+    # Construct the request.
+    request = service.reports().insert(profileId=profile_id, body=report)
+
+    # Execute request and print response.
+    pprint.pprint(request.execute())
+  except client.AccessTokenRefreshError:
+    print ('The credentials have been revoked or expired, please re-run the '
+           'application to re-authorize')
+
+if __name__ == '__main__':
+  main(sys.argv)

samples/dfareporting/delete_report.py

@@ -0,0 +1,59 @@
+#!/usr/bin/python
+#
+# Copyright 2013 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""This example illustrates how to delete a report.
+
+Tags: reports.delete
+"""
+
+__author__ = ('jimper@google.com (Jonathon Imperiosi)')
+
+import argparse
+import pprint
+import sys
+
+from apiclient import sample_tools
+from oauth2client import client
+
+# Declare command-line flags.
+argparser = argparse.ArgumentParser(add_help=False)
+argparser.add_argument('profile_id', type=int,
+                     help='The ID of the profile to delete a report for')
+argparser.add_argument('report_id', type=int,
+                     help='The ID of the report to delete')
+
+
+def main(argv):
+  # Authenticate and construct service.
+  service, flags = sample_tools.init(
+      argv, 'dfareporting', 'v1.3', __doc__, __file__, parents=[argparser],
+      scope='https://www.googleapis.com/auth/dfareporting')
+
+  profile_id = flags.profile_id
+  report_id = flags.report_id
+
+  try: 
+    # Construct the request.
+    request = service.reports().delete(profileId=profile_id, reportId=report_id)
+
+    # Execute request and print response.
+    pprint.pprint(request.execute())
+  except client.AccessTokenRefreshError:
+    print ('The credentials have been revoked or expired, please re-run the '
+           'application to re-authorize')
+
+if __name__ == '__main__':
+  main(sys.argv)

samples/dfareporting/download_file.py

@@ -0,0 +1,58 @@
+#!/usr/bin/python
+#
+# Copyright 2013 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""This example illustrates how to download a file.
+
+Tags: files.get
+"""
+
+__author__ = ('jimper@google.com (Jonathon Imperiosi)')
+
+import argparse
+import sys
+
+from apiclient import sample_tools
+from oauth2client import client
+
+# Declare command-line flags.
+argparser = argparse.ArgumentParser(add_help=False)
+argparser.add_argument('report_id', type=int,
+                     help='The ID of the report to get a file for')
+argparser.add_argument('file_id', type=int,
+                     help='The ID of the file to get')
+
+
+def main(argv):
+  # Authenticate and construct service.
+  service, flags = sample_tools.init(
+      argv, 'dfareporting', 'v1.3', __doc__, __file__, parents=[argparser],
+      scope='https://www.googleapis.com/auth/dfareporting')
+
+  report_id = flags.report_id
+  file_id = flags.file_id
+
+  try: 
+    # Construct the request.
+    request = service.files().get_media(reportId=report_id, fileId=file_id)
+
+    # Execute request and print the file contents
+    print request.execute()
+  except client.AccessTokenRefreshError:
+    print ('The credentials have been revoked or expired, please re-run the '
+           'application to re-authorize')
+
+if __name__ == '__main__':
+  main(sys.argv)

samples/dfareporting/get_all_dimension_values.py

@@ -0,0 +1,72 @@
+#!/usr/bin/python
+#
+# Copyright 2013 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""This example illustrates how to get all dimension values for a dimension.
+
+Tags: dimensionValues.query
+"""
+
+__author__ = ('jimper@google.com (Jonathon Imperiosi)')
+
+import argparse
+import pprint
+import sys
+
+from apiclient import sample_tools
+from oauth2client import client
+
+# Declare command-line flags.
+argparser = argparse.ArgumentParser(add_help=False)
+argparser.add_argument('profile_id', type=int,
+                     help='The ID of the profile to get a report for')
+
+def main(argv):
+  # Authenticate and construct service.
+  service, flags = sample_tools.init(
+      argv, 'dfareporting', 'v1.3', __doc__, __file__, parents=[argparser],
+      scope='https://www.googleapis.com/auth/dfareporting')
+
+  profile_id = flags.profile_id
+
+  try: 
+    # Create the dimension to query
+    dimension = {
+      'dimensionName': 'dfa:advertiser',
+      'startDate': '2013-01-01',
+      'endDate': '2013-12-31'
+    }
+
+    # Construct the request.
+    request = service.dimensionValues().query(profileId=profile_id,
+                                              body=dimension)
+
+    while request is not None:
+      # Execute request and print response.
+      response = request.execute()
+      pprint.pprint(response)
+
+      nextPageToken = response.get('nextPageToken')
+
+      if nextPageToken and nextPageToken != '0':
+        request = service.dimensionValues().query_next(request, response)
+      else:
+        request = None
+  except client.AccessTokenRefreshError:
+    print ('The credentials have been revoked or expired, please re-run the '
+           'application to re-authorize')
+
+if __name__ == '__main__':
+  main(sys.argv)

samples/dfareporting/get_all_files.py

@@ -0,0 +1,65 @@
+#!/usr/bin/python
+#
+# Copyright 2013 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""This example illustrates how to get a list of all the files for a profile.
+
+Tags: files.list
+"""
+
+__author__ = ('jimper@google.com (Jonathon Imperiosi)')
+
+import argparse
+import pprint
+import sys
+
+from apiclient import sample_tools
+from oauth2client import client
+
+# Declare command-line flags.
+argparser = argparse.ArgumentParser(add_help=False)
+argparser.add_argument('profile_id', type=int,
+                     help='The ID of the profile to use')
+
+
+def main(argv):
+  # Authenticate and construct service.
+  service, flags = sample_tools.init(
+      argv, 'dfareporting', 'v1.3', __doc__, __file__, parents=[argparser],
+      scope='https://www.googleapis.com/auth/dfareporting')
+
+  profile_id = flags.profile_id
+
+  try: 
+    # Construct a get request for the specified profile.    
+    request = service.files().list(profileId=profile_id, maxResults=10)
+
+    while request is not None:
+      # Execute request and print response.
+      response = request.execute()
+      pprint.pprint(response)
+
+      nextPageToken = response.get('nextPageToken')
+
+      if nextPageToken:
+        request = service.files().list_next(request, response)
+      else:
+        request = None
+  except client.AccessTokenRefreshError:
+    print ('The credentials have been revoked or expired, please re-run the '
+           'application to re-authorize')
+
+if __name__ == '__main__':
+  main(sys.argv)