Documentation

Google_Service_Analytics_Resource_ManagementRemarketingAudience extends Google_Service_Resource
in package

The "remarketingAudience" collection of methods.

Typical usage is: $analyticsService = new Google_Service_Analytics(...); $remarketingAudience = $analyticsService->remarketingAudience;

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.
delete()  : mixed
Delete a remarketing audience. (remarketingAudience.delete)
get()  : Google_Service_Analytics_RemarketingAudience
Gets a remarketing audience to which the user has access.
insert()  : Google_Service_Analytics_RemarketingAudience
Creates a new remarketing audience. (remarketingAudience.insert)
listManagementRemarketingAudience()  : Google_Service_Analytics_RemarketingAudiences
Lists remarketing audiences to which the user has access.
patch()  : Google_Service_Analytics_RemarketingAudience
Updates an existing remarketing audience. This method supports patch semantics. (remarketingAudience.patch)
update()  : Google_Service_Analytics_RemarketingAudience
Updates an existing remarketing audience. (remarketingAudience.update)
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

delete()

Delete a remarketing audience. (remarketingAudience.delete)

public delete(string $accountId, string $webPropertyId, string $remarketingAudienceId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$accountId : string

Account ID to which the remarketing audience belongs.

$webPropertyId : string

Web property ID to which the remarketing audience belongs.

$remarketingAudienceId : string

The ID of the remarketing audience to delete.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed

get()

Gets a remarketing audience to which the user has access.

public get(string $accountId, string $webPropertyId, string $remarketingAudienceId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Analytics_RemarketingAudience

(remarketingAudience.get)

Parameters
$accountId : string

The account ID of the remarketing audience to retrieve.

$webPropertyId : string

The web property ID of the remarketing audience to retrieve.

$remarketingAudienceId : string

The ID of the remarketing audience to retrieve.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Analytics_RemarketingAudience

insert()

Creates a new remarketing audience. (remarketingAudience.insert)

public insert(string $accountId, string $webPropertyId, Google_Service_Analytics_RemarketingAudience $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Analytics_RemarketingAudience
Parameters
$accountId : string

The account ID for which to create the remarketing audience.

$webPropertyId : string

Web property ID for which to create the remarketing audience.

$postBody : Google_Service_Analytics_RemarketingAudience
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Analytics_RemarketingAudience

listManagementRemarketingAudience()

Lists remarketing audiences to which the user has access.

public listManagementRemarketingAudience(string $accountId, string $webPropertyId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Analytics_RemarketingAudiences

(remarketingAudience.listManagementRemarketingAudience)

Parameters
$accountId : string

The account ID of the remarketing audiences to retrieve.

$webPropertyId : string

The web property ID of the remarketing audiences to retrieve.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int max-results The maximum number of remarketing audiences to include in this response.

opt_param

int start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

opt_param

string type

Return values
Google_Service_Analytics_RemarketingAudiences

patch()

Updates an existing remarketing audience. This method supports patch semantics. (remarketingAudience.patch)

public patch(string $accountId, string $webPropertyId, string $remarketingAudienceId, Google_Service_Analytics_RemarketingAudience $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Analytics_RemarketingAudience
Parameters
$accountId : string

The account ID of the remarketing audience to update.

$webPropertyId : string

The web property ID of the remarketing audience to update.

$remarketingAudienceId : string

The ID of the remarketing audience to update.

$postBody : Google_Service_Analytics_RemarketingAudience
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Analytics_RemarketingAudience

update()

Updates an existing remarketing audience. (remarketingAudience.update)

public update(string $accountId, string $webPropertyId, string $remarketingAudienceId, Google_Service_Analytics_RemarketingAudience $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Analytics_RemarketingAudience
Parameters
$accountId : string

The account ID of the remarketing audience to update.

$webPropertyId : string

The web property ID of the remarketing audience to update.

$remarketingAudienceId : string

The ID of the remarketing audience to update.

$postBody : Google_Service_Analytics_RemarketingAudience
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Analytics_RemarketingAudience

convertToArrayAndStripNulls()

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

Search results