PHP Class ProposalLineItemService, googleads-php-lib

Inheritance: extends DfpSoapClient

显示文件 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
createProposalLineItems ( $proposalLineItems ) : the	Creates new {@link ProposalLineItem} objects.
getProposalLineItemsByStatement ( $filterStatement ) : the	Gets a {@link ProposalLineItemPage} of {@link ProposalLineItem} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:
performProposalLineItemAction ( $proposalLineItemAction, $filterStatement ) : the	Performs actions on {@link ProposalLineItem} objects that match the given {@link Statement#query}.
updateProposalLineItems ( $proposalLineItems ) : the	Updates the specified {@link ProposalLineItem} objects. If free editing mode is enabled, this will trigger inventory reservation and cause the proposal to be pushed to DFP again.

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

createProposalLineItems() public method

For each proposal line item, the following fields are required:

{@link ProposalLineItem#proposalId}
{@link ProposalLineItem#rateCardId}
{@link ProposalLineItem#productId}
{@link ProposalLineItem#name}
{@link ProposalLineItem#startDateTime}
{@link ProposalLineItem#endDateTime}

public createProposalLineItems ( $proposalLineItems ) : the
return	the	created proposal line items with their IDs filled in

getProposalLineItemsByStatement() public method

PQL Property	Object Property
{@code id}	{@link ProposalLineItem#id}
{@code name}	{@link ProposalLineItem#name}
{@code proposalId}	{@link ProposalLineItem#proposalId}
{@code startDateTime}	{@link ProposalLineItem#startDateTime}
{@code endDateTime}	{@link ProposalLineItem#endDateTime}
{@code isArchived}	{@link ProposalLineItem#isArchived}
{@code lastModifiedDateTime}	{@link ProposalLineItem#lastModifiedDateTime}
{@code useThirdPartyAdServerFromProposal} Only applicable for non-programmatic proposal line items using sales management	{@link ProposalLineItem#useThirdPartyAdServerFromProposal}
{@code thirdPartyAdServerId} Only applicable for non-programmatic proposal line items using sales management	{@link ProposalLineItem#thirdPartyAdServerId}
{@code customThirdPartyAdServerName} Only applicable for non-programmatic proposal line items using sales management	{@link ProposalLineItem#customThirdPartyAdServerName}
{@code isProgrammatic}	{@link ProposalLineItem#isProgrammatic}

public getProposalLineItemsByStatement ( $filterStatement ) : the
return	the	proposal line items that match the given filter

performProposalLineItemAction() public method

Performs actions on {@link ProposalLineItem} objects that match the given {@link Statement#query}.

public performProposalLineItemAction ( $proposalLineItemAction, $filterStatement ) : the
return	the	result of the action performed

updateProposalLineItems() public method

Updates the specified {@link ProposalLineItem} objects. If free editing mode is enabled, this will trigger inventory reservation and cause the proposal to be pushed to DFP again.

public updateProposalLineItems ( $proposalLineItems ) : the
return	the	updated proposal line items

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