| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="partners_v2.html">Google Partners API</a> . <a href="partners_v2.exams.html">exams</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#getToken">getToken(examType, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p> |
| 79 | <p class="firstline">Gets an Exam Token for a Partner's user to take an exam in the Exams System</p> |
| 80 | <h3>Method Details</h3> |
| 81 | <div class="method"> |
| 82 | <code class="details" id="getToken">getToken(examType, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</code> |
| 83 | <pre>Gets an Exam Token for a Partner's user to take an exam in the Exams System |
| 84 | |
| 85 | Args: |
| 86 | examType: string, The exam type we are requesting a token for. (required) |
| 87 | requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address. |
| 88 | requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. |
| 89 | An identifier has multiple letters created by a team which redirected the |
| 90 | traffic to us. |
| 91 | requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID. |
| 92 | x__xgafv: string, V1 error format. |
| 93 | Allowed values |
| 94 | 1 - v1 error format |
| 95 | 2 - v2 error format |
| 96 | requestMetadata_locale: string, Locale to use for the current request. |
| 97 | requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated) |
| 98 | requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. |
| 99 | An identifier has multiple letters created by a team which redirected the |
| 100 | traffic to us. |
| 101 | requestMetadata_partnersSessionId: string, Google Partners session ID. |
| 102 | |
| 103 | Returns: |
| 104 | An object of the form: |
| 105 | |
| 106 | { # A token that allows a user to take an exam. |
| 107 | "examType": "A String", # The type of the exam the token belongs to. |
| 108 | "token": "A String", # The token, only present if the user has access to the exam. |
| 109 | "examId": "A String", # The id of the exam the token is for. |
| 110 | }</pre> |
| 111 | </div> |
| 112 | |
| 113 | </body></html> |