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

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/partners__v2.json

Issue 2973303002: Api-Roll 51: 2017-07-10 (Closed)
Patch Set: Created 3 years, 5 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 side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/monitoring__v3.json ('k') | discovery/googleapis/people__v1.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/partners__v2.json
diff --git a/discovery/googleapis/partners__v2.json b/discovery/googleapis/partners__v2.json
index e82adf9e28a58a0358b2182eed553dd2b200aa3b..30980bb7c4cbbbd5c1dd4b79472783ab006df2f7 100644
--- a/discovery/googleapis/partners__v2.json
+++ b/discovery/googleapis/partners__v2.json
@@ -16,6 +16,27 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "location": "query",
+ "type": "string"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
@@ -80,44 +101,65 @@
"description": "OAuth access token.",
"location": "query",
"type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query",
- "type": "string"
- },
- "pp": {
- "default": "true",
- "description": "Pretty-print response.",
- "location": "query",
- "type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "location": "query",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
}
},
"protocol": "rest",
"resources": {
- "leads": {
+ "userEvents": {
"methods": {
- "list": {
- "description": "Lists advertiser leads for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
- "httpMethod": "GET",
- "id": "partners.leads.list",
+ "log": {
+ "description": "Logs a user event.",
+ "httpMethod": "POST",
+ "id": "partners.userEvents.log",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v2/userEvents:log",
+ "request": {
+ "$ref": "LogUserEventRequest"
+ },
+ "response": {
+ "$ref": "LogUserEventResponse"
+ }
+ }
+ }
+ },
+ "clientMessages": {
+ "methods": {
+ "log": {
+ "description": "Logs a generic message from the client, such as\n`Failed to render component`, `Profile page is running slow`,\n`More than 500 users have accessed this result.`, etc.",
+ "httpMethod": "POST",
+ "id": "partners.clientMessages.log",
"parameterOrder": [],
+ "parameters": {},
+ "path": "v2/clientMessages:log",
+ "request": {
+ "$ref": "LogMessageRequest"
+ },
+ "response": {
+ "$ref": "LogMessageResponse"
+ }
+ }
+ }
+ },
+ "exams": {
+ "methods": {
+ "getToken": {
+ "description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System",
+ "httpMethod": "GET",
+ "id": "partners.exams.getToken",
+ "parameterOrder": [
+ "examType"
+ ],
"parameters": {
- "pageSize": {
- "description": "Requested page size. Server may return fewer leads than requested.\nIf unspecified, server picks an appropriate default.",
- "format": "int32",
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"location": "query",
- "type": "integer"
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "location": "query",
+ "type": "string"
},
"requestMetadata.trafficSource.trafficSourceId": {
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
@@ -140,16 +182,46 @@
"repeated": true,
"type": "string"
},
- "orderBy": {
- "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
- "location": "query",
- "type": "string"
- },
"requestMetadata.trafficSource.trafficSubId": {
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
"type": "string"
},
+ "examType": {
+ "description": "The exam type we are requesting a token for.",
+ "enum": [
+ "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
+ "CET_ADWORDS_FUNDAMENTALS",
+ "CET_ADWORDS_ADVANCED_SEARCH",
+ "CET_ADWORDS_ADVANCED_DISPLAY",
+ "CET_VIDEO_ADS",
+ "CET_DOUBLECLICK",
+ "CET_ANALYTICS",
+ "CET_SHOPPING",
+ "CET_MOBILE",
+ "CET_DIGITAL_SALES",
+ "CET_MOBILE_SITES"
+ ],
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/exams/{examType}/token",
+ "response": {
+ "$ref": "ExamToken"
+ }
+ }
+ }
+ },
+ "leads": {
+ "methods": {
+ "list": {
+ "description": "Lists advertiser leads for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
+ "httpMethod": "GET",
+ "id": "partners.leads.list",
+ "parameterOrder": [],
+ "parameters": {
"requestMetadata.userOverrides.userId": {
"description": "Logged-in user ID to impersonate instead of the user's ID.",
"location": "query",
@@ -164,6 +236,43 @@
"description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListLeadsResponse.next_page_token`\nreturned from the previous call to\nListLeads.",
"location": "query",
"type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. Server may return fewer leads than requested.\nIf unspecified, server picks an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "location": "query",
+ "type": "string"
}
},
"path": "v2/leads",
@@ -181,16 +290,6 @@
"id": "partners.offers.list",
"parameterOrder": [],
"parameters": {
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "location": "query",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
- "location": "query",
- "type": "string"
- },
"requestMetadata.trafficSource.trafficSourceId": {
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
@@ -216,6 +315,16 @@
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
"type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "location": "query",
+ "type": "string"
}
},
"path": "v2/offers",
@@ -233,13 +342,13 @@
"id": "partners.offers.history.list",
"parameterOrder": [],
"parameters": {
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"location": "query",
"type": "string"
},
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"location": "query",
"type": "string"
},
@@ -280,13 +389,13 @@
"repeated": true,
"type": "string"
},
- "orderBy": {
- "description": "Comma-separated list of fields to order by, e.g.: \"foo,bar,baz\".\nUse \"foo desc\" to sort descending.\nList of valid field names is: name, offer_code, expiration_time, status,\n last_modified_time, sender_name, creation_time, country_code,\n offer_type.",
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
"type": "string"
},
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "orderBy": {
+ "description": "Comma-separated list of fields to order by, e.g.: \"foo,bar,baz\".\nUse \"foo desc\" to sort descending.\nList of valid field names is: name, offer_code, expiration_time, status,\n last_modified_time, sender_name, creation_time, country_code,\n offer_type.",
"location": "query",
"type": "string"
}
@@ -308,11 +417,6 @@
"id": "partners.userStates.list",
"parameterOrder": [],
"parameters": {
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "location": "query",
- "type": "string"
- },
"requestMetadata.userOverrides.ipAddress": {
"description": "IP address to use instead of the user's geo-located IP address.",
"location": "query",
@@ -329,13 +433,13 @@
"location": "query",
"type": "string"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"location": "query",
"type": "string"
},
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"location": "query",
"type": "string"
},
@@ -343,6 +447,11 @@
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
"type": "string"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "location": "query",
+ "type": "string"
}
},
"path": "v2/userStates",
@@ -423,6 +532,16 @@
"id": "partners.getPartnersstatus",
"parameterOrder": [],
"parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "location": "query",
+ "type": "string"
+ },
"requestMetadata.trafficSource.trafficSourceId": {
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
@@ -448,16 +567,6 @@
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
"type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
- "location": "query",
- "type": "string"
- },
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "location": "query",
- "type": "string"
}
},
"path": "v2/partnersstatus",
@@ -471,16 +580,6 @@
"id": "partners.updateLeads",
"parameterOrder": [],
"parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "location": "query",
- "type": "string"
- },
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "location": "query",
- "type": "string"
- },
"requestMetadata.userOverrides.ipAddress": {
"description": "IP address to use instead of the user's geo-located IP address.",
"location": "query",
@@ -503,13 +602,23 @@
"location": "query",
"type": "string"
},
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "location": "query",
+ "type": "string"
+ },
"requestMetadata.partnersSessionId": {
"description": "Google Partners session ID.",
"location": "query",
"type": "string"
},
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
"location": "query",
"type": "string"
}
@@ -528,45 +637,45 @@
"id": "partners.updateCompanies",
"parameterOrder": [],
"parameters": {
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"location": "query",
"type": "string"
},
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.",
- "format": "google-fieldmask",
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"location": "query",
"type": "string"
},
- "requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
- "repeated": true,
"type": "string"
},
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
"location": "query",
"type": "string"
},
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
"location": "query",
"type": "string"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.",
+ "format": "google-fieldmask",
"location": "query",
"type": "string"
},
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
"location": "query",
+ "repeated": true,
"type": "string"
},
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
"type": "string"
}
@@ -581,46 +690,26 @@
}
}
},
- "companies": {
+ "users": {
"methods": {
- "get": {
- "description": "Gets a company.",
- "httpMethod": "GET",
- "id": "partners.companies.get",
+ "deleteCompanyRelation": {
+ "description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
+ "httpMethod": "DELETE",
+ "id": "partners.users.deleteCompanyRelation",
"parameterOrder": [
- "companyId"
+ "userId"
],
"parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "location": "query",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "location": "query",
- "type": "string"
- },
- "companyId": {
- "description": "The ID of the company to retrieve.",
- "location": "path",
- "required": true,
- "type": "string"
- },
"requestMetadata.experimentIds": {
"description": "Experiment IDs the current request belongs to.",
"location": "query",
"repeated": true,
"type": "string"
},
- "currencyCode": {
- "description": "If the company's budget is in a different currency code than this one, then\nthe converted budget is converted to this currency code.",
- "location": "query",
- "type": "string"
- },
- "orderBy": {
- "description": "How to order addresses within the returned 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.",
- "location": "query",
+ "userId": {
+ "description": "The ID of the user. Can be set to <code>me</code> to mean\nthe currently authenticated user.",
+ "location": "path",
+ "required": true,
"type": "string"
},
"requestMetadata.trafficSource.trafficSubId": {
@@ -638,12 +727,8 @@
"location": "query",
"type": "string"
},
- "view": {
- "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
- "enum": [
- "COMPANY_VIEW_UNSPECIFIED",
- "CV_GOOGLE_PARTNER_SEARCH"
- ],
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
"type": "string"
},
@@ -652,32 +737,29 @@
"location": "query",
"type": "string"
},
- "address": {
- "description": "The address to use for sorting the company's addresses by proximity.\nIf not given, the geo-located address of the request is used.\nUsed when order_by is set.",
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
"location": "query",
"type": "string"
}
},
- "path": "v2/companies/{companyId}",
+ "path": "v2/users/{userId}/companyRelation",
"response": {
- "$ref": "GetCompanyResponse"
+ "$ref": "Empty"
}
},
- "list": {
- "description": "Lists companies.",
- "httpMethod": "GET",
- "id": "partners.companies.list",
- "parameterOrder": [],
+ "createCompanyRelation": {
+ "description": "Creates a user's company relation. Affiliates the user to a company.",
+ "httpMethod": "PUT",
+ "id": "partners.users.createCompanyRelation",
+ "parameterOrder": [
+ "userId"
+ ],
"parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "location": "query",
- "type": "string"
- },
- "maxMonthlyBudget.units": {
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "format": "int64",
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
"location": "query",
+ "repeated": true,
"type": "string"
},
"requestMetadata.trafficSource.trafficSubId": {
@@ -685,74 +767,83 @@
"location": "query",
"type": "string"
},
- "minMonthlyBudget.nanos": {
- "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 negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "format": "int32",
+ "userId": {
+ "description": "The ID of the user. Can be set to <code>me</code> to mean\nthe currently authenticated user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"location": "query",
- "type": "integer"
+ "type": "string"
},
"requestMetadata.partnersSessionId": {
"description": "Google Partners session ID.",
"location": "query",
"type": "string"
},
- "companyName": {
- "description": "Company name to search for.",
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
"type": "string"
},
- "pageToken": {
- "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListCompaniesResponse.next_page_token`\nreturned from the previous call to\nListCompanies.",
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
"location": "query",
"type": "string"
},
- "industries": {
- "description": "List of industries the company can help with.",
- "enum": [
- "INDUSTRY_UNSPECIFIED",
- "I_AUTOMOTIVE",
- "I_BUSINESS_TO_BUSINESS",
- "I_CONSUMER_PACKAGED_GOODS",
- "I_EDUCATION",
- "I_FINANCE",
- "I_HEALTHCARE",
- "I_MEDIA_AND_ENTERTAINMENT",
- "I_RETAIL",
- "I_TECHNOLOGY",
- "I_TRAVEL"
- ],
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2/users/{userId}/companyRelation",
+ "request": {
+ "$ref": "CompanyRelation"
+ },
+ "response": {
+ "$ref": "CompanyRelation"
+ }
+ },
+ "get": {
+ "description": "Gets a user.",
+ "httpMethod": "GET",
+ "id": "partners.users.get",
+ "parameterOrder": [
+ "userId"
+ ],
+ "parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"location": "query",
- "repeated": true,
"type": "string"
},
- "websiteUrl": {
- "description": "Website URL that will help to find a better matched company.\n.",
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"location": "query",
"type": "string"
},
- "gpsMotivations": {
- "description": "List of reasons for using Google Partner Search to get companies.",
+ "userView": {
+ "description": "Specifies what parts of the user information to return.",
"enum": [
- "GPS_MOTIVATION_UNSPECIFIED",
- "GPSM_HELP_WITH_ADVERTISING",
- "GPSM_HELP_WITH_WEBSITE",
- "GPSM_NO_WEBSITE"
+ "BASIC",
+ "PROFILE",
+ "PUBLIC_PROFILE"
],
"location": "query",
- "repeated": true,
"type": "string"
},
- "languageCodes": {
- "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 Identifying Languages\").",
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
- "repeated": true,
"type": "string"
},
- "pageSize": {
- "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
- "format": "int32",
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
"location": "query",
- "type": "integer"
+ "type": "string"
},
"requestMetadata.userOverrides.ipAddress": {
"description": "IP address to use instead of the user's geo-located IP address.",
@@ -765,35 +856,89 @@
"repeated": true,
"type": "string"
},
- "orderBy": {
- "description": "How to order addresses within the returned companies. 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.",
- "location": "query",
- "type": "string"
- },
- "specializations": {
- "description": "List of specializations that the returned agencies should provide. If this\nis not empty, any returned agency must have at least one of these\nspecializations, or one of the services in the \"services\" field.",
- "enum": [
- "BADGE_SPECIALIZATION_UNKNOWN",
- "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
- "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
- "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
- "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
- "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
- ],
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxMonthlyBudget.currencyCode": {
- "description": "The 3-letter currency code defined in ISO 4217.",
- "location": "query",
+ "userId": {
+ "description": "Identifier of the user. Can be set to <code>me</code> to mean the currently\nauthenticated user.",
+ "location": "path",
+ "required": true,
"type": "string"
},
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
"type": "string"
- },
+ }
+ },
+ "path": "v2/users/{userId}",
+ "response": {
+ "$ref": "User"
+ }
+ },
+ "updateProfile": {
+ "description": "Updates a user's profile. A user can only update their own profile and\nshould only be called within the context of a logged in user.",
+ "httpMethod": "PATCH",
+ "id": "partners.users.updateProfile",
+ "parameterOrder": [],
+ "parameters": {
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v2/users/profile",
+ "request": {
+ "$ref": "UserProfile"
+ },
+ "response": {
+ "$ref": "UserProfile"
+ }
+ }
+ }
+ },
+ "companies": {
+ "methods": {
+ "list": {
+ "description": "Lists companies.",
+ "httpMethod": "GET",
+ "id": "partners.companies.list",
+ "parameterOrder": [],
+ "parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "location": "query",
+ "type": "string"
+ },
"minMonthlyBudget.currencyCode": {
"description": "The 3-letter currency code defined in ISO 4217.",
"location": "query",
@@ -808,13 +953,13 @@
"location": "query",
"type": "string"
},
- "address": {
- "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used.",
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
"location": "query",
"type": "string"
},
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
+ "address": {
+ "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used.",
"location": "query",
"type": "string"
},
@@ -844,142 +989,91 @@
"location": "query",
"repeated": true,
"type": "string"
- }
- },
- "path": "v2/companies",
- "response": {
- "$ref": "ListCompaniesResponse"
- }
- }
- },
- "resources": {
- "leads": {
- "methods": {
- "create": {
- "description": "Creates an advertiser lead for the given company ID.",
- "httpMethod": "POST",
- "id": "partners.companies.leads.create",
- "parameterOrder": [
- "companyId"
- ],
- "parameters": {
- "companyId": {
- "description": "The ID of the company to contact.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v2/companies/{companyId}/leads",
- "request": {
- "$ref": "CreateLeadRequest"
- },
- "response": {
- "$ref": "CreateLeadResponse"
- }
- }
- }
- }
- }
- },
- "users": {
- "methods": {
- "get": {
- "description": "Gets a user.",
- "httpMethod": "GET",
- "id": "partners.users.get",
- "parameterOrder": [
- "userId"
- ],
- "parameters": {
+ },
"requestMetadata.trafficSource.trafficSourceId": {
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
"type": "string"
},
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
+ "maxMonthlyBudget.units": {
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "format": "int64",
"location": "query",
"type": "string"
},
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
"type": "string"
},
- "requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
+ "minMonthlyBudget.nanos": {
+ "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 negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "format": "int32",
"location": "query",
- "repeated": true,
- "type": "string"
- },
- "userId": {
- "description": "Identifier of the user. Can be set to <code>me</code> to mean the currently\nauthenticated user.",
- "location": "path",
- "required": true,
- "type": "string"
+ "type": "integer"
},
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"location": "query",
"type": "string"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "companyName": {
+ "description": "Company name to search for.",
"location": "query",
"type": "string"
},
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "pageToken": {
+ "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListCompaniesResponse.next_page_token`\nreturned from the previous call to\nListCompanies.",
"location": "query",
"type": "string"
},
- "userView": {
- "description": "Specifies what parts of the user information to return.",
+ "industries": {
+ "description": "List of industries the company can help with.",
"enum": [
- "BASIC",
- "PROFILE",
- "PUBLIC_PROFILE"
+ "INDUSTRY_UNSPECIFIED",
+ "I_AUTOMOTIVE",
+ "I_BUSINESS_TO_BUSINESS",
+ "I_CONSUMER_PACKAGED_GOODS",
+ "I_EDUCATION",
+ "I_FINANCE",
+ "I_HEALTHCARE",
+ "I_MEDIA_AND_ENTERTAINMENT",
+ "I_RETAIL",
+ "I_TECHNOLOGY",
+ "I_TRAVEL"
],
"location": "query",
- "type": "string"
- }
- },
- "path": "v2/users/{userId}",
- "response": {
- "$ref": "User"
- }
- },
- "updateProfile": {
- "description": "Updates a user's profile. A user can only update their own profile and\nshould only be called within the context of a logged in user.",
- "httpMethod": "PATCH",
- "id": "partners.users.updateProfile",
- "parameterOrder": [],
- "parameters": {
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "location": "query",
+ "repeated": true,
"type": "string"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "websiteUrl": {
+ "description": "Website URL that will help to find a better matched company.\n.",
"location": "query",
"type": "string"
},
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "gpsMotivations": {
+ "description": "List of reasons for using Google Partner Search to get companies.",
+ "enum": [
+ "GPS_MOTIVATION_UNSPECIFIED",
+ "GPSM_HELP_WITH_ADVERTISING",
+ "GPSM_HELP_WITH_WEBSITE",
+ "GPSM_NO_WEBSITE"
+ ],
"location": "query",
+ "repeated": true,
"type": "string"
},
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "languageCodes": {
+ "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 Identifying Languages\").",
"location": "query",
+ "repeated": true,
"type": "string"
},
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
+ "pageSize": {
+ "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
+ "format": "int32",
"location": "query",
- "type": "string"
+ "type": "integer"
},
"requestMetadata.userOverrides.ipAddress": {
"description": "IP address to use instead of the user's geo-located IP address.",
@@ -991,201 +1085,85 @@
"location": "query",
"repeated": true,
"type": "string"
- }
- },
- "path": "v2/users/profile",
- "request": {
- "$ref": "UserProfile"
- },
- "response": {
- "$ref": "UserProfile"
- }
- },
- "createCompanyRelation": {
- "description": "Creates a user's company relation. Affiliates the user to a company.",
- "httpMethod": "PUT",
- "id": "partners.users.createCompanyRelation",
- "parameterOrder": [
- "userId"
- ],
- "parameters": {
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "location": "query",
- "type": "string"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "orderBy": {
+ "description": "How to order addresses within the returned companies. 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.",
"location": "query",
"type": "string"
},
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "location": "query",
- "type": "string"
- },
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "location": "query",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "location": "query",
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
+ "specializations": {
+ "description": "List of specializations that the returned agencies should provide. If this\nis not empty, any returned agency must have at least one of these\nspecializations, or one of the services in the \"services\" field.",
+ "enum": [
+ "BADGE_SPECIALIZATION_UNKNOWN",
+ "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
+ "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
+ "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
+ "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
+ "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
+ ],
"location": "query",
"repeated": true,
"type": "string"
},
- "userId": {
- "description": "The ID of the user. Can be set to <code>me</code> to mean\nthe currently authenticated user.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "maxMonthlyBudget.currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
"location": "query",
"type": "string"
}
},
- "path": "v2/users/{userId}/companyRelation",
- "request": {
- "$ref": "CompanyRelation"
- },
+ "path": "v2/companies",
"response": {
- "$ref": "CompanyRelation"
+ "$ref": "ListCompaniesResponse"
}
},
- "deleteCompanyRelation": {
- "description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
- "httpMethod": "DELETE",
- "id": "partners.users.deleteCompanyRelation",
+ "get": {
+ "description": "Gets a company.",
+ "httpMethod": "GET",
+ "id": "partners.companies.get",
"parameterOrder": [
- "userId"
+ "companyId"
],
"parameters": {
- "requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
- "repeated": true,
"type": "string"
},
- "userId": {
- "description": "The ID of the user. Can be set to <code>me</code> to mean\nthe currently authenticated user.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
"location": "query",
"type": "string"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
- "location": "query",
+ "companyId": {
+ "description": "The ID of the company to retrieve.",
+ "location": "path",
+ "required": true,
"type": "string"
},
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
"location": "query",
+ "repeated": true,
"type": "string"
},
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "currencyCode": {
+ "description": "If the company's budget is in a different currency code than this one, then\nthe converted budget is converted to this currency code.",
"location": "query",
"type": "string"
},
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
+ "orderBy": {
+ "description": "How to order addresses within the returned 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.",
"location": "query",
"type": "string"
},
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v2/users/{userId}/companyRelation",
- "response": {
- "$ref": "Empty"
- }
- }
- }
- },
- "userEvents": {
- "methods": {
- "log": {
- "description": "Logs a user event.",
- "httpMethod": "POST",
- "id": "partners.userEvents.log",
- "parameterOrder": [],
- "parameters": {},
- "path": "v2/userEvents:log",
- "request": {
- "$ref": "LogUserEventRequest"
- },
- "response": {
- "$ref": "LogUserEventResponse"
- }
- }
- }
- },
- "clientMessages": {
- "methods": {
- "log": {
- "description": "Logs a generic message from the client, such as\n`Failed to render component`, `Profile page is running slow`,\n`More than 500 users have accessed this result.`, etc.",
- "httpMethod": "POST",
- "id": "partners.clientMessages.log",
- "parameterOrder": [],
- "parameters": {},
- "path": "v2/clientMessages:log",
- "request": {
- "$ref": "LogMessageRequest"
- },
- "response": {
- "$ref": "LogMessageResponse"
- }
- }
- }
- },
- "exams": {
- "methods": {
- "getToken": {
- "description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System",
- "httpMethod": "GET",
- "id": "partners.exams.getToken",
- "parameterOrder": [
- "examType"
- ],
- "parameters": {
"requestMetadata.trafficSource.trafficSubId": {
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"location": "query",
"type": "string"
},
- "examType": {
- "description": "The exam type we are requesting a token for.",
- "enum": [
- "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
- "CET_ADWORDS_FUNDAMENTALS",
- "CET_ADWORDS_ADVANCED_SEARCH",
- "CET_ADWORDS_ADVANCED_DISPLAY",
- "CET_VIDEO_ADS",
- "CET_DOUBLECLICK",
- "CET_ANALYTICS",
- "CET_SHOPPING",
- "CET_MOBILE",
- "CET_DIGITAL_SALES",
- "CET_MOBILE_SITES"
- ],
- "location": "path",
- "required": true,
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "location": "query",
"type": "string"
},
"requestMetadata.userOverrides.userId": {
@@ -1193,13 +1171,17 @@
"location": "query",
"type": "string"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "view": {
+ "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
+ "enum": [
+ "COMPANY_VIEW_UNSPECIFIED",
+ "CV_GOOGLE_PARTNER_SEARCH"
+ ],
"location": "query",
"type": "string"
},
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "address": {
+ "description": "The address to use for sorting the company's addresses by proximity.\nIf not given, the geo-located address of the request is used.\nUsed when order_by is set.",
"location": "query",
"type": "string"
},
@@ -1207,39 +1189,201 @@
"description": "Locale to use for the current request.",
"location": "query",
"type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "location": "query",
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
- "location": "query",
- "repeated": true,
- "type": "string"
}
},
- "path": "v2/exams/{examType}/token",
+ "path": "v2/companies/{companyId}",
"response": {
- "$ref": "ExamToken"
+ "$ref": "GetCompanyResponse"
+ }
+ }
+ },
+ "resources": {
+ "leads": {
+ "methods": {
+ "create": {
+ "description": "Creates an advertiser lead for the given company ID.",
+ "httpMethod": "POST",
+ "id": "partners.companies.leads.create",
+ "parameterOrder": [
+ "companyId"
+ ],
+ "parameters": {
+ "companyId": {
+ "description": "The ID of the company to contact.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v2/companies/{companyId}/leads",
+ "request": {
+ "$ref": "CreateLeadRequest"
+ },
+ "response": {
+ "$ref": "CreateLeadResponse"
+ }
+ }
}
}
}
}
},
- "revision": "20170605",
+ "revision": "20170628",
"rootUrl": "https://partners.googleapis.com/",
"schemas": {
- "AnalyticsSummary": {
- "description": "Analytics aggregated data for a `Company` for a given date range.",
- "id": "AnalyticsSummary",
+ "RecaptchaChallenge": {
+ "description": "<a href=\"https://www.google.com/recaptcha/\">reCaptcha</a> challenge info.",
+ "id": "RecaptchaChallenge",
"properties": {
- "contactsCount": {
- "description": "Aggregated number of times users contacted the `Company`\nfor given date range.",
+ "id": {
+ "description": "The ID of the reCaptcha challenge.",
+ "type": "string"
+ },
+ "response": {
+ "description": "The response to the reCaptcha challenge.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AvailableOffer": {
+ "description": "Available Offers to be distributed.",
+ "id": "AvailableOffer",
+ "properties": {
+ "name": {
+ "description": "Name of the offer.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of this offer.",
+ "format": "int64",
+ "type": "string"
+ },
+ "qualifiedCustomersComplete": {
+ "description": "Whether or not the list of qualified customers is definitely complete.",
+ "type": "boolean"
+ },
+ "countryOfferInfos": {
+ "description": "Offer info by country.",
+ "items": {
+ "$ref": "CountryOfferInfo"
+ },
+ "type": "array"
+ },
+ "offerType": {
+ "description": "Type of offer.",
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ],
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
+ "type": "string"
+ },
+ "maxAccountAge": {
+ "description": "The maximum age of an account [in days] to be eligible.",
"format": "int32",
"type": "integer"
},
+ "qualifiedCustomer": {
+ "description": "Customers who qualify for this offer.",
+ "items": {
+ "$ref": "OfferCustomer"
+ },
+ "type": "array"
+ },
+ "terms": {
+ "description": "Terms of the offer.",
+ "type": "string"
+ },
+ "showSpecialOfferCopy": {
+ "description": "Should special text be shown on the offers page.",
+ "type": "boolean"
+ },
+ "available": {
+ "description": "The number of codes for this offer that are available for distribution.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "description": {
+ "description": "Description of the offer.",
+ "type": "string"
+ },
+ "offerLevel": {
+ "description": "Level of this offer.",
+ "enum": [
+ "OFFER_LEVEL_UNSPECIFIED",
+ "OFFER_LEVEL_DENY_PROBLEM",
+ "OFFER_LEVEL_DENY_CONTRACT",
+ "OFFER_LEVEL_MANUAL",
+ "OFFER_LEVEL_LIMIT_0",
+ "OFFER_LEVEL_LIMIT_5",
+ "OFFER_LEVEL_LIMIT_15",
+ "OFFER_LEVEL_LIMIT_50"
+ ],
+ "enumDescriptions": [
+ "Unset.",
+ "Users/Agencies that have no offers because of a problem.",
+ "Users/Agencies that have no offers due to contractural agreements.",
+ "Users/Agencies that have a manually-configured limit.",
+ "Some Agencies don't get any offers.",
+ "Basic level gets 5 per month.",
+ "Agencies with adequate AHI and spend get 15/month.",
+ "Badged partners (even in grace) get 50 per month."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LatLng": {
+ "description": "An object representing a latitude/longitude pair. This 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 longitude 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 return 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], respectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(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) == NormalizeLatLng(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 assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "id": "LatLng",
+ "properties": {
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "format": "double",
+ "type": "number"
+ },
+ "longitude": {
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "Money": {
+ "description": "Represents an amount of money with its currency type.",
+ "id": "Money",
+ "properties": {
+ "units": {
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "format": "int64",
+ "type": "string"
+ },
+ "currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string"
+ },
+ "nanos": {
+ "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 negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AnalyticsSummary": {
+ "description": "Analytics aggregated data for a `Company` for a given date range.",
+ "id": "AnalyticsSummary",
+ "properties": {
"profileViewsCount": {
"description": "Aggregated number of profile views for the `Company` for given date range.",
"format": "int32",
@@ -1249,6 +1393,11 @@
"description": "Aggregated number of times users saw the `Company`\nin Google Partners Search results for given date range.",
"format": "int32",
"type": "integer"
+ },
+ "contactsCount": {
+ "description": "Aggregated number of times users contacted the `Company`\nfor given date range.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
@@ -1257,6 +1406,10 @@
"description": "Request message for\nLogClientMessage.",
"id": "LogMessageRequest",
"properties": {
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
+ },
"level": {
"description": "Message level of client message.",
"enum": [
@@ -1285,10 +1438,6 @@
},
"description": "Map of client info, such as URL, browser navigator, browser platform, etc.",
"type": "object"
- },
- "requestMetadata": {
- "$ref": "RequestMetadata",
- "description": "Current request metadata."
}
},
"type": "object"
@@ -1297,32 +1446,52 @@
"description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal).",
"id": "Lead",
"properties": {
- "languageCode": {
- "description": "Language code of the lead's language preference, as defined by\n<a href=\"https://tools.ietf.org/html/bcp47\">BCP 47</a>\n(IETF BCP 47, \"Tags for Identifying Languages\").",
+ "phoneNumber": {
+ "description": "Phone number of lead source.",
"type": "string"
},
- "websiteUrl": {
- "description": "Website URL of lead source.",
+ "adwordsCustomerId": {
+ "description": "The AdWords Customer ID of the lead.",
+ "format": "int64",
"type": "string"
},
- "state": {
- "description": "The lead's state in relation to the company.",
+ "createTime": {
+ "description": "Timestamp of when this lead was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "marketingOptIn": {
+ "description": "Whether or not the lead signed up for marketing emails",
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Type of lead.",
"enum": [
- "LEAD_STATE_UNSPECIFIED",
- "LEAD",
- "CONTACTED",
- "CLIENT",
- "OTHER"
+ "LEAD_TYPE_UNSPECIFIED",
+ "LT_GPS"
],
"enumDescriptions": [
"Unchosen.",
- "Lead not yet contacted.",
- "Lead has been contacted.",
- "Lead has become a client.",
- "Lead in a state not covered by other options."
+ "Google Partner Search."
],
"type": "string"
},
+ "minMonthlyBudget": {
+ "$ref": "Money",
+ "description": "The minimum monthly budget lead source is willing to spend."
+ },
+ "givenName": {
+ "description": "First name of lead source.",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "Language code of the lead's language preference, as defined by\n<a href=\"https://tools.ietf.org/html/bcp47\">BCP 47</a>\n(IETF BCP 47, \"Tags for Identifying Languages\").",
+ "type": "string"
+ },
+ "websiteUrl": {
+ "description": "Website URL of lead source.",
+ "type": "string"
+ },
"gpsMotivations": {
"description": "List of reasons for using Google Partner Search and creating a lead.",
"enumDescriptions": [
@@ -1342,6 +1511,24 @@
},
"type": "array"
},
+ "state": {
+ "description": "The lead's state in relation to the company.",
+ "enum": [
+ "LEAD_STATE_UNSPECIFIED",
+ "LEAD",
+ "CONTACTED",
+ "CLIENT",
+ "OTHER"
+ ],
+ "enumDescriptions": [
+ "Unchosen.",
+ "Lead not yet contacted.",
+ "Lead has been contacted.",
+ "Lead has become a client.",
+ "Lead in a state not covered by other options."
+ ],
+ "type": "string"
+ },
"email": {
"description": "Email address of lead source.",
"type": "string"
@@ -1350,50 +1537,12 @@
"description": "Last name of lead source.",
"type": "string"
},
- "id": {
- "description": "ID of the lead.",
- "type": "string"
- },
"comments": {
"description": "Comments lead source gave.",
"type": "string"
},
- "phoneNumber": {
- "description": "Phone number of lead source.",
- "type": "string"
- },
- "adwordsCustomerId": {
- "description": "The AdWords Customer ID of the lead.",
- "format": "int64",
- "type": "string"
- },
- "createTime": {
- "description": "Timestamp of when this lead was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "marketingOptIn": {
- "description": "Whether or not the lead signed up for marketing emails",
- "type": "boolean"
- },
- "type": {
- "description": "Type of lead.",
- "enum": [
- "LEAD_TYPE_UNSPECIFIED",
- "LT_GPS"
- ],
- "enumDescriptions": [
- "Unchosen.",
- "Google Partner Search."
- ],
- "type": "string"
- },
- "minMonthlyBudget": {
- "$ref": "Money",
- "description": "The minimum monthly budget lead source is willing to spend."
- },
- "givenName": {
- "description": "First name of lead source.",
+ "id": {
+ "description": "ID of the lead.",
"type": "string"
}
},
@@ -1403,16 +1552,16 @@
"description": "Debug information about this request.",
"id": "DebugInfo",
"properties": {
- "serviceUrl": {
- "description": "URL of the service that handled this request.",
+ "serverTraceInfo": {
+ "description": "Server-side debug stack trace.",
"type": "string"
},
"serverInfo": {
"description": "Info about the server that serviced this request.",
"type": "string"
},
- "serverTraceInfo": {
- "description": "Server-side debug stack trace.",
+ "serviceUrl": {
+ "description": "URL of the service that handled this request.",
"type": "string"
}
},
@@ -1448,6 +1597,10 @@
"description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.",
"id": "CompanyRelation",
"properties": {
+ "logoUrl": {
+ "description": "A URL to a profile photo, e.g. a G+ profile photo.",
+ "type": "string"
+ },
"resolvedTimestamp": {
"description": "The timestamp when the user was approved.\n@OutputOnly",
"format": "google-datetime",
@@ -1470,10 +1623,6 @@
"format": "google-datetime",
"type": "string"
},
- "primaryAddress": {
- "$ref": "Location",
- "description": "The primary location of the company."
- },
"state": {
"description": "The state of relationship, in terms of approvals.",
"enum": [
@@ -1490,6 +1639,10 @@
],
"type": "string"
},
+ "primaryAddress": {
+ "$ref": "Location",
+ "description": "The primary location of the company."
+ },
"name": {
"description": "The name (in the company's primary language) for the company.",
"type": "string"
@@ -1562,10 +1715,6 @@
"primaryLanguageCode": {
"description": "The primary language code of the company.",
"type": "string"
- },
- "logoUrl": {
- "description": "A URL to a profile photo, e.g. a G+ profile photo.",
- "type": "string"
}
},
"type": "object"
@@ -1574,8 +1723,8 @@
"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 significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 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 independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
"id": "Date",
"properties": {
- "year": {
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
"format": "int32",
"type": "integer"
},
@@ -1584,8 +1733,8 @@
"format": "int32",
"type": "integer"
},
- "month": {
- "description": "Month of year. Must be from 1 to 12.",
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32",
"type": "integer"
}
@@ -1617,28 +1766,28 @@
"description": "Common data that is in each API request.",
"id": "RequestMetadata",
"properties": {
- "userOverrides": {
- "$ref": "UserOverrides",
- "description": "Values to use instead of the user's respective defaults for the current\nrequest. These are only honored by whitelisted products."
+ "locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string"
},
"partnersSessionId": {
"description": "Google Partners session ID.",
"type": "string"
},
+ "userOverrides": {
+ "$ref": "UserOverrides",
+ "description": "Values to use instead of the user's respective defaults for the current\nrequest. These are only honored by whitelisted products."
+ },
+ "trafficSource": {
+ "$ref": "TrafficSource",
+ "description": "Source of traffic for the current request."
+ },
"experimentIds": {
"description": "Experiment IDs the current request belongs to.",
"items": {
"type": "string"
},
"type": "array"
- },
- "trafficSource": {
- "$ref": "TrafficSource",
- "description": "Source of traffic for the current request."
- },
- "locale": {
- "description": "Locale to use for the current request.",
- "type": "string"
}
},
"type": "object"
@@ -1647,14 +1796,14 @@
"description": "Request message for CreateLead.",
"id": "CreateLeadRequest",
"properties": {
- "lead": {
- "$ref": "Lead",
- "description": "The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED`\nand either `email` or `phone_number` must be provided."
- },
"recaptchaChallenge": {
"$ref": "RecaptchaChallenge",
"description": "<a href=\"https://www.google.com/recaptcha/\">reCaptcha</a> challenge info."
},
+ "lead": {
+ "$ref": "Lead",
+ "description": "The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED`\nand either `email` or `phone_number` must be provided."
+ },
"requestMetadata": {
"$ref": "RequestMetadata",
"description": "Current request metadata."
@@ -1824,10 +1973,6 @@
"description": "Response for ListOffer.",
"id": "ListOffersResponse",
"properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
"noOfferReason": {
"description": "Reason why no Offers are available.",
"enum": [
@@ -1850,6 +1995,10 @@
"$ref": "AvailableOffer"
},
"type": "array"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
}
},
"type": "object"
@@ -1858,6 +2007,14 @@
"description": "Offer info by country.",
"id": "CountryOfferInfo",
"properties": {
+ "spendXAmount": {
+ "description": "(localized) Spend X amount for that country's offer.",
+ "type": "string"
+ },
+ "offerCountryCode": {
+ "description": "Country code for which offer codes may be requested.",
+ "type": "string"
+ },
"offerType": {
"description": "Type of offer country is eligible for.",
"enum": [
@@ -1877,14 +2034,6 @@
"getYAmount": {
"description": "(localized) Get Y amount for that country's offer.",
"type": "string"
- },
- "offerCountryCode": {
- "description": "Country code for which offer codes may be requested.",
- "type": "string"
- },
- "spendXAmount": {
- "description": "(localized) Spend X amount for that country's offer.",
- "type": "string"
}
},
"type": "object"
@@ -1915,24 +2064,35 @@
"description": "Customers qualified for an offer.",
"id": "OfferCustomer",
"properties": {
+ "getYAmount": {
+ "description": "Formatted Get Y amount with currency code.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the customer.",
+ "type": "string"
+ },
+ "spendXAmount": {
+ "description": "Formatted Spend X amount with currency code.",
+ "type": "string"
+ },
+ "adwordsUrl": {
+ "description": "URL to the customer's AdWords page.",
+ "type": "string"
+ },
"creationTime": {
"description": "Time the customer was created.",
"format": "google-datetime",
"type": "string"
},
- "eligibilityDaysLeft": {
- "description": "Days the customer is still eligible.",
- "format": "int32",
- "type": "integer"
- },
"countryCode": {
"description": "Country code of the customer.",
"type": "string"
},
- "externalCid": {
- "description": "External CID for the customer.",
- "format": "int64",
- "type": "string"
+ "eligibilityDaysLeft": {
+ "description": "Days the customer is still eligible.",
+ "format": "int32",
+ "type": "integer"
},
"offerType": {
"description": "Type of the offer",
@@ -1950,20 +2110,9 @@
],
"type": "string"
},
- "getYAmount": {
- "description": "Formatted Get Y amount with currency code.",
- "type": "string"
- },
- "name": {
- "description": "Name of the customer.",
- "type": "string"
- },
- "spendXAmount": {
- "description": "Formatted Spend X amount with currency code.",
- "type": "string"
- },
- "adwordsUrl": {
- "description": "URL to the customer's AdWords page.",
+ "externalCid": {
+ "description": "External CID for the customer.",
+ "format": "int64",
"type": "string"
}
},
@@ -1973,6 +2122,13 @@
"description": "Google Partners certification status.",
"id": "CertificationStatus",
"properties": {
+ "examStatuses": {
+ "description": "List of certification exam statuses.",
+ "items": {
+ "$ref": "CertificationExamStatus"
+ },
+ "type": "array"
+ },
"type": {
"description": "The type of the certification.",
"enum": [
@@ -2013,13 +2169,6 @@
"isCertified": {
"description": "Whether certification is passing.",
"type": "boolean"
- },
- "examStatuses": {
- "description": "List of certification exam statuses.",
- "items": {
- "$ref": "CertificationExamStatus"
- },
- "type": "array"
}
},
"type": "object"
@@ -2028,10 +2177,6 @@
"description": "The localized company information.",
"id": "LocalizedCompanyInfo",
"properties": {
- "displayName": {
- "description": "Localized display name.",
- "type": "string"
- },
"languageCode": {
"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\").",
"type": "string"
@@ -2046,6 +2191,10 @@
"overview": {
"description": "Localized brief description that the company uses to advertise themselves.",
"type": "string"
+ },
+ "displayName": {
+ "description": "Localized display name.",
+ "type": "string"
}
},
"type": "object"
@@ -2065,10 +2214,6 @@
"description": "Response for ListOfferHistory.",
"id": "ListOffersHistoryResponse",
"properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
"canShowEntireCompany": {
"description": "True if the user has the option to show entire company history.",
"type": "boolean"
@@ -2092,6 +2237,10 @@
"nextPageToken": {
"description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.",
"type": "string"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
}
},
"type": "object"
@@ -2111,6 +2260,22 @@
"description": "Agency specialization status",
"id": "SpecializationStatus",
"properties": {
+ "badgeSpecializationState": {
+ "description": "State of agency specialization.",
+ "enum": [
+ "BADGE_SPECIALIZATION_STATE_UNKNOWN",
+ "BADGE_SPECIALIZATION_STATE_PASSED",
+ "BADGE_SPECIALIZATION_STATE_NOT_PASSED",
+ "BADGE_SPECIALIZATION_STATE_IN_GRACE"
+ ],
+ "enumDescriptions": [
+ "Unknown state",
+ "Specialization passed",
+ "Specialization not passed",
+ "Specialization in grace"
+ ],
+ "type": "string"
+ },
"badgeSpecialization": {
"description": "The specialization this status is for.",
"enum": [
@@ -2130,43 +2295,14 @@
"AdWords Shopping specialization"
],
"type": "string"
- },
- "badgeSpecializationState": {
- "description": "State of agency specialization.",
- "enum": [
- "BADGE_SPECIALIZATION_STATE_UNKNOWN",
- "BADGE_SPECIALIZATION_STATE_PASSED",
- "BADGE_SPECIALIZATION_STATE_NOT_PASSED",
- "BADGE_SPECIALIZATION_STATE_IN_GRACE"
- ],
- "enumDescriptions": [
- "Unknown state",
- "Specialization passed",
- "Specialization not passed",
- "Specialization in grace"
- ],
- "type": "string"
}
},
"type": "object"
},
"Certification": {
"description": "A user's information on a specific certification.",
- "id": "Certification",
- "properties": {
- "achieved": {
- "description": "Whether this certification has been achieved.",
- "type": "boolean"
- },
- "expiration": {
- "description": "Date this certification is due to expire.",
- "format": "google-datetime",
- "type": "string"
- },
- "warning": {
- "description": "Whether this certification is in the state of warning.",
- "type": "boolean"
- },
+ "id": "Certification",
+ "properties": {
"certificationType": {
"description": "The type of certification, the area of expertise.",
"enum": [
@@ -2203,6 +2339,19 @@
"description": "The date the user last achieved certification.",
"format": "google-datetime",
"type": "string"
+ },
+ "warning": {
+ "description": "Whether this certification is in the state of warning.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Date this certification is due to expire.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "achieved": {
+ "description": "Whether this certification has been achieved.",
+ "type": "boolean"
}
},
"type": "object"
@@ -2275,6 +2424,14 @@
"description": "Response message for\nListAnalytics.",
"id": "ListAnalyticsResponse",
"properties": {
+ "analyticsSummary": {
+ "$ref": "AnalyticsSummary",
+ "description": "Aggregated information across the response's\nanalytics."
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
"analytics": {
"description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date.",
"items": {
@@ -2285,14 +2442,6 @@
"nextPageToken": {
"description": "A token to retrieve next page of results.\nPass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results.",
"type": "string"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
- "analyticsSummary": {
- "$ref": "AnalyticsSummary",
- "description": "Aggregated information across the response's\nanalytics."
}
},
"type": "object"
@@ -2301,6 +2450,48 @@
"description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.",
"id": "Company",
"properties": {
+ "additionalWebsites": {
+ "description": "URL of the company's additional websites used 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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "websiteUrl": {
+ "description": "URL of the company's website.",
+ "type": "string"
+ },
+ "primaryAdwordsManagerAccountId": {
+ "description": "The Primary AdWords Manager Account id.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the company.",
+ "type": "string"
+ },
+ "localizedInfos": {
+ "description": "The list of localized info for the company.",
+ "items": {
+ "$ref": "LocalizedCompanyInfo"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "The ID of the company.",
+ "type": "string"
+ },
+ "certificationStatuses": {
+ "description": "The list of Google Partners certification statuses for the company.",
+ "items": {
+ "$ref": "CertificationStatus"
+ },
+ "type": "array"
+ },
+ "publicProfile": {
+ "$ref": "PublicProfile",
+ "description": "Basic information from the company's public profile."
+ },
"primaryLocation": {
"$ref": "Location",
"description": "The primary location of the company."
@@ -2334,10 +2525,6 @@
"$ref": "Money",
"description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness."
},
- "publicProfile": {
- "$ref": "PublicProfile",
- "description": "Basic information from the company's public profile."
- },
"ranks": {
"description": "Information related to the ranking of the company within the list of\ncompanies.",
"items": {
@@ -2366,6 +2553,13 @@
],
"type": "string"
},
+ "autoApprovalEmailDomains": {
+ "description": "Email domains that allow users with a matching email address to get\nauto-approved for associating with this company.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"companyTypes": {
"description": "Company type labels listed on the company's profile.",
"enumDescriptions": [
@@ -2399,13 +2593,6 @@
},
"type": "array"
},
- "autoApprovalEmailDomains": {
- "description": "Email domains that allow users with a matching email address to get\nauto-approved for associating with this company.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"primaryLanguageCode": {
"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\").",
"type": "string"
@@ -2469,44 +2656,6 @@
"type": "string"
},
"type": "array"
- },
- "additionalWebsites": {
- "description": "URL of the company's additional websites used 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.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "websiteUrl": {
- "description": "URL of the company's website.",
- "type": "string"
- },
- "primaryAdwordsManagerAccountId": {
- "description": "The Primary AdWords Manager Account id.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "The name of the company.",
- "type": "string"
- },
- "localizedInfos": {
- "description": "The list of localized info for the company.",
- "items": {
- "$ref": "LocalizedCompanyInfo"
- },
- "type": "array"
- },
- "id": {
- "description": "The ID of the company.",
- "type": "string"
- },
- "certificationStatuses": {
- "description": "The list of Google Partners certification statuses for the company.",
- "items": {
- "$ref": "CertificationStatus"
- },
- "type": "array"
}
},
"type": "object"
@@ -2515,25 +2664,25 @@
"description": "Response message for ListLeads.",
"id": "ListLeadsResponse",
"properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the `ListLeadsRequest.page_token` field in the\nsubsequent call to\nListLeads to retrieve the\nnext page of results.",
+ "type": "string"
},
"totalSize": {
"description": "The total count of leads for the given company.",
"format": "int32",
"type": "integer"
},
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
"leads": {
"description": "The list of leads.",
"items": {
"$ref": "Lead"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the `ListLeadsRequest.page_token` field in the\nsubsequent call to\nListLeads to retrieve the\nnext page of results.",
- "type": "string"
}
},
"type": "object"
@@ -2542,14 +2691,6 @@
"description": "Response message for CreateLead.",
"id": "CreateLeadResponse",
"properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
- "lead": {
- "$ref": "Lead",
- "description": "Lead that was created depending on the outcome of\n<a href=\"https://www.google.com/recaptcha/\">reCaptcha</a> validation."
- },
"recaptchaStatus": {
"description": "The outcome of <a href=\"https://www.google.com/recaptcha/\">reCaptcha</a>\nvalidation.",
"enum": [
@@ -2565,6 +2706,14 @@
"reCaptcha challenge failed."
],
"type": "string"
+ },
+ "lead": {
+ "$ref": "Lead",
+ "description": "Lead that was created depending on the outcome of\n<a href=\"https://www.google.com/recaptcha/\">reCaptcha</a> validation."
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
}
},
"type": "object"
@@ -2573,13 +2722,13 @@
"description": "Response message for GetCompany.",
"id": "GetCompanyResponse",
"properties": {
- "company": {
- "$ref": "Company",
- "description": "The company."
- },
"responseMetadata": {
"$ref": "ResponseMetadata",
"description": "Current response metadata."
+ },
+ "company": {
+ "$ref": "Company",
+ "description": "The company."
}
},
"type": "object"
@@ -2588,6 +2737,21 @@
"description": "A location with address and geographic coordinates. May optionally contain a\ndetailed (multi-field) version of the address.",
"id": "Location",
"properties": {
+ "languageCode": {
+ "description": "Language code of the address. Should be in BCP 47 format.",
+ "type": "string"
+ },
+ "sortingCode": {
+ "description": "Use of this code is very country-specific, but will refer to a secondary\nclassification code for sorting mail.",
+ "type": "string"
+ },
+ "addressLine": {
+ "description": "The following address lines represent the most specific part of any\naddress.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"administrativeArea": {
"description": "Top-level administrative subdivision of this country.",
"type": "string"
@@ -2604,32 +2768,17 @@
"description": "Dependent locality or sublocality. Used for UK dependent localities, or\nneighborhoods or boroughs in other locations.",
"type": "string"
},
- "regionCode": {
- "description": "CLDR (Common Locale Data Repository) region code .",
- "type": "string"
- },
"address": {
"description": "The single string version of the address.",
"type": "string"
},
- "postalCode": {
- "description": "Values are frequently alphanumeric.",
- "type": "string"
- },
- "languageCode": {
- "description": "Language code of the address. Should be in BCP 47 format.",
+ "regionCode": {
+ "description": "CLDR (Common Locale Data Repository) region code .",
"type": "string"
},
- "sortingCode": {
- "description": "Use of this code is very country-specific, but will refer to a secondary\nclassification code for sorting mail.",
+ "postalCode": {
+ "description": "Values are frequently alphanumeric.",
"type": "string"
- },
- "addressLine": {
- "description": "The following address lines represent the most specific part of any\naddress.",
- "items": {
- "type": "string"
- },
- "type": "array"
}
},
"type": "object"
@@ -2738,13 +2887,13 @@
"description": "An opt-in about receiving email with customized AdWords campaign management\ntips.",
"type": "boolean"
},
- "physicalMail": {
- "description": "An opt-in to receive special promotional gifts and material in the mail.",
- "type": "boolean"
- },
"phoneContact": {
"description": "An opt-in to allow recieivng phone calls about their Partners account.",
"type": "boolean"
+ },
+ "physicalMail": {
+ "description": "An opt-in to receive special promotional gifts and material in the mail.",
+ "type": "boolean"
}
},
"type": "object"
@@ -2753,11 +2902,6 @@
"description": "Information related to ranking of results.",
"id": "Rank",
"properties": {
- "value": {
- "description": "The numerical value of the rank.",
- "format": "double",
- "type": "number"
- },
"type": {
"description": "The type of rank.",
"enum": [
@@ -2769,6 +2913,11 @@
"Total final score."
],
"type": "string"
+ },
+ "value": {
+ "description": "The numerical value of the rank.",
+ "format": "double",
+ "type": "number"
}
},
"type": "object"
@@ -2777,19 +2926,6 @@
"description": "The profile information of a Partners user.",
"id": "UserProfile",
"properties": {
- "adwordsManagerAccount": {
- "description": "If the user has edit access to multiple accounts, the user can choose the\npreferred account and it is used when a personal account is needed. Can\nbe empty.",
- "format": "int64",
- "type": "string"
- },
- "phoneNumber": {
- "description": "The user's phone number.",
- "type": "string"
- },
- "primaryCountryCode": {
- "description": "The user's primary country, an ISO 2-character code.",
- "type": "string"
- },
"emailAddress": {
"description": "The email address the user has selected on the Partners site as primary.",
"type": "string"
@@ -2834,20 +2970,33 @@
},
"type": "array"
},
+ "familyName": {
+ "description": "The user's family name.",
+ "type": "string"
+ },
"emailOptIns": {
"$ref": "OptIns",
"description": "The list of opt-ins for the user, related to communication preferences."
},
- "familyName": {
- "description": "The user's family name.",
+ "markets": {
+ "description": "A list of ids representing which markets the user was interested in.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "phoneNumber": {
+ "description": "The user's phone number.",
+ "type": "string"
+ },
+ "adwordsManagerAccount": {
+ "description": "If the user has edit access to multiple accounts, the user can choose the\npreferred account and it is used when a personal account is needed. Can\nbe empty.",
+ "format": "int64",
"type": "string"
},
- "markets": {
- "description": "A list of ids representing which markets the user was interested in.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "primaryCountryCode": {
+ "description": "The user's primary country, an ISO 2-character code.",
+ "type": "string"
}
},
"type": "object"
@@ -2867,6 +3016,26 @@
"description": "Historical information about a Google Partners Offer.",
"id": "HistoricalOffer",
"properties": {
+ "adwordsUrl": {
+ "description": "Client's AdWords page URL.",
+ "type": "string"
+ },
+ "offerType": {
+ "description": "Type of offer.",
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ],
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
+ "type": "string"
+ },
"senderName": {
"description": "Name (First + Last) of the partners user to whom the incentive is allocated.",
"type": "string"
@@ -2924,26 +3093,6 @@
"description": "Time last action was taken.",
"format": "google-datetime",
"type": "string"
- },
- "adwordsUrl": {
- "description": "Client's AdWords page URL.",
- "type": "string"
- },
- "offerType": {
- "description": "Type of offer.",
- "enum": [
- "OFFER_TYPE_UNSPECIFIED",
- "OFFER_TYPE_SPEND_X_GET_Y",
- "OFFER_TYPE_VIDEO",
- "OFFER_TYPE_SPEND_MATCH"
- ],
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ],
- "type": "string"
}
},
"type": "object"
@@ -3324,13 +3473,6 @@
"$ref": "RequestMetadata",
"description": "Current request metadata."
},
- "eventDatas": {
- "description": "List of event data for the event.",
- "items": {
- "$ref": "EventData"
- },
- "type": "array"
- },
"eventScope": {
"description": "The scope of the event.",
"enum": [
@@ -3346,6 +3488,13 @@
"Based on page visit."
],
"type": "string"
+ },
+ "eventDatas": {
+ "description": "List of event data for the event.",
+ "items": {
+ "$ref": "EventData"
+ },
+ "type": "array"
}
},
"type": "object"
@@ -3388,21 +3537,21 @@
"description": "Analytics data for a `Company` within a single day.",
"id": "Analytics",
"properties": {
- "eventDate": {
- "$ref": "Date",
- "description": "Date on which these events occurred."
- },
- "profileViews": {
+ "contacts": {
"$ref": "AnalyticsDataPoint",
- "description": "Instances of users viewing the `Company` profile\non the specified date."
+ "description": "Instances of users contacting the `Company`\non the specified date."
},
"searchViews": {
"$ref": "AnalyticsDataPoint",
"description": "Instances of users seeing the `Company` in Google Partners Search results\non the specified date."
},
- "contacts": {
+ "profileViews": {
"$ref": "AnalyticsDataPoint",
- "description": "Instances of users contacting the `Company`\non the specified date."
+ "description": "Instances of users viewing the `Company` profile\non the specified date."
+ },
+ "eventDate": {
+ "$ref": "Date",
+ "description": "Date on which these events occurred."
}
},
"type": "object"
@@ -3411,14 +3560,14 @@
"description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186",
"id": "AdWordsManagerAccountInfo",
"properties": {
+ "customerName": {
+ "description": "Name of the customer this account represents.",
+ "type": "string"
+ },
"id": {
"description": "The AdWords Manager Account id.",
"format": "int64",
"type": "string"
- },
- "customerName": {
- "description": "Name of the customer this account represents.",
- "type": "string"
}
},
"type": "object"
@@ -3427,24 +3576,24 @@
"description": "Basic information from a public profile.",
"id": "PublicProfile",
"properties": {
- "id": {
- "description": "The ID which can be used to retrieve more details about the public profile.",
- "type": "string"
- },
- "url": {
- "description": "The URL of the public profile.",
- "type": "string"
- },
"profileImage": {
"description": "The URL to the main profile image of the public profile.",
"type": "string"
},
+ "displayImageUrl": {
+ "description": "The URL to the main display image of the public profile. Being deprecated.",
+ "type": "string"
+ },
"displayName": {
"description": "The display name of the public profile.",
"type": "string"
},
- "displayImageUrl": {
- "description": "The URL to the main display image of the public profile. Being deprecated.",
+ "url": {
+ "description": "The URL of the public profile.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The ID which can be used to retrieve more details about the public profile.",
"type": "string"
}
},
@@ -3460,155 +3609,6 @@
}
},
"type": "object"
- },
- "RecaptchaChallenge": {
- "description": "<a href=\"https://www.google.com/recaptcha/\">reCaptcha</a> challenge info.",
- "id": "RecaptchaChallenge",
- "properties": {
- "id": {
- "description": "The ID of the reCaptcha challenge.",
- "type": "string"
- },
- "response": {
- "description": "The response to the reCaptcha challenge.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AvailableOffer": {
- "description": "Available Offers to be distributed.",
- "id": "AvailableOffer",
- "properties": {
- "qualifiedCustomersComplete": {
- "description": "Whether or not the list of qualified customers is definitely complete.",
- "type": "boolean"
- },
- "id": {
- "description": "ID of this offer.",
- "format": "int64",
- "type": "string"
- },
- "countryOfferInfos": {
- "description": "Offer info by country.",
- "items": {
- "$ref": "CountryOfferInfo"
- },
- "type": "array"
- },
- "offerType": {
- "description": "Type of offer.",
- "enum": [
- "OFFER_TYPE_UNSPECIFIED",
- "OFFER_TYPE_SPEND_X_GET_Y",
- "OFFER_TYPE_VIDEO",
- "OFFER_TYPE_SPEND_MATCH"
- ],
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ],
- "type": "string"
- },
- "maxAccountAge": {
- "description": "The maximum age of an account [in days] to be eligible.",
- "format": "int32",
- "type": "integer"
- },
- "qualifiedCustomer": {
- "description": "Customers who qualify for this offer.",
- "items": {
- "$ref": "OfferCustomer"
- },
- "type": "array"
- },
- "terms": {
- "description": "Terms of the offer.",
- "type": "string"
- },
- "showSpecialOfferCopy": {
- "description": "Should special text be shown on the offers page.",
- "type": "boolean"
- },
- "available": {
- "description": "The number of codes for this offer that are available for distribution.",
- "format": "int32",
- "type": "integer"
- },
- "description": {
- "description": "Description of the offer.",
- "type": "string"
- },
- "offerLevel": {
- "description": "Level of this offer.",
- "enum": [
- "OFFER_LEVEL_UNSPECIFIED",
- "OFFER_LEVEL_DENY_PROBLEM",
- "OFFER_LEVEL_DENY_CONTRACT",
- "OFFER_LEVEL_MANUAL",
- "OFFER_LEVEL_LIMIT_0",
- "OFFER_LEVEL_LIMIT_5",
- "OFFER_LEVEL_LIMIT_15",
- "OFFER_LEVEL_LIMIT_50"
- ],
- "enumDescriptions": [
- "Unset.",
- "Users/Agencies that have no offers because of a problem.",
- "Users/Agencies that have no offers due to contractural agreements.",
- "Users/Agencies that have a manually-configured limit.",
- "Some Agencies don't get any offers.",
- "Basic level gets 5 per month.",
- "Agencies with adequate AHI and spend get 15/month.",
- "Badged partners (even in grace) get 50 per month."
- ],
- "type": "string"
- },
- "name": {
- "description": "Name of the offer.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LatLng": {
- "description": "An object representing a latitude/longitude pair. This 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 longitude 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 return 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], respectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(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) == NormalizeLatLng(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 assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "id": "LatLng",
- "properties": {
- "latitude": {
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "format": "double",
- "type": "number"
- },
- "longitude": {
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "Money": {
- "description": "Represents an amount of money with its currency type.",
- "id": "Money",
- "properties": {
- "units": {
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "format": "int64",
- "type": "string"
- },
- "currencyCode": {
- "description": "The 3-letter currency code defined in ISO 4217.",
- "type": "string"
- },
- "nanos": {
- "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 negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
}
},
"servicePath": "",
« no previous file with comments | « discovery/googleapis/monitoring__v3.json ('k') | discovery/googleapis/people__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698