Reports API - ADMIN SDK

Question

I want to use Reports API - ADMIN SDK User Usage Google Docs Parameter named "num_docs_shared_outside_domain" which is used to retrieve Number of Docs that are not public or visible to anyone with link, but explicitly are shared either with users or groups outside the domain up to the date of the report according to this link https://developers.google.com/admin-sdk/reports/v1/reference/usage-ref-appendix-a/users-docs

But can anyone say me how to use this Parameter? I have already authenticate my service account to use Reports API ADMIN SDK. Now next step is to use this option.

Answer 1

You can try this out in the API Explorer to see what the parameters would look like. With Python, the API call might look something like:

service.userUsageReport().get(userKey='all',
                              date='2013-12-02',
                              parameters='docs:num_docs_shared_outside_domain').execute()

if you remove the parameters field entirely, you'll get all of the results from the user usage report, including the parameters simply makes things more efficient (and presumably faster) by limiting the results to that single parameter.