PHP Class ProposalService, 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
createProposals ( $proposals ) : the Creates new {@link Proposal} objects.
getProposalsByStatement ( $filterStatement ) : the Gets a {@link ProposalPage} of {@link Proposal} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:
performProposalAction ( $proposalAction, $filterStatement ) : the Performs actions on {@link Proposal} objects that match the given {@link Statement#query}.
updateProposals ( $proposals ) : the Updates the specified {@link Proposal} 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

createProposals() public method

For each proposal, the following fields are required:
  • {@link Proposal#name}
public createProposals ( $proposals ) : the
return the created proposals with their IDs filled in

getProposalsByStatement() public method

PQL Property Object Property
{@code id} {@link Proposal#id}
{@code dfpOrderId} {@link Proposal#dfpOrderId}
{@code name} {@link Proposal#name}
{@code status} {@link Proposal#status}
{@code isArchived} {@link Proposal#isArchived}
{@code approvalStatus}
Only applicable for proposals using sales management
{@link Proposal#approvalStatus}
{@code lastModifiedDateTime} {@link Proposal#lastModifiedDateTime}
{@code thirdPartyAdServerId}
Only applicable for non-programmatic proposals using sales management
{@link Proposal#thirdPartyAdServerId}
{@code customThirdPartyAdServerName}
Only applicable for non-programmatic proposals using sales management
{@link Proposal#customThirdPartyAdServerName}
{@code hasOfflineErrors} {@link Proposal#hasOfflineErrors}
{@code isProgrammatic} {@link Proposal#isProgrammatic}
{@code negotiationStatus}
Only applicable for programmatic proposals
{@link ProposalMarketplaceInfo#negotiationStatus}
public getProposalsByStatement ( $filterStatement ) : the
return the proposals that match the given filter

performProposalAction() public method

The following fields are also required when submitting proposals for approval:
  • {@link Proposal#advertiser}
  • {@link Proposal#primarySalesperson}
  • {@link Proposal#primaryTraffickerId}
public performProposalAction ( $proposalAction, $filterStatement ) : the
return the result of the action performed

updateProposals() public method

Updates the specified {@link Proposal} objects.
public updateProposals ( $proposals ) : the
return the updated proposals

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