Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(266)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/partners__v2.json

Issue 3003493002: Api-Roll 53: 2017-08-21 (Closed)
Patch Set: Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/oauth2__v2.json ('k') | discovery/googleapis/people__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "basePath": "", 2 "basePath": "",
3 "baseUrl": "https://partners.googleapis.com/", 3 "baseUrl": "https://partners.googleapis.com/",
4 "batchPath": "batch", 4 "batchPath": "batch",
5 "canonicalName": "Partners", 5 "canonicalName": "Partners",
6 "description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.", 6 "description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.",
7 "discoveryVersion": "v1", 7 "discoveryVersion": "v1",
8 "documentationLink": "https://developers.google.com/partners/", 8 "documentationLink": "https://developers.google.com/partners/",
9 "icons": { 9 "icons": {
10 "x16": "http://www.google.com/images/icons/product/search-16.gif", 10 "x16": "http://www.google.com/images/icons/product/search-16.gif",
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after
64 "proto" 64 "proto"
65 ], 65 ],
66 "enumDescriptions": [ 66 "enumDescriptions": [
67 "Responses with Content-Type of application/json", 67 "Responses with Content-Type of application/json",
68 "Media download with context-dependent Content-Type", 68 "Media download with context-dependent Content-Type",
69 "Responses with Content-Type of application/x-protobuf" 69 "Responses with Content-Type of application/x-protobuf"
70 ], 70 ],
71 "location": "query", 71 "location": "query",
72 "type": "string" 72 "type": "string"
73 }, 73 },
74 "access_token": {
75 "description": "OAuth access token.",
76 "location": "query",
77 "type": "string"
78 },
74 "key": { 79 "key": {
75 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.", 80 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
76 "location": "query", 81 "location": "query",
77 "type": "string" 82 "type": "string"
78 }, 83 },
79 "access_token": {
80 "description": "OAuth access token.",
81 "location": "query",
82 "type": "string"
83 },
84 "quotaUser": { 84 "quotaUser": {
85 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 85 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
86 "location": "query", 86 "location": "query",
87 "type": "string" 87 "type": "string"
88 }, 88 },
89 "pp": { 89 "pp": {
90 "default": "true", 90 "default": "true",
91 "description": "Pretty-print response.", 91 "description": "Pretty-print response.",
92 "location": "query", 92 "location": "query",
93 "type": "boolean" 93 "type": "boolean"
(...skipping 12 matching lines...) Expand all
106 "protocol": "rest", 106 "protocol": "rest",
107 "resources": { 107 "resources": {
108 "leads": { 108 "leads": {
109 "methods": { 109 "methods": {
110 "list": { 110 "list": {
111 "description": "Lists advertiser leads for a user's associat ed company.\nShould only be called within the context of an authorized logged in user.", 111 "description": "Lists advertiser leads for a user's associat ed company.\nShould only be called within the context of an authorized logged in user.",
112 "httpMethod": "GET", 112 "httpMethod": "GET",
113 "id": "partners.leads.list", 113 "id": "partners.leads.list",
114 "parameterOrder": [], 114 "parameterOrder": [],
115 "parameters": { 115 "parameters": {
116 "requestMetadata.locale": {
117 "description": "Locale to use for the current reques t.",
118 "location": "query",
119 "type": "string"
120 },
121 "requestMetadata.userOverrides.ipAddress": {
122 "description": "IP address to use instead of the use r's geo-located IP address.",
123 "location": "query",
124 "type": "string"
125 },
126 "requestMetadata.experimentIds": {
127 "description": "Experiment IDs the current request b elongs to.",
128 "location": "query",
129 "repeated": true,
130 "type": "string"
131 },
132 "requestMetadata.trafficSource.trafficSubId": {
133 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
134 "location": "query",
135 "type": "string"
136 },
137 "orderBy": {
138 "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
139 "location": "query",
140 "type": "string"
141 },
116 "requestMetadata.partnersSessionId": { 142 "requestMetadata.partnersSessionId": {
117 "description": "Google Partners session ID.", 143 "description": "Google Partners session ID.",
118 "location": "query", 144 "location": "query",
119 "type": "string" 145 "type": "string"
120 }, 146 },
121 "requestMetadata.userOverrides.userId": { 147 "requestMetadata.userOverrides.userId": {
122 "description": "Logged-in user ID to impersonate ins tead of the user's ID.", 148 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
123 "location": "query", 149 "location": "query",
124 "type": "string" 150 "type": "string"
125 }, 151 },
126 "pageToken": { 152 "pageToken": {
127 "description": "A token identifying a page of result s that the server returns.\nTypically, this is the value of `ListLeadsResponse.n ext_page_token`\nreturned from the previous call to\nListLeads.", 153 "description": "A token identifying a page of result s that the server returns.\nTypically, this is the value of `ListLeadsResponse.n ext_page_token`\nreturned from the previous call to\nListLeads.",
128 "location": "query", 154 "location": "query",
129 "type": "string" 155 "type": "string"
130 }, 156 },
131 "pageSize": { 157 "pageSize": {
132 "description": "Requested page size. Server may retu rn fewer leads than requested.\nIf unspecified, server picks an appropriate defa ult.", 158 "description": "Requested page size. Server may retu rn fewer leads than requested.\nIf unspecified, server picks an appropriate defa ult.",
133 "format": "int32", 159 "format": "int32",
134 "location": "query", 160 "location": "query",
135 "type": "integer" 161 "type": "integer"
136 }, 162 },
137 "requestMetadata.trafficSource.trafficSourceId": { 163 "requestMetadata.trafficSource.trafficSourceId": {
138 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.", 164 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
139 "location": "query", 165 "location": "query",
140 "type": "string" 166 "type": "string"
141 },
142 "requestMetadata.locale": {
143 "description": "Locale to use for the current reques t.",
144 "location": "query",
145 "type": "string"
146 },
147 "requestMetadata.userOverrides.ipAddress": {
148 "description": "IP address to use instead of the use r's geo-located IP address.",
149 "location": "query",
150 "type": "string"
151 },
152 "requestMetadata.experimentIds": {
153 "description": "Experiment IDs the current request b elongs to.",
154 "location": "query",
155 "repeated": true,
156 "type": "string"
157 },
158 "orderBy": {
159 "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
160 "location": "query",
161 "type": "string"
162 },
163 "requestMetadata.trafficSource.trafficSubId": {
164 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
165 "location": "query",
166 "type": "string"
167 } 167 }
168 }, 168 },
169 "path": "v2/leads", 169 "path": "v2/leads",
170 "response": { 170 "response": {
171 "$ref": "ListLeadsResponse" 171 "$ref": "ListLeadsResponse"
172 } 172 }
173 } 173 }
174 } 174 }
175 }, 175 },
176 "offers": { 176 "offers": {
177 "methods": { 177 "methods": {
178 "list": { 178 "list": {
179 "description": "Lists the Offers available for the current u ser", 179 "description": "Lists the Offers available for the current u ser",
180 "httpMethod": "GET", 180 "httpMethod": "GET",
181 "id": "partners.offers.list", 181 "id": "partners.offers.list",
182 "parameterOrder": [], 182 "parameterOrder": [],
183 "parameters": { 183 "parameters": {
184 "requestMetadata.partnersSessionId": {
185 "description": "Google Partners session ID.",
186 "location": "query",
187 "type": "string"
188 },
189 "requestMetadata.userOverrides.userId": {
190 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
191 "location": "query",
192 "type": "string"
193 },
184 "requestMetadata.trafficSource.trafficSourceId": { 194 "requestMetadata.trafficSource.trafficSourceId": {
185 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.", 195 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
186 "location": "query", 196 "location": "query",
187 "type": "string" 197 "type": "string"
188 }, 198 },
189 "requestMetadata.locale": { 199 "requestMetadata.locale": {
190 "description": "Locale to use for the current reques t.", 200 "description": "Locale to use for the current reques t.",
191 "location": "query", 201 "location": "query",
192 "type": "string" 202 "type": "string"
193 }, 203 },
194 "requestMetadata.userOverrides.ipAddress": { 204 "requestMetadata.userOverrides.ipAddress": {
195 "description": "IP address to use instead of the use r's geo-located IP address.", 205 "description": "IP address to use instead of the use r's geo-located IP address.",
196 "location": "query", 206 "location": "query",
197 "type": "string" 207 "type": "string"
198 }, 208 },
199 "requestMetadata.experimentIds": { 209 "requestMetadata.experimentIds": {
200 "description": "Experiment IDs the current request b elongs to.", 210 "description": "Experiment IDs the current request b elongs to.",
201 "location": "query", 211 "location": "query",
202 "repeated": true, 212 "repeated": true,
203 "type": "string" 213 "type": "string"
204 }, 214 },
205 "requestMetadata.trafficSource.trafficSubId": { 215 "requestMetadata.trafficSource.trafficSubId": {
206 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.", 216 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
207 "location": "query", 217 "location": "query",
208 "type": "string" 218 "type": "string"
209 },
210 "requestMetadata.userOverrides.userId": {
211 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
212 "location": "query",
213 "type": "string"
214 },
215 "requestMetadata.partnersSessionId": {
216 "description": "Google Partners session ID.",
217 "location": "query",
218 "type": "string"
219 } 219 }
220 }, 220 },
221 "path": "v2/offers", 221 "path": "v2/offers",
222 "response": { 222 "response": {
223 "$ref": "ListOffersResponse" 223 "$ref": "ListOffersResponse"
224 } 224 }
225 } 225 }
226 }, 226 },
227 "resources": { 227 "resources": {
228 "history": { 228 "history": {
229 "methods": { 229 "methods": {
230 "list": { 230 "list": {
231 "description": "Lists the Historical Offers for the current user (or user's entire company)", 231 "description": "Lists the Historical Offers for the current user (or user's entire company)",
232 "httpMethod": "GET", 232 "httpMethod": "GET",
233 "id": "partners.offers.history.list", 233 "id": "partners.offers.history.list",
234 "parameterOrder": [], 234 "parameterOrder": [],
235 "parameters": { 235 "parameters": {
236 "requestMetadata.experimentIds": {
237 "description": "Experiment IDs the current r equest belongs to.",
238 "location": "query",
239 "repeated": true,
240 "type": "string"
241 },
242 "entireCompany": {
243 "description": "if true, show history for th e entire company. Requires user to be admin.",
244 "location": "query",
245 "type": "boolean"
246 },
236 "requestMetadata.trafficSource.trafficSubId": { 247 "requestMetadata.trafficSource.trafficSubId": {
237 "description": "Second level identifier to i ndicate where the traffic comes from.\nAn identifier has multiple letters create d by a team which redirected the\ntraffic to us.", 248 "description": "Second level identifier to i ndicate where the traffic comes from.\nAn identifier has multiple letters create d by a team which redirected the\ntraffic to us.",
238 "location": "query", 249 "location": "query",
239 "type": "string" 250 "type": "string"
240 }, 251 },
241 "orderBy": { 252 "orderBy": {
242 "description": "Comma-separated list of fiel ds to order by, e.g.: \"foo,bar,baz\".\nUse \"foo desc\" to sort descending.\nLi st of valid field names is: name, offer_code, expiration_time, status,\n last _modified_time, sender_name, creation_time, country_code,\n offer_type.", 253 "description": "Comma-separated list of fiel ds to order by, e.g.: \"foo,bar,baz\".\nUse \"foo desc\" to sort descending.\nLi st of valid field names is: name, offer_code, expiration_time, status,\n last _modified_time, sender_name, creation_time, country_code,\n offer_type.",
243 "location": "query", 254 "location": "query",
244 "type": "string" 255 "type": "string"
245 }, 256 },
(...skipping 25 matching lines...) Expand all
271 }, 282 },
272 "requestMetadata.locale": { 283 "requestMetadata.locale": {
273 "description": "Locale to use for the curren t request.", 284 "description": "Locale to use for the curren t request.",
274 "location": "query", 285 "location": "query",
275 "type": "string" 286 "type": "string"
276 }, 287 },
277 "requestMetadata.userOverrides.ipAddress": { 288 "requestMetadata.userOverrides.ipAddress": {
278 "description": "IP address to use instead of the user's geo-located IP address.", 289 "description": "IP address to use instead of the user's geo-located IP address.",
279 "location": "query", 290 "location": "query",
280 "type": "string" 291 "type": "string"
281 },
282 "requestMetadata.experimentIds": {
283 "description": "Experiment IDs the current r equest belongs to.",
284 "location": "query",
285 "repeated": true,
286 "type": "string"
287 },
288 "entireCompany": {
289 "description": "if true, show history for th e entire company. Requires user to be admin.",
290 "location": "query",
291 "type": "boolean"
292 } 292 }
293 }, 293 },
294 "path": "v2/offers/history", 294 "path": "v2/offers/history",
295 "response": { 295 "response": {
296 "$ref": "ListOffersHistoryResponse" 296 "$ref": "ListOffersHistoryResponse"
297 } 297 }
298 } 298 }
299 } 299 }
300 } 300 }
301 } 301 }
302 }, 302 },
303 "userStates": {
304 "methods": {
305 "list": {
306 "description": "Lists states for current user.",
307 "httpMethod": "GET",
308 "id": "partners.userStates.list",
309 "parameterOrder": [],
310 "parameters": {
311 "requestMetadata.userOverrides.userId": {
312 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
313 "location": "query",
314 "type": "string"
315 },
316 "requestMetadata.partnersSessionId": {
317 "description": "Google Partners session ID.",
318 "location": "query",
319 "type": "string"
320 },
321 "requestMetadata.trafficSource.trafficSourceId": {
322 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
323 "location": "query",
324 "type": "string"
325 },
326 "requestMetadata.locale": {
327 "description": "Locale to use for the current reques t.",
328 "location": "query",
329 "type": "string"
330 },
331 "requestMetadata.userOverrides.ipAddress": {
332 "description": "IP address to use instead of the use r's geo-located IP address.",
333 "location": "query",
334 "type": "string"
335 },
336 "requestMetadata.experimentIds": {
337 "description": "Experiment IDs the current request b elongs to.",
338 "location": "query",
339 "repeated": true,
340 "type": "string"
341 },
342 "requestMetadata.trafficSource.trafficSubId": {
343 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
344 "location": "query",
345 "type": "string"
346 }
347 },
348 "path": "v2/userStates",
349 "response": {
350 "$ref": "ListUserStatesResponse"
351 }
352 }
353 }
354 },
303 "analytics": { 355 "analytics": {
304 "methods": { 356 "methods": {
305 "list": { 357 "list": {
306 "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in u ser.", 358 "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in u ser.",
307 "httpMethod": "GET", 359 "httpMethod": "GET",
308 "id": "partners.analytics.list", 360 "id": "partners.analytics.list",
309 "parameterOrder": [], 361 "parameterOrder": [],
310 "parameters": { 362 "parameters": {
311 "requestMetadata.partnersSessionId": { 363 "requestMetadata.userOverrides.userId": {
312 "description": "Google Partners session ID.", 364 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
313 "location": "query", 365 "location": "query",
314 "type": "string" 366 "type": "string"
315 }, 367 },
316 "requestMetadata.userOverrides.userId": { 368 "requestMetadata.partnersSessionId": {
317 "description": "Logged-in user ID to impersonate ins tead of the user's ID.", 369 "description": "Google Partners session ID.",
318 "location": "query", 370 "location": "query",
319 "type": "string" 371 "type": "string"
320 }, 372 },
321 "pageToken": { 373 "pageToken": {
322 "description": "A token identifying a page of result s that the server returns.\nTypically, this is the value of `ListAnalyticsRespon se.next_page_token`\nreturned from the previous call to\nListAnalytics.\nWill be a date string in `YYYY-MM-DD` format representing the end date\nof the date ran ge of results to return.\nIf unspecified or set to \"\", default value is the cu rrent date.", 374 "description": "A token identifying a page of result s that the server returns.\nTypically, this is the value of `ListAnalyticsRespon se.next_page_token`\nreturned from the previous call to\nListAnalytics.\nWill be a date string in `YYYY-MM-DD` format representing the end date\nof the date ran ge of results to return.\nIf unspecified or set to \"\", default value is the cu rrent date.",
323 "location": "query", 375 "location": "query",
324 "type": "string" 376 "type": "string"
325 }, 377 },
326 "pageSize": { 378 "pageSize": {
327 "description": "Requested page size. Server may retu rn fewer analytics than requested.\nIf unspecified or set to 0, default value is 30.\nSpecifies the number of days in the date range when querying analytics.\nT he `page_token` represents the end date of the date range\nand the start date is calculated using the `page_size` as the number\nof days BEFORE the end date.\nM ust be a non-negative integer.", 379 "description": "Requested page size. Server may retu rn fewer analytics than requested.\nIf unspecified or set to 0, default value is 30.\nSpecifies the number of days in the date range when querying analytics.\nT he `page_token` represents the end date of the date range\nand the start date is calculated using the `page_size` as the number\nof days BEFORE the end date.\nM ust be a non-negative integer.",
(...skipping 28 matching lines...) Expand all
356 "type": "string" 408 "type": "string"
357 } 409 }
358 }, 410 },
359 "path": "v2/analytics", 411 "path": "v2/analytics",
360 "response": { 412 "response": {
361 "$ref": "ListAnalyticsResponse" 413 "$ref": "ListAnalyticsResponse"
362 } 414 }
363 } 415 }
364 } 416 }
365 }, 417 },
366 "userStates": { 418 "v2": {
367 "methods": { 419 "methods": {
368 "list": { 420 "getPartnersstatus": {
369 "description": "Lists states for current user.", 421 "description": "Gets Partners Status of the logged in user's agency.\nShould only be called if the logged in user is the admin of the agency .",
370 "httpMethod": "GET", 422 "httpMethod": "GET",
371 "id": "partners.userStates.list", 423 "id": "partners.getPartnersstatus",
372 "parameterOrder": [], 424 "parameterOrder": [],
373 "parameters": { 425 "parameters": {
426 "requestMetadata.partnersSessionId": {
427 "description": "Google Partners session ID.",
428 "location": "query",
429 "type": "string"
430 },
374 "requestMetadata.userOverrides.userId": { 431 "requestMetadata.userOverrides.userId": {
375 "description": "Logged-in user ID to impersonate ins tead of the user's ID.", 432 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
376 "location": "query", 433 "location": "query",
377 "type": "string" 434 "type": "string"
378 }, 435 },
379 "requestMetadata.partnersSessionId": {
380 "description": "Google Partners session ID.",
381 "location": "query",
382 "type": "string"
383 },
384 "requestMetadata.trafficSource.trafficSourceId": { 436 "requestMetadata.trafficSource.trafficSourceId": {
385 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.", 437 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
386 "location": "query", 438 "location": "query",
387 "type": "string" 439 "type": "string"
388 }, 440 },
389 "requestMetadata.locale": { 441 "requestMetadata.locale": {
390 "description": "Locale to use for the current reques t.", 442 "description": "Locale to use for the current reques t.",
391 "location": "query", 443 "location": "query",
392 "type": "string" 444 "type": "string"
393 }, 445 },
394 "requestMetadata.userOverrides.ipAddress": { 446 "requestMetadata.userOverrides.ipAddress": {
395 "description": "IP address to use instead of the use r's geo-located IP address.", 447 "description": "IP address to use instead of the use r's geo-located IP address.",
396 "location": "query", 448 "location": "query",
397 "type": "string" 449 "type": "string"
398 }, 450 },
399 "requestMetadata.experimentIds": { 451 "requestMetadata.experimentIds": {
400 "description": "Experiment IDs the current request b elongs to.", 452 "description": "Experiment IDs the current request b elongs to.",
401 "location": "query", 453 "location": "query",
402 "repeated": true, 454 "repeated": true,
403 "type": "string" 455 "type": "string"
404 }, 456 },
405 "requestMetadata.trafficSource.trafficSubId": { 457 "requestMetadata.trafficSource.trafficSubId": {
406 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.", 458 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
407 "location": "query", 459 "location": "query",
408 "type": "string" 460 "type": "string"
409 } 461 }
410 }, 462 },
411 "path": "v2/userStates", 463 "path": "v2/partnersstatus",
412 "response": { 464 "response": {
413 "$ref": "ListUserStatesResponse" 465 "$ref": "GetPartnersStatusResponse"
414 } 466 }
415 } 467 },
416 }
417 },
418 "v2": {
419 "methods": {
420 "updateLeads": { 468 "updateLeads": {
421 "description": "Updates the specified lead.", 469 "description": "Updates the specified lead.",
422 "httpMethod": "PATCH", 470 "httpMethod": "PATCH",
423 "id": "partners.updateLeads", 471 "id": "partners.updateLeads",
424 "parameterOrder": [], 472 "parameterOrder": [],
425 "parameters": { 473 "parameters": {
474 "requestMetadata.partnersSessionId": {
475 "description": "Google Partners session ID.",
476 "location": "query",
477 "type": "string"
478 },
479 "requestMetadata.userOverrides.userId": {
480 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
481 "location": "query",
482 "type": "string"
483 },
484 "requestMetadata.trafficSource.trafficSourceId": {
485 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
486 "location": "query",
487 "type": "string"
488 },
426 "requestMetadata.locale": { 489 "requestMetadata.locale": {
427 "description": "Locale to use for the current reques t.", 490 "description": "Locale to use for the current reques t.",
428 "location": "query", 491 "location": "query",
429 "type": "string" 492 "type": "string"
430 }, 493 },
431 "requestMetadata.userOverrides.ipAddress": { 494 "requestMetadata.userOverrides.ipAddress": {
432 "description": "IP address to use instead of the use r's geo-located IP address.", 495 "description": "IP address to use instead of the use r's geo-located IP address.",
433 "location": "query", 496 "location": "query",
434 "type": "string" 497 "type": "string"
435 }, 498 },
436 "updateMask": { 499 "updateMask": {
437 "description": "Standard field mask for the set of f ields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.", 500 "description": "Standard field mask for the set of f ields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.",
438 "format": "google-fieldmask", 501 "format": "google-fieldmask",
439 "location": "query", 502 "location": "query",
440 "type": "string" 503 "type": "string"
441 }, 504 },
442 "requestMetadata.experimentIds": { 505 "requestMetadata.experimentIds": {
443 "description": "Experiment IDs the current request b elongs to.", 506 "description": "Experiment IDs the current request b elongs to.",
444 "location": "query", 507 "location": "query",
445 "repeated": true, 508 "repeated": true,
446 "type": "string" 509 "type": "string"
447 }, 510 },
448 "requestMetadata.trafficSource.trafficSubId": { 511 "requestMetadata.trafficSource.trafficSubId": {
449 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.", 512 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
450 "location": "query", 513 "location": "query",
451 "type": "string" 514 "type": "string"
452 },
453 "requestMetadata.userOverrides.userId": {
454 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
455 "location": "query",
456 "type": "string"
457 },
458 "requestMetadata.partnersSessionId": {
459 "description": "Google Partners session ID.",
460 "location": "query",
461 "type": "string"
462 },
463 "requestMetadata.trafficSource.trafficSourceId": {
464 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
465 "location": "query",
466 "type": "string"
467 } 515 }
468 }, 516 },
469 "path": "v2/leads", 517 "path": "v2/leads",
470 "request": { 518 "request": {
471 "$ref": "Lead" 519 "$ref": "Lead"
472 }, 520 },
473 "response": { 521 "response": {
474 "$ref": "Lead" 522 "$ref": "Lead"
475 } 523 }
476 }, 524 },
477 "updateCompanies": { 525 "updateCompanies": {
478 "description": "Update company.\nShould only be called withi n the context of an authorized logged in user.", 526 "description": "Update company.\nShould only be called withi n the context of an authorized logged in user.",
479 "httpMethod": "PATCH", 527 "httpMethod": "PATCH",
480 "id": "partners.updateCompanies", 528 "id": "partners.updateCompanies",
481 "parameterOrder": [], 529 "parameterOrder": [],
482 "parameters": { 530 "parameters": {
483 "requestMetadata.trafficSource.trafficSubId": { 531 "requestMetadata.partnersSessionId": {
484 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.", 532 "description": "Google Partners session ID.",
485 "location": "query", 533 "location": "query",
486 "type": "string" 534 "type": "string"
487 }, 535 },
488 "requestMetadata.userOverrides.userId": { 536 "requestMetadata.userOverrides.userId": {
489 "description": "Logged-in user ID to impersonate ins tead of the user's ID.", 537 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
490 "location": "query", 538 "location": "query",
491 "type": "string" 539 "type": "string"
492 }, 540 },
493 "requestMetadata.partnersSessionId": {
494 "description": "Google Partners session ID.",
495 "location": "query",
496 "type": "string"
497 },
498 "requestMetadata.trafficSource.trafficSourceId": { 541 "requestMetadata.trafficSource.trafficSourceId": {
499 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.", 542 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
500 "location": "query", 543 "location": "query",
501 "type": "string" 544 "type": "string"
502 }, 545 },
503 "requestMetadata.locale": { 546 "requestMetadata.locale": {
504 "description": "Locale to use for the current reques t.", 547 "description": "Locale to use for the current reques t.",
505 "location": "query", 548 "location": "query",
506 "type": "string" 549 "type": "string"
507 }, 550 },
508 "requestMetadata.userOverrides.ipAddress": { 551 "requestMetadata.userOverrides.ipAddress": {
509 "description": "IP address to use instead of the use r's geo-located IP address.", 552 "description": "IP address to use instead of the use r's geo-located IP address.",
510 "location": "query", 553 "location": "query",
511 "type": "string" 554 "type": "string"
512 }, 555 },
513 "updateMask": { 556 "updateMask": {
514 "description": "Standard field mask for the set of f ields to be updated.\nRequired with at least 1 value in FieldMask's paths.", 557 "description": "Standard field mask for the set of f ields to be updated.\nRequired with at least 1 value in FieldMask's paths.",
515 "format": "google-fieldmask", 558 "format": "google-fieldmask",
516 "location": "query", 559 "location": "query",
517 "type": "string" 560 "type": "string"
518 }, 561 },
519 "requestMetadata.experimentIds": { 562 "requestMetadata.experimentIds": {
520 "description": "Experiment IDs the current request b elongs to.", 563 "description": "Experiment IDs the current request b elongs to.",
521 "location": "query", 564 "location": "query",
522 "repeated": true, 565 "repeated": true,
523 "type": "string" 566 "type": "string"
567 },
568 "requestMetadata.trafficSource.trafficSubId": {
569 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
570 "location": "query",
571 "type": "string"
524 } 572 }
525 }, 573 },
526 "path": "v2/companies", 574 "path": "v2/companies",
527 "request": { 575 "request": {
528 "$ref": "Company" 576 "$ref": "Company"
529 }, 577 },
530 "response": { 578 "response": {
531 "$ref": "Company" 579 "$ref": "Company"
532 } 580 }
533 }, 581 }
534 "getPartnersstatus": { 582 }
535 "description": "Gets Partners Status of the logged in user's agency.\nShould only be called if the logged in user is the admin of the agency .", 583 },
584 "companies": {
585 "methods": {
586 "list": {
587 "description": "Lists companies.",
536 "httpMethod": "GET", 588 "httpMethod": "GET",
537 "id": "partners.getPartnersstatus", 589 "id": "partners.companies.list",
538 "parameterOrder": [], 590 "parameterOrder": [],
539 "parameters": { 591 "parameters": {
592 "languageCodes": {
593 "description": "List of language codes that company can support. Only primary language\nsubtags are accepted as defined by\n<a href= \"https://tools.ietf.org/html/bcp47\">BCP 47</a>\n(IETF BCP 47, \"Tags for Ident ifying Languages\").",
594 "location": "query",
595 "repeated": true,
596 "type": "string"
597 },
598 "pageSize": {
599 "description": "Requested page size. Server may retu rn fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
600 "format": "int32",
601 "location": "query",
602 "type": "integer"
603 },
604 "requestMetadata.userOverrides.ipAddress": {
605 "description": "IP address to use instead of the use r's geo-located IP address.",
606 "location": "query",
607 "type": "string"
608 },
540 "requestMetadata.experimentIds": { 609 "requestMetadata.experimentIds": {
541 "description": "Experiment IDs the current request b elongs to.", 610 "description": "Experiment IDs the current request b elongs to.",
542 "location": "query", 611 "location": "query",
543 "repeated": true, 612 "repeated": true,
544 "type": "string" 613 "type": "string"
545 }, 614 },
546 "requestMetadata.trafficSource.trafficSubId": { 615 "orderBy": {
547 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.", 616 "description": "How to order addresses within the re turned companies. Currently, only\n`address` and `address desc` is supported whi ch will sorted by closest to\nfarthest in distance from given address and farthe st to closest distance\nfrom given address respectively.",
548 "location": "query", 617 "location": "query",
549 "type": "string" 618 "type": "string"
550 }, 619 },
551 "requestMetadata.partnersSessionId": { 620 "specializations": {
552 "description": "Google Partners session ID.", 621 "description": "List of specializations that the ret urned agencies should provide. If this\nis not empty, any returned agency must h ave at least one of these\nspecializations, or one of the services in the \"serv ices\" field.",
622 "enum": [
623 "BADGE_SPECIALIZATION_UNKNOWN",
624 "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
625 "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
626 "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
627 "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
628 "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
629 ],
630 "location": "query",
631 "repeated": true,
632 "type": "string"
633 },
634 "maxMonthlyBudget.currencyCode": {
635 "description": "The 3-letter currency code defined i n ISO 4217.",
553 "location": "query", 636 "location": "query",
554 "type": "string" 637 "type": "string"
555 }, 638 },
556 "requestMetadata.userOverrides.userId": { 639 "minMonthlyBudget.currencyCode": {
557 "description": "Logged-in user ID to impersonate ins tead of the user's ID.", 640 "description": "The 3-letter currency code defined i n ISO 4217.",
558 "location": "query", 641 "location": "query",
559 "type": "string" 642 "type": "string"
560 }, 643 },
561 "requestMetadata.trafficSource.trafficSourceId": {
562 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
563 "location": "query",
564 "type": "string"
565 },
566 "requestMetadata.locale": {
567 "description": "Locale to use for the current reques t.",
568 "location": "query",
569 "type": "string"
570 },
571 "requestMetadata.userOverrides.ipAddress": {
572 "description": "IP address to use instead of the use r's geo-located IP address.",
573 "location": "query",
574 "type": "string"
575 }
576 },
577 "path": "v2/partnersstatus",
578 "response": {
579 "$ref": "GetPartnersStatusResponse"
580 }
581 }
582 }
583 },
584 "users": {
585 "methods": {
586 "updateProfile": {
587 "description": "Updates a user's profile. A user can only up date their own profile and\nshould only be called within the context of a logged in user.",
588 "httpMethod": "PATCH",
589 "id": "partners.users.updateProfile",
590 "parameterOrder": [],
591 "parameters": {
592 "requestMetadata.partnersSessionId": {
593 "description": "Google Partners session ID.",
594 "location": "query",
595 "type": "string"
596 },
597 "requestMetadata.userOverrides.userId": { 644 "requestMetadata.userOverrides.userId": {
598 "description": "Logged-in user ID to impersonate ins tead of the user's ID.", 645 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
599 "location": "query", 646 "location": "query",
600 "type": "string" 647 "type": "string"
601 }, 648 },
602 "requestMetadata.trafficSource.trafficSourceId": { 649 "view": {
603 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.", 650 "description": "The view of the `Company` resource t o be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
651 "enum": [
652 "COMPANY_VIEW_UNSPECIFIED",
653 "CV_GOOGLE_PARTNER_SEARCH"
654 ],
655 "location": "query",
656 "type": "string"
657 },
658 "address": {
659 "description": "The address to use when searching fo r companies.\nIf not given, the geo-located address of the request is used.",
604 "location": "query", 660 "location": "query",
605 "type": "string" 661 "type": "string"
606 }, 662 },
607 "requestMetadata.locale": { 663 "requestMetadata.locale": {
608 "description": "Locale to use for the current reques t.", 664 "description": "Locale to use for the current reques t.",
609 "location": "query", 665 "location": "query",
610 "type": "string" 666 "type": "string"
611 }, 667 },
612 "requestMetadata.userOverrides.ipAddress": { 668 "minMonthlyBudget.units": {
613 "description": "IP address to use instead of the use r's geo-located IP address.", 669 "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
670 "format": "int64",
614 "location": "query", 671 "location": "query",
615 "type": "string" 672 "type": "string"
616 }, 673 },
617 "requestMetadata.experimentIds": { 674 "maxMonthlyBudget.nanos": {
618 "description": "Experiment IDs the current request b elongs to.", 675 "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nan os` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`= -750,000,000.",
676 "format": "int32",
677 "location": "query",
678 "type": "integer"
679 },
680 "services": {
681 "description": "List of services that the returned a gencies should provide. If this is\nnot empty, any returned agency must have at least one of these services,\nor one of the specializations in the \"specializat ions\" field.",
682 "enum": [
683 "SERVICE_UNSPECIFIED",
684 "S_ADVANCED_ADWORDS_SUPPORT",
685 "S_ADVERTISING_ON_GOOGLE",
686 "S_AN_ENHANCED_WEBSITE",
687 "S_AN_ONLINE_MARKETING_PLAN",
688 "S_MOBILE_AND_VIDEO_ADS",
689 "S_MOBILE_WEBSITE_SERVICES"
690 ],
619 "location": "query", 691 "location": "query",
620 "repeated": true, 692 "repeated": true,
621 "type": "string" 693 "type": "string"
622 }, 694 },
623 "requestMetadata.trafficSource.trafficSubId": { 695 "requestMetadata.trafficSource.trafficSourceId": {
624 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.", 696 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
625 "location": "query", 697 "location": "query",
626 "type": "string" 698 "type": "string"
627 } 699 },
628 }, 700 "maxMonthlyBudget.units": {
629 "path": "v2/users/profile", 701 "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
630 "request": { 702 "format": "int64",
631 "$ref": "UserProfile"
632 },
633 "response": {
634 "$ref": "UserProfile"
635 }
636 },
637 "deleteCompanyRelation": {
638 "description": "Deletes a user's company relation. Unaffilia ites the user from a company.",
639 "httpMethod": "DELETE",
640 "id": "partners.users.deleteCompanyRelation",
641 "parameterOrder": [
642 "userId"
643 ],
644 "parameters": {
645 "requestMetadata.experimentIds": {
646 "description": "Experiment IDs the current request b elongs to.",
647 "location": "query", 703 "location": "query",
648 "repeated": true,
649 "type": "string" 704 "type": "string"
650 }, 705 },
706 "minMonthlyBudget.nanos": {
707 "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nan os` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`= -750,000,000.",
708 "format": "int32",
709 "location": "query",
710 "type": "integer"
711 },
651 "requestMetadata.trafficSource.trafficSubId": { 712 "requestMetadata.trafficSource.trafficSubId": {
652 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.", 713 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
653 "location": "query", 714 "location": "query",
654 "type": "string" 715 "type": "string"
655 }, 716 },
656 "userId": {
657 "description": "The ID of the user. Can be set to <c ode>me</code> to mean\nthe currently authenticated user.",
658 "location": "path",
659 "required": true,
660 "type": "string"
661 },
662 "requestMetadata.userOverrides.userId": {
663 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
664 "location": "query",
665 "type": "string"
666 },
667 "requestMetadata.partnersSessionId": { 717 "requestMetadata.partnersSessionId": {
668 "description": "Google Partners session ID.", 718 "description": "Google Partners session ID.",
669 "location": "query", 719 "location": "query",
670 "type": "string" 720 "type": "string"
671 }, 721 },
672 "requestMetadata.trafficSource.trafficSourceId": { 722 "companyName": {
673 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.", 723 "description": "Company name to search for.",
674 "location": "query", 724 "location": "query",
675 "type": "string" 725 "type": "string"
676 }, 726 },
677 "requestMetadata.locale": { 727 "pageToken": {
678 "description": "Locale to use for the current reques t.", 728 "description": "A token identifying a page of result s that the server returns.\nTypically, this is the value of `ListCompaniesRespon se.next_page_token`\nreturned from the previous call to\nListCompanies.",
679 "location": "query", 729 "location": "query",
680 "type": "string" 730 "type": "string"
681 }, 731 },
682 "requestMetadata.userOverrides.ipAddress": { 732 "industries": {
683 "description": "IP address to use instead of the use r's geo-located IP address.", 733 "description": "List of industries the company can h elp with.",
684 "location": "query", 734 "enum": [
685 "type": "string" 735 "INDUSTRY_UNSPECIFIED",
686 } 736 "I_AUTOMOTIVE",
687 }, 737 "I_BUSINESS_TO_BUSINESS",
688 "path": "v2/users/{userId}/companyRelation", 738 "I_CONSUMER_PACKAGED_GOODS",
689 "response": { 739 "I_EDUCATION",
690 "$ref": "Empty" 740 "I_FINANCE",
691 } 741 "I_HEALTHCARE",
692 }, 742 "I_MEDIA_AND_ENTERTAINMENT",
693 "createCompanyRelation": { 743 "I_RETAIL",
694 "description": "Creates a user's company relation. Affiliate s the user to a company.", 744 "I_TECHNOLOGY",
695 "httpMethod": "PUT", 745 "I_TRAVEL"
696 "id": "partners.users.createCompanyRelation", 746 ],
697 "parameterOrder": [
698 "userId"
699 ],
700 "parameters": {
701 "requestMetadata.partnersSessionId": {
702 "description": "Google Partners session ID.",
703 "location": "query",
704 "type": "string"
705 },
706 "requestMetadata.userOverrides.userId": {
707 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
708 "location": "query",
709 "type": "string"
710 },
711 "requestMetadata.trafficSource.trafficSourceId": {
712 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
713 "location": "query",
714 "type": "string"
715 },
716 "requestMetadata.locale": {
717 "description": "Locale to use for the current reques t.",
718 "location": "query",
719 "type": "string"
720 },
721 "requestMetadata.userOverrides.ipAddress": {
722 "description": "IP address to use instead of the use r's geo-located IP address.",
723 "location": "query",
724 "type": "string"
725 },
726 "requestMetadata.experimentIds": {
727 "description": "Experiment IDs the current request b elongs to.",
728 "location": "query", 747 "location": "query",
729 "repeated": true, 748 "repeated": true,
730 "type": "string" 749 "type": "string"
731 }, 750 },
732 "userId": { 751 "websiteUrl": {
733 "description": "The ID of the user. Can be set to <c ode>me</code> to mean\nthe currently authenticated user.", 752 "description": "Website URL that will help to find a better matched company.\n.",
734 "location": "path", 753 "location": "query",
735 "required": true, 754 "type": "string"
755 },
756 "gpsMotivations": {
757 "description": "List of reasons for using Google Par tner Search to get companies.",
758 "enum": [
759 "GPS_MOTIVATION_UNSPECIFIED",
760 "GPSM_HELP_WITH_ADVERTISING",
761 "GPSM_HELP_WITH_WEBSITE",
762 "GPSM_NO_WEBSITE"
763 ],
764 "location": "query",
765 "repeated": true,
766 "type": "string"
767 }
768 },
769 "path": "v2/companies",
770 "response": {
771 "$ref": "ListCompaniesResponse"
772 }
773 },
774 "get": {
775 "description": "Gets a company.",
776 "httpMethod": "GET",
777 "id": "partners.companies.get",
778 "parameterOrder": [
779 "companyId"
780 ],
781 "parameters": {
782 "orderBy": {
783 "description": "How to order addresses within the re turned company. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
784 "location": "query",
736 "type": "string" 785 "type": "string"
737 }, 786 },
738 "requestMetadata.trafficSource.trafficSubId": { 787 "requestMetadata.trafficSource.trafficSubId": {
739 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.", 788 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
740 "location": "query", 789 "location": "query",
741 "type": "string" 790 "type": "string"
742 } 791 },
743 },
744 "path": "v2/users/{userId}/companyRelation",
745 "request": {
746 "$ref": "CompanyRelation"
747 },
748 "response": {
749 "$ref": "CompanyRelation"
750 }
751 },
752 "get": {
753 "description": "Gets a user.",
754 "httpMethod": "GET",
755 "id": "partners.users.get",
756 "parameterOrder": [
757 "userId"
758 ],
759 "parameters": {
760 "requestMetadata.partnersSessionId": { 792 "requestMetadata.partnersSessionId": {
761 "description": "Google Partners session ID.", 793 "description": "Google Partners session ID.",
762 "location": "query", 794 "location": "query",
763 "type": "string" 795 "type": "string"
764 }, 796 },
765 "requestMetadata.userOverrides.userId": { 797 "requestMetadata.userOverrides.userId": {
766 "description": "Logged-in user ID to impersonate ins tead of the user's ID.", 798 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
767 "location": "query", 799 "location": "query",
768 "type": "string" 800 "type": "string"
769 }, 801 },
802 "view": {
803 "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
804 "enum": [
805 "COMPANY_VIEW_UNSPECIFIED",
806 "CV_GOOGLE_PARTNER_SEARCH"
807 ],
808 "location": "query",
809 "type": "string"
810 },
811 "requestMetadata.locale": {
812 "description": "Locale to use for the current reques t.",
813 "location": "query",
814 "type": "string"
815 },
816 "address": {
817 "description": "The address to use for sorting the c ompany's addresses by proximity.\nIf not given, the geo-located address of the r equest is used.\nUsed when order_by is set.",
818 "location": "query",
819 "type": "string"
820 },
821 "requestMetadata.trafficSource.trafficSourceId": {
822 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
823 "location": "query",
824 "type": "string"
825 },
826 "requestMetadata.userOverrides.ipAddress": {
827 "description": "IP address to use instead of the use r's geo-located IP address.",
828 "location": "query",
829 "type": "string"
830 },
831 "companyId": {
832 "description": "The ID of the company to retrieve.",
833 "location": "path",
834 "required": true,
835 "type": "string"
836 },
837 "requestMetadata.experimentIds": {
838 "description": "Experiment IDs the current request b elongs to.",
839 "location": "query",
840 "repeated": true,
841 "type": "string"
842 },
843 "currencyCode": {
844 "description": "If the company's budget is in a diff erent currency code than this one, then\nthe converted budget is converted to th is currency code.",
845 "location": "query",
846 "type": "string"
847 }
848 },
849 "path": "v2/companies/{companyId}",
850 "response": {
851 "$ref": "GetCompanyResponse"
852 }
853 }
854 },
855 "resources": {
856 "leads": {
857 "methods": {
858 "create": {
859 "description": "Creates an advertiser lead for the g iven company ID.",
860 "httpMethod": "POST",
861 "id": "partners.companies.leads.create",
862 "parameterOrder": [
863 "companyId"
864 ],
865 "parameters": {
866 "companyId": {
867 "description": "The ID of the company to con tact.",
868 "location": "path",
869 "required": true,
870 "type": "string"
871 }
872 },
873 "path": "v2/companies/{companyId}/leads",
874 "request": {
875 "$ref": "CreateLeadRequest"
876 },
877 "response": {
878 "$ref": "CreateLeadResponse"
879 }
880 }
881 }
882 }
883 }
884 },
885 "users": {
886 "methods": {
887 "deleteCompanyRelation": {
888 "description": "Deletes a user's company relation. Unaffilia ites the user from a company.",
889 "httpMethod": "DELETE",
890 "id": "partners.users.deleteCompanyRelation",
891 "parameterOrder": [
892 "userId"
893 ],
894 "parameters": {
895 "requestMetadata.experimentIds": {
896 "description": "Experiment IDs the current request b elongs to.",
897 "location": "query",
898 "repeated": true,
899 "type": "string"
900 },
901 "requestMetadata.trafficSource.trafficSubId": {
902 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
903 "location": "query",
904 "type": "string"
905 },
906 "userId": {
907 "description": "The ID of the user. Can be set to <c ode>me</code> to mean\nthe currently authenticated user.",
908 "location": "path",
909 "required": true,
910 "type": "string"
911 },
912 "requestMetadata.partnersSessionId": {
913 "description": "Google Partners session ID.",
914 "location": "query",
915 "type": "string"
916 },
917 "requestMetadata.userOverrides.userId": {
918 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
919 "location": "query",
920 "type": "string"
921 },
922 "requestMetadata.trafficSource.trafficSourceId": {
923 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
924 "location": "query",
925 "type": "string"
926 },
927 "requestMetadata.locale": {
928 "description": "Locale to use for the current reques t.",
929 "location": "query",
930 "type": "string"
931 },
932 "requestMetadata.userOverrides.ipAddress": {
933 "description": "IP address to use instead of the use r's geo-located IP address.",
934 "location": "query",
935 "type": "string"
936 }
937 },
938 "path": "v2/users/{userId}/companyRelation",
939 "response": {
940 "$ref": "Empty"
941 }
942 },
943 "createCompanyRelation": {
944 "description": "Creates a user's company relation. Affiliate s the user to a company.",
945 "httpMethod": "PUT",
946 "id": "partners.users.createCompanyRelation",
947 "parameterOrder": [
948 "userId"
949 ],
950 "parameters": {
951 "requestMetadata.userOverrides.userId": {
952 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
953 "location": "query",
954 "type": "string"
955 },
956 "requestMetadata.partnersSessionId": {
957 "description": "Google Partners session ID.",
958 "location": "query",
959 "type": "string"
960 },
961 "requestMetadata.trafficSource.trafficSourceId": {
962 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
963 "location": "query",
964 "type": "string"
965 },
966 "requestMetadata.locale": {
967 "description": "Locale to use for the current reques t.",
968 "location": "query",
969 "type": "string"
970 },
971 "requestMetadata.userOverrides.ipAddress": {
972 "description": "IP address to use instead of the use r's geo-located IP address.",
973 "location": "query",
974 "type": "string"
975 },
976 "requestMetadata.experimentIds": {
977 "description": "Experiment IDs the current request b elongs to.",
978 "location": "query",
979 "repeated": true,
980 "type": "string"
981 },
982 "requestMetadata.trafficSource.trafficSubId": {
983 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
984 "location": "query",
985 "type": "string"
986 },
987 "userId": {
988 "description": "The ID of the user. Can be set to <c ode>me</code> to mean\nthe currently authenticated user.",
989 "location": "path",
990 "required": true,
991 "type": "string"
992 }
993 },
994 "path": "v2/users/{userId}/companyRelation",
995 "request": {
996 "$ref": "CompanyRelation"
997 },
998 "response": {
999 "$ref": "CompanyRelation"
1000 }
1001 },
1002 "get": {
1003 "description": "Gets a user.",
1004 "httpMethod": "GET",
1005 "id": "partners.users.get",
1006 "parameterOrder": [
1007 "userId"
1008 ],
1009 "parameters": {
1010 "requestMetadata.experimentIds": {
1011 "description": "Experiment IDs the current request b elongs to.",
1012 "location": "query",
1013 "repeated": true,
1014 "type": "string"
1015 },
1016 "userId": {
1017 "description": "Identifier of the user. Can be set t o <code>me</code> to mean the currently\nauthenticated user.",
1018 "location": "path",
1019 "required": true,
1020 "type": "string"
1021 },
1022 "requestMetadata.trafficSource.trafficSubId": {
1023 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
1024 "location": "query",
1025 "type": "string"
1026 },
1027 "requestMetadata.partnersSessionId": {
1028 "description": "Google Partners session ID.",
1029 "location": "query",
1030 "type": "string"
1031 },
1032 "requestMetadata.userOverrides.userId": {
1033 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
1034 "location": "query",
1035 "type": "string"
1036 },
770 "userView": { 1037 "userView": {
771 "description": "Specifies what parts of the user inf ormation to return.", 1038 "description": "Specifies what parts of the user inf ormation to return.",
772 "enum": [ 1039 "enum": [
773 "BASIC", 1040 "BASIC",
774 "PROFILE", 1041 "PROFILE",
775 "PUBLIC_PROFILE" 1042 "PUBLIC_PROFILE"
776 ], 1043 ],
777 "location": "query", 1044 "location": "query",
778 "type": "string" 1045 "type": "string"
779 }, 1046 },
780 "requestMetadata.trafficSource.trafficSourceId": {
781 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
782 "location": "query",
783 "type": "string"
784 },
785 "requestMetadata.locale": {
786 "description": "Locale to use for the current reques t.",
787 "location": "query",
788 "type": "string"
789 },
790 "requestMetadata.userOverrides.ipAddress": {
791 "description": "IP address to use instead of the use r's geo-located IP address.",
792 "location": "query",
793 "type": "string"
794 },
795 "requestMetadata.experimentIds": {
796 "description": "Experiment IDs the current request b elongs to.",
797 "location": "query",
798 "repeated": true,
799 "type": "string"
800 },
801 "userId": {
802 "description": "Identifier of the user. Can be set t o <code>me</code> to mean the currently\nauthenticated user.",
803 "location": "path",
804 "required": true,
805 "type": "string"
806 },
807 "requestMetadata.trafficSource.trafficSubId": {
808 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
809 "location": "query",
810 "type": "string"
811 }
812 },
813 "path": "v2/users/{userId}",
814 "response": {
815 "$ref": "User"
816 }
817 }
818 }
819 },
820 "companies": {
821 "methods": {
822 "list": {
823 "description": "Lists companies.",
824 "httpMethod": "GET",
825 "id": "partners.companies.list",
826 "parameterOrder": [],
827 "parameters": {
828 "companyName": {
829 "description": "Company name to search for.",
830 "location": "query",
831 "type": "string"
832 },
833 "pageToken": {
834 "description": "A token identifying a page of result s that the server returns.\nTypically, this is the value of `ListCompaniesRespon se.next_page_token`\nreturned from the previous call to\nListCompanies.",
835 "location": "query",
836 "type": "string"
837 },
838 "industries": {
839 "description": "List of industries the company can h elp with.",
840 "enum": [
841 "INDUSTRY_UNSPECIFIED",
842 "I_AUTOMOTIVE",
843 "I_BUSINESS_TO_BUSINESS",
844 "I_CONSUMER_PACKAGED_GOODS",
845 "I_EDUCATION",
846 "I_FINANCE",
847 "I_HEALTHCARE",
848 "I_MEDIA_AND_ENTERTAINMENT",
849 "I_RETAIL",
850 "I_TECHNOLOGY",
851 "I_TRAVEL"
852 ],
853 "location": "query",
854 "repeated": true,
855 "type": "string"
856 },
857 "websiteUrl": {
858 "description": "Website URL that will help to find a better matched company.\n.",
859 "location": "query",
860 "type": "string"
861 },
862 "gpsMotivations": {
863 "description": "List of reasons for using Google Par tner Search to get companies.",
864 "enum": [
865 "GPS_MOTIVATION_UNSPECIFIED",
866 "GPSM_HELP_WITH_ADVERTISING",
867 "GPSM_HELP_WITH_WEBSITE",
868 "GPSM_NO_WEBSITE"
869 ],
870 "location": "query",
871 "repeated": true,
872 "type": "string"
873 },
874 "languageCodes": {
875 "description": "List of language codes that company can support. Only primary language\nsubtags are accepted as defined by\n<a href= \"https://tools.ietf.org/html/bcp47\">BCP 47</a>\n(IETF BCP 47, \"Tags for Ident ifying Languages\").",
876 "location": "query",
877 "repeated": true,
878 "type": "string"
879 },
880 "pageSize": {
881 "description": "Requested page size. Server may retu rn fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
882 "format": "int32",
883 "location": "query",
884 "type": "integer"
885 },
886 "requestMetadata.userOverrides.ipAddress": {
887 "description": "IP address to use instead of the use r's geo-located IP address.",
888 "location": "query",
889 "type": "string"
890 },
891 "requestMetadata.experimentIds": {
892 "description": "Experiment IDs the current request b elongs to.",
893 "location": "query",
894 "repeated": true,
895 "type": "string"
896 },
897 "orderBy": {
898 "description": "How to order addresses within the re turned companies. Currently, only\n`address` and `address desc` is supported whi ch will sorted by closest to\nfarthest in distance from given address and farthe st to closest distance\nfrom given address respectively.",
899 "location": "query",
900 "type": "string"
901 },
902 "specializations": {
903 "description": "List of specializations that the ret urned agencies should provide. If this\nis not empty, any returned agency must h ave at least one of these\nspecializations, or one of the services in the \"serv ices\" field.",
904 "enum": [
905 "BADGE_SPECIALIZATION_UNKNOWN",
906 "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
907 "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
908 "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
909 "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
910 "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
911 ],
912 "location": "query",
913 "repeated": true,
914 "type": "string"
915 },
916 "maxMonthlyBudget.currencyCode": {
917 "description": "The 3-letter currency code defined i n ISO 4217.",
918 "location": "query",
919 "type": "string"
920 },
921 "minMonthlyBudget.currencyCode": {
922 "description": "The 3-letter currency code defined i n ISO 4217.",
923 "location": "query",
924 "type": "string"
925 },
926 "requestMetadata.userOverrides.userId": {
927 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
928 "location": "query",
929 "type": "string"
930 },
931 "view": {
932 "description": "The view of the `Company` resource t o be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
933 "enum": [
934 "COMPANY_VIEW_UNSPECIFIED",
935 "CV_GOOGLE_PARTNER_SEARCH"
936 ],
937 "location": "query",
938 "type": "string"
939 },
940 "requestMetadata.locale": {
941 "description": "Locale to use for the current reques t.",
942 "location": "query",
943 "type": "string"
944 },
945 "address": {
946 "description": "The address to use when searching fo r companies.\nIf not given, the geo-located address of the request is used.",
947 "location": "query",
948 "type": "string"
949 },
950 "minMonthlyBudget.units": {
951 "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
952 "format": "int64",
953 "location": "query",
954 "type": "string"
955 },
956 "maxMonthlyBudget.nanos": {
957 "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nan os` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`= -750,000,000.",
958 "format": "int32",
959 "location": "query",
960 "type": "integer"
961 },
962 "services": {
963 "description": "List of services that the returned a gencies should provide. If this is\nnot empty, any returned agency must have at least one of these services,\nor one of the specializations in the \"specializat ions\" field.",
964 "enum": [
965 "SERVICE_UNSPECIFIED",
966 "S_ADVANCED_ADWORDS_SUPPORT",
967 "S_ADVERTISING_ON_GOOGLE",
968 "S_AN_ENHANCED_WEBSITE",
969 "S_AN_ONLINE_MARKETING_PLAN",
970 "S_MOBILE_AND_VIDEO_ADS",
971 "S_MOBILE_WEBSITE_SERVICES"
972 ],
973 "location": "query",
974 "repeated": true,
975 "type": "string"
976 },
977 "maxMonthlyBudget.units": {
978 "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
979 "format": "int64",
980 "location": "query",
981 "type": "string"
982 },
983 "requestMetadata.trafficSource.trafficSourceId": { 1047 "requestMetadata.trafficSource.trafficSourceId": {
984 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.", 1048 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
985 "location": "query", 1049 "location": "query",
986 "type": "string" 1050 "type": "string"
987 }, 1051 },
988 "requestMetadata.trafficSource.trafficSubId": {
989 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
990 "location": "query",
991 "type": "string"
992 },
993 "minMonthlyBudget.nanos": {
994 "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nan os` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`= -750,000,000.",
995 "format": "int32",
996 "location": "query",
997 "type": "integer"
998 },
999 "requestMetadata.partnersSessionId": {
1000 "description": "Google Partners session ID.",
1001 "location": "query",
1002 "type": "string"
1003 }
1004 },
1005 "path": "v2/companies",
1006 "response": {
1007 "$ref": "ListCompaniesResponse"
1008 }
1009 },
1010 "get": {
1011 "description": "Gets a company.",
1012 "httpMethod": "GET",
1013 "id": "partners.companies.get",
1014 "parameterOrder": [
1015 "companyId"
1016 ],
1017 "parameters": {
1018 "address": {
1019 "description": "The address to use for sorting the c ompany's addresses by proximity.\nIf not given, the geo-located address of the r equest is used.\nUsed when order_by is set.",
1020 "location": "query",
1021 "type": "string"
1022 },
1023 "requestMetadata.locale": { 1052 "requestMetadata.locale": {
1024 "description": "Locale to use for the current reques t.", 1053 "description": "Locale to use for the current reques t.",
1025 "location": "query", 1054 "location": "query",
1026 "type": "string" 1055 "type": "string"
1027 }, 1056 },
1057 "requestMetadata.userOverrides.ipAddress": {
1058 "description": "IP address to use instead of the use r's geo-located IP address.",
1059 "location": "query",
1060 "type": "string"
1061 }
1062 },
1063 "path": "v2/users/{userId}",
1064 "response": {
1065 "$ref": "User"
1066 }
1067 },
1068 "updateProfile": {
1069 "description": "Updates a user's profile. A user can only up date their own profile and\nshould only be called within the context of a logged in user.",
1070 "httpMethod": "PATCH",
1071 "id": "partners.users.updateProfile",
1072 "parameterOrder": [],
1073 "parameters": {
1074 "requestMetadata.partnersSessionId": {
1075 "description": "Google Partners session ID.",
1076 "location": "query",
1077 "type": "string"
1078 },
1079 "requestMetadata.userOverrides.userId": {
1080 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
1081 "location": "query",
1082 "type": "string"
1083 },
1028 "requestMetadata.trafficSource.trafficSourceId": { 1084 "requestMetadata.trafficSource.trafficSourceId": {
1029 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.", 1085 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
1030 "location": "query", 1086 "location": "query",
1031 "type": "string" 1087 "type": "string"
1032 }, 1088 },
1089 "requestMetadata.locale": {
1090 "description": "Locale to use for the current reques t.",
1091 "location": "query",
1092 "type": "string"
1093 },
1033 "requestMetadata.userOverrides.ipAddress": { 1094 "requestMetadata.userOverrides.ipAddress": {
1034 "description": "IP address to use instead of the use r's geo-located IP address.", 1095 "description": "IP address to use instead of the use r's geo-located IP address.",
1035 "location": "query", 1096 "location": "query",
1036 "type": "string" 1097 "type": "string"
1037 }, 1098 },
1038 "companyId": {
1039 "description": "The ID of the company to retrieve.",
1040 "location": "path",
1041 "required": true,
1042 "type": "string"
1043 },
1044 "currencyCode": {
1045 "description": "If the company's budget is in a diff erent currency code than this one, then\nthe converted budget is converted to th is currency code.",
1046 "location": "query",
1047 "type": "string"
1048 },
1049 "requestMetadata.experimentIds": { 1099 "requestMetadata.experimentIds": {
1050 "description": "Experiment IDs the current request b elongs to.", 1100 "description": "Experiment IDs the current request b elongs to.",
1051 "location": "query", 1101 "location": "query",
1052 "repeated": true, 1102 "repeated": true,
1053 "type": "string" 1103 "type": "string"
1054 }, 1104 },
1055 "requestMetadata.trafficSource.trafficSubId": { 1105 "requestMetadata.trafficSource.trafficSubId": {
1056 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.", 1106 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
1057 "location": "query", 1107 "location": "query",
1058 "type": "string" 1108 "type": "string"
1059 },
1060 "orderBy": {
1061 "description": "How to order addresses within the re turned company. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
1062 "location": "query",
1063 "type": "string"
1064 },
1065 "requestMetadata.userOverrides.userId": {
1066 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
1067 "location": "query",
1068 "type": "string"
1069 },
1070 "requestMetadata.partnersSessionId": {
1071 "description": "Google Partners session ID.",
1072 "location": "query",
1073 "type": "string"
1074 },
1075 "view": {
1076 "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
1077 "enum": [
1078 "COMPANY_VIEW_UNSPECIFIED",
1079 "CV_GOOGLE_PARTNER_SEARCH"
1080 ],
1081 "location": "query",
1082 "type": "string"
1083 } 1109 }
1084 }, 1110 },
1085 "path": "v2/companies/{companyId}", 1111 "path": "v2/users/profile",
1112 "request": {
1113 "$ref": "UserProfile"
1114 },
1086 "response": { 1115 "response": {
1087 "$ref": "GetCompanyResponse" 1116 "$ref": "UserProfile"
1088 }
1089 }
1090 },
1091 "resources": {
1092 "leads": {
1093 "methods": {
1094 "create": {
1095 "description": "Creates an advertiser lead for the g iven company ID.",
1096 "httpMethod": "POST",
1097 "id": "partners.companies.leads.create",
1098 "parameterOrder": [
1099 "companyId"
1100 ],
1101 "parameters": {
1102 "companyId": {
1103 "description": "The ID of the company to con tact.",
1104 "location": "path",
1105 "required": true,
1106 "type": "string"
1107 }
1108 },
1109 "path": "v2/companies/{companyId}/leads",
1110 "request": {
1111 "$ref": "CreateLeadRequest"
1112 },
1113 "response": {
1114 "$ref": "CreateLeadResponse"
1115 }
1116 }
1117 } 1117 }
1118 } 1118 }
1119 } 1119 }
1120 }, 1120 },
1121 "userEvents": { 1121 "userEvents": {
1122 "methods": { 1122 "methods": {
1123 "log": { 1123 "log": {
1124 "description": "Logs a user event.", 1124 "description": "Logs a user event.",
1125 "httpMethod": "POST", 1125 "httpMethod": "POST",
1126 "id": "partners.userEvents.log", 1126 "id": "partners.userEvents.log",
(...skipping 30 matching lines...) Expand all
1157 "exams": { 1157 "exams": {
1158 "methods": { 1158 "methods": {
1159 "getToken": { 1159 "getToken": {
1160 "description": "Gets an Exam Token for a Partner's user to t ake an exam in the Exams System", 1160 "description": "Gets an Exam Token for a Partner's user to t ake an exam in the Exams System",
1161 "httpMethod": "GET", 1161 "httpMethod": "GET",
1162 "id": "partners.exams.getToken", 1162 "id": "partners.exams.getToken",
1163 "parameterOrder": [ 1163 "parameterOrder": [
1164 "examType" 1164 "examType"
1165 ], 1165 ],
1166 "parameters": { 1166 "parameters": {
1167 "examType": { 1167 "requestMetadata.partnersSessionId": {
1168 "description": "The exam type we are requesting a to ken for.", 1168 "description": "Google Partners session ID.",
1169 "enum": [ 1169 "location": "query",
1170 "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
1171 "CET_ADWORDS_FUNDAMENTALS",
1172 "CET_ADWORDS_ADVANCED_SEARCH",
1173 "CET_ADWORDS_ADVANCED_DISPLAY",
1174 "CET_VIDEO_ADS",
1175 "CET_DOUBLECLICK",
1176 "CET_ANALYTICS",
1177 "CET_SHOPPING",
1178 "CET_MOBILE",
1179 "CET_DIGITAL_SALES",
1180 "CET_MOBILE_SITES"
1181 ],
1182 "location": "path",
1183 "required": true,
1184 "type": "string" 1170 "type": "string"
1185 }, 1171 },
1186 "requestMetadata.userOverrides.userId": { 1172 "requestMetadata.userOverrides.userId": {
1187 "description": "Logged-in user ID to impersonate ins tead of the user's ID.", 1173 "description": "Logged-in user ID to impersonate ins tead of the user's ID.",
1188 "location": "query", 1174 "location": "query",
1189 "type": "string" 1175 "type": "string"
1190 }, 1176 },
1191 "requestMetadata.partnersSessionId": {
1192 "description": "Google Partners session ID.",
1193 "location": "query",
1194 "type": "string"
1195 },
1196 "requestMetadata.trafficSource.trafficSourceId": { 1177 "requestMetadata.trafficSource.trafficSourceId": {
1197 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.", 1178 "description": "Identifier to indicate where the tra ffic comes from.\nAn identifier has multiple letters created by a team which red irected the\ntraffic to us.",
1198 "location": "query", 1179 "location": "query",
1199 "type": "string" 1180 "type": "string"
1200 }, 1181 },
1201 "requestMetadata.locale": { 1182 "requestMetadata.locale": {
1202 "description": "Locale to use for the current reques t.", 1183 "description": "Locale to use for the current reques t.",
1203 "location": "query", 1184 "location": "query",
1204 "type": "string" 1185 "type": "string"
1205 }, 1186 },
1206 "requestMetadata.userOverrides.ipAddress": { 1187 "requestMetadata.userOverrides.ipAddress": {
1207 "description": "IP address to use instead of the use r's geo-located IP address.", 1188 "description": "IP address to use instead of the use r's geo-located IP address.",
1208 "location": "query", 1189 "location": "query",
1209 "type": "string" 1190 "type": "string"
1210 }, 1191 },
1211 "requestMetadata.experimentIds": { 1192 "requestMetadata.experimentIds": {
1212 "description": "Experiment IDs the current request b elongs to.", 1193 "description": "Experiment IDs the current request b elongs to.",
1213 "location": "query", 1194 "location": "query",
1214 "repeated": true, 1195 "repeated": true,
1215 "type": "string" 1196 "type": "string"
1216 }, 1197 },
1217 "requestMetadata.trafficSource.trafficSubId": { 1198 "requestMetadata.trafficSource.trafficSubId": {
1218 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.", 1199 "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a t eam which redirected the\ntraffic to us.",
1219 "location": "query", 1200 "location": "query",
1220 "type": "string" 1201 "type": "string"
1202 },
1203 "examType": {
1204 "description": "The exam type we are requesting a to ken for.",
1205 "enum": [
1206 "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
1207 "CET_ADWORDS_FUNDAMENTALS",
1208 "CET_ADWORDS_ADVANCED_SEARCH",
1209 "CET_ADWORDS_ADVANCED_DISPLAY",
1210 "CET_VIDEO_ADS",
1211 "CET_DOUBLECLICK",
1212 "CET_ANALYTICS",
1213 "CET_SHOPPING",
1214 "CET_MOBILE",
1215 "CET_DIGITAL_SALES",
1216 "CET_MOBILE_SITES"
1217 ],
1218 "location": "path",
1219 "required": true,
1220 "type": "string"
1221 } 1221 }
1222 }, 1222 },
1223 "path": "v2/exams/{examType}/token", 1223 "path": "v2/exams/{examType}/token",
1224 "response": { 1224 "response": {
1225 "$ref": "ExamToken" 1225 "$ref": "ExamToken"
1226 } 1226 }
1227 } 1227 }
1228 } 1228 }
1229 } 1229 }
1230 }, 1230 },
1231 "revision": "20170725", 1231 "revision": "20170812",
1232 "rootUrl": "https://partners.googleapis.com/", 1232 "rootUrl": "https://partners.googleapis.com/",
1233 "schemas": { 1233 "schemas": {
1234 "AnalyticsSummary": { 1234 "LocalizedCompanyInfo": {
1235 "description": "Analytics aggregated data for a `Company` for a give n date range.", 1235 "description": "The localized company information.",
1236 "id": "AnalyticsSummary", 1236 "id": "LocalizedCompanyInfo",
1237 "properties": { 1237 "properties": {
1238 "profileViewsCount": { 1238 "countryCodes": {
1239 "description": "Aggregated number of profile views for the ` Company` for given date range.", 1239 "description": "List of country codes for the localized comp any info.",
1240 "format": "int32", 1240 "items": {
1241 "type": "integer" 1241 "type": "string"
1242 }, 1242 },
1243 "searchViewsCount": { 1243 "type": "array"
1244 "description": "Aggregated number of times users saw the `Co mpany`\nin Google Partners Search results for given date range.", 1244 },
1245 "format": "int32", 1245 "overview": {
1246 "type": "integer" 1246 "description": "Localized brief description that the company uses to advertise themselves.",
1247 }, 1247 "type": "string"
1248 "contactsCount": { 1248 },
1249 "description": "Aggregated number of times users contacted t he `Company`\nfor given date range.", 1249 "displayName": {
1250 "format": "int32", 1250 "description": "Localized display name.",
1251 "type": "integer"
1252 }
1253 },
1254 "type": "object"
1255 },
1256 "LogMessageRequest": {
1257 "description": "Request message for\nLogClientMessage.",
1258 "id": "LogMessageRequest",
1259 "properties": {
1260 "details": {
1261 "description": "Details about the client message.",
1262 "type": "string"
1263 },
1264 "clientInfo": {
1265 "additionalProperties": {
1266 "type": "string"
1267 },
1268 "description": "Map of client info, such as URL, browser nav igator, browser platform, etc.",
1269 "type": "object"
1270 },
1271 "requestMetadata": {
1272 "$ref": "RequestMetadata",
1273 "description": "Current request metadata."
1274 },
1275 "level": {
1276 "description": "Message level of client message.",
1277 "enum": [
1278 "MESSAGE_LEVEL_UNSPECIFIED",
1279 "ML_FINE",
1280 "ML_INFO",
1281 "ML_WARNING",
1282 "ML_SEVERE"
1283 ],
1284 "enumDescriptions": [
1285 "Unchosen.",
1286 "Message level for tracing information.",
1287 "Message level for informational messages.",
1288 "Message level for potential problems.",
1289 "Message level for serious failures."
1290 ],
1291 "type": "string"
1292 }
1293 },
1294 "type": "object"
1295 },
1296 "DebugInfo": {
1297 "description": "Debug information about this request.",
1298 "id": "DebugInfo",
1299 "properties": {
1300 "serviceUrl": {
1301 "description": "URL of the service that handled this request .",
1302 "type": "string"
1303 },
1304 "serverTraceInfo": {
1305 "description": "Server-side debug stack trace.",
1306 "type": "string"
1307 },
1308 "serverInfo": {
1309 "description": "Info about the server that serviced this req uest.",
1310 "type": "string"
1311 }
1312 },
1313 "type": "object"
1314 },
1315 "Lead": {
1316 "description": "A lead resource that represents an advertiser contac t for a `Company`. These\nare usually generated via Google Partner Search (the a dvertiser portal).",
1317 "id": "Lead",
1318 "properties": {
1319 "adwordsCustomerId": {
1320 "description": "The AdWords Customer ID of the lead.",
1321 "format": "int64",
1322 "type": "string"
1323 },
1324 "phoneNumber": {
1325 "description": "Phone number of lead source.",
1326 "type": "string"
1327 },
1328 "createTime": {
1329 "description": "Timestamp of when this lead was created.",
1330 "format": "google-datetime",
1331 "type": "string"
1332 },
1333 "marketingOptIn": {
1334 "description": "Whether or not the lead signed up for market ing emails",
1335 "type": "boolean"
1336 },
1337 "type": {
1338 "description": "Type of lead.",
1339 "enum": [
1340 "LEAD_TYPE_UNSPECIFIED",
1341 "LT_GPS"
1342 ],
1343 "enumDescriptions": [
1344 "Unchosen.",
1345 "Google Partner Search."
1346 ],
1347 "type": "string"
1348 },
1349 "minMonthlyBudget": {
1350 "$ref": "Money",
1351 "description": "The minimum monthly budget lead source is wi lling to spend."
1352 },
1353 "givenName": {
1354 "description": "First name of lead source.",
1355 "type": "string" 1251 "type": "string"
1356 }, 1252 },
1357 "languageCode": { 1253 "languageCode": {
1358 "description": "Language code of the lead's language prefere nce, as defined by\n<a href=\"https://tools.ietf.org/html/bcp47\">BCP 47</a>\n(I ETF BCP 47, \"Tags for Identifying Languages\").", 1254 "description": "Language code of the localized company info, as defined by\n<a href=\"https://tools.ietf.org/html/bcp47\">BCP 47</a>\n(IETF BCP 47, \"Tags for Identifying Languages\").",
1359 "type": "string" 1255 "type": "string"
1360 }, 1256 }
1361 "websiteUrl": { 1257 },
1362 "description": "Website URL of lead source.", 1258 "type": "object"
1363 "type": "string" 1259 },
1364 }, 1260 "LogUserEventResponse": {
1365 "state": { 1261 "description": "Response message for\nLogUserEvent.",
1366 "description": "The lead's state in relation to the company. ", 1262 "id": "LogUserEventResponse",
1367 "enum": [
1368 "LEAD_STATE_UNSPECIFIED",
1369 "LEAD",
1370 "CONTACTED",
1371 "CLIENT",
1372 "OTHER"
1373 ],
1374 "enumDescriptions": [
1375 "Unchosen.",
1376 "Lead not yet contacted.",
1377 "Lead has been contacted.",
1378 "Lead has become a client.",
1379 "Lead in a state not covered by other options."
1380 ],
1381 "type": "string"
1382 },
1383 "gpsMotivations": {
1384 "description": "List of reasons for using Google Partner Sea rch and creating a lead.",
1385 "enumDescriptions": [
1386 "Unchosen.",
1387 "Advertiser needs help with their advertising.",
1388 "Advertiser needs help with their website.",
1389 "Advertiser does not have a website."
1390 ],
1391 "items": {
1392 "enum": [
1393 "GPS_MOTIVATION_UNSPECIFIED",
1394 "GPSM_HELP_WITH_ADVERTISING",
1395 "GPSM_HELP_WITH_WEBSITE",
1396 "GPSM_NO_WEBSITE"
1397 ],
1398 "type": "string"
1399 },
1400 "type": "array"
1401 },
1402 "email": {
1403 "description": "Email address of lead source.",
1404 "type": "string"
1405 },
1406 "familyName": {
1407 "description": "Last name of lead source.",
1408 "type": "string"
1409 },
1410 "comments": {
1411 "description": "Comments lead source gave.",
1412 "type": "string"
1413 },
1414 "id": {
1415 "description": "ID of the lead.",
1416 "type": "string"
1417 }
1418 },
1419 "type": "object"
1420 },
1421 "ListUserStatesResponse": {
1422 "description": "Response message for\nListUserStates.",
1423 "id": "ListUserStatesResponse",
1424 "properties": { 1263 "properties": {
1425 "responseMetadata": { 1264 "responseMetadata": {
1426 "$ref": "ResponseMetadata", 1265 "$ref": "ResponseMetadata",
1427 "description": "Current response metadata." 1266 "description": "Current response metadata."
1428 }, 1267 }
1429 "userStates": { 1268 },
1430 "description": "User's states.", 1269 "type": "object"
1270 },
1271 "ListOffersHistoryResponse": {
1272 "description": "Response for ListOfferHistory.",
1273 "id": "ListOffersHistoryResponse",
1274 "properties": {
1275 "canShowEntireCompany": {
1276 "description": "True if the user has the option to show enti re company history.",
1277 "type": "boolean"
1278 },
1279 "totalResults": {
1280 "description": "Number of results across all pages.",
1281 "format": "int32",
1282 "type": "integer"
1283 },
1284 "showingEntireCompany": {
1285 "description": "True if this response is showing entire comp any history.",
1286 "type": "boolean"
1287 },
1288 "offers": {
1289 "description": "Historical offers meeting request.",
1290 "items": {
1291 "$ref": "HistoricalOffer"
1292 },
1293 "type": "array"
1294 },
1295 "nextPageToken": {
1296 "description": "Supply this token in a ListOffersHistoryRequ est to retrieve the next page.",
1297 "type": "string"
1298 },
1299 "responseMetadata": {
1300 "$ref": "ResponseMetadata",
1301 "description": "Current response metadata."
1302 }
1303 },
1304 "type": "object"
1305 },
1306 "LogMessageResponse": {
1307 "description": "Response message for\nLogClientMessage.",
1308 "id": "LogMessageResponse",
1309 "properties": {
1310 "responseMetadata": {
1311 "$ref": "ResponseMetadata",
1312 "description": "Current response metadata."
1313 }
1314 },
1315 "type": "object"
1316 },
1317 "SpecializationStatus": {
1318 "description": "Agency specialization status",
1319 "id": "SpecializationStatus",
1320 "properties": {
1321 "badgeSpecializationState": {
1322 "description": "State of agency specialization.",
1323 "enum": [
1324 "BADGE_SPECIALIZATION_STATE_UNKNOWN",
1325 "BADGE_SPECIALIZATION_STATE_PASSED",
1326 "BADGE_SPECIALIZATION_STATE_NOT_PASSED",
1327 "BADGE_SPECIALIZATION_STATE_IN_GRACE"
1328 ],
1329 "enumDescriptions": [
1330 "Unknown state",
1331 "Specialization passed",
1332 "Specialization not passed",
1333 "Specialization in grace"
1334 ],
1335 "type": "string"
1336 },
1337 "badgeSpecialization": {
1338 "description": "The specialization this status is for.",
1339 "enum": [
1340 "BADGE_SPECIALIZATION_UNKNOWN",
1341 "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
1342 "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
1343 "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
1344 "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
1345 "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
1346 ],
1347 "enumDescriptions": [
1348 "Unknown specialization",
1349 "AdWords Search specialization",
1350 "AdWords Display specialization",
1351 "AdWords Mobile specialization",
1352 "AdWords Video specialization",
1353 "AdWords Shopping specialization"
1354 ],
1355 "type": "string"
1356 }
1357 },
1358 "type": "object"
1359 },
1360 "Certification": {
1361 "description": "A user's information on a specific certification.",
1362 "id": "Certification",
1363 "properties": {
1364 "warning": {
1365 "description": "Whether this certification is in the state o f warning.",
1366 "type": "boolean"
1367 },
1368 "expiration": {
1369 "description": "Date this certification is due to expire.",
1370 "format": "google-datetime",
1371 "type": "string"
1372 },
1373 "achieved": {
1374 "description": "Whether this certification has been achieved .",
1375 "type": "boolean"
1376 },
1377 "certificationType": {
1378 "description": "The type of certification, the area of exper tise.",
1379 "enum": [
1380 "CERTIFICATION_TYPE_UNSPECIFIED",
1381 "CT_ADWORDS",
1382 "CT_YOUTUBE",
1383 "CT_VIDEOADS",
1384 "CT_ANALYTICS",
1385 "CT_DOUBLECLICK",
1386 "CT_SHOPPING",
1387 "CT_MOBILE",
1388 "CT_DIGITAL_SALES",
1389 "CT_ADWORDS_SEARCH",
1390 "CT_ADWORDS_DISPLAY",
1391 "CT_MOBILE_SITES"
1392 ],
1431 "enumDescriptions": [ 1393 "enumDescriptions": [
1432 "Unchosen.", 1394 "Unchosen.",
1433 "User must pass <a href=\"https://www.google.com/recaptc ha/\">reCaptcha</a> to\ncontact a Partner via Google Partner Search." 1395 "AdWords certified.",
1396 "YouTube certified.",
1397 "VideoAds certified.",
1398 "Analytics certified.",
1399 "DoubleClick certified.",
1400 "Shopping certified.",
1401 "Mobile certified.",
1402 "Digital sales certified.",
1403 "AdWords Search certified.",
1404 "AdWords Display certified.",
1405 "Mobile Sites certified."
1406 ],
1407 "type": "string"
1408 },
1409 "lastAchieved": {
1410 "description": "The date the user last achieved certificatio n.",
1411 "format": "google-datetime",
1412 "type": "string"
1413 }
1414 },
1415 "type": "object"
1416 },
1417 "User": {
1418 "description": "A resource representing a user of the Partners platf orm.",
1419 "id": "User",
1420 "properties": {
1421 "examStatus": {
1422 "description": "The list of exams the user ever taken. For e ach type of exam, only one\nentry is listed.",
1423 "items": {
1424 "$ref": "ExamStatus"
1425 },
1426 "type": "array"
1427 },
1428 "id": {
1429 "description": "The ID of the user.",
1430 "type": "string"
1431 },
1432 "publicProfile": {
1433 "$ref": "PublicProfile",
1434 "description": "Information about a user's external public p rofile outside Google Partners."
1435 },
1436 "companyVerificationEmail": {
1437 "description": "The email address used by the user used for company verification.\n@OutputOnly",
1438 "type": "string"
1439 },
1440 "certificationStatus": {
1441 "description": "The list of achieved certifications. These a re calculated based on exam\nresults and other requirements.\n@OutputOnly",
1442 "items": {
1443 "$ref": "Certification"
1444 },
1445 "type": "array"
1446 },
1447 "company": {
1448 "$ref": "CompanyRelation",
1449 "description": "The company that the user is associated with .\nIf not present, the user is not associated with any company."
1450 },
1451 "profile": {
1452 "$ref": "UserProfile",
1453 "description": "The profile information of a Partners user, contains all the directly\neditable user information."
1454 },
1455 "lastAccessTime": {
1456 "description": "The most recent time the user interacted wit h the Partners site.\n@OutputOnly",
1457 "format": "google-datetime",
1458 "type": "string"
1459 },
1460 "primaryEmails": {
1461 "description": "The list of emails the user has access to/ca n select as primary.\n@OutputOnly",
1462 "items": {
1463 "type": "string"
1464 },
1465 "type": "array"
1466 },
1467 "availableAdwordsManagerAccounts": {
1468 "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal acco unt is needed. Can\nbe empty meaning the user has access to no accounts.\n@Outpu tOnly",
1469 "items": {
1470 "$ref": "AdWordsManagerAccountInfo"
1471 },
1472 "type": "array"
1473 },
1474 "internalId": {
1475 "description": "The internal user ID.\nOnly available for a whitelisted set of api clients.",
1476 "type": "string"
1477 }
1478 },
1479 "type": "object"
1480 },
1481 "ListAnalyticsResponse": {
1482 "description": "Response message for\nListAnalytics.",
1483 "id": "ListAnalyticsResponse",
1484 "properties": {
1485 "nextPageToken": {
1486 "description": "A token to retrieve next page of results.\nP ass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results.",
1487 "type": "string"
1488 },
1489 "analyticsSummary": {
1490 "$ref": "AnalyticsSummary",
1491 "description": "Aggregated information across the response's \nanalytics."
1492 },
1493 "responseMetadata": {
1494 "$ref": "ResponseMetadata",
1495 "description": "Current response metadata."
1496 },
1497 "analytics": {
1498 "description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date.",
1499 "items": {
1500 "$ref": "Analytics"
1501 },
1502 "type": "array"
1503 }
1504 },
1505 "type": "object"
1506 },
1507 "ListLeadsResponse": {
1508 "description": "Response message for ListLeads.",
1509 "id": "ListLeadsResponse",
1510 "properties": {
1511 "nextPageToken": {
1512 "description": "A token to retrieve next page of results.\nP ass this value in the `ListLeadsRequest.page_token` field in the\nsubsequent cal l to\nListLeads to retrieve the\nnext page of results.",
1513 "type": "string"
1514 },
1515 "totalSize": {
1516 "description": "The total count of leads for the given compa ny.",
1517 "format": "int32",
1518 "type": "integer"
1519 },
1520 "responseMetadata": {
1521 "$ref": "ResponseMetadata",
1522 "description": "Current response metadata."
1523 },
1524 "leads": {
1525 "description": "The list of leads.",
1526 "items": {
1527 "$ref": "Lead"
1528 },
1529 "type": "array"
1530 }
1531 },
1532 "type": "object"
1533 },
1534 "Company": {
1535 "description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.",
1536 "id": "Company",
1537 "properties": {
1538 "convertedMinMonthlyBudget": {
1539 "$ref": "Money",
1540 "description": "The minimum monthly budget that the company accepts for partner business,\nconverted to the requested currency code."
1541 },
1542 "industries": {
1543 "description": "Industries the company can help with.",
1544 "enumDescriptions": [
1545 "Unchosen.",
1546 "The automotive industry.",
1547 "The business-to-business industry.",
1548 "The consumer packaged goods industry.",
1549 "The education industry.",
1550 "The finance industry.",
1551 "The healthcare industry.",
1552 "The media and entertainment industry.",
1553 "The retail industry.",
1554 "The technology industry.",
1555 "The travel industry."
1434 ], 1556 ],
1435 "items": { 1557 "items": {
1436 "enum": [ 1558 "enum": [
1437 "USER_STATE_UNSPECIFIED", 1559 "INDUSTRY_UNSPECIFIED",
1438 "US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT" 1560 "I_AUTOMOTIVE",
1561 "I_BUSINESS_TO_BUSINESS",
1562 "I_CONSUMER_PACKAGED_GOODS",
1563 "I_EDUCATION",
1564 "I_FINANCE",
1565 "I_HEALTHCARE",
1566 "I_MEDIA_AND_ENTERTAINMENT",
1567 "I_RETAIL",
1568 "I_TECHNOLOGY",
1569 "I_TRAVEL"
1439 ], 1570 ],
1440 "type": "string" 1571 "type": "string"
1441 }, 1572 },
1442 "type": "array" 1573 "type": "array"
1443 } 1574 },
1444 }, 1575 "additionalWebsites": {
1445 "type": "object" 1576 "description": "URL of the company's additional websites use d to verify the dynamic badges.\nThese are stored as full URLs as entered by the user, but only the TLD will\nbe used for the actual verification.",
1446 }, 1577 "items": {
1447 "CompanyRelation": { 1578 "type": "string"
1448 "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.", 1579 },
1449 "id": "CompanyRelation", 1580 "type": "array"
1450 "properties": { 1581 },
1451 "internalCompanyId": { 1582 "websiteUrl": {
1452 "description": "The internal company ID.\nOnly available for a whitelisted set of api clients.", 1583 "description": "URL of the company's website.",
1453 "type": "string" 1584 "type": "string"
1585 },
1586 "primaryAdwordsManagerAccountId": {
1587 "description": "The Primary AdWords Manager Account id.",
1588 "format": "int64",
1589 "type": "string"
1590 },
1591 "name": {
1592 "description": "The name of the company.",
1593 "type": "string"
1594 },
1595 "localizedInfos": {
1596 "description": "The list of localized info for the company." ,
1597 "items": {
1598 "$ref": "LocalizedCompanyInfo"
1599 },
1600 "type": "array"
1601 },
1602 "certificationStatuses": {
1603 "description": "The list of Google Partners certification st atuses for the company.",
1604 "items": {
1605 "$ref": "CertificationStatus"
1606 },
1607 "type": "array"
1608 },
1609 "id": {
1610 "description": "The ID of the company.",
1611 "type": "string"
1612 },
1613 "publicProfile": {
1614 "$ref": "PublicProfile",
1615 "description": "Basic information from the company's public profile."
1616 },
1617 "primaryLocation": {
1618 "$ref": "Location",
1619 "description": "The primary location of the company."
1620 },
1621 "services": {
1622 "description": "Services the company can help with.",
1623 "enumDescriptions": [
1624 "Unchosen.",
1625 "Help with advanced AdWords support.",
1626 "Help with advertising on Google.",
1627 "Help with an enhanced website.",
1628 "Help with an online marketing plan.",
1629 "Help with mobile and video ads.",
1630 "Help with mobile websites."
1631 ],
1632 "items": {
1633 "enum": [
1634 "SERVICE_UNSPECIFIED",
1635 "S_ADVANCED_ADWORDS_SUPPORT",
1636 "S_ADVERTISING_ON_GOOGLE",
1637 "S_AN_ENHANCED_WEBSITE",
1638 "S_AN_ONLINE_MARKETING_PLAN",
1639 "S_MOBILE_AND_VIDEO_ADS",
1640 "S_MOBILE_WEBSITE_SERVICES"
1641 ],
1642 "type": "string"
1643 },
1644 "type": "array"
1645 },
1646 "originalMinMonthlyBudget": {
1647 "$ref": "Money",
1648 "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness."
1649 },
1650 "ranks": {
1651 "description": "Information related to the ranking of the co mpany within the list of\ncompanies.",
1652 "items": {
1653 "$ref": "Rank"
1654 },
1655 "type": "array"
1454 }, 1656 },
1455 "specializationStatus": { 1657 "specializationStatus": {
1456 "description": "The list of Google Partners specialization s tatuses for the company.", 1658 "description": "The list of Google Partners specialization s tatuses for the company.",
1457 "items": { 1659 "items": {
1458 "$ref": "SpecializationStatus" 1660 "$ref": "SpecializationStatus"
1459 }, 1661 },
1460 "type": "array" 1662 "type": "array"
1461 }, 1663 },
1462 "badgeTier": { 1664 "badgeTier": {
1463 "description": "Whether the company is a Partner.", 1665 "description": "Partner badge tier",
1464 "enum": [ 1666 "enum": [
1465 "BADGE_TIER_NONE", 1667 "BADGE_TIER_NONE",
1466 "BADGE_TIER_REGULAR", 1668 "BADGE_TIER_REGULAR",
1467 "BADGE_TIER_PREMIER" 1669 "BADGE_TIER_PREMIER"
1468 ], 1670 ],
1469 "enumDescriptions": [ 1671 "enumDescriptions": [
1470 "Tier badge is not set.", 1672 "Tier badge is not set.",
1471 "Agency has regular partner badge.", 1673 "Agency has regular partner badge.",
1472 "Agency has premier badge." 1674 "Agency has premier badge."
1473 ], 1675 ],
1474 "type": "string" 1676 "type": "string"
1475 }, 1677 },
1476 "website": { 1678 "autoApprovalEmailDomains": {
1477 "description": "The website URL for this company.", 1679 "description": "Email domains that allow users with a matchi ng email address to get\nauto-approved for associating with this company.",
1478 "type": "string" 1680 "items": {
1479 }, 1681 "type": "string"
1480 "phoneNumber": { 1682 },
1481 "description": "The phone number for the company's primary a ddress.", 1683 "type": "array"
1482 "type": "string" 1684 },
1483 }, 1685 "companyTypes": {
1484 "primaryCountryCode": { 1686 "description": "Company type labels listed on the company's profile.",
1485 "description": "The primary country code of the company.", 1687 "enumDescriptions": [
1486 "type": "string" 1688 "Unchosen.",
1487 }, 1689 "Handles all aspects of the advertising process.",
1488 "companyId": { 1690 "Focuses solely on an advertiser's media placement.",
1489 "description": "The ID of the company. There may be no id if this is a\npending company.5", 1691 "Plans/executes advertising campaigns.",
1692 "Like a\nFULL_SERVICE_AGENCY,\nbut specializing in digit al.",
1693 "Increases visibility in search engine result pages.",
1694 "Drives promotional efforts for immediate impact.",
1695 "Focuses on bid management, conversion, reporting.",
1696 "Establishes favorable relationship with public through low/no-cost\ncommunications.",
1697 "Does not manage other company's accounts, manages own m arketing programs.",
1698 "Full-service AdWords account management for local busin esses."
1699 ],
1700 "items": {
1701 "enum": [
1702 "COMPANY_TYPE_UNSPECIFIED",
1703 "FULL_SERVICE_AGENCY",
1704 "MEDIA_AGENCY",
1705 "CREATIVE_AGENCY",
1706 "CDIGITAL_AGENCY",
1707 "SEM_SEO",
1708 "PERFORMANCE_MARKETING",
1709 "ADVERTISING_TOOL_DEVELOPMENT",
1710 "PR",
1711 "SELF_MANAGED",
1712 "RESELLER"
1713 ],
1714 "type": "string"
1715 },
1716 "type": "array"
1717 },
1718 "profileStatus": {
1719 "description": "The public viewability status of the company 's profile.",
1720 "enum": [
1721 "COMPANY_PROFILE_STATUS_UNSPECIFIED",
1722 "HIDDEN",
1723 "PUBLISHED",
1724 "SEARCHABLE"
1725 ],
1726 "enumDescriptions": [
1727 "Unchosen.",
1728 "Company profile does not show up publicly.",
1729 "Company profile can only be viewed by the profile's URL \nand not by Google Partner Search.",
1730 "Company profile can be viewed by the profile's URL\nand by Google Partner Search."
1731 ],
1490 "type": "string" 1732 "type": "string"
1491 }, 1733 },
1492 "primaryLanguageCode": { 1734 "primaryLanguageCode": {
1493 "description": "The primary language code of the company.", 1735 "description": "The primary language code of the company, as defined by\n<a href=\"https://tools.ietf.org/html/bcp47\">BCP 47</a>\n(IETF BCP 47, \"Tags for Identifying Languages\").",
1494 "type": "string" 1736 "type": "string"
1495 }, 1737 },
1496 "logoUrl": { 1738 "locations": {
1497 "description": "A URL to a profile photo, e.g. a G+ profile photo.", 1739 "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.",
1498 "type": "string" 1740 "items": {
1499 }, 1741 "$ref": "Location"
1500 "resolvedTimestamp": { 1742 },
1501 "description": "The timestamp when the user was approved.\n@ OutputOnly", 1743 "type": "array"
1502 "format": "google-datetime", 1744 }
1503 "type": "string" 1745 },
1504 }, 1746 "type": "object"
1505 "companyAdmin": { 1747 },
1506 "description": "Indicates if the user is an admin for this c ompany.", 1748 "CreateLeadResponse": {
1507 "type": "boolean" 1749 "description": "Response message for CreateLead.",
1508 }, 1750 "id": "CreateLeadResponse",
1509 "address": { 1751 "properties": {
1510 "description": "The primary address for this company.", 1752 "recaptchaStatus": {
1511 "type": "string" 1753 "description": "The outcome of <a href=\"https://www.google. com/recaptcha/\">reCaptcha</a>\nvalidation.",
1512 },
1513 "isPending": {
1514 "description": "The flag that indicates if the company is pe nding verification.",
1515 "type": "boolean"
1516 },
1517 "creationTime": {
1518 "description": "The timestamp of when affiliation was reques ted.\n@OutputOnly",
1519 "format": "google-datetime",
1520 "type": "string"
1521 },
1522 "primaryAddress": {
1523 "$ref": "Location",
1524 "description": "The primary location of the company."
1525 },
1526 "state": {
1527 "description": "The state of relationship, in terms of appro vals.",
1528 "enum": [ 1754 "enum": [
1529 "USER_COMPANY_REATION_STATE_NONE_SPECIFIED", 1755 "RECAPTCHA_STATUS_UNSPECIFIED",
1530 "USER_COMPANY_RELATION_STATE_AWAIT_EMAIL", 1756 "RS_NOT_NEEDED",
1531 "USER_COMPANY_RELATION_STATE_AWAIT_ADMIN", 1757 "RS_PASSED",
1532 "USER_COMPANY_RELATION_STATE_APPROVED" 1758 "RS_FAILED"
1533 ], 1759 ],
1534 "enumDescriptions": [ 1760 "enumDescriptions": [
1535 "Default unspecified value.", 1761 "Unchosen.",
1536 "User has filled in a request to be associated with an c ompany.\nNow waiting email confirmation.", 1762 "No reCaptcha validation needed.",
1537 "Pending approval from company.\nEmail confirmation will not approve this one.", 1763 "reCaptcha challenge passed.",
1538 "Approved by company." 1764 "reCaptcha challenge failed."
1539 ], 1765 ],
1540 "type": "string" 1766 "type": "string"
1541 },
1542 "managerAccount": {
1543 "description": "The AdWords manager account # associated thi s company.",
1544 "format": "int64",
1545 "type": "string"
1546 },
1547 "name": {
1548 "description": "The name (in the company's primary language) for the company.",
1549 "type": "string"
1550 },
1551 "segment": {
1552 "description": "The segment the company is classified as.",
1553 "enumDescriptions": [
1554 "Default segment indicates an unknown.",
1555 "Segment representing a selected group of Partners",
1556 "Segment representing Premier SMB Partners, an AdWords p artnership program.",
1557 "A segment of Premier SMB Partners that have relationshi p with Google."
1558 ],
1559 "items": {
1560 "enum": [
1561 "COMPANY_SEGMENT_UNKNOWN",
1562 "COMPANY_SEGMENT_NAL",
1563 "COMPANY_SEGMENT_PSP",
1564 "COMPANY_SEGMENT_PPSP"
1565 ],
1566 "type": "string"
1567 },
1568 "type": "array"
1569 }
1570 },
1571 "type": "object"
1572 },
1573 "Date": {
1574 "description": "Represents a whole calendar date, e.g. date of birth . The time of day and\ntime zone are either specified elsewhere or are not signi ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b e 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independe nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
1575 "id": "Date",
1576 "properties": {
1577 "month": {
1578 "description": "Month of year. Must be from 1 to 12.",
1579 "format": "int32",
1580 "type": "integer"
1581 },
1582 "day": {
1583 "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not s ignificant.",
1584 "format": "int32",
1585 "type": "integer"
1586 },
1587 "year": {
1588 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without\na year.",
1589 "format": "int32",
1590 "type": "integer"
1591 }
1592 },
1593 "type": "object"
1594 },
1595 "Empty": {
1596 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
1597 "id": "Empty",
1598 "properties": {},
1599 "type": "object"
1600 },
1601 "TrafficSource": {
1602 "description": "Source of traffic for the current request.",
1603 "id": "TrafficSource",
1604 "properties": {
1605 "trafficSubId": {
1606 "description": "Second level identifier to indicate where th e traffic comes from.\nAn identifier has multiple letters created by a team whic h redirected the\ntraffic to us.",
1607 "type": "string"
1608 },
1609 "trafficSourceId": {
1610 "description": "Identifier to indicate where the traffic com es from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
1611 "type": "string"
1612 }
1613 },
1614 "type": "object"
1615 },
1616 "CreateLeadRequest": {
1617 "description": "Request message for CreateLead.",
1618 "id": "CreateLeadRequest",
1619 "properties": {
1620 "recaptchaChallenge": {
1621 "$ref": "RecaptchaChallenge",
1622 "description": "<a href=\"https://www.google.com/recaptcha/\ ">reCaptcha</a> challenge info."
1623 }, 1767 },
1624 "lead": { 1768 "lead": {
1625 "$ref": "Lead", 1769 "$ref": "Lead",
1626 "description": "The lead resource. The `LeadType` must not b e `LEAD_TYPE_UNSPECIFIED`\nand either `email` or `phone_number` must be provided ." 1770 "description": "Lead that was created depending on the outco me of\n<a href=\"https://www.google.com/recaptcha/\">reCaptcha</a> validation."
1627 }, 1771 },
1628 "requestMetadata": { 1772 "responseMetadata": {
1629 "$ref": "RequestMetadata", 1773 "$ref": "ResponseMetadata",
1630 "description": "Current request metadata." 1774 "description": "Current response metadata."
1631 } 1775 }
1632 }, 1776 },
1633 "type": "object" 1777 "type": "object"
1634 }, 1778 },
1635 "RequestMetadata": { 1779 "GetCompanyResponse": {
1636 "description": "Common data that is in each API request.", 1780 "description": "Response message for GetCompany.",
1637 "id": "RequestMetadata", 1781 "id": "GetCompanyResponse",
1638 "properties": { 1782 "properties": {
1639 "locale": { 1783 "company": {
1640 "description": "Locale to use for the current request.", 1784 "$ref": "Company",
1641 "type": "string" 1785 "description": "The company."
1642 }, 1786 },
1643 "partnersSessionId": { 1787 "responseMetadata": {
1644 "description": "Google Partners session ID.", 1788 "$ref": "ResponseMetadata",
1645 "type": "string" 1789 "description": "Current response metadata."
1646 }, 1790 }
1647 "userOverrides": { 1791 },
1648 "$ref": "UserOverrides", 1792 "type": "object"
1649 "description": "Values to use instead of the user's respecti ve defaults for the current\nrequest. These are only honored by whitelisted prod ucts." 1793 },
1650 }, 1794 "Location": {
1651 "trafficSource": { 1795 "description": "A location with address and geographic coordinates. May optionally contain a\ndetailed (multi-field) version of the address.",
1652 "$ref": "TrafficSource", 1796 "id": "Location",
1653 "description": "Source of traffic for the current request." 1797 "properties": {
1654 }, 1798 "administrativeArea": {
1655 "experimentIds": { 1799 "description": "Top-level administrative subdivision of this country.",
1656 "description": "Experiment IDs the current request belongs t o.", 1800 "type": "string"
1657 "items": { 1801 },
1658 "type": "string" 1802 "locality": {
1659 }, 1803 "description": "Generally refers to the city/town portion of an address.",
1804 "type": "string"
1805 },
1806 "latLng": {
1807 "$ref": "LatLng",
1808 "description": "The latitude and longitude of the location, in degrees."
1809 },
1810 "address": {
1811 "description": "The single string version of the address.",
1812 "type": "string"
1813 },
1814 "dependentLocality": {
1815 "description": "Dependent locality or sublocality. Used for UK dependent localities, or\nneighborhoods or boroughs in other locations.",
1816 "type": "string"
1817 },
1818 "regionCode": {
1819 "description": "CLDR (Common Locale Data Repository) region code .",
1820 "type": "string"
1821 },
1822 "postalCode": {
1823 "description": "Values are frequently alphanumeric.",
1824 "type": "string"
1825 },
1826 "languageCode": {
1827 "description": "Language code of the address. Should be in B CP 47 format.",
1828 "type": "string"
1829 },
1830 "sortingCode": {
1831 "description": "Use of this code is very country-specific, b ut will refer to a secondary\nclassification code for sorting mail.",
1832 "type": "string"
1833 },
1834 "addressLine": {
1835 "description": "The following address lines represent the mo st specific part of any\naddress.",
1836 "items": {
1837 "type": "string"
1838 },
1660 "type": "array" 1839 "type": "array"
1661 } 1840 }
1662 }, 1841 },
1663 "type": "object" 1842 "type": "object"
1664 }, 1843 },
1665 "EventData": { 1844 "CertificationExamStatus": {
1666 "description": "Key value data pair for an event.", 1845 "description": "Status for a Google Partners certification exam.",
1667 "id": "EventData", 1846 "id": "CertificationExamStatus",
1668 "properties": { 1847 "properties": {
1669 "key": { 1848 "type": {
1670 "description": "Data type.", 1849 "description": "The type of certification exam.",
1671 "enum": [ 1850 "enum": [
1672 "EVENT_DATA_TYPE_UNSPECIFIED", 1851 "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
1673 "ACTION", 1852 "CET_ADWORDS_FUNDAMENTALS",
1674 "AGENCY_ID", 1853 "CET_ADWORDS_ADVANCED_SEARCH",
1675 "AGENCY_NAME", 1854 "CET_ADWORDS_ADVANCED_DISPLAY",
1676 "AGENCY_PHONE_NUMBER", 1855 "CET_VIDEO_ADS",
1677 "AGENCY_WEBSITE", 1856 "CET_DOUBLECLICK",
1678 "BUDGET", 1857 "CET_ANALYTICS",
1679 "CENTER_POINT", 1858 "CET_SHOPPING",
1680 "CERTIFICATION", 1859 "CET_MOBILE",
1681 "COMMENT", 1860 "CET_DIGITAL_SALES",
1682 "COUNTRY", 1861 "CET_MOBILE_SITES"
1683 "CURRENCY",
1684 "CURRENTLY_VIEWED_AGENCY_ID",
1685 "DISTANCE",
1686 "DISTANCE_TYPE",
1687 "EXAM",
1688 "HISTORY_TOKEN",
1689 "ID",
1690 "INDUSTRY",
1691 "INSIGHT_TAG",
1692 "LANGUAGE",
1693 "LOCATION",
1694 "MARKETING_OPT_IN",
1695 "QUERY",
1696 "SEARCH_START_INDEX",
1697 "SERVICE",
1698 "SHOW_VOW",
1699 "SOLUTION",
1700 "TRAFFIC_SOURCE_ID",
1701 "TRAFFIC_SUB_ID",
1702 "VIEW_PORT",
1703 "WEBSITE",
1704 "DETAILS",
1705 "EXPERIMENT_ID",
1706 "GPS_MOTIVATION",
1707 "URL",
1708 "ELEMENT_FOCUS",
1709 "PROGRESS"
1710 ], 1862 ],
1711 "enumDescriptions": [ 1863 "enumDescriptions": [
1712 "Unchosen.", 1864 "Unchosen.",
1713 "Action data.", 1865 "Adwords Fundamentals exam.",
1714 "Agency ID data.", 1866 "AdWords advanced search exam.",
1715 "Agency name data.", 1867 "AdWords advanced display exam.",
1716 "Agency phone number data.", 1868 "VideoAds exam.",
1717 "Agency website data.", 1869 "DoubleClick exam.",
1718 "Budget data.", 1870 "Analytics exam.",
1719 "Center-point data.", 1871 "Shopping exam.",
1720 "Certification data.", 1872 "Mobile exam.",
1721 "Comment data.", 1873 "Digital Sales exam.",
1722 "Country data.", 1874 "Mobile Sites exam."
1723 "Currency data.",
1724 "Currently viewed agency ID data.",
1725 "Distance data.",
1726 "Distance type data.",
1727 "Exam data.",
1728 "History token data.",
1729 "Identifier data.",
1730 "Industry data.",
1731 "Insight tag data.",
1732 "Language data.",
1733 "Location data.",
1734 "Marketing opt-in data.",
1735 "Query data.",
1736 "Search start index data.",
1737 "Service data.",
1738 "Show vow data.",
1739 "Solution data.",
1740 "Traffic source ID data.",
1741 "Traffic sub ID data.",
1742 "Viewport data.",
1743 "Website data.",
1744 "Details data.",
1745 "Experiment ID data.",
1746 "Google Partner Search motivation data.",
1747 "URL data.",
1748 "Element we wanted user to focus on.",
1749 "Progress when viewing an item \\[0-100\\]."
1750 ], 1875 ],
1751 "type": "string" 1876 "type": "string"
1752 }, 1877 },
1753 "values": { 1878 "numberUsersPass": {
1754 "description": "Data values.", 1879 "description": "The number of people who have passed the cer tification exam.",
1755 "items": { 1880 "format": "int32",
1756 "type": "string" 1881 "type": "integer"
1757 },
1758 "type": "array"
1759 } 1882 }
1760 }, 1883 },
1761 "type": "object" 1884 "type": "object"
1762 }, 1885 },
1763 "ExamStatus": { 1886 "ExamToken": {
1764 "description": "A user's information on a specific exam.", 1887 "description": "A token that allows a user to take an exam.",
1765 "id": "ExamStatus", 1888 "id": "ExamToken",
1766 "properties": { 1889 "properties": {
1767 "passed": {
1768 "description": "Whether this exam has been passed and not ex pired.",
1769 "type": "boolean"
1770 },
1771 "taken": {
1772 "description": "The date the user last taken this exam.",
1773 "format": "google-datetime",
1774 "type": "string"
1775 },
1776 "warning": {
1777 "description": "Whether this exam is in the state of warning .",
1778 "type": "boolean"
1779 },
1780 "expiration": {
1781 "description": "Date this exam is due to expire.",
1782 "format": "google-datetime",
1783 "type": "string"
1784 },
1785 "lastPassed": {
1786 "description": "The date the user last passed this exam.",
1787 "format": "google-datetime",
1788 "type": "string"
1789 },
1790 "examType": { 1890 "examType": {
1791 "description": "The type of the exam.", 1891 "description": "The type of the exam the token belongs to.",
1792 "enum": [ 1892 "enum": [
1793 "CERTIFICATION_EXAM_TYPE_UNSPECIFIED", 1893 "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
1794 "CET_ADWORDS_FUNDAMENTALS", 1894 "CET_ADWORDS_FUNDAMENTALS",
1795 "CET_ADWORDS_ADVANCED_SEARCH", 1895 "CET_ADWORDS_ADVANCED_SEARCH",
1796 "CET_ADWORDS_ADVANCED_DISPLAY", 1896 "CET_ADWORDS_ADVANCED_DISPLAY",
1797 "CET_VIDEO_ADS", 1897 "CET_VIDEO_ADS",
1798 "CET_DOUBLECLICK", 1898 "CET_DOUBLECLICK",
1799 "CET_ANALYTICS", 1899 "CET_ANALYTICS",
1800 "CET_SHOPPING", 1900 "CET_SHOPPING",
1801 "CET_MOBILE", 1901 "CET_MOBILE",
1802 "CET_DIGITAL_SALES", 1902 "CET_DIGITAL_SALES",
1803 "CET_MOBILE_SITES" 1903 "CET_MOBILE_SITES"
1804 ], 1904 ],
1805 "enumDescriptions": [ 1905 "enumDescriptions": [
1806 "Unchosen.", 1906 "Unchosen.",
1807 "Adwords Fundamentals exam.", 1907 "Adwords Fundamentals exam.",
1808 "AdWords advanced search exam.", 1908 "AdWords advanced search exam.",
1809 "AdWords advanced display exam.", 1909 "AdWords advanced display exam.",
1810 "VideoAds exam.", 1910 "VideoAds exam.",
1811 "DoubleClick exam.", 1911 "DoubleClick exam.",
1812 "Analytics exam.", 1912 "Analytics exam.",
1813 "Shopping exam.", 1913 "Shopping exam.",
1814 "Mobile exam.", 1914 "Mobile exam.",
1815 "Digital Sales exam.", 1915 "Digital Sales exam.",
1816 "Mobile Sites exam." 1916 "Mobile Sites exam."
1817 ], 1917 ],
1818 "type": "string" 1918 "type": "string"
1819 } 1919 },
1820 },
1821 "type": "object"
1822 },
1823 "ListOffersResponse": {
1824 "description": "Response for ListOffer.",
1825 "id": "ListOffersResponse",
1826 "properties": {
1827 "noOfferReason": {
1828 "description": "Reason why no Offers are available.",
1829 "enum": [
1830 "NO_OFFER_REASON_UNSPECIFIED",
1831 "NO_OFFER_REASON_NO_MCC",
1832 "NO_OFFER_REASON_LIMIT_REACHED",
1833 "NO_OFFER_REASON_INELIGIBLE"
1834 ],
1835 "enumDescriptions": [
1836 "Unset.",
1837 "Not an MCC.",
1838 "Offer limit has been reached.",
1839 "Ineligible for offers."
1840 ],
1841 "type": "string"
1842 },
1843 "availableOffers": {
1844 "description": "Available Offers to be distributed.",
1845 "items": {
1846 "$ref": "AvailableOffer"
1847 },
1848 "type": "array"
1849 },
1850 "responseMetadata": {
1851 "$ref": "ResponseMetadata",
1852 "description": "Current response metadata."
1853 }
1854 },
1855 "type": "object"
1856 },
1857 "CountryOfferInfo": {
1858 "description": "Offer info by country.",
1859 "id": "CountryOfferInfo",
1860 "properties": {
1861 "spendXAmount": {
1862 "description": "(localized) Spend X amount for that country' s offer.",
1863 "type": "string"
1864 },
1865 "offerCountryCode": {
1866 "description": "Country code for which offer codes may be re quested.",
1867 "type": "string"
1868 },
1869 "offerType": {
1870 "description": "Type of offer country is eligible for.",
1871 "enum": [
1872 "OFFER_TYPE_UNSPECIFIED",
1873 "OFFER_TYPE_SPEND_X_GET_Y",
1874 "OFFER_TYPE_VIDEO",
1875 "OFFER_TYPE_SPEND_MATCH"
1876 ],
1877 "enumDescriptions": [
1878 "Unset.",
1879 "AdWords spend X get Y.",
1880 "Youtube video.",
1881 "Spend Match up to Y."
1882 ],
1883 "type": "string"
1884 },
1885 "getYAmount": {
1886 "description": "(localized) Get Y amount for that country's offer.",
1887 "type": "string"
1888 }
1889 },
1890 "type": "object"
1891 },
1892 "ListCompaniesResponse": {
1893 "description": "Response message for\nListCompanies.",
1894 "id": "ListCompaniesResponse",
1895 "properties": {
1896 "nextPageToken": {
1897 "description": "A token to retrieve next page of results.\nP ass this value in the `ListCompaniesRequest.page_token` field in the\nsubsequent call to\nListCompanies to retrieve the\nnext page of results.",
1898 "type": "string"
1899 },
1900 "responseMetadata": {
1901 "$ref": "ResponseMetadata",
1902 "description": "Current response metadata."
1903 },
1904 "companies": {
1905 "description": "The list of companies.",
1906 "items": {
1907 "$ref": "Company"
1908 },
1909 "type": "array"
1910 }
1911 },
1912 "type": "object"
1913 },
1914 "OfferCustomer": {
1915 "description": "Customers qualified for an offer.",
1916 "id": "OfferCustomer",
1917 "properties": {
1918 "spendXAmount": {
1919 "description": "Formatted Spend X amount with currency code. ",
1920 "type": "string"
1921 },
1922 "adwordsUrl": {
1923 "description": "URL to the customer's AdWords page.",
1924 "type": "string"
1925 },
1926 "creationTime": {
1927 "description": "Time the customer was created.",
1928 "format": "google-datetime",
1929 "type": "string"
1930 },
1931 "countryCode": {
1932 "description": "Country code of the customer.",
1933 "type": "string"
1934 },
1935 "eligibilityDaysLeft": {
1936 "description": "Days the customer is still eligible.",
1937 "format": "int32",
1938 "type": "integer"
1939 },
1940 "offerType": {
1941 "description": "Type of the offer",
1942 "enum": [
1943 "OFFER_TYPE_UNSPECIFIED",
1944 "OFFER_TYPE_SPEND_X_GET_Y",
1945 "OFFER_TYPE_VIDEO",
1946 "OFFER_TYPE_SPEND_MATCH"
1947 ],
1948 "enumDescriptions": [
1949 "Unset.",
1950 "AdWords spend X get Y.",
1951 "Youtube video.",
1952 "Spend Match up to Y."
1953 ],
1954 "type": "string"
1955 },
1956 "externalCid": {
1957 "description": "External CID for the customer.",
1958 "format": "int64",
1959 "type": "string"
1960 },
1961 "getYAmount": {
1962 "description": "Formatted Get Y amount with currency code.",
1963 "type": "string"
1964 },
1965 "name": {
1966 "description": "Name of the customer.",
1967 "type": "string"
1968 }
1969 },
1970 "type": "object"
1971 },
1972 "CertificationStatus": {
1973 "description": "Google Partners certification status.",
1974 "id": "CertificationStatus",
1975 "properties": {
1976 "type": {
1977 "description": "The type of the certification.",
1978 "enum": [
1979 "CERTIFICATION_TYPE_UNSPECIFIED",
1980 "CT_ADWORDS",
1981 "CT_YOUTUBE",
1982 "CT_VIDEOADS",
1983 "CT_ANALYTICS",
1984 "CT_DOUBLECLICK",
1985 "CT_SHOPPING",
1986 "CT_MOBILE",
1987 "CT_DIGITAL_SALES",
1988 "CT_ADWORDS_SEARCH",
1989 "CT_ADWORDS_DISPLAY",
1990 "CT_MOBILE_SITES"
1991 ],
1992 "enumDescriptions": [
1993 "Unchosen.",
1994 "AdWords certified.",
1995 "YouTube certified.",
1996 "VideoAds certified.",
1997 "Analytics certified.",
1998 "DoubleClick certified.",
1999 "Shopping certified.",
2000 "Mobile certified.",
2001 "Digital sales certified.",
2002 "AdWords Search certified.",
2003 "AdWords Display certified.",
2004 "Mobile Sites certified."
2005 ],
2006 "type": "string"
2007 },
2008 "userCount": {
2009 "description": "Number of people who are certified,",
2010 "format": "int32",
2011 "type": "integer"
2012 },
2013 "isCertified": {
2014 "description": "Whether certification is passing.",
2015 "type": "boolean"
2016 },
2017 "examStatuses": {
2018 "description": "List of certification exam statuses.",
2019 "items": {
2020 "$ref": "CertificationExamStatus"
2021 },
2022 "type": "array"
2023 }
2024 },
2025 "type": "object"
2026 },
2027 "LocalizedCompanyInfo": {
2028 "description": "The localized company information.",
2029 "id": "LocalizedCompanyInfo",
2030 "properties": {
2031 "countryCodes": {
2032 "description": "List of country codes for the localized comp any info.",
2033 "items": {
2034 "type": "string"
2035 },
2036 "type": "array"
2037 },
2038 "overview": {
2039 "description": "Localized brief description that the company uses to advertise themselves.",
2040 "type": "string"
2041 },
2042 "displayName": {
2043 "description": "Localized display name.",
2044 "type": "string"
2045 },
2046 "languageCode": {
2047 "description": "Language code of the localized company info, as defined by\n<a href=\"https://tools.ietf.org/html/bcp47\">BCP 47</a>\n(IETF BCP 47, \"Tags for Identifying Languages\").",
2048 "type": "string"
2049 }
2050 },
2051 "type": "object"
2052 },
2053 "LogUserEventResponse": {
2054 "description": "Response message for\nLogUserEvent.",
2055 "id": "LogUserEventResponse",
2056 "properties": {
2057 "responseMetadata": {
2058 "$ref": "ResponseMetadata",
2059 "description": "Current response metadata."
2060 }
2061 },
2062 "type": "object"
2063 },
2064 "ListOffersHistoryResponse": {
2065 "description": "Response for ListOfferHistory.",
2066 "id": "ListOffersHistoryResponse",
2067 "properties": {
2068 "showingEntireCompany": {
2069 "description": "True if this response is showing entire comp any history.",
2070 "type": "boolean"
2071 },
2072 "offers": {
2073 "description": "Historical offers meeting request.",
2074 "items": {
2075 "$ref": "HistoricalOffer"
2076 },
2077 "type": "array"
2078 },
2079 "nextPageToken": {
2080 "description": "Supply this token in a ListOffersHistoryRequ est to retrieve the next page.",
2081 "type": "string"
2082 },
2083 "responseMetadata": {
2084 "$ref": "ResponseMetadata",
2085 "description": "Current response metadata."
2086 },
2087 "canShowEntireCompany": {
2088 "description": "True if the user has the option to show enti re company history.",
2089 "type": "boolean"
2090 },
2091 "totalResults": {
2092 "description": "Number of results across all pages.",
2093 "format": "int32",
2094 "type": "integer"
2095 }
2096 },
2097 "type": "object"
2098 },
2099 "LogMessageResponse": {
2100 "description": "Response message for\nLogClientMessage.",
2101 "id": "LogMessageResponse",
2102 "properties": {
2103 "responseMetadata": {
2104 "$ref": "ResponseMetadata",
2105 "description": "Current response metadata."
2106 }
2107 },
2108 "type": "object"
2109 },
2110 "SpecializationStatus": {
2111 "description": "Agency specialization status",
2112 "id": "SpecializationStatus",
2113 "properties": {
2114 "badgeSpecialization": {
2115 "description": "The specialization this status is for.",
2116 "enum": [
2117 "BADGE_SPECIALIZATION_UNKNOWN",
2118 "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
2119 "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
2120 "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
2121 "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
2122 "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
2123 ],
2124 "enumDescriptions": [
2125 "Unknown specialization",
2126 "AdWords Search specialization",
2127 "AdWords Display specialization",
2128 "AdWords Mobile specialization",
2129 "AdWords Video specialization",
2130 "AdWords Shopping specialization"
2131 ],
2132 "type": "string"
2133 },
2134 "badgeSpecializationState": {
2135 "description": "State of agency specialization.",
2136 "enum": [
2137 "BADGE_SPECIALIZATION_STATE_UNKNOWN",
2138 "BADGE_SPECIALIZATION_STATE_PASSED",
2139 "BADGE_SPECIALIZATION_STATE_NOT_PASSED",
2140 "BADGE_SPECIALIZATION_STATE_IN_GRACE"
2141 ],
2142 "enumDescriptions": [
2143 "Unknown state",
2144 "Specialization passed",
2145 "Specialization not passed",
2146 "Specialization in grace"
2147 ],
2148 "type": "string"
2149 }
2150 },
2151 "type": "object"
2152 },
2153 "Certification": {
2154 "description": "A user's information on a specific certification.",
2155 "id": "Certification",
2156 "properties": {
2157 "certificationType": {
2158 "description": "The type of certification, the area of exper tise.",
2159 "enum": [
2160 "CERTIFICATION_TYPE_UNSPECIFIED",
2161 "CT_ADWORDS",
2162 "CT_YOUTUBE",
2163 "CT_VIDEOADS",
2164 "CT_ANALYTICS",
2165 "CT_DOUBLECLICK",
2166 "CT_SHOPPING",
2167 "CT_MOBILE",
2168 "CT_DIGITAL_SALES",
2169 "CT_ADWORDS_SEARCH",
2170 "CT_ADWORDS_DISPLAY",
2171 "CT_MOBILE_SITES"
2172 ],
2173 "enumDescriptions": [
2174 "Unchosen.",
2175 "AdWords certified.",
2176 "YouTube certified.",
2177 "VideoAds certified.",
2178 "Analytics certified.",
2179 "DoubleClick certified.",
2180 "Shopping certified.",
2181 "Mobile certified.",
2182 "Digital sales certified.",
2183 "AdWords Search certified.",
2184 "AdWords Display certified.",
2185 "Mobile Sites certified."
2186 ],
2187 "type": "string"
2188 },
2189 "lastAchieved": {
2190 "description": "The date the user last achieved certificatio n.",
2191 "format": "google-datetime",
2192 "type": "string"
2193 },
2194 "warning": {
2195 "description": "Whether this certification is in the state o f warning.",
2196 "type": "boolean"
2197 },
2198 "expiration": {
2199 "description": "Date this certification is due to expire.",
2200 "format": "google-datetime",
2201 "type": "string"
2202 },
2203 "achieved": {
2204 "description": "Whether this certification has been achieved .",
2205 "type": "boolean"
2206 }
2207 },
2208 "type": "object"
2209 },
2210 "User": {
2211 "description": "A resource representing a user of the Partners platf orm.",
2212 "id": "User",
2213 "properties": {
2214 "lastAccessTime": {
2215 "description": "The most recent time the user interacted wit h the Partners site.\n@OutputOnly",
2216 "format": "google-datetime",
2217 "type": "string"
2218 },
2219 "availableAdwordsManagerAccounts": {
2220 "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal acco unt is needed. Can\nbe empty meaning the user has access to no accounts.\n@Outpu tOnly",
2221 "items": {
2222 "$ref": "AdWordsManagerAccountInfo"
2223 },
2224 "type": "array"
2225 },
2226 "primaryEmails": {
2227 "description": "The list of emails the user has access to/ca n select as primary.\n@OutputOnly",
2228 "items": {
2229 "type": "string"
2230 },
2231 "type": "array"
2232 },
2233 "internalId": {
2234 "description": "The internal user ID.\nOnly available for a whitelisted set of api clients.",
2235 "type": "string"
2236 },
2237 "examStatus": {
2238 "description": "The list of exams the user ever taken. For e ach type of exam, only one\nentry is listed.",
2239 "items": {
2240 "$ref": "ExamStatus"
2241 },
2242 "type": "array"
2243 },
2244 "id": {
2245 "description": "The ID of the user.",
2246 "type": "string"
2247 },
2248 "publicProfile": {
2249 "$ref": "PublicProfile",
2250 "description": "Information about a user's external public p rofile outside Google Partners."
2251 },
2252 "certificationStatus": {
2253 "description": "The list of achieved certifications. These a re calculated based on exam\nresults and other requirements.\n@OutputOnly",
2254 "items": {
2255 "$ref": "Certification"
2256 },
2257 "type": "array"
2258 },
2259 "companyVerificationEmail": {
2260 "description": "The email address used by the user used for company verification.\n@OutputOnly",
2261 "type": "string"
2262 },
2263 "company": {
2264 "$ref": "CompanyRelation",
2265 "description": "The company that the user is associated with .\nIf not present, the user is not associated with any company."
2266 },
2267 "profile": {
2268 "$ref": "UserProfile",
2269 "description": "The profile information of a Partners user, contains all the directly\neditable user information."
2270 }
2271 },
2272 "type": "object"
2273 },
2274 "ListAnalyticsResponse": {
2275 "description": "Response message for\nListAnalytics.",
2276 "id": "ListAnalyticsResponse",
2277 "properties": {
2278 "analytics": {
2279 "description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date.",
2280 "items": {
2281 "$ref": "Analytics"
2282 },
2283 "type": "array"
2284 },
2285 "nextPageToken": {
2286 "description": "A token to retrieve next page of results.\nP ass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results.",
2287 "type": "string"
2288 },
2289 "analyticsSummary": {
2290 "$ref": "AnalyticsSummary",
2291 "description": "Aggregated information across the response's \nanalytics."
2292 },
2293 "responseMetadata": {
2294 "$ref": "ResponseMetadata",
2295 "description": "Current response metadata."
2296 }
2297 },
2298 "type": "object"
2299 },
2300 "Company": {
2301 "description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.",
2302 "id": "Company",
2303 "properties": {
2304 "autoApprovalEmailDomains": {
2305 "description": "Email domains that allow users with a matchi ng email address to get\nauto-approved for associating with this company.",
2306 "items": {
2307 "type": "string"
2308 },
2309 "type": "array"
2310 },
2311 "companyTypes": {
2312 "description": "Company type labels listed on the company's profile.",
2313 "enumDescriptions": [
2314 "Unchosen.",
2315 "Handles all aspects of the advertising process.",
2316 "Focuses solely on an advertiser's media placement.",
2317 "Plans/executes advertising campaigns.",
2318 "Like a\nFULL_SERVICE_AGENCY,\nbut specializing in digit al.",
2319 "Increases visibility in search engine result pages.",
2320 "Drives promotional efforts for immediate impact.",
2321 "Focuses on bid management, conversion, reporting.",
2322 "Establishes favorable relationship with public through low/no-cost\ncommunications.",
2323 "Does not manage other company's accounts, manages own m arketing programs.",
2324 "Full-service AdWords account management for local busin esses."
2325 ],
2326 "items": {
2327 "enum": [
2328 "COMPANY_TYPE_UNSPECIFIED",
2329 "FULL_SERVICE_AGENCY",
2330 "MEDIA_AGENCY",
2331 "CREATIVE_AGENCY",
2332 "CDIGITAL_AGENCY",
2333 "SEM_SEO",
2334 "PERFORMANCE_MARKETING",
2335 "ADVERTISING_TOOL_DEVELOPMENT",
2336 "PR",
2337 "SELF_MANAGED",
2338 "RESELLER"
2339 ],
2340 "type": "string"
2341 },
2342 "type": "array"
2343 },
2344 "profileStatus": {
2345 "description": "The public viewability status of the company 's profile.",
2346 "enum": [
2347 "COMPANY_PROFILE_STATUS_UNSPECIFIED",
2348 "HIDDEN",
2349 "PUBLISHED",
2350 "SEARCHABLE"
2351 ],
2352 "enumDescriptions": [
2353 "Unchosen.",
2354 "Company profile does not show up publicly.",
2355 "Company profile can only be viewed by the profile's URL \nand not by Google Partner Search.",
2356 "Company profile can be viewed by the profile's URL\nand by Google Partner Search."
2357 ],
2358 "type": "string"
2359 },
2360 "primaryLanguageCode": {
2361 "description": "The primary language code of the company, as defined by\n<a href=\"https://tools.ietf.org/html/bcp47\">BCP 47</a>\n(IETF BCP 47, \"Tags for Identifying Languages\").",
2362 "type": "string"
2363 },
2364 "locations": {
2365 "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.",
2366 "items": {
2367 "$ref": "Location"
2368 },
2369 "type": "array"
2370 },
2371 "convertedMinMonthlyBudget": {
2372 "$ref": "Money",
2373 "description": "The minimum monthly budget that the company accepts for partner business,\nconverted to the requested currency code."
2374 },
2375 "industries": {
2376 "description": "Industries the company can help with.",
2377 "enumDescriptions": [
2378 "Unchosen.",
2379 "The automotive industry.",
2380 "The business-to-business industry.",
2381 "The consumer packaged goods industry.",
2382 "The education industry.",
2383 "The finance industry.",
2384 "The healthcare industry.",
2385 "The media and entertainment industry.",
2386 "The retail industry.",
2387 "The technology industry.",
2388 "The travel industry."
2389 ],
2390 "items": {
2391 "enum": [
2392 "INDUSTRY_UNSPECIFIED",
2393 "I_AUTOMOTIVE",
2394 "I_BUSINESS_TO_BUSINESS",
2395 "I_CONSUMER_PACKAGED_GOODS",
2396 "I_EDUCATION",
2397 "I_FINANCE",
2398 "I_HEALTHCARE",
2399 "I_MEDIA_AND_ENTERTAINMENT",
2400 "I_RETAIL",
2401 "I_TECHNOLOGY",
2402 "I_TRAVEL"
2403 ],
2404 "type": "string"
2405 },
2406 "type": "array"
2407 },
2408 "websiteUrl": {
2409 "description": "URL of the company's website.",
2410 "type": "string"
2411 },
2412 "additionalWebsites": {
2413 "description": "URL of the company's additional websites use d to verify the dynamic badges.\nThese are stored as full URLs as entered by the user, but only the TLD will\nbe used for the actual verification.",
2414 "items": {
2415 "type": "string"
2416 },
2417 "type": "array"
2418 },
2419 "primaryAdwordsManagerAccountId": {
2420 "description": "The Primary AdWords Manager Account id.",
2421 "format": "int64",
2422 "type": "string"
2423 },
2424 "name": {
2425 "description": "The name of the company.",
2426 "type": "string"
2427 },
2428 "localizedInfos": {
2429 "description": "The list of localized info for the company." ,
2430 "items": {
2431 "$ref": "LocalizedCompanyInfo"
2432 },
2433 "type": "array"
2434 },
2435 "certificationStatuses": {
2436 "description": "The list of Google Partners certification st atuses for the company.",
2437 "items": {
2438 "$ref": "CertificationStatus"
2439 },
2440 "type": "array"
2441 },
2442 "id": {
2443 "description": "The ID of the company.",
2444 "type": "string"
2445 },
2446 "services": {
2447 "description": "Services the company can help with.",
2448 "enumDescriptions": [
2449 "Unchosen.",
2450 "Help with advanced AdWords support.",
2451 "Help with advertising on Google.",
2452 "Help with an enhanced website.",
2453 "Help with an online marketing plan.",
2454 "Help with mobile and video ads.",
2455 "Help with mobile websites."
2456 ],
2457 "items": {
2458 "enum": [
2459 "SERVICE_UNSPECIFIED",
2460 "S_ADVANCED_ADWORDS_SUPPORT",
2461 "S_ADVERTISING_ON_GOOGLE",
2462 "S_AN_ENHANCED_WEBSITE",
2463 "S_AN_ONLINE_MARKETING_PLAN",
2464 "S_MOBILE_AND_VIDEO_ADS",
2465 "S_MOBILE_WEBSITE_SERVICES"
2466 ],
2467 "type": "string"
2468 },
2469 "type": "array"
2470 },
2471 "primaryLocation": {
2472 "$ref": "Location",
2473 "description": "The primary location of the company."
2474 },
2475 "originalMinMonthlyBudget": {
2476 "$ref": "Money",
2477 "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness."
2478 },
2479 "publicProfile": {
2480 "$ref": "PublicProfile",
2481 "description": "Basic information from the company's public profile."
2482 },
2483 "ranks": {
2484 "description": "Information related to the ranking of the co mpany within the list of\ncompanies.",
2485 "items": {
2486 "$ref": "Rank"
2487 },
2488 "type": "array"
2489 },
2490 "specializationStatus": {
2491 "description": "The list of Google Partners specialization s tatuses for the company.",
2492 "items": {
2493 "$ref": "SpecializationStatus"
2494 },
2495 "type": "array"
2496 },
2497 "badgeTier": {
2498 "description": "Partner badge tier",
2499 "enum": [
2500 "BADGE_TIER_NONE",
2501 "BADGE_TIER_REGULAR",
2502 "BADGE_TIER_PREMIER"
2503 ],
2504 "enumDescriptions": [
2505 "Tier badge is not set.",
2506 "Agency has regular partner badge.",
2507 "Agency has premier badge."
2508 ],
2509 "type": "string"
2510 }
2511 },
2512 "type": "object"
2513 },
2514 "ListLeadsResponse": {
2515 "description": "Response message for ListLeads.",
2516 "id": "ListLeadsResponse",
2517 "properties": {
2518 "nextPageToken": {
2519 "description": "A token to retrieve next page of results.\nP ass this value in the `ListLeadsRequest.page_token` field in the\nsubsequent cal l to\nListLeads to retrieve the\nnext page of results.",
2520 "type": "string"
2521 },
2522 "totalSize": {
2523 "description": "The total count of leads for the given compa ny.",
2524 "format": "int32",
2525 "type": "integer"
2526 },
2527 "responseMetadata": {
2528 "$ref": "ResponseMetadata",
2529 "description": "Current response metadata."
2530 },
2531 "leads": {
2532 "description": "The list of leads.",
2533 "items": {
2534 "$ref": "Lead"
2535 },
2536 "type": "array"
2537 }
2538 },
2539 "type": "object"
2540 },
2541 "CreateLeadResponse": {
2542 "description": "Response message for CreateLead.",
2543 "id": "CreateLeadResponse",
2544 "properties": {
2545 "recaptchaStatus": {
2546 "description": "The outcome of <a href=\"https://www.google. com/recaptcha/\">reCaptcha</a>\nvalidation.",
2547 "enum": [
2548 "RECAPTCHA_STATUS_UNSPECIFIED",
2549 "RS_NOT_NEEDED",
2550 "RS_PASSED",
2551 "RS_FAILED"
2552 ],
2553 "enumDescriptions": [
2554 "Unchosen.",
2555 "No reCaptcha validation needed.",
2556 "reCaptcha challenge passed.",
2557 "reCaptcha challenge failed."
2558 ],
2559 "type": "string"
2560 },
2561 "lead": {
2562 "$ref": "Lead",
2563 "description": "Lead that was created depending on the outco me of\n<a href=\"https://www.google.com/recaptcha/\">reCaptcha</a> validation."
2564 },
2565 "responseMetadata": {
2566 "$ref": "ResponseMetadata",
2567 "description": "Current response metadata."
2568 }
2569 },
2570 "type": "object"
2571 },
2572 "GetCompanyResponse": {
2573 "description": "Response message for GetCompany.",
2574 "id": "GetCompanyResponse",
2575 "properties": {
2576 "company": {
2577 "$ref": "Company",
2578 "description": "The company."
2579 },
2580 "responseMetadata": {
2581 "$ref": "ResponseMetadata",
2582 "description": "Current response metadata."
2583 }
2584 },
2585 "type": "object"
2586 },
2587 "Location": {
2588 "description": "A location with address and geographic coordinates. May optionally contain a\ndetailed (multi-field) version of the address.",
2589 "id": "Location",
2590 "properties": {
2591 "latLng": {
2592 "$ref": "LatLng",
2593 "description": "The latitude and longitude of the location, in degrees."
2594 },
2595 "address": {
2596 "description": "The single string version of the address.",
2597 "type": "string"
2598 },
2599 "regionCode": {
2600 "description": "CLDR (Common Locale Data Repository) region code .",
2601 "type": "string"
2602 },
2603 "dependentLocality": {
2604 "description": "Dependent locality or sublocality. Used for UK dependent localities, or\nneighborhoods or boroughs in other locations.",
2605 "type": "string"
2606 },
2607 "postalCode": {
2608 "description": "Values are frequently alphanumeric.",
2609 "type": "string"
2610 },
2611 "languageCode": {
2612 "description": "Language code of the address. Should be in B CP 47 format.",
2613 "type": "string"
2614 },
2615 "sortingCode": {
2616 "description": "Use of this code is very country-specific, b ut will refer to a secondary\nclassification code for sorting mail.",
2617 "type": "string"
2618 },
2619 "addressLine": {
2620 "description": "The following address lines represent the mo st specific part of any\naddress.",
2621 "items": {
2622 "type": "string"
2623 },
2624 "type": "array"
2625 },
2626 "administrativeArea": {
2627 "description": "Top-level administrative subdivision of this country.",
2628 "type": "string"
2629 },
2630 "locality": {
2631 "description": "Generally refers to the city/town portion of an address.",
2632 "type": "string"
2633 }
2634 },
2635 "type": "object"
2636 },
2637 "ExamToken": {
2638 "description": "A token that allows a user to take an exam.",
2639 "id": "ExamToken",
2640 "properties": {
2641 "examId": { 1920 "examId": {
2642 "description": "The id of the exam the token is for.", 1921 "description": "The id of the exam the token is for.",
2643 "format": "int64", 1922 "format": "int64",
2644 "type": "string" 1923 "type": "string"
2645 }, 1924 },
2646 "token": { 1925 "token": {
2647 "description": "The token, only present if the user has acce ss to the exam.", 1926 "description": "The token, only present if the user has acce ss to the exam.",
2648 "type": "string" 1927 "type": "string"
2649 },
2650 "examType": {
2651 "description": "The type of the exam the token belongs to.",
2652 "enum": [
2653 "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
2654 "CET_ADWORDS_FUNDAMENTALS",
2655 "CET_ADWORDS_ADVANCED_SEARCH",
2656 "CET_ADWORDS_ADVANCED_DISPLAY",
2657 "CET_VIDEO_ADS",
2658 "CET_DOUBLECLICK",
2659 "CET_ANALYTICS",
2660 "CET_SHOPPING",
2661 "CET_MOBILE",
2662 "CET_DIGITAL_SALES",
2663 "CET_MOBILE_SITES"
2664 ],
2665 "enumDescriptions": [
2666 "Unchosen.",
2667 "Adwords Fundamentals exam.",
2668 "AdWords advanced search exam.",
2669 "AdWords advanced display exam.",
2670 "VideoAds exam.",
2671 "DoubleClick exam.",
2672 "Analytics exam.",
2673 "Shopping exam.",
2674 "Mobile exam.",
2675 "Digital Sales exam.",
2676 "Mobile Sites exam."
2677 ],
2678 "type": "string"
2679 }
2680 },
2681 "type": "object"
2682 },
2683 "CertificationExamStatus": {
2684 "description": "Status for a Google Partners certification exam.",
2685 "id": "CertificationExamStatus",
2686 "properties": {
2687 "numberUsersPass": {
2688 "description": "The number of people who have passed the cer tification exam.",
2689 "format": "int32",
2690 "type": "integer"
2691 },
2692 "type": {
2693 "description": "The type of certification exam.",
2694 "enum": [
2695 "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
2696 "CET_ADWORDS_FUNDAMENTALS",
2697 "CET_ADWORDS_ADVANCED_SEARCH",
2698 "CET_ADWORDS_ADVANCED_DISPLAY",
2699 "CET_VIDEO_ADS",
2700 "CET_DOUBLECLICK",
2701 "CET_ANALYTICS",
2702 "CET_SHOPPING",
2703 "CET_MOBILE",
2704 "CET_DIGITAL_SALES",
2705 "CET_MOBILE_SITES"
2706 ],
2707 "enumDescriptions": [
2708 "Unchosen.",
2709 "Adwords Fundamentals exam.",
2710 "AdWords advanced search exam.",
2711 "AdWords advanced display exam.",
2712 "VideoAds exam.",
2713 "DoubleClick exam.",
2714 "Analytics exam.",
2715 "Shopping exam.",
2716 "Mobile exam.",
2717 "Digital Sales exam.",
2718 "Mobile Sites exam."
2719 ],
2720 "type": "string"
2721 } 1928 }
2722 }, 1929 },
2723 "type": "object" 1930 "type": "object"
2724 }, 1931 },
2725 "OptIns": { 1932 "OptIns": {
2726 "description": "A set of opt-ins for a user.", 1933 "description": "A set of opt-ins for a user.",
2727 "id": "OptIns", 1934 "id": "OptIns",
2728 "properties": { 1935 "properties": {
1936 "phoneContact": {
1937 "description": "An opt-in to allow recieivng phone calls abo ut their Partners account.",
1938 "type": "boolean"
1939 },
1940 "physicalMail": {
1941 "description": "An opt-in to receive special promotional gif ts and material in the mail.",
1942 "type": "boolean"
1943 },
1944 "marketComm": {
1945 "description": "An opt-in about receiving email from Partner s marketing teams. Includes\nmember-only events and special promotional offers f or Google products.",
1946 "type": "boolean"
1947 },
2729 "specialOffers": { 1948 "specialOffers": {
2730 "description": "An opt-in about receiving email regarding ne w features and products.", 1949 "description": "An opt-in about receiving email regarding ne w features and products.",
2731 "type": "boolean" 1950 "type": "boolean"
2732 }, 1951 },
2733 "performanceSuggestions": { 1952 "performanceSuggestions": {
2734 "description": "An opt-in about receiving email with customi zed AdWords campaign management\ntips.", 1953 "description": "An opt-in about receiving email with customi zed AdWords campaign management\ntips.",
2735 "type": "boolean" 1954 "type": "boolean"
2736 },
2737 "phoneContact": {
2738 "description": "An opt-in to allow recieivng phone calls abo ut their Partners account.",
2739 "type": "boolean"
2740 },
2741 "physicalMail": {
2742 "description": "An opt-in to receive special promotional gif ts and material in the mail.",
2743 "type": "boolean"
2744 },
2745 "marketComm": {
2746 "description": "An opt-in about receiving email from Partner s marketing teams. Includes\nmember-only events and special promotional offers f or Google products.",
2747 "type": "boolean"
2748 } 1955 }
2749 }, 1956 },
2750 "type": "object" 1957 "type": "object"
2751 }, 1958 },
2752 "Rank": { 1959 "Rank": {
2753 "description": "Information related to ranking of results.", 1960 "description": "Information related to ranking of results.",
2754 "id": "Rank", 1961 "id": "Rank",
2755 "properties": { 1962 "properties": {
2756 "value": { 1963 "value": {
2757 "description": "The numerical value of the rank.", 1964 "description": "The numerical value of the rank.",
2758 "format": "double", 1965 "format": "double",
2759 "type": "number" 1966 "type": "number"
2760 }, 1967 },
2761 "type": { 1968 "type": {
2762 "description": "The type of rank.", 1969 "description": "The type of rank.",
2763 "enum": [ 1970 "enum": [
2764 "RANK_TYPE_UNSPECIFIED", 1971 "RANK_TYPE_UNSPECIFIED",
2765 "RT_FINAL_SCORE" 1972 "RT_FINAL_SCORE"
2766 ], 1973 ],
2767 "enumDescriptions": [ 1974 "enumDescriptions": [
2768 "Unchosen.", 1975 "Unchosen.",
2769 "Total final score." 1976 "Total final score."
2770 ], 1977 ],
2771 "type": "string" 1978 "type": "string"
2772 } 1979 }
2773 }, 1980 },
2774 "type": "object" 1981 "type": "object"
2775 }, 1982 },
1983 "GetPartnersStatusResponse": {
1984 "description": "Response message for\nGetPartnersStatus.",
1985 "id": "GetPartnersStatusResponse",
1986 "properties": {
1987 "responseMetadata": {
1988 "$ref": "ResponseMetadata",
1989 "description": "Current response metadata."
1990 }
1991 },
1992 "type": "object"
1993 },
2776 "UserProfile": { 1994 "UserProfile": {
2777 "description": "The profile information of a Partners user.", 1995 "description": "The profile information of a Partners user.",
2778 "id": "UserProfile", 1996 "id": "UserProfile",
2779 "properties": { 1997 "properties": {
1998 "phoneNumber": {
1999 "description": "The user's phone number.",
2000 "type": "string"
2001 },
2002 "adwordsManagerAccount": {
2003 "description": "If the user has edit access to multiple acco unts, the user can choose the\npreferred account and it is used when a personal account is needed. Can\nbe empty.",
2004 "format": "int64",
2005 "type": "string"
2006 },
2007 "primaryCountryCode": {
2008 "description": "The user's primary country, an ISO 2-charact er code.",
2009 "type": "string"
2010 },
2011 "emailAddress": {
2012 "description": "The email address the user has selected on t he Partners site as primary.",
2013 "type": "string"
2014 },
2015 "profilePublic": {
2016 "description": "Whether the user's public profile is visible to anyone with the URL.",
2017 "type": "boolean"
2018 },
2019 "channels": {
2020 "description": "A list of ids representing which channels th e user selected they were in.",
2021 "items": {
2022 "type": "string"
2023 },
2024 "type": "array"
2025 },
2026 "jobFunctions": {
2027 "description": "A list of ids represnting which job categori es the user selected.",
2028 "items": {
2029 "type": "string"
2030 },
2031 "type": "array"
2032 },
2780 "givenName": { 2033 "givenName": {
2781 "description": "The user's given name.", 2034 "description": "The user's given name.",
2782 "type": "string" 2035 "type": "string"
2783 }, 2036 },
2784 "address": { 2037 "address": {
2785 "$ref": "Location", 2038 "$ref": "Location",
2786 "description": "The user's mailing address, contains multipl e fields." 2039 "description": "The user's mailing address, contains multipl e fields."
2787 }, 2040 },
2788 "industries": { 2041 "industries": {
2789 "description": "A list of ids representing which industries the user selected.", 2042 "description": "A list of ids representing which industries the user selected.",
2790 "items": { 2043 "items": {
2791 "type": "string" 2044 "type": "string"
2792 }, 2045 },
2793 "type": "array" 2046 "type": "array"
2794 }, 2047 },
2048 "emailOptIns": {
2049 "$ref": "OptIns",
2050 "description": "The list of opt-ins for the user, related to communication preferences."
2051 },
2795 "languages": { 2052 "languages": {
2796 "description": "The list of languages this user understands. ", 2053 "description": "The list of languages this user understands. ",
2797 "items": { 2054 "items": {
2798 "type": "string" 2055 "type": "string"
2799 }, 2056 },
2800 "type": "array" 2057 "type": "array"
2801 }, 2058 },
2802 "familyName": { 2059 "familyName": {
2803 "description": "The user's family name.", 2060 "description": "The user's family name.",
2804 "type": "string" 2061 "type": "string"
2805 }, 2062 },
2806 "emailOptIns": {
2807 "$ref": "OptIns",
2808 "description": "The list of opt-ins for the user, related to communication preferences."
2809 },
2810 "markets": { 2063 "markets": {
2811 "description": "A list of ids representing which markets the user was interested in.", 2064 "description": "A list of ids representing which markets the user was interested in.",
2812 "items": { 2065 "items": {
2813 "type": "string" 2066 "type": "string"
2814 }, 2067 },
2815 "type": "array" 2068 "type": "array"
2816 },
2817 "adwordsManagerAccount": {
2818 "description": "If the user has edit access to multiple acco unts, the user can choose the\npreferred account and it is used when a personal account is needed. Can\nbe empty.",
2819 "format": "int64",
2820 "type": "string"
2821 },
2822 "phoneNumber": {
2823 "description": "The user's phone number.",
2824 "type": "string"
2825 },
2826 "primaryCountryCode": {
2827 "description": "The user's primary country, an ISO 2-charact er code.",
2828 "type": "string"
2829 },
2830 "emailAddress": {
2831 "description": "The email address the user has selected on t he Partners site as primary.",
2832 "type": "string"
2833 },
2834 "channels": {
2835 "description": "A list of ids representing which channels th e user selected they were in.",
2836 "items": {
2837 "type": "string"
2838 },
2839 "type": "array"
2840 },
2841 "profilePublic": {
2842 "description": "Whether the user's public profile is visible to anyone with the URL.",
2843 "type": "boolean"
2844 },
2845 "jobFunctions": {
2846 "description": "A list of ids represnting which job categori es the user selected.",
2847 "items": {
2848 "type": "string"
2849 },
2850 "type": "array"
2851 }
2852 },
2853 "type": "object"
2854 },
2855 "GetPartnersStatusResponse": {
2856 "description": "Response message for\nGetPartnersStatus.",
2857 "id": "GetPartnersStatusResponse",
2858 "properties": {
2859 "responseMetadata": {
2860 "$ref": "ResponseMetadata",
2861 "description": "Current response metadata."
2862 } 2069 }
2863 }, 2070 },
2864 "type": "object" 2071 "type": "object"
2865 }, 2072 },
2866 "HistoricalOffer": { 2073 "HistoricalOffer": {
2867 "description": "Historical information about a Google Partners Offer .", 2074 "description": "Historical information about a Google Partners Offer .",
2868 "id": "HistoricalOffer", 2075 "id": "HistoricalOffer",
2869 "properties": { 2076 "properties": {
2870 "offerCountryCode": {
2871 "description": "Country Code for the offer country.",
2872 "type": "string"
2873 },
2874 "expirationTime": {
2875 "description": "Time this offer expires.",
2876 "format": "google-datetime",
2877 "type": "string"
2878 },
2879 "offerCode": { 2077 "offerCode": {
2880 "description": "Offer code.", 2078 "description": "Offer code.",
2881 "type": "string" 2079 "type": "string"
2882 }, 2080 },
2883 "creationTime": { 2081 "creationTime": {
2884 "description": "Time offer was first created.", 2082 "description": "Time offer was first created.",
2885 "format": "google-datetime", 2083 "format": "google-datetime",
2886 "type": "string" 2084 "type": "string"
2887 }, 2085 },
2888 "status": { 2086 "status": {
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after
2937 "Unset.", 2135 "Unset.",
2938 "AdWords spend X get Y.", 2136 "AdWords spend X get Y.",
2939 "Youtube video.", 2137 "Youtube video.",
2940 "Spend Match up to Y." 2138 "Spend Match up to Y."
2941 ], 2139 ],
2942 "type": "string" 2140 "type": "string"
2943 }, 2141 },
2944 "senderName": { 2142 "senderName": {
2945 "description": "Name (First + Last) of the partners user to whom the incentive is allocated.", 2143 "description": "Name (First + Last) of the partners user to whom the incentive is allocated.",
2946 "type": "string" 2144 "type": "string"
2947 } 2145 },
2948 }, 2146 "offerCountryCode": {
2949 "type": "object" 2147 "description": "Country Code for the offer country.",
2950 }, 2148 "type": "string"
2951 "UserOverrides": { 2149 },
2952 "description": "Values to use instead of the user's respective defau lts. These are only\nhonored by whitelisted products.", 2150 "expirationTime": {
2953 "id": "UserOverrides", 2151 "description": "Time this offer expires.",
2954 "properties": { 2152 "format": "google-datetime",
2955 "userId": {
2956 "description": "Logged-in user ID to impersonate instead of the user's ID.",
2957 "type": "string"
2958 },
2959 "ipAddress": {
2960 "description": "IP address to use instead of the user's geo- located IP address.",
2961 "type": "string" 2153 "type": "string"
2962 } 2154 }
2963 }, 2155 },
2964 "type": "object" 2156 "type": "object"
2965 }, 2157 },
2966 "LogUserEventRequest": { 2158 "LogUserEventRequest": {
2967 "description": "Request message for\nLogUserEvent.", 2159 "description": "Request message for\nLogUserEvent.",
2968 "id": "LogUserEventRequest", 2160 "id": "LogUserEventRequest",
2969 "properties": { 2161 "properties": {
2970 "url": {
2971 "description": "The URL where the event occurred.",
2972 "type": "string"
2973 },
2974 "requestMetadata": {
2975 "$ref": "RequestMetadata",
2976 "description": "Current request metadata."
2977 },
2978 "eventScope": {
2979 "description": "The scope of the event.",
2980 "enum": [
2981 "EVENT_SCOPE_UNSPECIFIED",
2982 "VISITOR",
2983 "SESSION",
2984 "PAGE"
2985 ],
2986 "enumDescriptions": [
2987 "Unchosen.",
2988 "Based on visitor.",
2989 "Based on session.",
2990 "Based on page visit."
2991 ],
2992 "type": "string"
2993 },
2994 "eventDatas": {
2995 "description": "List of event data for the event.",
2996 "items": {
2997 "$ref": "EventData"
2998 },
2999 "type": "array"
3000 },
3001 "eventCategory": { 2162 "eventCategory": {
3002 "description": "The category the action belongs to.", 2163 "description": "The category the action belongs to.",
3003 "enum": [ 2164 "enum": [
3004 "EVENT_CATEGORY_UNSPECIFIED", 2165 "EVENT_CATEGORY_UNSPECIFIED",
3005 "GOOGLE_PARTNER_SEARCH", 2166 "GOOGLE_PARTNER_SEARCH",
3006 "GOOGLE_PARTNER_SIGNUP_FLOW", 2167 "GOOGLE_PARTNER_SIGNUP_FLOW",
3007 "GOOGLE_PARTNER_PORTAL", 2168 "GOOGLE_PARTNER_PORTAL",
3008 "GOOGLE_PARTNER_PORTAL_MY_PROFILE", 2169 "GOOGLE_PARTNER_PORTAL_MY_PROFILE",
3009 "GOOGLE_PARTNER_PORTAL_CERTIFICATIONS", 2170 "GOOGLE_PARTNER_PORTAL_CERTIFICATIONS",
3010 "GOOGLE_PARTNER_PORTAL_COMMUNITY", 2171 "GOOGLE_PARTNER_PORTAL_COMMUNITY",
(...skipping 345 matching lines...) Expand 10 before | Expand all | Expand 10 after
3356 "Agency picked a suggested agency.", 2517 "Agency picked a suggested agency.",
3357 "Agency searched for agencies.", 2518 "Agency searched for agencies.",
3358 "Agency picked a searched agency.", 2519 "Agency picked a searched agency.",
3359 "Agency dismissed affiliation widget.", 2520 "Agency dismissed affiliation widget.",
3360 "Agency clicked on the download link for downloading con tent.", 2521 "Agency clicked on the download link for downloading con tent.",
3361 "Agency user is maklingg progress viewing a content item .", 2522 "Agency user is maklingg progress viewing a content item .",
3362 "Agency clicked `cancel Terms Of Service` button.", 2523 "Agency clicked `cancel Terms Of Service` button.",
3363 "Advertiser entered website in contact form." 2524 "Advertiser entered website in contact form."
3364 ], 2525 ],
3365 "type": "string" 2526 "type": "string"
2527 },
2528 "url": {
2529 "description": "The URL where the event occurred.",
2530 "type": "string"
2531 },
2532 "requestMetadata": {
2533 "$ref": "RequestMetadata",
2534 "description": "Current request metadata."
2535 },
2536 "eventDatas": {
2537 "description": "List of event data for the event.",
2538 "items": {
2539 "$ref": "EventData"
2540 },
2541 "type": "array"
2542 },
2543 "eventScope": {
2544 "description": "The scope of the event.",
2545 "enum": [
2546 "EVENT_SCOPE_UNSPECIFIED",
2547 "VISITOR",
2548 "SESSION",
2549 "PAGE"
2550 ],
2551 "enumDescriptions": [
2552 "Unchosen.",
2553 "Based on visitor.",
2554 "Based on session.",
2555 "Based on page visit."
2556 ],
2557 "type": "string"
2558 }
2559 },
2560 "type": "object"
2561 },
2562 "UserOverrides": {
2563 "description": "Values to use instead of the user's respective defau lts. These are only\nhonored by whitelisted products.",
2564 "id": "UserOverrides",
2565 "properties": {
2566 "ipAddress": {
2567 "description": "IP address to use instead of the user's geo- located IP address.",
2568 "type": "string"
2569 },
2570 "userId": {
2571 "description": "Logged-in user ID to impersonate instead of the user's ID.",
2572 "type": "string"
3366 } 2573 }
3367 }, 2574 },
3368 "type": "object" 2575 "type": "object"
3369 }, 2576 },
3370 "AnalyticsDataPoint": { 2577 "AnalyticsDataPoint": {
3371 "description": "Details of the analytics events for a `Company` with in a single day.", 2578 "description": "Details of the analytics events for a `Company` with in a single day.",
3372 "id": "AnalyticsDataPoint", 2579 "id": "AnalyticsDataPoint",
3373 "properties": { 2580 "properties": {
2581 "eventCount": {
2582 "description": "Number of times the type of event occurred.\ nMeaning depends on context (e.g. profile views, contacts, etc.).",
2583 "format": "int32",
2584 "type": "integer"
2585 },
3374 "eventLocations": { 2586 "eventLocations": {
3375 "description": "Location information of where these events o ccurred.", 2587 "description": "Location information of where these events o ccurred.",
3376 "items": { 2588 "items": {
3377 "$ref": "LatLng" 2589 "$ref": "LatLng"
3378 }, 2590 },
3379 "type": "array" 2591 "type": "array"
3380 },
3381 "eventCount": {
3382 "description": "Number of times the type of event occurred.\ nMeaning depends on context (e.g. profile views, contacts, etc.).",
3383 "format": "int32",
3384 "type": "integer"
3385 } 2592 }
3386 }, 2593 },
3387 "type": "object" 2594 "type": "object"
3388 }, 2595 },
3389 "Analytics": { 2596 "Analytics": {
3390 "description": "Analytics data for a `Company` within a single day." , 2597 "description": "Analytics data for a `Company` within a single day." ,
3391 "id": "Analytics", 2598 "id": "Analytics",
3392 "properties": { 2599 "properties": {
2600 "contacts": {
2601 "$ref": "AnalyticsDataPoint",
2602 "description": "Instances of users contacting the `Company`\ non the specified date."
2603 },
3393 "searchViews": { 2604 "searchViews": {
3394 "$ref": "AnalyticsDataPoint", 2605 "$ref": "AnalyticsDataPoint",
3395 "description": "Instances of users seeing the `Company` in G oogle Partners Search results\non the specified date." 2606 "description": "Instances of users seeing the `Company` in G oogle Partners Search results\non the specified date."
3396 }, 2607 },
3397 "profileViews": { 2608 "profileViews": {
3398 "$ref": "AnalyticsDataPoint", 2609 "$ref": "AnalyticsDataPoint",
3399 "description": "Instances of users viewing the `Company` pro file\non the specified date." 2610 "description": "Instances of users viewing the `Company` pro file\non the specified date."
3400 }, 2611 },
3401 "eventDate": { 2612 "eventDate": {
3402 "$ref": "Date", 2613 "$ref": "Date",
3403 "description": "Date on which these events occurred." 2614 "description": "Date on which these events occurred."
3404 },
3405 "contacts": {
3406 "$ref": "AnalyticsDataPoint",
3407 "description": "Instances of users contacting the `Company`\ non the specified date."
3408 } 2615 }
3409 }, 2616 },
3410 "type": "object" 2617 "type": "object"
3411 }, 2618 },
3412 "PublicProfile": { 2619 "PublicProfile": {
3413 "description": "Basic information from a public profile.", 2620 "description": "Basic information from a public profile.",
3414 "id": "PublicProfile", 2621 "id": "PublicProfile",
3415 "properties": { 2622 "properties": {
2623 "url": {
2624 "description": "The URL of the public profile.",
2625 "type": "string"
2626 },
2627 "id": {
2628 "description": "The ID which can be used to retrieve more de tails about the public profile.",
2629 "type": "string"
2630 },
2631 "profileImage": {
2632 "description": "The URL to the main profile image of the pub lic profile.",
2633 "type": "string"
2634 },
3416 "displayImageUrl": { 2635 "displayImageUrl": {
3417 "description": "The URL to the main display image of the pub lic profile. Being deprecated.", 2636 "description": "The URL to the main display image of the pub lic profile. Being deprecated.",
3418 "type": "string" 2637 "type": "string"
3419 }, 2638 },
3420 "displayName": { 2639 "displayName": {
3421 "description": "The display name of the public profile.", 2640 "description": "The display name of the public profile.",
3422 "type": "string" 2641 "type": "string"
3423 },
3424 "url": {
3425 "description": "The URL of the public profile.",
3426 "type": "string"
3427 },
3428 "id": {
3429 "description": "The ID which can be used to retrieve more de tails about the public profile.",
3430 "type": "string"
3431 },
3432 "profileImage": {
3433 "description": "The URL to the main profile image of the pub lic profile.",
3434 "type": "string"
3435 } 2642 }
3436 }, 2643 },
3437 "type": "object" 2644 "type": "object"
3438 }, 2645 },
3439 "AdWordsManagerAccountInfo": { 2646 "AdWordsManagerAccountInfo": {
3440 "description": "Information about a particular AdWords Manager Accou nt.\nRead more at https://support.google.com/adwords/answer/6139186", 2647 "description": "Information about a particular AdWords Manager Accou nt.\nRead more at https://support.google.com/adwords/answer/6139186",
3441 "id": "AdWordsManagerAccountInfo", 2648 "id": "AdWordsManagerAccountInfo",
3442 "properties": { 2649 "properties": {
3443 "customerName": { 2650 "customerName": {
3444 "description": "Name of the customer this account represents .", 2651 "description": "Name of the customer this account represents .",
(...skipping 30 matching lines...) Expand all
3475 "description": "The ID of the reCaptcha challenge.", 2682 "description": "The ID of the reCaptcha challenge.",
3476 "type": "string" 2683 "type": "string"
3477 } 2684 }
3478 }, 2685 },
3479 "type": "object" 2686 "type": "object"
3480 }, 2687 },
3481 "AvailableOffer": { 2688 "AvailableOffer": {
3482 "description": "Available Offers to be distributed.", 2689 "description": "Available Offers to be distributed.",
3483 "id": "AvailableOffer", 2690 "id": "AvailableOffer",
3484 "properties": { 2691 "properties": {
2692 "maxAccountAge": {
2693 "description": "The maximum age of an account [in days] to b e eligible.",
2694 "format": "int32",
2695 "type": "integer"
2696 },
2697 "qualifiedCustomer": {
2698 "description": "Customers who qualify for this offer.",
2699 "items": {
2700 "$ref": "OfferCustomer"
2701 },
2702 "type": "array"
2703 },
2704 "terms": {
2705 "description": "Terms of the offer.",
2706 "type": "string"
2707 },
2708 "showSpecialOfferCopy": {
2709 "description": "Should special text be shown on the offers p age.",
2710 "type": "boolean"
2711 },
2712 "available": {
2713 "description": "The number of codes for this offer that are available for distribution.",
2714 "format": "int32",
2715 "type": "integer"
2716 },
2717 "description": {
2718 "description": "Description of the offer.",
2719 "type": "string"
2720 },
2721 "offerLevel": {
2722 "description": "Level of this offer.",
2723 "enum": [
2724 "OFFER_LEVEL_UNSPECIFIED",
2725 "OFFER_LEVEL_DENY_PROBLEM",
2726 "OFFER_LEVEL_DENY_CONTRACT",
2727 "OFFER_LEVEL_MANUAL",
2728 "OFFER_LEVEL_LIMIT_0",
2729 "OFFER_LEVEL_LIMIT_5",
2730 "OFFER_LEVEL_LIMIT_15",
2731 "OFFER_LEVEL_LIMIT_50"
2732 ],
2733 "enumDescriptions": [
2734 "Unset.",
2735 "Users/Agencies that have no offers because of a problem .",
2736 "Users/Agencies that have no offers due to contractural agreements.",
2737 "Users/Agencies that have a manually-configured limit.",
2738 "Some Agencies don't get any offers.",
2739 "Basic level gets 5 per month.",
2740 "Agencies with adequate AHI and spend get 15/month.",
2741 "Badged partners (even in grace) get 50 per month."
2742 ],
2743 "type": "string"
2744 },
2745 "name": {
2746 "description": "Name of the offer.",
2747 "type": "string"
2748 },
3485 "qualifiedCustomersComplete": { 2749 "qualifiedCustomersComplete": {
3486 "description": "Whether or not the list of qualified custome rs is definitely complete.", 2750 "description": "Whether or not the list of qualified custome rs is definitely complete.",
3487 "type": "boolean" 2751 "type": "boolean"
3488 }, 2752 },
3489 "id": { 2753 "id": {
3490 "description": "ID of this offer.", 2754 "description": "ID of this offer.",
3491 "format": "int64", 2755 "format": "int64",
3492 "type": "string" 2756 "type": "string"
3493 }, 2757 },
3494 "countryOfferInfos": { 2758 "countryOfferInfos": {
3495 "description": "Offer info by country.", 2759 "description": "Offer info by country.",
3496 "items": { 2760 "items": {
3497 "$ref": "CountryOfferInfo" 2761 "$ref": "CountryOfferInfo"
3498 }, 2762 },
3499 "type": "array" 2763 "type": "array"
3500 }, 2764 },
3501 "offerType": { 2765 "offerType": {
3502 "description": "Type of offer.", 2766 "description": "Type of offer.",
3503 "enum": [ 2767 "enum": [
3504 "OFFER_TYPE_UNSPECIFIED", 2768 "OFFER_TYPE_UNSPECIFIED",
3505 "OFFER_TYPE_SPEND_X_GET_Y", 2769 "OFFER_TYPE_SPEND_X_GET_Y",
2770 "OFFER_TYPE_VIDEO",
2771 "OFFER_TYPE_SPEND_MATCH"
2772 ],
2773 "enumDescriptions": [
2774 "Unset.",
2775 "AdWords spend X get Y.",
2776 "Youtube video.",
2777 "Spend Match up to Y."
2778 ],
2779 "type": "string"
2780 }
2781 },
2782 "type": "object"
2783 },
2784 "LatLng": {
2785 "description": "An object representing a latitude/longitude pair. Th is is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n<a href=\"http ://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\">WGS84\nstandard</a>. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n \n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees long itude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r > 180.0 or (r == 180.0 and q <= -1.0):\n return r - 360.0\n retur n r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], resp ectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 36 0, NormalizeLongitude(longitude)\n else:\n return 180 - r, Normalize Longitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLo ngitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == Normali zeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\ n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10. 0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng (-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n as sert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == N ormalizeLatLng(-270.0, 10.0)",
2786 "id": "LatLng",
2787 "properties": {
2788 "longitude": {
2789 "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
2790 "format": "double",
2791 "type": "number"
2792 },
2793 "latitude": {
2794 "description": "The latitude in degrees. It must be in the r ange [-90.0, +90.0].",
2795 "format": "double",
2796 "type": "number"
2797 }
2798 },
2799 "type": "object"
2800 },
2801 "Money": {
2802 "description": "Represents an amount of money with its currency type .",
2803 "id": "Money",
2804 "properties": {
2805 "units": {
2806 "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
2807 "format": "int64",
2808 "type": "string"
2809 },
2810 "currencyCode": {
2811 "description": "The 3-letter currency code defined in ISO 42 17.",
2812 "type": "string"
2813 },
2814 "nanos": {
2815 "description": "Number of nano (10^-9) units of the amount.\ nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negativ e or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000 ,000.",
2816 "format": "int32",
2817 "type": "integer"
2818 }
2819 },
2820 "type": "object"
2821 },
2822 "AnalyticsSummary": {
2823 "description": "Analytics aggregated data for a `Company` for a give n date range.",
2824 "id": "AnalyticsSummary",
2825 "properties": {
2826 "searchViewsCount": {
2827 "description": "Aggregated number of times users saw the `Co mpany`\nin Google Partners Search results for given date range.",
2828 "format": "int32",
2829 "type": "integer"
2830 },
2831 "contactsCount": {
2832 "description": "Aggregated number of times users contacted t he `Company`\nfor given date range.",
2833 "format": "int32",
2834 "type": "integer"
2835 },
2836 "profileViewsCount": {
2837 "description": "Aggregated number of profile views for the ` Company` for given date range.",
2838 "format": "int32",
2839 "type": "integer"
2840 }
2841 },
2842 "type": "object"
2843 },
2844 "LogMessageRequest": {
2845 "description": "Request message for\nLogClientMessage.",
2846 "id": "LogMessageRequest",
2847 "properties": {
2848 "level": {
2849 "description": "Message level of client message.",
2850 "enum": [
2851 "MESSAGE_LEVEL_UNSPECIFIED",
2852 "ML_FINE",
2853 "ML_INFO",
2854 "ML_WARNING",
2855 "ML_SEVERE"
2856 ],
2857 "enumDescriptions": [
2858 "Unchosen.",
2859 "Message level for tracing information.",
2860 "Message level for informational messages.",
2861 "Message level for potential problems.",
2862 "Message level for serious failures."
2863 ],
2864 "type": "string"
2865 },
2866 "details": {
2867 "description": "Details about the client message.",
2868 "type": "string"
2869 },
2870 "clientInfo": {
2871 "additionalProperties": {
2872 "type": "string"
2873 },
2874 "description": "Map of client info, such as URL, browser nav igator, browser platform, etc.",
2875 "type": "object"
2876 },
2877 "requestMetadata": {
2878 "$ref": "RequestMetadata",
2879 "description": "Current request metadata."
2880 }
2881 },
2882 "type": "object"
2883 },
2884 "Lead": {
2885 "description": "A lead resource that represents an advertiser contac t for a `Company`. These\nare usually generated via Google Partner Search (the a dvertiser portal).",
2886 "id": "Lead",
2887 "properties": {
2888 "type": {
2889 "description": "Type of lead.",
2890 "enum": [
2891 "LEAD_TYPE_UNSPECIFIED",
2892 "LT_GPS"
2893 ],
2894 "enumDescriptions": [
2895 "Unchosen.",
2896 "Google Partner Search."
2897 ],
2898 "type": "string"
2899 },
2900 "minMonthlyBudget": {
2901 "$ref": "Money",
2902 "description": "The minimum monthly budget lead source is wi lling to spend."
2903 },
2904 "givenName": {
2905 "description": "First name of lead source.",
2906 "type": "string"
2907 },
2908 "websiteUrl": {
2909 "description": "Website URL of lead source.",
2910 "type": "string"
2911 },
2912 "languageCode": {
2913 "description": "Language code of the lead's language prefere nce, as defined by\n<a href=\"https://tools.ietf.org/html/bcp47\">BCP 47</a>\n(I ETF BCP 47, \"Tags for Identifying Languages\").",
2914 "type": "string"
2915 },
2916 "state": {
2917 "description": "The lead's state in relation to the company. ",
2918 "enum": [
2919 "LEAD_STATE_UNSPECIFIED",
2920 "LEAD",
2921 "CONTACTED",
2922 "CLIENT",
2923 "OTHER"
2924 ],
2925 "enumDescriptions": [
2926 "Unchosen.",
2927 "Lead not yet contacted.",
2928 "Lead has been contacted.",
2929 "Lead has become a client.",
2930 "Lead in a state not covered by other options."
2931 ],
2932 "type": "string"
2933 },
2934 "gpsMotivations": {
2935 "description": "List of reasons for using Google Partner Sea rch and creating a lead.",
2936 "enumDescriptions": [
2937 "Unchosen.",
2938 "Advertiser needs help with their advertising.",
2939 "Advertiser needs help with their website.",
2940 "Advertiser does not have a website."
2941 ],
2942 "items": {
2943 "enum": [
2944 "GPS_MOTIVATION_UNSPECIFIED",
2945 "GPSM_HELP_WITH_ADVERTISING",
2946 "GPSM_HELP_WITH_WEBSITE",
2947 "GPSM_NO_WEBSITE"
2948 ],
2949 "type": "string"
2950 },
2951 "type": "array"
2952 },
2953 "email": {
2954 "description": "Email address of lead source.",
2955 "type": "string"
2956 },
2957 "familyName": {
2958 "description": "Last name of lead source.",
2959 "type": "string"
2960 },
2961 "id": {
2962 "description": "ID of the lead.",
2963 "type": "string"
2964 },
2965 "comments": {
2966 "description": "Comments lead source gave.",
2967 "type": "string"
2968 },
2969 "adwordsCustomerId": {
2970 "description": "The AdWords Customer ID of the lead.",
2971 "format": "int64",
2972 "type": "string"
2973 },
2974 "phoneNumber": {
2975 "description": "Phone number of lead source.",
2976 "type": "string"
2977 },
2978 "createTime": {
2979 "description": "Timestamp of when this lead was created.",
2980 "format": "google-datetime",
2981 "type": "string"
2982 },
2983 "marketingOptIn": {
2984 "description": "Whether or not the lead signed up for market ing emails",
2985 "type": "boolean"
2986 }
2987 },
2988 "type": "object"
2989 },
2990 "DebugInfo": {
2991 "description": "Debug information about this request.",
2992 "id": "DebugInfo",
2993 "properties": {
2994 "serverTraceInfo": {
2995 "description": "Server-side debug stack trace.",
2996 "type": "string"
2997 },
2998 "serverInfo": {
2999 "description": "Info about the server that serviced this req uest.",
3000 "type": "string"
3001 },
3002 "serviceUrl": {
3003 "description": "URL of the service that handled this request .",
3004 "type": "string"
3005 }
3006 },
3007 "type": "object"
3008 },
3009 "ListUserStatesResponse": {
3010 "description": "Response message for\nListUserStates.",
3011 "id": "ListUserStatesResponse",
3012 "properties": {
3013 "userStates": {
3014 "description": "User's states.",
3015 "enumDescriptions": [
3016 "Unchosen.",
3017 "User must pass <a href=\"https://www.google.com/recaptc ha/\">reCaptcha</a> to\ncontact a Partner via Google Partner Search."
3018 ],
3019 "items": {
3020 "enum": [
3021 "USER_STATE_UNSPECIFIED",
3022 "US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT"
3023 ],
3024 "type": "string"
3025 },
3026 "type": "array"
3027 },
3028 "responseMetadata": {
3029 "$ref": "ResponseMetadata",
3030 "description": "Current response metadata."
3031 }
3032 },
3033 "type": "object"
3034 },
3035 "CompanyRelation": {
3036 "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.",
3037 "id": "CompanyRelation",
3038 "properties": {
3039 "resolvedTimestamp": {
3040 "description": "The timestamp when the user was approved.\n@ OutputOnly",
3041 "format": "google-datetime",
3042 "type": "string"
3043 },
3044 "companyAdmin": {
3045 "description": "Indicates if the user is an admin for this c ompany.",
3046 "type": "boolean"
3047 },
3048 "isPending": {
3049 "description": "The flag that indicates if the company is pe nding verification.",
3050 "type": "boolean"
3051 },
3052 "address": {
3053 "description": "The primary address for this company.",
3054 "type": "string"
3055 },
3056 "creationTime": {
3057 "description": "The timestamp of when affiliation was reques ted.\n@OutputOnly",
3058 "format": "google-datetime",
3059 "type": "string"
3060 },
3061 "primaryAddress": {
3062 "$ref": "Location",
3063 "description": "The primary location of the company."
3064 },
3065 "state": {
3066 "description": "The state of relationship, in terms of appro vals.",
3067 "enum": [
3068 "USER_COMPANY_REATION_STATE_NONE_SPECIFIED",
3069 "USER_COMPANY_RELATION_STATE_AWAIT_EMAIL",
3070 "USER_COMPANY_RELATION_STATE_AWAIT_ADMIN",
3071 "USER_COMPANY_RELATION_STATE_APPROVED"
3072 ],
3073 "enumDescriptions": [
3074 "Default unspecified value.",
3075 "User has filled in a request to be associated with an c ompany.\nNow waiting email confirmation.",
3076 "Pending approval from company.\nEmail confirmation will not approve this one.",
3077 "Approved by company."
3078 ],
3079 "type": "string"
3080 },
3081 "managerAccount": {
3082 "description": "The AdWords manager account # associated thi s company.",
3083 "format": "int64",
3084 "type": "string"
3085 },
3086 "name": {
3087 "description": "The name (in the company's primary language) for the company.",
3088 "type": "string"
3089 },
3090 "segment": {
3091 "description": "The segment the company is classified as.",
3092 "enumDescriptions": [
3093 "Default segment indicates an unknown.",
3094 "Segment representing a selected group of Partners",
3095 "Segment representing Premier SMB Partners, an AdWords p artnership program.",
3096 "A segment of Premier SMB Partners that have relationshi p with Google."
3097 ],
3098 "items": {
3099 "enum": [
3100 "COMPANY_SEGMENT_UNKNOWN",
3101 "COMPANY_SEGMENT_NAL",
3102 "COMPANY_SEGMENT_PSP",
3103 "COMPANY_SEGMENT_PPSP"
3104 ],
3105 "type": "string"
3106 },
3107 "type": "array"
3108 },
3109 "internalCompanyId": {
3110 "description": "The internal company ID.\nOnly available for a whitelisted set of api clients.",
3111 "type": "string"
3112 },
3113 "badgeTier": {
3114 "description": "Whether the company is a Partner.",
3115 "enum": [
3116 "BADGE_TIER_NONE",
3117 "BADGE_TIER_REGULAR",
3118 "BADGE_TIER_PREMIER"
3119 ],
3120 "enumDescriptions": [
3121 "Tier badge is not set.",
3122 "Agency has regular partner badge.",
3123 "Agency has premier badge."
3124 ],
3125 "type": "string"
3126 },
3127 "specializationStatus": {
3128 "description": "The list of Google Partners specialization s tatuses for the company.",
3129 "items": {
3130 "$ref": "SpecializationStatus"
3131 },
3132 "type": "array"
3133 },
3134 "phoneNumber": {
3135 "description": "The phone number for the company's primary a ddress.",
3136 "type": "string"
3137 },
3138 "website": {
3139 "description": "The website URL for this company.",
3140 "type": "string"
3141 },
3142 "primaryCountryCode": {
3143 "description": "The primary country code of the company.",
3144 "type": "string"
3145 },
3146 "companyId": {
3147 "description": "The ID of the company. There may be no id if this is a\npending company.5",
3148 "type": "string"
3149 },
3150 "primaryLanguageCode": {
3151 "description": "The primary language code of the company.",
3152 "type": "string"
3153 },
3154 "logoUrl": {
3155 "description": "A URL to a profile photo, e.g. a G+ profile photo.",
3156 "type": "string"
3157 }
3158 },
3159 "type": "object"
3160 },
3161 "Date": {
3162 "description": "Represents a whole calendar date, e.g. date of birth . The time of day and\ntime zone are either specified elsewhere or are not signi ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b e 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independe nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
3163 "id": "Date",
3164 "properties": {
3165 "day": {
3166 "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not s ignificant.",
3167 "format": "int32",
3168 "type": "integer"
3169 },
3170 "year": {
3171 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without\na year.",
3172 "format": "int32",
3173 "type": "integer"
3174 },
3175 "month": {
3176 "description": "Month of year. Must be from 1 to 12.",
3177 "format": "int32",
3178 "type": "integer"
3179 }
3180 },
3181 "type": "object"
3182 },
3183 "Empty": {
3184 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
3185 "id": "Empty",
3186 "properties": {},
3187 "type": "object"
3188 },
3189 "TrafficSource": {
3190 "description": "Source of traffic for the current request.",
3191 "id": "TrafficSource",
3192 "properties": {
3193 "trafficSourceId": {
3194 "description": "Identifier to indicate where the traffic com es from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
3195 "type": "string"
3196 },
3197 "trafficSubId": {
3198 "description": "Second level identifier to indicate where th e traffic comes from.\nAn identifier has multiple letters created by a team whic h redirected the\ntraffic to us.",
3199 "type": "string"
3200 }
3201 },
3202 "type": "object"
3203 },
3204 "RequestMetadata": {
3205 "description": "Common data that is in each API request.",
3206 "id": "RequestMetadata",
3207 "properties": {
3208 "locale": {
3209 "description": "Locale to use for the current request.",
3210 "type": "string"
3211 },
3212 "partnersSessionId": {
3213 "description": "Google Partners session ID.",
3214 "type": "string"
3215 },
3216 "userOverrides": {
3217 "$ref": "UserOverrides",
3218 "description": "Values to use instead of the user's respecti ve defaults for the current\nrequest. These are only honored by whitelisted prod ucts."
3219 },
3220 "trafficSource": {
3221 "$ref": "TrafficSource",
3222 "description": "Source of traffic for the current request."
3223 },
3224 "experimentIds": {
3225 "description": "Experiment IDs the current request belongs t o.",
3226 "items": {
3227 "type": "string"
3228 },
3229 "type": "array"
3230 }
3231 },
3232 "type": "object"
3233 },
3234 "CreateLeadRequest": {
3235 "description": "Request message for CreateLead.",
3236 "id": "CreateLeadRequest",
3237 "properties": {
3238 "requestMetadata": {
3239 "$ref": "RequestMetadata",
3240 "description": "Current request metadata."
3241 },
3242 "recaptchaChallenge": {
3243 "$ref": "RecaptchaChallenge",
3244 "description": "<a href=\"https://www.google.com/recaptcha/\ ">reCaptcha</a> challenge info."
3245 },
3246 "lead": {
3247 "$ref": "Lead",
3248 "description": "The lead resource. The `LeadType` must not b e `LEAD_TYPE_UNSPECIFIED`\nand either `email` or `phone_number` must be provided ."
3249 }
3250 },
3251 "type": "object"
3252 },
3253 "EventData": {
3254 "description": "Key value data pair for an event.",
3255 "id": "EventData",
3256 "properties": {
3257 "values": {
3258 "description": "Data values.",
3259 "items": {
3260 "type": "string"
3261 },
3262 "type": "array"
3263 },
3264 "key": {
3265 "description": "Data type.",
3266 "enum": [
3267 "EVENT_DATA_TYPE_UNSPECIFIED",
3268 "ACTION",
3269 "AGENCY_ID",
3270 "AGENCY_NAME",
3271 "AGENCY_PHONE_NUMBER",
3272 "AGENCY_WEBSITE",
3273 "BUDGET",
3274 "CENTER_POINT",
3275 "CERTIFICATION",
3276 "COMMENT",
3277 "COUNTRY",
3278 "CURRENCY",
3279 "CURRENTLY_VIEWED_AGENCY_ID",
3280 "DISTANCE",
3281 "DISTANCE_TYPE",
3282 "EXAM",
3283 "HISTORY_TOKEN",
3284 "ID",
3285 "INDUSTRY",
3286 "INSIGHT_TAG",
3287 "LANGUAGE",
3288 "LOCATION",
3289 "MARKETING_OPT_IN",
3290 "QUERY",
3291 "SEARCH_START_INDEX",
3292 "SERVICE",
3293 "SHOW_VOW",
3294 "SOLUTION",
3295 "TRAFFIC_SOURCE_ID",
3296 "TRAFFIC_SUB_ID",
3297 "VIEW_PORT",
3298 "WEBSITE",
3299 "DETAILS",
3300 "EXPERIMENT_ID",
3301 "GPS_MOTIVATION",
3302 "URL",
3303 "ELEMENT_FOCUS",
3304 "PROGRESS"
3305 ],
3306 "enumDescriptions": [
3307 "Unchosen.",
3308 "Action data.",
3309 "Agency ID data.",
3310 "Agency name data.",
3311 "Agency phone number data.",
3312 "Agency website data.",
3313 "Budget data.",
3314 "Center-point data.",
3315 "Certification data.",
3316 "Comment data.",
3317 "Country data.",
3318 "Currency data.",
3319 "Currently viewed agency ID data.",
3320 "Distance data.",
3321 "Distance type data.",
3322 "Exam data.",
3323 "History token data.",
3324 "Identifier data.",
3325 "Industry data.",
3326 "Insight tag data.",
3327 "Language data.",
3328 "Location data.",
3329 "Marketing opt-in data.",
3330 "Query data.",
3331 "Search start index data.",
3332 "Service data.",
3333 "Show vow data.",
3334 "Solution data.",
3335 "Traffic source ID data.",
3336 "Traffic sub ID data.",
3337 "Viewport data.",
3338 "Website data.",
3339 "Details data.",
3340 "Experiment ID data.",
3341 "Google Partner Search motivation data.",
3342 "URL data.",
3343 "Element we wanted user to focus on.",
3344 "Progress when viewing an item \\[0-100\\]."
3345 ],
3346 "type": "string"
3347 }
3348 },
3349 "type": "object"
3350 },
3351 "ExamStatus": {
3352 "description": "A user's information on a specific exam.",
3353 "id": "ExamStatus",
3354 "properties": {
3355 "warning": {
3356 "description": "Whether this exam is in the state of warning .",
3357 "type": "boolean"
3358 },
3359 "expiration": {
3360 "description": "Date this exam is due to expire.",
3361 "format": "google-datetime",
3362 "type": "string"
3363 },
3364 "lastPassed": {
3365 "description": "The date the user last passed this exam.",
3366 "format": "google-datetime",
3367 "type": "string"
3368 },
3369 "examType": {
3370 "description": "The type of the exam.",
3371 "enum": [
3372 "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
3373 "CET_ADWORDS_FUNDAMENTALS",
3374 "CET_ADWORDS_ADVANCED_SEARCH",
3375 "CET_ADWORDS_ADVANCED_DISPLAY",
3376 "CET_VIDEO_ADS",
3377 "CET_DOUBLECLICK",
3378 "CET_ANALYTICS",
3379 "CET_SHOPPING",
3380 "CET_MOBILE",
3381 "CET_DIGITAL_SALES",
3382 "CET_MOBILE_SITES"
3383 ],
3384 "enumDescriptions": [
3385 "Unchosen.",
3386 "Adwords Fundamentals exam.",
3387 "AdWords advanced search exam.",
3388 "AdWords advanced display exam.",
3389 "VideoAds exam.",
3390 "DoubleClick exam.",
3391 "Analytics exam.",
3392 "Shopping exam.",
3393 "Mobile exam.",
3394 "Digital Sales exam.",
3395 "Mobile Sites exam."
3396 ],
3397 "type": "string"
3398 },
3399 "passed": {
3400 "description": "Whether this exam has been passed and not ex pired.",
3401 "type": "boolean"
3402 },
3403 "taken": {
3404 "description": "The date the user last taken this exam.",
3405 "format": "google-datetime",
3406 "type": "string"
3407 }
3408 },
3409 "type": "object"
3410 },
3411 "ListOffersResponse": {
3412 "description": "Response for ListOffer.",
3413 "id": "ListOffersResponse",
3414 "properties": {
3415 "noOfferReason": {
3416 "description": "Reason why no Offers are available.",
3417 "enum": [
3418 "NO_OFFER_REASON_UNSPECIFIED",
3419 "NO_OFFER_REASON_NO_MCC",
3420 "NO_OFFER_REASON_LIMIT_REACHED",
3421 "NO_OFFER_REASON_INELIGIBLE"
3422 ],
3423 "enumDescriptions": [
3424 "Unset.",
3425 "Not an MCC.",
3426 "Offer limit has been reached.",
3427 "Ineligible for offers."
3428 ],
3429 "type": "string"
3430 },
3431 "availableOffers": {
3432 "description": "Available Offers to be distributed.",
3433 "items": {
3434 "$ref": "AvailableOffer"
3435 },
3436 "type": "array"
3437 },
3438 "responseMetadata": {
3439 "$ref": "ResponseMetadata",
3440 "description": "Current response metadata."
3441 }
3442 },
3443 "type": "object"
3444 },
3445 "CountryOfferInfo": {
3446 "description": "Offer info by country.",
3447 "id": "CountryOfferInfo",
3448 "properties": {
3449 "getYAmount": {
3450 "description": "(localized) Get Y amount for that country's offer.",
3451 "type": "string"
3452 },
3453 "spendXAmount": {
3454 "description": "(localized) Spend X amount for that country' s offer.",
3455 "type": "string"
3456 },
3457 "offerCountryCode": {
3458 "description": "Country code for which offer codes may be re quested.",
3459 "type": "string"
3460 },
3461 "offerType": {
3462 "description": "Type of offer country is eligible for.",
3463 "enum": [
3464 "OFFER_TYPE_UNSPECIFIED",
3465 "OFFER_TYPE_SPEND_X_GET_Y",
3466 "OFFER_TYPE_VIDEO",
3467 "OFFER_TYPE_SPEND_MATCH"
3468 ],
3469 "enumDescriptions": [
3470 "Unset.",
3471 "AdWords spend X get Y.",
3472 "Youtube video.",
3473 "Spend Match up to Y."
3474 ],
3475 "type": "string"
3476 }
3477 },
3478 "type": "object"
3479 },
3480 "ListCompaniesResponse": {
3481 "description": "Response message for\nListCompanies.",
3482 "id": "ListCompaniesResponse",
3483 "properties": {
3484 "nextPageToken": {
3485 "description": "A token to retrieve next page of results.\nP ass this value in the `ListCompaniesRequest.page_token` field in the\nsubsequent call to\nListCompanies to retrieve the\nnext page of results.",
3486 "type": "string"
3487 },
3488 "responseMetadata": {
3489 "$ref": "ResponseMetadata",
3490 "description": "Current response metadata."
3491 },
3492 "companies": {
3493 "description": "The list of companies.",
3494 "items": {
3495 "$ref": "Company"
3496 },
3497 "type": "array"
3498 }
3499 },
3500 "type": "object"
3501 },
3502 "OfferCustomer": {
3503 "description": "Customers qualified for an offer.",
3504 "id": "OfferCustomer",
3505 "properties": {
3506 "adwordsUrl": {
3507 "description": "URL to the customer's AdWords page.",
3508 "type": "string"
3509 },
3510 "countryCode": {
3511 "description": "Country code of the customer.",
3512 "type": "string"
3513 },
3514 "externalCid": {
3515 "description": "External CID for the customer.",
3516 "format": "int64",
3517 "type": "string"
3518 },
3519 "offerType": {
3520 "description": "Type of the offer",
3521 "enum": [
3522 "OFFER_TYPE_UNSPECIFIED",
3523 "OFFER_TYPE_SPEND_X_GET_Y",
3506 "OFFER_TYPE_VIDEO", 3524 "OFFER_TYPE_VIDEO",
3507 "OFFER_TYPE_SPEND_MATCH" 3525 "OFFER_TYPE_SPEND_MATCH"
3508 ], 3526 ],
3509 "enumDescriptions": [ 3527 "enumDescriptions": [
3510 "Unset.", 3528 "Unset.",
3511 "AdWords spend X get Y.", 3529 "AdWords spend X get Y.",
3512 "Youtube video.", 3530 "Youtube video.",
3513 "Spend Match up to Y." 3531 "Spend Match up to Y."
3514 ], 3532 ],
3515 "type": "string" 3533 "type": "string"
3516 }, 3534 },
3517 "maxAccountAge": { 3535 "eligibilityDaysLeft": {
3518 "description": "The maximum age of an account [in days] to b e eligible.", 3536 "description": "Days the customer is still eligible.",
3519 "format": "int32", 3537 "format": "int32",
3520 "type": "integer" 3538 "type": "integer"
3521 }, 3539 },
3522 "qualifiedCustomer": { 3540 "creationTime": {
3523 "description": "Customers who qualify for this offer.", 3541 "description": "Time the customer was created.",
3524 "items": { 3542 "format": "google-datetime",
3525 "$ref": "OfferCustomer"
3526 },
3527 "type": "array"
3528 },
3529 "terms": {
3530 "description": "Terms of the offer.",
3531 "type": "string" 3543 "type": "string"
3532 }, 3544 },
3533 "showSpecialOfferCopy": { 3545 "getYAmount": {
3534 "description": "Should special text be shown on the offers p age.", 3546 "description": "Formatted Get Y amount with currency code.",
3535 "type": "boolean"
3536 },
3537 "available": {
3538 "description": "The number of codes for this offer that are available for distribution.",
3539 "format": "int32",
3540 "type": "integer"
3541 },
3542 "description": {
3543 "description": "Description of the offer.",
3544 "type": "string"
3545 },
3546 "offerLevel": {
3547 "description": "Level of this offer.",
3548 "enum": [
3549 "OFFER_LEVEL_UNSPECIFIED",
3550 "OFFER_LEVEL_DENY_PROBLEM",
3551 "OFFER_LEVEL_DENY_CONTRACT",
3552 "OFFER_LEVEL_MANUAL",
3553 "OFFER_LEVEL_LIMIT_0",
3554 "OFFER_LEVEL_LIMIT_5",
3555 "OFFER_LEVEL_LIMIT_15",
3556 "OFFER_LEVEL_LIMIT_50"
3557 ],
3558 "enumDescriptions": [
3559 "Unset.",
3560 "Users/Agencies that have no offers because of a problem .",
3561 "Users/Agencies that have no offers due to contractural agreements.",
3562 "Users/Agencies that have a manually-configured limit.",
3563 "Some Agencies don't get any offers.",
3564 "Basic level gets 5 per month.",
3565 "Agencies with adequate AHI and spend get 15/month.",
3566 "Badged partners (even in grace) get 50 per month."
3567 ],
3568 "type": "string" 3547 "type": "string"
3569 }, 3548 },
3570 "name": { 3549 "name": {
3571 "description": "Name of the offer.", 3550 "description": "Name of the customer.",
3551 "type": "string"
3552 },
3553 "spendXAmount": {
3554 "description": "Formatted Spend X amount with currency code. ",
3572 "type": "string" 3555 "type": "string"
3573 } 3556 }
3574 }, 3557 },
3575 "type": "object" 3558 "type": "object"
3576 }, 3559 },
3577 "LatLng": { 3560 "CertificationStatus": {
3578 "description": "An object representing a latitude/longitude pair. Th is is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n<a href=\"http ://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\">WGS84\nstandard</a>. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n \n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees long itude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r > 180.0 or (r == 180.0 and q <= -1.0):\n return r - 360.0\n retur n r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], resp ectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 36 0, NormalizeLongitude(longitude)\n else:\n return 180 - r, Normalize Longitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLo ngitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == Normali zeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\ n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10. 0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng (-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n as sert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == N ormalizeLatLng(-270.0, 10.0)", 3561 "description": "Google Partners certification status.",
3579 "id": "LatLng", 3562 "id": "CertificationStatus",
3580 "properties": { 3563 "properties": {
3581 "longitude": { 3564 "examStatuses": {
3582 "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", 3565 "description": "List of certification exam statuses.",
3583 "format": "double", 3566 "items": {
3584 "type": "number" 3567 "$ref": "CertificationExamStatus"
3568 },
3569 "type": "array"
3585 }, 3570 },
3586 "latitude": { 3571 "type": {
3587 "description": "The latitude in degrees. It must be in the r ange [-90.0, +90.0].", 3572 "description": "The type of the certification.",
3588 "format": "double", 3573 "enum": [
3589 "type": "number" 3574 "CERTIFICATION_TYPE_UNSPECIFIED",
3575 "CT_ADWORDS",
3576 "CT_YOUTUBE",
3577 "CT_VIDEOADS",
3578 "CT_ANALYTICS",
3579 "CT_DOUBLECLICK",
3580 "CT_SHOPPING",
3581 "CT_MOBILE",
3582 "CT_DIGITAL_SALES",
3583 "CT_ADWORDS_SEARCH",
3584 "CT_ADWORDS_DISPLAY",
3585 "CT_MOBILE_SITES"
3586 ],
3587 "enumDescriptions": [
3588 "Unchosen.",
3589 "AdWords certified.",
3590 "YouTube certified.",
3591 "VideoAds certified.",
3592 "Analytics certified.",
3593 "DoubleClick certified.",
3594 "Shopping certified.",
3595 "Mobile certified.",
3596 "Digital sales certified.",
3597 "AdWords Search certified.",
3598 "AdWords Display certified.",
3599 "Mobile Sites certified."
3600 ],
3601 "type": "string"
3602 },
3603 "userCount": {
3604 "description": "Number of people who are certified,",
3605 "format": "int32",
3606 "type": "integer"
3607 },
3608 "isCertified": {
3609 "description": "Whether certification is passing.",
3610 "type": "boolean"
3590 } 3611 }
3591 }, 3612 },
3592 "type": "object" 3613 "type": "object"
3593 },
3594 "Money": {
3595 "description": "Represents an amount of money with its currency type .",
3596 "id": "Money",
3597 "properties": {
3598 "currencyCode": {
3599 "description": "The 3-letter currency code defined in ISO 42 17.",
3600 "type": "string"
3601 },
3602 "nanos": {
3603 "description": "Number of nano (10^-9) units of the amount.\ nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negativ e or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000 ,000.",
3604 "format": "int32",
3605 "type": "integer"
3606 },
3607 "units": {
3608 "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
3609 "format": "int64",
3610 "type": "string"
3611 }
3612 },
3613 "type": "object"
3614 } 3614 }
3615 }, 3615 },
3616 "servicePath": "", 3616 "servicePath": "",
3617 "title": "Google Partners API", 3617 "title": "Google Partners API",
3618 "version": "v2" 3618 "version": "v2"
3619 } 3619 }
OLDNEW
« no previous file with comments | « discovery/googleapis/oauth2__v2.json ('k') | discovery/googleapis/people__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698