gestione documentale avanzata 1 parte

This commit is contained in:
2026-05-28 09:34:28 +02:00
parent 3471befb1a
commit f2b0833b90
34482 changed files with 4312269 additions and 546 deletions
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class ActivatePretargetingConfigRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivatePretargetingConfigRequest::class, 'Google_Service_RealTimeBidding_ActivatePretargetingConfigRequest');
@@ -0,0 +1,113 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class AdTechnologyProviders extends \Google\Collection
{
protected $collection_key = 'unidentifiedProviderDomains';
/**
* The detected IAB Global Vendor List (GVL) IDs for this creative. See the
* IAB Global Vendor List at https://vendor-list.consensu.org/v2/vendor-
* list.json for details about the vendors.
*
* @var string[]
*/
public $detectedGvlIds;
/**
* The detected [Google Ad Tech Providers
* (ATP)](https://support.google.com/admanager/answer/9012903) for this
* creative. See https://storage.googleapis.com/adx-rtb-
* dictionaries/providers.csv for mapping of provider ID to provided name, a
* privacy policy URL, and a list of domains which can be attributed to the
* provider.
*
* @var string[]
*/
public $detectedProviderIds;
/**
* Domains of detected unidentified ad technology providers (if any). You must
* ensure that the creatives used in bids placed for inventory that will serve
* to EEA or UK users does not contain unidentified ad technology providers.
* Google reserves the right to filter non-compliant bids.
*
* @var string[]
*/
public $unidentifiedProviderDomains;
/**
* The detected IAB Global Vendor List (GVL) IDs for this creative. See the
* IAB Global Vendor List at https://vendor-list.consensu.org/v2/vendor-
* list.json for details about the vendors.
*
* @param string[] $detectedGvlIds
*/
public function setDetectedGvlIds($detectedGvlIds)
{
$this->detectedGvlIds = $detectedGvlIds;
}
/**
* @return string[]
*/
public function getDetectedGvlIds()
{
return $this->detectedGvlIds;
}
/**
* The detected [Google Ad Tech Providers
* (ATP)](https://support.google.com/admanager/answer/9012903) for this
* creative. See https://storage.googleapis.com/adx-rtb-
* dictionaries/providers.csv for mapping of provider ID to provided name, a
* privacy policy URL, and a list of domains which can be attributed to the
* provider.
*
* @param string[] $detectedProviderIds
*/
public function setDetectedProviderIds($detectedProviderIds)
{
$this->detectedProviderIds = $detectedProviderIds;
}
/**
* @return string[]
*/
public function getDetectedProviderIds()
{
return $this->detectedProviderIds;
}
/**
* Domains of detected unidentified ad technology providers (if any). You must
* ensure that the creatives used in bids placed for inventory that will serve
* to EEA or UK users does not contain unidentified ad technology providers.
* Google reserves the right to filter non-compliant bids.
*
* @param string[] $unidentifiedProviderDomains
*/
public function setUnidentifiedProviderDomains($unidentifiedProviderDomains)
{
$this->unidentifiedProviderDomains = $unidentifiedProviderDomains;
}
/**
* @return string[]
*/
public function getUnidentifiedProviderDomains()
{
return $this->unidentifiedProviderDomains;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AdTechnologyProviders::class, 'Google_Service_RealTimeBidding_AdTechnologyProviders');
@@ -0,0 +1,97 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class AddTargetedAppsRequest extends \Google\Collection
{
/**
* Placeholder for undefined targeting mode.
*/
public const TARGETING_MODE_TARGETING_MODE_UNSPECIFIED = 'TARGETING_MODE_UNSPECIFIED';
/**
* The inclusive list type. Inventory must match an item in this list to be
* targeted.
*/
public const TARGETING_MODE_INCLUSIVE = 'INCLUSIVE';
/**
* The exclusive list type. Inventory must not match any item in this list to
* be targeted.
*/
public const TARGETING_MODE_EXCLUSIVE = 'EXCLUSIVE';
protected $collection_key = 'appIds';
/**
* A list of app IDs to target in the pretargeting configuration. These values
* will be added to the list of targeted app IDs in
* PretargetingConfig.appTargeting.mobileAppTargeting.values.
*
* @var string[]
*/
public $appIds;
/**
* Required. The targeting mode that should be applied to the list of app IDs.
* If there are existing targeted app IDs, must be equal to the existing
* PretargetingConfig.appTargeting.mobileAppTargeting.targetingMode or a 400
* bad request error will be returned.
*
* @var string
*/
public $targetingMode;
/**
* A list of app IDs to target in the pretargeting configuration. These values
* will be added to the list of targeted app IDs in
* PretargetingConfig.appTargeting.mobileAppTargeting.values.
*
* @param string[] $appIds
*/
public function setAppIds($appIds)
{
$this->appIds = $appIds;
}
/**
* @return string[]
*/
public function getAppIds()
{
return $this->appIds;
}
/**
* Required. The targeting mode that should be applied to the list of app IDs.
* If there are existing targeted app IDs, must be equal to the existing
* PretargetingConfig.appTargeting.mobileAppTargeting.targetingMode or a 400
* bad request error will be returned.
*
* Accepted values: TARGETING_MODE_UNSPECIFIED, INCLUSIVE, EXCLUSIVE
*
* @param self::TARGETING_MODE_* $targetingMode
*/
public function setTargetingMode($targetingMode)
{
$this->targetingMode = $targetingMode;
}
/**
* @return self::TARGETING_MODE_*
*/
public function getTargetingMode()
{
return $this->targetingMode;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AddTargetedAppsRequest::class, 'Google_Service_RealTimeBidding_AddTargetedAppsRequest');
@@ -0,0 +1,103 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class AddTargetedPublishersRequest extends \Google\Collection
{
/**
* Placeholder for undefined targeting mode.
*/
public const TARGETING_MODE_TARGETING_MODE_UNSPECIFIED = 'TARGETING_MODE_UNSPECIFIED';
/**
* The inclusive list type. Inventory must match an item in this list to be
* targeted.
*/
public const TARGETING_MODE_INCLUSIVE = 'INCLUSIVE';
/**
* The exclusive list type. Inventory must not match any item in this list to
* be targeted.
*/
public const TARGETING_MODE_EXCLUSIVE = 'EXCLUSIVE';
protected $collection_key = 'publisherIds';
/**
* A list of publisher IDs to target in the pretargeting configuration. These
* values will be added to the list of targeted publisher IDs in
* PretargetingConfig.publisherTargeting.values. Publishers are identified by
* their publisher ID from ads.txt / app-ads.txt. See
* https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for
* more details.
*
* @var string[]
*/
public $publisherIds;
/**
* Required. The targeting mode that should be applied to the list of
* publisher IDs. If are existing publisher IDs, must be equal to the existing
* PretargetingConfig.publisherTargeting.targetingMode or a 400 bad request
* error will be returned.
*
* @var string
*/
public $targetingMode;
/**
* A list of publisher IDs to target in the pretargeting configuration. These
* values will be added to the list of targeted publisher IDs in
* PretargetingConfig.publisherTargeting.values. Publishers are identified by
* their publisher ID from ads.txt / app-ads.txt. See
* https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for
* more details.
*
* @param string[] $publisherIds
*/
public function setPublisherIds($publisherIds)
{
$this->publisherIds = $publisherIds;
}
/**
* @return string[]
*/
public function getPublisherIds()
{
return $this->publisherIds;
}
/**
* Required. The targeting mode that should be applied to the list of
* publisher IDs. If are existing publisher IDs, must be equal to the existing
* PretargetingConfig.publisherTargeting.targetingMode or a 400 bad request
* error will be returned.
*
* Accepted values: TARGETING_MODE_UNSPECIFIED, INCLUSIVE, EXCLUSIVE
*
* @param self::TARGETING_MODE_* $targetingMode
*/
public function setTargetingMode($targetingMode)
{
$this->targetingMode = $targetingMode;
}
/**
* @return self::TARGETING_MODE_*
*/
public function getTargetingMode()
{
return $this->targetingMode;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AddTargetedPublishersRequest::class, 'Google_Service_RealTimeBidding_AddTargetedPublishersRequest');
@@ -0,0 +1,97 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class AddTargetedSitesRequest extends \Google\Collection
{
/**
* Placeholder for undefined targeting mode.
*/
public const TARGETING_MODE_TARGETING_MODE_UNSPECIFIED = 'TARGETING_MODE_UNSPECIFIED';
/**
* The inclusive list type. Inventory must match an item in this list to be
* targeted.
*/
public const TARGETING_MODE_INCLUSIVE = 'INCLUSIVE';
/**
* The exclusive list type. Inventory must not match any item in this list to
* be targeted.
*/
public const TARGETING_MODE_EXCLUSIVE = 'EXCLUSIVE';
protected $collection_key = 'sites';
/**
* A list of site URLs to target in the pretargeting configuration. These
* values will be added to the list of targeted URLs in
* PretargetingConfig.webTargeting.values.
*
* @var string[]
*/
public $sites;
/**
* Required. The targeting mode that should be applied to the list of site
* URLs. If there are existing targeted sites, must be equal to the existing
* PretargetingConfig.webTargeting.targetingMode or a 400 bad request error
* will be returned.
*
* @var string
*/
public $targetingMode;
/**
* A list of site URLs to target in the pretargeting configuration. These
* values will be added to the list of targeted URLs in
* PretargetingConfig.webTargeting.values.
*
* @param string[] $sites
*/
public function setSites($sites)
{
$this->sites = $sites;
}
/**
* @return string[]
*/
public function getSites()
{
return $this->sites;
}
/**
* Required. The targeting mode that should be applied to the list of site
* URLs. If there are existing targeted sites, must be equal to the existing
* PretargetingConfig.webTargeting.targetingMode or a 400 bad request error
* will be returned.
*
* Accepted values: TARGETING_MODE_UNSPECIFIED, INCLUSIVE, EXCLUSIVE
*
* @param self::TARGETING_MODE_* $targetingMode
*/
public function setTargetingMode($targetingMode)
{
$this->targetingMode = $targetingMode;
}
/**
* @return self::TARGETING_MODE_*
*/
public function getTargetingMode()
{
return $this->targetingMode;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AddTargetedSitesRequest::class, 'Google_Service_RealTimeBidding_AddTargetedSitesRequest');
@@ -0,0 +1,128 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class AdvertiserAndBrand extends \Google\Model
{
/**
* See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt for
* the list of possible values. Can be used to filter the response of the
* creatives.list method.
*
* @var string
*/
public $advertiserId;
/**
* Advertiser name. Can be used to filter the response of the creatives.list
* method.
*
* @var string
*/
public $advertiserName;
/**
* Detected brand ID or zero if no brand has been detected. See
* https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for the list
* of possible values. Can be used to filter the response of the
* creatives.list method.
*
* @var string
*/
public $brandId;
/**
* Brand name. Can be used to filter the response of the creatives.list
* method.
*
* @var string
*/
public $brandName;
/**
* See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt for
* the list of possible values. Can be used to filter the response of the
* creatives.list method.
*
* @param string $advertiserId
*/
public function setAdvertiserId($advertiserId)
{
$this->advertiserId = $advertiserId;
}
/**
* @return string
*/
public function getAdvertiserId()
{
return $this->advertiserId;
}
/**
* Advertiser name. Can be used to filter the response of the creatives.list
* method.
*
* @param string $advertiserName
*/
public function setAdvertiserName($advertiserName)
{
$this->advertiserName = $advertiserName;
}
/**
* @return string
*/
public function getAdvertiserName()
{
return $this->advertiserName;
}
/**
* Detected brand ID or zero if no brand has been detected. See
* https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for the list
* of possible values. Can be used to filter the response of the
* creatives.list method.
*
* @param string $brandId
*/
public function setBrandId($brandId)
{
$this->brandId = $brandId;
}
/**
* @return string
*/
public function getBrandId()
{
return $this->brandId;
}
/**
* Brand name. Can be used to filter the response of the creatives.list
* method.
*
* @param string $brandName
*/
public function setBrandName($brandName)
{
$this->brandName = $brandName;
}
/**
* @return string
*/
public function getBrandName()
{
return $this->brandName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AdvertiserAndBrand::class, 'Google_Service_RealTimeBidding_AdvertiserAndBrand');
@@ -0,0 +1,65 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class AppTargeting extends \Google\Model
{
protected $mobileAppCategoryTargetingType = NumericTargetingDimension::class;
protected $mobileAppCategoryTargetingDataType = '';
protected $mobileAppTargetingType = StringTargetingDimension::class;
protected $mobileAppTargetingDataType = '';
/**
* Lists of included and excluded mobile app categories as defined in https://
* developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
*
* @param NumericTargetingDimension $mobileAppCategoryTargeting
*/
public function setMobileAppCategoryTargeting(NumericTargetingDimension $mobileAppCategoryTargeting)
{
$this->mobileAppCategoryTargeting = $mobileAppCategoryTargeting;
}
/**
* @return NumericTargetingDimension
*/
public function getMobileAppCategoryTargeting()
{
return $this->mobileAppCategoryTargeting;
}
/**
* Targeted app IDs. App IDs can refer to those found in an app store or ones
* that are not published in an app store. A maximum of 30,000 app IDs can be
* targeted.
*
* @param StringTargetingDimension $mobileAppTargeting
*/
public function setMobileAppTargeting(StringTargetingDimension $mobileAppTargeting)
{
$this->mobileAppTargeting = $mobileAppTargeting;
}
/**
* @return StringTargetingDimension
*/
public function getMobileAppTargeting()
{
return $this->mobileAppTargeting;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AppTargeting::class, 'Google_Service_RealTimeBidding_AppTargeting');
@@ -0,0 +1,57 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class BatchApprovePublisherConnectionsRequest extends \Google\Collection
{
protected $collection_key = 'names';
/**
* Required. The names of the publishers with which connections will be
* approved. In the pattern
* `bidders/{bidder}/publisherConnections/{publisher}` where `{bidder}` is the
* account ID of the bidder, and `{publisher}` is the ads.txt/app-ads.txt
* publisher ID.
*
* @var string[]
*/
public $names;
/**
* Required. The names of the publishers with which connections will be
* approved. In the pattern
* `bidders/{bidder}/publisherConnections/{publisher}` where `{bidder}` is the
* account ID of the bidder, and `{publisher}` is the ads.txt/app-ads.txt
* publisher ID.
*
* @param string[] $names
*/
public function setNames($names)
{
$this->names = $names;
}
/**
* @return string[]
*/
public function getNames()
{
return $this->names;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchApprovePublisherConnectionsRequest::class, 'Google_Service_RealTimeBidding_BatchApprovePublisherConnectionsRequest');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class BatchApprovePublisherConnectionsResponse extends \Google\Collection
{
protected $collection_key = 'publisherConnections';
protected $publisherConnectionsType = PublisherConnection::class;
protected $publisherConnectionsDataType = 'array';
/**
* The publisher connections that have been approved.
*
* @param PublisherConnection[] $publisherConnections
*/
public function setPublisherConnections($publisherConnections)
{
$this->publisherConnections = $publisherConnections;
}
/**
* @return PublisherConnection[]
*/
public function getPublisherConnections()
{
return $this->publisherConnections;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchApprovePublisherConnectionsResponse::class, 'Google_Service_RealTimeBidding_BatchApprovePublisherConnectionsResponse');
@@ -0,0 +1,57 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class BatchRejectPublisherConnectionsRequest extends \Google\Collection
{
protected $collection_key = 'names';
/**
* Required. The names of the publishers with whom connection will be
* rejected. In the pattern
* `bidders/{bidder}/publisherConnections/{publisher}` where `{bidder}` is the
* account ID of the bidder, and `{publisher}` is the ads.txt/app-ads.txt
* publisher ID.
*
* @var string[]
*/
public $names;
/**
* Required. The names of the publishers with whom connection will be
* rejected. In the pattern
* `bidders/{bidder}/publisherConnections/{publisher}` where `{bidder}` is the
* account ID of the bidder, and `{publisher}` is the ads.txt/app-ads.txt
* publisher ID.
*
* @param string[] $names
*/
public function setNames($names)
{
$this->names = $names;
}
/**
* @return string[]
*/
public function getNames()
{
return $this->names;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchRejectPublisherConnectionsRequest::class, 'Google_Service_RealTimeBidding_BatchRejectPublisherConnectionsRequest');
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class BatchRejectPublisherConnectionsResponse extends \Google\Collection
{
protected $collection_key = 'publisherConnections';
protected $publisherConnectionsType = PublisherConnection::class;
protected $publisherConnectionsDataType = 'array';
/**
* The publisher connections that have been rejected.
*
* @param PublisherConnection[] $publisherConnections
*/
public function setPublisherConnections($publisherConnections)
{
$this->publisherConnections = $publisherConnections;
}
/**
* @return PublisherConnection[]
*/
public function getPublisherConnections()
{
return $this->publisherConnections;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchRejectPublisherConnectionsResponse::class, 'Google_Service_RealTimeBidding_BatchRejectPublisherConnectionsResponse');
@@ -0,0 +1,170 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class Bidder extends \Google\Model
{
/**
* Output only. An option to bypass pretargeting for private auctions and
* preferred deals. When true, bid requests from these nonguaranteed deals
* will always be sent. When false, bid requests will be subject to regular
* pretargeting configurations. Programmatic Guaranteed deals will always be
* sent to the bidder, regardless of the value for this option. Auction
* packages are not impacted by this value and are subject to the regular
* pretargeting configurations.
*
* @var bool
*/
public $bypassNonguaranteedDealsPretargeting;
/**
* Output only. The buyer's network ID used for cookie matching. This ID
* corresponds to the `google_nid` parameter in the URL used in cookie match
* requests. Refer to https://developers.google.com/authorized-
* buyers/rtb/cookie-guide for further information.
*
* @var string
*/
public $cookieMatchingNetworkId;
/**
* Output only. The base URL used in cookie match requests. Refer to
* https://developers.google.com/authorized-buyers/rtb/cookie-guide for
* further information.
*
* @var string
*/
public $cookieMatchingUrl;
/**
* Output only. The billing ID for the deals pretargeting config. This billing
* ID is sent on the bid request for guaranteed and nonguaranteed deals
* matched in pretargeting.
*
* @var string
*/
public $dealsBillingId;
/**
* Output only. Name of the bidder resource that must follow the pattern
* `bidders/{bidderAccountId}`, where `{bidderAccountId}` is the account ID of
* the bidder whose information is to be received. One can get their account
* ID on the Authorized Buyers or Open Bidding UI, or by contacting their
* Google account manager.
*
* @var string
*/
public $name;
/**
* Output only. An option to bypass pretargeting for private auctions and
* preferred deals. When true, bid requests from these nonguaranteed deals
* will always be sent. When false, bid requests will be subject to regular
* pretargeting configurations. Programmatic Guaranteed deals will always be
* sent to the bidder, regardless of the value for this option. Auction
* packages are not impacted by this value and are subject to the regular
* pretargeting configurations.
*
* @param bool $bypassNonguaranteedDealsPretargeting
*/
public function setBypassNonguaranteedDealsPretargeting($bypassNonguaranteedDealsPretargeting)
{
$this->bypassNonguaranteedDealsPretargeting = $bypassNonguaranteedDealsPretargeting;
}
/**
* @return bool
*/
public function getBypassNonguaranteedDealsPretargeting()
{
return $this->bypassNonguaranteedDealsPretargeting;
}
/**
* Output only. The buyer's network ID used for cookie matching. This ID
* corresponds to the `google_nid` parameter in the URL used in cookie match
* requests. Refer to https://developers.google.com/authorized-
* buyers/rtb/cookie-guide for further information.
*
* @param string $cookieMatchingNetworkId
*/
public function setCookieMatchingNetworkId($cookieMatchingNetworkId)
{
$this->cookieMatchingNetworkId = $cookieMatchingNetworkId;
}
/**
* @return string
*/
public function getCookieMatchingNetworkId()
{
return $this->cookieMatchingNetworkId;
}
/**
* Output only. The base URL used in cookie match requests. Refer to
* https://developers.google.com/authorized-buyers/rtb/cookie-guide for
* further information.
*
* @param string $cookieMatchingUrl
*/
public function setCookieMatchingUrl($cookieMatchingUrl)
{
$this->cookieMatchingUrl = $cookieMatchingUrl;
}
/**
* @return string
*/
public function getCookieMatchingUrl()
{
return $this->cookieMatchingUrl;
}
/**
* Output only. The billing ID for the deals pretargeting config. This billing
* ID is sent on the bid request for guaranteed and nonguaranteed deals
* matched in pretargeting.
*
* @param string $dealsBillingId
*/
public function setDealsBillingId($dealsBillingId)
{
$this->dealsBillingId = $dealsBillingId;
}
/**
* @return string
*/
public function getDealsBillingId()
{
return $this->dealsBillingId;
}
/**
* Output only. Name of the bidder resource that must follow the pattern
* `bidders/{bidderAccountId}`, where `{bidderAccountId}` is the account ID of
* the bidder whose information is to be received. One can get their account
* ID on the Authorized Buyers or Open Bidding UI, or by contacting their
* Google account manager.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Bidder::class, 'Google_Service_RealTimeBidding_Bidder');
@@ -0,0 +1,191 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class Buyer extends \Google\Collection
{
protected $collection_key = 'billingIds';
/**
* Output only. The number of creatives that this buyer submitted through the
* API or bid with in the last 30 days. This is counted against the maximum
* number of active creatives.
*
* @var string
*/
public $activeCreativeCount;
/**
* Output only. The name of the bidder resource that is responsible for
* receiving bidding traffic for this account. The bidder name must follow the
* pattern `bidders/{bidderAccountId}`, where `{bidderAccountId}` is the
* account ID of the bidder receiving traffic for this buyer.
*
* @var string
*/
public $bidder;
/**
* Output only. A list of billing IDs associated with this account. These IDs
* appear on: 1. A bid request, to signal which buyers are eligible to bid on
* a given opportunity, and which pretargeting configurations were matched for
* each eligible buyer. 2. The bid response, to attribute a winning impression
* to a specific account for billing, reporting, policy and publisher block
* enforcement.
*
* @var string[]
*/
public $billingIds;
/**
* Output only. The diplay name associated with this buyer account, as visible
* to sellers.
*
* @var string
*/
public $displayName;
/**
* Output only. The maximum number of active creatives that this buyer can
* have.
*
* @var string
*/
public $maximumActiveCreativeCount;
/**
* Output only. Name of the buyer resource that must follow the pattern
* `buyers/{buyerAccountId}`, where `{buyerAccountId}` is the account ID of
* the buyer account whose information is to be received. One can get their
* account ID on the Authorized Buyers or Open Bidding UI, or by contacting
* their Google account manager.
*
* @var string
*/
public $name;
/**
* Output only. The number of creatives that this buyer submitted through the
* API or bid with in the last 30 days. This is counted against the maximum
* number of active creatives.
*
* @param string $activeCreativeCount
*/
public function setActiveCreativeCount($activeCreativeCount)
{
$this->activeCreativeCount = $activeCreativeCount;
}
/**
* @return string
*/
public function getActiveCreativeCount()
{
return $this->activeCreativeCount;
}
/**
* Output only. The name of the bidder resource that is responsible for
* receiving bidding traffic for this account. The bidder name must follow the
* pattern `bidders/{bidderAccountId}`, where `{bidderAccountId}` is the
* account ID of the bidder receiving traffic for this buyer.
*
* @param string $bidder
*/
public function setBidder($bidder)
{
$this->bidder = $bidder;
}
/**
* @return string
*/
public function getBidder()
{
return $this->bidder;
}
/**
* Output only. A list of billing IDs associated with this account. These IDs
* appear on: 1. A bid request, to signal which buyers are eligible to bid on
* a given opportunity, and which pretargeting configurations were matched for
* each eligible buyer. 2. The bid response, to attribute a winning impression
* to a specific account for billing, reporting, policy and publisher block
* enforcement.
*
* @param string[] $billingIds
*/
public function setBillingIds($billingIds)
{
$this->billingIds = $billingIds;
}
/**
* @return string[]
*/
public function getBillingIds()
{
return $this->billingIds;
}
/**
* Output only. The diplay name associated with this buyer account, as visible
* to sellers.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Output only. The maximum number of active creatives that this buyer can
* have.
*
* @param string $maximumActiveCreativeCount
*/
public function setMaximumActiveCreativeCount($maximumActiveCreativeCount)
{
$this->maximumActiveCreativeCount = $maximumActiveCreativeCount;
}
/**
* @return string
*/
public function getMaximumActiveCreativeCount()
{
return $this->maximumActiveCreativeCount;
}
/**
* Output only. Name of the buyer resource that must follow the pattern
* `buyers/{buyerAccountId}`, where `{buyerAccountId}` is the account ID of
* the buyer account whose information is to be received. One can get their
* account ID on the Authorized Buyers or Open Bidding UI, or by contacting
* their Google account manager.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Buyer::class, 'Google_Service_RealTimeBidding_Buyer');
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class CloseUserListRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CloseUserListRequest::class, 'Google_Service_RealTimeBidding_CloseUserListRequest');
@@ -0,0 +1,577 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class Creative extends \Google\Collection
{
/**
* The format is unknown.
*/
public const CREATIVE_FORMAT_CREATIVE_FORMAT_UNSPECIFIED = 'CREATIVE_FORMAT_UNSPECIFIED';
/**
* HTML creative.
*/
public const CREATIVE_FORMAT_HTML = 'HTML';
/**
* Video creative.
*/
public const CREATIVE_FORMAT_VIDEO = 'VIDEO';
/**
* Native creative.
*/
public const CREATIVE_FORMAT_NATIVE = 'NATIVE';
protected $collection_key = 'restrictedCategories';
/**
* Output only. ID of the buyer account that this creative is owned by. Can be
* used to filter the response of the creatives.list method with equality and
* inequality check.
*
* @var string
*/
public $accountId;
/**
* The link to AdChoices destination page. This is only supported for native
* ads.
*
* @var string
*/
public $adChoicesDestinationUrl;
/**
* The name of the company being advertised in the creative. Can be used to
* filter the response of the creatives.list method.
*
* @var string
*/
public $advertiserName;
/**
* The agency ID for this creative.
*
* @var string
*/
public $agencyId;
/**
* Output only. The last update timestamp of the creative through the API.
*
* @var string
*/
public $apiUpdateTime;
/**
* Output only. The format of this creative. Can be used to filter the
* response of the creatives.list method.
*
* @var string
*/
public $creativeFormat;
/**
* Buyer-specific creative ID that references this creative in bid responses.
* This field is Ignored in update operations. Can be used to filter the
* response of the creatives.list method. The maximum length of the creative
* ID is 128 bytes.
*
* @var string
*/
public $creativeId;
protected $creativeServingDecisionType = CreativeServingDecision::class;
protected $creativeServingDecisionDataType = '';
/**
* Output only. IDs of all of the deals with which this creative has been used
* in bidding. Can be used to filter the response of the creatives.list
* method.
*
* @var string[]
*/
public $dealIds;
/**
* All declared attributes for the ads that may be shown from this creative.
* Can be used to filter the response of the creatives.list method. If the
* `excluded_attribute` field of a [bid
* request](https://developers.google.com/authorized-
* buyers/rtb/downloads/realtime-bidding-proto") contains one of the
* attributes that were declared or detected for a given creative, and a bid
* is submitted with that creative, the bid will be filtered before the
* auction.
*
* @var string[]
*/
public $declaredAttributes;
/**
* The set of declared destination URLs for the creative. Can be used to
* filter the response of the creatives.list method.
*
* @var string[]
*/
public $declaredClickThroughUrls;
/**
* All declared restricted categories for the ads that may be shown from this
* creative. Can be used to filter the response of the creatives.list method.
*
* @deprecated
* @var string[]
*/
public $declaredRestrictedCategories;
/**
* IDs for the declared ad technology vendors that may be used by this
* creative. See https://storage.googleapis.com/adx-rtb-
* dictionaries/vendors.txt for possible values. Can be used to filter the
* response of the creatives.list method.
*
* @var int[]
*/
public $declaredVendorIds;
protected $htmlType = HtmlContent::class;
protected $htmlDataType = '';
/**
* The set of URLs to be called to record an impression.
*
* @var string[]
*/
public $impressionTrackingUrls;
/**
* Output only. Name of the creative. Follows the pattern
* `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the
* account ID of the buyer who owns the creative, and `{creative}` is the
* buyer-specific creative ID that references this creative in the bid
* response.
*
* @var string
*/
public $name;
protected $nativeType = NativeContent::class;
protected $nativeDataType = '';
/**
* Deprecated: FLEDGE is no longer supported. See:
* https://privacysandbox.google.com/blog/update-on-plans-for-privacy-sandbox-
* technologies Experimental field that can be used during the [FLEDGE Origin
* Trial](/authorized-buyers/rtb/fledge-origin-trial). The URL to fetch an
* interest group ad used in [TURTLEDOVE on-device
* auction](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#1-browsers-
* record-interest-groups"). This should be unique among all creatives for a
* given `accountId`. This URL should be the same as the URL returned by [gene
* rateBid()](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#32-on-
* device-bidding).
*
* @deprecated
* @var string
*/
public $renderUrl;
/**
* All restricted categories for the ads that may be shown from this creative.
*
* @deprecated
* @var string[]
*/
public $restrictedCategories;
/**
* Output only. The version of the creative. Version for a new creative is 1
* and it increments during subsequent creative updates.
*
* @deprecated
* @var int
*/
public $version;
protected $videoType = VideoContent::class;
protected $videoDataType = '';
/**
* Output only. ID of the buyer account that this creative is owned by. Can be
* used to filter the response of the creatives.list method with equality and
* inequality check.
*
* @param string $accountId
*/
public function setAccountId($accountId)
{
$this->accountId = $accountId;
}
/**
* @return string
*/
public function getAccountId()
{
return $this->accountId;
}
/**
* The link to AdChoices destination page. This is only supported for native
* ads.
*
* @param string $adChoicesDestinationUrl
*/
public function setAdChoicesDestinationUrl($adChoicesDestinationUrl)
{
$this->adChoicesDestinationUrl = $adChoicesDestinationUrl;
}
/**
* @return string
*/
public function getAdChoicesDestinationUrl()
{
return $this->adChoicesDestinationUrl;
}
/**
* The name of the company being advertised in the creative. Can be used to
* filter the response of the creatives.list method.
*
* @param string $advertiserName
*/
public function setAdvertiserName($advertiserName)
{
$this->advertiserName = $advertiserName;
}
/**
* @return string
*/
public function getAdvertiserName()
{
return $this->advertiserName;
}
/**
* The agency ID for this creative.
*
* @param string $agencyId
*/
public function setAgencyId($agencyId)
{
$this->agencyId = $agencyId;
}
/**
* @return string
*/
public function getAgencyId()
{
return $this->agencyId;
}
/**
* Output only. The last update timestamp of the creative through the API.
*
* @param string $apiUpdateTime
*/
public function setApiUpdateTime($apiUpdateTime)
{
$this->apiUpdateTime = $apiUpdateTime;
}
/**
* @return string
*/
public function getApiUpdateTime()
{
return $this->apiUpdateTime;
}
/**
* Output only. The format of this creative. Can be used to filter the
* response of the creatives.list method.
*
* Accepted values: CREATIVE_FORMAT_UNSPECIFIED, HTML, VIDEO, NATIVE
*
* @param self::CREATIVE_FORMAT_* $creativeFormat
*/
public function setCreativeFormat($creativeFormat)
{
$this->creativeFormat = $creativeFormat;
}
/**
* @return self::CREATIVE_FORMAT_*
*/
public function getCreativeFormat()
{
return $this->creativeFormat;
}
/**
* Buyer-specific creative ID that references this creative in bid responses.
* This field is Ignored in update operations. Can be used to filter the
* response of the creatives.list method. The maximum length of the creative
* ID is 128 bytes.
*
* @param string $creativeId
*/
public function setCreativeId($creativeId)
{
$this->creativeId = $creativeId;
}
/**
* @return string
*/
public function getCreativeId()
{
return $this->creativeId;
}
/**
* Output only. Top level status and detected attributes of a creative (for
* example domain, language, advertiser, product category, etc.) that affect
* whether (status) and where (context) a creative will be allowed to serve.
*
* @param CreativeServingDecision $creativeServingDecision
*/
public function setCreativeServingDecision(CreativeServingDecision $creativeServingDecision)
{
$this->creativeServingDecision = $creativeServingDecision;
}
/**
* @return CreativeServingDecision
*/
public function getCreativeServingDecision()
{
return $this->creativeServingDecision;
}
/**
* Output only. IDs of all of the deals with which this creative has been used
* in bidding. Can be used to filter the response of the creatives.list
* method.
*
* @param string[] $dealIds
*/
public function setDealIds($dealIds)
{
$this->dealIds = $dealIds;
}
/**
* @return string[]
*/
public function getDealIds()
{
return $this->dealIds;
}
/**
* All declared attributes for the ads that may be shown from this creative.
* Can be used to filter the response of the creatives.list method. If the
* `excluded_attribute` field of a [bid
* request](https://developers.google.com/authorized-
* buyers/rtb/downloads/realtime-bidding-proto") contains one of the
* attributes that were declared or detected for a given creative, and a bid
* is submitted with that creative, the bid will be filtered before the
* auction.
*
* @param string[] $declaredAttributes
*/
public function setDeclaredAttributes($declaredAttributes)
{
$this->declaredAttributes = $declaredAttributes;
}
/**
* @return string[]
*/
public function getDeclaredAttributes()
{
return $this->declaredAttributes;
}
/**
* The set of declared destination URLs for the creative. Can be used to
* filter the response of the creatives.list method.
*
* @param string[] $declaredClickThroughUrls
*/
public function setDeclaredClickThroughUrls($declaredClickThroughUrls)
{
$this->declaredClickThroughUrls = $declaredClickThroughUrls;
}
/**
* @return string[]
*/
public function getDeclaredClickThroughUrls()
{
return $this->declaredClickThroughUrls;
}
/**
* All declared restricted categories for the ads that may be shown from this
* creative. Can be used to filter the response of the creatives.list method.
*
* @deprecated
* @param string[] $declaredRestrictedCategories
*/
public function setDeclaredRestrictedCategories($declaredRestrictedCategories)
{
$this->declaredRestrictedCategories = $declaredRestrictedCategories;
}
/**
* @deprecated
* @return string[]
*/
public function getDeclaredRestrictedCategories()
{
return $this->declaredRestrictedCategories;
}
/**
* IDs for the declared ad technology vendors that may be used by this
* creative. See https://storage.googleapis.com/adx-rtb-
* dictionaries/vendors.txt for possible values. Can be used to filter the
* response of the creatives.list method.
*
* @param int[] $declaredVendorIds
*/
public function setDeclaredVendorIds($declaredVendorIds)
{
$this->declaredVendorIds = $declaredVendorIds;
}
/**
* @return int[]
*/
public function getDeclaredVendorIds()
{
return $this->declaredVendorIds;
}
/**
* An HTML creative.
*
* @param HtmlContent $html
*/
public function setHtml(HtmlContent $html)
{
$this->html = $html;
}
/**
* @return HtmlContent
*/
public function getHtml()
{
return $this->html;
}
/**
* The set of URLs to be called to record an impression.
*
* @param string[] $impressionTrackingUrls
*/
public function setImpressionTrackingUrls($impressionTrackingUrls)
{
$this->impressionTrackingUrls = $impressionTrackingUrls;
}
/**
* @return string[]
*/
public function getImpressionTrackingUrls()
{
return $this->impressionTrackingUrls;
}
/**
* Output only. Name of the creative. Follows the pattern
* `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the
* account ID of the buyer who owns the creative, and `{creative}` is the
* buyer-specific creative ID that references this creative in the bid
* response.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* A native creative.
*
* @param NativeContent $native
*/
public function setNative(NativeContent $native)
{
$this->native = $native;
}
/**
* @return NativeContent
*/
public function getNative()
{
return $this->native;
}
/**
* Deprecated: FLEDGE is no longer supported. See:
* https://privacysandbox.google.com/blog/update-on-plans-for-privacy-sandbox-
* technologies Experimental field that can be used during the [FLEDGE Origin
* Trial](/authorized-buyers/rtb/fledge-origin-trial). The URL to fetch an
* interest group ad used in [TURTLEDOVE on-device
* auction](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#1-browsers-
* record-interest-groups"). This should be unique among all creatives for a
* given `accountId`. This URL should be the same as the URL returned by [gene
* rateBid()](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#32-on-
* device-bidding).
*
* @deprecated
* @param string $renderUrl
*/
public function setRenderUrl($renderUrl)
{
$this->renderUrl = $renderUrl;
}
/**
* @deprecated
* @return string
*/
public function getRenderUrl()
{
return $this->renderUrl;
}
/**
* All restricted categories for the ads that may be shown from this creative.
*
* @deprecated
* @param string[] $restrictedCategories
*/
public function setRestrictedCategories($restrictedCategories)
{
$this->restrictedCategories = $restrictedCategories;
}
/**
* @deprecated
* @return string[]
*/
public function getRestrictedCategories()
{
return $this->restrictedCategories;
}
/**
* Output only. The version of the creative. Version for a new creative is 1
* and it increments during subsequent creative updates.
*
* @deprecated
* @param int $version
*/
public function setVersion($version)
{
$this->version = $version;
}
/**
* @deprecated
* @return int
*/
public function getVersion()
{
return $this->version;
}
/**
* A video creative.
*
* @param VideoContent $video
*/
public function setVideo(VideoContent $video)
{
$this->video = $video;
}
/**
* @return VideoContent
*/
public function getVideo()
{
return $this->video;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Creative::class, 'Google_Service_RealTimeBidding_Creative');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class CreativeDimensions extends \Google\Model
{
/**
* The height of the creative in pixels.
*
* @var string
*/
public $height;
/**
* The width of the creative in pixels.
*
* @var string
*/
public $width;
/**
* The height of the creative in pixels.
*
* @param string $height
*/
public function setHeight($height)
{
$this->height = $height;
}
/**
* @return string
*/
public function getHeight()
{
return $this->height;
}
/**
* The width of the creative in pixels.
*
* @param string $width
*/
public function setWidth($width)
{
$this->width = $width;
}
/**
* @return string
*/
public function getWidth()
{
return $this->width;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreativeDimensions::class, 'Google_Service_RealTimeBidding_CreativeDimensions');
@@ -0,0 +1,464 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class CreativeServingDecision extends \Google\Collection
{
/**
* Default value that should never be used.
*/
public const DETECTED_CATEGORIES_TAXONOMY_AD_CATEGORY_TAXONOMY_UNSPECIFIED = 'AD_CATEGORY_TAXONOMY_UNSPECIFIED';
/**
* Google ad categories taxonomy, including product categories and sensitive
* categories. Find the category lists at
* https://developers.google.com/authorized-buyers/rtb/data#reference-data
*/
public const DETECTED_CATEGORIES_TAXONOMY_GOOGLE_AD_CATEGORY_TAXONOMY = 'GOOGLE_AD_CATEGORY_TAXONOMY';
/**
* IAB Content Taxonomy 1.0. See https://github.com/InteractiveAdvertisingBure
* au/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%201.0.tsv
* for more details.
*/
public const DETECTED_CATEGORIES_TAXONOMY_IAB_CONTENT_1_0 = 'IAB_CONTENT_1_0';
protected $collection_key = 'detectedVendorIds';
protected $adTechnologyProvidersType = AdTechnologyProviders::class;
protected $adTechnologyProvidersDataType = '';
protected $chinaPolicyComplianceType = PolicyCompliance::class;
protected $chinaPolicyComplianceDataType = '';
protected $dealsPolicyComplianceType = PolicyCompliance::class;
protected $dealsPolicyComplianceDataType = '';
protected $detectedAdvertisersType = AdvertiserAndBrand::class;
protected $detectedAdvertisersDataType = 'array';
/**
* Publisher-excludable attributes that were detected for this creative. Can
* be used to filter the response of the creatives.list method. If the
* `excluded_attribute` field of a [bid
* request](https://developers.google.com/authorized-
* buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes
* that were declared or detected for a given creative, and a bid is submitted
* with that creative, the bid will be filtered before the auction.
*
* @var string[]
*/
public $detectedAttributes;
/**
* Output only. IDs of the detected categories. The taxonomy in which the
* categories are expressed is specified by the detected_categories_taxonomy
* field. Use this in conjunction with BidRequest.bcat to avoid bidding on
* impressions where a given ad category is blocked, or to troubleshoot
* filtered bids. Can be used to filter the response of the creatives.list
* method.
*
* @var string[]
*/
public $detectedCategories;
/**
* Output only. The taxonomy in which the detected_categories field is
* expressed.
*
* @var string
*/
public $detectedCategoriesTaxonomy;
/**
* The set of detected destination URLs for the creative. Can be used to
* filter the response of the creatives.list method.
*
* @var string[]
*/
public $detectedClickThroughUrls;
/**
* The detected domains for this creative.
*
* @var string[]
*/
public $detectedDomains;
/**
* The detected languages for this creative. The order is arbitrary. The codes
* are 2 or 5 characters and are documented at
* https://developers.google.com/adwords/api/docs/appendix/languagecodes. Can
* be used to filter the response of the creatives.list method.
*
* @var string[]
*/
public $detectedLanguages;
/**
* Detected product categories, if any. See the ad-product-categories.txt file
* in the technical documentation for a list of IDs. Can be used to filter the
* response of the creatives.list method.
*
* @var int[]
*/
public $detectedProductCategories;
/**
* Detected sensitive categories, if any. Can be used to filter the response
* of the creatives.list method. See the ad-sensitive-categories.txt file in
* the technical documentation for a list of IDs. You should use these IDs
* along with the excluded-sensitive-category field in the bid request to
* filter your bids.
*
* @var int[]
*/
public $detectedSensitiveCategories;
/**
* IDs of the ad technology vendors that were detected to be used by this
* creative. See https://storage.googleapis.com/adx-rtb-
* dictionaries/vendors.txt for possible values. Can be used to filter the
* response of the creatives.list method. If the `allowed_vendor_type` field
* of a [bid request](https://developers.google.com/authorized-
* buyers/rtb/downloads/realtime-bidding-proto) does not contain one of the
* vendor type IDs that were declared or detected for a given creative, and a
* bid is submitted with that creative, the bid will be filtered before the
* auction.
*
* @var int[]
*/
public $detectedVendorIds;
/**
* The last time the creative status was updated. Can be used to filter the
* response of the creatives.list method.
*
* @var string
*/
public $lastStatusUpdate;
protected $networkPolicyComplianceType = PolicyCompliance::class;
protected $networkPolicyComplianceDataType = '';
protected $platformPolicyComplianceType = PolicyCompliance::class;
protected $platformPolicyComplianceDataType = '';
protected $russiaPolicyComplianceType = PolicyCompliance::class;
protected $russiaPolicyComplianceDataType = '';
/**
* The detected ad technology providers.
*
* @param AdTechnologyProviders $adTechnologyProviders
*/
public function setAdTechnologyProviders(AdTechnologyProviders $adTechnologyProviders)
{
$this->adTechnologyProviders = $adTechnologyProviders;
}
/**
* @return AdTechnologyProviders
*/
public function getAdTechnologyProviders()
{
return $this->adTechnologyProviders;
}
/**
* The policy compliance of this creative in China. When approved or
* disapproved, this applies to both deals and open auction in China. When
* pending review, this creative is allowed to serve for deals but not for
* open auction.
*
* @param PolicyCompliance $chinaPolicyCompliance
*/
public function setChinaPolicyCompliance(PolicyCompliance $chinaPolicyCompliance)
{
$this->chinaPolicyCompliance = $chinaPolicyCompliance;
}
/**
* @return PolicyCompliance
*/
public function getChinaPolicyCompliance()
{
return $this->chinaPolicyCompliance;
}
/**
* Policy compliance of this creative when bidding on Programmatic Guaranteed
* and Preferred Deals (outside of Russia and China).
*
* @param PolicyCompliance $dealsPolicyCompliance
*/
public function setDealsPolicyCompliance(PolicyCompliance $dealsPolicyCompliance)
{
$this->dealsPolicyCompliance = $dealsPolicyCompliance;
}
/**
* @return PolicyCompliance
*/
public function getDealsPolicyCompliance()
{
return $this->dealsPolicyCompliance;
}
/**
* Detected advertisers and brands.
*
* @param AdvertiserAndBrand[] $detectedAdvertisers
*/
public function setDetectedAdvertisers($detectedAdvertisers)
{
$this->detectedAdvertisers = $detectedAdvertisers;
}
/**
* @return AdvertiserAndBrand[]
*/
public function getDetectedAdvertisers()
{
return $this->detectedAdvertisers;
}
/**
* Publisher-excludable attributes that were detected for this creative. Can
* be used to filter the response of the creatives.list method. If the
* `excluded_attribute` field of a [bid
* request](https://developers.google.com/authorized-
* buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes
* that were declared or detected for a given creative, and a bid is submitted
* with that creative, the bid will be filtered before the auction.
*
* @param string[] $detectedAttributes
*/
public function setDetectedAttributes($detectedAttributes)
{
$this->detectedAttributes = $detectedAttributes;
}
/**
* @return string[]
*/
public function getDetectedAttributes()
{
return $this->detectedAttributes;
}
/**
* Output only. IDs of the detected categories. The taxonomy in which the
* categories are expressed is specified by the detected_categories_taxonomy
* field. Use this in conjunction with BidRequest.bcat to avoid bidding on
* impressions where a given ad category is blocked, or to troubleshoot
* filtered bids. Can be used to filter the response of the creatives.list
* method.
*
* @param string[] $detectedCategories
*/
public function setDetectedCategories($detectedCategories)
{
$this->detectedCategories = $detectedCategories;
}
/**
* @return string[]
*/
public function getDetectedCategories()
{
return $this->detectedCategories;
}
/**
* Output only. The taxonomy in which the detected_categories field is
* expressed.
*
* Accepted values: AD_CATEGORY_TAXONOMY_UNSPECIFIED,
* GOOGLE_AD_CATEGORY_TAXONOMY, IAB_CONTENT_1_0
*
* @param self::DETECTED_CATEGORIES_TAXONOMY_* $detectedCategoriesTaxonomy
*/
public function setDetectedCategoriesTaxonomy($detectedCategoriesTaxonomy)
{
$this->detectedCategoriesTaxonomy = $detectedCategoriesTaxonomy;
}
/**
* @return self::DETECTED_CATEGORIES_TAXONOMY_*
*/
public function getDetectedCategoriesTaxonomy()
{
return $this->detectedCategoriesTaxonomy;
}
/**
* The set of detected destination URLs for the creative. Can be used to
* filter the response of the creatives.list method.
*
* @param string[] $detectedClickThroughUrls
*/
public function setDetectedClickThroughUrls($detectedClickThroughUrls)
{
$this->detectedClickThroughUrls = $detectedClickThroughUrls;
}
/**
* @return string[]
*/
public function getDetectedClickThroughUrls()
{
return $this->detectedClickThroughUrls;
}
/**
* The detected domains for this creative.
*
* @param string[] $detectedDomains
*/
public function setDetectedDomains($detectedDomains)
{
$this->detectedDomains = $detectedDomains;
}
/**
* @return string[]
*/
public function getDetectedDomains()
{
return $this->detectedDomains;
}
/**
* The detected languages for this creative. The order is arbitrary. The codes
* are 2 or 5 characters and are documented at
* https://developers.google.com/adwords/api/docs/appendix/languagecodes. Can
* be used to filter the response of the creatives.list method.
*
* @param string[] $detectedLanguages
*/
public function setDetectedLanguages($detectedLanguages)
{
$this->detectedLanguages = $detectedLanguages;
}
/**
* @return string[]
*/
public function getDetectedLanguages()
{
return $this->detectedLanguages;
}
/**
* Detected product categories, if any. See the ad-product-categories.txt file
* in the technical documentation for a list of IDs. Can be used to filter the
* response of the creatives.list method.
*
* @param int[] $detectedProductCategories
*/
public function setDetectedProductCategories($detectedProductCategories)
{
$this->detectedProductCategories = $detectedProductCategories;
}
/**
* @return int[]
*/
public function getDetectedProductCategories()
{
return $this->detectedProductCategories;
}
/**
* Detected sensitive categories, if any. Can be used to filter the response
* of the creatives.list method. See the ad-sensitive-categories.txt file in
* the technical documentation for a list of IDs. You should use these IDs
* along with the excluded-sensitive-category field in the bid request to
* filter your bids.
*
* @param int[] $detectedSensitiveCategories
*/
public function setDetectedSensitiveCategories($detectedSensitiveCategories)
{
$this->detectedSensitiveCategories = $detectedSensitiveCategories;
}
/**
* @return int[]
*/
public function getDetectedSensitiveCategories()
{
return $this->detectedSensitiveCategories;
}
/**
* IDs of the ad technology vendors that were detected to be used by this
* creative. See https://storage.googleapis.com/adx-rtb-
* dictionaries/vendors.txt for possible values. Can be used to filter the
* response of the creatives.list method. If the `allowed_vendor_type` field
* of a [bid request](https://developers.google.com/authorized-
* buyers/rtb/downloads/realtime-bidding-proto) does not contain one of the
* vendor type IDs that were declared or detected for a given creative, and a
* bid is submitted with that creative, the bid will be filtered before the
* auction.
*
* @param int[] $detectedVendorIds
*/
public function setDetectedVendorIds($detectedVendorIds)
{
$this->detectedVendorIds = $detectedVendorIds;
}
/**
* @return int[]
*/
public function getDetectedVendorIds()
{
return $this->detectedVendorIds;
}
/**
* The last time the creative status was updated. Can be used to filter the
* response of the creatives.list method.
*
* @param string $lastStatusUpdate
*/
public function setLastStatusUpdate($lastStatusUpdate)
{
$this->lastStatusUpdate = $lastStatusUpdate;
}
/**
* @return string
*/
public function getLastStatusUpdate()
{
return $this->lastStatusUpdate;
}
/**
* Policy compliance of this creative when bidding in open auction, private
* auction, or auction packages (outside of Russia and China).
*
* @param PolicyCompliance $networkPolicyCompliance
*/
public function setNetworkPolicyCompliance(PolicyCompliance $networkPolicyCompliance)
{
$this->networkPolicyCompliance = $networkPolicyCompliance;
}
/**
* @return PolicyCompliance
*/
public function getNetworkPolicyCompliance()
{
return $this->networkPolicyCompliance;
}
/**
* Policy compliance of this creative when bidding in Open Bidding (outside of
* Russia and China). For the list of platform policies, see:
* https://support.google.com/platformspolicy/answer/3013851.
*
* @param PolicyCompliance $platformPolicyCompliance
*/
public function setPlatformPolicyCompliance(PolicyCompliance $platformPolicyCompliance)
{
$this->platformPolicyCompliance = $platformPolicyCompliance;
}
/**
* @return PolicyCompliance
*/
public function getPlatformPolicyCompliance()
{
return $this->platformPolicyCompliance;
}
/**
* The policy compliance of this creative in Russia. When approved or
* disapproved, this applies to both deals and open auction in Russia. When
* pending review, this creative is allowed to serve for deals but not for
* open auction.
*
* @param PolicyCompliance $russiaPolicyCompliance
*/
public function setRussiaPolicyCompliance(PolicyCompliance $russiaPolicyCompliance)
{
$this->russiaPolicyCompliance = $russiaPolicyCompliance;
}
/**
* @return PolicyCompliance
*/
public function getRussiaPolicyCompliance()
{
return $this->russiaPolicyCompliance;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreativeServingDecision::class, 'Google_Service_RealTimeBidding_CreativeServingDecision');
@@ -0,0 +1,100 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class Date extends \Google\Model
{
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
* to specify a year by itself or a year and month where the day isn't
* significant.
*
* @var int
*/
public $day;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a
* month and day.
*
* @var int
*/
public $month;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
* year.
*
* @var int
*/
public $year;
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
* to specify a year by itself or a year and month where the day isn't
* significant.
*
* @param int $day
*/
public function setDay($day)
{
$this->day = $day;
}
/**
* @return int
*/
public function getDay()
{
return $this->day;
}
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a
* month and day.
*
* @param int $month
*/
public function setMonth($month)
{
$this->month = $month;
}
/**
* @return int
*/
public function getMonth()
{
return $this->month;
}
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
* year.
*
* @param int $year
*/
public function setYear($year)
{
$this->year = $year;
}
/**
* @return int
*/
public function getYear()
{
return $this->year;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Date::class, 'Google_Service_RealTimeBidding_Date');
@@ -0,0 +1,116 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class DestinationNotCrawlableEvidence extends \Google\Model
{
/**
* Default value that should never be used.
*/
public const REASON_REASON_UNSPECIFIED = 'REASON_UNSPECIFIED';
/**
* Site's robots exclusion file (for example, robots.txt) was unreachable.
*/
public const REASON_UNREACHABLE_ROBOTS = 'UNREACHABLE_ROBOTS';
/**
* Timed out reading site's robots exclusion file (for example, robots.txt).
*/
public const REASON_TIMEOUT_ROBOTS = 'TIMEOUT_ROBOTS';
/**
* Crawler was disallowed by the site's robots exclusion file (for example,
* robots.txt).
*/
public const REASON_ROBOTED_DENIED = 'ROBOTED_DENIED';
/**
* Unknown reason.
*/
public const REASON_UNKNOWN = 'UNKNOWN';
/**
* Approximate time of the crawl.
*
* @var string
*/
public $crawlTime;
/**
* Destination URL that was attempted to be crawled.
*
* @var string
*/
public $crawledUrl;
/**
* Reason of destination not crawlable.
*
* @var string
*/
public $reason;
/**
* Approximate time of the crawl.
*
* @param string $crawlTime
*/
public function setCrawlTime($crawlTime)
{
$this->crawlTime = $crawlTime;
}
/**
* @return string
*/
public function getCrawlTime()
{
return $this->crawlTime;
}
/**
* Destination URL that was attempted to be crawled.
*
* @param string $crawledUrl
*/
public function setCrawledUrl($crawledUrl)
{
$this->crawledUrl = $crawledUrl;
}
/**
* @return string
*/
public function getCrawledUrl()
{
return $this->crawledUrl;
}
/**
* Reason of destination not crawlable.
*
* Accepted values: REASON_UNSPECIFIED, UNREACHABLE_ROBOTS, TIMEOUT_ROBOTS,
* ROBOTED_DENIED, UNKNOWN
*
* @param self::REASON_* $reason
*/
public function setReason($reason)
{
$this->reason = $reason;
}
/**
* @return self::REASON_*
*/
public function getReason()
{
return $this->reason;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DestinationNotCrawlableEvidence::class, 'Google_Service_RealTimeBidding_DestinationNotCrawlableEvidence');
@@ -0,0 +1,290 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class DestinationNotWorkingEvidence extends \Google\Model
{
/**
* Default value that should never be used.
*/
public const DNS_ERROR_DNS_ERROR_UNSPECIFIED = 'DNS_ERROR_UNSPECIFIED';
/**
* DNS name was not found.
*/
public const DNS_ERROR_ERROR_DNS = 'ERROR_DNS';
/**
* An internal issue occurred when Google's crawler tried to resolve the DNS
* entry. This is a Google-internal issue and may not be the result of an
* issue with the landing page.
*/
public const DNS_ERROR_GOOGLE_CRAWLER_DNS_ISSUE = 'GOOGLE_CRAWLER_DNS_ISSUE';
/**
* Default value that should never be used.
*/
public const INVALID_PAGE_INVALID_PAGE_UNSPECIFIED = 'INVALID_PAGE_UNSPECIFIED';
/**
* Page was empty or had an error.
*/
public const INVALID_PAGE_EMPTY_OR_ERROR_PAGE = 'EMPTY_OR_ERROR_PAGE';
/**
* Default value that should never be used.
*/
public const PLATFORM_PLATFORM_UNSPECIFIED = 'PLATFORM_UNSPECIFIED';
/**
* The personal computer platform.
*/
public const PLATFORM_PERSONAL_COMPUTER = 'PERSONAL_COMPUTER';
/**
* The Android platform.
*/
public const PLATFORM_ANDROID = 'ANDROID';
/**
* The iOS platform.
*/
public const PLATFORM_IOS = 'IOS';
/**
* Default value that should never be used.
*/
public const REDIRECTION_ERROR_REDIRECTION_ERROR_UNSPECIFIED = 'REDIRECTION_ERROR_UNSPECIFIED';
/**
* Too many redirect hops.
*/
public const REDIRECTION_ERROR_TOO_MANY_REDIRECTS = 'TOO_MANY_REDIRECTS';
/**
* Got a redirect but it was invalid.
*/
public const REDIRECTION_ERROR_INVALID_REDIRECT = 'INVALID_REDIRECT';
/**
* Got a redirect but it was empty.
*/
public const REDIRECTION_ERROR_EMPTY_REDIRECT = 'EMPTY_REDIRECT';
/**
* Unknown redirect error.
*/
public const REDIRECTION_ERROR_REDIRECT_ERROR_UNKNOWN = 'REDIRECT_ERROR_UNKNOWN';
/**
* Default value that should never be used.
*/
public const URL_REJECTED_URL_REJECTED_UNSPECIFIED = 'URL_REJECTED_UNSPECIFIED';
/**
* URL rejected because of a malformed request.
*/
public const URL_REJECTED_BAD_REQUEST = 'BAD_REQUEST';
/**
* URL rejected because of a malformed URL.
*/
public const URL_REJECTED_MALFORMED_URL = 'MALFORMED_URL';
/**
* URL rejected because of unknown reason.
*/
public const URL_REJECTED_URL_REJECTED_UNKNOWN = 'URL_REJECTED_UNKNOWN';
/**
* DNS lookup errors.
*
* @var string
*/
public $dnsError;
/**
* The full non-working URL.
*
* @var string
*/
public $expandedUrl;
/**
* HTTP error code (for example, 404 or 5xx)
*
* @var int
*/
public $httpError;
/**
* Page was crawled successfully, but was detected as either a page with no
* content or an error page.
*
* @var string
*/
public $invalidPage;
/**
* Approximate time when the ad destination was last checked.
*
* @var string
*/
public $lastCheckTime;
/**
* Platform of the non-working URL.
*
* @var string
*/
public $platform;
/**
* HTTP redirect chain error.
*
* @var string
*/
public $redirectionError;
/**
* Rejected because of malformed URLs or invalid requests.
*
* @var string
*/
public $urlRejected;
/**
* DNS lookup errors.
*
* Accepted values: DNS_ERROR_UNSPECIFIED, ERROR_DNS, GOOGLE_CRAWLER_DNS_ISSUE
*
* @param self::DNS_ERROR_* $dnsError
*/
public function setDnsError($dnsError)
{
$this->dnsError = $dnsError;
}
/**
* @return self::DNS_ERROR_*
*/
public function getDnsError()
{
return $this->dnsError;
}
/**
* The full non-working URL.
*
* @param string $expandedUrl
*/
public function setExpandedUrl($expandedUrl)
{
$this->expandedUrl = $expandedUrl;
}
/**
* @return string
*/
public function getExpandedUrl()
{
return $this->expandedUrl;
}
/**
* HTTP error code (for example, 404 or 5xx)
*
* @param int $httpError
*/
public function setHttpError($httpError)
{
$this->httpError = $httpError;
}
/**
* @return int
*/
public function getHttpError()
{
return $this->httpError;
}
/**
* Page was crawled successfully, but was detected as either a page with no
* content or an error page.
*
* Accepted values: INVALID_PAGE_UNSPECIFIED, EMPTY_OR_ERROR_PAGE
*
* @param self::INVALID_PAGE_* $invalidPage
*/
public function setInvalidPage($invalidPage)
{
$this->invalidPage = $invalidPage;
}
/**
* @return self::INVALID_PAGE_*
*/
public function getInvalidPage()
{
return $this->invalidPage;
}
/**
* Approximate time when the ad destination was last checked.
*
* @param string $lastCheckTime
*/
public function setLastCheckTime($lastCheckTime)
{
$this->lastCheckTime = $lastCheckTime;
}
/**
* @return string
*/
public function getLastCheckTime()
{
return $this->lastCheckTime;
}
/**
* Platform of the non-working URL.
*
* Accepted values: PLATFORM_UNSPECIFIED, PERSONAL_COMPUTER, ANDROID, IOS
*
* @param self::PLATFORM_* $platform
*/
public function setPlatform($platform)
{
$this->platform = $platform;
}
/**
* @return self::PLATFORM_*
*/
public function getPlatform()
{
return $this->platform;
}
/**
* HTTP redirect chain error.
*
* Accepted values: REDIRECTION_ERROR_UNSPECIFIED, TOO_MANY_REDIRECTS,
* INVALID_REDIRECT, EMPTY_REDIRECT, REDIRECT_ERROR_UNKNOWN
*
* @param self::REDIRECTION_ERROR_* $redirectionError
*/
public function setRedirectionError($redirectionError)
{
$this->redirectionError = $redirectionError;
}
/**
* @return self::REDIRECTION_ERROR_*
*/
public function getRedirectionError()
{
return $this->redirectionError;
}
/**
* Rejected because of malformed URLs or invalid requests.
*
* Accepted values: URL_REJECTED_UNSPECIFIED, BAD_REQUEST, MALFORMED_URL,
* URL_REJECTED_UNKNOWN
*
* @param self::URL_REJECTED_* $urlRejected
*/
public function setUrlRejected($urlRejected)
{
$this->urlRejected = $urlRejected;
}
/**
* @return self::URL_REJECTED_*
*/
public function getUrlRejected()
{
return $this->urlRejected;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DestinationNotWorkingEvidence::class, 'Google_Service_RealTimeBidding_DestinationNotWorkingEvidence');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class DestinationUrlEvidence extends \Google\Model
{
/**
* The full landing page URL of the destination.
*
* @var string
*/
public $destinationUrl;
/**
* The full landing page URL of the destination.
*
* @param string $destinationUrl
*/
public function setDestinationUrl($destinationUrl)
{
$this->destinationUrl = $destinationUrl;
}
/**
* @return string
*/
public function getDestinationUrl()
{
return $this->destinationUrl;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DestinationUrlEvidence::class, 'Google_Service_RealTimeBidding_DestinationUrlEvidence');
@@ -0,0 +1,69 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class DomainCallEvidence extends \Google\Collection
{
protected $collection_key = 'topHttpCallDomains';
protected $topHttpCallDomainsType = DomainCalls::class;
protected $topHttpCallDomainsDataType = 'array';
/**
* The total number of HTTP calls made by the creative, including but not
* limited to the number of calls in the top_http_call_domains.
*
* @var int
*/
public $totalHttpCallCount;
/**
* Breakdown of the most frequent domains called through HTTP by the creative.
*
* @param DomainCalls[] $topHttpCallDomains
*/
public function setTopHttpCallDomains($topHttpCallDomains)
{
$this->topHttpCallDomains = $topHttpCallDomains;
}
/**
* @return DomainCalls[]
*/
public function getTopHttpCallDomains()
{
return $this->topHttpCallDomains;
}
/**
* The total number of HTTP calls made by the creative, including but not
* limited to the number of calls in the top_http_call_domains.
*
* @param int $totalHttpCallCount
*/
public function setTotalHttpCallCount($totalHttpCallCount)
{
$this->totalHttpCallCount = $totalHttpCallCount;
}
/**
* @return int
*/
public function getTotalHttpCallCount()
{
return $this->totalHttpCallCount;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DomainCallEvidence::class, 'Google_Service_RealTimeBidding_DomainCallEvidence');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class DomainCalls extends \Google\Model
{
/**
* The domain name.
*
* @var string
*/
public $domain;
/**
* Number of HTTP calls made to the domain.
*
* @var int
*/
public $httpCallCount;
/**
* The domain name.
*
* @param string $domain
*/
public function setDomain($domain)
{
$this->domain = $domain;
}
/**
* @return string
*/
public function getDomain()
{
return $this->domain;
}
/**
* Number of HTTP calls made to the domain.
*
* @param int $httpCallCount
*/
public function setHttpCallCount($httpCallCount)
{
$this->httpCallCount = $httpCallCount;
}
/**
* @return int
*/
public function getHttpCallCount()
{
return $this->httpCallCount;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DomainCalls::class, 'Google_Service_RealTimeBidding_DomainCalls');
@@ -0,0 +1,67 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class DownloadSizeEvidence extends \Google\Collection
{
protected $collection_key = 'topUrlDownloadSizeBreakdowns';
protected $topUrlDownloadSizeBreakdownsType = UrlDownloadSize::class;
protected $topUrlDownloadSizeBreakdownsDataType = 'array';
/**
* Total download size (in kilobytes) for all the resources in the creative.
*
* @var int
*/
public $totalDownloadSizeKb;
/**
* Download size broken down by URLs with the top download size.
*
* @param UrlDownloadSize[] $topUrlDownloadSizeBreakdowns
*/
public function setTopUrlDownloadSizeBreakdowns($topUrlDownloadSizeBreakdowns)
{
$this->topUrlDownloadSizeBreakdowns = $topUrlDownloadSizeBreakdowns;
}
/**
* @return UrlDownloadSize[]
*/
public function getTopUrlDownloadSizeBreakdowns()
{
return $this->topUrlDownloadSizeBreakdowns;
}
/**
* Total download size (in kilobytes) for all the resources in the creative.
*
* @param int $totalDownloadSizeKb
*/
public function setTotalDownloadSizeKb($totalDownloadSizeKb)
{
$this->totalDownloadSizeKb = $totalDownloadSizeKb;
}
/**
* @return int
*/
public function getTotalDownloadSizeKb()
{
return $this->totalDownloadSizeKb;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DownloadSizeEvidence::class, 'Google_Service_RealTimeBidding_DownloadSizeEvidence');
@@ -0,0 +1,191 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class Endpoint extends \Google\Model
{
/**
* Placeholder for undefined bid protocol. This value should not be used.
*/
public const BID_PROTOCOL_BID_PROTOCOL_UNSPECIFIED = 'BID_PROTOCOL_UNSPECIFIED';
/**
* Google RTB protocol / Protobuf encoding.
*
* @deprecated
*/
public const BID_PROTOCOL_GOOGLE_RTB = 'GOOGLE_RTB';
/**
* OpenRTB / JSON encoding (unversioned/latest).
*/
public const BID_PROTOCOL_OPENRTB_JSON = 'OPENRTB_JSON';
/**
* OpenRTB / Protobuf encoding (unversioned/latest).
*/
public const BID_PROTOCOL_OPENRTB_PROTOBUF = 'OPENRTB_PROTOBUF';
/**
* A placeholder for an undefined trading region. This value should not be
* used.
*/
public const TRADING_LOCATION_TRADING_LOCATION_UNSPECIFIED = 'TRADING_LOCATION_UNSPECIFIED';
/**
* The Western US trading location.
*/
public const TRADING_LOCATION_US_WEST = 'US_WEST';
/**
* The Eastern US trading location.
*/
public const TRADING_LOCATION_US_EAST = 'US_EAST';
/**
* The European trading location.
*/
public const TRADING_LOCATION_EUROPE = 'EUROPE';
/**
* The Asia trading location.
*/
public const TRADING_LOCATION_ASIA = 'ASIA';
/**
* The protocol that the bidder endpoint is using.
*
* @var string
*/
public $bidProtocol;
/**
* The maximum number of queries per second allowed to be sent to this server.
*
* @var string
*/
public $maximumQps;
/**
* Output only. Name of the endpoint resource that must follow the pattern
* `bidders/{bidderAccountId}/endpoints/{endpointId}`, where {bidderAccountId}
* is the account ID of the bidder who operates this endpoint, and
* {endpointId} is a unique ID assigned by the server.
*
* @var string
*/
public $name;
/**
* The trading location that bid requests should be sent from. See
* https://developers.google.com/authorized-buyers/rtb/peer-guide#trading-
* locations for further information.
*
* @var string
*/
public $tradingLocation;
/**
* Output only. The URL that bid requests should be sent to.
*
* @var string
*/
public $url;
/**
* The protocol that the bidder endpoint is using.
*
* Accepted values: BID_PROTOCOL_UNSPECIFIED, GOOGLE_RTB, OPENRTB_JSON,
* OPENRTB_PROTOBUF
*
* @param self::BID_PROTOCOL_* $bidProtocol
*/
public function setBidProtocol($bidProtocol)
{
$this->bidProtocol = $bidProtocol;
}
/**
* @return self::BID_PROTOCOL_*
*/
public function getBidProtocol()
{
return $this->bidProtocol;
}
/**
* The maximum number of queries per second allowed to be sent to this server.
*
* @param string $maximumQps
*/
public function setMaximumQps($maximumQps)
{
$this->maximumQps = $maximumQps;
}
/**
* @return string
*/
public function getMaximumQps()
{
return $this->maximumQps;
}
/**
* Output only. Name of the endpoint resource that must follow the pattern
* `bidders/{bidderAccountId}/endpoints/{endpointId}`, where {bidderAccountId}
* is the account ID of the bidder who operates this endpoint, and
* {endpointId} is a unique ID assigned by the server.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The trading location that bid requests should be sent from. See
* https://developers.google.com/authorized-buyers/rtb/peer-guide#trading-
* locations for further information.
*
* Accepted values: TRADING_LOCATION_UNSPECIFIED, US_WEST, US_EAST, EUROPE,
* ASIA
*
* @param self::TRADING_LOCATION_* $tradingLocation
*/
public function setTradingLocation($tradingLocation)
{
$this->tradingLocation = $tradingLocation;
}
/**
* @return self::TRADING_LOCATION_*
*/
public function getTradingLocation()
{
return $this->tradingLocation;
}
/**
* Output only. The URL that bid requests should be sent to.
*
* @param string $url
*/
public function setUrl($url)
{
$this->url = $url;
}
/**
* @return string
*/
public function getUrl()
{
return $this->url;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Endpoint::class, 'Google_Service_RealTimeBidding_Endpoint');
@@ -0,0 +1,54 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class GetRemarketingTagResponse extends \Google\Model
{
/**
* An HTML tag that can be placed on the advertiser's page to add users to a
* user list. For more information and code samples on using snippets on your
* website, refer to [Tag your site for
* remarketing](https://support.google.com/google-ads/answer/2476688).
*
* @var string
*/
public $snippet;
/**
* An HTML tag that can be placed on the advertiser's page to add users to a
* user list. For more information and code samples on using snippets on your
* website, refer to [Tag your site for
* remarketing](https://support.google.com/google-ads/answer/2476688).
*
* @param string $snippet
*/
public function setSnippet($snippet)
{
$this->snippet = $snippet;
}
/**
* @return string
*/
public function getSnippet()
{
return $this->snippet;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GetRemarketingTagResponse::class, 'Google_Service_RealTimeBidding_GetRemarketingTagResponse');
@@ -0,0 +1,96 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class HtmlContent extends \Google\Model
{
/**
* The height of the HTML snippet in pixels. Can be used to filter the
* response of the creatives.list method.
*
* @var int
*/
public $height;
/**
* The HTML snippet that displays the ad when inserted in the web page.
*
* @var string
*/
public $snippet;
/**
* The width of the HTML snippet in pixels. Can be used to filter the response
* of the creatives.list method.
*
* @var int
*/
public $width;
/**
* The height of the HTML snippet in pixels. Can be used to filter the
* response of the creatives.list method.
*
* @param int $height
*/
public function setHeight($height)
{
$this->height = $height;
}
/**
* @return int
*/
public function getHeight()
{
return $this->height;
}
/**
* The HTML snippet that displays the ad when inserted in the web page.
*
* @param string $snippet
*/
public function setSnippet($snippet)
{
$this->snippet = $snippet;
}
/**
* @return string
*/
public function getSnippet()
{
return $this->snippet;
}
/**
* The width of the HTML snippet in pixels. Can be used to filter the response
* of the creatives.list method.
*
* @param int $width
*/
public function setWidth($width)
{
$this->width = $width;
}
/**
* @return int
*/
public function getWidth()
{
return $this->width;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(HtmlContent::class, 'Google_Service_RealTimeBidding_HtmlContent');
@@ -0,0 +1,49 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class HttpCallEvidence extends \Google\Collection
{
protected $collection_key = 'urls';
/**
* URLs of HTTP calls made by the creative.
*
* @var string[]
*/
public $urls;
/**
* URLs of HTTP calls made by the creative.
*
* @param string[] $urls
*/
public function setUrls($urls)
{
$this->urls = $urls;
}
/**
* @return string[]
*/
public function getUrls()
{
return $this->urls;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(HttpCallEvidence::class, 'Google_Service_RealTimeBidding_HttpCallEvidence');
@@ -0,0 +1,83 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class HttpCookieEvidence extends \Google\Collection
{
protected $collection_key = 'cookieNames';
/**
* Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy,
* this will be the cookie names of top domains with the largest number of
* cookies. For other policies, this will be all the cookie names that violate
* the policy.
*
* @var string[]
*/
public $cookieNames;
/**
* The largest number of cookies set by a creative. If this field is set,
* cookie_names above will be set to the cookie names of top domains with the
* largest number of cookies. This field will only be set for TOO_MANY_COOKIES
* policy.
*
* @var int
*/
public $maxCookieCount;
/**
* Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy,
* this will be the cookie names of top domains with the largest number of
* cookies. For other policies, this will be all the cookie names that violate
* the policy.
*
* @param string[] $cookieNames
*/
public function setCookieNames($cookieNames)
{
$this->cookieNames = $cookieNames;
}
/**
* @return string[]
*/
public function getCookieNames()
{
return $this->cookieNames;
}
/**
* The largest number of cookies set by a creative. If this field is set,
* cookie_names above will be set to the cookie names of top domains with the
* largest number of cookies. This field will only be set for TOO_MANY_COOKIES
* policy.
*
* @param int $maxCookieCount
*/
public function setMaxCookieCount($maxCookieCount)
{
$this->maxCookieCount = $maxCookieCount;
}
/**
* @return int
*/
public function getMaxCookieCount()
{
return $this->maxCookieCount;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(HttpCookieEvidence::class, 'Google_Service_RealTimeBidding_HttpCookieEvidence');
@@ -0,0 +1,92 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class Image extends \Google\Model
{
/**
* Image height in pixels.
*
* @var int
*/
public $height;
/**
* The URL of the image.
*
* @var string
*/
public $url;
/**
* Image width in pixels.
*
* @var int
*/
public $width;
/**
* Image height in pixels.
*
* @param int $height
*/
public function setHeight($height)
{
$this->height = $height;
}
/**
* @return int
*/
public function getHeight()
{
return $this->height;
}
/**
* The URL of the image.
*
* @param string $url
*/
public function setUrl($url)
{
$this->url = $url;
}
/**
* @return string
*/
public function getUrl()
{
return $this->url;
}
/**
* Image width in pixels.
*
* @param int $width
*/
public function setWidth($width)
{
$this->width = $width;
}
/**
* @return int
*/
public function getWidth()
{
return $this->width;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Image::class, 'Google_Service_RealTimeBidding_Image');
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class ListBiddersResponse extends \Google\Collection
{
protected $collection_key = 'bidders';
protected $biddersType = Bidder::class;
protected $biddersDataType = 'array';
/**
* A token which can be passed to a subsequent call to the `ListBidders`
* method to retrieve the next page of results in
* ListBiddersRequest.pageToken.
*
* @var string
*/
public $nextPageToken;
/**
* List of bidders.
*
* @param Bidder[] $bidders
*/
public function setBidders($bidders)
{
$this->bidders = $bidders;
}
/**
* @return Bidder[]
*/
public function getBidders()
{
return $this->bidders;
}
/**
* A token which can be passed to a subsequent call to the `ListBidders`
* method to retrieve the next page of results in
* ListBiddersRequest.pageToken.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListBiddersResponse::class, 'Google_Service_RealTimeBidding_ListBiddersResponse');
@@ -0,0 +1,69 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class ListBuyersResponse extends \Google\Collection
{
protected $collection_key = 'buyers';
protected $buyersType = Buyer::class;
protected $buyersDataType = 'array';
/**
* A token which can be passed to a subsequent call to the `ListBuyers` method
* to retrieve the next page of results in ListBuyersRequest.pageToken.
*
* @var string
*/
public $nextPageToken;
/**
* List of buyers.
*
* @param Buyer[] $buyers
*/
public function setBuyers($buyers)
{
$this->buyers = $buyers;
}
/**
* @return Buyer[]
*/
public function getBuyers()
{
return $this->buyers;
}
/**
* A token which can be passed to a subsequent call to the `ListBuyers` method
* to retrieve the next page of results in ListBuyersRequest.pageToken.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListBuyersResponse::class, 'Google_Service_RealTimeBidding_ListBuyersResponse');
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class ListCreativesResponse extends \Google\Collection
{
protected $collection_key = 'creatives';
protected $creativesType = Creative::class;
protected $creativesDataType = 'array';
/**
* A token to retrieve the next page of results. Pass this value in the
* ListCreativesRequest.pageToken field in the subsequent call to the
* `ListCreatives` method to retrieve the next page of results.
*
* @var string
*/
public $nextPageToken;
/**
* The list of creatives.
*
* @param Creative[] $creatives
*/
public function setCreatives($creatives)
{
$this->creatives = $creatives;
}
/**
* @return Creative[]
*/
public function getCreatives()
{
return $this->creatives;
}
/**
* A token to retrieve the next page of results. Pass this value in the
* ListCreativesRequest.pageToken field in the subsequent call to the
* `ListCreatives` method to retrieve the next page of results.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListCreativesResponse::class, 'Google_Service_RealTimeBidding_ListCreativesResponse');
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class ListEndpointsResponse extends \Google\Collection
{
protected $collection_key = 'endpoints';
protected $endpointsType = Endpoint::class;
protected $endpointsDataType = 'array';
/**
* A token which can be passed to a subsequent call to the `ListEndpoints`
* method to retrieve the next page of results in
* ListEndpointsRequest.pageToken.
*
* @var string
*/
public $nextPageToken;
/**
* List of bidder endpoints.
*
* @param Endpoint[] $endpoints
*/
public function setEndpoints($endpoints)
{
$this->endpoints = $endpoints;
}
/**
* @return Endpoint[]
*/
public function getEndpoints()
{
return $this->endpoints;
}
/**
* A token which can be passed to a subsequent call to the `ListEndpoints`
* method to retrieve the next page of results in
* ListEndpointsRequest.pageToken.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListEndpointsResponse::class, 'Google_Service_RealTimeBidding_ListEndpointsResponse');
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class ListPretargetingConfigsResponse extends \Google\Collection
{
protected $collection_key = 'pretargetingConfigs';
/**
* A token which can be passed to a subsequent call to the
* `ListPretargetingConfigs` method to retrieve the next page of results in
* ListPretargetingConfigsRequest.pageToken.
*
* @var string
*/
public $nextPageToken;
protected $pretargetingConfigsType = PretargetingConfig::class;
protected $pretargetingConfigsDataType = 'array';
/**
* A token which can be passed to a subsequent call to the
* `ListPretargetingConfigs` method to retrieve the next page of results in
* ListPretargetingConfigsRequest.pageToken.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* List of pretargeting configurations.
*
* @param PretargetingConfig[] $pretargetingConfigs
*/
public function setPretargetingConfigs($pretargetingConfigs)
{
$this->pretargetingConfigs = $pretargetingConfigs;
}
/**
* @return PretargetingConfig[]
*/
public function getPretargetingConfigs()
{
return $this->pretargetingConfigs;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListPretargetingConfigsResponse::class, 'Google_Service_RealTimeBidding_ListPretargetingConfigsResponse');
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class ListPublisherConnectionsResponse extends \Google\Collection
{
protected $collection_key = 'publisherConnections';
/**
* A token to retrieve the next page of results. Pass this value in the
* ListPublisherConnectionsRequest.pageToken field in the subsequent call to
* the `ListPublisherConnections` method to retrieve the next page of results.
*
* @var string
*/
public $nextPageToken;
protected $publisherConnectionsType = PublisherConnection::class;
protected $publisherConnectionsDataType = 'array';
/**
* A token to retrieve the next page of results. Pass this value in the
* ListPublisherConnectionsRequest.pageToken field in the subsequent call to
* the `ListPublisherConnections` method to retrieve the next page of results.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* The list of publisher connections.
*
* @param PublisherConnection[] $publisherConnections
*/
public function setPublisherConnections($publisherConnections)
{
$this->publisherConnections = $publisherConnections;
}
/**
* @return PublisherConnection[]
*/
public function getPublisherConnections()
{
return $this->publisherConnections;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListPublisherConnectionsResponse::class, 'Google_Service_RealTimeBidding_ListPublisherConnectionsResponse');
@@ -0,0 +1,73 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class ListUserListsResponse extends \Google\Collection
{
protected $collection_key = 'userLists';
/**
* The continuation page token to send back to the server in a subsequent
* request. Due to a currently known issue, it is recommended that the caller
* keep invoking the list method until the time a next page token is not
* returned, even if the result set is empty.
*
* @var string
*/
public $nextPageToken;
protected $userListsType = UserList::class;
protected $userListsDataType = 'array';
/**
* The continuation page token to send back to the server in a subsequent
* request. Due to a currently known issue, it is recommended that the caller
* keep invoking the list method until the time a next page token is not
* returned, even if the result set is empty.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* List of user lists from the search.
*
* @param UserList[] $userLists
*/
public function setUserLists($userLists)
{
$this->userLists = $userLists;
}
/**
* @return UserList[]
*/
public function getUserLists()
{
return $this->userLists;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListUserListsResponse::class, 'Google_Service_RealTimeBidding_ListUserListsResponse');
@@ -0,0 +1,153 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class MediaFile extends \Google\Model
{
/**
* Default value that should never be used.
*/
public const MIME_TYPE_VIDEO_MIME_TYPE_UNSPECIFIED = 'VIDEO_MIME_TYPE_UNSPECIFIED';
/**
* Flash container.
*/
public const MIME_TYPE_MIME_VIDEO_XFLV = 'MIME_VIDEO_XFLV';
/**
* WebM container assuming VP9 codec.
*/
public const MIME_TYPE_MIME_VIDEO_WEBM = 'MIME_VIDEO_WEBM';
/**
* MPEG-4 container typically with H.264 codec.
*/
public const MIME_TYPE_MIME_VIDEO_MP4 = 'MIME_VIDEO_MP4';
/**
* Ogg container assuming Theora codec.
*/
public const MIME_TYPE_MIME_VIDEO_OGG = 'MIME_VIDEO_OGG';
/**
* Video files hosted on YouTube.
*/
public const MIME_TYPE_MIME_VIDEO_YT_HOSTED = 'MIME_VIDEO_YT_HOSTED';
/**
* Windows Media Video Codec.
*/
public const MIME_TYPE_MIME_VIDEO_X_MS_WMV = 'MIME_VIDEO_X_MS_WMV';
/**
* 3GPP container format used on 3G phones.
*/
public const MIME_TYPE_MIME_VIDEO_3GPP = 'MIME_VIDEO_3GPP';
/**
* Quicktime container format.
*/
public const MIME_TYPE_MIME_VIDEO_MOV = 'MIME_VIDEO_MOV';
/**
* Shockwave Flash (used for VPAID ads).
*/
public const MIME_TYPE_MIME_APPLICATION_SWF = 'MIME_APPLICATION_SWF';
/**
* Properties of VAST served by consumer survey.
*/
public const MIME_TYPE_MIME_APPLICATION_SURVEY = 'MIME_APPLICATION_SURVEY';
/**
* JavaScript (used for VPAID ads).
*/
public const MIME_TYPE_MIME_APPLICATION_JAVASCRIPT = 'MIME_APPLICATION_JAVASCRIPT';
/**
* Silverlight (used for VPAID ads).
*/
public const MIME_TYPE_MIME_APPLICATION_SILVERLIGHT = 'MIME_APPLICATION_SILVERLIGHT';
/**
* HLS/M3U8.
*/
public const MIME_TYPE_MIME_APPLICATION_MPEGURL = 'MIME_APPLICATION_MPEGURL';
/**
* DASH.
*/
public const MIME_TYPE_MIME_APPLICATION_MPEGDASH = 'MIME_APPLICATION_MPEGDASH';
/**
* MPEG-4 audio format.
*/
public const MIME_TYPE_MIME_AUDIO_MP4A = 'MIME_AUDIO_MP4A';
/**
* MPEG-3 audio format.
*/
public const MIME_TYPE_MIME_AUDIO_MP3 = 'MIME_AUDIO_MP3';
/**
* Ogg audio format
*/
public const MIME_TYPE_MIME_AUDIO_OGG = 'MIME_AUDIO_OGG';
/**
* Bitrate of the video file, in Kbps. Can be used to filter the response of
* the creatives.list method.
*
* @var string
*/
public $bitrate;
/**
* The MIME type of this media file. Can be used to filter the response of the
* creatives.list method.
*
* @var string
*/
public $mimeType;
/**
* Bitrate of the video file, in Kbps. Can be used to filter the response of
* the creatives.list method.
*
* @param string $bitrate
*/
public function setBitrate($bitrate)
{
$this->bitrate = $bitrate;
}
/**
* @return string
*/
public function getBitrate()
{
return $this->bitrate;
}
/**
* The MIME type of this media file. Can be used to filter the response of the
* creatives.list method.
*
* Accepted values: VIDEO_MIME_TYPE_UNSPECIFIED, MIME_VIDEO_XFLV,
* MIME_VIDEO_WEBM, MIME_VIDEO_MP4, MIME_VIDEO_OGG, MIME_VIDEO_YT_HOSTED,
* MIME_VIDEO_X_MS_WMV, MIME_VIDEO_3GPP, MIME_VIDEO_MOV, MIME_APPLICATION_SWF,
* MIME_APPLICATION_SURVEY, MIME_APPLICATION_JAVASCRIPT,
* MIME_APPLICATION_SILVERLIGHT, MIME_APPLICATION_MPEGURL,
* MIME_APPLICATION_MPEGDASH, MIME_AUDIO_MP4A, MIME_AUDIO_MP3, MIME_AUDIO_OGG
*
* @param self::MIME_TYPE_* $mimeType
*/
public function setMimeType($mimeType)
{
$this->mimeType = $mimeType;
}
/**
* @return self::MIME_TYPE_*
*/
public function getMimeType()
{
return $this->mimeType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MediaFile::class, 'Google_Service_RealTimeBidding_MediaFile');
@@ -0,0 +1,292 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class NativeContent extends \Google\Model
{
/**
* The name of the advertiser or sponsor, to be displayed in the ad creative.
*
* @var string
*/
public $advertiserName;
protected $appIconType = Image::class;
protected $appIconDataType = '';
/**
* A long description of the ad.
*
* @var string
*/
public $body;
/**
* A label for the button that the user is supposed to click.
*
* @var string
*/
public $callToAction;
/**
* The URL that the browser/SDK will load when the user clicks the ad.
*
* @var string
*/
public $clickLinkUrl;
/**
* The URL to use for click tracking.
*
* @var string
*/
public $clickTrackingUrl;
/**
* A short title for the ad.
*
* @var string
*/
public $headline;
protected $imageType = Image::class;
protected $imageDataType = '';
protected $logoType = Image::class;
protected $logoDataType = '';
/**
* The price of the promoted app including currency info.
*
* @var string
*/
public $priceDisplayText;
/**
* The app rating in the app store. Must be in the range [0-5].
*
* @var
*/
public $starRating;
/**
* The URL to fetch a native video ad.
*
* @var string
*/
public $videoUrl;
/**
* The contents of a VAST document for a native video ad.
*
* @var string
*/
public $videoVastXml;
/**
* The name of the advertiser or sponsor, to be displayed in the ad creative.
*
* @param string $advertiserName
*/
public function setAdvertiserName($advertiserName)
{
$this->advertiserName = $advertiserName;
}
/**
* @return string
*/
public function getAdvertiserName()
{
return $this->advertiserName;
}
/**
* The app icon, for app download ads.
*
* @param Image $appIcon
*/
public function setAppIcon(Image $appIcon)
{
$this->appIcon = $appIcon;
}
/**
* @return Image
*/
public function getAppIcon()
{
return $this->appIcon;
}
/**
* A long description of the ad.
*
* @param string $body
*/
public function setBody($body)
{
$this->body = $body;
}
/**
* @return string
*/
public function getBody()
{
return $this->body;
}
/**
* A label for the button that the user is supposed to click.
*
* @param string $callToAction
*/
public function setCallToAction($callToAction)
{
$this->callToAction = $callToAction;
}
/**
* @return string
*/
public function getCallToAction()
{
return $this->callToAction;
}
/**
* The URL that the browser/SDK will load when the user clicks the ad.
*
* @param string $clickLinkUrl
*/
public function setClickLinkUrl($clickLinkUrl)
{
$this->clickLinkUrl = $clickLinkUrl;
}
/**
* @return string
*/
public function getClickLinkUrl()
{
return $this->clickLinkUrl;
}
/**
* The URL to use for click tracking.
*
* @param string $clickTrackingUrl
*/
public function setClickTrackingUrl($clickTrackingUrl)
{
$this->clickTrackingUrl = $clickTrackingUrl;
}
/**
* @return string
*/
public function getClickTrackingUrl()
{
return $this->clickTrackingUrl;
}
/**
* A short title for the ad.
*
* @param string $headline
*/
public function setHeadline($headline)
{
$this->headline = $headline;
}
/**
* @return string
*/
public function getHeadline()
{
return $this->headline;
}
/**
* A large image.
*
* @param Image $image
*/
public function setImage(Image $image)
{
$this->image = $image;
}
/**
* @return Image
*/
public function getImage()
{
return $this->image;
}
/**
* A smaller image, for the advertiser's logo.
*
* @param Image $logo
*/
public function setLogo(Image $logo)
{
$this->logo = $logo;
}
/**
* @return Image
*/
public function getLogo()
{
return $this->logo;
}
/**
* The price of the promoted app including currency info.
*
* @param string $priceDisplayText
*/
public function setPriceDisplayText($priceDisplayText)
{
$this->priceDisplayText = $priceDisplayText;
}
/**
* @return string
*/
public function getPriceDisplayText()
{
return $this->priceDisplayText;
}
public function setStarRating($starRating)
{
$this->starRating = $starRating;
}
public function getStarRating()
{
return $this->starRating;
}
/**
* The URL to fetch a native video ad.
*
* @param string $videoUrl
*/
public function setVideoUrl($videoUrl)
{
$this->videoUrl = $videoUrl;
}
/**
* @return string
*/
public function getVideoUrl()
{
return $this->videoUrl;
}
/**
* The contents of a VAST document for a native video ad.
*
* @param string $videoVastXml
*/
public function setVideoVastXml($videoVastXml)
{
$this->videoVastXml = $videoVastXml;
}
/**
* @return string
*/
public function getVideoVastXml()
{
return $this->videoVastXml;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NativeContent::class, 'Google_Service_RealTimeBidding_NativeContent');
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class NumericTargetingDimension extends \Google\Collection
{
protected $collection_key = 'includedIds';
/**
* The IDs excluded in a config.
*
* @var string[]
*/
public $excludedIds;
/**
* The IDs included in a config.
*
* @var string[]
*/
public $includedIds;
/**
* The IDs excluded in a config.
*
* @param string[] $excludedIds
*/
public function setExcludedIds($excludedIds)
{
$this->excludedIds = $excludedIds;
}
/**
* @return string[]
*/
public function getExcludedIds()
{
return $this->excludedIds;
}
/**
* The IDs included in a config.
*
* @param string[] $includedIds
*/
public function setIncludedIds($includedIds)
{
$this->includedIds = $includedIds;
}
/**
* @return string[]
*/
public function getIncludedIds()
{
return $this->includedIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NumericTargetingDimension::class, 'Google_Service_RealTimeBidding_NumericTargetingDimension');
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class OpenUserListRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(OpenUserListRequest::class, 'Google_Service_RealTimeBidding_OpenUserListRequest');
@@ -0,0 +1,98 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class PolicyCompliance extends \Google\Collection
{
/**
* Default value that should never be used.
*/
public const STATUS_STATUS_UNSPECIFIED = 'STATUS_UNSPECIFIED';
/**
* Creative is pending review.
*/
public const STATUS_PENDING_REVIEW = 'PENDING_REVIEW';
/**
* Creative cannot serve.
*/
public const STATUS_DISAPPROVED = 'DISAPPROVED';
/**
* Creative is approved.
*/
public const STATUS_APPROVED = 'APPROVED';
/**
* Certificates are required for the creative to be served in some regions.
* For more information about creative certification, refer to:
* https://support.google.com/authorizedbuyers/answer/7450776
*/
public const STATUS_CERTIFICATE_REQUIRED = 'CERTIFICATE_REQUIRED';
protected $collection_key = 'topics';
/**
* Serving status for the given transaction type (for example, open auction,
* deals) or region (for example, China, Russia). Can be used to filter the
* response of the creatives.list method.
*
* @var string
*/
public $status;
protected $topicsType = PolicyTopicEntry::class;
protected $topicsDataType = 'array';
/**
* Serving status for the given transaction type (for example, open auction,
* deals) or region (for example, China, Russia). Can be used to filter the
* response of the creatives.list method.
*
* Accepted values: STATUS_UNSPECIFIED, PENDING_REVIEW, DISAPPROVED, APPROVED,
* CERTIFICATE_REQUIRED
*
* @param self::STATUS_* $status
*/
public function setStatus($status)
{
$this->status = $status;
}
/**
* @return self::STATUS_*
*/
public function getStatus()
{
return $this->status;
}
/**
* Topics related to the policy compliance for this transaction type (for
* example, open auction, deals) or region (for example, China, Russia).
* Topics may be present only if status is DISAPPROVED.
*
* @param PolicyTopicEntry[] $topics
*/
public function setTopics($topics)
{
$this->topics = $topics;
}
/**
* @return PolicyTopicEntry[]
*/
public function getTopics()
{
return $this->topics;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PolicyCompliance::class, 'Google_Service_RealTimeBidding_PolicyCompliance');
@@ -0,0 +1,123 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class PolicyTopicEntry extends \Google\Collection
{
protected $collection_key = 'evidences';
protected $evidencesType = PolicyTopicEvidence::class;
protected $evidencesDataType = 'array';
/**
* URL of the help center article describing this policy topic.
*
* @var string
*/
public $helpCenterUrl;
/**
* Whether or not the policy topic is missing a certificate. Some policy
* topics require a certificate to unblock serving in some regions. For more
* information about creative certification, refer to:
* https://support.google.com/authorizedbuyers/answer/7450776
*
* @var bool
*/
public $missingCertificate;
/**
* Policy topic this entry refers to. For example, "ALCOHOL",
* "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible
* policy topics is not fixed for a particular API version and may change at
* any time. Can be used to filter the response of the creatives.list method
*
* @var string
*/
public $policyTopic;
/**
* Pieces of evidence associated with this policy topic entry.
*
* @param PolicyTopicEvidence[] $evidences
*/
public function setEvidences($evidences)
{
$this->evidences = $evidences;
}
/**
* @return PolicyTopicEvidence[]
*/
public function getEvidences()
{
return $this->evidences;
}
/**
* URL of the help center article describing this policy topic.
*
* @param string $helpCenterUrl
*/
public function setHelpCenterUrl($helpCenterUrl)
{
$this->helpCenterUrl = $helpCenterUrl;
}
/**
* @return string
*/
public function getHelpCenterUrl()
{
return $this->helpCenterUrl;
}
/**
* Whether or not the policy topic is missing a certificate. Some policy
* topics require a certificate to unblock serving in some regions. For more
* information about creative certification, refer to:
* https://support.google.com/authorizedbuyers/answer/7450776
*
* @param bool $missingCertificate
*/
public function setMissingCertificate($missingCertificate)
{
$this->missingCertificate = $missingCertificate;
}
/**
* @return bool
*/
public function getMissingCertificate()
{
return $this->missingCertificate;
}
/**
* Policy topic this entry refers to. For example, "ALCOHOL",
* "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible
* policy topics is not fixed for a particular API version and may change at
* any time. Can be used to filter the response of the creatives.list method
*
* @param string $policyTopic
*/
public function setPolicyTopic($policyTopic)
{
$this->policyTopic = $policyTopic;
}
/**
* @return string
*/
public function getPolicyTopic()
{
return $this->policyTopic;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PolicyTopicEntry::class, 'Google_Service_RealTimeBidding_PolicyTopicEntry');
@@ -0,0 +1,154 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class PolicyTopicEvidence extends \Google\Model
{
protected $destinationNotCrawlableType = DestinationNotCrawlableEvidence::class;
protected $destinationNotCrawlableDataType = '';
protected $destinationNotWorkingType = DestinationNotWorkingEvidence::class;
protected $destinationNotWorkingDataType = '';
protected $destinationUrlType = DestinationUrlEvidence::class;
protected $destinationUrlDataType = '';
protected $domainCallType = DomainCallEvidence::class;
protected $domainCallDataType = '';
protected $downloadSizeType = DownloadSizeEvidence::class;
protected $downloadSizeDataType = '';
protected $httpCallType = HttpCallEvidence::class;
protected $httpCallDataType = '';
protected $httpCookieType = HttpCookieEvidence::class;
protected $httpCookieDataType = '';
/**
* The creative's destination URL was not crawlable by Google.
*
* @param DestinationNotCrawlableEvidence $destinationNotCrawlable
*/
public function setDestinationNotCrawlable(DestinationNotCrawlableEvidence $destinationNotCrawlable)
{
$this->destinationNotCrawlable = $destinationNotCrawlable;
}
/**
* @return DestinationNotCrawlableEvidence
*/
public function getDestinationNotCrawlable()
{
return $this->destinationNotCrawlable;
}
/**
* The creative's destination URL did not function properly or was incorrectly
* set up.
*
* @param DestinationNotWorkingEvidence $destinationNotWorking
*/
public function setDestinationNotWorking(DestinationNotWorkingEvidence $destinationNotWorking)
{
$this->destinationNotWorking = $destinationNotWorking;
}
/**
* @return DestinationNotWorkingEvidence
*/
public function getDestinationNotWorking()
{
return $this->destinationNotWorking;
}
/**
* URL of the actual landing page.
*
* @param DestinationUrlEvidence $destinationUrl
*/
public function setDestinationUrl(DestinationUrlEvidence $destinationUrl)
{
$this->destinationUrl = $destinationUrl;
}
/**
* @return DestinationUrlEvidence
*/
public function getDestinationUrl()
{
return $this->destinationUrl;
}
/**
* Number of HTTP calls made by the creative, broken down by domain.
*
* @param DomainCallEvidence $domainCall
*/
public function setDomainCall(DomainCallEvidence $domainCall)
{
$this->domainCall = $domainCall;
}
/**
* @return DomainCallEvidence
*/
public function getDomainCall()
{
return $this->domainCall;
}
/**
* Total download size and URL-level download size breakdown for resources in
* a creative.
*
* @param DownloadSizeEvidence $downloadSize
*/
public function setDownloadSize(DownloadSizeEvidence $downloadSize)
{
$this->downloadSize = $downloadSize;
}
/**
* @return DownloadSizeEvidence
*/
public function getDownloadSize()
{
return $this->downloadSize;
}
/**
* HTTP calls made by the creative that resulted in policy violations.
*
* @param HttpCallEvidence $httpCall
*/
public function setHttpCall(HttpCallEvidence $httpCall)
{
$this->httpCall = $httpCall;
}
/**
* @return HttpCallEvidence
*/
public function getHttpCall()
{
return $this->httpCall;
}
/**
* Evidence for HTTP cookie-related policy violations.
*
* @param HttpCookieEvidence $httpCookie
*/
public function setHttpCookie(HttpCookieEvidence $httpCookie)
{
$this->httpCookie = $httpCookie;
}
/**
* @return HttpCookieEvidence
*/
public function getHttpCookie()
{
return $this->httpCookie;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PolicyTopicEvidence::class, 'Google_Service_RealTimeBidding_PolicyTopicEvidence');
@@ -0,0 +1,630 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class PretargetingConfig extends \Google\Collection
{
/**
* Unspecified interstitial targeting. Represents an interstitial-agnostic
* selection.
*/
public const INTERSTITIAL_TARGETING_INTERSTITIAL_TARGETING_UNSPECIFIED = 'INTERSTITIAL_TARGETING_UNSPECIFIED';
/**
* Only bid requests for interstitial inventory should be sent.
*/
public const INTERSTITIAL_TARGETING_ONLY_INTERSTITIAL_REQUESTS = 'ONLY_INTERSTITIAL_REQUESTS';
/**
* Only bid requests for non-interstitial inventory should be sent.
*/
public const INTERSTITIAL_TARGETING_ONLY_NON_INTERSTITIAL_REQUESTS = 'ONLY_NON_INTERSTITIAL_REQUESTS';
/**
* Placeholder for undefined state.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* This pretargeting config is actively being used to filter bid requests.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* This pretargeting config is suspended and not used in serving.
*/
public const STATE_SUSPENDED = 'SUSPENDED';
protected $collection_key = 'invalidGeoIds';
/**
* Targeting modes included by this config. A bid request must allow all the
* specified targeting modes. An unset value allows all bid requests to be
* sent, regardless of which targeting modes they allow.
*
* @var string[]
*/
public $allowedUserTargetingModes;
protected $appTargetingType = AppTargeting::class;
protected $appTargetingDataType = '';
/**
* Output only. The identifier that corresponds to this pretargeting config
* that helps buyers track and attribute their spend across their own
* arbitrary divisions. If a bid request matches more than one config, the
* buyer chooses which billing_id to attribute each of their bids.
*
* @var string
*/
public $billingId;
/**
* The diplay name associated with this config. This name must be unique among
* all the pretargeting configs a bidder has.
*
* @var string
*/
public $displayName;
/**
* The sensitive content category label IDs excluded in this config. Bid
* requests for inventory with any of the specified content label IDs will not
* be sent. Refer to this file https://storage.googleapis.com/adx-rtb-
* dictionaries/content-labels.txt for category IDs.
*
* @var string[]
*/
public $excludedContentLabelIds;
protected $geoTargetingType = NumericTargetingDimension::class;
protected $geoTargetingDataType = '';
protected $includedCreativeDimensionsType = CreativeDimensions::class;
protected $includedCreativeDimensionsDataType = 'array';
/**
* Environments that are being included. Bid requests will not be sent for a
* given environment if it is not included. Further restrictions can be
* applied to included environments to target only a subset of its inventory.
* An unset value includes all environments.
*
* @var string[]
*/
public $includedEnvironments;
/**
* Creative formats included by this config. Only bid requests eligible for at
* least one of the specified creative formats will be sent. An unset value
* will allow all bid requests to be sent, regardless of format.
*
* @var string[]
*/
public $includedFormats;
/**
* The languages included in this config, represented by their language code.
* See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
*
* @var string[]
*/
public $includedLanguages;
/**
* The mobile operating systems included in this config as defined in
* https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
*
* @var string[]
*/
public $includedMobileOperatingSystemIds;
/**
* The platforms included by this config. Bid requests for devices with the
* specified platform types will be sent. An unset value allows all bid
* requests to be sent, regardless of platform.
*
* @var string[]
*/
public $includedPlatforms;
/**
* User identifier types included in this config. At least one of the user
* identifier types specified in this list must be available for the bid
* request to be sent.
*
* @var string[]
*/
public $includedUserIdTypes;
/**
* The interstitial targeting specified for this config. The unset value will
* allow bid requests to be sent regardless of whether they are for
* interstitials or not.
*
* @var string
*/
public $interstitialTargeting;
/**
* Output only. Existing included or excluded geos that are invalid.
* Previously targeted geos may become invalid due to privacy restrictions.
*
* @var string[]
*/
public $invalidGeoIds;
/**
* The maximum QPS threshold for this config. The bidder should receive no
* more than this number of bid requests matching this config per second
* across all their bidding endpoints among all trading locations. Further
* information available at https://developers.google.com/authorized-
* buyers/rtb/peer-guide
*
* @var string
*/
public $maximumQps;
/**
* The targeted minimum viewability decile, ranging in values [0, 10]. A value
* of 5 means that the config will only match adslots for which we predict at
* least 50% viewability. Values > 10 will be rounded down to 10. An unset
* value or a value of 0 indicates that bid requests will be sent regardless
* of viewability.
*
* @var int
*/
public $minimumViewabilityDecile;
/**
* Output only. Name of the pretargeting config that must follow the pattern
* `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
*
* @var string
*/
public $name;
protected $publisherTargetingType = StringTargetingDimension::class;
protected $publisherTargetingDataType = '';
/**
* Output only. The state of this pretargeting config.
*
* @var string
*/
public $state;
protected $userListTargetingType = NumericTargetingDimension::class;
protected $userListTargetingDataType = '';
protected $verticalTargetingType = NumericTargetingDimension::class;
protected $verticalTargetingDataType = '';
protected $webTargetingType = StringTargetingDimension::class;
protected $webTargetingDataType = '';
/**
* Targeting modes included by this config. A bid request must allow all the
* specified targeting modes. An unset value allows all bid requests to be
* sent, regardless of which targeting modes they allow.
*
* @param string[] $allowedUserTargetingModes
*/
public function setAllowedUserTargetingModes($allowedUserTargetingModes)
{
$this->allowedUserTargetingModes = $allowedUserTargetingModes;
}
/**
* @return string[]
*/
public function getAllowedUserTargetingModes()
{
return $this->allowedUserTargetingModes;
}
/**
* Targeting on a subset of app inventory. If APP is listed in
* targeted_environments, the specified targeting is applied. A maximum of
* 30,000 app IDs can be targeted. An unset value for targeting allows all
* app-based bid requests to be sent. Apps can either be targeting positively
* (bid requests will be sent only if the destination app is listed in the
* targeting dimension) or negatively (bid requests will be sent only if the
* destination app is not listed in the targeting dimension).
*
* @param AppTargeting $appTargeting
*/
public function setAppTargeting(AppTargeting $appTargeting)
{
$this->appTargeting = $appTargeting;
}
/**
* @return AppTargeting
*/
public function getAppTargeting()
{
return $this->appTargeting;
}
/**
* Output only. The identifier that corresponds to this pretargeting config
* that helps buyers track and attribute their spend across their own
* arbitrary divisions. If a bid request matches more than one config, the
* buyer chooses which billing_id to attribute each of their bids.
*
* @param string $billingId
*/
public function setBillingId($billingId)
{
$this->billingId = $billingId;
}
/**
* @return string
*/
public function getBillingId()
{
return $this->billingId;
}
/**
* The diplay name associated with this config. This name must be unique among
* all the pretargeting configs a bidder has.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* The sensitive content category label IDs excluded in this config. Bid
* requests for inventory with any of the specified content label IDs will not
* be sent. Refer to this file https://storage.googleapis.com/adx-rtb-
* dictionaries/content-labels.txt for category IDs.
*
* @param string[] $excludedContentLabelIds
*/
public function setExcludedContentLabelIds($excludedContentLabelIds)
{
$this->excludedContentLabelIds = $excludedContentLabelIds;
}
/**
* @return string[]
*/
public function getExcludedContentLabelIds()
{
return $this->excludedContentLabelIds;
}
/**
* The geos included or excluded in this config defined in
* https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
*
* @param NumericTargetingDimension $geoTargeting
*/
public function setGeoTargeting(NumericTargetingDimension $geoTargeting)
{
$this->geoTargeting = $geoTargeting;
}
/**
* @return NumericTargetingDimension
*/
public function getGeoTargeting()
{
return $this->geoTargeting;
}
/**
* Creative dimensions included by this config. Only bid requests eligible for
* at least one of the specified creative dimensions will be sent. An unset
* value allows all bid requests to be sent, regardless of creative dimension.
*
* @param CreativeDimensions[] $includedCreativeDimensions
*/
public function setIncludedCreativeDimensions($includedCreativeDimensions)
{
$this->includedCreativeDimensions = $includedCreativeDimensions;
}
/**
* @return CreativeDimensions[]
*/
public function getIncludedCreativeDimensions()
{
return $this->includedCreativeDimensions;
}
/**
* Environments that are being included. Bid requests will not be sent for a
* given environment if it is not included. Further restrictions can be
* applied to included environments to target only a subset of its inventory.
* An unset value includes all environments.
*
* @param string[] $includedEnvironments
*/
public function setIncludedEnvironments($includedEnvironments)
{
$this->includedEnvironments = $includedEnvironments;
}
/**
* @return string[]
*/
public function getIncludedEnvironments()
{
return $this->includedEnvironments;
}
/**
* Creative formats included by this config. Only bid requests eligible for at
* least one of the specified creative formats will be sent. An unset value
* will allow all bid requests to be sent, regardless of format.
*
* @param string[] $includedFormats
*/
public function setIncludedFormats($includedFormats)
{
$this->includedFormats = $includedFormats;
}
/**
* @return string[]
*/
public function getIncludedFormats()
{
return $this->includedFormats;
}
/**
* The languages included in this config, represented by their language code.
* See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
*
* @param string[] $includedLanguages
*/
public function setIncludedLanguages($includedLanguages)
{
$this->includedLanguages = $includedLanguages;
}
/**
* @return string[]
*/
public function getIncludedLanguages()
{
return $this->includedLanguages;
}
/**
* The mobile operating systems included in this config as defined in
* https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
*
* @param string[] $includedMobileOperatingSystemIds
*/
public function setIncludedMobileOperatingSystemIds($includedMobileOperatingSystemIds)
{
$this->includedMobileOperatingSystemIds = $includedMobileOperatingSystemIds;
}
/**
* @return string[]
*/
public function getIncludedMobileOperatingSystemIds()
{
return $this->includedMobileOperatingSystemIds;
}
/**
* The platforms included by this config. Bid requests for devices with the
* specified platform types will be sent. An unset value allows all bid
* requests to be sent, regardless of platform.
*
* @param string[] $includedPlatforms
*/
public function setIncludedPlatforms($includedPlatforms)
{
$this->includedPlatforms = $includedPlatforms;
}
/**
* @return string[]
*/
public function getIncludedPlatforms()
{
return $this->includedPlatforms;
}
/**
* User identifier types included in this config. At least one of the user
* identifier types specified in this list must be available for the bid
* request to be sent.
*
* @param string[] $includedUserIdTypes
*/
public function setIncludedUserIdTypes($includedUserIdTypes)
{
$this->includedUserIdTypes = $includedUserIdTypes;
}
/**
* @return string[]
*/
public function getIncludedUserIdTypes()
{
return $this->includedUserIdTypes;
}
/**
* The interstitial targeting specified for this config. The unset value will
* allow bid requests to be sent regardless of whether they are for
* interstitials or not.
*
* Accepted values: INTERSTITIAL_TARGETING_UNSPECIFIED,
* ONLY_INTERSTITIAL_REQUESTS, ONLY_NON_INTERSTITIAL_REQUESTS
*
* @param self::INTERSTITIAL_TARGETING_* $interstitialTargeting
*/
public function setInterstitialTargeting($interstitialTargeting)
{
$this->interstitialTargeting = $interstitialTargeting;
}
/**
* @return self::INTERSTITIAL_TARGETING_*
*/
public function getInterstitialTargeting()
{
return $this->interstitialTargeting;
}
/**
* Output only. Existing included or excluded geos that are invalid.
* Previously targeted geos may become invalid due to privacy restrictions.
*
* @param string[] $invalidGeoIds
*/
public function setInvalidGeoIds($invalidGeoIds)
{
$this->invalidGeoIds = $invalidGeoIds;
}
/**
* @return string[]
*/
public function getInvalidGeoIds()
{
return $this->invalidGeoIds;
}
/**
* The maximum QPS threshold for this config. The bidder should receive no
* more than this number of bid requests matching this config per second
* across all their bidding endpoints among all trading locations. Further
* information available at https://developers.google.com/authorized-
* buyers/rtb/peer-guide
*
* @param string $maximumQps
*/
public function setMaximumQps($maximumQps)
{
$this->maximumQps = $maximumQps;
}
/**
* @return string
*/
public function getMaximumQps()
{
return $this->maximumQps;
}
/**
* The targeted minimum viewability decile, ranging in values [0, 10]. A value
* of 5 means that the config will only match adslots for which we predict at
* least 50% viewability. Values > 10 will be rounded down to 10. An unset
* value or a value of 0 indicates that bid requests will be sent regardless
* of viewability.
*
* @param int $minimumViewabilityDecile
*/
public function setMinimumViewabilityDecile($minimumViewabilityDecile)
{
$this->minimumViewabilityDecile = $minimumViewabilityDecile;
}
/**
* @return int
*/
public function getMinimumViewabilityDecile()
{
return $this->minimumViewabilityDecile;
}
/**
* Output only. Name of the pretargeting config that must follow the pattern
* `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Targeting on a subset of publisher inventory. Publishers can either be
* targeted positively (bid requests will be sent only if the publisher is
* listed in the targeting dimension) or negatively (bid requests will be sent
* only if the publisher is not listed in the targeting dimension). A maximum
* of 10,000 publisher IDs can be targeted. Publisher IDs are found in
* [ads.txt](https://iabtechlab.com/ads-txt/) / [app-
* ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the
* `BidRequest.publisher_id` field on the [Google RTB
* protocol](https://developers.google.com/authorized-
* buyers/rtb/downloads/realtime-bidding-proto) or the
* `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the
* [OpenRTB protocol](https://developers.google.com/authorized-
* buyers/rtb/downloads/openrtb-adx-proto). Publisher IDs will be returned in
* the order that they were entered.
*
* @param StringTargetingDimension $publisherTargeting
*/
public function setPublisherTargeting(StringTargetingDimension $publisherTargeting)
{
$this->publisherTargeting = $publisherTargeting;
}
/**
* @return StringTargetingDimension
*/
public function getPublisherTargeting()
{
return $this->publisherTargeting;
}
/**
* Output only. The state of this pretargeting config.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE, SUSPENDED
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* The remarketing lists included or excluded in this config as defined in
* UserList.
*
* @param NumericTargetingDimension $userListTargeting
*/
public function setUserListTargeting(NumericTargetingDimension $userListTargeting)
{
$this->userListTargeting = $userListTargeting;
}
/**
* @return NumericTargetingDimension
*/
public function getUserListTargeting()
{
return $this->userListTargeting;
}
/**
* The verticals included or excluded in this config as defined in
* https://developers.google.com/authorized-buyers/rtb/downloads/publisher-
* verticals
*
* @param NumericTargetingDimension $verticalTargeting
*/
public function setVerticalTargeting(NumericTargetingDimension $verticalTargeting)
{
$this->verticalTargeting = $verticalTargeting;
}
/**
* @return NumericTargetingDimension
*/
public function getVerticalTargeting()
{
return $this->verticalTargeting;
}
/**
* Targeting on a subset of site inventory. If WEB is listed in
* included_environments, the specified targeting is applied. A maximum of
* 50,000 site URLs can be targeted. An unset value for targeting allows all
* web-based bid requests to be sent. Sites can either be targeting positively
* (bid requests will be sent only if the destination site is listed in the
* targeting dimension) or negatively (bid requests will be sent only if the
* destination site is not listed in the pretargeting config).
*
* @param StringTargetingDimension $webTargeting
*/
public function setWebTargeting(StringTargetingDimension $webTargeting)
{
$this->webTargeting = $webTargeting;
}
/**
* @return StringTargetingDimension
*/
public function getWebTargeting()
{
return $this->webTargeting;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PretargetingConfig::class, 'Google_Service_RealTimeBidding_PretargetingConfig');
@@ -0,0 +1,181 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class PublisherConnection extends \Google\Model
{
/**
* An unspecified bidding status.
*/
public const BIDDING_STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* Indicates a request for connection from the publisher that the bidder needs
* to review.
*/
public const BIDDING_STATE_PENDING = 'PENDING';
/**
* Indicates that the publisher was rejected.
*/
public const BIDDING_STATE_REJECTED = 'REJECTED';
/**
* Indicates that the publisher was approved.
*/
public const BIDDING_STATE_APPROVED = 'APPROVED';
/**
* An unspecified publisher platform.
*/
public const PUBLISHER_PLATFORM_PUBLISHER_PLATFORM_UNSPECIFIED = 'PUBLISHER_PLATFORM_UNSPECIFIED';
/**
* A Google Ad Manager publisher.
*/
public const PUBLISHER_PLATFORM_GOOGLE_AD_MANAGER = 'GOOGLE_AD_MANAGER';
/**
* An AdMob publisher.
*/
public const PUBLISHER_PLATFORM_ADMOB = 'ADMOB';
/**
* Whether the publisher has been approved by the bidder.
*
* @var string
*/
public $biddingState;
/**
* Output only. The time at which the publisher initiated a connection with
* the bidder (irrespective of if or when the bidder approves it). This is
* subsequently updated if the publisher revokes and re-initiates the
* connection.
*
* @var string
*/
public $createTime;
/**
* Output only. Publisher display name.
*
* @var string
*/
public $displayName;
/**
* Output only. Name of the publisher connection. This follows the pattern
* `bidders/{bidder}/publisherConnections/{publisher}`, where `{bidder}`
* represents the account ID of the bidder, and `{publisher}` is the
* ads.txt/app-ads.txt publisher ID.
*
* @var string
*/
public $name;
/**
* Output only. Whether the publisher is an Ad Manager or AdMob publisher.
*
* @var string
*/
public $publisherPlatform;
/**
* Whether the publisher has been approved by the bidder.
*
* Accepted values: STATE_UNSPECIFIED, PENDING, REJECTED, APPROVED
*
* @param self::BIDDING_STATE_* $biddingState
*/
public function setBiddingState($biddingState)
{
$this->biddingState = $biddingState;
}
/**
* @return self::BIDDING_STATE_*
*/
public function getBiddingState()
{
return $this->biddingState;
}
/**
* Output only. The time at which the publisher initiated a connection with
* the bidder (irrespective of if or when the bidder approves it). This is
* subsequently updated if the publisher revokes and re-initiates the
* connection.
*
* @param string $createTime
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* Output only. Publisher display name.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Output only. Name of the publisher connection. This follows the pattern
* `bidders/{bidder}/publisherConnections/{publisher}`, where `{bidder}`
* represents the account ID of the bidder, and `{publisher}` is the
* ads.txt/app-ads.txt publisher ID.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Output only. Whether the publisher is an Ad Manager or AdMob publisher.
*
* Accepted values: PUBLISHER_PLATFORM_UNSPECIFIED, GOOGLE_AD_MANAGER, ADMOB
*
* @param self::PUBLISHER_PLATFORM_* $publisherPlatform
*/
public function setPublisherPlatform($publisherPlatform)
{
$this->publisherPlatform = $publisherPlatform;
}
/**
* @return self::PUBLISHER_PLATFORM_*
*/
public function getPublisherPlatform()
{
return $this->publisherPlatform;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PublisherConnection::class, 'Google_Service_RealTimeBidding_PublisherConnection');
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class RealtimebiddingEmpty extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RealtimebiddingEmpty::class, 'Google_Service_RealTimeBidding_RealtimebiddingEmpty');
@@ -0,0 +1,53 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class RemoveTargetedAppsRequest extends \Google\Collection
{
protected $collection_key = 'appIds';
/**
* A list of app IDs to stop targeting in the pretargeting configuration.
* These values will be removed from the list of targeted app IDs in
* PretargetingConfig.appTargeting.mobileAppTargeting.values.
*
* @var string[]
*/
public $appIds;
/**
* A list of app IDs to stop targeting in the pretargeting configuration.
* These values will be removed from the list of targeted app IDs in
* PretargetingConfig.appTargeting.mobileAppTargeting.values.
*
* @param string[] $appIds
*/
public function setAppIds($appIds)
{
$this->appIds = $appIds;
}
/**
* @return string[]
*/
public function getAppIds()
{
return $this->appIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RemoveTargetedAppsRequest::class, 'Google_Service_RealTimeBidding_RemoveTargetedAppsRequest');
@@ -0,0 +1,59 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class RemoveTargetedPublishersRequest extends \Google\Collection
{
protected $collection_key = 'publisherIds';
/**
* A list of publisher IDs to stop targeting in the pretargeting
* configuration. These values will be removed from the list of targeted
* publisher IDs in PretargetingConfig.publisherTargeting.values. Publishers
* are identified by their publisher ID from ads.txt / app-ads.txt. See
* https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for
* more details.
*
* @var string[]
*/
public $publisherIds;
/**
* A list of publisher IDs to stop targeting in the pretargeting
* configuration. These values will be removed from the list of targeted
* publisher IDs in PretargetingConfig.publisherTargeting.values. Publishers
* are identified by their publisher ID from ads.txt / app-ads.txt. See
* https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for
* more details.
*
* @param string[] $publisherIds
*/
public function setPublisherIds($publisherIds)
{
$this->publisherIds = $publisherIds;
}
/**
* @return string[]
*/
public function getPublisherIds()
{
return $this->publisherIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RemoveTargetedPublishersRequest::class, 'Google_Service_RealTimeBidding_RemoveTargetedPublishersRequest');
@@ -0,0 +1,53 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class RemoveTargetedSitesRequest extends \Google\Collection
{
protected $collection_key = 'sites';
/**
* A list of site URLs to stop targeting in the pretargeting configuration.
* These values will be removed from the list of targeted URLs in
* PretargetingConfig.webTargeting.values.
*
* @var string[]
*/
public $sites;
/**
* A list of site URLs to stop targeting in the pretargeting configuration.
* These values will be removed from the list of targeted URLs in
* PretargetingConfig.webTargeting.values.
*
* @param string[] $sites
*/
public function setSites($sites)
{
$this->sites = $sites;
}
/**
* @return string[]
*/
public function getSites()
{
return $this->sites;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RemoveTargetedSitesRequest::class, 'Google_Service_RealTimeBidding_RemoveTargetedSitesRequest');
@@ -0,0 +1,72 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\Bidder;
use Google\Service\RealTimeBidding\ListBiddersResponse;
/**
* The "bidders" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $bidders = $realtimebiddingService->bidders;
* </code>
*/
class Bidders extends \Google\Service\Resource
{
/**
* Gets a bidder account by its name. (bidders.get)
*
* @param string $name Required. Name of the bidder to get. Format:
* `bidders/{bidderAccountId}`
* @param array $optParams Optional parameters.
* @return Bidder
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Bidder::class);
}
/**
* Lists all the bidder accounts that belong to the caller.
* (bidders.listBidders)
*
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of bidders to return. If
* unspecified, at most 100 bidders will be returned. The maximum value is 500;
* values above 500 will be coerced to 500.
* @opt_param string pageToken A token identifying a page of results the server
* should return. This value is received from a previous `ListBidders` call in
* ListBiddersResponse.nextPageToken.
* @return ListBiddersResponse
* @throws \Google\Service\Exception
*/
public function listBidders($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListBiddersResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Bidders::class, 'Google_Service_RealTimeBidding_Resource_Bidders');
@@ -0,0 +1,108 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\ListCreativesResponse;
use Google\Service\RealTimeBidding\WatchCreativesRequest;
use Google\Service\RealTimeBidding\WatchCreativesResponse;
/**
* The "creatives" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $creatives = $realtimebiddingService->bidders_creatives;
* </code>
*/
class BiddersCreatives extends \Google\Service\Resource
{
/**
* Lists creatives as they are at the time of the initial request. This call may
* take multiple hours to complete. For large, paginated requests, this method
* returns a snapshot of creatives at the time of request for the first page.
* `lastStatusUpdate` and `creativeServingDecision` may be outdated for
* creatives on sequential pages. We recommend [Google Cloud
* Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status.
* (creatives.listBiddersCreatives)
*
* @param string $parent Required. Name of the parent buyer that owns the
* creatives. The pattern for this resource is either `buyers/{buyerAccountId}`
* or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the
* `buyerAccountId` can be one of the following: 1. The ID of the buyer that is
* accessing their own creatives. 2. The ID of the child seat buyer under a
* bidder account. So for listing creatives pertaining to the child seat buyer
* (`456`) under bidder account (`123`), you would use the pattern:
* `buyers/456`. 3. The ID of the bidder itself. So for listing creatives
* pertaining to bidder (`123`), you would use `buyers/123`. If you want to
* access all creatives pertaining to both the bidder and all of its child seat
* accounts, you would use `bidders/{bidderAccountId}`, for example, for all
* creatives pertaining to bidder (`123`), use `bidders/123`.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Query string to filter creatives. If no filter is
* specified, all active creatives will be returned. Example: 'accountId=12345
* AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR
* declaredAttributes:IS_COOKIE_TARGETED'
* @opt_param int pageSize Requested page size. The server may return fewer
* creatives than requested (due to timeout constraint) even if more are
* available through another call. If unspecified, server will pick an
* appropriate default. Acceptable values are 1 to 1000, inclusive.
* @opt_param string pageToken A token identifying a page of results the server
* should return. Typically, this is the value of
* ListCreativesResponse.nextPageToken returned from the previous call to the
* 'ListCreatives' method. Page tokens for continued pages are valid for up to
* five hours, counting from the call to 'ListCreatives' for the first page.
* @opt_param string view Controls the amount of information included in the
* response. By default only creativeServingDecision is included. To retrieve
* the entire creative resource (including the declared fields and the creative
* content) specify the view as "FULL".
* @return ListCreativesResponse
* @throws \Google\Service\Exception
*/
public function listBiddersCreatives($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListCreativesResponse::class);
}
/**
* Watches all creatives pertaining to a bidder. It is sufficient to invoke this
* endpoint once per bidder. A Pub/Sub topic will be created and notifications
* will be pushed to the topic when any of the bidder's creatives change status.
* All of the bidder's service accounts will have access to read from the topic.
* Subsequent invocations of this method will return the existing Pub/Sub
* configuration. (creatives.watch)
*
* @param string $parent Required. To watch all creatives pertaining to the
* bidder and all its child seat accounts, the bidder must follow the pattern
* `bidders/{bidderAccountId}`.
* @param WatchCreativesRequest $postBody
* @param array $optParams Optional parameters.
* @return WatchCreativesResponse
* @throws \Google\Service\Exception
*/
public function watch($parent, WatchCreativesRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('watch', [$params], WatchCreativesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BiddersCreatives::class, 'Google_Service_RealTimeBidding_Resource_BiddersCreatives');
@@ -0,0 +1,93 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\Endpoint;
use Google\Service\RealTimeBidding\ListEndpointsResponse;
/**
* The "endpoints" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $endpoints = $realtimebiddingService->bidders_endpoints;
* </code>
*/
class BiddersEndpoints extends \Google\Service\Resource
{
/**
* Gets a bidder endpoint by its name. (endpoints.get)
*
* @param string $name Required. Name of the bidder endpoint to get. Format:
* `bidders/{bidderAccountId}/endpoints/{endpointId}`
* @param array $optParams Optional parameters.
* @return Endpoint
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Endpoint::class);
}
/**
* Lists all the bidder's endpoints. (endpoints.listBiddersEndpoints)
*
* @param string $parent Required. Name of the bidder whose endpoints will be
* listed. Format: `bidders/{bidderAccountId}`
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of endpoints to return. If
* unspecified, at most 100 endpoints will be returned. The maximum value is
* 500; values above 500 will be coerced to 500.
* @opt_param string pageToken A token identifying a page of results the server
* should return. This value is received from a previous `ListEndpoints` call in
* ListEndpointsResponse.nextPageToken.
* @return ListEndpointsResponse
* @throws \Google\Service\Exception
*/
public function listBiddersEndpoints($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListEndpointsResponse::class);
}
/**
* Updates a bidder's endpoint. (endpoints.patch)
*
* @param string $name Output only. Name of the endpoint resource that must
* follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where
* {bidderAccountId} is the account ID of the bidder who operates this endpoint,
* and {endpointId} is a unique ID assigned by the server.
* @param Endpoint $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Field mask to use for partial in-place updates.
* @return Endpoint
* @throws \Google\Service\Exception
*/
public function patch($name, Endpoint $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Endpoint::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BiddersEndpoints::class, 'Google_Service_RealTimeBidding_Resource_BiddersEndpoints');
@@ -0,0 +1,278 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\ActivatePretargetingConfigRequest;
use Google\Service\RealTimeBidding\AddTargetedAppsRequest;
use Google\Service\RealTimeBidding\AddTargetedPublishersRequest;
use Google\Service\RealTimeBidding\AddTargetedSitesRequest;
use Google\Service\RealTimeBidding\ListPretargetingConfigsResponse;
use Google\Service\RealTimeBidding\PretargetingConfig;
use Google\Service\RealTimeBidding\RealtimebiddingEmpty;
use Google\Service\RealTimeBidding\RemoveTargetedAppsRequest;
use Google\Service\RealTimeBidding\RemoveTargetedPublishersRequest;
use Google\Service\RealTimeBidding\RemoveTargetedSitesRequest;
use Google\Service\RealTimeBidding\SuspendPretargetingConfigRequest;
/**
* The "pretargetingConfigs" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $pretargetingConfigs = $realtimebiddingService->bidders_pretargetingConfigs;
* </code>
*/
class BiddersPretargetingConfigs extends \Google\Service\Resource
{
/**
* Activates a pretargeting configuration. (pretargetingConfigs.activate)
*
* @param string $name Required. The name of the pretargeting configuration.
* Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param ActivatePretargetingConfigRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function activate($name, ActivatePretargetingConfigRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('activate', [$params], PretargetingConfig::class);
}
/**
* Adds targeted apps to the pretargeting configuration.
* (pretargetingConfigs.addTargetedApps)
*
* @param string $pretargetingConfig Required. The name of the pretargeting
* configuration. Format:
* bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param AddTargetedAppsRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function addTargetedApps($pretargetingConfig, AddTargetedAppsRequest $postBody, $optParams = [])
{
$params = ['pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('addTargetedApps', [$params], PretargetingConfig::class);
}
/**
* Adds targeted publishers to the pretargeting config.
* (pretargetingConfigs.addTargetedPublishers)
*
* @param string $pretargetingConfig Required. The name of the pretargeting
* configuration. Format:
* bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param AddTargetedPublishersRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function addTargetedPublishers($pretargetingConfig, AddTargetedPublishersRequest $postBody, $optParams = [])
{
$params = ['pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('addTargetedPublishers', [$params], PretargetingConfig::class);
}
/**
* Adds targeted sites to the pretargeting configuration.
* (pretargetingConfigs.addTargetedSites)
*
* @param string $pretargetingConfig Required. The name of the pretargeting
* configuration. Format:
* bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param AddTargetedSitesRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function addTargetedSites($pretargetingConfig, AddTargetedSitesRequest $postBody, $optParams = [])
{
$params = ['pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('addTargetedSites', [$params], PretargetingConfig::class);
}
/**
* Creates a pretargeting configuration. A pretargeting configuration's state
* (PretargetingConfig.state) is active upon creation, and it will start to
* affect traffic shortly after. A bidder may create a maximum of 10
* pretargeting configurations. Attempts to exceed this maximum results in a 400
* bad request error. (pretargetingConfigs.create)
*
* @param string $parent Required. Name of the bidder to create the pretargeting
* configuration for. Format: bidders/{bidderAccountId}
* @param PretargetingConfig $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function create($parent, PretargetingConfig $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], PretargetingConfig::class);
}
/**
* Deletes a pretargeting configuration. (pretargetingConfigs.delete)
*
* @param string $name Required. The name of the pretargeting configuration to
* delete. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param array $optParams Optional parameters.
* @return RealtimebiddingEmpty
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], RealtimebiddingEmpty::class);
}
/**
* Gets a pretargeting configuration. (pretargetingConfigs.get)
*
* @param string $name Required. Name of the pretargeting configuration to get.
* Format: bidders/{bidderAccountId}/pretargetingConfigs/{configId}
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], PretargetingConfig::class);
}
/**
* Lists all pretargeting configurations for a single bidder.
* (pretargetingConfigs.listBiddersPretargetingConfigs)
*
* @param string $parent Required. Name of the bidder whose pretargeting
* configurations will be listed. Format: bidders/{bidderAccountId}
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of pretargeting configurations to
* return. If unspecified, at most 10 pretargeting configurations will be
* returned. The maximum value is 100; values above 100 will be coerced to 100.
* @opt_param string pageToken A token identifying a page of results the server
* should return. This value is received from a previous
* `ListPretargetingConfigs` call in
* ListPretargetingConfigsResponse.nextPageToken.
* @return ListPretargetingConfigsResponse
* @throws \Google\Service\Exception
*/
public function listBiddersPretargetingConfigs($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListPretargetingConfigsResponse::class);
}
/**
* Updates a pretargeting configuration. (pretargetingConfigs.patch)
*
* @param string $name Output only. Name of the pretargeting config that must
* follow the pattern
* `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
* @param PretargetingConfig $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Field mask to use for partial in-place updates.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function patch($name, PretargetingConfig $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], PretargetingConfig::class);
}
/**
* Removes targeted apps from the pretargeting configuration.
* (pretargetingConfigs.removeTargetedApps)
*
* @param string $pretargetingConfig Required. The name of the pretargeting
* configuration. Format:
* bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param RemoveTargetedAppsRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function removeTargetedApps($pretargetingConfig, RemoveTargetedAppsRequest $postBody, $optParams = [])
{
$params = ['pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('removeTargetedApps', [$params], PretargetingConfig::class);
}
/**
* Removes targeted publishers from the pretargeting config.
* (pretargetingConfigs.removeTargetedPublishers)
*
* @param string $pretargetingConfig Required. The name of the pretargeting
* configuration. Format:
* bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param RemoveTargetedPublishersRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function removeTargetedPublishers($pretargetingConfig, RemoveTargetedPublishersRequest $postBody, $optParams = [])
{
$params = ['pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('removeTargetedPublishers', [$params], PretargetingConfig::class);
}
/**
* Removes targeted sites from the pretargeting configuration.
* (pretargetingConfigs.removeTargetedSites)
*
* @param string $pretargetingConfig Required. The name of the pretargeting
* configuration. Format:
* bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param RemoveTargetedSitesRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function removeTargetedSites($pretargetingConfig, RemoveTargetedSitesRequest $postBody, $optParams = [])
{
$params = ['pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('removeTargetedSites', [$params], PretargetingConfig::class);
}
/**
* Suspends a pretargeting configuration. (pretargetingConfigs.suspend)
*
* @param string $name Required. The name of the pretargeting configuration.
* Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param SuspendPretargetingConfigRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function suspend($name, SuspendPretargetingConfigRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('suspend', [$params], PretargetingConfig::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BiddersPretargetingConfigs::class, 'Google_Service_RealTimeBidding_Resource_BiddersPretargetingConfigs');
@@ -0,0 +1,130 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\BatchApprovePublisherConnectionsRequest;
use Google\Service\RealTimeBidding\BatchApprovePublisherConnectionsResponse;
use Google\Service\RealTimeBidding\BatchRejectPublisherConnectionsRequest;
use Google\Service\RealTimeBidding\BatchRejectPublisherConnectionsResponse;
use Google\Service\RealTimeBidding\ListPublisherConnectionsResponse;
use Google\Service\RealTimeBidding\PublisherConnection;
/**
* The "publisherConnections" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $publisherConnections = $realtimebiddingService->bidders_publisherConnections;
* </code>
*/
class BiddersPublisherConnections extends \Google\Service\Resource
{
/**
* Batch approves multiple publisher connections.
* (publisherConnections.batchApprove)
*
* @param string $parent Required. The bidder for whom publisher connections
* will be approved. Format: `bidders/{bidder}` where `{bidder}` is the account
* ID of the bidder.
* @param BatchApprovePublisherConnectionsRequest $postBody
* @param array $optParams Optional parameters.
* @return BatchApprovePublisherConnectionsResponse
* @throws \Google\Service\Exception
*/
public function batchApprove($parent, BatchApprovePublisherConnectionsRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('batchApprove', [$params], BatchApprovePublisherConnectionsResponse::class);
}
/**
* Batch rejects multiple publisher connections.
* (publisherConnections.batchReject)
*
* @param string $parent Required. The bidder for whom publisher connections
* will be rejected. Format: `bidders/{bidder}` where `{bidder}` is the account
* ID of the bidder.
* @param BatchRejectPublisherConnectionsRequest $postBody
* @param array $optParams Optional parameters.
* @return BatchRejectPublisherConnectionsResponse
* @throws \Google\Service\Exception
*/
public function batchReject($parent, BatchRejectPublisherConnectionsRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('batchReject', [$params], BatchRejectPublisherConnectionsResponse::class);
}
/**
* Gets a publisher connection. (publisherConnections.get)
*
* @param string $name Required. Name of the publisher whose connection
* information is to be retrieved. In the pattern
* `bidders/{bidder}/publisherConnections/{publisher}` where `{bidder}` is the
* account ID of the bidder, and `{publisher}` is the ads.txt/app-ads.txt
* publisher ID. See publisherConnection.name.
* @param array $optParams Optional parameters.
* @return PublisherConnection
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], PublisherConnection::class);
}
/**
* Lists publisher connections for a given bidder.
* (publisherConnections.listBiddersPublisherConnections)
*
* @param string $parent Required. Name of the bidder for which publishers have
* initiated connections. The pattern for this resource is `bidders/{bidder}`
* where `{bidder}` represents the account ID of the bidder.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Query string to filter publisher connections.
* Connections can be filtered by `displayName`, `publisherPlatform`, and
* `biddingState`. If no filter is specified, all publisher connections will be
* returned. Example: 'displayName="Great Publisher*" AND
* publisherPlatform=ADMOB AND biddingState != PENDING' See
* https://google.aip.dev/160 for more information about filtering syntax.
* @opt_param string orderBy Order specification by which results should be
* sorted. If no sort order is specified, the results will be returned in
* alphabetic order based on the publisher's publisher code. Results can be
* sorted by `createTime`. Example: 'createTime DESC'.
* @opt_param int pageSize Requested page size. The server may return fewer
* results than requested (due to timeout constraint) even if more are available
* through another call. If unspecified, the server will pick an appropriate
* default. Acceptable values are 1 to 5000, inclusive.
* @opt_param string pageToken A token identifying a page of results the server
* should return. Typically, this is the value of
* ListPublisherConnectionsResponse.nextPageToken returned from the previous
* call to the 'ListPublisherConnections' method.
* @return ListPublisherConnectionsResponse
* @throws \Google\Service\Exception
*/
public function listBiddersPublisherConnections($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListPublisherConnectionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BiddersPublisherConnections::class, 'Google_Service_RealTimeBidding_Resource_BiddersPublisherConnections');
@@ -0,0 +1,99 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\Buyer;
use Google\Service\RealTimeBidding\GetRemarketingTagResponse;
use Google\Service\RealTimeBidding\ListBuyersResponse;
/**
* The "buyers" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $buyers = $realtimebiddingService->buyers;
* </code>
*/
class Buyers extends \Google\Service\Resource
{
/**
* Gets a buyer account by its name. (buyers.get)
*
* @param string $name Required. Name of the buyer to get. Format:
* `buyers/{buyerId}`
* @param array $optParams Optional parameters.
* @return Buyer
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Buyer::class);
}
/**
* This has been sunset as of October 2023, and will return an error response if
* called. For more information, see the release notes:
* https://developers.google.com/authorized-buyers/apis/relnotes#real-time-
* bidding-api Gets remarketing tag for a buyer. A remarketing tag is a piece of
* JavaScript code that can be placed on a web page. When a user visits a page
* containing a remarketing tag, Google adds the user to a user list.
* (buyers.getRemarketingTag)
*
* @param string $name Required. To fetch the remarketing tag for an account,
* the name must follow the pattern `buyers/{accountId}`, where `{accountId}`
* represents the ID of the buyer that owns the remarketing tag. For a bidder
* accessing the remarketing tag on behalf of a child seat buyer, `{accountId}`
* should represent the ID of the child seat buyer. To fetch the remarketing tag
* for a specific user list, the name must follow the pattern
* `buyers/{accountId}/userLists/{userListId}`. See UserList.name.
* @param array $optParams Optional parameters.
* @return GetRemarketingTagResponse
* @throws \Google\Service\Exception
*/
public function getRemarketingTag($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getRemarketingTag', [$params], GetRemarketingTagResponse::class);
}
/**
* Lists all buyer account information the calling buyer user or service account
* is permissioned to manage. (buyers.listBuyers)
*
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of buyers to return. If
* unspecified, at most 100 buyers will be returned. The maximum value is 500;
* values above 500 will be coerced to 500.
* @opt_param string pageToken A token identifying a page of results the server
* should return. This value is received from a previous `ListBuyers` call in
* ListBuyersResponse.nextPageToken.
* @return ListBuyersResponse
* @throws \Google\Service\Exception
*/
public function listBuyers($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListBuyersResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Buyers::class, 'Google_Service_RealTimeBidding_Resource_Buyers');
@@ -0,0 +1,144 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\Creative;
use Google\Service\RealTimeBidding\ListCreativesResponse;
/**
* The "creatives" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $creatives = $realtimebiddingService->buyers_creatives;
* </code>
*/
class BuyersCreatives extends \Google\Service\Resource
{
/**
* Creates a creative. (creatives.create)
*
* @param string $parent Required. The name of the parent buyer that the new
* creative belongs to that must follow the pattern `buyers/{buyerAccountId}`,
* where `{buyerAccountId}` represents the account ID of the buyer who owns a
* creative. For a bidder accessing creatives on behalf of a child seat buyer,
* `{buyerAccountId}` should represent the account ID of the child seat buyer.
* @param Creative $postBody
* @param array $optParams Optional parameters.
* @return Creative
* @throws \Google\Service\Exception
*/
public function create($parent, Creative $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Creative::class);
}
/**
* Gets a creative. (creatives.get)
*
* @param string $name Required. Name of the creative to retrieve. See
* creative.name.
* @param array $optParams Optional parameters.
*
* @opt_param string view Controls the amount of information included in the
* response. By default only creativeServingDecision is included. To retrieve
* the entire creative resource (including the declared fields and the creative
* content) specify the view as "FULL".
* @return Creative
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Creative::class);
}
/**
* Lists creatives as they are at the time of the initial request. This call may
* take multiple hours to complete. For large, paginated requests, this method
* returns a snapshot of creatives at the time of request for the first page.
* `lastStatusUpdate` and `creativeServingDecision` may be outdated for
* creatives on sequential pages. We recommend [Google Cloud
* Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status.
* (creatives.listBuyersCreatives)
*
* @param string $parent Required. Name of the parent buyer that owns the
* creatives. The pattern for this resource is either `buyers/{buyerAccountId}`
* or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the
* `buyerAccountId` can be one of the following: 1. The ID of the buyer that is
* accessing their own creatives. 2. The ID of the child seat buyer under a
* bidder account. So for listing creatives pertaining to the child seat buyer
* (`456`) under bidder account (`123`), you would use the pattern:
* `buyers/456`. 3. The ID of the bidder itself. So for listing creatives
* pertaining to bidder (`123`), you would use `buyers/123`. If you want to
* access all creatives pertaining to both the bidder and all of its child seat
* accounts, you would use `bidders/{bidderAccountId}`, for example, for all
* creatives pertaining to bidder (`123`), use `bidders/123`.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Query string to filter creatives. If no filter is
* specified, all active creatives will be returned. Example: 'accountId=12345
* AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR
* declaredAttributes:IS_COOKIE_TARGETED'
* @opt_param int pageSize Requested page size. The server may return fewer
* creatives than requested (due to timeout constraint) even if more are
* available through another call. If unspecified, server will pick an
* appropriate default. Acceptable values are 1 to 1000, inclusive.
* @opt_param string pageToken A token identifying a page of results the server
* should return. Typically, this is the value of
* ListCreativesResponse.nextPageToken returned from the previous call to the
* 'ListCreatives' method. Page tokens for continued pages are valid for up to
* five hours, counting from the call to 'ListCreatives' for the first page.
* @opt_param string view Controls the amount of information included in the
* response. By default only creativeServingDecision is included. To retrieve
* the entire creative resource (including the declared fields and the creative
* content) specify the view as "FULL".
* @return ListCreativesResponse
* @throws \Google\Service\Exception
*/
public function listBuyersCreatives($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListCreativesResponse::class);
}
/**
* Updates a creative. (creatives.patch)
*
* @param string $name Output only. Name of the creative. Follows the pattern
* `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account
* ID of the buyer who owns the creative, and `{creative}` is the buyer-specific
* creative ID that references this creative in the bid response.
* @param Creative $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Field mask to use for partial in-place updates.
* @return Creative
* @throws \Google\Service\Exception
*/
public function patch($name, Creative $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Creative::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BuyersCreatives::class, 'Google_Service_RealTimeBidding_Resource_BuyersCreatives');
@@ -0,0 +1,177 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\CloseUserListRequest;
use Google\Service\RealTimeBidding\GetRemarketingTagResponse;
use Google\Service\RealTimeBidding\ListUserListsResponse;
use Google\Service\RealTimeBidding\OpenUserListRequest;
use Google\Service\RealTimeBidding\UserList;
/**
* The "userLists" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $userLists = $realtimebiddingService->buyers_userLists;
* </code>
*/
class BuyersUserLists extends \Google\Service\Resource
{
/**
* Changes the status of a user list to CLOSED. This prevents new users from
* being added to the user list. (userLists.close)
*
* @param string $name Required. The name of the user list to close. See
* UserList.name
* @param CloseUserListRequest $postBody
* @param array $optParams Optional parameters.
* @return UserList
* @throws \Google\Service\Exception
*/
public function close($name, CloseUserListRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('close', [$params], UserList::class);
}
/**
* Creates a new user list. (userLists.create)
*
* @param string $parent Required. The name of the parent buyer of the user list
* to be retrieved, which must follow the pattern `buyers/{buyerAccountId}`,
* where `{buyerAccountId}` represents the account ID of the buyer who owns the
* user list. For a bidder accessing user lists on behalf of a child seat buyer,
* `{buyerAccountId}` should represent the account ID of the child seat buyer.
* @param UserList $postBody
* @param array $optParams Optional parameters.
* @return UserList
* @throws \Google\Service\Exception
*/
public function create($parent, UserList $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], UserList::class);
}
/**
* Gets a user list by its name. (userLists.get)
*
* @param string $name Required. The name of the user list to be retrieved. See
* UserList.name.
* @param array $optParams Optional parameters.
* @return UserList
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], UserList::class);
}
/**
* This has been sunset as of October 2023, and will return an error response if
* called. For more information, see the release notes:
* https://developers.google.com/authorized-buyers/apis/relnotes#real-time-
* bidding-api Gets remarketing tag for a buyer. A remarketing tag is a piece of
* JavaScript code that can be placed on a web page. When a user visits a page
* containing a remarketing tag, Google adds the user to a user list.
* (userLists.getRemarketingTag)
*
* @param string $name Required. To fetch the remarketing tag for an account,
* the name must follow the pattern `buyers/{accountId}`, where `{accountId}`
* represents the ID of the buyer that owns the remarketing tag. For a bidder
* accessing the remarketing tag on behalf of a child seat buyer, `{accountId}`
* should represent the ID of the child seat buyer. To fetch the remarketing tag
* for a specific user list, the name must follow the pattern
* `buyers/{accountId}/userLists/{userListId}`. See UserList.name.
* @param array $optParams Optional parameters.
* @return GetRemarketingTagResponse
* @throws \Google\Service\Exception
*/
public function getRemarketingTag($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getRemarketingTag', [$params], GetRemarketingTagResponse::class);
}
/**
* Lists the user lists visible to the current user.
* (userLists.listBuyersUserLists)
*
* @param string $parent Required. The name of the parent buyer for the user
* lists to be returned that must follow the pattern `buyers/{buyerAccountId}`,
* where `{buyerAccountId}` represents the account ID of the buyer who owns user
* lists. For a bidder accessing user lists on behalf of a child seat buyer ,
* `{buyerAccountId}` should represent the account ID of the child seat buyer.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The number of results to return per page.
* @opt_param string pageToken Continuation page token as received from a
* previous response.
* @return ListUserListsResponse
* @throws \Google\Service\Exception
*/
public function listBuyersUserLists($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListUserListsResponse::class);
}
/**
* Changes the status of a user list to OPEN. This allows new users to be added
* to the user list. (userLists.open)
*
* @param string $name Required. The name of the user list to open. See
* UserList.name
* @param OpenUserListRequest $postBody
* @param array $optParams Optional parameters.
* @return UserList
* @throws \Google\Service\Exception
*/
public function open($name, OpenUserListRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('open', [$params], UserList::class);
}
/**
* Updates the given user list. Only user lists with URLRestrictions can be
* updated. (userLists.update)
*
* @param string $name Output only. Name of the user list that must follow the
* pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents
* the account ID of the buyer who owns the user list. For a bidder accessing
* user lists on behalf of a child seat buyer, `{buyer}` represents the account
* ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by
* Google to uniquely identify a user list.
* @param UserList $postBody
* @param array $optParams Optional parameters.
* @return UserList
* @throws \Google\Service\Exception
*/
public function update($name, UserList $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], UserList::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BuyersUserLists::class, 'Google_Service_RealTimeBidding_Resource_BuyersUserLists');
@@ -0,0 +1,87 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class StringTargetingDimension extends \Google\Collection
{
/**
* Placeholder for undefined targeting mode.
*/
public const TARGETING_MODE_TARGETING_MODE_UNSPECIFIED = 'TARGETING_MODE_UNSPECIFIED';
/**
* The inclusive list type. Inventory must match an item in this list to be
* targeted.
*/
public const TARGETING_MODE_INCLUSIVE = 'INCLUSIVE';
/**
* The exclusive list type. Inventory must not match any item in this list to
* be targeted.
*/
public const TARGETING_MODE_EXCLUSIVE = 'EXCLUSIVE';
protected $collection_key = 'values';
/**
* How the items in this list should be targeted.
*
* @var string
*/
public $targetingMode;
/**
* The values specified.
*
* @var string[]
*/
public $values;
/**
* How the items in this list should be targeted.
*
* Accepted values: TARGETING_MODE_UNSPECIFIED, INCLUSIVE, EXCLUSIVE
*
* @param self::TARGETING_MODE_* $targetingMode
*/
public function setTargetingMode($targetingMode)
{
$this->targetingMode = $targetingMode;
}
/**
* @return self::TARGETING_MODE_*
*/
public function getTargetingMode()
{
return $this->targetingMode;
}
/**
* The values specified.
*
* @param string[] $values
*/
public function setValues($values)
{
$this->values = $values;
}
/**
* @return string[]
*/
public function getValues()
{
return $this->values;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(StringTargetingDimension::class, 'Google_Service_RealTimeBidding_StringTargetingDimension');
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class SuspendPretargetingConfigRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SuspendPretargetingConfigRequest::class, 'Google_Service_RealTimeBidding_SuspendPretargetingConfigRequest');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class UrlDownloadSize extends \Google\Model
{
/**
* Download size of the URL in kilobytes.
*
* @var int
*/
public $downloadSizeKb;
/**
* The normalized URL with query parameters and fragment removed.
*
* @var string
*/
public $normalizedUrl;
/**
* Download size of the URL in kilobytes.
*
* @param int $downloadSizeKb
*/
public function setDownloadSizeKb($downloadSizeKb)
{
$this->downloadSizeKb = $downloadSizeKb;
}
/**
* @return int
*/
public function getDownloadSizeKb()
{
return $this->downloadSizeKb;
}
/**
* The normalized URL with query parameters and fragment removed.
*
* @param string $normalizedUrl
*/
public function setNormalizedUrl($normalizedUrl)
{
$this->normalizedUrl = $normalizedUrl;
}
/**
* @return string
*/
public function getNormalizedUrl()
{
return $this->normalizedUrl;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UrlDownloadSize::class, 'Google_Service_RealTimeBidding_UrlDownloadSize');
@@ -0,0 +1,154 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class UrlRestriction extends \Google\Model
{
/**
* Default value that should never be used.
*/
public const RESTRICTION_TYPE_RESTRICTION_TYPE_UNSPECIFIED = 'RESTRICTION_TYPE_UNSPECIFIED';
/**
* The tag URL (as recorded by the pixel callback) contains the specified URL.
*/
public const RESTRICTION_TYPE_CONTAINS = 'CONTAINS';
/**
* The tag URL (as recorded by the pixel callback) exactly matches the
* specified URL.
*/
public const RESTRICTION_TYPE_EQUALS = 'EQUALS';
/**
* The tag URL (as recorded by the pixel callback) starts with the specified
* URL.
*/
public const RESTRICTION_TYPE_STARTS_WITH = 'STARTS_WITH';
/**
* The tag URL (as recorded by the pixel callback) ends with the specified
* URL.
*/
public const RESTRICTION_TYPE_ENDS_WITH = 'ENDS_WITH';
/**
* The tag URL (as recorded by the pixel callback) does not equal the
* specified URL.
*/
public const RESTRICTION_TYPE_DOES_NOT_EQUAL = 'DOES_NOT_EQUAL';
/**
* The tag URL (as recorded by the pixel callback) does not contain the
* specified URL.
*/
public const RESTRICTION_TYPE_DOES_NOT_CONTAIN = 'DOES_NOT_CONTAIN';
/**
* The tag URL (as recorded by the pixel callback) does not start with the
* specified URL.
*/
public const RESTRICTION_TYPE_DOES_NOT_START_WITH = 'DOES_NOT_START_WITH';
/**
* The tag URL (as recorded by the pixel callback) does not end with the
* specified URL.
*/
public const RESTRICTION_TYPE_DOES_NOT_END_WITH = 'DOES_NOT_END_WITH';
protected $endDateType = Date::class;
protected $endDateDataType = '';
/**
* The restriction type for the specified URL.
*
* @var string
*/
public $restrictionType;
protected $startDateType = Date::class;
protected $startDateDataType = '';
/**
* Required. The URL to use for applying the restriction on the user list.
*
* @var string
*/
public $url;
/**
* End date (if specified) of the URL restriction. End date should be later
* than the start date for the date range to be valid.
*
* @param Date $endDate
*/
public function setEndDate(Date $endDate)
{
$this->endDate = $endDate;
}
/**
* @return Date
*/
public function getEndDate()
{
return $this->endDate;
}
/**
* The restriction type for the specified URL.
*
* Accepted values: RESTRICTION_TYPE_UNSPECIFIED, CONTAINS, EQUALS,
* STARTS_WITH, ENDS_WITH, DOES_NOT_EQUAL, DOES_NOT_CONTAIN,
* DOES_NOT_START_WITH, DOES_NOT_END_WITH
*
* @param self::RESTRICTION_TYPE_* $restrictionType
*/
public function setRestrictionType($restrictionType)
{
$this->restrictionType = $restrictionType;
}
/**
* @return self::RESTRICTION_TYPE_*
*/
public function getRestrictionType()
{
return $this->restrictionType;
}
/**
* Start date (if specified) of the URL restriction.
*
* @param Date $startDate
*/
public function setStartDate(Date $startDate)
{
$this->startDate = $startDate;
}
/**
* @return Date
*/
public function getStartDate()
{
return $this->startDate;
}
/**
* Required. The URL to use for applying the restriction on the user list.
*
* @param string $url
*/
public function setUrl($url)
{
$this->url = $url;
}
/**
* @return string
*/
public function getUrl()
{
return $this->url;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UrlRestriction::class, 'Google_Service_RealTimeBidding_UrlRestriction');
@@ -0,0 +1,187 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class UserList extends \Google\Model
{
/**
* Default value that should never be used.
*/
public const STATUS_STATUS_UNSPECIFIED = 'STATUS_UNSPECIFIED';
/**
* New users can be added to the user list.
*/
public const STATUS_OPEN = 'OPEN';
/**
* New users cannot be added to the user list.
*/
public const STATUS_CLOSED = 'CLOSED';
/**
* The description for the user list.
*
* @var string
*/
public $description;
/**
* Required. Display name of the user list. This must be unique across all
* user lists for a given account.
*
* @var string
*/
public $displayName;
/**
* Required. The number of days a user's cookie stays on the user list. The
* field must be between 0 and 540 inclusive.
*
* @var string
*/
public $membershipDurationDays;
/**
* Output only. Name of the user list that must follow the pattern
* `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the
* account ID of the buyer who owns the user list. For a bidder accessing user
* lists on behalf of a child seat buyer, `{buyer}` represents the account ID
* of the child seat buyer. `{user_list}` is an int64 identifier assigned by
* Google to uniquely identify a user list.
*
* @var string
*/
public $name;
/**
* Output only. The status of the user list. A new user list starts out as
* open.
*
* @var string
*/
public $status;
protected $urlRestrictionType = UrlRestriction::class;
protected $urlRestrictionDataType = '';
/**
* The description for the user list.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* Required. Display name of the user list. This must be unique across all
* user lists for a given account.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Required. The number of days a user's cookie stays on the user list. The
* field must be between 0 and 540 inclusive.
*
* @param string $membershipDurationDays
*/
public function setMembershipDurationDays($membershipDurationDays)
{
$this->membershipDurationDays = $membershipDurationDays;
}
/**
* @return string
*/
public function getMembershipDurationDays()
{
return $this->membershipDurationDays;
}
/**
* Output only. Name of the user list that must follow the pattern
* `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the
* account ID of the buyer who owns the user list. For a bidder accessing user
* lists on behalf of a child seat buyer, `{buyer}` represents the account ID
* of the child seat buyer. `{user_list}` is an int64 identifier assigned by
* Google to uniquely identify a user list.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Output only. The status of the user list. A new user list starts out as
* open.
*
* Accepted values: STATUS_UNSPECIFIED, OPEN, CLOSED
*
* @param self::STATUS_* $status
*/
public function setStatus($status)
{
$this->status = $status;
}
/**
* @return self::STATUS_*
*/
public function getStatus()
{
return $this->status;
}
/**
* Required. Deprecated. This will be removed in October 2023. For more
* information, see the release notes:
* https://developers.google.com/authorized-buyers/apis/relnotes#real-time-
* bidding-api The URL restriction for the user list.
*
* @param UrlRestriction $urlRestriction
*/
public function setUrlRestriction(UrlRestriction $urlRestriction)
{
$this->urlRestriction = $urlRestriction;
}
/**
* @return UrlRestriction
*/
public function getUrlRestriction()
{
return $this->urlRestriction;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UserList::class, 'Google_Service_RealTimeBidding_UserList');
@@ -0,0 +1,92 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class VideoContent extends \Google\Model
{
protected $videoMetadataType = VideoMetadata::class;
protected $videoMetadataDataType = '';
/**
* The URL to fetch a video ad. The URL should return an XML response that
* conforms to the VAST 2.0, 3.0 or 4.x standard.
*
* @var string
*/
public $videoUrl;
/**
* The contents of a VAST document for a video ad. This document should
* conform to the VAST 2.0, 3.0, or 4.x standard.
*
* @var string
*/
public $videoVastXml;
/**
* Output only. Video metadata.
*
* @param VideoMetadata $videoMetadata
*/
public function setVideoMetadata(VideoMetadata $videoMetadata)
{
$this->videoMetadata = $videoMetadata;
}
/**
* @return VideoMetadata
*/
public function getVideoMetadata()
{
return $this->videoMetadata;
}
/**
* The URL to fetch a video ad. The URL should return an XML response that
* conforms to the VAST 2.0, 3.0 or 4.x standard.
*
* @param string $videoUrl
*/
public function setVideoUrl($videoUrl)
{
$this->videoUrl = $videoUrl;
}
/**
* @return string
*/
public function getVideoUrl()
{
return $this->videoUrl;
}
/**
* The contents of a VAST document for a video ad. This document should
* conform to the VAST 2.0, 3.0, or 4.x standard.
*
* @param string $videoVastXml
*/
public function setVideoVastXml($videoVastXml)
{
$this->videoVastXml = $videoVastXml;
}
/**
* @return string
*/
public function getVideoVastXml()
{
return $this->videoVastXml;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(VideoContent::class, 'Google_Service_RealTimeBidding_VideoContent');
@@ -0,0 +1,194 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class VideoMetadata extends \Google\Collection
{
/**
* Default value that should never be used.
*/
public const VAST_VERSION_VAST_VERSION_UNSPECIFIED = 'VAST_VERSION_UNSPECIFIED';
/**
* VAST 1.0
*/
public const VAST_VERSION_VAST_VERSION_1_0 = 'VAST_VERSION_1_0';
/**
* VAST 2.0
*/
public const VAST_VERSION_VAST_VERSION_2_0 = 'VAST_VERSION_2_0';
/**
* VAST 3.0
*/
public const VAST_VERSION_VAST_VERSION_3_0 = 'VAST_VERSION_3_0';
/**
* VAST 4.0
*/
public const VAST_VERSION_VAST_VERSION_4_0 = 'VAST_VERSION_4_0';
protected $collection_key = 'mediaFiles';
/**
* The duration of the ad. Can be used to filter the response of the
* creatives.list method.
*
* @var string
*/
public $duration;
/**
* Is this a valid VAST ad? Can be used to filter the response of the
* creatives.list method.
*
* @var bool
*/
public $isValidVast;
/**
* Is this a VPAID ad? Can be used to filter the response of the
* creatives.list method.
*
* @var bool
*/
public $isVpaid;
protected $mediaFilesType = MediaFile::class;
protected $mediaFilesDataType = 'array';
/**
* The minimum duration that the user has to watch before being able to skip
* this ad. If the field is not set, the ad is not skippable. If the field is
* set, the ad is skippable. Can be used to filter the response of the
* creatives.list method.
*
* @var string
*/
public $skipOffset;
/**
* The maximum VAST version across all wrapped VAST documents. Can be used to
* filter the response of the creatives.list method.
*
* @var string
*/
public $vastVersion;
/**
* The duration of the ad. Can be used to filter the response of the
* creatives.list method.
*
* @param string $duration
*/
public function setDuration($duration)
{
$this->duration = $duration;
}
/**
* @return string
*/
public function getDuration()
{
return $this->duration;
}
/**
* Is this a valid VAST ad? Can be used to filter the response of the
* creatives.list method.
*
* @param bool $isValidVast
*/
public function setIsValidVast($isValidVast)
{
$this->isValidVast = $isValidVast;
}
/**
* @return bool
*/
public function getIsValidVast()
{
return $this->isValidVast;
}
/**
* Is this a VPAID ad? Can be used to filter the response of the
* creatives.list method.
*
* @param bool $isVpaid
*/
public function setIsVpaid($isVpaid)
{
$this->isVpaid = $isVpaid;
}
/**
* @return bool
*/
public function getIsVpaid()
{
return $this->isVpaid;
}
/**
* The list of all media files declared in the VAST. If there are multiple
* VASTs in a wrapper chain, this includes the media files from the deepest
* one in the chain.
*
* @param MediaFile[] $mediaFiles
*/
public function setMediaFiles($mediaFiles)
{
$this->mediaFiles = $mediaFiles;
}
/**
* @return MediaFile[]
*/
public function getMediaFiles()
{
return $this->mediaFiles;
}
/**
* The minimum duration that the user has to watch before being able to skip
* this ad. If the field is not set, the ad is not skippable. If the field is
* set, the ad is skippable. Can be used to filter the response of the
* creatives.list method.
*
* @param string $skipOffset
*/
public function setSkipOffset($skipOffset)
{
$this->skipOffset = $skipOffset;
}
/**
* @return string
*/
public function getSkipOffset()
{
return $this->skipOffset;
}
/**
* The maximum VAST version across all wrapped VAST documents. Can be used to
* filter the response of the creatives.list method.
*
* Accepted values: VAST_VERSION_UNSPECIFIED, VAST_VERSION_1_0,
* VAST_VERSION_2_0, VAST_VERSION_3_0, VAST_VERSION_4_0
*
* @param self::VAST_VERSION_* $vastVersion
*/
public function setVastVersion($vastVersion)
{
$this->vastVersion = $vastVersion;
}
/**
* @return self::VAST_VERSION_*
*/
public function getVastVersion()
{
return $this->vastVersion;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(VideoMetadata::class, 'Google_Service_RealTimeBidding_VideoMetadata');
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class WatchCreativesRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(WatchCreativesRequest::class, 'Google_Service_RealTimeBidding_WatchCreativesRequest');
@@ -0,0 +1,86 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\RealTimeBidding;
class WatchCreativesResponse extends \Google\Model
{
/**
* The Pub/Sub subscription that can be used to pull creative status
* notifications. This would be of the format
* `projects/{project_id}/subscriptions/{subscription_id}`. Subscription is
* created with pull delivery. All service accounts belonging to the bidder
* will have read access to this subscription. Subscriptions that are inactive
* for more than 90 days will be disabled. Use watchCreatives to re-enable the
* subscription.
*
* @var string
*/
public $subscription;
/**
* The Pub/Sub topic that will be used to publish creative serving status
* notifications. This would be of the format
* `projects/{project_id}/topics/{topic_id}`.
*
* @var string
*/
public $topic;
/**
* The Pub/Sub subscription that can be used to pull creative status
* notifications. This would be of the format
* `projects/{project_id}/subscriptions/{subscription_id}`. Subscription is
* created with pull delivery. All service accounts belonging to the bidder
* will have read access to this subscription. Subscriptions that are inactive
* for more than 90 days will be disabled. Use watchCreatives to re-enable the
* subscription.
*
* @param string $subscription
*/
public function setSubscription($subscription)
{
$this->subscription = $subscription;
}
/**
* @return string
*/
public function getSubscription()
{
return $this->subscription;
}
/**
* The Pub/Sub topic that will be used to publish creative serving status
* notifications. This would be of the format
* `projects/{project_id}/topics/{topic_id}`.
*
* @param string $topic
*/
public function setTopic($topic)
{
$this->topic = $topic;
}
/**
* @return string
*/
public function getTopic()
{
return $this->topic;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(WatchCreativesResponse::class, 'Google_Service_RealTimeBidding_WatchCreativesResponse');