Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
(no description)
| File Size: | 1610 lines (45 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 33 classes
Google_Service_Partners:: (1 method):
__construct()
Google_Service_Partners_ClientMessages_Resource:: (1 method):
log()
Google_Service_Partners_Companies_Resource:: (2 methods):
get()
listCompanies()
Google_Service_Partners_CompaniesLeads_Resource:: (1 method):
create()
Google_Service_Partners_UserEvents_Resource:: (1 method):
log()
Google_Service_Partners_UserStates_Resource:: (1 method):
listUserStates()
Google_Service_Partners_CertificationExamStatus:: (4 methods):
setNumberUsersPass()
getNumberUsersPass()
setType()
getType()
Google_Service_Partners_CertificationStatus:: (6 methods):
setExamStatuses()
getExamStatuses()
setIsCertified()
getIsCertified()
setType()
getType()
Google_Service_Partners_Company:: (24 methods):
setCertificationStatuses()
getCertificationStatuses()
setConvertedMinMonthlyBudget()
getConvertedMinMonthlyBudget()
setId()
getId()
setIndustries()
getIndustries()
setLocalizedInfos()
getLocalizedInfos()
setLocations()
getLocations()
setName()
getName()
setOriginalMinMonthlyBudget()
getOriginalMinMonthlyBudget()
setPublicProfile()
getPublicProfile()
setRanks()
getRanks()
setServices()
getServices()
setWebsiteUrl()
getWebsiteUrl()
Google_Service_Partners_CreateLeadRequest:: (6 methods):
setLead()
getLead()
setRecaptchaChallenge()
getRecaptchaChallenge()
setRequestMetadata()
getRequestMetadata()
Google_Service_Partners_CreateLeadResponse:: (6 methods):
setLead()
getLead()
setRecaptchaStatus()
getRecaptchaStatus()
setResponseMetadata()
getResponseMetadata()
Google_Service_Partners_DebugInfo:: (6 methods):
setServerInfo()
getServerInfo()
setServerTraceInfo()
getServerTraceInfo()
setServiceUrl()
getServiceUrl()
Google_Service_Partners_EventData:: (4 methods):
setKey()
getKey()
setValues()
getValues()
Google_Service_Partners_GetCompanyResponse:: (4 methods):
setCompany()
getCompany()
setResponseMetadata()
getResponseMetadata()
Google_Service_Partners_LatLng:: (4 methods):
setLatitude()
getLatitude()
setLongitude()
getLongitude()
Google_Service_Partners_Lead:: (20 methods):
setComments()
getComments()
setEmail()
getEmail()
setFamilyName()
getFamilyName()
setGivenName()
getGivenName()
setGpsMotivations()
getGpsMotivations()
setId()
getId()
setMinMonthlyBudget()
getMinMonthlyBudget()
setPhoneNumber()
getPhoneNumber()
setType()
getType()
setWebsiteUrl()
getWebsiteUrl()
Google_Service_Partners_ListCompaniesResponse:: (6 methods):
setCompanies()
getCompanies()
setNextPageToken()
getNextPageToken()
setResponseMetadata()
getResponseMetadata()
Google_Service_Partners_ListUserStatesResponse:: (4 methods):
setResponseMetadata()
getResponseMetadata()
setUserStates()
getUserStates()
Google_Service_Partners_LocalizedCompanyInfo:: (8 methods):
setCountryCodes()
getCountryCodes()
setDisplayName()
getDisplayName()
setLanguageCode()
getLanguageCode()
setOverview()
getOverview()
Google_Service_Partners_Location:: (4 methods):
setAddress()
getAddress()
setLatLng()
getLatLng()
Google_Service_Partners_LogMessageRequest:: (8 methods):
setClientInfo()
getClientInfo()
setDetails()
getDetails()
setLevel()
getLevel()
setRequestMetadata()
getRequestMetadata()
Google_Service_Partners_LogMessageRequestClientInfo:: (0 methods):
Google_Service_Partners_LogMessageResponse:: (2 methods):
setResponseMetadata()
getResponseMetadata()
Google_Service_Partners_LogUserEventRequest:: (14 methods):
setEventAction()
getEventAction()
setEventCategory()
getEventCategory()
setEventDatas()
getEventDatas()
setEventScope()
getEventScope()
setLead()
getLead()
setRequestMetadata()
getRequestMetadata()
setUrl()
getUrl()
Google_Service_Partners_LogUserEventResponse:: (2 methods):
setResponseMetadata()
getResponseMetadata()
Google_Service_Partners_Money:: (6 methods):
setCurrencyCode()
getCurrencyCode()
setNanos()
getNanos()
setUnits()
getUnits()
Google_Service_Partners_PublicProfile:: (8 methods):
setDisplayImageUrl()
getDisplayImageUrl()
setDisplayName()
getDisplayName()
setId()
getId()
setUrl()
getUrl()
Google_Service_Partners_Rank:: (4 methods):
setType()
getType()
setValue()
getValue()
Google_Service_Partners_RecaptchaChallenge:: (4 methods):
setId()
getId()
setResponse()
getResponse()
Google_Service_Partners_RequestMetadata:: (10 methods):
setExperimentIds()
getExperimentIds()
setLocale()
getLocale()
setPartnersSessionId()
getPartnersSessionId()
setTrafficSource()
getTrafficSource()
setUserOverrides()
getUserOverrides()
Google_Service_Partners_ResponseMetadata:: (2 methods):
setDebugInfo()
getDebugInfo()
Google_Service_Partners_TrafficSource:: (4 methods):
setTrafficSourceId()
getTrafficSourceId()
setTrafficSubId()
getTrafficSubId()
Google_Service_Partners_UserOverrides:: (4 methods):
setIpAddress()
getIpAddress()
setUserId()
getUserId()
Class: Google_Service_Partners - X-Ref
Service definition for Partners (v2).<p>
Lets advertisers search certified companies and create contact leads with
them, and also audits the usage of clients.</p>
<p>
For more information about this service, see the API
<a href="https://developers.google.com/partners/" target="_blank">Documentation</a>
</p>
| __construct(Google_Client $client) X-Ref |
| Constructs the internal representation of the Partners service. param: Google_Client $client |
Class: Google_Service_Partners_ClientMessages_Resource - X-Ref
The "clientMessages" collection of methods.Typical usage is:
<code>
$partnersService = new Google_Service_Partners(...);
$clientMessages = $partnersService->clientMessages;
</code>
| log(Google_Service_Partners_LogMessageRequest $postBody, $optParams = array() X-Ref |
| Logs a generic message from the client, such as `Failed to render component`, `Profile page is running slow`, `More than 500 users have accessed this result.`, etc. (clientMessages.log) param: Google_LogMessageRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Partners_LogMessageResponse |
Class: Google_Service_Partners_Companies_Resource - X-Ref
The "companies" collection of methods.Typical usage is:
<code>
$partnersService = new Google_Service_Partners(...);
$companies = $partnersService->companies;
</code>
| get($companyId, $optParams = array() X-Ref |
| Gets a company. (companies.get) param: string $companyId The ID of the company to retrieve. param: array $optParams Optional parameters. return: Google_Service_Partners_GetCompanyResponse |
| listCompanies($optParams = array() X-Ref |
| Lists companies. (companies.listCompanies) param: array $optParams Optional parameters. return: Google_Service_Partners_ListCompaniesResponse |
Class: Google_Service_Partners_CompaniesLeads_Resource - X-Ref
The "leads" collection of methods.Typical usage is:
<code>
$partnersService = new Google_Service_Partners(...);
$leads = $partnersService->leads;
</code>
| create($companyId, Google_Service_Partners_CreateLeadRequest $postBody, $optParams = array() X-Ref |
| Creates an advertiser lead for the given company ID. (leads.create) param: string $companyId The ID of the company to contact. param: Google_CreateLeadRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Partners_CreateLeadResponse |
Class: Google_Service_Partners_UserEvents_Resource - X-Ref
The "userEvents" collection of methods.Typical usage is:
<code>
$partnersService = new Google_Service_Partners(...);
$userEvents = $partnersService->userEvents;
</code>
| log(Google_Service_Partners_LogUserEventRequest $postBody, $optParams = array() X-Ref |
| Logs a user event. (userEvents.log) param: Google_LogUserEventRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Partners_LogUserEventResponse |
Class: Google_Service_Partners_UserStates_Resource - X-Ref
The "userStates" collection of methods.Typical usage is:
<code>
$partnersService = new Google_Service_Partners(...);
$userStates = $partnersService->userStates;
</code>
| listUserStates($optParams = array() X-Ref |
| Lists states for current user. (userStates.listUserStates) param: array $optParams Optional parameters. return: Google_Service_Partners_ListUserStatesResponse |
Class: Google_Service_Partners_CertificationExamStatus - X-Ref
| setNumberUsersPass($numberUsersPass) X-Ref |
| No description |
| getNumberUsersPass() X-Ref |
| No description |
| setType($type) X-Ref |
| No description |
| getType() X-Ref |
| No description |
Class: Google_Service_Partners_CertificationStatus - X-Ref
| setExamStatuses($examStatuses) X-Ref |
| No description |
| getExamStatuses() X-Ref |
| No description |
| setIsCertified($isCertified) X-Ref |
| No description |
| getIsCertified() X-Ref |
| No description |
| setType($type) X-Ref |
| No description |
| getType() X-Ref |
| No description |
Class: Google_Service_Partners_Company - X-Ref
| setCertificationStatuses($certificationStatuses) X-Ref |
| No description |
| getCertificationStatuses() X-Ref |
| No description |
| setConvertedMinMonthlyBudget(Google_Service_Partners_Money $convertedMinMonthlyBudget) X-Ref |
| No description |
| getConvertedMinMonthlyBudget() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setIndustries($industries) X-Ref |
| No description |
| getIndustries() X-Ref |
| No description |
| setLocalizedInfos($localizedInfos) X-Ref |
| No description |
| getLocalizedInfos() X-Ref |
| No description |
| setLocations($locations) X-Ref |
| No description |
| getLocations() X-Ref |
| No description |
| setName($name) X-Ref |
| No description |
| getName() X-Ref |
| No description |
| setOriginalMinMonthlyBudget(Google_Service_Partners_Money $originalMinMonthlyBudget) X-Ref |
| No description |
| getOriginalMinMonthlyBudget() X-Ref |
| No description |
| setPublicProfile(Google_Service_Partners_PublicProfile $publicProfile) X-Ref |
| No description |
| getPublicProfile() X-Ref |
| No description |
| setRanks($ranks) X-Ref |
| No description |
| getRanks() X-Ref |
| No description |
| setServices($services) X-Ref |
| No description |
| getServices() X-Ref |
| No description |
| setWebsiteUrl($websiteUrl) X-Ref |
| No description |
| getWebsiteUrl() X-Ref |
| No description |
Class: Google_Service_Partners_CreateLeadRequest - X-Ref
| setLead(Google_Service_Partners_Lead $lead) X-Ref |
| No description |
| getLead() X-Ref |
| No description |
| setRecaptchaChallenge(Google_Service_Partners_RecaptchaChallenge $recaptchaChallenge) X-Ref |
| No description |
| getRecaptchaChallenge() X-Ref |
| No description |
| setRequestMetadata(Google_Service_Partners_RequestMetadata $requestMetadata) X-Ref |
| No description |
| getRequestMetadata() X-Ref |
| No description |
Class: Google_Service_Partners_CreateLeadResponse - X-Ref
| setLead(Google_Service_Partners_Lead $lead) X-Ref |
| No description |
| getLead() X-Ref |
| No description |
| setRecaptchaStatus($recaptchaStatus) X-Ref |
| No description |
| getRecaptchaStatus() X-Ref |
| No description |
| setResponseMetadata(Google_Service_Partners_ResponseMetadata $responseMetadata) X-Ref |
| No description |
| getResponseMetadata() X-Ref |
| No description |
Class: Google_Service_Partners_DebugInfo - X-Ref
| setServerInfo($serverInfo) X-Ref |
| No description |
| getServerInfo() X-Ref |
| No description |
| setServerTraceInfo($serverTraceInfo) X-Ref |
| No description |
| getServerTraceInfo() X-Ref |
| No description |
| setServiceUrl($serviceUrl) X-Ref |
| No description |
| getServiceUrl() X-Ref |
| No description |
Class: Google_Service_Partners_EventData - X-Ref
Class: Google_Service_Partners_GetCompanyResponse - X-Ref
| setCompany(Google_Service_Partners_Company $company) X-Ref |
| No description |
| getCompany() X-Ref |
| No description |
| setResponseMetadata(Google_Service_Partners_ResponseMetadata $responseMetadata) X-Ref |
| No description |
| getResponseMetadata() X-Ref |
| No description |
Class: Google_Service_Partners_LatLng - X-Ref
| setLatitude($latitude) X-Ref |
| No description |
| getLatitude() X-Ref |
| No description |
| setLongitude($longitude) X-Ref |
| No description |
| getLongitude() X-Ref |
| No description |
Class: Google_Service_Partners_Lead - X-Ref
| setComments($comments) X-Ref |
| No description |
| getComments() X-Ref |
| No description |
| setEmail($email) X-Ref |
| No description |
| getEmail() X-Ref |
| No description |
| setFamilyName($familyName) X-Ref |
| No description |
| getFamilyName() X-Ref |
| No description |
| setGivenName($givenName) X-Ref |
| No description |
| getGivenName() X-Ref |
| No description |
| setGpsMotivations($gpsMotivations) X-Ref |
| No description |
| getGpsMotivations() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setMinMonthlyBudget(Google_Service_Partners_Money $minMonthlyBudget) X-Ref |
| No description |
| getMinMonthlyBudget() X-Ref |
| No description |
| setPhoneNumber($phoneNumber) X-Ref |
| No description |
| getPhoneNumber() X-Ref |
| No description |
| setType($type) X-Ref |
| No description |
| getType() X-Ref |
| No description |
| setWebsiteUrl($websiteUrl) X-Ref |
| No description |
| getWebsiteUrl() X-Ref |
| No description |
Class: Google_Service_Partners_ListCompaniesResponse - X-Ref
| setCompanies($companies) X-Ref |
| No description |
| getCompanies() X-Ref |
| No description |
| setNextPageToken($nextPageToken) X-Ref |
| No description |
| getNextPageToken() X-Ref |
| No description |
| setResponseMetadata(Google_Service_Partners_ResponseMetadata $responseMetadata) X-Ref |
| No description |
| getResponseMetadata() X-Ref |
| No description |
Class: Google_Service_Partners_ListUserStatesResponse - X-Ref
| setResponseMetadata(Google_Service_Partners_ResponseMetadata $responseMetadata) X-Ref |
| No description |
| getResponseMetadata() X-Ref |
| No description |
| setUserStates($userStates) X-Ref |
| No description |
| getUserStates() X-Ref |
| No description |
Class: Google_Service_Partners_LocalizedCompanyInfo - X-Ref
| setCountryCodes($countryCodes) X-Ref |
| No description |
| getCountryCodes() X-Ref |
| No description |
| setDisplayName($displayName) X-Ref |
| No description |
| getDisplayName() X-Ref |
| No description |
| setLanguageCode($languageCode) X-Ref |
| No description |
| getLanguageCode() X-Ref |
| No description |
| setOverview($overview) X-Ref |
| No description |
| getOverview() X-Ref |
| No description |
Class: Google_Service_Partners_Location - X-Ref
| setAddress($address) X-Ref |
| No description |
| getAddress() X-Ref |
| No description |
| setLatLng(Google_Service_Partners_LatLng $latLng) X-Ref |
| No description |
| getLatLng() X-Ref |
| No description |
Class: Google_Service_Partners_LogMessageRequest - X-Ref
| setClientInfo($clientInfo) X-Ref |
| No description |
| getClientInfo() X-Ref |
| No description |
| setDetails($details) X-Ref |
| No description |
| getDetails() X-Ref |
| No description |
| setLevel($level) X-Ref |
| No description |
| getLevel() X-Ref |
| No description |
| setRequestMetadata(Google_Service_Partners_RequestMetadata $requestMetadata) X-Ref |
| No description |
| getRequestMetadata() X-Ref |
| No description |
Class: Google_Service_Partners_LogMessageResponse - X-Ref
| setResponseMetadata(Google_Service_Partners_ResponseMetadata $responseMetadata) X-Ref |
| No description |
| getResponseMetadata() X-Ref |
| No description |
Class: Google_Service_Partners_LogUserEventRequest - X-Ref
| setEventAction($eventAction) X-Ref |
| No description |
| getEventAction() X-Ref |
| No description |
| setEventCategory($eventCategory) X-Ref |
| No description |
| getEventCategory() X-Ref |
| No description |
| setEventDatas($eventDatas) X-Ref |
| No description |
| getEventDatas() X-Ref |
| No description |
| setEventScope($eventScope) X-Ref |
| No description |
| getEventScope() X-Ref |
| No description |
| setLead(Google_Service_Partners_Lead $lead) X-Ref |
| No description |
| getLead() X-Ref |
| No description |
| setRequestMetadata(Google_Service_Partners_RequestMetadata $requestMetadata) X-Ref |
| No description |
| getRequestMetadata() X-Ref |
| No description |
| setUrl($url) X-Ref |
| No description |
| getUrl() X-Ref |
| No description |
Class: Google_Service_Partners_LogUserEventResponse - X-Ref
| setResponseMetadata(Google_Service_Partners_ResponseMetadata $responseMetadata) X-Ref |
| No description |
| getResponseMetadata() X-Ref |
| No description |
Class: Google_Service_Partners_Money - X-Ref
| setCurrencyCode($currencyCode) X-Ref |
| No description |
| getCurrencyCode() X-Ref |
| No description |
| setNanos($nanos) X-Ref |
| No description |
| getNanos() X-Ref |
| No description |
| setUnits($units) X-Ref |
| No description |
| getUnits() X-Ref |
| No description |
Class: Google_Service_Partners_PublicProfile - X-Ref
| setDisplayImageUrl($displayImageUrl) X-Ref |
| No description |
| getDisplayImageUrl() X-Ref |
| No description |
| setDisplayName($displayName) X-Ref |
| No description |
| getDisplayName() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setUrl($url) X-Ref |
| No description |
| getUrl() X-Ref |
| No description |
Class: Google_Service_Partners_Rank - X-Ref
Class: Google_Service_Partners_RecaptchaChallenge - X-Ref
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setResponse($response) X-Ref |
| No description |
| getResponse() X-Ref |
| No description |
Class: Google_Service_Partners_RequestMetadata - X-Ref
| setExperimentIds($experimentIds) X-Ref |
| No description |
| getExperimentIds() X-Ref |
| No description |
| setLocale($locale) X-Ref |
| No description |
| getLocale() X-Ref |
| No description |
| setPartnersSessionId($partnersSessionId) X-Ref |
| No description |
| getPartnersSessionId() X-Ref |
| No description |
| setTrafficSource(Google_Service_Partners_TrafficSource $trafficSource) X-Ref |
| No description |
| getTrafficSource() X-Ref |
| No description |
| setUserOverrides(Google_Service_Partners_UserOverrides $userOverrides) X-Ref |
| No description |
| getUserOverrides() X-Ref |
| No description |
Class: Google_Service_Partners_ResponseMetadata - X-Ref
| setDebugInfo(Google_Service_Partners_DebugInfo $debugInfo) X-Ref |
| No description |
| getDebugInfo() X-Ref |
| No description |
Class: Google_Service_Partners_TrafficSource - X-Ref
| setTrafficSourceId($trafficSourceId) X-Ref |
| No description |
| getTrafficSourceId() X-Ref |
| No description |
| setTrafficSubId($trafficSubId) X-Ref |
| No description |
| getTrafficSubId() X-Ref |
| No description |
Class: Google_Service_Partners_UserOverrides - X-Ref
| setIpAddress($ipAddress) X-Ref |
| No description |
| getIpAddress() X-Ref |
| No description |
| setUserId($userId) X-Ref |
| No description |
| getUserId() X-Ref |
| No description |
