Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Public Member Functions | Protected Member Functions | List of all members
Google_Service_Partners_Companies_Resource Class Reference

The "companies" collection of methods. More...

Inheritance diagram for Google_Service_Partners_Companies_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 get ($companyId, $optParams=array())
 Gets a company.
 
 listCompanies ($optParams=array())
 Lists companies.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "companies" collection of methods.

Typical usage is: $partnersService = new Google_Service_Partners(...); $companies = $partnersService->companies;

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ get()

Google_Service_Partners_Companies_Resource::get ( $companyId,
$optParams = array() )

Gets a company.

(companies.get)

Parameters
string$companyIdThe ID of the company to retrieve.
array$optParamsOptional parameters.

@opt_param string orderBy How to order addresses within the returned company. Currently, only address and address desc is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively. @opt_param string requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID. @opt_param string requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. @opt_param string requestMetadata.partnersSessionId Google Partners session ID. @opt_param string requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. @opt_param string requestMetadata.locale Locale to use for the current request. @opt_param string address The address to use for sorting the company's addresses by proximity. If not given, the geo-located address of the request is used. Used when order_by is set. @opt_param string requestMetadata.experimentIds Experiment IDs the current request belongs to. @opt_param string currencyCode If the company's budget is in a different currency code than this one, then the converted budget is converted to this currency code. @opt_param string requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. @opt_param string view The view of Company resource to be returned. This must not be COMPANY_VIEW_UNSPECIFIED.

Return values
Google_Service_Partners_GetCompanyResponse

◆ listCompanies()

Google_Service_Partners_Companies_Resource::listCompanies ( $optParams = array())

Lists companies.

(companies.listCompanies)

Parameters
array$optParamsOptional parameters.

@opt_param string orderBy How to order addresses within the returned companies. Currently, only address and address desc is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively. @opt_param int pageSize Requested page size. Server may return fewer companies than requested. If unspecified, server picks an appropriate default. @opt_param string requestMetadata.partnersSessionId Google Partners session ID. @opt_param string maxMonthlyBudget.currencyCode The 3-letter currency code defined in ISO 4217. @opt_param int maxMonthlyBudget.nanos Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000. @opt_param string languageCodes List of language codes that company can support. Only primary language subtags are accepted as defined by BCP 47 (IETF BCP 47, "Tags for Identifying Languages"). @opt_param int minMonthlyBudget.nanos Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000. @opt_param string requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. @opt_param string industries List of industries the company can help with. @opt_param string minMonthlyBudget.currencyCode The 3-letter currency code defined in ISO 4217. @opt_param string minMonthlyBudget.units The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar. @opt_param string pageToken A token identifying a page of results that the server returns. Typically, this is the value of ListCompaniesResponse.next_page_token returned from the previous call to ListCompanies. @opt_param string requestMetadata.locale Locale to use for the current request. @opt_param string requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. @opt_param string companyName Company name to search for. @opt_param string address The address to use when searching for companies. If not given, the geo-located address of the request is used. @opt_param string services List of services the company can help with. @opt_param string requestMetadata.experimentIds Experiment IDs the current request belongs to. @opt_param string gpsMotivations List of reasons for using Google Partner Search to get companies. @opt_param string requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. @opt_param string websiteUrl Website URL that will help to find a better matched company. . @opt_param string requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID. @opt_param string view The view of the Company resource to be returned. This must not be COMPANY_VIEW_UNSPECIFIED. @opt_param string maxMonthlyBudget.units The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

Return values
Google_Service_Partners_ListCompaniesResponse
The documentation for this class was generated from the following file:
Generated on Sun Jun 9 2024 02:46:54 for Moodle PHP Documentation by doxygen 1.11.0