Documentation

Google_Service_Dfareporting_Resource_AdvertiserLandingPages extends Google_Service_Resource
in package

The "advertiserLandingPages" collection of methods.

Typical usage is: $dfareportingService = new Google_Service_Dfareporting(...); $advertiserLandingPages = $dfareportingService->advertiserLandingPages;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Dfareporting_LandingPage
Gets one landing page by ID. (advertiserLandingPages.get)
insert()  : Google_Service_Dfareporting_LandingPage
Inserts a new landing page. (advertiserLandingPages.insert)
listAdvertiserLandingPages()  : Google_Service_Dfareporting_AdvertiserLandingPagesListResponse
Retrieves a list of landing pages.
patch()  : Google_Service_Dfareporting_LandingPage
Updates an existing advertiser landing page. This method supports patch semantics. (advertiserLandingPages.patch)
update()  : Google_Service_Dfareporting_LandingPage
Updates an existing landing page. (advertiserLandingPages.update)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

insert()

Inserts a new landing page. (advertiserLandingPages.insert)

public insert(string $profileId, Google_Service_Dfareporting_LandingPage $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_LandingPage
Parameters
$profileId : string

User profile ID associated with this request.

$postBody : Google_Service_Dfareporting_LandingPage
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_LandingPage —

listAdvertiserLandingPages()

Retrieves a list of landing pages.

public listAdvertiserLandingPages(string $profileId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_AdvertiserLandingPagesListResponse

(advertiserLandingPages.listAdvertiserLandingPages)

Parameters
$profileId : string

User profile ID associated with this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string searchString Allows searching for landing pages by name or ID. Wildcards () are allowed. For example, "landingpage2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage".

opt_param

string advertiserIds Select only landing pages that belong to these advertisers.

opt_param

string sortField Field by which to sort the list.

opt_param

string pageToken Value of the nextPageToken from the previous result page.

opt_param

string subaccountId Select only landing pages that belong to this subaccount.

opt_param

string sortOrder Order of sorted results.

opt_param

string ids Select only landing pages with these IDs.

opt_param

bool archived Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.

opt_param

string campaignIds Select only landing pages that are associated with these campaigns.

opt_param

int maxResults Maximum number of results to return.

Return values
Google_Service_Dfareporting_AdvertiserLandingPagesListResponse —

patch()

Updates an existing advertiser landing page. This method supports patch semantics. (advertiserLandingPages.patch)

public patch(string $profileId, string $id, Google_Service_Dfareporting_LandingPage $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_LandingPage
Parameters
$profileId : string

User profile ID associated with this request.

$id : string

LandingPage ID.

$postBody : Google_Service_Dfareporting_LandingPage
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_LandingPage —

update()

Updates an existing landing page. (advertiserLandingPages.update)

public update(string $profileId, Google_Service_Dfareporting_LandingPage $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dfareporting_LandingPage
Parameters
$profileId : string

User profile ID associated with this request.

$postBody : Google_Service_Dfareporting_LandingPage
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dfareporting_LandingPage —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results