openapi-directory/api/googleapis.com/partners.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"name":"Google","url":"https://google.com"},"description":"Searches certified companies and creates contact leads with them, and also audits the usage of clients.","title":"Google Partners","version":"v2","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.6.2"},"format":"google","url":"https://partners.googleapis.com/$discovery/rest?version=v2","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"partners"},"externalDocs":{"url":"https://developers.google.com/partners/"},"tags":[{"name":"analytics"},{"name":"clientMessages"},{"name":"companies"},{"name":"leads"},{"name":"offers"},{"name":"userEvents"},{"name":"userStates"},{"name":"users"},{"name":"v2"}],"paths":{"/v2/analytics":{"get":{"description":"Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user.","operationId":"partners.analytics.list","parameters":[{"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.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"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.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListAnalyticsResponse"}}}}},"tags":["analytics"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v2/clientMessages:log":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"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.","operationId":"partners.clientMessages.log","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogMessageRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LogMessageResponse"}}}}},"tags":["clientMessages"]}},"/v2/companies":{"get":{"description":"Lists companies.","operationId":"partners.companies.list","parameters":[{"description":"The address to use when searching for companies.\nIf not given, the geo-located address of the request is used.","in":"query","name":"address","schema":{"type":"string"}},{"description":"Company name to search for.","in":"query","name":"companyName","schema":{"type":"string"}},{"description":"List of reasons for using Google Partner Search to get companies.","in":"query","name":"gpsMotivations","explode":true,"schema":{"type":"array","items":{"enum":["GPS_MOTIVATION_UNSPECIFIED","GPSM_HELP_WITH_ADVERTISING","GPSM_HELP_WITH_WEBSITE","GPSM_NO_WEBSITE"],"type":"string"}}},{"description":"List of industries the company can help with.","in":"query","name":"industries","explode":true,"schema":{"type":"array","items":{"enum":["INDUSTRY_UNSPECIFIED","I_AUTOMOTIVE","I_BUSINESS_TO_BUSINESS","I_CONSUMER_PACKAGED_GOODS","I_EDUCATION","I_FINANCE","I_HEALTHCARE","I_MEDIA_AND_ENTERTAINMENT","I_RETAIL","I_TECHNOLOGY","I_TRAVEL"],"type":"string"}}},{"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\").","in":"query","name":"languageCodes","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"The 3-letter currency code defined in ISO 4217.","in":"query","name":"maxMonthlyBudget.currencyCode","schema":{"type":"string"}},{"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.","in":"query","name":"maxMonthlyBudget.nanos","schema":{"type":"integer"}},{"description":"The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.","in":"query","name":"maxMonthlyBudget.units","schema":{"type":"string"}},{"description":"The 3-letter currency code defined in ISO 4217.","in":"query","name":"minMonthlyBudget.currencyCode","schema":{"type":"string"}},{"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.","in":"query","name":"minMonthlyBudget.nanos","schema":{"type":"integer"}},{"description":"The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.","in":"query","name":"minMonthlyBudget.units","schema":{"type":"string"}},{"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.","in":"query","name":"orderBy","schema":{"type":"string"}},{"description":"Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"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.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}},{"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.","in":"query","name":"services","explode":true,"schema":{"type":"array","items":{"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"],"type":"string"}}},{"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.","in":"query","name":"specializations","explode":true,"schema":{"type":"array","items":{"enum":["BADGE_SPECIALIZATION_UNKNOWN","BADGE_SPECIALIZATION_ADWORDS_SEARCH","BADGE_SPECIALIZATION_ADWORDS_DISPLAY","BADGE_SPECIALIZATION_ADWORDS_MOBILE","BADGE_SPECIALIZATION_ADWORDS_VIDEO","BADGE_SPECIALIZATION_ADWORDS_SHOPPING"],"type":"string"}}},{"description":"The view of the `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.","in":"query","name":"view","schema":{"type":"string","enum":["COMPANY_VIEW_UNSPECIFIED","CV_GOOGLE_PARTNER_SEARCH"]}},{"description":"Website URL that will help to find a better matched company.\n.","in":"query","name":"websiteUrl","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListCompaniesResponse"}}}}},"tags":["companies"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"patch":{"description":"Update company.\nShould only be called within the context of an authorized logged in user.","operationId":"partners.updateCompanies","parameters":[{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}},{"description":"Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Company"}}}}},"tags":["v2"]}},"/v2/companies/{companyId}":{"get":{"description":"Gets a company.","operationId":"partners.companies.get","parameters":[{"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.","in":"query","name":"address","schema":{"type":"string"}},{"description":"The ID of the company to retrieve.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}},{"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.","in":"query","name":"currencyCode","schema":{"type":"string"}},{"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.","in":"query","name":"orderBy","schema":{"type":"string"}},{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}},{"description":"The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.","in":"query","name":"view","schema":{"type":"string","enum":["COMPANY_VIEW_UNSPECIFIED","CV_GOOGLE_PARTNER_SEARCH"]}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetCompanyResponse"}}}}},"tags":["companies"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v2/companies/{companyId}/leads":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Creates an advertiser lead for the given company ID.","operationId":"partners.companies.leads.create","parameters":[{"description":"The ID of the company to contact.","in":"path","name":"companyId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLeadRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CreateLeadResponse"}}}}},"tags":["companies"]}},"/v2/leads":{"get":{"description":"Lists advertiser leads for a user's associated company.\nShould only be called within the context of an authorized logged in user.","operationId":"partners.leads.list","parameters":[{"description":"How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported","in":"query","name":"orderBy","schema":{"type":"string"}},{"description":"Requested page size. Server may return fewer leads than requested.\nIf unspecified, server picks an appropriate default.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"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.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListLeadsResponse"}}}}},"tags":["leads"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"patch":{"description":"Updates the specified lead.","operationId":"partners.updateLeads","parameters":[{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}},{"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.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lead"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Lead"}}}}},"tags":["v2"]}},"/v2/offers":{"get":{"description":"Lists the Offers available for the current user","operationId":"partners.offers.list","parameters":[{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListOffersResponse"}}}}},"tags":["offers"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v2/offers/history":{"get":{"description":"Lists the Historical Offers for the current user (or user's entire company)","operationId":"partners.offers.history.list","parameters":[{"description":"if true, show history for the entire company.  Requires user to be admin.","in":"query","name":"entireCompany","schema":{"type":"boolean"}},{"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.","in":"query","name":"orderBy","schema":{"type":"string"}},{"description":"Maximum number of rows to return per page.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Token to retrieve a specific page.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListOffersHistoryResponse"}}}}},"tags":["offers"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v2/partnersstatus":{"get":{"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.","operationId":"partners.getPartnersstatus","parameters":[{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetPartnersStatusResponse"}}}}},"tags":["v2"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v2/userEvents:log":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Logs a user event.","operationId":"partners.userEvents.log","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogUserEventRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LogUserEventResponse"}}}}},"tags":["userEvents"]}},"/v2/userStates":{"get":{"description":"Lists states for current user.","operationId":"partners.userStates.list","parameters":[{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListUserStatesResponse"}}}}},"tags":["userStates"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v2/users/profile":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"patch":{"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.","operationId":"partners.users.updateProfile","parameters":[{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}}},"tags":["users"]}},"/v2/users/{userId}":{"get":{"description":"Gets a user.","operationId":"partners.users.get","parameters":[{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}},{"description":"Identifier of the user. Can be set to <code>me</code> to mean the currently\nauthenticated user.","in":"path","name":"userId","required":true,"schema":{"type":"string"}},{"description":"Specifies what parts of the user information to return.","in":"query","name":"userView","schema":{"type":"string","enum":["BASIC","PROFILE","PUBLIC_PROFILE"]}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/User"}}}}},"tags":["users"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v2/users/{userId}/companyRelation":{"delete":{"description":"Deletes a user's company relation. Unaffiliaites the user from a company.","operationId":"partners.users.deleteCompanyRelation","parameters":[{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}},{"description":"The ID of the user. Can be set to <code>me</code> to mean\nthe currently authenticated user.","in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Empty"}}}}},"tags":["users"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/bearer_token"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/pp"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"put":{"description":"Creates a user's company relation. Affiliates the user to a company.","operationId":"partners.users.createCompanyRelation","parameters":[{"description":"Experiment IDs the current request belongs to.","in":"query","name":"requestMetadata.experimentIds","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Locale to use for the current request.","in":"query","name":"requestMetadata.locale","schema":{"type":"string"}},{"description":"Google Partners session ID.","in":"query","name":"requestMetadata.partnersSessionId","schema":{"type":"string"}},{"description":"Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.","in":"query","name":"requestMetadata.trafficSource.trafficSourceId","schema":{"type":"string"}},{"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.","in":"query","name":"requestMetadata.trafficSource.trafficSubId","schema":{"type":"string"}},{"description":"IP address to use instead of the user's geo-located IP address.","in":"query","name":"requestMetadata.userOverrides.ipAddress","schema":{"type":"string"}},{"description":"Logged-in user ID to impersonate instead of the user's ID.","in":"query","name":"requestMetadata.userOverrides.userId","schema":{"type":"string"}},{"description":"The ID of the user. Can be set to <code>me</code> to mean\nthe currently authenticated user.","in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyRelation"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompanyRelation"}}}}},"tags":["users"]}}},"servers":[{"url":"https://partners.googleapis.com/"}],"components":{"parameters":{"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"type":"string","enum":["json","media","proto"],"default":"json"}},"bearer_token":{"description":"OAuth bearer token.","in":"query","name":"bearer_token","schema":{"type":"string"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"pp":{"description":"Pretty-print response.","in":"query","name":"pp","schema":{"type":"boolean","default":true}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean","default":true}},"quotaUser":{"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}},"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"type":"string","enum":["1","2"]}}},"schemas":{"AdWordsManagerAccountInfo":{"description":"Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186","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"},"Analytics":{"description":"Analytics data for a `Company` within a single day.","properties":{"contacts":{"$ref":"#/components/schemas/AnalyticsDataPoint"},"eventDate":{"$ref":"#/components/schemas/Date"},"profileViews":{"$ref":"#/components/schemas/AnalyticsDataPoint"},"searchViews":{"$ref":"#/components/schemas/AnalyticsDataPoint"}},"type":"object"},"AnalyticsDataPoint":{"description":"Details of the analytics events for a `Company` within a single day.","properties":{"eventCount":{"description":"Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).","format":"int32","type":"integer"},"eventLocations":{"description":"Location information of where these events occurred.","items":{"$ref":"#/components/schemas/LatLng"},"type":"array"}},"type":"object"},"AnalyticsSummary":{"description":"Analytics aggregated data for a `Company` for a given date range.","properties":{"contactsCount":{"description":"Aggregated number of times users contacted the `Company`\nfor given date range.","format":"int32","type":"integer"},"profileViewsCount":{"description":"Aggregated number of profile views for the `Company` for given date range.","format":"int32","type":"integer"},"searchViewsCount":{"description":"Aggregated number of times users saw the `Company`\nin Google Partners Search results for given date range.","format":"int32","type":"integer"}},"type":"object"},"AvailableOffer":{"description":"Available Offers to be distributed.","properties":{"available":{"description":"The number of codes for this offer that are available for distribution.","format":"int32","type":"integer"},"countryOfferInfos":{"description":"Offer info by country.","items":{"$ref":"#/components/schemas/CountryOfferInfo"},"type":"array"},"description":{"description":"Description of the offer.","type":"string"},"id":{"description":"ID of this offer.","format":"int64","type":"string"},"maxAccountAge":{"description":"The maximum age of an account [in days] to be eligible.","format":"int32","type":"integer"},"name":{"description":"Name of the offer.","type":"string"},"offerLevel":{"description":"Level of this offer.","enum":["OFFER_LEVEL_UNSPECIFIED","OFFER_LEVEL_DENY_PROBLEM","OFFER_LEVEL_DENY_CONTRACT","OFFER_LEVEL_MANUAL","OFFER_LEVEL_LIMIT_0","OFFER_LEVEL_LIMIT_5","OFFER_LEVEL_LIMIT_15","OFFER_LEVEL_LIMIT_50"],"type":"string"},"offerType":{"description":"Type of offer.","enum":["OFFER_TYPE_UNSPECIFIED","OFFER_TYPE_SPEND_X_GET_Y","OFFER_TYPE_VIDEO","OFFER_TYPE_SPEND_MATCH"],"type":"string"},"qualifiedCustomer":{"description":"Customers who qualify for this offer.","items":{"$ref":"#/components/schemas/OfferCustomer"},"type":"array"},"qualifiedCustomersComplete":{"description":"Whether or not the list of qualified customers is definitely complete.","type":"boolean"},"showSpecialOfferCopy":{"description":"Should special text be shown on the offers page.","type":"boolean"},"terms":{"description":"Terms of the offer.","type":"string"}},"type":"object"},"Certification":{"description":"A user's information on a specific certification.","properties":{"achieved":{"description":"Whether this certification has been achieved.","type":"boolean"},"certificationType":{"description":"The type of certification, the area of expertise.","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"],"type":"string"},"expiration":{"description":"Date this certification is due to expire.","format":"google-datetime","type":"string"},"lastAchieved":{"description":"The date the user last achieved certification.","format":"google-datetime","type":"string"},"warning":{"description":"Whether this certification is in the state of warning.","type":"boolean"}},"type":"object"},"CertificationExamStatus":{"description":"Status for a Google Partners certification exam.","properties":{"numberUsersPass":{"description":"The number of people