* $displayvideoService = new Google\Service\DisplayVideo(...); * $adGroups = $displayvideoService->advertisers_adGroups; * */ class AdvertisersAdGroups extends \Google\Service\Resource { /** * Lists assigned targeting options for multiple ad groups across targeting * types. Inherited assigned targeting options are not included. * (adGroups.bulkListAdGroupAssignedTargetingOptions) * * @param string $advertiserId Required. The ID of the advertiser the line items * belongs to. * @param array $optParams Optional parameters. * * @opt_param string adGroupIds Required. The IDs of the ad groups to list * assigned targeting options for. * @opt_param string filter Optional. Allows filtering by assigned targeting * option fields. Supported syntax: * Filter expressions are made up of one or * more restrictions. * Restrictions can be combined by the logical operator * `OR`. * A restriction has the form of `{field} {operator} {value}`. * All * fields must use the `EQUALS (=)` operator. Supported fields: * * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting * type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: * `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR * targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field * should be no more than 500 characters. Reference our [filter `LIST` * requests](/display-video/api/guides/how-tos/filters) guide for more * information. * @opt_param string orderBy Optional. Field by which to sort the list. * Acceptable values are: * `adGroupId` (default) * * `assignedTargetingOption.targetingType` The default sorting order is * ascending. To specify descending order for a field, a suffix "desc" should be * added to the field name. Example: `targetingType desc`. * @opt_param int pageSize Optional. Requested page size. The size must be an * integer between `1` and `5000`. If unspecified, the default is `5000`. * Returns error code `INVALID_ARGUMENT` if an invalid value is specified. * @opt_param string pageToken Optional. A token that lets the client fetch the * next page of results. Typically, this is the value of next_page_token * returned from the previous call to the * `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first * page of results will be returned. * @return BulkListAdGroupAssignedTargetingOptionsResponse * @throws \Google\Service\Exception */ public function bulkListAdGroupAssignedTargetingOptions($advertiserId, $optParams = []) { $params = ['advertiserId' => $advertiserId]; $params = array_merge($params, $optParams); return $this->call('bulkListAdGroupAssignedTargetingOptions', [$params], BulkListAdGroupAssignedTargetingOptionsResponse::class); } /** * Gets an ad group. (adGroups.get) * * @param string $advertiserId Required. The ID of the advertiser this ad group * belongs to. * @param string $adGroupId Required. The ID of the ad group to fetch. * @param array $optParams Optional parameters. * @return AdGroup * @throws \Google\Service\Exception */ public function get($advertiserId, $adGroupId, $optParams = []) { $params = ['advertiserId' => $advertiserId, 'adGroupId' => $adGroupId]; $params = array_merge($params, $optParams); return $this->call('get', [$params], AdGroup::class); } /** * Lists ad groups. (adGroups.listAdvertisersAdGroups) * * @param string $advertiserId Required. The ID of the advertiser the ad groups * belongs to. * @param array $optParams Optional parameters. * * @opt_param string filter Optional. Allows filtering by custom ad group * fields. Supported syntax: * Filter expressions are made up of one or more * restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of * restrictions implicitly uses `AND`. * A restriction has the form of `{field} * {operator} {value}`. * All fields must use the `EQUALS (=)` operator. * Supported properties: * `adGroupId` * `displayName` * `entityStatus` * * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: * `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` * `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: * `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") * AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field * should be no more than 500 characters. Reference our [filter `LIST` * requests](/display-video/api/guides/how-tos/filters) guide for more * information. * @opt_param string orderBy Optional. 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 Optional. Requested page size. Must be between `1` * and `200`. If unspecified will default to `100`. Returns error code * `INVALID_ARGUMENT` if an invalid value is specified. * @opt_param string pageToken Optional. 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 `ListAdGroups` method. If not specified, * the first page of results will be returned. * @return ListAdGroupsResponse * @throws \Google\Service\Exception */ public function listAdvertisersAdGroups($advertiserId, $optParams = []) { $params = ['advertiserId' => $advertiserId]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListAdGroupsResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(AdvertisersAdGroups::class, 'Google_Service_DisplayVideo_Resource_AdvertisersAdGroups');