Google_PublishersServiceResource
The "publishers" collection of methods.
Defined (1)
The class is defined in the following location(s).
- /src/contrib/Google_GanService.php
- class Google_PublishersServiceResource extends Google_ServiceResource {
- /**
- * Retrieves data about a single advertiser if that the requesting advertiser/publisher has access
- * to it. Only advertisers can look up publishers. Publishers can request information about
- * themselves by omitting the publisherId query parameter. (publishers.get)
- *
- * @param string $role The role of the requester. Valid values: 'advertisers' or 'publishers'.
- * @param string $roleId The ID of the requesting advertiser or publisher.
- * @param array $optParams Optional parameters.
- *
- * @opt_param string publisherId The ID of the publisher to look up. Optional.
- * @return Google_Publisher
- */
- public function get($role, $roleId, $optParams = array()) {
- $params = array('role' => $role, 'roleId' => $roleId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new Google_Publisher($data);
- } else {
- return $data;
- }
- }
- /**
- * Retrieves data about all publishers that the requesting advertiser/publisher has access to.
- * (publishers.list)
- *
- * @param string $role The role of the requester. Valid values: 'advertisers' or 'publishers'.
- * @param string $roleId The ID of the requesting advertiser or publisher.
- * @param array $optParams Optional parameters.
- *
- * @opt_param string maxResults Max number of items to return in this page. Optional. Defaults to 20.
- * @opt_param double minNinetyDayEpc Filters out all publishers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
- * @opt_param int minPayoutRank A value between 1 and 4, where 1 represents the quartile of publishers with the lowest ranks and 4 represents the quartile of publishers with the highest ranks. Filters out all publishers with a lower rank than the given quartile. For example if a 2 was given only publishers with a payout rank of 25 or higher would be included. Optional.
- * @opt_param double minSevenDayEpc Filters out all publishers that have a seven day EPC average lower than the given value (inclusive). Min value 0.0. Optional.
- * @opt_param string pageToken The value of 'nextPageToken' from the previous page. Optional.
- * @opt_param string publisherCategory Caret(^) delimted list of publisher categories. Valid categories: (unclassified|community_and_content|shopping_and_promotion|loyalty_and_rewards|network|search_specialist|comparison_shopping|email). Filters out all publishers not in one of the given advertiser categories. Optional.
- * @opt_param string relationshipStatus Filters out all publishers for which do not have the given relationship status with the requesting publisher.
- * @return Google_Publishers
- */
- public function listPublishers($role, $roleId, $optParams = array()) {
- $params = array('role' => $role, 'roleId' => $roleId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new Google_Publishers($data);
- } else {
- return $data;
- }
- }
- }