* $displayvideoService = new Google_Service_DisplayVideo(...); * $campaigns = $displayvideoService->campaigns; * */ class Google_Service_DisplayVideo_Resource_AdvertisersCampaigns extends Google_Service_Resource { /** * Creates a new campaign. Returns the newly created campaign if successful. * (campaigns.create) * * @param string $advertiserId Output only. The unique ID of the advertiser the * campaign belongs to. * @param Google_Service_DisplayVideo_Campaign $postBody * @param array $optParams Optional parameters. * @return Google_Service_DisplayVideo_Campaign */ public function create($advertiserId, Google_Service_DisplayVideo_Campaign $postBody, $optParams = array()) { $params = array('advertiserId' => $advertiserId, 'postBody' => $postBody); $params = array_merge($params, $optParams); return $this->call('create', array($params), "Google_Service_DisplayVideo_Campaign"); } /** * Permanently deletes a campaign. A deleted campaign cannot be recovered. The * campaign should be archived first, i.e. set entity_status to * `ENTITY_STATUS_ARCHIVED`, to be able to delete it. (campaigns.delete) * * @param string $advertiserId The ID of the advertiser this campaign belongs * to. * @param string $campaignId The ID of the campaign we need to delete. * @param array $optParams Optional parameters. * @return Google_Service_DisplayVideo_DisplayvideoEmpty */ public function delete($advertiserId, $campaignId, $optParams = array()) { $params = array('advertiserId' => $advertiserId, 'campaignId' => $campaignId); $params = array_merge($params, $optParams); return $this->call('delete', array($params), "Google_Service_DisplayVideo_DisplayvideoEmpty"); } /** * Gets a campaign. (campaigns.get) * * @param string $advertiserId Required. The ID of the advertiser this campaign * belongs to. * @param string $campaignId Required. The ID of the campaign to fetch. * @param array $optParams Optional parameters. * @return Google_Service_DisplayVideo_Campaign */ public function get($advertiserId, $campaignId, $optParams = array()) { $params = array('advertiserId' => $advertiserId, 'campaignId' => $campaignId); $params = array_merge($params, $optParams); return $this->call('get', array($params), "Google_Service_DisplayVideo_Campaign"); } /** * Lists campaigns in an advertiser. The order is defined by the order_by * parameter. If a filter by entity_status is not specified, campaigns with * `ENTITY_STATUS_ARCHIVED` will not be included in the results. * (campaigns.listAdvertisersCampaigns) * * @param string $advertiserId The ID of the advertiser to list campaigns for. * @param array $optParams Optional parameters. * * @opt_param string filter Allows filtering by campaign properties. Supported * syntax: * Filter expressions are made up of one or more restrictions. * * Restrictions can be combined by `AND` or `OR` logical operators. A sequence * of restrictions implicitly uses `AND`. * A restriction has the form of * `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * * Supported fields: - `entityStatus` Examples: * All `ENTITY_STATUS_ACTIVE` or * `ENTITY_STATUS_PAUSED` campaigns under an advertiser: * `(entityStatus="ENTITY_STATUS_ACTIVE" OR * entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no * more than 500 characters. * @opt_param string pageToken A token identifying a page of results the server * should return. Typically, this is the value of next_page_token returned from * the previous call to `ListCampaigns` method. If not specified, the first page * of results will be returned. * @opt_param string orderBy Field by which to sort the list. Acceptable values * are: * `displayName` (default) * `entityStatus` The default sorting order is * ascending. To specify descending order for a field, a suffix "desc" should be * added to the field name. Example: `displayName desc`. * @opt_param int pageSize Requested page size. Must be between `1` and `100`. * If unspecified will default to `100`. * @return Google_Service_DisplayVideo_ListCampaignsResponse */ public function listAdvertisersCampaigns($advertiserId, $optParams = array()) { $params = array('advertiserId' => $advertiserId); $params = array_merge($params, $optParams); return $this->call('list', array($params), "Google_Service_DisplayVideo_ListCampaignsResponse"); } /** * Updates an existing campaign. Returns the updated campaign if successful. * (campaigns.patch) * * @param string $advertiserId Output only. The unique ID of the advertiser the * campaign belongs to. * @param string $campaignId Output only. The unique ID of the campaign. * Assigned by the system. * @param Google_Service_DisplayVideo_Campaign $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask Required. The mask to control which fields to * update. * @return Google_Service_DisplayVideo_Campaign */ public function patch($advertiserId, $campaignId, Google_Service_DisplayVideo_Campaign $postBody, $optParams = array()) { $params = array('advertiserId' => $advertiserId, 'campaignId' => $campaignId, 'postBody' => $postBody); $params = array_merge($params, $optParams); return $this->call('patch', array($params), "Google_Service_DisplayVideo_Campaign"); } }