Documentation

Google_Service_Partners_Resource_V2 extends Google_Service_Resource
in package

The "v2" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
getPartnersstatus()  : Google_Service_Partners_GetPartnersStatusResponse
Gets Partners Status of the logged in user's agency. Should only be called if the logged in user is the admin of the agency. (v2.getPartnersstatus)
updateCompanies()  : Google_Service_Partners_Company
Update company. Should only be called within the context of an authorized logged in user. (v2.updateCompanies)
updateLeads()  : Google_Service_Partners_Lead
Updates the specified lead. (v2.updateLeads)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

getPartnersstatus()

Gets Partners Status of the logged in user's agency. Should only be called if the logged in user is the admin of the agency. (v2.getPartnersstatus)

public getPartnersstatus([array<string|int, mixed> $optParams = array() ]) : Google_Service_Partners_GetPartnersStatusResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestMetadata.locale Locale to use for the current request.

opt_param

string requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address.

opt_param

string requestMetadata.experimentIds Experiment IDs the current request belongs to.

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.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID.

opt_param

string requestMetadata.partnersSessionId Google Partners session ID.

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.

Return values
Google_Service_Partners_GetPartnersStatusResponse —

updateCompanies()

Update company. Should only be called within the context of an authorized logged in user. (v2.updateCompanies)

public updateCompanies(Google_Service_Partners_Company $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Partners_Company
Parameters
$postBody : Google_Service_Partners_Company
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestMetadata.experimentIds Experiment IDs the current request belongs to.

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.partnersSessionId Google Partners session ID.

opt_param

string requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID.

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 requestMetadata.locale Locale to use for the current request.

opt_param

string requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address.

opt_param

string updateMask Standard field mask for the set of fields to be updated. Required with at least 1 value in FieldMask's paths.

Return values
Google_Service_Partners_Company —

updateLeads()

Updates the specified lead. (v2.updateLeads)

public updateLeads(Google_Service_Partners_Lead $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Partners_Lead
Parameters
$postBody : Google_Service_Partners_Lead
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestMetadata.experimentIds Experiment IDs the current request belongs to.

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.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID.

opt_param

string requestMetadata.partnersSessionId Google Partners session ID.

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 requestMetadata.locale Locale to use for the current request.

opt_param

string requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address.

opt_param

string updateMask Standard field mask for the set of fields to be updated. Required with at least 1 value in FieldMask's paths. Only state and adwords_customer_id are currently supported.

Return values
Google_Service_Partners_Lead —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results