PHP Class AdGroupService, googleads-php-lib

Inheritance: extends AdWordsSoapClient

Mostra 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 ) : List	This field is required and should not be {@code null}.
mutate ( $operations ) : The	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.
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 ) : A	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

Returns a list of all the ad groups specified by the selector from the target customer's account.

public get ( $serviceSelector ) : List
return	List	of adgroups identified by the selector.

mutate() public method

Adds, updates, or removes ad groups.

Note: {@link AdGroupOperation} does not support the {@code REMOVE} operator. To remove an ad group, set its {@link AdGroup#status status} to {@code REMOVED}.

public mutate ( $operations ) : The
return	The	updated adgroups.

mutateLabel() public method

Adds labels to the {@linkplain AdGroup ad group} or removes {@linkplain Label label}s from the {@linkplain AdGroup ad group}.

{@code ADD} -- Apply an existing label to an existing {@linkplain AdGroup ad group}. The {@code adGroupId} must reference an existing {@linkplain AdGroup ad group}. The {@code labelId} must reference an existing {@linkplain Label label}.

{@code REMOVE} -- Removes the link between the specified {@linkplain AdGroup ad group} and a {@linkplain Label label}.

public mutateLabel ( $operations ) : a
return	a	list of {@linkplain AdGroupLabel}s 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 AdGroupLabel contains the AdGroupId and the LabelId. In the case of a remove operation, the returned AdGroupLabel will only have AdGroupId.

query() public method

Returns the list of ad groups that match the query.

public query ( $query ) : A
return	A	list of adgroups

Property Details

$classmap public_oe static_oe property

Default class map for wsdl=>php

public static array $classmap
return	array

$endpoint public_oe static_oe property

The endpoint of the service

public static string $endpoint
return	string