PHP Class CustomFieldService, 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
createCustomFieldOptions ( $customFieldOptions ) : the Creates new {@link CustomFieldOption} objects.
createCustomFields ( $customFields ) : the Creates new {@link CustomField} objects.
getCustomFieldOption ( $customFieldOptionId ) : the Returns the {@link CustomFieldOption} uniquely identified by the given ID.
getCustomFieldsByStatement ( $filterStatement ) : the Gets a {@link CustomFieldPage} of {@link CustomField} objects that satisfy the given {@link Statement#query}.
performCustomFieldAction ( $customFieldAction, $filterStatement ) : the Performs actions on {@link CustomField} objects that match the given {@link Statement#query}.
updateCustomFieldOptions ( $customFieldOptions ) : the Updates the specified {@link CustomFieldOption} objects.
updateCustomFields ( $customFields ) : the Updates the specified {@link CustomField} 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

createCustomFieldOptions() public method

The following fields are required:
  • {@link CustomFieldOption#displayName}
  • {@link CustomFieldOption#customFieldId}
public createCustomFieldOptions ( $customFieldOptions ) : the
return the created custom field options with their IDs filled in

createCustomFields() public method

The following fields are required:
  • {@link CustomField#name}
  • {@link CustomField#entityType}
  • {@link CustomField#dataType}
  • {@link CustomField#visibility}
public createCustomFields ( $customFields ) : the
return the created custom fields with their IDs filled in

getCustomFieldOption() public method

Returns the {@link CustomFieldOption} uniquely identified by the given ID.
public getCustomFieldOption ( $customFieldOptionId ) : the
return the {@code CustomFieldOption} uniquely identified by the given ID

getCustomFieldsByStatement() public method

The following fields are supported for filtering:
PQL Property Object Property
{@code id} {@link CustomField#id}
{@code entityType} {@link CustomField#entityType}
{@code name} {@link CustomField#name}
{@code isActive} {@link CustomField#isActive}
{@code visibility} {@link CustomField#visibility}
public getCustomFieldsByStatement ( $filterStatement ) : the
return the custom fields that match the given filter

performCustomFieldAction() public method

Performs actions on {@link CustomField} objects that match the given {@link Statement#query}.
public performCustomFieldAction ( $customFieldAction, $filterStatement ) : the
return the result of the action performed

updateCustomFieldOptions() public method

Updates the specified {@link CustomFieldOption} objects.
public updateCustomFieldOptions ( $customFieldOptions ) : the
return the updated custom field options

updateCustomFields() public method

Updates the specified {@link CustomField} objects.
public updateCustomFields ( $customFields ) : the
return the updated custom fields

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