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

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/partners__v2.json

Issue 2987103002: Api-Roll 52: 2017-07-31 (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 30980bb7c4cbbbd5c1dd4b79472783ab006df2f7..e6f752e785173a2630ae156868007f625faef535 100644
--- a/discovery/googleapis/partners__v2.json
+++ b/discovery/googleapis/partners__v2.json
@@ -16,27 +16,6 @@
"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",
@@ -48,13 +27,13 @@
"location": "query",
"type": "boolean"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
@@ -101,119 +80,31 @@
"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"
+ },
+ "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"
}
},
"protocol": "rest",
"resources": {
- "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.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",
- "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"
- },
- "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": {
@@ -222,13 +113,13 @@
"id": "partners.leads.list",
"parameterOrder": [],
"parameters": {
- "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"
},
- "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"
},
@@ -316,13 +207,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"
}
@@ -342,8 +233,13 @@
"id": "partners.offers.history.list",
"parameterOrder": [],
"parameters": {
- "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"
+ },
+ "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"
},
@@ -352,6 +248,11 @@
"location": "query",
"type": "string"
},
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "location": "query",
+ "type": "string"
+ },
"pageToken": {
"description": "Token to retrieve a specific page.",
"location": "query",
@@ -378,26 +279,16 @@
"location": "query",
"type": "string"
},
- "entireCompany": {
- "description": "if true, show history for the entire company. Requires user to be admin.",
- "location": "query",
- "type": "boolean"
- },
"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"
- },
- "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.",
+ "entireCompany": {
+ "description": "if true, show history for the entire company. Requires user to be admin.",
"location": "query",
- "type": "string"
+ "type": "boolean"
}
},
"path": "v2/offers/history",
@@ -409,27 +300,16 @@
}
}
},
- "userStates": {
+ "analytics": {
"methods": {
"list": {
- "description": "Lists states for current user.",
+ "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
"httpMethod": "GET",
- "id": "partners.userStates.list",
+ "id": "partners.analytics.list",
"parameterOrder": [],
"parameters": {
- "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.",
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"location": "query",
"type": "string"
},
@@ -438,11 +318,17 @@
"location": "query",
"type": "string"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "pageToken": {
+ "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListAnalyticsResponse.next_page_token`\nreturned from the previous call to\nListAnalytics.\nWill be a date string in `YYYY-MM-DD` format representing the end date\nof the date range of results to return.\nIf unspecified or set to \"\", default value is the current date.",
"location": "query",
"type": "string"
},
+ "pageSize": {
+ "description": "Requested page size. Server may return fewer analytics than requested.\nIf unspecified or set to 0, default value is 30.\nSpecifies the number of days in the date range when querying analytics.\nThe `page_token` represents the end date of the date range\nand the start date is calculated using the `page_size` as the number\nof days BEFORE the end date.\nMust be a non-negative integer.",
+ "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",
@@ -452,21 +338,37 @@
"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/userStates",
+ "path": "v2/analytics",
"response": {
- "$ref": "ListUserStatesResponse"
+ "$ref": "ListAnalyticsResponse"
}
}
}
},
- "analytics": {
+ "userStates": {
"methods": {
"list": {
- "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
+ "description": "Lists states for current user.",
"httpMethod": "GET",
- "id": "partners.analytics.list",
+ "id": "partners.userStates.list",
"parameterOrder": [],
"parameters": {
"requestMetadata.userOverrides.userId": {
@@ -479,17 +381,6 @@
"location": "query",
"type": "string"
},
- "pageToken": {
- "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListAnalyticsResponse.next_page_token`\nreturned from the previous call to\nListAnalytics.\nWill be a date string in `YYYY-MM-DD` format representing the end date\nof the date range of results to return.\nIf unspecified or set to \"\", default value is the current date.",
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "Requested page size. Server may return fewer analytics than requested.\nIf unspecified or set to 0, default value is 30.\nSpecifies the number of days in the date range when querying analytics.\nThe `page_token` represents the end date of the date range\nand the start date is calculated using the `page_size` as the number\nof days BEFORE the end date.\nMust be a non-negative integer.",
- "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",
@@ -517,69 +408,26 @@
"type": "string"
}
},
- "path": "v2/analytics",
+ "path": "v2/userStates",
"response": {
- "$ref": "ListAnalyticsResponse"
+ "$ref": "ListUserStatesResponse"
}
}
}
},
"v2": {
"methods": {
- "getPartnersstatus": {
- "description": "Gets Partners Status of the logged in user's agency.\nShould only be called if the logged in user is the admin of the agency.",
- "httpMethod": "GET",
- "id": "partners.getPartnersstatus",
+ "updateLeads": {
+ "description": "Updates the specified lead.",
+ "httpMethod": "PATCH",
+ "id": "partners.updateLeads",
"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",
- "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/partnersstatus",
- "response": {
- "$ref": "GetPartnersStatusResponse"
- }
- },
- "updateLeads": {
- "description": "Updates the specified lead.",
- "httpMethod": "PATCH",
- "id": "partners.updateLeads",
- "parameterOrder": [],
- "parameters": {
"requestMetadata.userOverrides.ipAddress": {
"description": "IP address to use instead of the user's geo-located IP address.",
"location": "query",
@@ -616,11 +464,6 @@
"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/leads",
@@ -637,6 +480,11 @@
"id": "partners.updateCompanies",
"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",
+ "type": "string"
+ },
"requestMetadata.userOverrides.userId": {
"description": "Logged-in user ID to impersonate instead of the user's ID.",
"location": "query",
@@ -673,11 +521,6 @@
"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/companies",
@@ -687,18 +530,12 @@
"response": {
"$ref": "Company"
}
- }
- }
- },
- "users": {
- "methods": {
- "deleteCompanyRelation": {
- "description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
- "httpMethod": "DELETE",
- "id": "partners.users.deleteCompanyRelation",
- "parameterOrder": [
- "userId"
- ],
+ },
+ "getPartnersstatus": {
+ "description": "Gets Partners Status of the logged in user's agency.\nShould only be called if the logged in user is the admin of the agency.",
+ "httpMethod": "GET",
+ "id": "partners.getPartnersstatus",
+ "parameterOrder": [],
"parameters": {
"requestMetadata.experimentIds": {
"description": "Experiment IDs the current request belongs to.",
@@ -706,27 +543,62 @@
"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.",
"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"
},
+ "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"
+ }
+ },
+ "path": "v2/partnersstatus",
+ "response": {
+ "$ref": "GetPartnersStatusResponse"
+ }
+ }
+ }
+ },
+ "users": {
+ "methods": {
+ "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",
@@ -741,17 +613,31 @@
"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/{userId}/companyRelation",
+ "path": "v2/users/profile",
+ "request": {
+ "$ref": "UserProfile"
+ },
"response": {
- "$ref": "Empty"
+ "$ref": "UserProfile"
}
},
- "createCompanyRelation": {
- "description": "Creates a user's company relation. Affiliates the user to a company.",
- "httpMethod": "PUT",
- "id": "partners.users.createCompanyRelation",
+ "deleteCompanyRelation": {
+ "description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
+ "httpMethod": "DELETE",
+ "id": "partners.users.deleteCompanyRelation",
"parameterOrder": [
"userId"
],
@@ -800,38 +686,25 @@
}
},
"path": "v2/users/{userId}/companyRelation",
- "request": {
- "$ref": "CompanyRelation"
- },
"response": {
- "$ref": "CompanyRelation"
+ "$ref": "Empty"
}
},
- "get": {
- "description": "Gets a user.",
- "httpMethod": "GET",
- "id": "partners.users.get",
+ "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.",
"location": "query",
"type": "string"
},
- "userView": {
- "description": "Specifies what parts of the user information to return.",
- "enum": [
- "BASIC",
- "PROFILE",
- "PUBLIC_PROFILE"
- ],
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"location": "query",
"type": "string"
},
@@ -857,7 +730,7 @@
"type": "string"
},
"userId": {
- "description": "Identifier of the user. Can be set to <code>me</code> to mean the currently\nauthenticated user.",
+ "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"
@@ -868,16 +741,21 @@
"type": "string"
}
},
- "path": "v2/users/{userId}",
+ "path": "v2/users/{userId}/companyRelation",
+ "request": {
+ "$ref": "CompanyRelation"
+ },
"response": {
- "$ref": "User"
+ "$ref": "CompanyRelation"
}
},
- "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": [],
+ "get": {
+ "description": "Gets a user.",
+ "httpMethod": "GET",
+ "id": "partners.users.get",
+ "parameterOrder": [
+ "userId"
+ ],
"parameters": {
"requestMetadata.partnersSessionId": {
"description": "Google Partners session ID.",
@@ -889,6 +767,16 @@
"location": "query",
"type": "string"
},
+ "userView": {
+ "description": "Specifies what parts of the user information to return.",
+ "enum": [
+ "BASIC",
+ "PROFILE",
+ "PUBLIC_PROFILE"
+ ],
+ "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",
@@ -910,18 +798,21 @@
"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"
+ },
"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"
- },
+ "path": "v2/users/{userId}",
"response": {
- "$ref": "UserProfile"
+ "$ref": "User"
}
}
}
@@ -934,91 +825,8 @@
"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",
- "type": "string"
- },
- "view": {
- "description": "The view of the `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.locale": {
- "description": "Locale to use for the current request.",
- "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.",
- "location": "query",
- "type": "string"
- },
- "minMonthlyBudget.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"
- },
- "maxMonthlyBudget.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",
- "type": "integer"
- },
- "services": {
- "description": "List of services that the returned agencies should provide. If this is\nnot empty, any returned agency must have at least one of these services,\nor one of the specializations in the \"specializations\" field.",
- "enum": [
- "SERVICE_UNSPECIFIED",
- "S_ADVANCED_ADWORDS_SUPPORT",
- "S_ADVERTISING_ON_GOOGLE",
- "S_AN_ENHANCED_WEBSITE",
- "S_AN_ONLINE_MARKETING_PLAN",
- "S_MOBILE_AND_VIDEO_ADS",
- "S_MOBILE_WEBSITE_SERVICES"
- ],
- "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.",
- "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",
- "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"
- },
- "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",
- "type": "integer"
- },
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
- "location": "query",
- "type": "string"
- },
- "companyName": {
- "description": "Company name to search for.",
+ "companyName": {
+ "description": "Company name to search for.",
"location": "query",
"type": "string"
},
@@ -1109,6 +917,89 @@
"description": "The 3-letter currency code defined in ISO 4217.",
"location": "query",
"type": "string"
+ },
+ "minMonthlyBudget.currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "location": "query",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "location": "query",
+ "type": "string"
+ },
+ "view": {
+ "description": "The view of the `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.locale": {
+ "description": "Locale to use for the current request.",
+ "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.",
+ "location": "query",
+ "type": "string"
+ },
+ "minMonthlyBudget.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"
+ },
+ "maxMonthlyBudget.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",
+ "type": "integer"
+ },
+ "services": {
+ "description": "List of services that the returned agencies should provide. If this is\nnot empty, any returned agency must have at least one of these services,\nor one of the specializations in the \"specializations\" field.",
+ "enum": [
+ "SERVICE_UNSPECIFIED",
+ "S_ADVANCED_ADWORDS_SUPPORT",
+ "S_ADVERTISING_ON_GOOGLE",
+ "S_AN_ENHANCED_WEBSITE",
+ "S_AN_ONLINE_MARKETING_PLAN",
+ "S_MOBILE_AND_VIDEO_ADS",
+ "S_MOBILE_WEBSITE_SERVICES"
+ ],
+ "location": "query",
+ "repeated": true,
+ "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",
+ "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.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"
+ },
+ "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",
+ "type": "integer"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "location": "query",
+ "type": "string"
}
},
"path": "v2/companies",
@@ -1124,6 +1015,16 @@
"companyId"
],
"parameters": {
+ "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"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "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",
@@ -1140,14 +1041,19 @@
"required": 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"
+ },
"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.",
+ "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"
},
@@ -1156,8 +1062,8 @@
"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.",
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"location": "query",
"type": "string"
},
@@ -1166,11 +1072,6 @@
"location": "query",
"type": "string"
},
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "location": "query",
- "type": "string"
- },
"view": {
"description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
"enum": [
@@ -1179,16 +1080,6 @@
],
"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.",
- "location": "query",
- "type": "string"
- },
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "location": "query",
- "type": "string"
}
},
"path": "v2/companies/{companyId}",
@@ -1226,160 +1117,120 @@
}
}
}
- }
- },
- "revision": "20170628",
- "rootUrl": "https://partners.googleapis.com/",
- "schemas": {
- "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": {
- "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"
+ "userEvents": {
+ "methods": {
+ "log": {
+ "description": "Logs a user event.",
+ "httpMethod": "POST",
+ "id": "partners.userEvents.log",
+ "parameterOrder": [],
+ "parameters": {},
+ "path": "v2/userEvents:log",
+ "request": {
+ "$ref": "LogUserEventRequest"
},
- "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"
+ "response": {
+ "$ref": "LogUserEventResponse"
+ }
}
- },
- "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"
+ "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"
+ }
}
- },
- "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"
+ "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": {
+ "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"
+ },
+ "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",
+ "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/exams/{examType}/token",
+ "response": {
+ "$ref": "ExamToken"
+ }
}
- },
- "type": "object"
- },
+ }
+ }
+ },
+ "revision": "20170725",
+ "rootUrl": "https://partners.googleapis.com/",
+ "schemas": {
"AnalyticsSummary": {
"description": "Analytics aggregated data for a `Company` for a given date range.",
"id": "AnalyticsSummary",
@@ -1406,6 +1257,17 @@
"description": "Request message for\nLogClientMessage.",
"id": "LogMessageRequest",
"properties": {
+ "details": {
+ "description": "Details about the client message.",
+ "type": "string"
+ },
+ "clientInfo": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Map of client info, such as URL, browser navigator, browser platform, etc.",
+ "type": "object"
+ },
"requestMetadata": {
"$ref": "RequestMetadata",
"description": "Current request metadata."
@@ -1427,17 +1289,25 @@
"Message level for serious failures."
],
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DebugInfo": {
+ "description": "Debug information about this request.",
+ "id": "DebugInfo",
+ "properties": {
+ "serviceUrl": {
+ "description": "URL of the service that handled this request.",
+ "type": "string"
},
- "details": {
- "description": "Details about the client message.",
+ "serverTraceInfo": {
+ "description": "Server-side debug stack trace.",
"type": "string"
},
- "clientInfo": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Map of client info, such as URL, browser navigator, browser platform, etc.",
- "type": "object"
+ "serverInfo": {
+ "description": "Info about the server that serviced this request.",
+ "type": "string"
}
},
"type": "object"
@@ -1446,15 +1316,15 @@
"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": {
- "phoneNumber": {
- "description": "Phone number of lead source.",
- "type": "string"
- },
"adwordsCustomerId": {
"description": "The AdWords Customer ID of the lead.",
"format": "int64",
"type": "string"
},
+ "phoneNumber": {
+ "description": "Phone number of lead source.",
+ "type": "string"
+ },
"createTime": {
"description": "Timestamp of when this lead was created.",
"format": "google-datetime",
@@ -1492,6 +1362,24 @@
"description": "Website URL of lead source.",
"type": "string"
},
+ "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"
+ },
"gpsMotivations": {
"description": "List of reasons for using Google Partner Search and creating a lead.",
"enumDescriptions": [
@@ -1511,24 +1399,6 @@
},
"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"
@@ -1548,55 +1418,81 @@
},
"type": "object"
},
- "DebugInfo": {
- "description": "Debug information about this request.",
- "id": "DebugInfo",
+ "ListUserStatesResponse": {
+ "description": "Response message for\nListUserStates.",
+ "id": "ListUserStatesResponse",
"properties": {
- "serverTraceInfo": {
- "description": "Server-side debug stack trace.",
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
+ "userStates": {
+ "description": "User's states.",
+ "enumDescriptions": [
+ "Unchosen.",
+ "User must pass <a href=\"https://www.google.com/recaptcha/\">reCaptcha</a> to\ncontact a Partner via Google Partner Search."
+ ],
+ "items": {
+ "enum": [
+ "USER_STATE_UNSPECIFIED",
+ "US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CompanyRelation": {
+ "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.",
+ "id": "CompanyRelation",
+ "properties": {
+ "internalCompanyId": {
+ "description": "The internal company ID.\nOnly available for a whitelisted set of api clients.",
"type": "string"
},
- "serverInfo": {
- "description": "Info about the server that serviced this request.",
+ "specializationStatus": {
+ "description": "The list of Google Partners specialization statuses for the company.",
+ "items": {
+ "$ref": "SpecializationStatus"
+ },
+ "type": "array"
+ },
+ "badgeTier": {
+ "description": "Whether the company is a Partner.",
+ "enum": [
+ "BADGE_TIER_NONE",
+ "BADGE_TIER_REGULAR",
+ "BADGE_TIER_PREMIER"
+ ],
+ "enumDescriptions": [
+ "Tier badge is not set.",
+ "Agency has regular partner badge.",
+ "Agency has premier badge."
+ ],
"type": "string"
},
- "serviceUrl": {
- "description": "URL of the service that handled this request.",
+ "website": {
+ "description": "The website URL for this company.",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "The phone number for the company's primary address.",
+ "type": "string"
+ },
+ "primaryCountryCode": {
+ "description": "The primary country code of the company.",
+ "type": "string"
+ },
+ "companyId": {
+ "description": "The ID of the company. There may be no id if this is a\npending company.5",
+ "type": "string"
+ },
+ "primaryLanguageCode": {
+ "description": "The primary language code of the company.",
"type": "string"
- }
- },
- "type": "object"
- },
- "ListUserStatesResponse": {
- "description": "Response message for\nListUserStates.",
- "id": "ListUserStatesResponse",
- "properties": {
- "userStates": {
- "description": "User's states.",
- "enumDescriptions": [
- "Unchosen.",
- "User must pass <a href=\"https://www.google.com/recaptcha/\">reCaptcha</a> to\ncontact a Partner via Google Partner Search."
- ],
- "items": {
- "enum": [
- "USER_STATE_UNSPECIFIED",
- "US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT"
- ],
- "type": "string"
- },
- "type": "array"
},
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "type": "object"
- },
- "CompanyRelation": {
- "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"
@@ -1623,6 +1519,10 @@
"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": [
@@ -1639,19 +1539,15 @@
],
"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"
- },
"managerAccount": {
"description": "The AdWords manager account # associated this company.",
"format": "int64",
"type": "string"
},
+ "name": {
+ "description": "The name (in the company's primary language) for the company.",
+ "type": "string"
+ },
"segment": {
"description": "The segment the company is classified as.",
"enumDescriptions": [
@@ -1670,51 +1566,6 @@
"type": "string"
},
"type": "array"
- },
- "internalCompanyId": {
- "description": "The internal company ID.\nOnly available for a whitelisted set of api clients.",
- "type": "string"
- },
- "badgeTier": {
- "description": "Whether the company is a Partner.",
- "enum": [
- "BADGE_TIER_NONE",
- "BADGE_TIER_REGULAR",
- "BADGE_TIER_PREMIER"
- ],
- "enumDescriptions": [
- "Tier badge is not set.",
- "Agency has regular partner badge.",
- "Agency has premier badge."
- ],
- "type": "string"
- },
- "specializationStatus": {
- "description": "The list of Google Partners specialization statuses for the company.",
- "items": {
- "$ref": "SpecializationStatus"
- },
- "type": "array"
- },
- "phoneNumber": {
- "description": "The phone number for the company's primary address.",
- "type": "string"
- },
- "website": {
- "description": "The website URL for this company.",
- "type": "string"
- },
- "primaryCountryCode": {
- "description": "The primary country code of the company.",
- "type": "string"
- },
- "companyId": {
- "description": "The ID of the company. There may be no id if this is a\npending company.5",
- "type": "string"
- },
- "primaryLanguageCode": {
- "description": "The primary language code of the company.",
- "type": "string"
}
},
"type": "object"
@@ -1762,6 +1613,25 @@
},
"type": "object"
},
+ "CreateLeadRequest": {
+ "description": "Request message for CreateLead.",
+ "id": "CreateLeadRequest",
+ "properties": {
+ "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."
+ }
+ },
+ "type": "object"
+ },
"RequestMetadata": {
"description": "Common data that is in each API request.",
"id": "RequestMetadata",
@@ -1792,25 +1662,6 @@
},
"type": "object"
},
- "CreateLeadRequest": {
- "description": "Request message for CreateLead.",
- "id": "CreateLeadRequest",
- "properties": {
- "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."
- }
- },
- "type": "object"
- },
"EventData": {
"description": "Key value data pair for an event.",
"id": "EventData",
@@ -1913,6 +1764,15 @@
"description": "A user's information on a specific exam.",
"id": "ExamStatus",
"properties": {
+ "passed": {
+ "description": "Whether this exam has been passed and not expired.",
+ "type": "boolean"
+ },
+ "taken": {
+ "description": "The date the user last taken this exam.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"warning": {
"description": "Whether this exam is in the state of warning.",
"type": "boolean"
@@ -1956,15 +1816,6 @@
"Mobile Sites exam."
],
"type": "string"
- },
- "taken": {
- "description": "The date the user last taken this exam.",
- "format": "google-datetime",
- "type": "string"
- },
- "passed": {
- "description": "Whether this exam has been passed and not expired.",
- "type": "boolean"
}
},
"type": "object"
@@ -2064,14 +1915,6 @@
"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"
@@ -2114,6 +1957,14 @@
"description": "External CID for the customer.",
"format": "int64",
"type": "string"
+ },
+ "getYAmount": {
+ "description": "Formatted Get Y amount with currency code.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the customer.",
+ "type": "string"
}
},
"type": "object"
@@ -2122,13 +1973,6 @@
"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": [
@@ -2169,6 +2013,13 @@
"isCertified": {
"description": "Whether certification is passing.",
"type": "boolean"
+ },
+ "examStatuses": {
+ "description": "List of certification exam statuses.",
+ "items": {
+ "$ref": "CertificationExamStatus"
+ },
+ "type": "array"
}
},
"type": "object"
@@ -2177,10 +2028,6 @@
"description": "The localized company information.",
"id": "LocalizedCompanyInfo",
"properties": {
- "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"
- },
"countryCodes": {
"description": "List of country codes for the localized company info.",
"items": {
@@ -2195,6 +2042,10 @@
"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"
}
},
"type": "object"
@@ -2214,15 +2065,6 @@
"description": "Response for ListOfferHistory.",
"id": "ListOffersHistoryResponse",
"properties": {
- "canShowEntireCompany": {
- "description": "True if the user has the option to show entire company history.",
- "type": "boolean"
- },
- "totalResults": {
- "description": "Number of results across all pages.",
- "format": "int32",
- "type": "integer"
- },
"showingEntireCompany": {
"description": "True if this response is showing entire company history.",
"type": "boolean"
@@ -2241,6 +2083,15 @@
"responseMetadata": {
"$ref": "ResponseMetadata",
"description": "Current response metadata."
+ },
+ "canShowEntireCompany": {
+ "description": "True if the user has the option to show entire company history.",
+ "type": "boolean"
+ },
+ "totalResults": {
+ "description": "Number of results across all pages.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
@@ -2260,22 +2111,6 @@
"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": [
@@ -2295,6 +2130,22 @@
"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"
@@ -2353,37 +2204,29 @@
"description": "Whether this certification has been achieved.",
"type": "boolean"
}
- },
- "type": "object"
- },
- "User": {
- "description": "A resource representing a user of the Partners platform.",
- "id": "User",
- "properties": {
- "profile": {
- "$ref": "UserProfile",
- "description": "The profile information of a Partners user, contains all the directly\neditable user information."
- },
- "company": {
- "$ref": "CompanyRelation",
- "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company."
- },
+ },
+ "type": "object"
+ },
+ "User": {
+ "description": "A resource representing a user of the Partners platform.",
+ "id": "User",
+ "properties": {
"lastAccessTime": {
"description": "The most recent time the user interacted with the Partners site.\n@OutputOnly",
"format": "google-datetime",
"type": "string"
},
- "primaryEmails": {
- "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly",
+ "availableAdwordsManagerAccounts": {
+ "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal account is needed. Can\nbe empty meaning the user has access to no accounts.\n@OutputOnly",
"items": {
- "type": "string"
+ "$ref": "AdWordsManagerAccountInfo"
},
"type": "array"
},
- "availableAdwordsManagerAccounts": {
- "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal account is needed. Can\nbe empty meaning the user has access to no accounts.\n@OutputOnly",
+ "primaryEmails": {
+ "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly",
"items": {
- "$ref": "AdWordsManagerAccountInfo"
+ "type": "string"
},
"type": "array"
},
@@ -2416,6 +2259,14 @@
"companyVerificationEmail": {
"description": "The email address used by the user used for company verification.\n@OutputOnly",
"type": "string"
+ },
+ "company": {
+ "$ref": "CompanyRelation",
+ "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company."
+ },
+ "profile": {
+ "$ref": "UserProfile",
+ "description": "The profile information of a Partners user, contains all the directly\neditable user information."
}
},
"type": "object"
@@ -2424,14 +2275,6 @@
"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": {
@@ -2442,6 +2285,14 @@
"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"
+ },
+ "analyticsSummary": {
+ "$ref": "AnalyticsSummary",
+ "description": "Aggregated information across the response's\nanalytics."
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
}
},
"type": "object"
@@ -2450,9 +2301,106 @@
"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.",
+ "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": [
+ "Unchosen.",
+ "Handles all aspects of the advertising process.",
+ "Focuses solely on an advertiser's media placement.",
+ "Plans/executes advertising campaigns.",
+ "Like a\nFULL_SERVICE_AGENCY,\nbut specializing in digital.",
+ "Increases visibility in search engine result pages.",
+ "Drives promotional efforts for immediate impact.",
+ "Focuses on bid management, conversion, reporting.",
+ "Establishes favorable relationship with public through low/no-cost\ncommunications.",
+ "Does not manage other company's accounts, manages own marketing programs.",
+ "Full-service AdWords account management for local businesses."
+ ],
+ "items": {
+ "enum": [
+ "COMPANY_TYPE_UNSPECIFIED",
+ "FULL_SERVICE_AGENCY",
+ "MEDIA_AGENCY",
+ "CREATIVE_AGENCY",
+ "CDIGITAL_AGENCY",
+ "SEM_SEO",
+ "PERFORMANCE_MARKETING",
+ "ADVERTISING_TOOL_DEVELOPMENT",
+ "PR",
+ "SELF_MANAGED",
+ "RESELLER"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "profileStatus": {
+ "description": "The public viewability status of the company's profile.",
+ "enum": [
+ "COMPANY_PROFILE_STATUS_UNSPECIFIED",
+ "HIDDEN",
+ "PUBLISHED",
+ "SEARCHABLE"
+ ],
+ "enumDescriptions": [
+ "Unchosen.",
+ "Company profile does not show up publicly.",
+ "Company profile can only be viewed by the profile's URL\nand not by Google Partner Search.",
+ "Company profile can be viewed by the profile's URL\nand by Google Partner Search."
+ ],
+ "type": "string"
+ },
+ "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"
+ },
+ "locations": {
+ "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "convertedMinMonthlyBudget": {
+ "$ref": "Money",
+ "description": "The minimum monthly budget that the company accepts for partner business,\nconverted to the requested currency code."
+ },
+ "industries": {
+ "description": "Industries the company can help with.",
+ "enumDescriptions": [
+ "Unchosen.",
+ "The automotive industry.",
+ "The business-to-business industry.",
+ "The consumer packaged goods industry.",
+ "The education industry.",
+ "The finance industry.",
+ "The healthcare industry.",
+ "The media and entertainment industry.",
+ "The retail industry.",
+ "The technology industry.",
+ "The travel industry."
+ ],
"items": {
+ "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"
+ ],
"type": "string"
},
"type": "array"
@@ -2461,6 +2409,13 @@
"description": "URL of the company's website.",
"type": "string"
},
+ "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"
+ },
"primaryAdwordsManagerAccountId": {
"description": "The Primary AdWords Manager Account id.",
"format": "int64",
@@ -2477,10 +2432,6 @@
},
"type": "array"
},
- "id": {
- "description": "The ID of the company.",
- "type": "string"
- },
"certificationStatuses": {
"description": "The list of Google Partners certification statuses for the company.",
"items": {
@@ -2488,13 +2439,9 @@
},
"type": "array"
},
- "publicProfile": {
- "$ref": "PublicProfile",
- "description": "Basic information from the company's public profile."
- },
- "primaryLocation": {
- "$ref": "Location",
- "description": "The primary location of the company."
+ "id": {
+ "description": "The ID of the company.",
+ "type": "string"
},
"services": {
"description": "Services the company can help with.",
@@ -2521,10 +2468,18 @@
},
"type": "array"
},
+ "primaryLocation": {
+ "$ref": "Location",
+ "description": "The primary location of the company."
+ },
"originalMinMonthlyBudget": {
"$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": {
@@ -2532,130 +2487,26 @@
},
"type": "array"
},
- "specializationStatus": {
- "description": "The list of Google Partners specialization statuses for the company.",
- "items": {
- "$ref": "SpecializationStatus"
- },
- "type": "array"
- },
- "badgeTier": {
- "description": "Partner badge tier",
- "enum": [
- "BADGE_TIER_NONE",
- "BADGE_TIER_REGULAR",
- "BADGE_TIER_PREMIER"
- ],
- "enumDescriptions": [
- "Tier badge is not set.",
- "Agency has regular partner badge.",
- "Agency has premier badge."
- ],
- "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": [
- "Unchosen.",
- "Handles all aspects of the advertising process.",
- "Focuses solely on an advertiser's media placement.",
- "Plans/executes advertising campaigns.",
- "Like a\nFULL_SERVICE_AGENCY,\nbut specializing in digital.",
- "Increases visibility in search engine result pages.",
- "Drives promotional efforts for immediate impact.",
- "Focuses on bid management, conversion, reporting.",
- "Establishes favorable relationship with public through low/no-cost\ncommunications.",
- "Does not manage other company's accounts, manages own marketing programs.",
- "Full-service AdWords account management for local businesses."
- ],
- "items": {
- "enum": [
- "COMPANY_TYPE_UNSPECIFIED",
- "FULL_SERVICE_AGENCY",
- "MEDIA_AGENCY",
- "CREATIVE_AGENCY",
- "CDIGITAL_AGENCY",
- "SEM_SEO",
- "PERFORMANCE_MARKETING",
- "ADVERTISING_TOOL_DEVELOPMENT",
- "PR",
- "SELF_MANAGED",
- "RESELLER"
- ],
- "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"
- },
- "profileStatus": {
- "description": "The public viewability status of the company's profile.",
- "enum": [
- "COMPANY_PROFILE_STATUS_UNSPECIFIED",
- "HIDDEN",
- "PUBLISHED",
- "SEARCHABLE"
- ],
- "enumDescriptions": [
- "Unchosen.",
- "Company profile does not show up publicly.",
- "Company profile can only be viewed by the profile's URL\nand not by Google Partner Search.",
- "Company profile can be viewed by the profile's URL\nand by Google Partner Search."
- ],
- "type": "string"
- },
- "locations": {
- "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.",
+ "specializationStatus": {
+ "description": "The list of Google Partners specialization statuses for the company.",
"items": {
- "$ref": "Location"
+ "$ref": "SpecializationStatus"
},
"type": "array"
},
- "convertedMinMonthlyBudget": {
- "$ref": "Money",
- "description": "The minimum monthly budget that the company accepts for partner business,\nconverted to the requested currency code."
- },
- "industries": {
- "description": "Industries the company can help with.",
+ "badgeTier": {
+ "description": "Partner badge tier",
+ "enum": [
+ "BADGE_TIER_NONE",
+ "BADGE_TIER_REGULAR",
+ "BADGE_TIER_PREMIER"
+ ],
"enumDescriptions": [
- "Unchosen.",
- "The automotive industry.",
- "The business-to-business industry.",
- "The consumer packaged goods industry.",
- "The education industry.",
- "The finance industry.",
- "The healthcare industry.",
- "The media and entertainment industry.",
- "The retail industry.",
- "The technology industry.",
- "The travel industry."
+ "Tier badge is not set.",
+ "Agency has regular partner badge.",
+ "Agency has premier badge."
],
- "items": {
- "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"
- ],
- "type": "string"
- },
- "type": "array"
+ "type": "string"
}
},
"type": "object"
@@ -2722,13 +2573,13 @@
"description": "Response message for GetCompany.",
"id": "GetCompanyResponse",
"properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
"company": {
"$ref": "Company",
"description": "The company."
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
}
},
"type": "object"
@@ -2737,6 +2588,26 @@
"description": "A location with address and geographic coordinates. May optionally contain a\ndetailed (multi-field) version of the address.",
"id": "Location",
"properties": {
+ "latLng": {
+ "$ref": "LatLng",
+ "description": "The latitude and longitude of the location, in degrees."
+ },
+ "address": {
+ "description": "The single string version of the address.",
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "CLDR (Common Locale Data Repository) region code .",
+ "type": "string"
+ },
+ "dependentLocality": {
+ "description": "Dependent locality or sublocality. Used for UK dependent localities, or\nneighborhoods or boroughs in other locations.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "Values are frequently alphanumeric.",
+ "type": "string"
+ },
"languageCode": {
"description": "Language code of the address. Should be in BCP 47 format.",
"type": "string"
@@ -2759,26 +2630,6 @@
"locality": {
"description": "Generally refers to the city/town portion of an address.",
"type": "string"
- },
- "latLng": {
- "$ref": "LatLng",
- "description": "The latitude and longitude of the location, in degrees."
- },
- "dependentLocality": {
- "description": "Dependent locality or sublocality. Used for UK dependent localities, or\nneighborhoods or boroughs in other locations.",
- "type": "string"
- },
- "address": {
- "description": "The single string version of the address.",
- "type": "string"
- },
- "regionCode": {
- "description": "CLDR (Common Locale Data Repository) region code .",
- "type": "string"
- },
- "postalCode": {
- "description": "Values are frequently alphanumeric.",
- "type": "string"
}
},
"type": "object"
@@ -2875,10 +2726,6 @@
"description": "A set of opt-ins for a user.",
"id": "OptIns",
"properties": {
- "marketComm": {
- "description": "An opt-in about receiving email from Partners marketing teams. Includes\nmember-only events and special promotional offers for Google products.",
- "type": "boolean"
- },
"specialOffers": {
"description": "An opt-in about receiving email regarding new features and products.",
"type": "boolean"
@@ -2894,6 +2741,10 @@
"physicalMail": {
"description": "An opt-in to receive special promotional gifts and material in the mail.",
"type": "boolean"
+ },
+ "marketComm": {
+ "description": "An opt-in about receiving email from Partners marketing teams. Includes\nmember-only events and special promotional offers for Google products.",
+ "type": "boolean"
}
},
"type": "object"
@@ -2902,6 +2753,11 @@
"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": [
@@ -2913,11 +2769,6 @@
"Total final score."
],
"type": "string"
- },
- "value": {
- "description": "The numerical value of the rank.",
- "format": "double",
- "type": "number"
}
},
"type": "object"
@@ -2926,28 +2777,6 @@
"description": "The profile information of a Partners user.",
"id": "UserProfile",
"properties": {
- "emailAddress": {
- "description": "The email address the user has selected on the Partners site as primary.",
- "type": "string"
- },
- "channels": {
- "description": "A list of ids representing which channels the user selected they were in.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "profilePublic": {
- "description": "Whether the user's public profile is visible to anyone with the URL.",
- "type": "boolean"
- },
- "jobFunctions": {
- "description": "A list of ids represnting which job categories the user selected.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"givenName": {
"description": "The user's given name.",
"type": "string"
@@ -2985,18 +2814,40 @@
},
"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"
},
+ "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"
+ },
+ "channels": {
+ "description": "A list of ids representing which channels the user selected they were in.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "profilePublic": {
+ "description": "Whether the user's public profile is visible to anyone with the URL.",
+ "type": "boolean"
+ },
+ "jobFunctions": {
+ "description": "A list of ids represnting which job categories the user selected.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
"type": "object"
@@ -3016,30 +2867,6 @@
"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"
- },
"offerCountryCode": {
"description": "Country Code for the offer country.",
"type": "string"
@@ -3093,6 +2920,45 @@
"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"
+ },
+ "senderName": {
+ "description": "Name (First + Last) of the partners user to whom the incentive is allocated.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserOverrides": {
+ "description": "Values to use instead of the user's respective defaults. These are only\nhonored by whitelisted products.",
+ "id": "UserOverrides",
+ "properties": {
+ "userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
}
},
"type": "object"
@@ -3101,6 +2967,37 @@
"description": "Request message for\nLogUserEvent.",
"id": "LogUserEventRequest",
"properties": {
+ "url": {
+ "description": "The URL where the event occurred.",
+ "type": "string"
+ },
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
+ },
+ "eventScope": {
+ "description": "The scope of the event.",
+ "enum": [
+ "EVENT_SCOPE_UNSPECIFIED",
+ "VISITOR",
+ "SESSION",
+ "PAGE"
+ ],
+ "enumDescriptions": [
+ "Unchosen.",
+ "Based on visitor.",
+ "Based on session.",
+ "Based on page visit."
+ ],
+ "type": "string"
+ },
+ "eventDatas": {
+ "description": "List of event data for the event.",
+ "items": {
+ "$ref": "EventData"
+ },
+ "type": "array"
+ },
"eventCategory": {
"description": "The category the action belongs to.",
"enum": [
@@ -3275,6 +3172,7 @@
"SMB_VIEWED_VIDEO_ADS_CERTIFICATE",
"SMB_VIEWED_SHOPPING_CERTIFICATE",
"SMB_CLICKED_VIDEO_ADS_CERTIFICATE_HELP_ICON",
+ "SMB_VIEWED_DIGITAL_SALES_CERTIFICATE",
"CLICKED_HELP_AT_BOTTOM",
"CLICKED_HELP_AT_TOP",
"CLIENT_ERROR",
@@ -3433,6 +3331,7 @@
"Advertiser viewed VideoAds certificate.",
"Advertiser clicked Shopping certificate help icon.",
"Advertiser clicked VideoAds certificate help icon.",
+ "Advertiser viewed Digital Sales certificate.",
"Clicked `help` at bottom.",
"Clicked `help` at top.",
"Client error occurred.",
@@ -3464,52 +3363,6 @@
"Advertiser entered website in contact form."
],
"type": "string"
- },
- "url": {
- "description": "The URL where the event occurred.",
- "type": "string"
- },
- "requestMetadata": {
- "$ref": "RequestMetadata",
- "description": "Current request metadata."
- },
- "eventScope": {
- "description": "The scope of the event.",
- "enum": [
- "EVENT_SCOPE_UNSPECIFIED",
- "VISITOR",
- "SESSION",
- "PAGE"
- ],
- "enumDescriptions": [
- "Unchosen.",
- "Based on visitor.",
- "Based on session.",
- "Based on page visit."
- ],
- "type": "string"
- },
- "eventDatas": {
- "description": "List of event data for the event.",
- "items": {
- "$ref": "EventData"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "UserOverrides": {
- "description": "Values to use instead of the user's respective defaults. These are only\nhonored by whitelisted products.",
- "id": "UserOverrides",
- "properties": {
- "userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
}
},
"type": "object"
@@ -3518,17 +3371,17 @@
"description": "Details of the analytics events for a `Company` within a single day.",
"id": "AnalyticsDataPoint",
"properties": {
- "eventCount": {
- "description": "Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).",
- "format": "int32",
- "type": "integer"
- },
"eventLocations": {
"description": "Location information of where these events occurred.",
"items": {
"$ref": "LatLng"
},
"type": "array"
+ },
+ "eventCount": {
+ "description": "Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
@@ -3537,10 +3390,6 @@
"description": "Analytics data for a `Company` within a single day.",
"id": "Analytics",
"properties": {
- "contacts": {
- "$ref": "AnalyticsDataPoint",
- "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."
@@ -3552,22 +3401,10 @@
"eventDate": {
"$ref": "Date",
"description": "Date on which these events occurred."
- }
- },
- "type": "object"
- },
- "AdWordsManagerAccountInfo": {
- "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"
+ "contacts": {
+ "$ref": "AnalyticsDataPoint",
+ "description": "Instances of users contacting the `Company`\non the specified date."
}
},
"type": "object"
@@ -3576,10 +3413,6 @@
"description": "Basic information from a public profile.",
"id": "PublicProfile",
"properties": {
- "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"
@@ -3595,6 +3428,26 @@
"id": {
"description": "The ID which can be used to retrieve more details about the public profile.",
"type": "string"
+ },
+ "profileImage": {
+ "description": "The URL to the main profile image of the public profile.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AdWordsManagerAccountInfo": {
+ "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"
}
},
"type": "object"
@@ -3609,6 +3462,155 @@
}
},
"type": "object"
+ },
+ "RecaptchaChallenge": {
+ "description": "<a href=\"https://www.google.com/recaptcha/\">reCaptcha</a> challenge info.",
+ "id": "RecaptchaChallenge",
+ "properties": {
+ "response": {
+ "description": "The response to the reCaptcha challenge.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The ID of 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": {
+ "longitude": {
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "format": "double",
+ "type": "number"
+ },
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "Money": {
+ "description": "Represents an amount of money with its currency type.",
+ "id": "Money",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "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