PHP Class AdGroupCriterionService, googleads-php-lib

Inheritance: extends AdWordsSoapClient

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
get ( $serviceSelector ) : a	This field is required and should not be {@code null}.
mutate ( $operations ) : added	This field must not contain {@code null} elements. Elements in this field must have distinct IDs for following {@link Operator}s : SET, REMOVE. This field must contain at least one element. This field is required and should not be {@code null}. The following {@link Operator}s are supported: ADD, SET, REMOVE.
mutateLabel ( $operations ) : a	This field must not contain {@code null} elements. Elements in this field must have distinct IDs for following {@link Operator}s : ADD, REMOVE. This field must contain at least one element. This field is required and should not be {@code null}. The following {@link Operator}s are supported: ADD, REMOVE.
query ( $query )	This field is required and should not be {@code null}.

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

get() public method

Gets adgroup criteria.

public get ( $serviceSelector ) : a
return	a	page (subset) view of the criteria selected

mutate() public method

Adds, removes or updates adgroup criteria.

public mutate ( $operations ) : added
return	added	and updated adgroup criteria (without optional parts)

mutateLabel() public method

Adds labels to the AdGroupCriterion or removes labels from the AdGroupCriterion

Add - Apply an existing label to an existing {@linkplain AdGroupCriterion ad group criterion}. The {@code adGroupId} and {@code criterionId} must reference an existing {@linkplain AdGroupCriterion ad group criterion}. The {@code labelId} must reference an existing {@linkplain Label label}.

Remove - Removes the link between the specified {@linkplain AdGroupCriterion ad group criterion} and {@linkplain Label label}.

public mutateLabel ( $operations ) : a
return	a	list of AdGroupCriterionLabel where each entry in the list is the result of applying the operation in the input list with the same index. For an add operation, the returned AdGroupCriterionLabel contains the AdGroupId, CriterionId and the LabelId. In the case of a remove operation, the returned AdGroupCriterionLabel will only have AdGroupId and CriterionId.

query() public method

Returns the list of AdGroupCriterion that match the query.

public query ( $query )

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