PHP Class ManagedCustomerService, googleads-php-lib

Inheritance: extends AdWordsSoapClient

Mostra file Open project: googleads/googleads-php-lib Class Usage Examples

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}.
getPendingInvitations ( $selector )	This field is required and should not be {@code null}.
mutate ( $operations ) : The	This field must not contain {@code null} elements. 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: SET, ADD.
mutateLabel ( $operations )	This field is required and should not be {@code null}. The following {@link Operator}s are supported: ADD, REMOVE.
mutateLink ( $operations ) : results	This field is required and should not be {@code null}. The following {@link Operator}s are supported: SET, ADD.
mutateManager ( $operations ) : results	This field must not contain {@code null} elements. 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: SET.

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 the list of customers that meet the selector criteria.

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

getPendingInvitations() public method

Returns the pending invitations for the customer IDs in the selector.

public getPendingInvitations ( $selector )

mutate() public method

Modifies or creates new {@link ManagedCustomer}s.

Note: See {@link ManagedCustomerOperation} for available operators.

public mutate ( $operations ) : The
return	The	list of updated managed customers, returned in the same order as the `operations` array.

mutateLabel() public method

Adds {@linkplain AccountLabel}s to, and removes {@linkplain AccountLabel}s from, {@linkplain ManagedCustomer}s.

To add an {@linkplain AccountLabel} to a {@linkplain ManagedCustomer}, use {@link Operator#ADD}. To remove an {@linkplain AccountLabel} from a {@linkplain ManagedCustomer}, use {@link Operator#REMOVE}.

The label must already exist (see {@link AccountLabelService#mutate} for how to create them) and be owned by the authenticated user.

The {@linkplain ManagedCustomer} must already exist and be managed by the customer making the request (either directly or indirectly).

An AccountLabel may be applied to at most 1000 customers.

This method does not support partial failures, and will fail if any operation is invalid.

public mutateLabel ( $operations )

mutateLink() public method

Modifies the ManagedCustomer forest. These actions are possible (categorized by Operator + Link Status):

ADD + PENDING: manager extends invitations
SET + CANCELLED: manager rescinds invitations
SET + INACTIVE: manager/client terminates links
SET + ACTIVE: client accepts invitations
SET + REFUSED: client declines invitations

In addition to these, active links can also be marked hidden / unhidden.

An ACTIVE link can be marked hidden with SET + ACTIVE along with setting the isHidden bit to true.
An ACTIVE link can be marked unhidden with SET + ACTIVE along with setting the isHidden bit to false.

public mutateLink ( $operations ) : results
return	results	for the given operations

mutateManager() public method

Moves client customers to new managers (moving links). Only the following action is possible:

SET + ACTIVE: manager moves client customers to new managers within the same manager account hierarchy

public mutateManager ( $operations ) : results
return	results	for the given operations

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