PHP Class ForecastService, googleads-php-lib

Author: WSDLInterpreter
Inheritance: extends DfpSoapClient
Datei anzeigen 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
getAvailabilityForecast ( $lineItem, $forecastOptions ) Gets the availability forecast for a {@link ProspectiveLineItem}. An availability forecast reports the maximum number of available units that the line item can book, and the total number of units matching the line item's targeting.
getAvailabilityForecastById ( $lineItemId, $forecastOptions ) Gets an {@link AvailabilityForecast} for an existing {@link LineItem} object.
getDeliveryForecast ( $lineItems, $forecastOptions ) Gets the delivery forecast for a list of {@link ProspectiveLineItem} objects in a single delivery simulation with line items potentially contending with each other. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.
getDeliveryForecastByIds ( $lineItemIds, $forecastOptions ) Gets the delivery forecast for a list of existing {@link LineItem} objects in a single delivery simulation with line items potentially contending with each other. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.

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

getAvailabilityForecast() public method

Note: Beginning in v201502, this replaces the previous getForecast method.

public getAvailabilityForecast ( $lineItem, $forecastOptions )

getAvailabilityForecastById() public method

An availability forecast reports the maximum number of available units that the line item can be booked with, and also the total number of units matching the line item's targeting.

Only line items having type {@link LineItemType#SPONSORSHIP} or {@link LineItemType#STANDARD} are valid. Other types will result in {@link ReservationDetailsError.Reason#LINE_ITEM_TYPE_NOT_ALLOWED}.

Note: Beginning in v201502, this replaces the previous getForecastById method.

public getAvailabilityForecastById ( $lineItemId, $forecastOptions )

getDeliveryForecast() public method

Gets the delivery forecast for a list of {@link ProspectiveLineItem} objects in a single delivery simulation with line items potentially contending with each other. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.
public getDeliveryForecast ( $lineItems, $forecastOptions )

getDeliveryForecastByIds() public method

Gets the delivery forecast for a list of existing {@link LineItem} objects in a single delivery simulation with line items potentially contending with each other. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.
public getDeliveryForecastByIds ( $lineItemIds, $forecastOptions )

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