1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Dfareporting
  7. \
  8. Resource
  9. \
  10. Campaigns

Campaigns

class Campaigns extends Resource (View source)

The "campaigns" collection of methods.

Typical usage is:

 $dfareportingService = new Google\Service\Dfareporting(...);
 $campaigns = $dfareportingService->campaigns;

Methods

Campaign
get(string $profileId, string $id, array $optParams = [])

Gets one campaign by ID. (campaigns.get)

Campaign
insert(string $profileId, Campaign $postBody, array $optParams = [])

Inserts a new campaign. (campaigns.insert)

CampaignsListResponse
listCampaigns(string $profileId, array $optParams = [])

Retrieves a list of campaigns, possibly filtered. This method supports paging. (campaigns.listCampaigns)

Campaign
patch(string $profileId, string $id, Campaign $postBody, array $optParams = [])

Updates an existing campaign. This method supports patch semantics.

Campaign
update(string $profileId, Campaign $postBody, array $optParams = [])

Updates an existing campaign. (campaigns.update)

Details

at line 42
Campaign get(string $profileId, string $id, array $optParams = [])

Gets one campaign by ID. (campaigns.get)

Parameters

string $profileId

User profile ID associated with this request.
string $id

Campaign ID.
array $optParams

Optional parameters.

Return Value

Campaign

Exceptions

Exception

at line 57
Campaign insert(string $profileId, Campaign $postBody, array $optParams = [])

Inserts a new campaign. (campaigns.insert)

Parameters

string $profileId

User profile ID associated with this request.
Campaign $postBody
array $optParams

Optional parameters.

Return Value

Campaign

Exceptions

Exception

at line 99
CampaignsListResponse listCampaigns(string $profileId, array $optParams = [])

Retrieves a list of campaigns, possibly filtered. This method supports paging. (campaigns.listCampaigns)

Parameters

string $profileId

User profile ID associated with this request.
array $optParams

Optional parameters.

Return Value

CampaignsListResponse

Exceptions

Exception

at line 116
Campaign patch(string $profileId, string $id, Campaign $postBody, array $optParams = [])

Updates an existing campaign. This method supports patch semantics.

(campaigns.patch)

Parameters

string $profileId

User profile ID associated with this request.
string $id

Required. Campaign ID.
Campaign $postBody
array $optParams

Optional parameters.

Return Value

Campaign

Exceptions

Exception

at line 131
Campaign update(string $profileId, Campaign $postBody, array $optParams = [])

Updates an existing campaign. (campaigns.update)

Parameters

string $profileId

User profile ID associated with this request.
Campaign $postBody
array $optParams

Optional parameters.

Return Value

Campaign

Exceptions

Exception