PHP Class AudienceSegmentService, googleads-php-lib

Inheritance: extends DfpSoapClient
Show file Open project: googleads/googleads-php-lib

Public Properties

Property Type Description
$classmap array Default class map for wsdl=>php
$endpoint string The endpoint of the service

Public Methods

Method Description
__construct ( string $wsdl, array $options, $user ) Constructor using wsdl location and options array
createAudienceSegments ( $segments ) : created Creates new {@link RuleBasedFirstPartyAudienceSegment} objects.
getAudienceSegmentsByStatement ( $filterStatement ) : the Gets an {@link AudienceSegmentPage} of {@link AudienceSegment} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:
performAudienceSegmentAction ( $action, $filterStatement ) : { Performs the given {@link AudienceSegmentAction} on the set of segments identified by the given statement.
updateAudienceSegments ( $segments ) : updated Updates the given {@link RuleBasedFirstPartyAudienceSegment} objects.

Method Details

__construct() public method

Constructor using wsdl location and options array
public __construct ( string $wsdl, array $options, $user )
$wsdl string WSDL location for this service
$options array Options for the SoapClient

createAudienceSegments() public method

Creates new {@link RuleBasedFirstPartyAudienceSegment} objects.
public createAudienceSegments ( $segments ) : created
return created first-party audience segments

getAudienceSegmentsByStatement() public method

PQL Property Object Property
{@code id} {@link AudienceSegment#id}
{@code name} {@link AudienceSegment#name}
{@code status} {@link AudienceSegment#status}
{@code type} {@link AudienceSegment#type}
{@code size} {@link AudienceSegment#size}
{@code dataProviderName} {@link AudienceSegmentDataProvider#name}
{@code approvalStatus} {@link ThirdPartyAudienceSegment#approvalStatus}
{@code cost} {@link ThirdPartyAudienceSegment#cost}
{@code startDateTime} {@link ThirdPartyAudienceSegment#startDateTime}
{@code endDateTime} {@link ThirdPartyAudienceSegment#endDateTime}
public getAudienceSegmentsByStatement ( $filterStatement ) : the
return the audience segments that match the given filter

performAudienceSegmentAction() public method

Performs the given {@link AudienceSegmentAction} on the set of segments identified by the given statement.
public performAudienceSegmentAction ( $action, $filterStatement ) : {
return {

updateAudienceSegments() public method

Updates the given {@link RuleBasedFirstPartyAudienceSegment} objects.
public updateAudienceSegments ( $segments ) : updated
return updated first-party audience segments

Property Details

$classmap public static property

Default class map for wsdl=>php
public static array $classmap
return array

$endpoint public static property

The endpoint of the service
public static string $endpoint
return string