Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [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.clientMessages.html">clientMessages</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#log">log(body, x__xgafv=None)</a></code></p> |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 79 | <p class="firstline">Logs a generic message from the client, such as</p> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 80 | <h3>Method Details</h3> |
| 81 | <div class="method"> |
| 82 | <code class="details" id="log">log(body, x__xgafv=None)</code> |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 83 | <pre>Logs a generic message from the client, such as |
| 84 | `Failed to render component`, `Profile page is running slow`, |
| 85 | `More than 500 users have accessed this result.`, etc. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 86 | |
| 87 | Args: |
| 88 | body: object, The request body. (required) |
| 89 | The object takes the form of: |
| 90 | |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 91 | { # Request message for |
| 92 | # LogClientMessage. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 93 | "requestMetadata": { # Common data that is in each API request. # Current request metadata. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 94 | "locale": "A String", # Locale to use for the current request. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 95 | "partnersSessionId": "A String", # Google Partners session ID. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 96 | "trafficSource": { # Source of traffic for the current request. # Source of traffic for the current request. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 97 | "trafficSubId": "A String", # Second level identifier to indicate where the traffic comes from. |
| 98 | # An identifier has multiple letters created by a team which redirected the |
| 99 | # traffic to us. |
| 100 | "trafficSourceId": "A String", # Identifier to indicate where the traffic comes from. |
| 101 | # An identifier has multiple letters created by a team which redirected the |
| 102 | # traffic to us. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 103 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 104 | "userOverrides": { # Values to use instead of the user's respective defaults. These are only # Values to use instead of the user's respective defaults for the current |
| 105 | # request. These are only honored by whitelisted products. |
| 106 | # honored by whitelisted products. |
| 107 | "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID. |
| 108 | "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address. |
| 109 | }, |
| 110 | "experimentIds": [ # Experiment IDs the current request belongs to. |
| 111 | "A String", |
| 112 | ], |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 113 | }, |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 114 | "clientInfo": { # Map of client info, such as URL, browser navigator, browser platform, etc. |
| 115 | "a_key": "A String", |
| 116 | }, |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 117 | "details": "A String", # Details about the client message. |
| 118 | "level": "A String", # Message level of client message. |
| 119 | } |
| 120 | |
| 121 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 122 | Allowed values |
| 123 | 1 - v1 error format |
| 124 | 2 - v2 error format |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 125 | |
| 126 | Returns: |
| 127 | An object of the form: |
| 128 | |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 129 | { # Response message for |
| 130 | # LogClientMessage. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 131 | "responseMetadata": { # Common data that is in each API response. # Current response metadata. |
| 132 | "debugInfo": { # Debug information about this request. # Debug information about this request. |
| 133 | "serverTraceInfo": "A String", # Server-side debug stack trace. |
| 134 | "serviceUrl": "A String", # URL of the service that handled this request. |
| 135 | "serverInfo": "A String", # Info about the server that serviced this request. |
| 136 | }, |
| 137 | }, |
| 138 | }</pre> |
| 139 | </div> |
| 140 | |
| 141 | </body></html> |