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

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/partners__v2.json

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/pagespeedonline__v2.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 557ea0c2a1ff530252cb1bc745288dab8633cffd..1b2b1b011f2d94c4bd28894fe97a6abe6c6bac14 100644
--- a/discovery/googleapis/partners__v2.json
+++ b/discovery/googleapis/partners__v2.json
@@ -16,6 +16,22 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
+ "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"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
@@ -37,11 +53,6 @@
"location": "query",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
"$.xgafv": {
"description": "V1 error format.",
"enum": [
@@ -55,6 +66,11 @@
"location": "query",
"type": "string"
},
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
"alt": {
"default": "json",
"description": "Data format for response.",
@@ -85,39 +101,103 @@
"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": {
- "leads": {
+ "companies": {
"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.",
+ "description": "Lists companies.",
"httpMethod": "GET",
- "id": "partners.leads.list",
+ "id": "partners.companies.list",
"parameterOrder": [],
"parameters": {
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
+ "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.",
+ "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.",
+ "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"
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "websiteUrl": {
+ "description": "Website URL that will help to find a better matched company.\n.",
+ "location": "query",
+ "type": "string"
+ },
+ "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"
+ },
+ "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"
},
+ "pageSize": {
+ "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
"requestMetadata.userOverrides.ipAddress": {
"description": "IP address to use instead of the user's geo-located IP address.",
"location": "query",
@@ -129,18 +209,27 @@
"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.",
+ "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"
},
- "orderBy": {
- "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
+ "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"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "maxMonthlyBudget.currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
"location": "query",
"type": "string"
},
@@ -149,164 +238,183 @@
"location": "query",
"type": "string"
},
- "pageToken": {
- "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.",
+ "minMonthlyBudget.currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
"location": "query",
"type": "string"
},
- "pageSize": {
- "description": "Requested page size. Server may return fewer leads than requested.\nIf unspecified, server picks an appropriate default.",
+ "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"
},
- "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.",
+ "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"
}
},
- "path": "v2/leads",
+ "path": "v2/companies",
"response": {
- "$ref": "ListLeadsResponse"
+ "$ref": "ListCompaniesResponse"
}
- }
- }
- },
- "offers": {
- "methods": {
- "list": {
- "description": "Lists the Offers available for the current user",
+ },
+ "get": {
+ "description": "Gets a company.",
"httpMethod": "GET",
- "id": "partners.offers.list",
- "parameterOrder": [],
+ "id": "partners.companies.get",
+ "parameterOrder": [
+ "companyId"
+ ],
"parameters": {
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session 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.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.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",
+ "companyId": {
+ "description": "The ID of the company to retrieve.",
+ "location": "path",
+ "required": true,
"type": "string"
},
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
"location": "query",
+ "repeated": true,
"type": "string"
},
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
+ "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.",
+ "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",
- "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/offers",
- "response": {
- "$ref": "ListOffersResponse"
- }
- }
+ },
+ "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"
+ },
+ "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"
+ },
+ "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}",
+ "response": {
+ "$ref": "GetCompanyResponse"
+ }
+ }
},
"resources": {
- "history": {
+ "leads": {
"methods": {
- "list": {
- "description": "Lists the Historical Offers for the current user (or user's entire company)",
- "httpMethod": "GET",
- "id": "partners.offers.history.list",
- "parameterOrder": [],
+ "create": {
+ "description": "Creates an advertiser lead for the given company ID.",
+ "httpMethod": "POST",
+ "id": "partners.companies.leads.create",
+ "parameterOrder": [
+ "companyId"
+ ],
"parameters": {
- "requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "entireCompany": {
- "description": "if true, show history for the entire company. Requires user to be admin.",
- "location": "query",
- "type": "boolean"
- },
- "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"
- },
- "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"
- },
- "pageToken": {
- "description": "Token to retrieve a specific page.",
- "location": "query",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of rows to return per page.",
- "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",
+ "companyId": {
+ "description": "The ID of the company to contact.",
+ "location": "path",
+ "required": true,
"type": "string"
}
},
- "path": "v2/offers/history",
+ "path": "v2/companies/{companyId}/leads",
+ "request": {
+ "$ref": "CreateLeadRequest"
+ },
"response": {
- "$ref": "ListOffersHistoryResponse"
+ "$ref": "CreateLeadResponse"
}
}
}
}
}
},
- "userStates": {
+ "users": {
"methods": {
- "list": {
- "description": "Lists states for current user.",
- "httpMethod": "GET",
- "id": "partners.userStates.list",
- "parameterOrder": [],
+ "deleteCompanyRelation": {
+ "description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
+ "httpMethod": "DELETE",
+ "id": "partners.users.deleteCompanyRelation",
+ "parameterOrder": [
+ "userId"
+ ],
"parameters": {
"requestMetadata.userOverrides.userId": {
"description": "Logged-in user ID to impersonate instead of the user's ID.",
@@ -343,44 +451,27 @@
"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"
+ },
+ "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"
}
},
- "path": "v2/userStates",
+ "path": "v2/users/{userId}/companyRelation",
"response": {
- "$ref": "ListUserStatesResponse"
+ "$ref": "Empty"
}
- }
- }
- },
- "analytics": {
- "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.",
- "httpMethod": "GET",
- "id": "partners.analytics.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.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"
- },
- "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",
@@ -402,34 +493,61 @@
"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.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"
}
},
- "path": "v2/analytics",
+ "path": "v2/users/{userId}/companyRelation",
+ "request": {
+ "$ref": "CompanyRelation"
+ },
"response": {
- "$ref": "ListAnalyticsResponse"
+ "$ref": "CompanyRelation"
}
- }
- }
- },
- "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.",
+ },
+ "get": {
+ "description": "Gets a user.",
"httpMethod": "GET",
- "id": "partners.getPartnersstatus",
- "parameterOrder": [],
+ "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",
+ "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.",
+ "userView": {
+ "description": "Specifies what parts of the user information to return.",
+ "enum": [
+ "BASIC",
+ "PROFILE",
+ "PUBLIC_PROFILE"
+ ],
"location": "query",
"type": "string"
},
@@ -458,17 +576,23 @@
"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"
+ },
+ "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"
}
},
- "path": "v2/partnersstatus",
+ "path": "v2/users/{userId}",
"response": {
- "$ref": "GetPartnersStatusResponse"
+ "$ref": "User"
}
},
- "updateLeads": {
- "description": "Updates the specified lead.",
+ "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.updateLeads",
+ "id": "partners.users.updateProfile",
"parameterOrder": [],
"parameters": {
"requestMetadata.partnersSessionId": {
@@ -496,12 +620,6 @@
"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.\nOnly `state` and `adwords_customer_id` are currently supported.",
- "format": "google-fieldmask",
- "location": "query",
- "type": "string"
- },
"requestMetadata.experimentIds": {
"description": "Experiment IDs the current request belongs to.",
"location": "query",
@@ -514,131 +632,90 @@
"type": "string"
}
},
- "path": "v2/leads",
+ "path": "v2/users/profile",
"request": {
- "$ref": "Lead"
+ "$ref": "UserProfile"
},
"response": {
- "$ref": "Lead"
+ "$ref": "UserProfile"
}
- },
- "updateCompanies": {
- "description": "Update company.\nShould only be called within the context of an authorized logged in user.",
- "httpMethod": "PATCH",
- "id": "partners.updateCompanies",
+ }
+ }
+ },
+ "userEvents": {
+ "methods": {
+ "log": {
+ "description": "Logs a user event.",
+ "httpMethod": "POST",
+ "id": "partners.userEvents.log",
"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"
- },
- "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.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"
- }
+ "parameters": {},
+ "path": "v2/userEvents:log",
+ "request": {
+ "$ref": "LogUserEventRequest"
},
- "path": "v2/companies",
+ "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": "Company"
+ "$ref": "LogMessageRequest"
},
"response": {
- "$ref": "Company"
+ "$ref": "LogMessageResponse"
}
}
}
},
- "companies": {
+ "exams": {
"methods": {
- "list": {
- "description": "Lists companies.",
+ "getToken": {
+ "description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System",
"httpMethod": "GET",
- "id": "partners.companies.list",
- "parameterOrder": [],
+ "id": "partners.exams.getToken",
+ "parameterOrder": [
+ "examType"
+ ],
"parameters": {
- "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"
- },
- "pageSize": {
- "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "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 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.",
+ "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"
},
- "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.",
+ "examType": {
+ "description": "The exam type we are requesting a token for.",
"enum": [
- "BADGE_SPECIALIZATION_UNKNOWN",
- "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
- "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
- "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
- "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
- "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
+ "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": "query",
- "repeated": true,
- "type": "string"
- },
- "maxMonthlyBudget.currencyCode": {
- "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",
+ "location": "path",
+ "required": true,
"type": "string"
},
"requestMetadata.userOverrides.userId": {
@@ -646,17 +723,13 @@
"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"
- ],
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"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.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"
},
@@ -665,127 +738,66 @@
"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.",
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
"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",
+ }
+ },
+ "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": {
+ "pageToken": {
+ "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"
},
- "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.",
+ "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.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.",
+ "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"
},
- "companyName": {
- "description": "Company name to search for.",
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
"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.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
"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.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
"location": "query",
"repeated": true,
"type": "string"
},
- "websiteUrl": {
- "description": "Website URL that will help to find a better matched company.\n.",
- "location": "query",
- "type": "string"
- },
- "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"
- }
- },
- "path": "v2/companies",
- "response": {
- "$ref": "ListCompaniesResponse"
- }
- },
- "get": {
- "description": "Gets a company.",
- "httpMethod": "GET",
- "id": "partners.companies.get",
- "parameterOrder": [
- "companyId"
- ],
- "parameters": {
- "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.",
+ "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": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
"location": "query",
"type": "string"
},
@@ -798,13 +810,25 @@
"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": [
- "COMPANY_VIEW_UNSPECIFIED",
- "CV_GOOGLE_PARTNER_SEARCH"
- ],
+ }
+ },
+ "path": "v2/leads",
+ "response": {
+ "$ref": "ListLeadsResponse"
+ }
+ }
+ }
+ },
+ "offers": {
+ "methods": {
+ "list": {
+ "description": "Lists the Offers available for the current user",
+ "httpMethod": "GET",
+ "id": "partners.offers.list",
+ "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"
},
@@ -813,85 +837,148 @@
"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"
},
- "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.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"
},
- "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.",
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"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.partnersSessionId": {
+ "description": "Google Partners session ID.",
"location": "query",
"type": "string"
}
},
- "path": "v2/companies/{companyId}",
+ "path": "v2/offers",
"response": {
- "$ref": "GetCompanyResponse"
+ "$ref": "ListOffersResponse"
}
}
},
"resources": {
- "leads": {
+ "history": {
"methods": {
- "create": {
- "description": "Creates an advertiser lead for the given company ID.",
- "httpMethod": "POST",
- "id": "partners.companies.leads.create",
- "parameterOrder": [
- "companyId"
- ],
+ "list": {
+ "description": "Lists the Historical Offers for the current user (or user's entire company)",
+ "httpMethod": "GET",
+ "id": "partners.offers.history.list",
+ "parameterOrder": [],
"parameters": {
- "companyId": {
- "description": "The ID of the company to contact.",
- "location": "path",
- "required": true,
+ "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"
+ },
+ "pageToken": {
+ "description": "Token to retrieve a specific page.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of rows to return per page.",
+ "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"
+ },
+ "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.",
+ "location": "query",
"type": "string"
}
},
- "path": "v2/companies/{companyId}/leads",
- "request": {
- "$ref": "CreateLeadRequest"
- },
+ "path": "v2/offers/history",
"response": {
- "$ref": "CreateLeadResponse"
+ "$ref": "ListOffersHistoryResponse"
}
}
}
}
}
},
- "users": {
+ "userStates": {
"methods": {
- "deleteCompanyRelation": {
- "description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
- "httpMethod": "DELETE",
- "id": "partners.users.deleteCompanyRelation",
- "parameterOrder": [
- "userId"
- ],
+ "list": {
+ "description": "Lists states for current user.",
+ "httpMethod": "GET",
+ "id": "partners.userStates.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",
+ "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",
@@ -902,11 +989,26 @@
"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"
- },
- "userId": {
- "description": "The ID of the user. Can be set to <code>me</code> to mean\nthe currently authenticated user.",
- "location": "path",
- "required": true,
+ }
+ },
+ "path": "v2/userStates",
+ "response": {
+ "$ref": "ListUserStatesResponse"
+ }
+ }
+ }
+ },
+ "analytics": {
+ "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.",
+ "httpMethod": "GET",
+ "id": "partners.analytics.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": {
@@ -914,11 +1016,17 @@
"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 `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",
@@ -933,28 +1041,41 @@
"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/analytics",
"response": {
- "$ref": "Empty"
+ "$ref": "ListAnalyticsResponse"
}
- },
- "createCompanyRelation": {
- "description": "Creates a user's company relation. Affiliates the user to a company.",
- "httpMethod": "PUT",
- "id": "partners.users.createCompanyRelation",
- "parameterOrder": [
- "userId"
- ],
+ }
+ }
+ },
+ "v2": {
+ "methods": {
+ "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.",
+ "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"
},
@@ -973,6 +1094,12 @@
"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.\nOnly `state` and `adwords_customer_id` are currently supported.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ },
"requestMetadata.experimentIds": {
"description": "Experiment IDs the current request belongs to.",
"location": "query",
@@ -983,29 +1110,21 @@
"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"
- },
- "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"
}
},
- "path": "v2/users/{userId}/companyRelation",
+ "path": "v2/leads",
"request": {
- "$ref": "CompanyRelation"
+ "$ref": "Lead"
},
"response": {
- "$ref": "CompanyRelation"
+ "$ref": "Lead"
}
},
- "get": {
- "description": "Gets a user.",
- "httpMethod": "GET",
- "id": "partners.users.get",
- "parameterOrder": [
- "userId"
- ],
+ "updateCompanies": {
+ "description": "Update company.\nShould only be called within the context of an authorized logged in user.",
+ "httpMethod": "PATCH",
+ "id": "partners.updateCompanies",
+ "parameterOrder": [],
"parameters": {
"requestMetadata.experimentIds": {
"description": "Experiment IDs the current request belongs to.",
@@ -1013,34 +1132,18 @@
"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"
},
- "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"
},
- "userView": {
- "description": "Specifies what parts of the user information to return.",
- "enum": [
- "BASIC",
- "PROFILE",
- "PUBLIC_PROFILE"
- ],
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"location": "query",
"type": "string"
},
@@ -1058,17 +1161,26 @@
"description": "IP address to use instead of the user's geo-located IP address.",
"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",
+ "location": "query",
+ "type": "string"
}
},
- "path": "v2/users/{userId}",
+ "path": "v2/companies",
+ "request": {
+ "$ref": "Company"
+ },
"response": {
- "$ref": "User"
+ "$ref": "Company"
}
},
- "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",
+ "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.partnersSessionId": {
@@ -1108,129 +1220,152 @@
"type": "string"
}
},
- "path": "v2/users/profile",
- "request": {
- "$ref": "UserProfile"
- },
+ "path": "v2/partnersstatus",
"response": {
- "$ref": "UserProfile"
+ "$ref": "GetPartnersStatusResponse"
}
}
}
- },
- "userEvents": {
- "methods": {
- "log": {
- "description": "Logs a user event.",
- "httpMethod": "POST",
- "id": "partners.userEvents.log",
- "parameterOrder": [],
- "parameters": {},
- "path": "v2/userEvents:log",
- "request": {
- "$ref": "LogUserEventRequest"
+ }
+ },
+ "revision": "20170829",
+ "rootUrl": "https://partners.googleapis.com/",
+ "schemas": {
+ "ListCompaniesResponse": {
+ "description": "Response message for\nListCompanies.",
+ "id": "ListCompaniesResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the `ListCompaniesRequest.page_token` field in the\nsubsequent call to\nListCompanies to retrieve the\nnext page of results.",
+ "type": "string"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
+ "companies": {
+ "description": "The list of companies.",
+ "items": {
+ "$ref": "Company"
},
- "response": {
- "$ref": "LogUserEventResponse"
- }
+ "type": "array"
}
- }
+ },
+ "type": "object"
},
- "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"
- }
+ "OfferCustomer": {
+ "description": "Customers qualified for an offer.",
+ "id": "OfferCustomer",
+ "properties": {
+ "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"
+ },
+ "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",
+ "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"
+ },
+ "getYAmount": {
+ "description": "Formatted Get Y amount with currency code.",
+ "type": "string"
}
- }
+ },
+ "type": "object"
},
- "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.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"
- },
- "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"
- }
+ "CertificationStatus": {
+ "description": "Google Partners certification status.",
+ "id": "CertificationStatus",
+ "properties": {
+ "userCount": {
+ "description": "Number of people who are certified,",
+ "format": "int32",
+ "type": "integer"
+ },
+ "isCertified": {
+ "description": "Whether certification is passing.",
+ "type": "boolean"
+ },
+ "examStatuses": {
+ "description": "List of certification exam statuses.",
+ "items": {
+ "$ref": "CertificationExamStatus"
},
- "path": "v2/exams/{examType}/token",
- "response": {
- "$ref": "ExamToken"
- }
+ "type": "array"
+ },
+ "type": {
+ "description": "The type of the certification.",
+ "enum": [
+ "CERTIFICATION_TYPE_UNSPECIFIED",
+ "CT_ADWORDS",
+ "CT_YOUTUBE",
+ "CT_VIDEOADS",
+ "CT_ANALYTICS",
+ "CT_DOUBLECLICK",
+ "CT_SHOPPING",
+ "CT_MOBILE",
+ "CT_DIGITAL_SALES",
+ "CT_ADWORDS_SEARCH",
+ "CT_ADWORDS_DISPLAY",
+ "CT_MOBILE_SITES"
+ ],
+ "enumDescriptions": [
+ "Unchosen.",
+ "AdWords certified.",
+ "YouTube certified.",
+ "VideoAds certified.",
+ "Analytics certified.",
+ "DoubleClick certified.",
+ "Shopping certified.",
+ "Mobile certified.",
+ "Digital sales certified.",
+ "AdWords Search certified.",
+ "AdWords Display certified.",
+ "Mobile Sites certified."
+ ],
+ "type": "string"
}
- }
- }
- },
- "revision": "20170812",
- "rootUrl": "https://partners.googleapis.com/",
- "schemas": {
+ },
+ "type": "object"
+ },
"LocalizedCompanyInfo": {
"description": "The localized company information.",
"id": "LocalizedCompanyInfo",
@@ -1272,6 +1407,14 @@
"description": "Response for ListOfferHistory.",
"id": "ListOffersHistoryResponse",
"properties": {
+ "nextPageToken": {
+ "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.",
+ "type": "string"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
"canShowEntireCompany": {
"description": "True if the user has the option to show entire company history.",
"type": "boolean"
@@ -1291,14 +1434,6 @@
"$ref": "HistoricalOffer"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.",
- "type": "string"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
}
},
"type": "object"
@@ -1318,22 +1453,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": [
@@ -1353,6 +1472,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"
@@ -1418,6 +1553,37 @@
"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."
+ },
+ "lastAccessTime": {
+ "description": "The most recent time the user interacted with the Partners site.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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": {
+ "$ref": "AdWordsManagerAccountInfo"
+ },
+ "type": "array"
+ },
+ "primaryEmails": {
+ "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "internalId": {
+ "description": "The internal user ID.\nOnly available for a whitelisted set of api clients.",
+ "type": "string"
+ },
"examStatus": {
"description": "The list of exams the user ever taken. For each type of exam, only one\nentry is listed.",
"items": {
@@ -1433,10 +1599,6 @@
"$ref": "PublicProfile",
"description": "Information about a user's external public profile outside Google Partners."
},
- "companyVerificationEmail": {
- "description": "The email address used by the user used for company verification.\n@OutputOnly",
- "type": "string"
- },
"certificationStatus": {
"description": "The list of achieved certifications. These are calculated based on exam\nresults and other requirements.\n@OutputOnly",
"items": {
@@ -1444,35 +1606,8 @@
},
"type": "array"
},
- "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."
- },
- "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",
- "items": {
- "type": "string"
- },
- "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",
- "items": {
- "$ref": "AdWordsManagerAccountInfo"
- },
- "type": "array"
- },
- "internalId": {
- "description": "The internal user ID.\nOnly available for a whitelisted set of api clients.",
+ "companyVerificationEmail": {
+ "description": "The email address used by the user used for company verification.\n@OutputOnly",
"type": "string"
}
},
@@ -1504,33 +1639,6 @@
},
"type": "object"
},
- "ListLeadsResponse": {
- "description": "Response message for ListLeads.",
- "id": "ListLeadsResponse",
- "properties": {
- "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"
- }
- },
- "type": "object"
- },
"Company": {
"description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.",
"id": "Company",
@@ -1599,6 +1707,10 @@
},
"type": "array"
},
+ "id": {
+ "description": "The ID of the company.",
+ "type": "string"
+ },
"certificationStatuses": {
"description": "The list of Google Partners certification statuses for the company.",
"items": {
@@ -1606,14 +1718,6 @@
},
"type": "array"
},
- "id": {
- "description": "The ID of the company.",
- "type": "string"
- },
- "publicProfile": {
- "$ref": "PublicProfile",
- "description": "Basic information from the company's public profile."
- },
"primaryLocation": {
"$ref": "Location",
"description": "The primary location of the company."
@@ -1647,6 +1751,10 @@
"$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": {
@@ -1654,13 +1762,6 @@
},
"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": [
@@ -1675,10 +1776,10 @@
],
"type": "string"
},
- "autoApprovalEmailDomains": {
- "description": "Email domains that allow users with a matching email address to get\nauto-approved for associating with this company.",
+ "specializationStatus": {
+ "description": "The list of Google Partners specialization statuses for the company.",
"items": {
- "type": "string"
+ "$ref": "SpecializationStatus"
},
"type": "array"
},
@@ -1715,6 +1816,13 @@
},
"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"
+ },
"profileStatus": {
"description": "The public viewability status of the company's profile.",
"enum": [
@@ -1731,14 +1839,41 @@
],
"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"
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "ListLeadsResponse": {
+ "description": "Response message for ListLeads.",
+ "id": "ListLeadsResponse",
+ "properties": {
+ "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"
},
- "locations": {
- "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.",
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
+ "leads": {
+ "description": "The list of leads.",
"items": {
- "$ref": "Location"
+ "$ref": "Lead"
},
"type": "array"
}
@@ -1749,6 +1884,10 @@
"description": "Response message for CreateLead.",
"id": "CreateLeadResponse",
"properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
"recaptchaStatus": {
"description": "The outcome of <a href=\"https://www.google.com/recaptcha/\">reCaptcha</a>\nvalidation.",
"enum": [
@@ -1768,10 +1907,6 @@
"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"
@@ -1780,13 +1915,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"
@@ -1795,28 +1930,28 @@
"description": "A location with address and geographic coordinates. May optionally contain a\ndetailed (multi-field) version of the address.",
"id": "Location",
"properties": {
- "administrativeArea": {
- "description": "Top-level administrative subdivision of this country.",
- "type": "string"
- },
"locality": {
"description": "Generally refers to the city/town portion of an address.",
"type": "string"
},
+ "administrativeArea": {
+ "description": "Top-level administrative subdivision of this country.",
+ "type": "string"
+ },
"latLng": {
"$ref": "LatLng",
"description": "The latitude and longitude of the location, in degrees."
},
- "address": {
- "description": "The single string version of the address.",
+ "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"
},
- "regionCode": {
- "description": "CLDR (Common Locale Data Repository) region code .",
+ "address": {
+ "description": "The single string version of the address.",
"type": "string"
},
"postalCode": {
@@ -1845,6 +1980,11 @@
"description": "Status for a Google Partners certification exam.",
"id": "CertificationExamStatus",
"properties": {
+ "numberUsersPass": {
+ "description": "The number of people who have passed the certification exam.",
+ "format": "int32",
+ "type": "integer"
+ },
"type": {
"description": "The type of certification exam.",
"enum": [
@@ -1874,11 +2014,6 @@
"Mobile Sites exam."
],
"type": "string"
- },
- "numberUsersPass": {
- "description": "The number of people who have passed the certification exam.",
- "format": "int32",
- "type": "integer"
}
},
"type": "object"
@@ -1887,6 +2022,15 @@
"description": "A token that allows a user to take an exam.",
"id": "ExamToken",
"properties": {
+ "examId": {
+ "description": "The id of the exam the token is for.",
+ "format": "int64",
+ "type": "string"
+ },
+ "token": {
+ "description": "The token, only present if the user has access to the exam.",
+ "type": "string"
+ },
"examType": {
"description": "The type of the exam the token belongs to.",
"enum": [
@@ -1916,15 +2060,6 @@
"Mobile Sites exam."
],
"type": "string"
- },
- "examId": {
- "description": "The id of the exam the token is for.",
- "format": "int64",
- "type": "string"
- },
- "token": {
- "description": "The token, only present if the user has access to the exam.",
- "type": "string"
}
},
"type": "object"
@@ -1933,6 +2068,14 @@
"description": "A set of opt-ins for a user.",
"id": "OptIns",
"properties": {
+ "specialOffers": {
+ "description": "An opt-in about receiving email regarding new features and products.",
+ "type": "boolean"
+ },
+ "performanceSuggestions": {
+ "description": "An opt-in about receiving email with customized AdWords campaign management\ntips.",
+ "type": "boolean"
+ },
"phoneContact": {
"description": "An opt-in to allow recieivng phone calls about their Partners account.",
"type": "boolean"
@@ -1944,14 +2087,6 @@
"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"
- },
- "performanceSuggestions": {
- "description": "An opt-in about receiving email with customized AdWords campaign management\ntips.",
- "type": "boolean"
}
},
"type": "object"
@@ -1960,11 +2095,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": [
@@ -1976,17 +2106,11 @@
"Total final score."
],
"type": "string"
- }
- },
- "type": "object"
- },
- "GetPartnersStatusResponse": {
- "description": "Response message for\nGetPartnersStatus.",
- "id": "GetPartnersStatusResponse",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
+ },
+ "value": {
+ "description": "The numerical value of the rank.",
+ "format": "double",
+ "type": "number"
}
},
"type": "object"
@@ -1995,15 +2119,15 @@
"description": "The profile information of a Partners user.",
"id": "UserProfile",
"properties": {
- "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"
@@ -2012,10 +2136,6 @@
"description": "The email address the user has selected on the Partners site as primary.",
"type": "string"
},
- "profilePublic": {
- "description": "Whether the user's public profile is visible to anyone with the URL.",
- "type": "boolean"
- },
"channels": {
"description": "A list of ids representing which channels the user selected they were in.",
"items": {
@@ -2023,6 +2143,10 @@
},
"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": {
@@ -2045,10 +2169,6 @@
},
"type": "array"
},
- "emailOptIns": {
- "$ref": "OptIns",
- "description": "The list of opt-ins for the user, related to communication preferences."
- },
"languages": {
"description": "The list of languages this user understands.",
"items": {
@@ -2060,6 +2180,10 @@
"description": "The user's family name.",
"type": "string"
},
+ "emailOptIns": {
+ "$ref": "OptIns",
+ "description": "The list of opt-ins for the user, related to communication preferences."
+ },
"markets": {
"description": "A list of ids representing which markets the user was interested in.",
"items": {
@@ -2070,19 +2194,30 @@
},
"type": "object"
},
+ "GetPartnersStatusResponse": {
+ "description": "Response message for\nGetPartnersStatus.",
+ "id": "GetPartnersStatusResponse",
+ "properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ },
+ "type": "object"
+ },
"HistoricalOffer": {
"description": "Historical information about a Google Partners Offer.",
"id": "HistoricalOffer",
"properties": {
- "offerCode": {
- "description": "Offer code.",
- "type": "string"
- },
"creationTime": {
"description": "Time offer was first created.",
"format": "google-datetime",
"type": "string"
},
+ "clientEmail": {
+ "description": "Email address for client.",
+ "type": "string"
+ },
"status": {
"description": "Status of the offer.",
"enum": [
@@ -2101,10 +2236,6 @@
],
"type": "string"
},
- "clientEmail": {
- "description": "Email address for client.",
- "type": "string"
- },
"clientId": {
"description": "ID of client.",
"format": "int64",
@@ -2151,6 +2282,10 @@
"description": "Time this offer expires.",
"format": "google-datetime",
"type": "string"
+ },
+ "offerCode": {
+ "description": "Offer code.",
+ "type": "string"
}
},
"type": "object"
@@ -2159,6 +2294,37 @@
"description": "Request message for\nLogUserEvent.",
"id": "LogUserEventRequest",
"properties": {
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
+ },
+ "url": {
+ "description": "The URL where the event occurred.",
+ "type": "string"
+ },
+ "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": [
@@ -2497,62 +2663,31 @@
"Clicked `help` at top.",
"Client error occurred.",
"Agency clicked left nav `stories`.",
- "Click occured.",
- "Advertiser clicked Mobile certificate help icon.",
- "Agency failed the company verification.",
- "User visited the landing portion of Google Partners.",
- "User visited the Google Partner Search portion of Google Partners.",
- "User visited the agency portal portion of Google Partners.",
- "User cancelled signing up.",
- "User cancelled signing up their company.",
- "Agency clicked `Sign in` top button.",
- "Agency clicked `save and continue` at bottom of incomplete profile.",
- "Agency unselected `opt-in news invitations and promotions`.",
- "Agency unselected `opt-in beta tests and market research`.",
- "Agency unselected `opt-in performance suggestions`.",
- "Agency selected `opt-out unselect all email notifications`.",
- "Agency linked their individual MCC.",
- "Agency was suggested to user for affiliation.",
- "Agency ignored suggested agencies and begin searching.",
- "Agency picked a suggested agency.",
- "Agency searched for agencies.",
- "Agency picked a searched agency.",
- "Agency dismissed affiliation widget.",
- "Agency clicked on the download link for downloading content.",
- "Agency user is maklingg progress viewing a content item.",
- "Agency clicked `cancel Terms Of Service` button.",
- "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."
- },
- "eventDatas": {
- "description": "List of event data for the event.",
- "items": {
- "$ref": "EventData"
- },
- "type": "array"
- },
- "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."
+ "Click occured.",
+ "Advertiser clicked Mobile certificate help icon.",
+ "Agency failed the company verification.",
+ "User visited the landing portion of Google Partners.",
+ "User visited the Google Partner Search portion of Google Partners.",
+ "User visited the agency portal portion of Google Partners.",
+ "User cancelled signing up.",
+ "User cancelled signing up their company.",
+ "Agency clicked `Sign in` top button.",
+ "Agency clicked `save and continue` at bottom of incomplete profile.",
+ "Agency unselected `opt-in news invitations and promotions`.",
+ "Agency unselected `opt-in beta tests and market research`.",
+ "Agency unselected `opt-in performance suggestions`.",
+ "Agency selected `opt-out unselect all email notifications`.",
+ "Agency linked their individual MCC.",
+ "Agency was suggested to user for affiliation.",
+ "Agency ignored suggested agencies and begin searching.",
+ "Agency picked a suggested agency.",
+ "Agency searched for agencies.",
+ "Agency picked a searched agency.",
+ "Agency dismissed affiliation widget.",
+ "Agency clicked on the download link for downloading content.",
+ "Agency user is maklingg progress viewing a content item.",
+ "Agency clicked `cancel Terms Of Service` button.",
+ "Advertiser entered website in contact form."
],
"type": "string"
}
@@ -2616,6 +2751,22 @@
},
"type": "object"
},
+ "AdWordsManagerAccountInfo": {
+ "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186",
+ "id": "AdWordsManagerAccountInfo",
+ "properties": {
+ "id": {
+ "description": "The AdWords Manager Account id.",
+ "format": "int64",
+ "type": "string"
+ },
+ "customerName": {
+ "description": "Name of the customer this account represents.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"PublicProfile": {
"description": "Basic information from a public profile.",
"id": "PublicProfile",
@@ -2643,22 +2794,6 @@
},
"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"
- },
"ResponseMetadata": {
"description": "Common data that is in each API response.",
"id": "ResponseMetadata",
@@ -2674,13 +2809,13 @@
"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"
+ },
+ "response": {
+ "description": "The response to the reCaptcha challenge.",
+ "type": "string"
}
},
"type": "object"
@@ -2689,31 +2824,6 @@
"description": "Available Offers to be distributed.",
"id": "AvailableOffer",
"properties": {
- "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"
@@ -2777,6 +2887,31 @@
"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"
}
},
"type": "object"
@@ -2785,13 +2920,13 @@
"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].",
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"format": "double",
"type": "number"
},
- "latitude": {
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "longitude": {
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double",
"type": "number"
}
@@ -2802,11 +2937,6 @@
"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"
@@ -2815,6 +2945,11 @@
"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"
@@ -2845,6 +2980,17 @@
"description": "Request message for\nLogClientMessage.",
"id": "LogMessageRequest",
"properties": {
+ "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."
+ },
"level": {
"description": "Message level of client message.",
"enum": [
@@ -2866,17 +3012,6 @@
"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."
}
},
"type": "object"
@@ -2885,6 +3020,24 @@
"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"
+ },
+ "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": [
@@ -2897,38 +3050,20 @@
],
"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"
},
- "websiteUrl": {
- "description": "Website URL of lead source.",
- "type": "string"
+ "minMonthlyBudget": {
+ "$ref": "Money",
+ "description": "The minimum monthly budget lead source is willing to spend."
},
"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"
},
- "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."
- ],
+ "websiteUrl": {
+ "description": "Website URL of lead source.",
"type": "string"
},
"gpsMotivations": {
@@ -2950,6 +3085,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"
@@ -2958,31 +3111,13 @@
"description": "Last name of lead source.",
"type": "string"
},
- "id": {
- "description": "ID of the lead.",
- "type": "string"
- },
"comments": {
"description": "Comments lead source gave.",
"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",
+ "id": {
+ "description": "ID of the lead.",
"type": "string"
- },
- "marketingOptIn": {
- "description": "Whether or not the lead signed up for marketing emails",
- "type": "boolean"
}
},
"type": "object"
@@ -3010,6 +3145,10 @@
"description": "Response message for\nListUserStates.",
"id": "ListUserStatesResponse",
"properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
"userStates": {
"description": "User's states.",
"enumDescriptions": [
@@ -3024,10 +3163,6 @@
"type": "string"
},
"type": "array"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
}
},
"type": "object"
@@ -3040,19 +3175,19 @@
"description": "The timestamp when the user was approved.\n@OutputOnly",
"format": "google-datetime",
"type": "string"
- },
- "companyAdmin": {
- "description": "Indicates if the user is an admin for this company.",
- "type": "boolean"
- },
- "isPending": {
- "description": "The flag that indicates if the company is pending verification.",
+ },
+ "companyAdmin": {
+ "description": "Indicates if the user is an admin for this company.",
"type": "boolean"
},
"address": {
"description": "The primary address for this company.",
"type": "string"
},
+ "isPending": {
+ "description": "The flag that indicates if the company is pending verification.",
+ "type": "boolean"
+ },
"creationTime": {
"description": "The timestamp of when affiliation was requested.\n@OutputOnly",
"format": "google-datetime",
@@ -3078,15 +3213,15 @@
],
"type": "string"
},
+ "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": [
@@ -3201,36 +3336,6 @@
},
"type": "object"
},
- "RequestMetadata": {
- "description": "Common data that is in each API request.",
- "id": "RequestMetadata",
- "properties": {
- "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"
- }
- },
- "type": "object"
- },
"CreateLeadRequest": {
"description": "Request message for CreateLead.",
"id": "CreateLeadRequest",
@@ -3250,17 +3355,40 @@
},
"type": "object"
},
- "EventData": {
- "description": "Key value data pair for an event.",
- "id": "EventData",
+ "RequestMetadata": {
+ "description": "Common data that is in each API request.",
+ "id": "RequestMetadata",
"properties": {
- "values": {
- "description": "Data values.",
+ "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"
},
+ "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."
+ }
+ },
+ "type": "object"
+ },
+ "EventData": {
+ "description": "Key value data pair for an event.",
+ "id": "EventData",
+ "properties": {
"key": {
"description": "Data type.",
"enum": [
@@ -3344,6 +3472,13 @@
"Progress when viewing an item \\[0-100\\]."
],
"type": "string"
+ },
+ "values": {
+ "description": "Data values.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
"type": "object"
@@ -3352,20 +3487,6 @@
"description": "A user's information on a specific exam.",
"id": "ExamStatus",
"properties": {
- "warning": {
- "description": "Whether this exam is in the state of warning.",
- "type": "boolean"
- },
- "expiration": {
- "description": "Date this exam is due to expire.",
- "format": "google-datetime",
- "type": "string"
- },
- "lastPassed": {
- "description": "The date the user last passed this exam.",
- "format": "google-datetime",
- "type": "string"
- },
"examType": {
"description": "The type of the exam.",
"enum": [
@@ -3404,6 +3525,20 @@
"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"
+ },
+ "expiration": {
+ "description": "Date this exam is due to expire.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "lastPassed": {
+ "description": "The date the user last passed this exam.",
+ "format": "google-datetime",
+ "type": "string"
}
},
"type": "object"
@@ -3446,18 +3581,6 @@
"description": "Offer info by country.",
"id": "CountryOfferInfo",
"properties": {
- "getYAmount": {
- "description": "(localized) Get Y amount for that country's offer.",
- "type": "string"
- },
- "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": [
@@ -3473,141 +3596,18 @@
"Spend Match up to Y."
],
"type": "string"
- }
- },
- "type": "object"
- },
- "ListCompaniesResponse": {
- "description": "Response message for\nListCompanies.",
- "id": "ListCompaniesResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the `ListCompaniesRequest.page_token` field in the\nsubsequent call to\nListCompanies to retrieve the\nnext page of results.",
- "type": "string"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
- "companies": {
- "description": "The list of companies.",
- "items": {
- "$ref": "Company"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OfferCustomer": {
- "description": "Customers qualified for an offer.",
- "id": "OfferCustomer",
- "properties": {
- "adwordsUrl": {
- "description": "URL to the customer's AdWords page.",
- "type": "string"
- },
- "countryCode": {
- "description": "Country code of the customer.",
- "type": "string"
- },
- "externalCid": {
- "description": "External CID for the customer.",
- "format": "int64",
- "type": "string"
- },
- "offerType": {
- "description": "Type of the 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"
- },
- "eligibilityDaysLeft": {
- "description": "Days the customer is still eligible.",
- "format": "int32",
- "type": "integer"
- },
- "creationTime": {
- "description": "Time the customer was created.",
- "format": "google-datetime",
- "type": "string"
},
"getYAmount": {
- "description": "Formatted Get Y amount with currency code.",
- "type": "string"
- },
- "name": {
- "description": "Name of the customer.",
+ "description": "(localized) Get Y amount for that country's offer.",
"type": "string"
},
"spendXAmount": {
- "description": "Formatted Spend X amount with currency code.",
+ "description": "(localized) Spend X amount for that country's offer.",
"type": "string"
- }
- },
- "type": "object"
- },
- "CertificationStatus": {
- "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": [
- "CERTIFICATION_TYPE_UNSPECIFIED",
- "CT_ADWORDS",
- "CT_YOUTUBE",
- "CT_VIDEOADS",
- "CT_ANALYTICS",
- "CT_DOUBLECLICK",
- "CT_SHOPPING",
- "CT_MOBILE",
- "CT_DIGITAL_SALES",
- "CT_ADWORDS_SEARCH",
- "CT_ADWORDS_DISPLAY",
- "CT_MOBILE_SITES"
- ],
- "enumDescriptions": [
- "Unchosen.",
- "AdWords certified.",
- "YouTube certified.",
- "VideoAds certified.",
- "Analytics certified.",
- "DoubleClick certified.",
- "Shopping certified.",
- "Mobile certified.",
- "Digital sales certified.",
- "AdWords Search certified.",
- "AdWords Display certified.",
- "Mobile Sites certified."
- ],
+ "offerCountryCode": {
+ "description": "Country code for which offer codes may be requested.",
"type": "string"
- },
- "userCount": {
- "description": "Number of people who are certified,",
- "format": "int32",
- "type": "integer"
- },
- "isCertified": {
- "description": "Whether certification is passing.",
- "type": "boolean"
}
},
"type": "object"
« no previous file with comments | « discovery/googleapis/pagespeedonline__v2.json ('k') | discovery/googleapis/people__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698