GoogleApiAdsAdWords
[ class tree: GoogleApiAdsAdWords ] [ index: GoogleApiAdsAdWords ] [ all elements ]

Class: TestUtils

Source Location: /AdWords/Util/TestUtils.php

Class Overview


A collection of utility methods for testing the API.


Methods



Class Details

[line 35]
A collection of utility methods for testing the API.



[ Top ]


Class Methods


static method CreateUser [line 41]

static AdWordsUser CreateUser( [$defaultVersion $defaultVersion = NULL])

Creates an AdWordsUser from the test auth and settings files.



Tags:

return:  the new user
access:  public


Parameters:

$defaultVersion   $defaultVersion   the default version of the API the user should use

[ Top ]

constructor __construct [line 60]

TestUtils __construct( $user $user, $version $version)

Constructs a new TestUtils object.



Tags:

access:  public


Parameters:

$user   $user   the AdWordsUser to use for requests
$version   $version   the version of the API to use for requests

[ Top ]

method AddReportDefinition [line 277]

float AddReportDefinition( )

Adds a report definition.



Tags:

return:  the id of the report definition
access:  public


[ Top ]

method CreateAdExtensionOverride [line 229]

void CreateAdExtensionOverride( float $adId, float $adExtensionId)

Creates an ad extension override.



Tags:

access:  public


Parameters:

float   $adId   the id of the ad
float   $adExtensionId   the id of the ad extension

[ Top ]

method CreateAdGroup [line 103]

float CreateAdGroup( float $campaignId)

Creates an ad group.



Tags:

return:  the id of the ad group
access:  public


Parameters:

float   $campaignId   the id of the parent campaign

[ Top ]

method CreateCampaign [line 69]

float CreateCampaign( )

Creates a new campaign.



Tags:

return:  the id of the campaign
access:  public


[ Top ]

method CreateKeyword [line 145]

float CreateKeyword( float $adGroupId)

Creates a keyword criterion.



Tags:

return:  the id of the criterion
access:  public


Parameters:

float   $adGroupId   the id of the parent ad group

[ Top ]

method CreateLocationExtension [line 201]

float CreateLocationExtension( float $campaignId)

Creates a location extension.



Tags:

return:  the id of the ad extension
access:  public


Parameters:

float   $campaignId   the id of the campaign

[ Top ]

method CreateNegativeCampaignKeyword [line 166]

float CreateNegativeCampaignKeyword( float $campaignId)

Creates a negative campaign keyword criterion.



Tags:

return:  the id of the criterion
access:  public


Parameters:

float   $campaignId   the id of the parent campaign

[ Top ]

method CreateTextAd [line 122]

float CreateTextAd( float $adGroupId)

Creates a text ad.



Tags:

return:  the id of the ad
access:  public


Parameters:

float   $adGroupId   the id of the parent ad group

[ Top ]

method DeleteCampaign [line 87]

void DeleteCampaign( float $campaignId)

Deletes a campaign.



Tags:

access:  public


Parameters:

float   $campaignId   the id of the campaign

[ Top ]

method RemoveAdExtensionOverride [line 245]

void RemoveAdExtensionOverride( float $adId, float $adExtensionId)

Removes an ad extension override.



Tags:

access:  public


Parameters:

float   $adId   the id of the ad
float   $adExtensionId   the id of the ad extension

[ Top ]

method SetAdParam [line 187]

void SetAdParam( float $adGroupId, float $criterionId)

Sets an ad parameter on a keyword criterion.



Tags:

access:  public


Parameters:

float   $adGroupId   the id of the ad group
float   $criterionId   the id of the keyword criterion

[ Top ]

method UploadImage [line 261]

float UploadImage( )

Uploads an image.



Tags:

return:  the id of the image media
access:  public


[ Top ]


Documentation generated by phpDocumentor 1.4.3