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,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\AuthorizedBuyersMarketplace;
class AcceptProposalRequest extends \Google\Model
{
/**
* The last known client revision number of the proposal.
*
* @var string
*/
public $proposalRevision;
/**
* The last known client revision number of the proposal.
*
* @param string $proposalRevision
*/
public function setProposalRevision($proposalRevision)
{
$this->proposalRevision = $proposalRevision;
}
/**
* @return string
*/
public function getProposalRevision()
{
return $this->proposalRevision;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AcceptProposalRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_AcceptProposalRequest');
@@ -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\AuthorizedBuyersMarketplace;
class ActivateClientRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivateClientRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_ActivateClientRequest');
@@ -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\AuthorizedBuyersMarketplace;
class ActivateClientUserRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ActivateClientUserRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_ActivateClientUserRequest');
@@ -0,0 +1,119 @@
<?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\AuthorizedBuyersMarketplace;
class AdSize extends \Google\Model
{
/**
* A placeholder for an undefined size type.
*/
public const TYPE_TYPE_UNSPECIFIED = 'TYPE_UNSPECIFIED';
/**
* Ad slot with size specified by height and width in pixels.
*/
public const TYPE_PIXEL = 'PIXEL';
/**
* Special size to describe an interstitial ad slot.
*/
public const TYPE_INTERSTITIAL = 'INTERSTITIAL';
/**
* Native (mobile) ads rendered by the publisher.
*/
public const TYPE_NATIVE = 'NATIVE';
/**
* Fluid size (responsive size) can be resized automatically with the change
* of outside environment.
*/
public const TYPE_FLUID = 'FLUID';
/**
* The height of the ad slot in pixels. This field will be present only when
* size type is `PIXEL`.
*
* @var string
*/
public $height;
/**
* The type of the ad slot size.
*
* @var string
*/
public $type;
/**
* The width of the ad slot in pixels. This field will be present only when
* size type is `PIXEL`.
*
* @var string
*/
public $width;
/**
* The height of the ad slot in pixels. This field will be present only when
* size type is `PIXEL`.
*
* @param string $height
*/
public function setHeight($height)
{
$this->height = $height;
}
/**
* @return string
*/
public function getHeight()
{
return $this->height;
}
/**
* The type of the ad slot size.
*
* Accepted values: TYPE_UNSPECIFIED, PIXEL, INTERSTITIAL, NATIVE, FLUID
*
* @param self::TYPE_* $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return self::TYPE_*
*/
public function getType()
{
return $this->type;
}
/**
* The width of the ad slot in pixels. This field will be present only when
* size type is `PIXEL`.
*
* @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(AdSize::class, 'Google_Service_AuthorizedBuyersMarketplace_AdSize');
@@ -0,0 +1,50 @@
<?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\AuthorizedBuyersMarketplace;
class AddCreativeRequest extends \Google\Model
{
/**
* Name of the creative to add to the finalized deal, in the format
* `buyers/{buyerAccountId}/creatives/{creativeId}`. See creative.name.
*
* @var string
*/
public $creative;
/**
* Name of the creative to add to the finalized deal, in the format
* `buyers/{buyerAccountId}/creatives/{creativeId}`. See creative.name.
*
* @param string $creative
*/
public function setCreative($creative)
{
$this->creative = $creative;
}
/**
* @return string
*/
public function getCreative()
{
return $this->creative;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AddCreativeRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_AddCreativeRequest');
@@ -0,0 +1,44 @@
<?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\AuthorizedBuyersMarketplace;
class AddNoteRequest extends \Google\Model
{
protected $noteType = Note::class;
protected $noteDataType = '';
/**
* The note to add.
*
* @param Note $note
*/
public function setNote(Note $note)
{
$this->note = $note;
}
/**
* @return Note
*/
public function getNote()
{
return $this->note;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AddNoteRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_AddNoteRequest');
@@ -0,0 +1,318 @@
<?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\AuthorizedBuyersMarketplace;
class AuctionPackage extends \Google\Collection
{
protected $collection_key = 'subscribedMediaPlanners';
/**
* Output only. Time the auction package was created.
*
* @var string
*/
public $createTime;
/**
* Output only. The buyer that created this auction package. Format:
* `buyers/{buyerAccountId}`
*
* @var string
*/
public $creator;
/**
* Output only. If set, this field contains the DSP specific seat id set by
* the media planner account that is considered the owner of this deal. The
* seat ID is in the calling DSP's namespace.
*
* @var string
*/
public $dealOwnerSeatId;
/**
* Output only. A description of the auction package.
*
* @var string
*/
public $description;
/**
* The display_name assigned to the auction package.
*
* @var string
*/
public $displayName;
/**
* Output only. If set, this field identifies a seat that the media planner
* selected as the owner of this auction package. This is a seat ID in the
* DSP's namespace that was provided to the media planner.
*
* @var string[]
*/
public $eligibleSeatIds;
protected $floorPriceCpmType = Money::class;
protected $floorPriceCpmDataType = '';
/**
* Immutable. The unique identifier for the auction package. Format:
* `buyers/{accountId}/auctionPackages/{auctionPackageId}` The
* auction_package_id part of name is sent in the BidRequest to all RTB
* bidders and is returned as deal_id by the bidder in the BidResponse.
*
* @var string
*/
public $name;
/**
* Output only. The list of buyers that are subscribed to the AuctionPackage.
* This field is only populated when calling as a bidder. Format:
* `buyers/{buyerAccountId}`
*
* @var string[]
*/
public $subscribedBuyers;
/**
* Output only. When calling as a buyer, the list of clients of the current
* buyer that are subscribed to the AuctionPackage. When calling as a bidder,
* the list of clients that are subscribed to the AuctionPackage owned by the
* bidder or its buyers. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountId}`
*
* @var string[]
*/
public $subscribedClients;
protected $subscribedMediaPlannersType = MediaPlanner::class;
protected $subscribedMediaPlannersDataType = 'array';
/**
* Output only. Time the auction package was last updated. This value is only
* increased when this auction package is updated but never when a buyer
* subscribed.
*
* @var string
*/
public $updateTime;
/**
* Output only. Time the auction package was created.
*
* @param string $createTime
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* Output only. The buyer that created this auction package. Format:
* `buyers/{buyerAccountId}`
*
* @param string $creator
*/
public function setCreator($creator)
{
$this->creator = $creator;
}
/**
* @return string
*/
public function getCreator()
{
return $this->creator;
}
/**
* Output only. If set, this field contains the DSP specific seat id set by
* the media planner account that is considered the owner of this deal. The
* seat ID is in the calling DSP's namespace.
*
* @param string $dealOwnerSeatId
*/
public function setDealOwnerSeatId($dealOwnerSeatId)
{
$this->dealOwnerSeatId = $dealOwnerSeatId;
}
/**
* @return string
*/
public function getDealOwnerSeatId()
{
return $this->dealOwnerSeatId;
}
/**
* Output only. A description of the auction package.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* The display_name assigned to the auction package.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Output only. If set, this field identifies a seat that the media planner
* selected as the owner of this auction package. This is a seat ID in the
* DSP's namespace that was provided to the media planner.
*
* @param string[] $eligibleSeatIds
*/
public function setEligibleSeatIds($eligibleSeatIds)
{
$this->eligibleSeatIds = $eligibleSeatIds;
}
/**
* @return string[]
*/
public function getEligibleSeatIds()
{
return $this->eligibleSeatIds;
}
/**
* Output only. The minimum price a buyer has to bid to compete in this
* auction package. If this is field is not populated, there is no floor
* price.
*
* @param Money $floorPriceCpm
*/
public function setFloorPriceCpm(Money $floorPriceCpm)
{
$this->floorPriceCpm = $floorPriceCpm;
}
/**
* @return Money
*/
public function getFloorPriceCpm()
{
return $this->floorPriceCpm;
}
/**
* Immutable. The unique identifier for the auction package. Format:
* `buyers/{accountId}/auctionPackages/{auctionPackageId}` The
* auction_package_id part of name is sent in the BidRequest to all RTB
* bidders and is returned as deal_id by the bidder in the BidResponse.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Output only. The list of buyers that are subscribed to the AuctionPackage.
* This field is only populated when calling as a bidder. Format:
* `buyers/{buyerAccountId}`
*
* @param string[] $subscribedBuyers
*/
public function setSubscribedBuyers($subscribedBuyers)
{
$this->subscribedBuyers = $subscribedBuyers;
}
/**
* @return string[]
*/
public function getSubscribedBuyers()
{
return $this->subscribedBuyers;
}
/**
* Output only. When calling as a buyer, the list of clients of the current
* buyer that are subscribed to the AuctionPackage. When calling as a bidder,
* the list of clients that are subscribed to the AuctionPackage owned by the
* bidder or its buyers. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountId}`
*
* @param string[] $subscribedClients
*/
public function setSubscribedClients($subscribedClients)
{
$this->subscribedClients = $subscribedClients;
}
/**
* @return string[]
*/
public function getSubscribedClients()
{
return $this->subscribedClients;
}
/**
* Output only. The list of media planners that are subscribed to the
* AuctionPackage. This field is only populated when calling as a bidder.
*
* @param MediaPlanner[] $subscribedMediaPlanners
*/
public function setSubscribedMediaPlanners($subscribedMediaPlanners)
{
$this->subscribedMediaPlanners = $subscribedMediaPlanners;
}
/**
* @return MediaPlanner[]
*/
public function getSubscribedMediaPlanners()
{
return $this->subscribedMediaPlanners;
}
/**
* Output only. Time the auction package was last updated. This value is only
* increased when this auction package is updated but never when a buyer
* subscribed.
*
* @param string $updateTime
*/
public function setUpdateTime($updateTime)
{
$this->updateTime = $updateTime;
}
/**
* @return string
*/
public function getUpdateTime()
{
return $this->updateTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AuctionPackage::class, 'Google_Service_AuthorizedBuyersMarketplace_AuctionPackage');
@@ -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\AuthorizedBuyersMarketplace;
class AuthorizedbuyersmarketplaceEmpty extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AuthorizedbuyersmarketplaceEmpty::class, 'Google_Service_AuthorizedBuyersMarketplace_AuthorizedbuyersmarketplaceEmpty');
@@ -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\AuthorizedBuyersMarketplace;
class BatchUpdateDealsRequest extends \Google\Collection
{
protected $collection_key = 'requests';
protected $requestsType = UpdateDealRequest::class;
protected $requestsDataType = 'array';
/**
* Required. List of request messages to update deals.
*
* @param UpdateDealRequest[] $requests
*/
public function setRequests($requests)
{
$this->requests = $requests;
}
/**
* @return UpdateDealRequest[]
*/
public function getRequests()
{
return $this->requests;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchUpdateDealsRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_BatchUpdateDealsRequest');
@@ -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\AuthorizedBuyersMarketplace;
class BatchUpdateDealsResponse extends \Google\Collection
{
protected $collection_key = 'deals';
protected $dealsType = Deal::class;
protected $dealsDataType = 'array';
/**
* Deals updated.
*
* @param Deal[] $deals
*/
public function setDeals($deals)
{
$this->deals = $deals;
}
/**
* @return Deal[]
*/
public function getDeals()
{
return $this->deals;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchUpdateDealsResponse::class, 'Google_Service_AuthorizedBuyersMarketplace_BatchUpdateDealsResponse');
@@ -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\AuthorizedBuyersMarketplace;
class CancelNegotiationRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CancelNegotiationRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_CancelNegotiationRequest');
@@ -0,0 +1,217 @@
<?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\AuthorizedBuyersMarketplace;
class Client extends \Google\Model
{
/**
* A placeholder for an undefined client role. This value should never be
* specified in user input for create or update method, otherwise an error
* will be returned.
*/
public const ROLE_CLIENT_ROLE_UNSPECIFIED = 'CLIENT_ROLE_UNSPECIFIED';
/**
* Users associated with this client role can only view proposals and deals in
* the Marketplace UI. They cannot negotiate or approve proposals and deals
* sent from publishers or send RFP to publishers.
*/
public const ROLE_CLIENT_DEAL_VIEWER = 'CLIENT_DEAL_VIEWER';
/**
* Users associated with this client role can view and negotiate on the
* proposals and deals in the Marketplace UI sent from publishers and send RFP
* to publishers, but cannot approve the proposals and deals by themselves.
* The buyer can approve the proposals and deals on behalf of the client.
*/
public const ROLE_CLIENT_DEAL_NEGOTIATOR = 'CLIENT_DEAL_NEGOTIATOR';
/**
* Users associated with this client role can view, negotiate and approve
* proposals and deals in the Marketplace UI and send RFP to publishers.
*/
public const ROLE_CLIENT_DEAL_APPROVER = 'CLIENT_DEAL_APPROVER';
/**
* A placeholder for an undefined client state. Should not be used.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* A client that is currently active and allowed to access the Authorized
* Buyers UI.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* A client that is currently inactive and not allowed to access the
* Authorized Buyers UI.
*/
public const STATE_INACTIVE = 'INACTIVE';
/**
* Required. Display name shown to publishers. Must be unique for clients
* without partnerClientId specified. Maximum length of 255 characters is
* allowed.
*
* @var string
*/
public $displayName;
/**
* Output only. The resource name of the client. Format:
* `buyers/{accountId}/clients/{clientAccountId}`
*
* @var string
*/
public $name;
/**
* Arbitrary unique identifier provided by the buyer. This field can be used
* to associate a client with an identifier in the namespace of the buyer,
* lookup clients by that identifier and verify whether an Authorized Buyers
* account of the client already exists. If present, must be unique across all
* the clients.
*
* @var string
*/
public $partnerClientId;
/**
* Required. The role assigned to the client. Each role implies a set of
* permissions granted to the client.
*
* @var string
*/
public $role;
/**
* Whether the client will be visible to sellers.
*
* @var bool
*/
public $sellerVisible;
/**
* Output only. The state of the client.
*
* @var string
*/
public $state;
/**
* Required. Display name shown to publishers. Must be unique for clients
* without partnerClientId specified. Maximum length of 255 characters is
* allowed.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Output only. The resource name of the client. Format:
* `buyers/{accountId}/clients/{clientAccountId}`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Arbitrary unique identifier provided by the buyer. This field can be used
* to associate a client with an identifier in the namespace of the buyer,
* lookup clients by that identifier and verify whether an Authorized Buyers
* account of the client already exists. If present, must be unique across all
* the clients.
*
* @param string $partnerClientId
*/
public function setPartnerClientId($partnerClientId)
{
$this->partnerClientId = $partnerClientId;
}
/**
* @return string
*/
public function getPartnerClientId()
{
return $this->partnerClientId;
}
/**
* Required. The role assigned to the client. Each role implies a set of
* permissions granted to the client.
*
* Accepted values: CLIENT_ROLE_UNSPECIFIED, CLIENT_DEAL_VIEWER,
* CLIENT_DEAL_NEGOTIATOR, CLIENT_DEAL_APPROVER
*
* @param self::ROLE_* $role
*/
public function setRole($role)
{
$this->role = $role;
}
/**
* @return self::ROLE_*
*/
public function getRole()
{
return $this->role;
}
/**
* Whether the client will be visible to sellers.
*
* @param bool $sellerVisible
*/
public function setSellerVisible($sellerVisible)
{
$this->sellerVisible = $sellerVisible;
}
/**
* @return bool
*/
public function getSellerVisible()
{
return $this->sellerVisible;
}
/**
* Output only. The state of the client.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE, INACTIVE
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Client::class, 'Google_Service_AuthorizedBuyersMarketplace_Client');
@@ -0,0 +1,117 @@
<?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\AuthorizedBuyersMarketplace;
class ClientUser extends \Google\Model
{
/**
* A placeholder for an undefined user state.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* A user who was created but hasn't accepted the invitation yet, not allowed
* to access the Authorized Buyers UI.
*/
public const STATE_INVITED = 'INVITED';
/**
* A user that is currently active and allowed to access the Authorized Buyers
* UI.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* A user that is currently inactive and not allowed to access the Authorized
* Buyers UI.
*/
public const STATE_INACTIVE = 'INACTIVE';
/**
* Required. The client user's email address that has to be unique across all
* users for the same client.
*
* @var string
*/
public $email;
/**
* Output only. The resource name of the client user. Format:
* `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
*
* @var string
*/
public $name;
/**
* Output only. The state of the client user.
*
* @var string
*/
public $state;
/**
* Required. The client user's email address that has to be unique across all
* users for the same client.
*
* @param string $email
*/
public function setEmail($email)
{
$this->email = $email;
}
/**
* @return string
*/
public function getEmail()
{
return $this->email;
}
/**
* Output only. The resource name of the client user. Format:
* `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Output only. The state of the client user.
*
* Accepted values: STATE_UNSPECIFIED, INVITED, ACTIVE, INACTIVE
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ClientUser::class, 'Google_Service_AuthorizedBuyersMarketplace_ClientUser');
@@ -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\AuthorizedBuyersMarketplace;
class Contact extends \Google\Model
{
/**
* The display_name of the contact.
*
* @var string
*/
public $displayName;
/**
* Email address for the contact.
*
* @var string
*/
public $email;
/**
* The display_name of the contact.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Email address for the contact.
*
* @param string $email
*/
public function setEmail($email)
{
$this->email = $email;
}
/**
* @return string
*/
public function getEmail()
{
return $this->email;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Contact::class, 'Google_Service_AuthorizedBuyersMarketplace_Contact');
@@ -0,0 +1,263 @@
<?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\AuthorizedBuyersMarketplace;
class CreativeRequirements extends \Google\Model
{
/**
* A placeholder for an unspecified creative format.
*/
public const CREATIVE_FORMAT_CREATIVE_FORMAT_UNSPECIFIED = 'CREATIVE_FORMAT_UNSPECIFIED';
/**
* Banner creatives such as image or HTML5 assets.
*/
public const CREATIVE_FORMAT_DISPLAY = 'DISPLAY';
/**
* Video creatives that can be played in a video player.
*/
public const CREATIVE_FORMAT_VIDEO = 'VIDEO';
/**
* Audio creatives that can play during audio content or point to a third
* party ad server.
*/
public const CREATIVE_FORMAT_AUDIO = 'AUDIO';
/**
* A placeholder for an undefined creative pre-approval policy.
*/
public const CREATIVE_PRE_APPROVAL_POLICY_CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED = 'CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED';
/**
* The seller needs to approve each creative before it can serve.
*/
public const CREATIVE_PRE_APPROVAL_POLICY_SELLER_PRE_APPROVAL_REQUIRED = 'SELLER_PRE_APPROVAL_REQUIRED';
/**
* The seller does not need to approve each creative before it can serve.
*/
public const CREATIVE_PRE_APPROVAL_POLICY_SELLER_PRE_APPROVAL_NOT_REQUIRED = 'SELLER_PRE_APPROVAL_NOT_REQUIRED';
/**
* A placeholder for an undefined creative safe-frame compatibility.
*/
public const CREATIVE_SAFE_FRAME_COMPATIBILITY_CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED = 'CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED';
/**
* The creatives need to be compatible with the safe frame option.
*/
public const CREATIVE_SAFE_FRAME_COMPATIBILITY_COMPATIBLE = 'COMPATIBLE';
/**
* The creatives can be incompatible with the safe frame option.
*/
public const CREATIVE_SAFE_FRAME_COMPATIBILITY_INCOMPATIBLE = 'INCOMPATIBLE';
/**
* A placeholder for an undefined programmatic creative source.
*/
public const PROGRAMMATIC_CREATIVE_SOURCE_PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED = 'PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED';
/**
* The advertiser provides the creatives.
*/
public const PROGRAMMATIC_CREATIVE_SOURCE_ADVERTISER = 'ADVERTISER';
/**
* The publisher provides the creatives to be served.
*/
public const PROGRAMMATIC_CREATIVE_SOURCE_PUBLISHER = 'PUBLISHER';
/**
* A placeholder for an unspecified skippable ad type.
*/
public const SKIPPABLE_AD_TYPE_SKIPPABLE_AD_TYPE_UNSPECIFIED = 'SKIPPABLE_AD_TYPE_UNSPECIFIED';
/**
* Video ad that can be skipped after 5 seconds. This value will appear in RTB
* bid requests as SkippableBidRequestType::REQUIRE_SKIPPABLE.
*/
public const SKIPPABLE_AD_TYPE_SKIPPABLE = 'SKIPPABLE';
/**
* Video ad that can be skipped after 5 seconds, and is counted as engaged
* view after 30 seconds. The creative is hosted on YouTube only, and
* viewcount of the YouTube video increments after the engaged view. This
* value will appear in RTB bid requests as
* SkippableBidRequestType::REQUIRE_SKIPPABLE.
*/
public const SKIPPABLE_AD_TYPE_INSTREAM_SELECT = 'INSTREAM_SELECT';
/**
* This video ad is not skippable. This value will appear in RTB bid requests
* as SkippableBidRequestType::BLOCK_SKIPPABLE.
*/
public const SKIPPABLE_AD_TYPE_NOT_SKIPPABLE = 'NOT_SKIPPABLE';
/**
* This video ad can be skipped after 5 seconds or not-skippable. This value
* will appear in RTB bid requests as
* SkippableBidRequestType::ALLOW_SKIPPABLE.
*/
public const SKIPPABLE_AD_TYPE_ANY = 'ANY';
/**
* Output only. The format of the creative, only applicable for programmatic
* guaranteed and preferred deals.
*
* @var string
*/
public $creativeFormat;
/**
* Output only. Specifies the creative pre-approval policy.
*
* @var string
*/
public $creativePreApprovalPolicy;
/**
* Output only. Specifies whether the creative is safeFrame compatible.
*
* @var string
*/
public $creativeSafeFrameCompatibility;
/**
* Output only. The max duration of the video creative in milliseconds. only
* applicable for deals with video creatives.
*
* @var string
*/
public $maxAdDurationMs;
/**
* Output only. Specifies the creative source for programmatic deals.
* PUBLISHER means creative is provided by seller and ADVERTISER means
* creative is provided by the buyer.
*
* @var string
*/
public $programmaticCreativeSource;
/**
* Output only. Skippable video ads allow viewers to skip ads after 5 seconds.
* Only applicable for deals with video creatives.
*
* @var string
*/
public $skippableAdType;
/**
* Output only. The format of the creative, only applicable for programmatic
* guaranteed and preferred deals.
*
* Accepted values: CREATIVE_FORMAT_UNSPECIFIED, DISPLAY, VIDEO, AUDIO
*
* @param self::CREATIVE_FORMAT_* $creativeFormat
*/
public function setCreativeFormat($creativeFormat)
{
$this->creativeFormat = $creativeFormat;
}
/**
* @return self::CREATIVE_FORMAT_*
*/
public function getCreativeFormat()
{
return $this->creativeFormat;
}
/**
* Output only. Specifies the creative pre-approval policy.
*
* Accepted values: CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED,
* SELLER_PRE_APPROVAL_REQUIRED, SELLER_PRE_APPROVAL_NOT_REQUIRED
*
* @param self::CREATIVE_PRE_APPROVAL_POLICY_* $creativePreApprovalPolicy
*/
public function setCreativePreApprovalPolicy($creativePreApprovalPolicy)
{
$this->creativePreApprovalPolicy = $creativePreApprovalPolicy;
}
/**
* @return self::CREATIVE_PRE_APPROVAL_POLICY_*
*/
public function getCreativePreApprovalPolicy()
{
return $this->creativePreApprovalPolicy;
}
/**
* Output only. Specifies whether the creative is safeFrame compatible.
*
* Accepted values: CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED, COMPATIBLE,
* INCOMPATIBLE
*
* @param self::CREATIVE_SAFE_FRAME_COMPATIBILITY_* $creativeSafeFrameCompatibility
*/
public function setCreativeSafeFrameCompatibility($creativeSafeFrameCompatibility)
{
$this->creativeSafeFrameCompatibility = $creativeSafeFrameCompatibility;
}
/**
* @return self::CREATIVE_SAFE_FRAME_COMPATIBILITY_*
*/
public function getCreativeSafeFrameCompatibility()
{
return $this->creativeSafeFrameCompatibility;
}
/**
* Output only. The max duration of the video creative in milliseconds. only
* applicable for deals with video creatives.
*
* @param string $maxAdDurationMs
*/
public function setMaxAdDurationMs($maxAdDurationMs)
{
$this->maxAdDurationMs = $maxAdDurationMs;
}
/**
* @return string
*/
public function getMaxAdDurationMs()
{
return $this->maxAdDurationMs;
}
/**
* Output only. Specifies the creative source for programmatic deals.
* PUBLISHER means creative is provided by seller and ADVERTISER means
* creative is provided by the buyer.
*
* Accepted values: PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED, ADVERTISER,
* PUBLISHER
*
* @param self::PROGRAMMATIC_CREATIVE_SOURCE_* $programmaticCreativeSource
*/
public function setProgrammaticCreativeSource($programmaticCreativeSource)
{
$this->programmaticCreativeSource = $programmaticCreativeSource;
}
/**
* @return self::PROGRAMMATIC_CREATIVE_SOURCE_*
*/
public function getProgrammaticCreativeSource()
{
return $this->programmaticCreativeSource;
}
/**
* Output only. Skippable video ads allow viewers to skip ads after 5 seconds.
* Only applicable for deals with video creatives.
*
* Accepted values: SKIPPABLE_AD_TYPE_UNSPECIFIED, SKIPPABLE, INSTREAM_SELECT,
* NOT_SKIPPABLE, ANY
*
* @param self::SKIPPABLE_AD_TYPE_* $skippableAdType
*/
public function setSkippableAdType($skippableAdType)
{
$this->skippableAdType = $skippableAdType;
}
/**
* @return self::SKIPPABLE_AD_TYPE_*
*/
public function getSkippableAdType()
{
return $this->skippableAdType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreativeRequirements::class, 'Google_Service_AuthorizedBuyersMarketplace_CreativeRequirements');
@@ -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\AuthorizedBuyersMarketplace;
class CriteriaTargeting extends \Google\Collection
{
protected $collection_key = 'targetedCriteriaIds';
/**
* A list of numeric IDs to be excluded.
*
* @var string[]
*/
public $excludedCriteriaIds;
/**
* A list of numeric IDs to be included.
*
* @var string[]
*/
public $targetedCriteriaIds;
/**
* A list of numeric IDs to be excluded.
*
* @param string[] $excludedCriteriaIds
*/
public function setExcludedCriteriaIds($excludedCriteriaIds)
{
$this->excludedCriteriaIds = $excludedCriteriaIds;
}
/**
* @return string[]
*/
public function getExcludedCriteriaIds()
{
return $this->excludedCriteriaIds;
}
/**
* A list of numeric IDs to be included.
*
* @param string[] $targetedCriteriaIds
*/
public function setTargetedCriteriaIds($targetedCriteriaIds)
{
$this->targetedCriteriaIds = $targetedCriteriaIds;
}
/**
* @return string[]
*/
public function getTargetedCriteriaIds()
{
return $this->targetedCriteriaIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CriteriaTargeting::class, 'Google_Service_AuthorizedBuyersMarketplace_CriteriaTargeting');
@@ -0,0 +1,127 @@
<?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\AuthorizedBuyersMarketplace;
class DayPart extends \Google\Model
{
/**
* The day of the week is unspecified.
*/
public const DAY_OF_WEEK_DAY_OF_WEEK_UNSPECIFIED = 'DAY_OF_WEEK_UNSPECIFIED';
/**
* Monday
*/
public const DAY_OF_WEEK_MONDAY = 'MONDAY';
/**
* Tuesday
*/
public const DAY_OF_WEEK_TUESDAY = 'TUESDAY';
/**
* Wednesday
*/
public const DAY_OF_WEEK_WEDNESDAY = 'WEDNESDAY';
/**
* Thursday
*/
public const DAY_OF_WEEK_THURSDAY = 'THURSDAY';
/**
* Friday
*/
public const DAY_OF_WEEK_FRIDAY = 'FRIDAY';
/**
* Saturday
*/
public const DAY_OF_WEEK_SATURDAY = 'SATURDAY';
/**
* Sunday
*/
public const DAY_OF_WEEK_SUNDAY = 'SUNDAY';
/**
* Day of week for the period.
*
* @var string
*/
public $dayOfWeek;
protected $endTimeType = TimeOfDay::class;
protected $endTimeDataType = '';
protected $startTimeType = TimeOfDay::class;
protected $startTimeDataType = '';
/**
* Day of week for the period.
*
* Accepted values: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY,
* THURSDAY, FRIDAY, SATURDAY, SUNDAY
*
* @param self::DAY_OF_WEEK_* $dayOfWeek
*/
public function setDayOfWeek($dayOfWeek)
{
$this->dayOfWeek = $dayOfWeek;
}
/**
* @return self::DAY_OF_WEEK_*
*/
public function getDayOfWeek()
{
return $this->dayOfWeek;
}
/**
* Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically
* equivalent to 0, but is supported since in some cases there may need to be
* differentiation made between midnight on one day and midnight on the next
* day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only
* acceptable minute value for hour 24. Seconds and nanos are ignored.
*
* @param TimeOfDay $endTime
*/
public function setEndTime(TimeOfDay $endTime)
{
$this->endTime = $endTime;
}
/**
* @return TimeOfDay
*/
public function getEndTime()
{
return $this->endTime;
}
/**
* Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically
* equivalent to 0, but is supported since in some cases there may need to be
* differentiation made between midnight on one day and midnight on the next
* day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only
* acceptable minute value for hour 24. Seconds and nanos are ignored.
*
* @param TimeOfDay $startTime
*/
public function setStartTime(TimeOfDay $startTime)
{
$this->startTime = $startTime;
}
/**
* @return TimeOfDay
*/
public function getStartTime()
{
return $this->startTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DayPart::class, 'Google_Service_AuthorizedBuyersMarketplace_DayPart');
@@ -0,0 +1,81 @@
<?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\AuthorizedBuyersMarketplace;
class DayPartTargeting extends \Google\Collection
{
/**
* Default value. This field is unused.
*/
public const TIME_ZONE_TYPE_TIME_ZONE_TYPE_UNSPECIFIED = 'TIME_ZONE_TYPE_UNSPECIFIED';
/**
* The publisher's time zone
*/
public const TIME_ZONE_TYPE_SELLER = 'SELLER';
/**
* The user's time zone
*/
public const TIME_ZONE_TYPE_USER = 'USER';
protected $collection_key = 'dayParts';
protected $dayPartsType = DayPart::class;
protected $dayPartsDataType = 'array';
/**
* The time zone type of the day parts
*
* @var string
*/
public $timeZoneType;
/**
* The targeted weekdays and times
*
* @param DayPart[] $dayParts
*/
public function setDayParts($dayParts)
{
$this->dayParts = $dayParts;
}
/**
* @return DayPart[]
*/
public function getDayParts()
{
return $this->dayParts;
}
/**
* The time zone type of the day parts
*
* Accepted values: TIME_ZONE_TYPE_UNSPECIFIED, SELLER, USER
*
* @param self::TIME_ZONE_TYPE_* $timeZoneType
*/
public function setTimeZoneType($timeZoneType)
{
$this->timeZoneType = $timeZoneType;
}
/**
* @return self::TIME_ZONE_TYPE_*
*/
public function getTimeZoneType()
{
return $this->timeZoneType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DayPartTargeting::class, 'Google_Service_AuthorizedBuyersMarketplace_DayPartTargeting');
@@ -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\AuthorizedBuyersMarketplace;
class DeactivateClientRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeactivateClientRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_DeactivateClientRequest');
@@ -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\AuthorizedBuyersMarketplace;
class DeactivateClientUserRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeactivateClientUserRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_DeactivateClientUserRequest');
@@ -0,0 +1,609 @@
<?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\AuthorizedBuyersMarketplace;
class Deal extends \Google\Collection
{
/**
* A placeholder for an undefined buyer permission type.
*/
public const BUYER_PERMISSION_TYPE_BUYER_PERMISSION_TYPE_UNSPECIFIED = 'BUYER_PERMISSION_TYPE_UNSPECIFIED';
/**
* Only the [Deal.negotiating_buyer] can transact on the deal.
*/
public const BUYER_PERMISSION_TYPE_NEGOTIATOR_ONLY = 'NEGOTIATOR_ONLY';
/**
* All buyers under the [Deal.negotiating_buyer]'s bidder can transact on the
* deal.
*/
public const BUYER_PERMISSION_TYPE_BIDDER = 'BIDDER';
/**
* Default, unspecified deal type.
*/
public const DEAL_TYPE_DEAL_TYPE_UNSPECIFIED = 'DEAL_TYPE_UNSPECIFIED';
/**
* Preferred deals.
*/
public const DEAL_TYPE_PREFERRED_DEAL = 'PREFERRED_DEAL';
/**
* Private auction deals.
*/
public const DEAL_TYPE_PRIVATE_AUCTION = 'PRIVATE_AUCTION';
/**
* Programmatic guaranteed deals.
*/
public const DEAL_TYPE_PROGRAMMATIC_GUARANTEED = 'PROGRAMMATIC_GUARANTEED';
protected $collection_key = 'eligibleSeatIds';
/**
* Output only. When the client field is populated, this field refers to the
* buyer who creates and manages the client buyer and gets billed on behalf of
* the client buyer; when the buyer field is populated, this field is the same
* value as buyer; when the deal belongs to a media planner account, this
* field will be empty. Format : `buyers/{buyerAccountId}`
*
* @var string
*/
public $billedBuyer;
/**
* Output only. Refers to a buyer in Real-time Bidding API's Buyer resource.
* Format: `buyers/{buyerAccountId}`
*
* @var string
*/
public $buyer;
/**
* Output only. The buyer permission type of the deal.
*
* @var string
*/
public $buyerPermissionType;
/**
* Output only. Refers to a Client. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountid}`
*
* @var string
*/
public $client;
/**
* Output only. The time of the deal creation.
*
* @var string
*/
public $createTime;
protected $creativeRequirementsType = CreativeRequirements::class;
protected $creativeRequirementsDataType = '';
/**
* Output only. Type of deal.
*
* @var string
*/
public $dealType;
protected $deliveryControlType = DeliveryControl::class;
protected $deliveryControlDataType = '';
/**
* Output only. Free text description for the deal terms.
*
* @var string
*/
public $description;
/**
* Output only. The name of the deal. Maximum length of 255 unicode characters
* is allowed. Control characters are not allowed. Buyers cannot update this
* field. Note: Not to be confused with name, which is a unique identifier of
* the deal.
*
* @var string
*/
public $displayName;
/**
* Output only. If set, this field contains the list of DSP specific seat ids
* set by media planners that are eligible to transact on this deal. The seat
* ID is in the calling DSP's namespace.
*
* @var string[]
*/
public $eligibleSeatIds;
protected $estimatedGrossSpendType = Money::class;
protected $estimatedGrossSpendDataType = '';
/**
* Proposed flight end time of the deal. This will generally be stored in a
* granularity of a second. A value is not necessary for Private Auction
* deals.
*
* @var string
*/
public $flightEndTime;
/**
* Proposed flight start time of the deal. This will generally be stored in
* the granularity of one second since deal serving starts at seconds
* boundary. Any time specified with more granularity (for example, in
* milliseconds) will be truncated towards the start of time in seconds.
*
* @var string
*/
public $flightStartTime;
protected $mediaPlannerType = MediaPlanner::class;
protected $mediaPlannerDataType = '';
/**
* Immutable. The unique identifier of the deal. Auto-generated by the server
* when a deal is created. Format:
* buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
*
* @var string
*/
public $name;
protected $preferredDealTermsType = PreferredDealTerms::class;
protected $preferredDealTermsDataType = '';
protected $privateAuctionTermsType = PrivateAuctionTerms::class;
protected $privateAuctionTermsDataType = '';
protected $programmaticGuaranteedTermsType = ProgrammaticGuaranteedTerms::class;
protected $programmaticGuaranteedTermsDataType = '';
/**
* Output only. The revision number for the proposal and is the same value as
* proposal.proposal_revision. Each update to deal causes the proposal
* revision number to auto-increment. The buyer keeps track of the last
* revision number they know of and pass it in when making an update. If the
* head revision number on the server has since incremented, then an ABORTED
* error is returned during the update operation to let the buyer know that a
* subsequent update was made.
*
* @var string
*/
public $proposalRevision;
/**
* Immutable. Reference to the seller on the deal. Format:
* `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
*
* @var string
*/
public $publisherProfile;
protected $sellerTimeZoneType = TimeZone::class;
protected $sellerTimeZoneDataType = '';
protected $targetingType = MarketplaceTargeting::class;
protected $targetingDataType = '';
/**
* Output only. The time when the deal was last updated.
*
* @var string
*/
public $updateTime;
/**
* Output only. When the client field is populated, this field refers to the
* buyer who creates and manages the client buyer and gets billed on behalf of
* the client buyer; when the buyer field is populated, this field is the same
* value as buyer; when the deal belongs to a media planner account, this
* field will be empty. Format : `buyers/{buyerAccountId}`
*
* @param string $billedBuyer
*/
public function setBilledBuyer($billedBuyer)
{
$this->billedBuyer = $billedBuyer;
}
/**
* @return string
*/
public function getBilledBuyer()
{
return $this->billedBuyer;
}
/**
* Output only. Refers to a buyer in Real-time Bidding API's Buyer resource.
* Format: `buyers/{buyerAccountId}`
*
* @param string $buyer
*/
public function setBuyer($buyer)
{
$this->buyer = $buyer;
}
/**
* @return string
*/
public function getBuyer()
{
return $this->buyer;
}
/**
* Output only. The buyer permission type of the deal.
*
* Accepted values: BUYER_PERMISSION_TYPE_UNSPECIFIED, NEGOTIATOR_ONLY, BIDDER
*
* @param self::BUYER_PERMISSION_TYPE_* $buyerPermissionType
*/
public function setBuyerPermissionType($buyerPermissionType)
{
$this->buyerPermissionType = $buyerPermissionType;
}
/**
* @return self::BUYER_PERMISSION_TYPE_*
*/
public function getBuyerPermissionType()
{
return $this->buyerPermissionType;
}
/**
* Output only. Refers to a Client. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountid}`
*
* @param string $client
*/
public function setClient($client)
{
$this->client = $client;
}
/**
* @return string
*/
public function getClient()
{
return $this->client;
}
/**
* Output only. The time of the deal creation.
*
* @param string $createTime
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* Output only. Metadata about the creatives of this deal.
*
* @param CreativeRequirements $creativeRequirements
*/
public function setCreativeRequirements(CreativeRequirements $creativeRequirements)
{
$this->creativeRequirements = $creativeRequirements;
}
/**
* @return CreativeRequirements
*/
public function getCreativeRequirements()
{
return $this->creativeRequirements;
}
/**
* Output only. Type of deal.
*
* Accepted values: DEAL_TYPE_UNSPECIFIED, PREFERRED_DEAL, PRIVATE_AUCTION,
* PROGRAMMATIC_GUARANTEED
*
* @param self::DEAL_TYPE_* $dealType
*/
public function setDealType($dealType)
{
$this->dealType = $dealType;
}
/**
* @return self::DEAL_TYPE_*
*/
public function getDealType()
{
return $this->dealType;
}
/**
* Output only. Specifies the pacing set by the publisher.
*
* @param DeliveryControl $deliveryControl
*/
public function setDeliveryControl(DeliveryControl $deliveryControl)
{
$this->deliveryControl = $deliveryControl;
}
/**
* @return DeliveryControl
*/
public function getDeliveryControl()
{
return $this->deliveryControl;
}
/**
* Output only. Free text description for the deal terms.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* Output only. The name of the deal. Maximum length of 255 unicode characters
* is allowed. Control characters are not allowed. Buyers cannot update this
* field. Note: Not to be confused with name, which is a unique identifier of
* the deal.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Output only. If set, this field contains the list of DSP specific seat ids
* set by media planners that are eligible to transact on this deal. The seat
* ID is in the calling DSP's namespace.
*
* @param string[] $eligibleSeatIds
*/
public function setEligibleSeatIds($eligibleSeatIds)
{
$this->eligibleSeatIds = $eligibleSeatIds;
}
/**
* @return string[]
*/
public function getEligibleSeatIds()
{
return $this->eligibleSeatIds;
}
/**
* Specified by buyers in request for proposal (RFP) to notify publisher the
* total estimated spend for the proposal. Publishers will receive this
* information and send back proposed deals accordingly.
*
* @param Money $estimatedGrossSpend
*/
public function setEstimatedGrossSpend(Money $estimatedGrossSpend)
{
$this->estimatedGrossSpend = $estimatedGrossSpend;
}
/**
* @return Money
*/
public function getEstimatedGrossSpend()
{
return $this->estimatedGrossSpend;
}
/**
* Proposed flight end time of the deal. This will generally be stored in a
* granularity of a second. A value is not necessary for Private Auction
* deals.
*
* @param string $flightEndTime
*/
public function setFlightEndTime($flightEndTime)
{
$this->flightEndTime = $flightEndTime;
}
/**
* @return string
*/
public function getFlightEndTime()
{
return $this->flightEndTime;
}
/**
* Proposed flight start time of the deal. This will generally be stored in
* the granularity of one second since deal serving starts at seconds
* boundary. Any time specified with more granularity (for example, in
* milliseconds) will be truncated towards the start of time in seconds.
*
* @param string $flightStartTime
*/
public function setFlightStartTime($flightStartTime)
{
$this->flightStartTime = $flightStartTime;
}
/**
* @return string
*/
public function getFlightStartTime()
{
return $this->flightStartTime;
}
/**
* Output only. Refers to a buyer in Real-time Bidding API's Buyer resource.
* This field represents a media planner (For example, agency or big
* advertiser).
*
* @param MediaPlanner $mediaPlanner
*/
public function setMediaPlanner(MediaPlanner $mediaPlanner)
{
$this->mediaPlanner = $mediaPlanner;
}
/**
* @return MediaPlanner
*/
public function getMediaPlanner()
{
return $this->mediaPlanner;
}
/**
* Immutable. The unique identifier of the deal. Auto-generated by the server
* when a deal is created. Format:
* buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The terms for preferred deals.
*
* @param PreferredDealTerms $preferredDealTerms
*/
public function setPreferredDealTerms(PreferredDealTerms $preferredDealTerms)
{
$this->preferredDealTerms = $preferredDealTerms;
}
/**
* @return PreferredDealTerms
*/
public function getPreferredDealTerms()
{
return $this->preferredDealTerms;
}
/**
* The terms for private auction deals.
*
* @param PrivateAuctionTerms $privateAuctionTerms
*/
public function setPrivateAuctionTerms(PrivateAuctionTerms $privateAuctionTerms)
{
$this->privateAuctionTerms = $privateAuctionTerms;
}
/**
* @return PrivateAuctionTerms
*/
public function getPrivateAuctionTerms()
{
return $this->privateAuctionTerms;
}
/**
* The terms for programmatic guaranteed deals.
*
* @param ProgrammaticGuaranteedTerms $programmaticGuaranteedTerms
*/
public function setProgrammaticGuaranteedTerms(ProgrammaticGuaranteedTerms $programmaticGuaranteedTerms)
{
$this->programmaticGuaranteedTerms = $programmaticGuaranteedTerms;
}
/**
* @return ProgrammaticGuaranteedTerms
*/
public function getProgrammaticGuaranteedTerms()
{
return $this->programmaticGuaranteedTerms;
}
/**
* Output only. The revision number for the proposal and is the same value as
* proposal.proposal_revision. Each update to deal causes the proposal
* revision number to auto-increment. The buyer keeps track of the last
* revision number they know of and pass it in when making an update. If the
* head revision number on the server has since incremented, then an ABORTED
* error is returned during the update operation to let the buyer know that a
* subsequent update was made.
*
* @param string $proposalRevision
*/
public function setProposalRevision($proposalRevision)
{
$this->proposalRevision = $proposalRevision;
}
/**
* @return string
*/
public function getProposalRevision()
{
return $this->proposalRevision;
}
/**
* Immutable. Reference to the seller on the deal. Format:
* `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
*
* @param string $publisherProfile
*/
public function setPublisherProfile($publisherProfile)
{
$this->publisherProfile = $publisherProfile;
}
/**
* @return string
*/
public function getPublisherProfile()
{
return $this->publisherProfile;
}
/**
* Output only. Time zone of the seller used to mark the boundaries of a day
* for daypart targeting and CPD billing.
*
* @param TimeZone $sellerTimeZone
*/
public function setSellerTimeZone(TimeZone $sellerTimeZone)
{
$this->sellerTimeZone = $sellerTimeZone;
}
/**
* @return TimeZone
*/
public function getSellerTimeZone()
{
return $this->sellerTimeZone;
}
/**
* Specifies the subset of inventory targeted by the deal. Can be updated by
* the buyer before the deal is finalized.
*
* @param MarketplaceTargeting $targeting
*/
public function setTargeting(MarketplaceTargeting $targeting)
{
$this->targeting = $targeting;
}
/**
* @return MarketplaceTargeting
*/
public function getTargeting()
{
return $this->targeting;
}
/**
* Output only. The time when the deal was last updated.
*
* @param string $updateTime
*/
public function setUpdateTime($updateTime)
{
$this->updateTime = $updateTime;
}
/**
* @return string
*/
public function getUpdateTime()
{
return $this->updateTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Deal::class, 'Google_Service_AuthorizedBuyersMarketplace_Deal');
@@ -0,0 +1,106 @@
<?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\AuthorizedBuyersMarketplace;
class DealPausingInfo extends \Google\Model
{
/**
* A placeholder for an undefined buyer/seller role.
*/
public const PAUSE_ROLE_BUYER_SELLER_ROLE_UNSPECIFIED = 'BUYER_SELLER_ROLE_UNSPECIFIED';
/**
* Specifies the role as buyer.
*/
public const PAUSE_ROLE_BUYER = 'BUYER';
/**
* Specifies the role as seller.
*/
public const PAUSE_ROLE_SELLER = 'SELLER';
/**
* The reason for the pausing of the deal; empty for active deals.
*
* @var string
*/
public $pauseReason;
/**
* The party that first paused the deal; unspecified for active deals.
*
* @var string
*/
public $pauseRole;
/**
* Whether pausing is consented between buyer and seller for the deal.
*
* @var bool
*/
public $pausingConsented;
/**
* The reason for the pausing of the deal; empty for active deals.
*
* @param string $pauseReason
*/
public function setPauseReason($pauseReason)
{
$this->pauseReason = $pauseReason;
}
/**
* @return string
*/
public function getPauseReason()
{
return $this->pauseReason;
}
/**
* The party that first paused the deal; unspecified for active deals.
*
* Accepted values: BUYER_SELLER_ROLE_UNSPECIFIED, BUYER, SELLER
*
* @param self::PAUSE_ROLE_* $pauseRole
*/
public function setPauseRole($pauseRole)
{
$this->pauseRole = $pauseRole;
}
/**
* @return self::PAUSE_ROLE_*
*/
public function getPauseRole()
{
return $this->pauseRole;
}
/**
* Whether pausing is consented between buyer and seller for the deal.
*
* @param bool $pausingConsented
*/
public function setPausingConsented($pausingConsented)
{
$this->pausingConsented = $pausingConsented;
}
/**
* @return bool
*/
public function getPausingConsented()
{
return $this->pausingConsented;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DealPausingInfo::class, 'Google_Service_AuthorizedBuyersMarketplace_DealPausingInfo');
@@ -0,0 +1,234 @@
<?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\AuthorizedBuyersMarketplace;
class DeliveryControl extends \Google\Collection
{
/**
* A placeholder for an unspecified companion delivery type.
*/
public const COMPANION_DELIVERY_TYPE_COMPANION_DELIVERY_TYPE_UNSPECIFIED = 'COMPANION_DELIVERY_TYPE_UNSPECIFIED';
/**
* Companions are not required to serve a creative set. The creative set can
* serve an inventory that has zero or more matching companions.
*/
public const COMPANION_DELIVERY_TYPE_DELIVERY_OPTIONAL = 'DELIVERY_OPTIONAL';
/**
* At least one companion must be served in order for the creative set to be
* used.
*/
public const COMPANION_DELIVERY_TYPE_DELIVERY_AT_LEAST_ONE = 'DELIVERY_AT_LEAST_ONE';
/**
* All companions in the set must be served in order for the creative set to
* be used. This can still serve to inventory that has more companions than
* can be filled.
*/
public const COMPANION_DELIVERY_TYPE_DELIVERY_ALL = 'DELIVERY_ALL';
/**
* Creatives are displayed roughly the same number of times over the duration
* of the deal.
*/
public const CREATIVE_ROTATION_TYPE_CREATIVE_ROTATION_TYPE_UNSPECIFIED = 'CREATIVE_ROTATION_TYPE_UNSPECIFIED';
/**
* Creatives are displayed roughly the same number of times over the duration
* of the deal.
*/
public const CREATIVE_ROTATION_TYPE_ROTATION_EVEN = 'ROTATION_EVEN';
/**
* Creatives are served roughly proportionally to their performance.
*/
public const CREATIVE_ROTATION_TYPE_ROTATION_OPTIMIZED = 'ROTATION_OPTIMIZED';
/**
* Creatives are served roughly proportionally to their weights.
*/
public const CREATIVE_ROTATION_TYPE_ROTATION_MANUAL = 'ROTATION_MANUAL';
/**
* Creatives are served exactly in sequential order, also known as
* Storyboarding.
*/
public const CREATIVE_ROTATION_TYPE_ROTATION_SEQUENTIAL = 'ROTATION_SEQUENTIAL';
/**
* A placeholder for an undefined delivery rate type.
*/
public const DELIVERY_RATE_TYPE_DELIVERY_RATE_TYPE_UNSPECIFIED = 'DELIVERY_RATE_TYPE_UNSPECIFIED';
/**
* Impressions are served uniformly over the life of the deal.
*/
public const DELIVERY_RATE_TYPE_EVENLY = 'EVENLY';
/**
* Impressions are served front-loaded.
*/
public const DELIVERY_RATE_TYPE_FRONT_LOADED = 'FRONT_LOADED';
/**
* Impressions are served as fast as possible.
*/
public const DELIVERY_RATE_TYPE_AS_FAST_AS_POSSIBLE = 'AS_FAST_AS_POSSIBLE';
/**
* A placeholder for an unspecified roadblocking type.
*/
public const ROADBLOCKING_TYPE_ROADBLOCKING_TYPE_UNSPECIFIED = 'ROADBLOCKING_TYPE_UNSPECIFIED';
/**
* Only one creative from a deal can serve per ad request.
* https://support.google.com/admanager/answer/177277.
*/
public const ROADBLOCKING_TYPE_ONLY_ONE = 'ONLY_ONE';
/**
* Any number of creatives from a deal can serve together per ad request.
*/
public const ROADBLOCKING_TYPE_ONE_OR_MORE = 'ONE_OR_MORE';
/**
* As many creatives from a deal as can fit on a page will serve. This could
* mean anywhere from one to all of a deal's creatives given the size
* constraints of ad slots on a page.
*/
public const ROADBLOCKING_TYPE_AS_MANY_AS_POSSIBLE = 'AS_MANY_AS_POSSIBLE';
/**
* All or none of the creatives from a deal will serve.
*/
public const ROADBLOCKING_TYPE_ALL_ROADBLOCK = 'ALL_ROADBLOCK';
/**
* A main/companion creative set roadblocking type.
*/
public const ROADBLOCKING_TYPE_CREATIVE_SET = 'CREATIVE_SET';
protected $collection_key = 'frequencyCap';
/**
* Output only. Specifies roadblocking in a main companion lineitem.
*
* @var string
*/
public $companionDeliveryType;
/**
* Output only. Specifies strategy to use for selecting a creative when
* multiple creatives of the same size are available.
*
* @var string
*/
public $creativeRotationType;
/**
* Output only. Specifies how the impression delivery will be paced.
*
* @var string
*/
public $deliveryRateType;
protected $frequencyCapType = FrequencyCap::class;
protected $frequencyCapDataType = 'array';
/**
* Output only. Specifies the roadblocking type in display creatives.
*
* @var string
*/
public $roadblockingType;
/**
* Output only. Specifies roadblocking in a main companion lineitem.
*
* Accepted values: COMPANION_DELIVERY_TYPE_UNSPECIFIED, DELIVERY_OPTIONAL,
* DELIVERY_AT_LEAST_ONE, DELIVERY_ALL
*
* @param self::COMPANION_DELIVERY_TYPE_* $companionDeliveryType
*/
public function setCompanionDeliveryType($companionDeliveryType)
{
$this->companionDeliveryType = $companionDeliveryType;
}
/**
* @return self::COMPANION_DELIVERY_TYPE_*
*/
public function getCompanionDeliveryType()
{
return $this->companionDeliveryType;
}
/**
* Output only. Specifies strategy to use for selecting a creative when
* multiple creatives of the same size are available.
*
* Accepted values: CREATIVE_ROTATION_TYPE_UNSPECIFIED, ROTATION_EVEN,
* ROTATION_OPTIMIZED, ROTATION_MANUAL, ROTATION_SEQUENTIAL
*
* @param self::CREATIVE_ROTATION_TYPE_* $creativeRotationType
*/
public function setCreativeRotationType($creativeRotationType)
{
$this->creativeRotationType = $creativeRotationType;
}
/**
* @return self::CREATIVE_ROTATION_TYPE_*
*/
public function getCreativeRotationType()
{
return $this->creativeRotationType;
}
/**
* Output only. Specifies how the impression delivery will be paced.
*
* Accepted values: DELIVERY_RATE_TYPE_UNSPECIFIED, EVENLY, FRONT_LOADED,
* AS_FAST_AS_POSSIBLE
*
* @param self::DELIVERY_RATE_TYPE_* $deliveryRateType
*/
public function setDeliveryRateType($deliveryRateType)
{
$this->deliveryRateType = $deliveryRateType;
}
/**
* @return self::DELIVERY_RATE_TYPE_*
*/
public function getDeliveryRateType()
{
return $this->deliveryRateType;
}
/**
* Output only. Specifies any frequency caps. Cannot be filtered within
* ListDealsRequest.
*
* @param FrequencyCap[] $frequencyCap
*/
public function setFrequencyCap($frequencyCap)
{
$this->frequencyCap = $frequencyCap;
}
/**
* @return FrequencyCap[]
*/
public function getFrequencyCap()
{
return $this->frequencyCap;
}
/**
* Output only. Specifies the roadblocking type in display creatives.
*
* Accepted values: ROADBLOCKING_TYPE_UNSPECIFIED, ONLY_ONE, ONE_OR_MORE,
* AS_MANY_AS_POSSIBLE, ALL_ROADBLOCK, CREATIVE_SET
*
* @param self::ROADBLOCKING_TYPE_* $roadblockingType
*/
public function setRoadblockingType($roadblockingType)
{
$this->roadblockingType = $roadblockingType;
}
/**
* @return self::ROADBLOCKING_TYPE_*
*/
public function getRoadblockingType()
{
return $this->roadblockingType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeliveryControl::class, 'Google_Service_AuthorizedBuyersMarketplace_DeliveryControl');
@@ -0,0 +1,173 @@
<?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\AuthorizedBuyersMarketplace;
class FinalizedDeal extends \Google\Model
{
/**
* Unspecified.
*/
public const DEAL_SERVING_STATUS_DEAL_SERVING_STATUS_UNSPECIFIED = 'DEAL_SERVING_STATUS_UNSPECIFIED';
/**
* The deal is actively serving or ready to serve when the start date is
* reached.
*/
public const DEAL_SERVING_STATUS_ACTIVE = 'ACTIVE';
/**
* The deal serving has ended.
*/
public const DEAL_SERVING_STATUS_ENDED = 'ENDED';
/**
* The deal serving is paused by buyer.
*/
public const DEAL_SERVING_STATUS_PAUSED_BY_BUYER = 'PAUSED_BY_BUYER';
/**
* The deal serving is paused by seller.
*/
public const DEAL_SERVING_STATUS_PAUSED_BY_SELLER = 'PAUSED_BY_SELLER';
protected $dealType = Deal::class;
protected $dealDataType = '';
protected $dealPausingInfoType = DealPausingInfo::class;
protected $dealPausingInfoDataType = '';
/**
* Serving status of the deal.
*
* @var string
*/
public $dealServingStatus;
/**
* The resource name of the finalized deal. Format:
* `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
*
* @var string
*/
public $name;
/**
* Whether the Programmatic Guaranteed deal is ready for serving.
*
* @var bool
*/
public $readyToServe;
protected $rtbMetricsType = RtbMetrics::class;
protected $rtbMetricsDataType = '';
/**
* A copy of the Deal made upon finalization. During renegotiation, this will
* reflect the last finalized deal before renegotiation was initiated.
*
* @param Deal $deal
*/
public function setDeal(Deal $deal)
{
$this->deal = $deal;
}
/**
* @return Deal
*/
public function getDeal()
{
return $this->deal;
}
/**
* Information related to deal pausing for the deal.
*
* @param DealPausingInfo $dealPausingInfo
*/
public function setDealPausingInfo(DealPausingInfo $dealPausingInfo)
{
$this->dealPausingInfo = $dealPausingInfo;
}
/**
* @return DealPausingInfo
*/
public function getDealPausingInfo()
{
return $this->dealPausingInfo;
}
/**
* Serving status of the deal.
*
* Accepted values: DEAL_SERVING_STATUS_UNSPECIFIED, ACTIVE, ENDED,
* PAUSED_BY_BUYER, PAUSED_BY_SELLER
*
* @param self::DEAL_SERVING_STATUS_* $dealServingStatus
*/
public function setDealServingStatus($dealServingStatus)
{
$this->dealServingStatus = $dealServingStatus;
}
/**
* @return self::DEAL_SERVING_STATUS_*
*/
public function getDealServingStatus()
{
return $this->dealServingStatus;
}
/**
* The resource name of the finalized deal. Format:
* `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Whether the Programmatic Guaranteed deal is ready for serving.
*
* @param bool $readyToServe
*/
public function setReadyToServe($readyToServe)
{
$this->readyToServe = $readyToServe;
}
/**
* @return bool
*/
public function getReadyToServe()
{
return $this->readyToServe;
}
/**
* Real-time bidding metrics for this deal.
*
* @param RtbMetrics $rtbMetrics
*/
public function setRtbMetrics(RtbMetrics $rtbMetrics)
{
$this->rtbMetrics = $rtbMetrics;
}
/**
* @return RtbMetrics
*/
public function getRtbMetrics()
{
return $this->rtbMetrics;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FinalizedDeal::class, 'Google_Service_AuthorizedBuyersMarketplace_FinalizedDeal');
@@ -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\AuthorizedBuyersMarketplace;
class FirstPartyMobileApplicationTargeting extends \Google\Collection
{
protected $collection_key = 'targetedAppIds';
/**
* A list of application IDs to be excluded.
*
* @var string[]
*/
public $excludedAppIds;
/**
* A list of application IDs to be included.
*
* @var string[]
*/
public $targetedAppIds;
/**
* A list of application IDs to be excluded.
*
* @param string[] $excludedAppIds
*/
public function setExcludedAppIds($excludedAppIds)
{
$this->excludedAppIds = $excludedAppIds;
}
/**
* @return string[]
*/
public function getExcludedAppIds()
{
return $this->excludedAppIds;
}
/**
* A list of application IDs to be included.
*
* @param string[] $targetedAppIds
*/
public function setTargetedAppIds($targetedAppIds)
{
$this->targetedAppIds = $targetedAppIds;
}
/**
* @return string[]
*/
public function getTargetedAppIds()
{
return $this->targetedAppIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FirstPartyMobileApplicationTargeting::class, 'Google_Service_AuthorizedBuyersMarketplace_FirstPartyMobileApplicationTargeting');
@@ -0,0 +1,138 @@
<?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\AuthorizedBuyersMarketplace;
class FrequencyCap extends \Google\Model
{
/**
* A placeholder for an undefined time unit type. This just indicates the
* variable with this value hasn't been initialized.
*/
public const TIME_UNIT_TYPE_TIME_UNIT_TYPE_UNSPECIFIED = 'TIME_UNIT_TYPE_UNSPECIFIED';
/**
* Minute unit.
*/
public const TIME_UNIT_TYPE_MINUTE = 'MINUTE';
/**
* Hour unit.
*/
public const TIME_UNIT_TYPE_HOUR = 'HOUR';
/**
* Day unit.
*/
public const TIME_UNIT_TYPE_DAY = 'DAY';
/**
* Week unit.
*/
public const TIME_UNIT_TYPE_WEEK = 'WEEK';
/**
* Month unit.
*/
public const TIME_UNIT_TYPE_MONTH = 'MONTH';
/**
* Lifecycle/Lifetime unit.
*/
public const TIME_UNIT_TYPE_LIFETIME = 'LIFETIME';
/**
* Pod unit.
*/
public const TIME_UNIT_TYPE_POD = 'POD';
/**
* Stream unit.
*/
public const TIME_UNIT_TYPE_STREAM = 'STREAM';
/**
* The maximum number of impressions that can be served to a user within the
* specified time period.
*
* @var int
*/
public $maxImpressions;
/**
* The time unit. Along with num_time_units defines the amount of time over
* which impressions per user are counted and capped.
*
* @var string
*/
public $timeUnitType;
/**
* The amount of time, in the units specified by time_unit_type. Defines the
* amount of time over which impressions per user are counted and capped.
*
* @var int
*/
public $timeUnitsCount;
/**
* The maximum number of impressions that can be served to a user within the
* specified time period.
*
* @param int $maxImpressions
*/
public function setMaxImpressions($maxImpressions)
{
$this->maxImpressions = $maxImpressions;
}
/**
* @return int
*/
public function getMaxImpressions()
{
return $this->maxImpressions;
}
/**
* The time unit. Along with num_time_units defines the amount of time over
* which impressions per user are counted and capped.
*
* Accepted values: TIME_UNIT_TYPE_UNSPECIFIED, MINUTE, HOUR, DAY, WEEK,
* MONTH, LIFETIME, POD, STREAM
*
* @param self::TIME_UNIT_TYPE_* $timeUnitType
*/
public function setTimeUnitType($timeUnitType)
{
$this->timeUnitType = $timeUnitType;
}
/**
* @return self::TIME_UNIT_TYPE_*
*/
public function getTimeUnitType()
{
return $this->timeUnitType;
}
/**
* The amount of time, in the units specified by time_unit_type. Defines the
* amount of time over which impressions per user are counted and capped.
*
* @param int $timeUnitsCount
*/
public function setTimeUnitsCount($timeUnitsCount)
{
$this->timeUnitsCount = $timeUnitsCount;
}
/**
* @return int
*/
public function getTimeUnitsCount()
{
return $this->timeUnitsCount;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FrequencyCap::class, 'Google_Service_AuthorizedBuyersMarketplace_FrequencyCap');
@@ -0,0 +1,63 @@
<?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\AuthorizedBuyersMarketplace;
class InventorySizeTargeting extends \Google\Collection
{
protected $collection_key = 'targetedInventorySizes';
protected $excludedInventorySizesType = AdSize::class;
protected $excludedInventorySizesDataType = 'array';
protected $targetedInventorySizesType = AdSize::class;
protected $targetedInventorySizesDataType = 'array';
/**
* A list of inventory sizes to be excluded.
*
* @param AdSize[] $excludedInventorySizes
*/
public function setExcludedInventorySizes($excludedInventorySizes)
{
$this->excludedInventorySizes = $excludedInventorySizes;
}
/**
* @return AdSize[]
*/
public function getExcludedInventorySizes()
{
return $this->excludedInventorySizes;
}
/**
* A list of inventory sizes to be included.
*
* @param AdSize[] $targetedInventorySizes
*/
public function setTargetedInventorySizes($targetedInventorySizes)
{
$this->targetedInventorySizes = $targetedInventorySizes;
}
/**
* @return AdSize[]
*/
public function getTargetedInventorySizes()
{
return $this->targetedInventorySizes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InventorySizeTargeting::class, 'Google_Service_AuthorizedBuyersMarketplace_InventorySizeTargeting');
@@ -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\AuthorizedBuyersMarketplace;
class InventoryTypeTargeting extends \Google\Collection
{
protected $collection_key = 'inventoryTypes';
/**
* The list of targeted inventory types for the bid request.
*
* @var string[]
*/
public $inventoryTypes;
/**
* The list of targeted inventory types for the bid request.
*
* @param string[] $inventoryTypes
*/
public function setInventoryTypes($inventoryTypes)
{
$this->inventoryTypes = $inventoryTypes;
}
/**
* @return string[]
*/
public function getInventoryTypes()
{
return $this->inventoryTypes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(InventoryTypeTargeting::class, 'Google_Service_AuthorizedBuyersMarketplace_InventoryTypeTargeting');
@@ -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\AuthorizedBuyersMarketplace;
class ListAuctionPackagesResponse extends \Google\Collection
{
protected $collection_key = 'auctionPackages';
protected $auctionPackagesType = AuctionPackage::class;
protected $auctionPackagesDataType = 'array';
/**
* Continuation token for fetching the next page of results. Pass this value
* in the ListAuctionPackagesRequest.pageToken field in the subsequent call to
* the `ListAuctionPackages` method to retrieve the next page of results.
*
* @var string
*/
public $nextPageToken;
/**
* The list of auction packages.
*
* @param AuctionPackage[] $auctionPackages
*/
public function setAuctionPackages($auctionPackages)
{
$this->auctionPackages = $auctionPackages;
}
/**
* @return AuctionPackage[]
*/
public function getAuctionPackages()
{
return $this->auctionPackages;
}
/**
* Continuation token for fetching the next page of results. Pass this value
* in the ListAuctionPackagesRequest.pageToken field in the subsequent call to
* the `ListAuctionPackages` 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(ListAuctionPackagesResponse::class, 'Google_Service_AuthorizedBuyersMarketplace_ListAuctionPackagesResponse');
@@ -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\AuthorizedBuyersMarketplace;
class ListClientUsersResponse extends \Google\Collection
{
protected $collection_key = 'clientUsers';
protected $clientUsersType = ClientUser::class;
protected $clientUsersDataType = 'array';
/**
* A token to retrieve the next page of results. Pass this value in the
* ListClientUsersRequest.pageToken field in the subsequent call to the list
* method to retrieve the next page of results.
*
* @var string
*/
public $nextPageToken;
/**
* The returned list of client users.
*
* @param ClientUser[] $clientUsers
*/
public function setClientUsers($clientUsers)
{
$this->clientUsers = $clientUsers;
}
/**
* @return ClientUser[]
*/
public function getClientUsers()
{
return $this->clientUsers;
}
/**
* A token to retrieve the next page of results. Pass this value in the
* ListClientUsersRequest.pageToken field in the subsequent call to the list
* 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(ListClientUsersResponse::class, 'Google_Service_AuthorizedBuyersMarketplace_ListClientUsersResponse');
@@ -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\AuthorizedBuyersMarketplace;
class ListClientsResponse extends \Google\Collection
{
protected $collection_key = 'clients';
protected $clientsType = Client::class;
protected $clientsDataType = 'array';
/**
* A token to retrieve the next page of results. Pass this value in the
* ListClientsRequest.pageToken field in the subsequent call to the list
* method to retrieve the next page of results.
*
* @var string
*/
public $nextPageToken;
/**
* The returned list of clients.
*
* @param Client[] $clients
*/
public function setClients($clients)
{
$this->clients = $clients;
}
/**
* @return Client[]
*/
public function getClients()
{
return $this->clients;
}
/**
* A token to retrieve the next page of results. Pass this value in the
* ListClientsRequest.pageToken field in the subsequent call to the list
* 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(ListClientsResponse::class, 'Google_Service_AuthorizedBuyersMarketplace_ListClientsResponse');
@@ -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\AuthorizedBuyersMarketplace;
class ListDealsResponse extends \Google\Collection
{
protected $collection_key = 'deals';
protected $dealsType = Deal::class;
protected $dealsDataType = 'array';
/**
* Token to fetch the next page of results.
*
* @var string
*/
public $nextPageToken;
/**
* The list of deals.
*
* @param Deal[] $deals
*/
public function setDeals($deals)
{
$this->deals = $deals;
}
/**
* @return Deal[]
*/
public function getDeals()
{
return $this->deals;
}
/**
* Token to fetch 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(ListDealsResponse::class, 'Google_Service_AuthorizedBuyersMarketplace_ListDealsResponse');
@@ -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\AuthorizedBuyersMarketplace;
class ListFinalizedDealsResponse extends \Google\Collection
{
protected $collection_key = 'finalizedDeals';
protected $finalizedDealsType = FinalizedDeal::class;
protected $finalizedDealsDataType = 'array';
/**
* Token to fetch the next page of results.
*
* @var string
*/
public $nextPageToken;
/**
* The list of finalized deals.
*
* @param FinalizedDeal[] $finalizedDeals
*/
public function setFinalizedDeals($finalizedDeals)
{
$this->finalizedDeals = $finalizedDeals;
}
/**
* @return FinalizedDeal[]
*/
public function getFinalizedDeals()
{
return $this->finalizedDeals;
}
/**
* Token to fetch 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(ListFinalizedDealsResponse::class, 'Google_Service_AuthorizedBuyersMarketplace_ListFinalizedDealsResponse');
@@ -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\AuthorizedBuyersMarketplace;
class ListProposalsResponse extends \Google\Collection
{
protected $collection_key = 'proposals';
/**
* Continuation token for fetching the next page of results.
*
* @var string
*/
public $nextPageToken;
protected $proposalsType = Proposal::class;
protected $proposalsDataType = 'array';
/**
* Continuation token for fetching 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 proposals.
*
* @param Proposal[] $proposals
*/
public function setProposals($proposals)
{
$this->proposals = $proposals;
}
/**
* @return Proposal[]
*/
public function getProposals()
{
return $this->proposals;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListProposalsResponse::class, 'Google_Service_AuthorizedBuyersMarketplace_ListProposalsResponse');
@@ -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\AuthorizedBuyersMarketplace;
class ListPublisherProfilesResponse extends \Google\Collection
{
protected $collection_key = 'publisherProfiles';
/**
* Token to fetch the next page of results.
*
* @var string
*/
public $nextPageToken;
protected $publisherProfilesType = PublisherProfile::class;
protected $publisherProfilesDataType = 'array';
/**
* Token to fetch 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 matching publisher profiles.
*
* @param PublisherProfile[] $publisherProfiles
*/
public function setPublisherProfiles($publisherProfiles)
{
$this->publisherProfiles = $publisherProfiles;
}
/**
* @return PublisherProfile[]
*/
public function getPublisherProfiles()
{
return $this->publisherProfiles;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListPublisherProfilesResponse::class, 'Google_Service_AuthorizedBuyersMarketplace_ListPublisherProfilesResponse');
@@ -0,0 +1,220 @@
<?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\AuthorizedBuyersMarketplace;
class MarketplaceTargeting extends \Google\Collection
{
protected $collection_key = 'excludedSensitiveCategoryIds';
protected $daypartTargetingType = DayPartTargeting::class;
protected $daypartTargetingDataType = '';
/**
* Output only. The sensitive content category label IDs excluded. Refer to
* this file https://storage.googleapis.com/adx-rtb-dictionaries/content-
* labels.txt for category IDs.
*
* @var string[]
*/
public $excludedSensitiveCategoryIds;
protected $geoTargetingType = CriteriaTargeting::class;
protected $geoTargetingDataType = '';
protected $inventorySizeTargetingType = InventorySizeTargeting::class;
protected $inventorySizeTargetingDataType = '';
protected $inventoryTypeTargetingType = InventoryTypeTargeting::class;
protected $inventoryTypeTargetingDataType = '';
protected $placementTargetingType = PlacementTargeting::class;
protected $placementTargetingDataType = '';
protected $technologyTargetingType = TechnologyTargeting::class;
protected $technologyTargetingDataType = '';
protected $userListTargetingType = CriteriaTargeting::class;
protected $userListTargetingDataType = '';
protected $verticalTargetingType = CriteriaTargeting::class;
protected $verticalTargetingDataType = '';
protected $videoTargetingType = VideoTargeting::class;
protected $videoTargetingDataType = '';
/**
* Daypart targeting information.
*
* @param DayPartTargeting $daypartTargeting
*/
public function setDaypartTargeting(DayPartTargeting $daypartTargeting)
{
$this->daypartTargeting = $daypartTargeting;
}
/**
* @return DayPartTargeting
*/
public function getDaypartTargeting()
{
return $this->daypartTargeting;
}
/**
* Output only. The sensitive content category label IDs excluded. Refer to
* this file https://storage.googleapis.com/adx-rtb-dictionaries/content-
* labels.txt for category IDs.
*
* @param string[] $excludedSensitiveCategoryIds
*/
public function setExcludedSensitiveCategoryIds($excludedSensitiveCategoryIds)
{
$this->excludedSensitiveCategoryIds = $excludedSensitiveCategoryIds;
}
/**
* @return string[]
*/
public function getExcludedSensitiveCategoryIds()
{
return $this->excludedSensitiveCategoryIds;
}
/**
* Output only. Geo criteria IDs to be included/excluded.
*
* @param CriteriaTargeting $geoTargeting
*/
public function setGeoTargeting(CriteriaTargeting $geoTargeting)
{
$this->geoTargeting = $geoTargeting;
}
/**
* @return CriteriaTargeting
*/
public function getGeoTargeting()
{
return $this->geoTargeting;
}
/**
* Output only. Inventory sizes to be included/excluded.
*
* @param InventorySizeTargeting $inventorySizeTargeting
*/
public function setInventorySizeTargeting(InventorySizeTargeting $inventorySizeTargeting)
{
$this->inventorySizeTargeting = $inventorySizeTargeting;
}
/**
* @return InventorySizeTargeting
*/
public function getInventorySizeTargeting()
{
return $this->inventorySizeTargeting;
}
/**
* Output only. Inventory type targeting information.
*
* @param InventoryTypeTargeting $inventoryTypeTargeting
*/
public function setInventoryTypeTargeting(InventoryTypeTargeting $inventoryTypeTargeting)
{
$this->inventoryTypeTargeting = $inventoryTypeTargeting;
}
/**
* @return InventoryTypeTargeting
*/
public function getInventoryTypeTargeting()
{
return $this->inventoryTypeTargeting;
}
/**
* Output only. Placement targeting information, for example, URL, mobile
* applications.
*
* @param PlacementTargeting $placementTargeting
*/
public function setPlacementTargeting(PlacementTargeting $placementTargeting)
{
$this->placementTargeting = $placementTargeting;
}
/**
* @return PlacementTargeting
*/
public function getPlacementTargeting()
{
return $this->placementTargeting;
}
/**
* Output only. Technology targeting information, for example, operating
* system, device category.
*
* @param TechnologyTargeting $technologyTargeting
*/
public function setTechnologyTargeting(TechnologyTargeting $technologyTargeting)
{
$this->technologyTargeting = $technologyTargeting;
}
/**
* @return TechnologyTargeting
*/
public function getTechnologyTargeting()
{
return $this->technologyTargeting;
}
/**
* Buyer user list targeting information. User lists can be uploaded using
* https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
*
* @param CriteriaTargeting $userListTargeting
*/
public function setUserListTargeting(CriteriaTargeting $userListTargeting)
{
$this->userListTargeting = $userListTargeting;
}
/**
* @return CriteriaTargeting
*/
public function getUserListTargeting()
{
return $this->userListTargeting;
}
/**
* Output only. The verticals included or excluded as defined in
* https://developers.google.com/authorized-buyers/rtb/downloads/publisher-
* verticals
*
* @param CriteriaTargeting $verticalTargeting
*/
public function setVerticalTargeting(CriteriaTargeting $verticalTargeting)
{
$this->verticalTargeting = $verticalTargeting;
}
/**
* @return CriteriaTargeting
*/
public function getVerticalTargeting()
{
return $this->verticalTargeting;
}
/**
* Output only. Video targeting information.
*
* @param VideoTargeting $videoTargeting
*/
public function setVideoTargeting(VideoTargeting $videoTargeting)
{
$this->videoTargeting = $videoTargeting;
}
/**
* @return VideoTargeting
*/
public function getVideoTargeting()
{
return $this->videoTargeting;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MarketplaceTargeting::class, 'Google_Service_AuthorizedBuyersMarketplace_MarketplaceTargeting');
@@ -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\AuthorizedBuyersMarketplace;
class MediaPlanner extends \Google\Collection
{
protected $collection_key = 'ancestorNames';
/**
* Output only. Account ID of the media planner.
*
* @deprecated
* @var string
*/
public $accountId;
/**
* Output only. The ancestor names of the media planner. Format:
* `mediaPlanners/{mediaPlannerAccountId}` Can be used to filter the response
* of the mediaPlanners.list method.
*
* @var string[]
*/
public $ancestorNames;
/**
* Output only. The display name of the media planner. Can be used to filter
* the response of the mediaPlanners.list method.
*
* @var string
*/
public $displayName;
/**
* Identifier. The unique resource name of the media planner. Format:
* `mediaPlanners/{mediaPlannerAccountId}` Can be used to filter the response
* of the mediaPlanners.list method.
*
* @var string
*/
public $name;
/**
* Output only. Account ID of the media planner.
*
* @deprecated
* @param string $accountId
*/
public function setAccountId($accountId)
{
$this->accountId = $accountId;
}
/**
* @deprecated
* @return string
*/
public function getAccountId()
{
return $this->accountId;
}
/**
* Output only. The ancestor names of the media planner. Format:
* `mediaPlanners/{mediaPlannerAccountId}` Can be used to filter the response
* of the mediaPlanners.list method.
*
* @param string[] $ancestorNames
*/
public function setAncestorNames($ancestorNames)
{
$this->ancestorNames = $ancestorNames;
}
/**
* @return string[]
*/
public function getAncestorNames()
{
return $this->ancestorNames;
}
/**
* Output only. The display name of the media planner. Can be used to filter
* the response of the mediaPlanners.list method.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Identifier. The unique resource name of the media planner. Format:
* `mediaPlanners/{mediaPlannerAccountId}` Can be used to filter the response
* of the mediaPlanners.list method.
*
* @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(MediaPlanner::class, 'Google_Service_AuthorizedBuyersMarketplace_MediaPlanner');
@@ -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\AuthorizedBuyersMarketplace;
class MobileApplicationTargeting extends \Google\Model
{
protected $firstPartyTargetingType = FirstPartyMobileApplicationTargeting::class;
protected $firstPartyTargetingDataType = '';
/**
* Publisher owned apps to be targeted or excluded by the publisher to display
* the ads in.
*
* @param FirstPartyMobileApplicationTargeting $firstPartyTargeting
*/
public function setFirstPartyTargeting(FirstPartyMobileApplicationTargeting $firstPartyTargeting)
{
$this->firstPartyTargeting = $firstPartyTargeting;
}
/**
* @return FirstPartyMobileApplicationTargeting
*/
public function getFirstPartyTargeting()
{
return $this->firstPartyTargeting;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MobileApplicationTargeting::class, 'Google_Service_AuthorizedBuyersMarketplace_MobileApplicationTargeting');
@@ -0,0 +1,104 @@
<?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\AuthorizedBuyersMarketplace;
class Money extends \Google\Model
{
/**
* The three-letter currency code defined in ISO 4217.
*
* @var string
*/
public $currencyCode;
/**
* Number of nano (10^-9) units of the amount. The value must be between
* -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos`
* must be positive or zero. If `units` is zero, `nanos` can be positive,
* zero, or negative. If `units` is negative, `nanos` must be negative or
* zero. For example $-1.75 is represented as `units`=-1 and
* `nanos`=-750,000,000.
*
* @var int
*/
public $nanos;
/**
* The whole units of the amount. For example if `currencyCode` is `"USD"`,
* then 1 unit is one US dollar.
*
* @var string
*/
public $units;
/**
* The three-letter currency code defined in ISO 4217.
*
* @param string $currencyCode
*/
public function setCurrencyCode($currencyCode)
{
$this->currencyCode = $currencyCode;
}
/**
* @return string
*/
public function getCurrencyCode()
{
return $this->currencyCode;
}
/**
* Number of nano (10^-9) units of the amount. The value must be between
* -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos`
* must be positive or zero. If `units` is zero, `nanos` can be positive,
* zero, or negative. If `units` is negative, `nanos` must be negative or
* zero. For example $-1.75 is represented as `units`=-1 and
* `nanos`=-750,000,000.
*
* @param int $nanos
*/
public function setNanos($nanos)
{
$this->nanos = $nanos;
}
/**
* @return int
*/
public function getNanos()
{
return $this->nanos;
}
/**
* The whole units of the amount. For example if `currencyCode` is `"USD"`,
* then 1 unit is one US dollar.
*
* @param string $units
*/
public function setUnits($units)
{
$this->units = $units;
}
/**
* @return string
*/
public function getUnits()
{
return $this->units;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Money::class, 'Google_Service_AuthorizedBuyersMarketplace_Money');
@@ -0,0 +1,106 @@
<?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\AuthorizedBuyersMarketplace;
class Note extends \Google\Model
{
/**
* A placeholder for an undefined buyer/seller role.
*/
public const CREATOR_ROLE_BUYER_SELLER_ROLE_UNSPECIFIED = 'BUYER_SELLER_ROLE_UNSPECIFIED';
/**
* Specifies the role as buyer.
*/
public const CREATOR_ROLE_BUYER = 'BUYER';
/**
* Specifies the role as seller.
*/
public const CREATOR_ROLE_SELLER = 'SELLER';
/**
* Output only. When this note was created.
*
* @var string
*/
public $createTime;
/**
* Output only. The role who created the note.
*
* @var string
*/
public $creatorRole;
/**
* The text of the note. Maximum length is 1024 characters.
*
* @var string
*/
public $note;
/**
* Output only. When this note was created.
*
* @param string $createTime
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* Output only. The role who created the note.
*
* Accepted values: BUYER_SELLER_ROLE_UNSPECIFIED, BUYER, SELLER
*
* @param self::CREATOR_ROLE_* $creatorRole
*/
public function setCreatorRole($creatorRole)
{
$this->creatorRole = $creatorRole;
}
/**
* @return self::CREATOR_ROLE_*
*/
public function getCreatorRole()
{
return $this->creatorRole;
}
/**
* The text of the note. Maximum length is 1024 characters.
*
* @param string $note
*/
public function setNote($note)
{
$this->note = $note;
}
/**
* @return string
*/
public function getNote()
{
return $this->note;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Note::class, 'Google_Service_AuthorizedBuyersMarketplace_Note');
@@ -0,0 +1,62 @@
<?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\AuthorizedBuyersMarketplace;
class OperatingSystemTargeting extends \Google\Model
{
protected $operatingSystemCriteriaType = CriteriaTargeting::class;
protected $operatingSystemCriteriaDataType = '';
protected $operatingSystemVersionCriteriaType = CriteriaTargeting::class;
protected $operatingSystemVersionCriteriaDataType = '';
/**
* IDs of operating systems to be included/excluded.
*
* @param CriteriaTargeting $operatingSystemCriteria
*/
public function setOperatingSystemCriteria(CriteriaTargeting $operatingSystemCriteria)
{
$this->operatingSystemCriteria = $operatingSystemCriteria;
}
/**
* @return CriteriaTargeting
*/
public function getOperatingSystemCriteria()
{
return $this->operatingSystemCriteria;
}
/**
* IDs of operating system versions to be included/excluded.
*
* @param CriteriaTargeting $operatingSystemVersionCriteria
*/
public function setOperatingSystemVersionCriteria(CriteriaTargeting $operatingSystemVersionCriteria)
{
$this->operatingSystemVersionCriteria = $operatingSystemVersionCriteria;
}
/**
* @return CriteriaTargeting
*/
public function getOperatingSystemVersionCriteria()
{
return $this->operatingSystemVersionCriteria;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(OperatingSystemTargeting::class, 'Google_Service_AuthorizedBuyersMarketplace_OperatingSystemTargeting');
@@ -0,0 +1,50 @@
<?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\AuthorizedBuyersMarketplace;
class PauseFinalizedDealRequest extends \Google\Model
{
/**
* The reason to pause the finalized deal, will be displayed to the seller.
* Maximum length is 1000 characters.
*
* @var string
*/
public $reason;
/**
* The reason to pause the finalized deal, will be displayed to the seller.
* Maximum length is 1000 characters.
*
* @param string $reason
*/
public function setReason($reason)
{
$this->reason = $reason;
}
/**
* @return string
*/
public function getReason()
{
return $this->reason;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PauseFinalizedDealRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_PauseFinalizedDealRequest');
@@ -0,0 +1,63 @@
<?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\AuthorizedBuyersMarketplace;
class PlacementTargeting extends \Google\Model
{
protected $mobileApplicationTargetingType = MobileApplicationTargeting::class;
protected $mobileApplicationTargetingDataType = '';
protected $uriTargetingType = UriTargeting::class;
protected $uriTargetingDataType = '';
/**
* Mobile application targeting information in a deal. This doesn't apply to
* Auction Packages.
*
* @param MobileApplicationTargeting $mobileApplicationTargeting
*/
public function setMobileApplicationTargeting(MobileApplicationTargeting $mobileApplicationTargeting)
{
$this->mobileApplicationTargeting = $mobileApplicationTargeting;
}
/**
* @return MobileApplicationTargeting
*/
public function getMobileApplicationTargeting()
{
return $this->mobileApplicationTargeting;
}
/**
* URLs to be included/excluded.
*
* @param UriTargeting $uriTargeting
*/
public function setUriTargeting(UriTargeting $uriTargeting)
{
$this->uriTargeting = $uriTargeting;
}
/**
* @return UriTargeting
*/
public function getUriTargeting()
{
return $this->uriTargeting;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PlacementTargeting::class, 'Google_Service_AuthorizedBuyersMarketplace_PlacementTargeting');
@@ -0,0 +1,44 @@
<?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\AuthorizedBuyersMarketplace;
class PreferredDealTerms extends \Google\Model
{
protected $fixedPriceType = Price::class;
protected $fixedPriceDataType = '';
/**
* Fixed price for the deal.
*
* @param Price $fixedPrice
*/
public function setFixedPrice(Price $fixedPrice)
{
$this->fixedPrice = $fixedPrice;
}
/**
* @return Price
*/
public function getFixedPrice()
{
return $this->fixedPrice;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PreferredDealTerms::class, 'Google_Service_AuthorizedBuyersMarketplace_PreferredDealTerms');
@@ -0,0 +1,81 @@
<?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\AuthorizedBuyersMarketplace;
class Price extends \Google\Model
{
/**
* A placeholder for an undefined pricing type. If the pricing type is
* unspecified, CPM will be used instead.
*/
public const TYPE_TYPE_UNSPECIFIED = 'TYPE_UNSPECIFIED';
/**
* Cost per thousand impressions.
*/
public const TYPE_CPM = 'CPM';
/**
* Cost per day.
*/
public const TYPE_CPD = 'CPD';
protected $amountType = Money::class;
protected $amountDataType = '';
/**
* The pricing type for the deal.
*
* @var string
*/
public $type;
/**
* The actual price with currency specified.
*
* @param Money $amount
*/
public function setAmount(Money $amount)
{
$this->amount = $amount;
}
/**
* @return Money
*/
public function getAmount()
{
return $this->amount;
}
/**
* The pricing type for the deal.
*
* Accepted values: TYPE_UNSPECIFIED, CPM, CPD
*
* @param self::TYPE_* $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return self::TYPE_*
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Price::class, 'Google_Service_AuthorizedBuyersMarketplace_Price');
@@ -0,0 +1,68 @@
<?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\AuthorizedBuyersMarketplace;
class PrivateAuctionTerms extends \Google\Model
{
protected $floorPriceType = Price::class;
protected $floorPriceDataType = '';
/**
* Output only. True if open auction buyers are allowed to compete with
* invited buyers in this private auction.
*
* @var bool
*/
public $openAuctionAllowed;
/**
* The minimum price buyer has to bid to compete in the private auction.
*
* @param Price $floorPrice
*/
public function setFloorPrice(Price $floorPrice)
{
$this->floorPrice = $floorPrice;
}
/**
* @return Price
*/
public function getFloorPrice()
{
return $this->floorPrice;
}
/**
* Output only. True if open auction buyers are allowed to compete with
* invited buyers in this private auction.
*
* @param bool $openAuctionAllowed
*/
public function setOpenAuctionAllowed($openAuctionAllowed)
{
$this->openAuctionAllowed = $openAuctionAllowed;
}
/**
* @return bool
*/
public function getOpenAuctionAllowed()
{
return $this->openAuctionAllowed;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PrivateAuctionTerms::class, 'Google_Service_AuthorizedBuyersMarketplace_PrivateAuctionTerms');
@@ -0,0 +1,50 @@
<?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\AuthorizedBuyersMarketplace;
class PrivateData extends \Google\Model
{
/**
* A buyer specified reference ID. This can be queried in the list operations
* (max-length: 1024 unicode code units).
*
* @var string
*/
public $referenceId;
/**
* A buyer specified reference ID. This can be queried in the list operations
* (max-length: 1024 unicode code units).
*
* @param string $referenceId
*/
public function setReferenceId($referenceId)
{
$this->referenceId = $referenceId;
}
/**
* @return string
*/
public function getReferenceId()
{
return $this->referenceId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PrivateData::class, 'Google_Service_AuthorizedBuyersMarketplace_PrivateData');
@@ -0,0 +1,184 @@
<?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\AuthorizedBuyersMarketplace;
class ProgrammaticGuaranteedTerms extends \Google\Model
{
/**
* An unspecified reservation type.
*/
public const RESERVATION_TYPE_RESERVATION_TYPE_UNSPECIFIED = 'RESERVATION_TYPE_UNSPECIFIED';
/**
* Non-sponsorship deal.
*/
public const RESERVATION_TYPE_STANDARD = 'STANDARD';
/**
* Sponsorship deals don't have impression goal (guaranteed_looks) and they
* are served based on the flight dates. For CPM Sponsorship deals,
* impression_cap is the lifetime impression limit.
*/
public const RESERVATION_TYPE_SPONSORSHIP = 'SPONSORSHIP';
protected $fixedPriceType = Price::class;
protected $fixedPriceDataType = '';
/**
* Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks
* will be ignored.
*
* @var string
*/
public $guaranteedLooks;
/**
* The lifetime impression cap for CPM Sponsorship deals. Deal will stop
* serving when cap is reached.
*
* @var string
*/
public $impressionCap;
/**
* Daily minimum looks for CPD deal types. For CPD deals, buyer should
* negotiate on this field instead of guaranteed_looks.
*
* @var string
*/
public $minimumDailyLooks;
/**
* For sponsorship deals, this is the percentage of the seller's eligible
* impressions that the deal will serve until the cap is reached. Valid value
* is within range 0~100.
*
* @var string
*/
public $percentShareOfVoice;
/**
* The reservation type for a Programmatic Guaranteed deal. This indicates
* whether the number of impressions is fixed, or a percent of available
* impressions. If not specified, the default reservation type is STANDARD.
*
* @var string
*/
public $reservationType;
/**
* Fixed price for the deal.
*
* @param Price $fixedPrice
*/
public function setFixedPrice(Price $fixedPrice)
{
$this->fixedPrice = $fixedPrice;
}
/**
* @return Price
*/
public function getFixedPrice()
{
return $this->fixedPrice;
}
/**
* Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks
* will be ignored.
*
* @param string $guaranteedLooks
*/
public function setGuaranteedLooks($guaranteedLooks)
{
$this->guaranteedLooks = $guaranteedLooks;
}
/**
* @return string
*/
public function getGuaranteedLooks()
{
return $this->guaranteedLooks;
}
/**
* The lifetime impression cap for CPM Sponsorship deals. Deal will stop
* serving when cap is reached.
*
* @param string $impressionCap
*/
public function setImpressionCap($impressionCap)
{
$this->impressionCap = $impressionCap;
}
/**
* @return string
*/
public function getImpressionCap()
{
return $this->impressionCap;
}
/**
* Daily minimum looks for CPD deal types. For CPD deals, buyer should
* negotiate on this field instead of guaranteed_looks.
*
* @param string $minimumDailyLooks
*/
public function setMinimumDailyLooks($minimumDailyLooks)
{
$this->minimumDailyLooks = $minimumDailyLooks;
}
/**
* @return string
*/
public function getMinimumDailyLooks()
{
return $this->minimumDailyLooks;
}
/**
* For sponsorship deals, this is the percentage of the seller's eligible
* impressions that the deal will serve until the cap is reached. Valid value
* is within range 0~100.
*
* @param string $percentShareOfVoice
*/
public function setPercentShareOfVoice($percentShareOfVoice)
{
$this->percentShareOfVoice = $percentShareOfVoice;
}
/**
* @return string
*/
public function getPercentShareOfVoice()
{
return $this->percentShareOfVoice;
}
/**
* The reservation type for a Programmatic Guaranteed deal. This indicates
* whether the number of impressions is fixed, or a percent of available
* impressions. If not specified, the default reservation type is STANDARD.
*
* Accepted values: RESERVATION_TYPE_UNSPECIFIED, STANDARD, SPONSORSHIP
*
* @param self::RESERVATION_TYPE_* $reservationType
*/
public function setReservationType($reservationType)
{
$this->reservationType = $reservationType;
}
/**
* @return self::RESERVATION_TYPE_*
*/
public function getReservationType()
{
return $this->reservationType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProgrammaticGuaranteedTerms::class, 'Google_Service_AuthorizedBuyersMarketplace_ProgrammaticGuaranteedTerms');
@@ -0,0 +1,547 @@
<?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\AuthorizedBuyersMarketplace;
class Proposal extends \Google\Collection
{
/**
* Default, unspecified deal type.
*/
public const DEAL_TYPE_DEAL_TYPE_UNSPECIFIED = 'DEAL_TYPE_UNSPECIFIED';
/**
* Preferred deals.
*/
public const DEAL_TYPE_PREFERRED_DEAL = 'PREFERRED_DEAL';
/**
* Private auction deals.
*/
public const DEAL_TYPE_PRIVATE_AUCTION = 'PRIVATE_AUCTION';
/**
* Programmatic guaranteed deals.
*/
public const DEAL_TYPE_PROGRAMMATIC_GUARANTEED = 'PROGRAMMATIC_GUARANTEED';
/**
* A placeholder for an undefined buyer/seller role.
*/
public const LAST_UPDATER_OR_COMMENTOR_ROLE_BUYER_SELLER_ROLE_UNSPECIFIED = 'BUYER_SELLER_ROLE_UNSPECIFIED';
/**
* Specifies the role as buyer.
*/
public const LAST_UPDATER_OR_COMMENTOR_ROLE_BUYER = 'BUYER';
/**
* Specifies the role as seller.
*/
public const LAST_UPDATER_OR_COMMENTOR_ROLE_SELLER = 'SELLER';
/**
* A placeholder for an undefined buyer/seller role.
*/
public const ORIGINATOR_ROLE_BUYER_SELLER_ROLE_UNSPECIFIED = 'BUYER_SELLER_ROLE_UNSPECIFIED';
/**
* Specifies the role as buyer.
*/
public const ORIGINATOR_ROLE_BUYER = 'BUYER';
/**
* Specifies the role as seller.
*/
public const ORIGINATOR_ROLE_SELLER = 'SELLER';
/**
* Unspecified proposal state
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* When a proposal is waiting for buyer to review.
*/
public const STATE_BUYER_REVIEW_REQUESTED = 'BUYER_REVIEW_REQUESTED';
/**
* When the proposal is waiting for the seller to review.
*/
public const STATE_SELLER_REVIEW_REQUESTED = 'SELLER_REVIEW_REQUESTED';
/**
* When the seller accepted the proposal and sent it to the buyer for review.
*/
public const STATE_BUYER_ACCEPTANCE_REQUESTED = 'BUYER_ACCEPTANCE_REQUESTED';
/**
* When both buyer and seller has accepted the proposal
*/
public const STATE_FINALIZED = 'FINALIZED';
/**
* When either buyer or seller has cancelled the proposal
*/
public const STATE_TERMINATED = 'TERMINATED';
protected $collection_key = 'sellerContacts';
/**
* Output only. When the client field is populated, this field refers to the
* buyer who creates and manages the client buyer and gets billed on behalf of
* the client buyer; when the buyer field is populated, this field is the same
* value as buyer. Format : `buyers/{buyerAccountId}`
*
* @var string
*/
public $billedBuyer;
/**
* Output only. Refers to a buyer in The Realtime-bidding API. Format:
* `buyers/{buyerAccountId}`
*
* @var string
*/
public $buyer;
protected $buyerContactsType = Contact::class;
protected $buyerContactsDataType = 'array';
protected $buyerPrivateDataType = PrivateData::class;
protected $buyerPrivateDataDataType = '';
/**
* Output only. Refers to a Client. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountid}`
*
* @var string
*/
public $client;
/**
* Output only. Type of deal the proposal contains.
*
* @var string
*/
public $dealType;
/**
* Output only. The descriptive name for the proposal. Maximum length of 255
* unicode characters is allowed. Control characters are not allowed. Buyers
* cannot update this field. Note: Not to be confused with name, which is a
* unique identifier of the proposal.
*
* @var string
*/
public $displayName;
/**
* Output only. True if the proposal was previously finalized and is now being
* renegotiated.
*
* @var bool
*/
public $isRenegotiating;
/**
* Output only. The role of the last user that either updated the proposal or
* left a comment.
*
* @var string
*/
public $lastUpdaterOrCommentorRole;
/**
* Immutable. The name of the proposal serving as a unique identifier. Format:
* buyers/{accountId}/proposals/{proposalId}
*
* @var string
*/
public $name;
protected $notesType = Note::class;
protected $notesDataType = 'array';
/**
* Output only. Indicates whether the buyer/seller created the proposal.
*
* @var string
*/
public $originatorRole;
/**
* Whether pausing is allowed for the proposal. This is a negotiable term
* between buyers and publishers.
*
* @var bool
*/
public $pausingConsented;
/**
* Output only. The revision number for the proposal. Each update to the
* proposal or deal causes the proposal revision number to auto-increment. The
* buyer keeps track of the last revision number they know of and pass it in
* when making an update. If the head revision number on the server has since
* incremented, then an ABORTED error is returned during the update operation
* to let the buyer know that a subsequent update was made.
*
* @var string
*/
public $proposalRevision;
/**
* Immutable. Reference to the seller on the proposal. Format:
* `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This
* field may be set only when creating the resource. Modifying this field
* while updating the resource will result in an error.
*
* @var string
*/
public $publisherProfile;
protected $sellerContactsType = Contact::class;
protected $sellerContactsDataType = 'array';
/**
* Output only. Indicates the state of the proposal.
*
* @var string
*/
public $state;
/**
* Output only. The terms and conditions associated with this proposal.
* Accepting a proposal implies acceptance of this field. This is created by
* the seller, the buyer can only view it.
*
* @var string
*/
public $termsAndConditions;
/**
* Output only. The time when the proposal was last revised.
*
* @var string
*/
public $updateTime;
/**
* Output only. When the client field is populated, this field refers to the
* buyer who creates and manages the client buyer and gets billed on behalf of
* the client buyer; when the buyer field is populated, this field is the same
* value as buyer. Format : `buyers/{buyerAccountId}`
*
* @param string $billedBuyer
*/
public function setBilledBuyer($billedBuyer)
{
$this->billedBuyer = $billedBuyer;
}
/**
* @return string
*/
public function getBilledBuyer()
{
return $this->billedBuyer;
}
/**
* Output only. Refers to a buyer in The Realtime-bidding API. Format:
* `buyers/{buyerAccountId}`
*
* @param string $buyer
*/
public function setBuyer($buyer)
{
$this->buyer = $buyer;
}
/**
* @return string
*/
public function getBuyer()
{
return $this->buyer;
}
/**
* Contact information for the buyer.
*
* @param Contact[] $buyerContacts
*/
public function setBuyerContacts($buyerContacts)
{
$this->buyerContacts = $buyerContacts;
}
/**
* @return Contact[]
*/
public function getBuyerContacts()
{
return $this->buyerContacts;
}
/**
* Buyer private data (hidden from seller).
*
* @param PrivateData $buyerPrivateData
*/
public function setBuyerPrivateData(PrivateData $buyerPrivateData)
{
$this->buyerPrivateData = $buyerPrivateData;
}
/**
* @return PrivateData
*/
public function getBuyerPrivateData()
{
return $this->buyerPrivateData;
}
/**
* Output only. Refers to a Client. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountid}`
*
* @param string $client
*/
public function setClient($client)
{
$this->client = $client;
}
/**
* @return string
*/
public function getClient()
{
return $this->client;
}
/**
* Output only. Type of deal the proposal contains.
*
* Accepted values: DEAL_TYPE_UNSPECIFIED, PREFERRED_DEAL, PRIVATE_AUCTION,
* PROGRAMMATIC_GUARANTEED
*
* @param self::DEAL_TYPE_* $dealType
*/
public function setDealType($dealType)
{
$this->dealType = $dealType;
}
/**
* @return self::DEAL_TYPE_*
*/
public function getDealType()
{
return $this->dealType;
}
/**
* Output only. The descriptive name for the proposal. Maximum length of 255
* unicode characters is allowed. Control characters are not allowed. Buyers
* cannot update this field. Note: Not to be confused with name, which is a
* unique identifier of the proposal.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Output only. True if the proposal was previously finalized and is now being
* renegotiated.
*
* @param bool $isRenegotiating
*/
public function setIsRenegotiating($isRenegotiating)
{
$this->isRenegotiating = $isRenegotiating;
}
/**
* @return bool
*/
public function getIsRenegotiating()
{
return $this->isRenegotiating;
}
/**
* Output only. The role of the last user that either updated the proposal or
* left a comment.
*
* Accepted values: BUYER_SELLER_ROLE_UNSPECIFIED, BUYER, SELLER
*
* @param self::LAST_UPDATER_OR_COMMENTOR_ROLE_* $lastUpdaterOrCommentorRole
*/
public function setLastUpdaterOrCommentorRole($lastUpdaterOrCommentorRole)
{
$this->lastUpdaterOrCommentorRole = $lastUpdaterOrCommentorRole;
}
/**
* @return self::LAST_UPDATER_OR_COMMENTOR_ROLE_*
*/
public function getLastUpdaterOrCommentorRole()
{
return $this->lastUpdaterOrCommentorRole;
}
/**
* Immutable. The name of the proposal serving as a unique identifier. Format:
* buyers/{accountId}/proposals/{proposalId}
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* A list of notes from the buyer and the seller attached to this proposal.
*
* @param Note[] $notes
*/
public function setNotes($notes)
{
$this->notes = $notes;
}
/**
* @return Note[]
*/
public function getNotes()
{
return $this->notes;
}
/**
* Output only. Indicates whether the buyer/seller created the proposal.
*
* Accepted values: BUYER_SELLER_ROLE_UNSPECIFIED, BUYER, SELLER
*
* @param self::ORIGINATOR_ROLE_* $originatorRole
*/
public function setOriginatorRole($originatorRole)
{
$this->originatorRole = $originatorRole;
}
/**
* @return self::ORIGINATOR_ROLE_*
*/
public function getOriginatorRole()
{
return $this->originatorRole;
}
/**
* Whether pausing is allowed for the proposal. This is a negotiable term
* between buyers and publishers.
*
* @param bool $pausingConsented
*/
public function setPausingConsented($pausingConsented)
{
$this->pausingConsented = $pausingConsented;
}
/**
* @return bool
*/
public function getPausingConsented()
{
return $this->pausingConsented;
}
/**
* Output only. The revision number for the proposal. Each update to the
* proposal or deal causes the proposal revision number to auto-increment. The
* buyer keeps track of the last revision number they know of and pass it in
* when making an update. If the head revision number on the server has since
* incremented, then an ABORTED error is returned during the update operation
* to let the buyer know that a subsequent update was made.
*
* @param string $proposalRevision
*/
public function setProposalRevision($proposalRevision)
{
$this->proposalRevision = $proposalRevision;
}
/**
* @return string
*/
public function getProposalRevision()
{
return $this->proposalRevision;
}
/**
* Immutable. Reference to the seller on the proposal. Format:
* `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This
* field may be set only when creating the resource. Modifying this field
* while updating the resource will result in an error.
*
* @param string $publisherProfile
*/
public function setPublisherProfile($publisherProfile)
{
$this->publisherProfile = $publisherProfile;
}
/**
* @return string
*/
public function getPublisherProfile()
{
return $this->publisherProfile;
}
/**
* Output only. Contact information for the seller.
*
* @param Contact[] $sellerContacts
*/
public function setSellerContacts($sellerContacts)
{
$this->sellerContacts = $sellerContacts;
}
/**
* @return Contact[]
*/
public function getSellerContacts()
{
return $this->sellerContacts;
}
/**
* Output only. Indicates the state of the proposal.
*
* Accepted values: STATE_UNSPECIFIED, BUYER_REVIEW_REQUESTED,
* SELLER_REVIEW_REQUESTED, BUYER_ACCEPTANCE_REQUESTED, FINALIZED, TERMINATED
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Output only. The terms and conditions associated with this proposal.
* Accepting a proposal implies acceptance of this field. This is created by
* the seller, the buyer can only view it.
*
* @param string $termsAndConditions
*/
public function setTermsAndConditions($termsAndConditions)
{
$this->termsAndConditions = $termsAndConditions;
}
/**
* @return string
*/
public function getTermsAndConditions()
{
return $this->termsAndConditions;
}
/**
* Output only. The time when the proposal was last revised.
*
* @param string $updateTime
*/
public function setUpdateTime($updateTime)
{
$this->updateTime = $updateTime;
}
/**
* @return string
*/
public function getUpdateTime()
{
return $this->updateTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Proposal::class, 'Google_Service_AuthorizedBuyersMarketplace_Proposal');
@@ -0,0 +1,396 @@
<?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\AuthorizedBuyersMarketplace;
class PublisherProfile extends \Google\Collection
{
protected $collection_key = 'topHeadlines';
/**
* Description on the publisher's audience.
*
* @var string
*/
public $audienceDescription;
/**
* Contact information for direct reservation deals. This is free text entered
* by the publisher and may include information like names, phone numbers and
* email addresses.
*
* @var string
*/
public $directDealsContact;
/**
* Display name of the publisher profile. Can be used to filter the response
* of the publisherProfiles.list method.
*
* @var string
*/
public $displayName;
/**
* The list of domains represented in this publisher profile. Empty if this is
* a parent profile. These are top private domains, meaning that these will
* not contain a string like "photos.google.co.uk/123", but will instead
* contain "google.co.uk". Can be used to filter the response of the
* publisherProfiles.list method.
*
* @var string[]
*/
public $domains;
/**
* Indicates if this profile is the parent profile of the seller. A parent
* profile represents all the inventory from the seller, as opposed to child
* profile that is created to brand a portion of inventory. One seller has
* only one parent publisher profile, and can have multiple child profiles.
* See https://support.google.com/admanager/answer/6035806 for details. Can be
* used to filter the response of the publisherProfiles.list method by setting
* the filter to "is_parent: true".
*
* @var bool
*/
public $isParent;
/**
* A Google public URL to the logo for this publisher profile. The logo is
* stored as a PNG, JPG, or GIF image.
*
* @var string
*/
public $logoUrl;
/**
* URL to additional marketing and sales materials.
*
* @var string
*/
public $mediaKitUrl;
protected $mobileAppsType = PublisherProfileMobileApplication::class;
protected $mobileAppsDataType = 'array';
/**
* Name of the publisher profile. Format:
* `buyers/{buyer}/publisherProfiles/{publisher_profile}`
*
* @var string
*/
public $name;
/**
* Overview of the publisher.
*
* @var string
*/
public $overview;
/**
* Statement explaining what's unique about publisher's business, and why
* buyers should partner with the publisher.
*
* @var string
*/
public $pitchStatement;
/**
* Contact information for programmatic deals. This is free text entered by
* the publisher and may include information like names, phone numbers and
* email addresses.
*
* @var string
*/
public $programmaticDealsContact;
/**
* A unique identifying code for the seller. This value is the same for all of
* the seller's parent and child publisher profiles. Can be used to filter the
* response of the publisherProfiles.list method.
*
* @var string
*/
public $publisherCode;
/**
* URL to a sample content page.
*
* @var string
*/
public $samplePageUrl;
/**
* Up to three key metrics and rankings. For example, "#1 Mobile News Site for
* 20 Straight Months".
*
* @var string[]
*/
public $topHeadlines;
/**
* Description on the publisher's audience.
*
* @param string $audienceDescription
*/
public function setAudienceDescription($audienceDescription)
{
$this->audienceDescription = $audienceDescription;
}
/**
* @return string
*/
public function getAudienceDescription()
{
return $this->audienceDescription;
}
/**
* Contact information for direct reservation deals. This is free text entered
* by the publisher and may include information like names, phone numbers and
* email addresses.
*
* @param string $directDealsContact
*/
public function setDirectDealsContact($directDealsContact)
{
$this->directDealsContact = $directDealsContact;
}
/**
* @return string
*/
public function getDirectDealsContact()
{
return $this->directDealsContact;
}
/**
* Display name of the publisher profile. Can be used to filter the response
* of the publisherProfiles.list method.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* The list of domains represented in this publisher profile. Empty if this is
* a parent profile. These are top private domains, meaning that these will
* not contain a string like "photos.google.co.uk/123", but will instead
* contain "google.co.uk". Can be used to filter the response of the
* publisherProfiles.list method.
*
* @param string[] $domains
*/
public function setDomains($domains)
{
$this->domains = $domains;
}
/**
* @return string[]
*/
public function getDomains()
{
return $this->domains;
}
/**
* Indicates if this profile is the parent profile of the seller. A parent
* profile represents all the inventory from the seller, as opposed to child
* profile that is created to brand a portion of inventory. One seller has
* only one parent publisher profile, and can have multiple child profiles.
* See https://support.google.com/admanager/answer/6035806 for details. Can be
* used to filter the response of the publisherProfiles.list method by setting
* the filter to "is_parent: true".
*
* @param bool $isParent
*/
public function setIsParent($isParent)
{
$this->isParent = $isParent;
}
/**
* @return bool
*/
public function getIsParent()
{
return $this->isParent;
}
/**
* A Google public URL to the logo for this publisher profile. The logo is
* stored as a PNG, JPG, or GIF image.
*
* @param string $logoUrl
*/
public function setLogoUrl($logoUrl)
{
$this->logoUrl = $logoUrl;
}
/**
* @return string
*/
public function getLogoUrl()
{
return $this->logoUrl;
}
/**
* URL to additional marketing and sales materials.
*
* @param string $mediaKitUrl
*/
public function setMediaKitUrl($mediaKitUrl)
{
$this->mediaKitUrl = $mediaKitUrl;
}
/**
* @return string
*/
public function getMediaKitUrl()
{
return $this->mediaKitUrl;
}
/**
* The list of apps represented in this publisher profile. Empty if this is a
* parent profile.
*
* @param PublisherProfileMobileApplication[] $mobileApps
*/
public function setMobileApps($mobileApps)
{
$this->mobileApps = $mobileApps;
}
/**
* @return PublisherProfileMobileApplication[]
*/
public function getMobileApps()
{
return $this->mobileApps;
}
/**
* Name of the publisher profile. Format:
* `buyers/{buyer}/publisherProfiles/{publisher_profile}`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Overview of the publisher.
*
* @param string $overview
*/
public function setOverview($overview)
{
$this->overview = $overview;
}
/**
* @return string
*/
public function getOverview()
{
return $this->overview;
}
/**
* Statement explaining what's unique about publisher's business, and why
* buyers should partner with the publisher.
*
* @param string $pitchStatement
*/
public function setPitchStatement($pitchStatement)
{
$this->pitchStatement = $pitchStatement;
}
/**
* @return string
*/
public function getPitchStatement()
{
return $this->pitchStatement;
}
/**
* Contact information for programmatic deals. This is free text entered by
* the publisher and may include information like names, phone numbers and
* email addresses.
*
* @param string $programmaticDealsContact
*/
public function setProgrammaticDealsContact($programmaticDealsContact)
{
$this->programmaticDealsContact = $programmaticDealsContact;
}
/**
* @return string
*/
public function getProgrammaticDealsContact()
{
return $this->programmaticDealsContact;
}
/**
* A unique identifying code for the seller. This value is the same for all of
* the seller's parent and child publisher profiles. Can be used to filter the
* response of the publisherProfiles.list method.
*
* @param string $publisherCode
*/
public function setPublisherCode($publisherCode)
{
$this->publisherCode = $publisherCode;
}
/**
* @return string
*/
public function getPublisherCode()
{
return $this->publisherCode;
}
/**
* URL to a sample content page.
*
* @param string $samplePageUrl
*/
public function setSamplePageUrl($samplePageUrl)
{
$this->samplePageUrl = $samplePageUrl;
}
/**
* @return string
*/
public function getSamplePageUrl()
{
return $this->samplePageUrl;
}
/**
* Up to three key metrics and rankings. For example, "#1 Mobile News Site for
* 20 Straight Months".
*
* @param string[] $topHeadlines
*/
public function setTopHeadlines($topHeadlines)
{
$this->topHeadlines = $topHeadlines;
}
/**
* @return string[]
*/
public function getTopHeadlines()
{
return $this->topHeadlines;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PublisherProfile::class, 'Google_Service_AuthorizedBuyersMarketplace_PublisherProfile');
@@ -0,0 +1,156 @@
<?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\AuthorizedBuyersMarketplace;
class PublisherProfileMobileApplication extends \Google\Model
{
/**
* A placeholder for an unknown app store.
*/
public const APP_STORE_APP_STORE_TYPE_UNSPECIFIED = 'APP_STORE_TYPE_UNSPECIFIED';
/**
* Apple iTunes
*/
public const APP_STORE_APPLE_ITUNES = 'APPLE_ITUNES';
/**
* Google Play
*/
public const APP_STORE_GOOGLE_PLAY = 'GOOGLE_PLAY';
/**
* Roku
*/
public const APP_STORE_ROKU = 'ROKU';
/**
* Amazon Fire TV
*/
public const APP_STORE_AMAZON_FIRE_TV = 'AMAZON_FIRE_TV';
/**
* PlayStation
*/
public const APP_STORE_PLAYSTATION = 'PLAYSTATION';
/**
* Xbox
*/
public const APP_STORE_XBOX = 'XBOX';
/**
* Samsung TV
*/
public const APP_STORE_SAMSUNG_TV = 'SAMSUNG_TV';
/**
* Amazon Appstore
*/
public const APP_STORE_AMAZON = 'AMAZON';
/**
* OPPO App Market
*/
public const APP_STORE_OPPO = 'OPPO';
/**
* Samsung Galaxy Store
*/
public const APP_STORE_SAMSUNG = 'SAMSUNG';
/**
* VIVO App Store
*/
public const APP_STORE_VIVO = 'VIVO';
/**
* Xiaomi GetApps
*/
public const APP_STORE_XIAOMI = 'XIAOMI';
/**
* LG TV
*/
public const APP_STORE_LG_TV = 'LG_TV';
/**
* The app store the app belongs to. Can be used to filter the response of the
* publisherProfiles.list method.
*
* @var string
*/
public $appStore;
/**
* The external ID for the app from its app store. Can be used to filter the
* response of the publisherProfiles.list method.
*
* @var string
*/
public $externalAppId;
/**
* The name of the app.
*
* @var string
*/
public $name;
/**
* The app store the app belongs to. Can be used to filter the response of the
* publisherProfiles.list method.
*
* Accepted values: APP_STORE_TYPE_UNSPECIFIED, APPLE_ITUNES, GOOGLE_PLAY,
* ROKU, AMAZON_FIRE_TV, PLAYSTATION, XBOX, SAMSUNG_TV, AMAZON, OPPO, SAMSUNG,
* VIVO, XIAOMI, LG_TV
*
* @param self::APP_STORE_* $appStore
*/
public function setAppStore($appStore)
{
$this->appStore = $appStore;
}
/**
* @return self::APP_STORE_*
*/
public function getAppStore()
{
return $this->appStore;
}
/**
* The external ID for the app from its app store. Can be used to filter the
* response of the publisherProfiles.list method.
*
* @param string $externalAppId
*/
public function setExternalAppId($externalAppId)
{
$this->externalAppId = $externalAppId;
}
/**
* @return string
*/
public function getExternalAppId()
{
return $this->externalAppId;
}
/**
* The name of the app.
*
* @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(PublisherProfileMobileApplication::class, 'Google_Service_AuthorizedBuyersMarketplace_PublisherProfileMobileApplication');
@@ -0,0 +1,33 @@
<?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\AuthorizedBuyersMarketplace\Resource;
/**
* The "bidders" collection of methods.
* Typical usage is:
* <code>
* $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
* $bidders = $authorizedbuyersmarketplaceService->bidders;
* </code>
*/
class Bidders extends \Google\Service\Resource
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Bidders::class, 'Google_Service_AuthorizedBuyersMarketplace_Resource_Bidders');
@@ -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\AuthorizedBuyersMarketplace\Resource;
use Google\Service\AuthorizedBuyersMarketplace\ListAuctionPackagesResponse;
/**
* The "auctionPackages" collection of methods.
* Typical usage is:
* <code>
* $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
* $auctionPackages = $authorizedbuyersmarketplaceService->bidders_auctionPackages;
* </code>
*/
class BiddersAuctionPackages extends \Google\Service\Resource
{
/**
* List the auction packages. Buyers can use the URL path
* "/v1/buyers/{accountId}/auctionPackages" to list auction packages for the
* current buyer and its clients. Bidders can use the URL path
* "/v1/bidders/{accountId}/auctionPackages" to list auction packages for the
* bidder, its media planners, its buyers, and all their clients.
* (auctionPackages.listBiddersAuctionPackages)
*
* @param string $parent Required. Name of the parent buyer that can access the
* auction package. Format: `buyers/{accountId}`. When used with a bidder
* account, the auction packages that the bidder, its media planners, its buyers
* and clients are subscribed to will be listed, in the format
* `bidders/{accountId}`.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Optional. Optional query string using the [Cloud API
* list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only
* supported when parent is bidder. Supported columns for filtering are: *
* displayName * createTime * updateTime * eligibleSeatIds
* @opt_param string orderBy Optional. An optional query string to sort auction
* packages using the [Cloud API sorting
* syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
* If no sort order is specified, results will be returned in an arbitrary
* order. Only supported when parent is bidder. Supported columns for sorting
* are: * displayName * createTime * updateTime
* @opt_param int pageSize Requested page size. The server may return fewer
* results than requested. Max allowed page size is 500.
* @opt_param string pageToken The page token as returned.
* ListAuctionPackagesResponse.nextPageToken
* @return ListAuctionPackagesResponse
* @throws \Google\Service\Exception
*/
public function listBiddersAuctionPackages($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListAuctionPackagesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BiddersAuctionPackages::class, 'Google_Service_AuthorizedBuyersMarketplace_Resource_BiddersAuctionPackages');
@@ -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\AuthorizedBuyersMarketplace\Resource;
use Google\Service\AuthorizedBuyersMarketplace\FinalizedDeal;
use Google\Service\AuthorizedBuyersMarketplace\ListFinalizedDealsResponse;
use Google\Service\AuthorizedBuyersMarketplace\SetReadyToServeRequest;
/**
* The "finalizedDeals" collection of methods.
* Typical usage is:
* <code>
* $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
* $finalizedDeals = $authorizedbuyersmarketplaceService->bidders_finalizedDeals;
* </code>
*/
class BiddersFinalizedDeals extends \Google\Service\Resource
{
/**
* Lists finalized deals. Use the URL path
* "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the
* current buyer and its clients. Bidders can use the URL path
* "/v1/bidders/{accountId}/finalizedDeals" to list finalized deals for the
* bidder, its buyers and all their clients.
* (finalizedDeals.listBiddersFinalizedDeals)
*
* @param string $parent Required. The buyer to list the finalized deals for, in
* the format: `buyers/{accountId}`. When used to list finalized deals for a
* bidder, its buyers and clients, in the format `bidders/{accountId}`.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Optional query string using the [Cloud API list
* filtering syntax](https://developers.google.com/authorized-
* buyers/apis/guides/list-filters) Supported columns for filtering are: *
* deal.displayName * deal.dealType * deal.createTime * deal.updateTime *
* deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds *
* dealServingStatus * readyToServe
* @opt_param string orderBy An optional query string to sort finalized deals
* using the [Cloud API sorting
* syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
* If no sort order is specified, results will be returned in an arbitrary
* order. Supported columns for sorting are: * deal.displayName *
* deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime
* * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days *
* rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days *
* rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth
* @opt_param int pageSize Requested page size. The server may return fewer
* results than requested. If requested more than 500, the server will return
* 500 results per page. If unspecified, the server will pick a default page
* size of 100.
* @opt_param string pageToken The page token as returned from
* ListFinalizedDealsResponse.
* @return ListFinalizedDealsResponse
* @throws \Google\Service\Exception
*/
public function listBiddersFinalizedDeals($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListFinalizedDealsResponse::class);
}
/**
* Sets the given finalized deal as ready to serve. By default, deals are set as
* ready to serve as soon as they're finalized. If you want to opt out of the
* default behavior, and manually indicate that deals are ready to serve, ask
* your Technical Account Manager to add you to the allowlist. If you choose to
* use this method, finalized deals belonging to the bidder and its child seats
* don't start serving until after you call `setReadyToServe`, and after the
* deals become active. For example, you can use this method to delay receiving
* bid requests until your creative is ready. In addition, bidders can use the
* URL path "/v1/bidders/{accountId}/finalizedDeals/{dealId}" to set ready to
* serve for the finalized deals belong to itself, its child seats and all their
* clients. This method only applies to programmatic guaranteed deals.
* (finalizedDeals.setReadyToServe)
*
* @param string $deal Required. Format:
* `buyers/{accountId}/finalizedDeals/{dealId}` or
* `bidders/{accountId}/finalizedDeals/{dealId}`
* @param SetReadyToServeRequest $postBody
* @param array $optParams Optional parameters.
* @return FinalizedDeal
* @throws \Google\Service\Exception
*/
public function setReadyToServe($deal, SetReadyToServeRequest $postBody, $optParams = [])
{
$params = ['deal' => $deal, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setReadyToServe', [$params], FinalizedDeal::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BiddersFinalizedDeals::class, 'Google_Service_AuthorizedBuyersMarketplace_Resource_BiddersFinalizedDeals');
@@ -0,0 +1,33 @@
<?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\AuthorizedBuyersMarketplace\Resource;
/**
* The "buyers" collection of methods.
* Typical usage is:
* <code>
* $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
* $buyers = $authorizedbuyersmarketplaceService->buyers;
* </code>
*/
class Buyers extends \Google\Service\Resource
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Buyers::class, 'Google_Service_AuthorizedBuyersMarketplace_Resource_Buyers');
@@ -0,0 +1,168 @@
<?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\AuthorizedBuyersMarketplace\Resource;
use Google\Service\AuthorizedBuyersMarketplace\AuctionPackage;
use Google\Service\AuthorizedBuyersMarketplace\ListAuctionPackagesResponse;
use Google\Service\AuthorizedBuyersMarketplace\SubscribeAuctionPackageRequest;
use Google\Service\AuthorizedBuyersMarketplace\SubscribeClientsRequest;
use Google\Service\AuthorizedBuyersMarketplace\UnsubscribeAuctionPackageRequest;
use Google\Service\AuthorizedBuyersMarketplace\UnsubscribeClientsRequest;
/**
* The "auctionPackages" collection of methods.
* Typical usage is:
* <code>
* $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
* $auctionPackages = $authorizedbuyersmarketplaceService->buyers_auctionPackages;
* </code>
*/
class BuyersAuctionPackages extends \Google\Service\Resource
{
/**
* Gets an auction package given its name. (auctionPackages.get)
*
* @param string $name Required. Name of auction package to get. Format:
* `buyers/{accountId}/auctionPackages/{auctionPackageId}`
* @param array $optParams Optional parameters.
* @return AuctionPackage
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], AuctionPackage::class);
}
/**
* List the auction packages. Buyers can use the URL path
* "/v1/buyers/{accountId}/auctionPackages" to list auction packages for the
* current buyer and its clients. Bidders can use the URL path
* "/v1/bidders/{accountId}/auctionPackages" to list auction packages for the
* bidder, its media planners, its buyers, and all their clients.
* (auctionPackages.listBuyersAuctionPackages)
*
* @param string $parent Required. Name of the parent buyer that can access the
* auction package. Format: `buyers/{accountId}`. When used with a bidder
* account, the auction packages that the bidder, its media planners, its buyers
* and clients are subscribed to will be listed, in the format
* `bidders/{accountId}`.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Optional. Optional query string using the [Cloud API
* list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only
* supported when parent is bidder. Supported columns for filtering are: *
* displayName * createTime * updateTime * eligibleSeatIds
* @opt_param string orderBy Optional. An optional query string to sort auction
* packages using the [Cloud API sorting
* syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
* If no sort order is specified, results will be returned in an arbitrary
* order. Only supported when parent is bidder. Supported columns for sorting
* are: * displayName * createTime * updateTime
* @opt_param int pageSize Requested page size. The server may return fewer
* results than requested. Max allowed page size is 500.
* @opt_param string pageToken The page token as returned.
* ListAuctionPackagesResponse.nextPageToken
* @return ListAuctionPackagesResponse
* @throws \Google\Service\Exception
*/
public function listBuyersAuctionPackages($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListAuctionPackagesResponse::class);
}
/**
* Subscribe to the auction package for the specified buyer. Once subscribed,
* the bidder will receive a call out for inventory matching the auction package
* targeting criteria with the auction package deal ID and the specified buyer.
* (auctionPackages.subscribe)
*
* @param string $name Required. Name of the auction package. Format:
* `buyers/{accountId}/auctionPackages/{auctionPackageId}`
* @param SubscribeAuctionPackageRequest $postBody
* @param array $optParams Optional parameters.
* @return AuctionPackage
* @throws \Google\Service\Exception
*/
public function subscribe($name, SubscribeAuctionPackageRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('subscribe', [$params], AuctionPackage::class);
}
/**
* Subscribe the specified clients of the buyer to the auction package. If a
* client in the list does not belong to the buyer, an error response will be
* returned, and all of the following clients in the list will not be
* subscribed. Subscribing an already subscribed client will have no effect.
* (auctionPackages.subscribeClients)
*
* @param string $auctionPackage Required. Name of the auction package. Format:
* `buyers/{accountId}/auctionPackages/{auctionPackageId}`
* @param SubscribeClientsRequest $postBody
* @param array $optParams Optional parameters.
* @return AuctionPackage
* @throws \Google\Service\Exception
*/
public function subscribeClients($auctionPackage, SubscribeClientsRequest $postBody, $optParams = [])
{
$params = ['auctionPackage' => $auctionPackage, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('subscribeClients', [$params], AuctionPackage::class);
}
/**
* Unsubscribe from the auction package for the specified buyer. Once
* unsubscribed, the bidder will no longer receive a call out for the auction
* package deal ID and the specified buyer. (auctionPackages.unsubscribe)
*
* @param string $name Required. Name of the auction package. Format:
* `buyers/{accountId}/auctionPackages/{auctionPackageId}`
* @param UnsubscribeAuctionPackageRequest $postBody
* @param array $optParams Optional parameters.
* @return AuctionPackage
* @throws \Google\Service\Exception
*/
public function unsubscribe($name, UnsubscribeAuctionPackageRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('unsubscribe', [$params], AuctionPackage::class);
}
/**
* Unsubscribe from the auction package for the specified clients of the buyer.
* Unsubscribing a client that is not subscribed will have no effect.
* (auctionPackages.unsubscribeClients)
*
* @param string $auctionPackage Required. Name of the auction package. Format:
* `buyers/{accountId}/auctionPackages/{auctionPackageId}`
* @param UnsubscribeClientsRequest $postBody
* @param array $optParams Optional parameters.
* @return AuctionPackage
* @throws \Google\Service\Exception
*/
public function unsubscribeClients($auctionPackage, UnsubscribeClientsRequest $postBody, $optParams = [])
{
$params = ['auctionPackage' => $auctionPackage, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('unsubscribeClients', [$params], AuctionPackage::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BuyersAuctionPackages::class, 'Google_Service_AuthorizedBuyersMarketplace_Resource_BuyersAuctionPackages');
@@ -0,0 +1,161 @@
<?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\AuthorizedBuyersMarketplace\Resource;
use Google\Service\AuthorizedBuyersMarketplace\ActivateClientRequest;
use Google\Service\AuthorizedBuyersMarketplace\Client;
use Google\Service\AuthorizedBuyersMarketplace\DeactivateClientRequest;
use Google\Service\AuthorizedBuyersMarketplace\ListClientsResponse;
/**
* The "clients" collection of methods.
* Typical usage is:
* <code>
* $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
* $clients = $authorizedbuyersmarketplaceService->buyers_clients;
* </code>
*/
class BuyersClients extends \Google\Service\Resource
{
/**
* Activates an existing client. The state of the client will be updated to
* "ACTIVE". This method has no effect if the client is already in "ACTIVE"
* state. (clients.activate)
*
* @param string $name Required. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountId}`
* @param ActivateClientRequest $postBody
* @param array $optParams Optional parameters.
* @return Client
* @throws \Google\Service\Exception
*/
public function activate($name, ActivateClientRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('activate', [$params], Client::class);
}
/**
* Creates a new client. (clients.create)
*
* @param string $parent Required. The name of the buyer. Format:
* `buyers/{accountId}`
* @param Client $postBody
* @param array $optParams Optional parameters.
* @return Client
* @throws \Google\Service\Exception
*/
public function create($parent, Client $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Client::class);
}
/**
* Deactivates an existing client. The state of the client will be updated to
* "INACTIVE". This method has no effect if the client is already in "INACTIVE"
* state. (clients.deactivate)
*
* @param string $name Required. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountId}`
* @param DeactivateClientRequest $postBody
* @param array $optParams Optional parameters.
* @return Client
* @throws \Google\Service\Exception
*/
public function deactivate($name, DeactivateClientRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('deactivate', [$params], Client::class);
}
/**
* Gets a client with a given resource name. (clients.get)
*
* @param string $name Required. Format:
* `buyers/{accountId}/clients/{clientAccountId}`
* @param array $optParams Optional parameters.
* @return Client
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Client::class);
}
/**
* Lists all the clients for the current buyer. (clients.listBuyersClients)
*
* @param string $parent Required. The name of the buyer. Format:
* `buyers/{accountId}`
* @param array $optParams Optional parameters.
*
* @opt_param string filter Query string using the [Filtering
* Syntax](https://developers.google.com/authorized-buyers/apis/guides/list-
* filters) Supported fields for filtering are: * partnerClientId Use this field
* to filter the clients by the partnerClientId. For example, if the
* partnerClientId of the client is "1234", the value of this field should be
* `partnerClientId = "1234"`, in order to get only the client whose
* partnerClientId is "1234" in the response.
* @opt_param int pageSize Requested page size. If left blank, a default page
* size of 500 will be applied.
* @opt_param string pageToken A token identifying a page of results the server
* should return. Typically, this is the value of
* ListClientsResponse.nextPageToken returned from the previous call to the list
* method.
* @return ListClientsResponse
* @throws \Google\Service\Exception
*/
public function listBuyersClients($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListClientsResponse::class);
}
/**
* Updates an existing client. (clients.patch)
*
* @param string $name Output only. The resource name of the client. Format:
* `buyers/{accountId}/clients/{clientAccountId}`
* @param Client $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask List of fields to be updated. If empty or
* unspecified, the service will update all fields populated in the update
* request excluding the output only fields and primitive fields with default
* value. Note that explicit field mask is required in order to reset a
* primitive field back to its default value, for example, false for boolean
* fields, 0 for integer fields. A special field mask consisting of a single
* path "*" can be used to indicate full replacement(the equivalent of PUT
* method), updatable fields unset or unspecified in the input will be cleared
* or set to default value. Output only fields will be ignored regardless of the
* value of updateMask.
* @return Client
* @throws \Google\Service\Exception
*/
public function patch($name, Client $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Client::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BuyersClients::class, 'Google_Service_AuthorizedBuyersMarketplace_Resource_BuyersClients');
@@ -0,0 +1,150 @@
<?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\AuthorizedBuyersMarketplace\Resource;
use Google\Service\AuthorizedBuyersMarketplace\ActivateClientUserRequest;
use Google\Service\AuthorizedBuyersMarketplace\AuthorizedbuyersmarketplaceEmpty;
use Google\Service\AuthorizedBuyersMarketplace\ClientUser;
use Google\Service\AuthorizedBuyersMarketplace\DeactivateClientUserRequest;
use Google\Service\AuthorizedBuyersMarketplace\ListClientUsersResponse;
/**
* The "users" collection of methods.
* Typical usage is:
* <code>
* $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
* $users = $authorizedbuyersmarketplaceService->buyers_clients_users;
* </code>
*/
class BuyersClientsUsers extends \Google\Service\Resource
{
/**
* Activates an existing client user. The state of the client user will be
* updated from "INACTIVE" to "ACTIVE". This method has no effect if the client
* user is already in "ACTIVE" state. An error will be returned if the client
* user to activate is still in "INVITED" state. (users.activate)
*
* @param string $name Required. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`
* @param ActivateClientUserRequest $postBody
* @param array $optParams Optional parameters.
* @return ClientUser
* @throws \Google\Service\Exception
*/
public function activate($name, ActivateClientUserRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('activate', [$params], ClientUser::class);
}
/**
* Creates a new client user in "INVITED" state. An email invitation will be
* sent to the new user, once accepted the user will become active.
* (users.create)
*
* @param string $parent Required. The name of the client. Format:
* `buyers/{accountId}/clients/{clientAccountId}`
* @param ClientUser $postBody
* @param array $optParams Optional parameters.
* @return ClientUser
* @throws \Google\Service\Exception
*/
public function create($parent, ClientUser $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], ClientUser::class);
}
/**
* Deactivates an existing client user. The state of the client user will be
* updated from "ACTIVE" to "INACTIVE". This method has no effect if the client
* user is already in "INACTIVE" state. An error will be returned if the client
* user to deactivate is still in "INVITED" state. (users.deactivate)
*
* @param string $name Required. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`
* @param DeactivateClientUserRequest $postBody
* @param array $optParams Optional parameters.
* @return ClientUser
* @throws \Google\Service\Exception
*/
public function deactivate($name, DeactivateClientUserRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('deactivate', [$params], ClientUser::class);
}
/**
* Deletes an existing client user. The client user will lose access to the
* Authorized Buyers UI. Note that if a client user is deleted, the user's
* access to the UI can't be restored unless a new client user is created and
* activated. (users.delete)
*
* @param string $name Required. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`
* @param array $optParams Optional parameters.
* @return AuthorizedbuyersmarketplaceEmpty
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], AuthorizedbuyersmarketplaceEmpty::class);
}
/**
* Retrieves an existing client user. (users.get)
*
* @param string $name Required. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`
* @param array $optParams Optional parameters.
* @return ClientUser
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ClientUser::class);
}
/**
* Lists all client users for a specified client. (users.listBuyersClientsUsers)
*
* @param string $parent Required. The name of the client. Format:
* `buyers/{buyerAccountId}/clients/{clientAccountId}`
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Requested page size. If left blank, a default page
* size of 500 will be applied.
* @opt_param string pageToken A token identifying a page of results the server
* should return. Typically, this is the value of
* ListClientUsersResponse.nextPageToken returned from the previous call to the
* list method.
* @return ListClientUsersResponse
* @throws \Google\Service\Exception
*/
public function listBuyersClientsUsers($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListClientUsersResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BuyersClientsUsers::class, 'Google_Service_AuthorizedBuyersMarketplace_Resource_BuyersClientsUsers');
@@ -0,0 +1,188 @@
<?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\AuthorizedBuyersMarketplace\Resource;
use Google\Service\AuthorizedBuyersMarketplace\AddCreativeRequest;
use Google\Service\AuthorizedBuyersMarketplace\FinalizedDeal;
use Google\Service\AuthorizedBuyersMarketplace\ListFinalizedDealsResponse;
use Google\Service\AuthorizedBuyersMarketplace\PauseFinalizedDealRequest;
use Google\Service\AuthorizedBuyersMarketplace\ResumeFinalizedDealRequest;
use Google\Service\AuthorizedBuyersMarketplace\SetReadyToServeRequest;
/**
* The "finalizedDeals" collection of methods.
* Typical usage is:
* <code>
* $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
* $finalizedDeals = $authorizedbuyersmarketplaceService->buyers_finalizedDeals;
* </code>
*/
class BuyersFinalizedDeals extends \Google\Service\Resource
{
/**
* Add creative to be used in the bidding process for a finalized deal. For
* programmatic guaranteed deals, it's recommended that you associate at least
* one approved creative with the deal before calling SetReadyToServe, to help
* reduce the number of bid responses filtered because they don't contain
* approved creatives. Creatives successfully added to a deal can be found in
* the Realtime-bidding Creatives API creative.deal_ids. This method only
* applies to programmatic guaranteed deals. Maximum number of 1000 creatives
* can be added to a finalized deal. (finalizedDeals.addCreative)
*
* @param string $deal Required. Name of the finalized deal in the format of:
* `buyers/{accountId}/finalizedDeals/{dealId}`
* @param AddCreativeRequest $postBody
* @param array $optParams Optional parameters.
* @return FinalizedDeal
* @throws \Google\Service\Exception
*/
public function addCreative($deal, AddCreativeRequest $postBody, $optParams = [])
{
$params = ['deal' => $deal, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('addCreative', [$params], FinalizedDeal::class);
}
/**
* Gets a finalized deal given its name. (finalizedDeals.get)
*
* @param string $name Required. Format:
* `buyers/{accountId}/finalizedDeals/{dealId}`
* @param array $optParams Optional parameters.
* @return FinalizedDeal
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], FinalizedDeal::class);
}
/**
* Lists finalized deals. Use the URL path
* "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the
* current buyer and its clients. Bidders can use the URL path
* "/v1/bidders/{accountId}/finalizedDeals" to list finalized deals for the
* bidder, its buyers and all their clients.
* (finalizedDeals.listBuyersFinalizedDeals)
*
* @param string $parent Required. The buyer to list the finalized deals for, in
* the format: `buyers/{accountId}`. When used to list finalized deals for a
* bidder, its buyers and clients, in the format `bidders/{accountId}`.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Optional query string using the [Cloud API list
* filtering syntax](https://developers.google.com/authorized-
* buyers/apis/guides/list-filters) Supported columns for filtering are: *
* deal.displayName * deal.dealType * deal.createTime * deal.updateTime *
* deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds *
* dealServingStatus * readyToServe
* @opt_param string orderBy An optional query string to sort finalized deals
* using the [Cloud API sorting
* syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
* If no sort order is specified, results will be returned in an arbitrary
* order. Supported columns for sorting are: * deal.displayName *
* deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime
* * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days *
* rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days *
* rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth
* @opt_param int pageSize Requested page size. The server may return fewer
* results than requested. If requested more than 500, the server will return
* 500 results per page. If unspecified, the server will pick a default page
* size of 100.
* @opt_param string pageToken The page token as returned from
* ListFinalizedDealsResponse.
* @return ListFinalizedDealsResponse
* @throws \Google\Service\Exception
*/
public function listBuyersFinalizedDeals($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListFinalizedDealsResponse::class);
}
/**
* Pauses serving of the given finalized deal. This call only pauses the serving
* status, and does not affect other fields of the finalized deal. Calling this
* method for an already paused deal has no effect. This method only applies to
* programmatic guaranteed deals and preferred deals. (finalizedDeals.pause)
*
* @param string $name Required. Format:
* `buyers/{accountId}/finalizedDeals/{dealId}`
* @param PauseFinalizedDealRequest $postBody
* @param array $optParams Optional parameters.
* @return FinalizedDeal
* @throws \Google\Service\Exception
*/
public function pause($name, PauseFinalizedDealRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('pause', [$params], FinalizedDeal::class);
}
/**
* Resumes serving of the given finalized deal. Calling this method for an
* running deal has no effect. If a deal is initially paused by the seller,
* calling this method will not resume serving of the deal until the seller also
* resumes the deal. This method only applies to programmatic guaranteed deals
* and preferred deals. (finalizedDeals.resume)
*
* @param string $name Required. Format:
* `buyers/{accountId}/finalizedDeals/{dealId}`
* @param ResumeFinalizedDealRequest $postBody
* @param array $optParams Optional parameters.
* @return FinalizedDeal
* @throws \Google\Service\Exception
*/
public function resume($name, ResumeFinalizedDealRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('resume', [$params], FinalizedDeal::class);
}
/**
* Sets the given finalized deal as ready to serve. By default, deals are set as
* ready to serve as soon as they're finalized. If you want to opt out of the
* default behavior, and manually indicate that deals are ready to serve, ask
* your Technical Account Manager to add you to the allowlist. If you choose to
* use this method, finalized deals belonging to the bidder and its child seats
* don't start serving until after you call `setReadyToServe`, and after the
* deals become active. For example, you can use this method to delay receiving
* bid requests until your creative is ready. In addition, bidders can use the
* URL path "/v1/bidders/{accountId}/finalizedDeals/{dealId}" to set ready to
* serve for the finalized deals belong to itself, its child seats and all their
* clients. This method only applies to programmatic guaranteed deals.
* (finalizedDeals.setReadyToServe)
*
* @param string $deal Required. Format:
* `buyers/{accountId}/finalizedDeals/{dealId}` or
* `bidders/{accountId}/finalizedDeals/{dealId}`
* @param SetReadyToServeRequest $postBody
* @param array $optParams Optional parameters.
* @return FinalizedDeal
* @throws \Google\Service\Exception
*/
public function setReadyToServe($deal, SetReadyToServeRequest $postBody, $optParams = [])
{
$params = ['deal' => $deal, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setReadyToServe', [$params], FinalizedDeal::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BuyersFinalizedDeals::class, 'Google_Service_AuthorizedBuyersMarketplace_Resource_BuyersFinalizedDeals');
@@ -0,0 +1,203 @@
<?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\AuthorizedBuyersMarketplace\Resource;
use Google\Service\AuthorizedBuyersMarketplace\AcceptProposalRequest;
use Google\Service\AuthorizedBuyersMarketplace\AddNoteRequest;
use Google\Service\AuthorizedBuyersMarketplace\CancelNegotiationRequest;
use Google\Service\AuthorizedBuyersMarketplace\ListProposalsResponse;
use Google\Service\AuthorizedBuyersMarketplace\Proposal;
use Google\Service\AuthorizedBuyersMarketplace\SendRfpRequest;
/**
* The "proposals" collection of methods.
* Typical usage is:
* <code>
* $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
* $proposals = $authorizedbuyersmarketplaceService->buyers_proposals;
* </code>
*/
class BuyersProposals extends \Google\Service\Resource
{
/**
* Accepts the proposal at the given revision number. If the revision number in
* the request is behind the latest from the server, an error message will be
* returned. This call updates the Proposal.state from
* `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the
* Proposal.state is already `FINALIZED` and throws exception if the
* Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`.
* Accepting a proposal means the buyer understands and accepts the
* Proposal.terms_and_conditions proposed by the seller. (proposals.accept)
*
* @param string $name Name of the proposal. Format:
* `buyers/{accountId}/proposals/{proposalId}`
* @param AcceptProposalRequest $postBody
* @param array $optParams Optional parameters.
* @return Proposal
* @throws \Google\Service\Exception
*/
public function accept($name, AcceptProposalRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('accept', [$params], Proposal::class);
}
/**
* Creates a note for this proposal and sends to the seller. This method is not
* supported for proposals with DealType set to 'PRIVATE_AUCTION'.
* (proposals.addNote)
*
* @param string $proposal Name of the proposal. Format:
* `buyers/{accountId}/proposals/{proposalId}`
* @param AddNoteRequest $postBody
* @param array $optParams Optional parameters.
* @return Proposal
* @throws \Google\Service\Exception
*/
public function addNote($proposal, AddNoteRequest $postBody, $optParams = [])
{
$params = ['proposal' => $proposal, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('addNote', [$params], Proposal::class);
}
/**
* Cancels an ongoing negotiation on a proposal. This does not cancel or end
* serving for the deals if the proposal has been finalized. If the proposal has
* not been finalized before, calling this method will set the Proposal.state to
* `TERMINATED` and increment the Proposal.proposal_revision. If the proposal
* has been finalized before and is under renegotiation now, calling this method
* will reset the Proposal.state to `FINALIZED` and increment the
* Proposal.proposal_revision. This method does not support private auction
* proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.
* (proposals.cancelNegotiation)
*
* @param string $proposal Name of the proposal. Format:
* `buyers/{accountId}/proposals/{proposalId}`
* @param CancelNegotiationRequest $postBody
* @param array $optParams Optional parameters.
* @return Proposal
* @throws \Google\Service\Exception
*/
public function cancelNegotiation($proposal, CancelNegotiationRequest $postBody, $optParams = [])
{
$params = ['proposal' => $proposal, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('cancelNegotiation', [$params], Proposal::class);
}
/**
* Gets a proposal using its resource name. The proposal is returned at the
* latest revision. (proposals.get)
*
* @param string $name Required. Name of the proposal. Format:
* `buyers/{accountId}/proposals/{proposalId}`
* @param array $optParams Optional parameters.
* @return Proposal
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Proposal::class);
}
/**
* Lists proposals. A filter expression using [Cloud API list filtering
* syntax](https://developers.google.com/authorized-buyers/apis/guides/list-
* filters) may be specified to filter the results.
* (proposals.listBuyersProposals)
*
* @param string $parent Required. Parent that owns the collection of proposals
* Format: `buyers/{accountId}`
* @param array $optParams Optional parameters.
*
* @opt_param string filter Optional query string using the [Cloud API list
* filtering syntax](https://developers.google.com/authorized-
* buyers/apis/guides/list-filters) Supported columns for filtering are: *
* displayName * dealType * updateTime * state
* @opt_param int pageSize Requested page size. The server may return fewer
* results than requested. If unspecified, the server will put a size of 500.
* @opt_param string pageToken The page token as returned from
* ListProposalsResponse.
* @return ListProposalsResponse
* @throws \Google\Service\Exception
*/
public function listBuyersProposals($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListProposalsResponse::class);
}
/**
* Updates the proposal at the given revision number. If the revision number in
* the request is behind the latest one kept in the server, an error message
* will be returned. See FieldMask for how to use FieldMask. Only fields
* specified in the UpdateProposalRequest.update_mask will be updated; Fields
* noted as 'Immutable' or 'Output only' yet specified in the
* UpdateProposalRequest.update_mask will be ignored and left unchanged.
* Updating a private auction proposal is only allowed for buyer private data,
* all other fields are immutable. (proposals.patch)
*
* @param string $name Immutable. The name of the proposal serving as a unique
* identifier. Format: buyers/{accountId}/proposals/{proposalId}
* @param Proposal $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask List of fields to be updated. If empty or
* unspecified, the service will update all fields populated in the update
* request excluding the output only fields and primitive fields with default
* value. Note that explicit field mask is required in order to reset a
* primitive field back to its default value, for example, false for boolean
* fields, 0 for integer fields. A special field mask consisting of a single
* path "*" can be used to indicate full replacement(the equivalent of PUT
* method), updatable fields unset or unspecified in the input will be cleared
* or set to default value. Output only fields will be ignored regardless of the
* value of updateMask.
* @return Proposal
* @throws \Google\Service\Exception
*/
public function patch($name, Proposal $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Proposal::class);
}
/**
* Sends a request for proposal (RFP) to a publisher to initiate the negotiation
* regarding certain inventory. In the RFP, buyers can specify the deal type,
* deal terms, start and end dates, targeting, and a message to the publisher.
* Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be
* created and returned in the response. The publisher may review your request
* and respond with detailed deals in the proposal. (proposals.sendRfp)
*
* @param string $buyer Required. The current buyer who is sending the RFP in
* the format: `buyers/{accountId}`.
* @param SendRfpRequest $postBody
* @param array $optParams Optional parameters.
* @return Proposal
* @throws \Google\Service\Exception
*/
public function sendRfp($buyer, SendRfpRequest $postBody, $optParams = [])
{
$params = ['buyer' => $buyer, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('sendRfp', [$params], Proposal::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BuyersProposals::class, 'Google_Service_AuthorizedBuyersMarketplace_Resource_BuyersProposals');
@@ -0,0 +1,131 @@
<?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\AuthorizedBuyersMarketplace\Resource;
use Google\Service\AuthorizedBuyersMarketplace\BatchUpdateDealsRequest;
use Google\Service\AuthorizedBuyersMarketplace\BatchUpdateDealsResponse;
use Google\Service\AuthorizedBuyersMarketplace\Deal;
use Google\Service\AuthorizedBuyersMarketplace\ListDealsResponse;
/**
* The "deals" collection of methods.
* Typical usage is:
* <code>
* $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
* $deals = $authorizedbuyersmarketplaceService->buyers_proposals_deals;
* </code>
*/
class BuyersProposalsDeals extends \Google\Service\Resource
{
/**
* Batch updates multiple deals in the same proposal. (deals.batchUpdate)
*
* @param string $parent Required. The name of the proposal containing the deals
* to batch update. Format: buyers/{accountId}/proposals/{proposalId}
* @param BatchUpdateDealsRequest $postBody
* @param array $optParams Optional parameters.
* @return BatchUpdateDealsResponse
* @throws \Google\Service\Exception
*/
public function batchUpdate($parent, BatchUpdateDealsRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('batchUpdate', [$params], BatchUpdateDealsResponse::class);
}
/**
* Gets a deal given its name. The deal is returned at its head revision.
* (deals.get)
*
* @param string $name Required. Format:
* buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
* @param array $optParams Optional parameters.
* @return Deal
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Deal::class);
}
/**
* Lists all deals in a proposal. To retrieve only the finalized revision deals
* regardless if a deal is being renegotiated, see the FinalizedDeals resource.
* (deals.listBuyersProposalsDeals)
*
* @param string $parent Required. The name of the proposal containing the deals
* to retrieve. Format: buyers/{accountId}/proposals/{proposalId}
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Requested page size. The server may return fewer
* results than requested. If requested more than 500, the server will return
* 500 results per page. If unspecified, the server will pick a default page
* size of 100.
* @opt_param string pageToken The page token as returned from
* ListDealsResponse.
* @return ListDealsResponse
* @throws \Google\Service\Exception
*/
public function listBuyersProposalsDeals($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListDealsResponse::class);
}
/**
* Updates the given deal at the buyer known revision number. If the server
* revision has advanced since the passed-in proposal.proposal_revision an
* ABORTED error message will be returned. The revision number is incremented by
* the server whenever the proposal or its constituent deals are updated. Note:
* The revision number is kept at a proposal level. The buyer of the API is
* expected to keep track of the revision number after the last update operation
* and send it in as part of the next update request. This way, if there are
* further changes on the server (for example, seller making new updates), then
* the server can detect conflicts and reject the proposed changes.
* (deals.patch)
*
* @param string $name Immutable. The unique identifier of the deal. Auto-
* generated by the server when a deal is created. Format:
* buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
* @param Deal $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask List of fields to be updated. If empty or
* unspecified, the service will update all fields populated in the update
* request excluding the output only fields and primitive fields with default
* value. Note that explicit field mask is required in order to reset a
* primitive field back to its default value, for example, false for boolean
* fields, 0 for integer fields. A special field mask consisting of a single
* path "*" can be used to indicate full replacement(the equivalent of PUT
* method), updatable fields unset or unspecified in the input will be cleared
* or set to default value. Output only fields will be ignored regardless of the
* value of updateMask.
* @return Deal
* @throws \Google\Service\Exception
*/
public function patch($name, Deal $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Deal::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BuyersProposalsDeals::class, 'Google_Service_AuthorizedBuyersMarketplace_Resource_BuyersProposalsDeals');
@@ -0,0 +1,79 @@
<?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\AuthorizedBuyersMarketplace\Resource;
use Google\Service\AuthorizedBuyersMarketplace\ListPublisherProfilesResponse;
use Google\Service\AuthorizedBuyersMarketplace\PublisherProfile;
/**
* The "publisherProfiles" collection of methods.
* Typical usage is:
* <code>
* $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
* $publisherProfiles = $authorizedbuyersmarketplaceService->buyers_publisherProfiles;
* </code>
*/
class BuyersPublisherProfiles extends \Google\Service\Resource
{
/**
* Gets the requested publisher profile by name. (publisherProfiles.get)
*
* @param string $name Required. Name of the publisher profile. Format:
* `buyers/{buyerId}/publisherProfiles/{publisherProfileId}`
* @param array $optParams Optional parameters.
* @return PublisherProfile
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], PublisherProfile::class);
}
/**
* Lists publisher profiles. The returned publisher profiles aren't in any
* defined order. The order of the results might change. A new publisher profile
* can appear in any place in the list of returned results.
* (publisherProfiles.listBuyersPublisherProfiles)
*
* @param string $parent Required. Parent that owns the collection of publisher
* profiles Format: `buyers/{buyerId}`
* @param array $optParams Optional parameters.
*
* @opt_param string filter Optional query string using the [Cloud API list
* filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-
* filters) syntax.
* @opt_param int pageSize Requested page size. The server may return fewer
* results than requested. If requested more than 500, the server will return
* 500 results per page. If unspecified, the server will pick a default page
* size of 100.
* @opt_param string pageToken The page token as returned from a previous
* ListPublisherProfilesResponse.
* @return ListPublisherProfilesResponse
* @throws \Google\Service\Exception
*/
public function listBuyersPublisherProfiles($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListPublisherProfilesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BuyersPublisherProfiles::class, 'Google_Service_AuthorizedBuyersMarketplace_Resource_BuyersPublisherProfiles');
@@ -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\AuthorizedBuyersMarketplace;
class ResumeFinalizedDealRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ResumeFinalizedDealRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_ResumeFinalizedDealRequest');
@@ -0,0 +1,134 @@
<?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\AuthorizedBuyersMarketplace;
class RtbMetrics extends \Google\Model
{
/**
* Ad impressions in last 7 days.
*
* @var string
*/
public $adImpressions7Days;
/**
* Bid rate in last 7 days, calculated by (bids / bid requests).
*
* @var
*/
public $bidRate7Days;
/**
* Bid requests in last 7 days.
*
* @var string
*/
public $bidRequests7Days;
/**
* Bids in last 7 days.
*
* @var string
*/
public $bids7Days;
/**
* Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
*
* @var
*/
public $filteredBidRate7Days;
/**
* Must bid rate for current month.
*
* @var
*/
public $mustBidRateCurrentMonth;
/**
* Ad impressions in last 7 days.
*
* @param string $adImpressions7Days
*/
public function setAdImpressions7Days($adImpressions7Days)
{
$this->adImpressions7Days = $adImpressions7Days;
}
/**
* @return string
*/
public function getAdImpressions7Days()
{
return $this->adImpressions7Days;
}
public function setBidRate7Days($bidRate7Days)
{
$this->bidRate7Days = $bidRate7Days;
}
public function getBidRate7Days()
{
return $this->bidRate7Days;
}
/**
* Bid requests in last 7 days.
*
* @param string $bidRequests7Days
*/
public function setBidRequests7Days($bidRequests7Days)
{
$this->bidRequests7Days = $bidRequests7Days;
}
/**
* @return string
*/
public function getBidRequests7Days()
{
return $this->bidRequests7Days;
}
/**
* Bids in last 7 days.
*
* @param string $bids7Days
*/
public function setBids7Days($bids7Days)
{
$this->bids7Days = $bids7Days;
}
/**
* @return string
*/
public function getBids7Days()
{
return $this->bids7Days;
}
public function setFilteredBidRate7Days($filteredBidRate7Days)
{
$this->filteredBidRate7Days = $filteredBidRate7Days;
}
public function getFilteredBidRate7Days()
{
return $this->filteredBidRate7Days;
}
public function setMustBidRateCurrentMonth($mustBidRateCurrentMonth)
{
$this->mustBidRateCurrentMonth = $mustBidRateCurrentMonth;
}
public function getMustBidRateCurrentMonth()
{
return $this->mustBidRateCurrentMonth;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RtbMetrics::class, 'Google_Service_AuthorizedBuyersMarketplace_RtbMetrics');
@@ -0,0 +1,284 @@
<?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\AuthorizedBuyersMarketplace;
class SendRfpRequest extends \Google\Collection
{
protected $collection_key = 'buyerContacts';
protected $buyerContactsType = Contact::class;
protected $buyerContactsDataType = 'array';
/**
* If the current buyer is sending the RFP on behalf of its client, use this
* field to specify the name of the client in the format:
* `buyers/{accountId}/clients/{clientAccountid}`.
*
* @var string
*/
public $client;
/**
* Required. The display name of the proposal being created by this RFP.
*
* @var string
*/
public $displayName;
protected $estimatedGrossSpendType = Money::class;
protected $estimatedGrossSpendDataType = '';
/**
* Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC
* "Zulu" format. Note that the specified value will be truncated to a
* granularity of one second.
*
* @var string
*/
public $flightEndTime;
/**
* Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC
* "Zulu" format. Note that the specified value will be truncated to a
* granularity of one second.
*
* @var string
*/
public $flightStartTime;
protected $geoTargetingType = CriteriaTargeting::class;
protected $geoTargetingDataType = '';
protected $inventorySizeTargetingType = InventorySizeTargeting::class;
protected $inventorySizeTargetingDataType = '';
/**
* A message that is sent to the publisher. Maximum length is 1024 characters.
*
* @var string
*/
public $note;
protected $preferredDealTermsType = PreferredDealTerms::class;
protected $preferredDealTermsDataType = '';
protected $programmaticGuaranteedTermsType = ProgrammaticGuaranteedTerms::class;
protected $programmaticGuaranteedTermsDataType = '';
/**
* Required. The profile of the publisher who will receive this RFP in the
* format: `buyers/{accountId}/publisherProfiles/{publisherProfileId}`.
*
* @var string
*/
public $publisherProfile;
/**
* Contact information for the buyer.
*
* @param Contact[] $buyerContacts
*/
public function setBuyerContacts($buyerContacts)
{
$this->buyerContacts = $buyerContacts;
}
/**
* @return Contact[]
*/
public function getBuyerContacts()
{
return $this->buyerContacts;
}
/**
* If the current buyer is sending the RFP on behalf of its client, use this
* field to specify the name of the client in the format:
* `buyers/{accountId}/clients/{clientAccountid}`.
*
* @param string $client
*/
public function setClient($client)
{
$this->client = $client;
}
/**
* @return string
*/
public function getClient()
{
return $this->client;
}
/**
* Required. The display name of the proposal being created by this RFP.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Specified by buyers in request for proposal (RFP) to notify publisher the
* total estimated spend for the proposal. Publishers will receive this
* information and send back proposed deals accordingly.
*
* @param Money $estimatedGrossSpend
*/
public function setEstimatedGrossSpend(Money $estimatedGrossSpend)
{
$this->estimatedGrossSpend = $estimatedGrossSpend;
}
/**
* @return Money
*/
public function getEstimatedGrossSpend()
{
return $this->estimatedGrossSpend;
}
/**
* Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC
* "Zulu" format. Note that the specified value will be truncated to a
* granularity of one second.
*
* @param string $flightEndTime
*/
public function setFlightEndTime($flightEndTime)
{
$this->flightEndTime = $flightEndTime;
}
/**
* @return string
*/
public function getFlightEndTime()
{
return $this->flightEndTime;
}
/**
* Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC
* "Zulu" format. Note that the specified value will be truncated to a
* granularity of one second.
*
* @param string $flightStartTime
*/
public function setFlightStartTime($flightStartTime)
{
$this->flightStartTime = $flightStartTime;
}
/**
* @return string
*/
public function getFlightStartTime()
{
return $this->flightStartTime;
}
/**
* Geo criteria IDs to be targeted. Refer to Geo tables.
*
* @param CriteriaTargeting $geoTargeting
*/
public function setGeoTargeting(CriteriaTargeting $geoTargeting)
{
$this->geoTargeting = $geoTargeting;
}
/**
* @return CriteriaTargeting
*/
public function getGeoTargeting()
{
return $this->geoTargeting;
}
/**
* Inventory sizes to be targeted. Only PIXEL inventory size type is
* supported.
*
* @param InventorySizeTargeting $inventorySizeTargeting
*/
public function setInventorySizeTargeting(InventorySizeTargeting $inventorySizeTargeting)
{
$this->inventorySizeTargeting = $inventorySizeTargeting;
}
/**
* @return InventorySizeTargeting
*/
public function getInventorySizeTargeting()
{
return $this->inventorySizeTargeting;
}
/**
* A message that is sent to the publisher. Maximum length is 1024 characters.
*
* @param string $note
*/
public function setNote($note)
{
$this->note = $note;
}
/**
* @return string
*/
public function getNote()
{
return $this->note;
}
/**
* The terms for preferred deals.
*
* @param PreferredDealTerms $preferredDealTerms
*/
public function setPreferredDealTerms(PreferredDealTerms $preferredDealTerms)
{
$this->preferredDealTerms = $preferredDealTerms;
}
/**
* @return PreferredDealTerms
*/
public function getPreferredDealTerms()
{
return $this->preferredDealTerms;
}
/**
* The terms for programmatic guaranteed deals.
*
* @param ProgrammaticGuaranteedTerms $programmaticGuaranteedTerms
*/
public function setProgrammaticGuaranteedTerms(ProgrammaticGuaranteedTerms $programmaticGuaranteedTerms)
{
$this->programmaticGuaranteedTerms = $programmaticGuaranteedTerms;
}
/**
* @return ProgrammaticGuaranteedTerms
*/
public function getProgrammaticGuaranteedTerms()
{
return $this->programmaticGuaranteedTerms;
}
/**
* Required. The profile of the publisher who will receive this RFP in the
* format: `buyers/{accountId}/publisherProfiles/{publisherProfileId}`.
*
* @param string $publisherProfile
*/
public function setPublisherProfile($publisherProfile)
{
$this->publisherProfile = $publisherProfile;
}
/**
* @return string
*/
public function getPublisherProfile()
{
return $this->publisherProfile;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SendRfpRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_SendRfpRequest');
@@ -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\AuthorizedBuyersMarketplace;
class SetReadyToServeRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SetReadyToServeRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_SetReadyToServeRequest');
@@ -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\AuthorizedBuyersMarketplace;
class SubscribeAuctionPackageRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SubscribeAuctionPackageRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_SubscribeAuctionPackageRequest');
@@ -0,0 +1,55 @@
<?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\AuthorizedBuyersMarketplace;
class SubscribeClientsRequest extends \Google\Collection
{
protected $collection_key = 'clients';
/**
* Optional. A list of client buyers to subscribe to the auction package, with
* client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`.
* The current buyer will be subscribed to the auction package regardless of
* the list contents if not already.
*
* @var string[]
*/
public $clients;
/**
* Optional. A list of client buyers to subscribe to the auction package, with
* client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`.
* The current buyer will be subscribed to the auction package regardless of
* the list contents if not already.
*
* @param string[] $clients
*/
public function setClients($clients)
{
$this->clients = $clients;
}
/**
* @return string[]
*/
public function getClients()
{
return $this->clients;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SubscribeClientsRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_SubscribeClientsRequest');
@@ -0,0 +1,80 @@
<?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\AuthorizedBuyersMarketplace;
class TechnologyTargeting extends \Google\Model
{
protected $deviceCapabilityTargetingType = CriteriaTargeting::class;
protected $deviceCapabilityTargetingDataType = '';
protected $deviceCategoryTargetingType = CriteriaTargeting::class;
protected $deviceCategoryTargetingDataType = '';
protected $operatingSystemTargetingType = OperatingSystemTargeting::class;
protected $operatingSystemTargetingDataType = '';
/**
* IDs of device capabilities to be included/excluded.
*
* @param CriteriaTargeting $deviceCapabilityTargeting
*/
public function setDeviceCapabilityTargeting(CriteriaTargeting $deviceCapabilityTargeting)
{
$this->deviceCapabilityTargeting = $deviceCapabilityTargeting;
}
/**
* @return CriteriaTargeting
*/
public function getDeviceCapabilityTargeting()
{
return $this->deviceCapabilityTargeting;
}
/**
* IDs of device categories to be included/excluded.
*
* @param CriteriaTargeting $deviceCategoryTargeting
*/
public function setDeviceCategoryTargeting(CriteriaTargeting $deviceCategoryTargeting)
{
$this->deviceCategoryTargeting = $deviceCategoryTargeting;
}
/**
* @return CriteriaTargeting
*/
public function getDeviceCategoryTargeting()
{
return $this->deviceCategoryTargeting;
}
/**
* Operating system related targeting information.
*
* @param OperatingSystemTargeting $operatingSystemTargeting
*/
public function setOperatingSystemTargeting(OperatingSystemTargeting $operatingSystemTargeting)
{
$this->operatingSystemTargeting = $operatingSystemTargeting;
}
/**
* @return OperatingSystemTargeting
*/
public function getOperatingSystemTargeting()
{
return $this->operatingSystemTargeting;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TechnologyTargeting::class, 'Google_Service_AuthorizedBuyersMarketplace_TechnologyTargeting');
@@ -0,0 +1,126 @@
<?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\AuthorizedBuyersMarketplace;
class TimeOfDay extends \Google\Model
{
/**
* Hours of a day in 24 hour format. Must be greater than or equal to 0 and
* typically must be less than or equal to 23. An API may choose to allow the
* value "24:00:00" for scenarios like business closing time.
*
* @var int
*/
public $hours;
/**
* Minutes of an hour. Must be greater than or equal to 0 and less than or
* equal to 59.
*
* @var int
*/
public $minutes;
/**
* Fractions of seconds, in nanoseconds. Must be greater than or equal to 0
* and less than or equal to 999,999,999.
*
* @var int
*/
public $nanos;
/**
* Seconds of a minute. Must be greater than or equal to 0 and typically must
* be less than or equal to 59. An API may allow the value 60 if it allows
* leap-seconds.
*
* @var int
*/
public $seconds;
/**
* Hours of a day in 24 hour format. Must be greater than or equal to 0 and
* typically must be less than or equal to 23. An API may choose to allow the
* value "24:00:00" for scenarios like business closing time.
*
* @param int $hours
*/
public function setHours($hours)
{
$this->hours = $hours;
}
/**
* @return int
*/
public function getHours()
{
return $this->hours;
}
/**
* Minutes of an hour. Must be greater than or equal to 0 and less than or
* equal to 59.
*
* @param int $minutes
*/
public function setMinutes($minutes)
{
$this->minutes = $minutes;
}
/**
* @return int
*/
public function getMinutes()
{
return $this->minutes;
}
/**
* Fractions of seconds, in nanoseconds. Must be greater than or equal to 0
* and less than or equal to 999,999,999.
*
* @param int $nanos
*/
public function setNanos($nanos)
{
$this->nanos = $nanos;
}
/**
* @return int
*/
public function getNanos()
{
return $this->nanos;
}
/**
* Seconds of a minute. Must be greater than or equal to 0 and typically must
* be less than or equal to 59. An API may allow the value 60 if it allows
* leap-seconds.
*
* @param int $seconds
*/
public function setSeconds($seconds)
{
$this->seconds = $seconds;
}
/**
* @return int
*/
public function getSeconds()
{
return $this->seconds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TimeOfDay::class, 'Google_Service_AuthorizedBuyersMarketplace_TimeOfDay');
@@ -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\AuthorizedBuyersMarketplace;
class TimeZone extends \Google\Model
{
/**
* IANA Time Zone Database time zone. For example "America/New_York".
*
* @var string
*/
public $id;
/**
* Optional. IANA Time Zone Database version number. For example "2019a".
*
* @var string
*/
public $version;
/**
* IANA Time Zone Database time zone. For example "America/New_York".
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* Optional. IANA Time Zone Database version number. For example "2019a".
*
* @param string $version
*/
public function setVersion($version)
{
$this->version = $version;
}
/**
* @return string
*/
public function getVersion()
{
return $this->version;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TimeZone::class, 'Google_Service_AuthorizedBuyersMarketplace_TimeZone');
@@ -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\AuthorizedBuyersMarketplace;
class UnsubscribeAuctionPackageRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UnsubscribeAuctionPackageRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_UnsubscribeAuctionPackageRequest');
@@ -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\AuthorizedBuyersMarketplace;
class UnsubscribeClientsRequest extends \Google\Collection
{
protected $collection_key = 'clients';
/**
* Optional. A list of client buyers to unsubscribe from the auction package,
* with client buyer in the format
* `buyers/{accountId}/clients/{clientAccountId}`.
*
* @var string[]
*/
public $clients;
/**
* Optional. A list of client buyers to unsubscribe from the auction package,
* with client buyer in the format
* `buyers/{accountId}/clients/{clientAccountId}`.
*
* @param string[] $clients
*/
public function setClients($clients)
{
$this->clients = $clients;
}
/**
* @return string[]
*/
public function getClients()
{
return $this->clients;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UnsubscribeClientsRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_UnsubscribeClientsRequest');
@@ -0,0 +1,85 @@
<?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\AuthorizedBuyersMarketplace;
class UpdateDealRequest extends \Google\Model
{
protected $dealType = Deal::class;
protected $dealDataType = '';
/**
* List of fields to be updated. If empty or unspecified, the service will
* update all fields populated in the update request excluding the output only
* fields and primitive fields with default value. Note that explicit field
* mask is required in order to reset a primitive field back to its default
* value, for example, false for boolean fields, 0 for integer fields. A
* special field mask consisting of a single path "*" can be used to indicate
* full replacement(the equivalent of PUT method), updatable fields unset or
* unspecified in the input will be cleared or set to default value. Output
* only fields will be ignored regardless of the value of updateMask.
*
* @var string
*/
public $updateMask;
/**
* Required. The deal to update. The deal's `name` field is used to identify
* the deal to be updated. Note: proposal_revision will have to be provided
* within the resource or else an error will be thrown. Format:
* buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
*
* @param Deal $deal
*/
public function setDeal(Deal $deal)
{
$this->deal = $deal;
}
/**
* @return Deal
*/
public function getDeal()
{
return $this->deal;
}
/**
* List of fields to be updated. If empty or unspecified, the service will
* update all fields populated in the update request excluding the output only
* fields and primitive fields with default value. Note that explicit field
* mask is required in order to reset a primitive field back to its default
* value, for example, false for boolean fields, 0 for integer fields. A
* special field mask consisting of a single path "*" can be used to indicate
* full replacement(the equivalent of PUT method), updatable fields unset or
* unspecified in the input will be cleared or set to default value. Output
* only fields will be ignored regardless of the value of updateMask.
*
* @param string $updateMask
*/
public function setUpdateMask($updateMask)
{
$this->updateMask = $updateMask;
}
/**
* @return string
*/
public function getUpdateMask()
{
return $this->updateMask;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UpdateDealRequest::class, 'Google_Service_AuthorizedBuyersMarketplace_UpdateDealRequest');
@@ -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\AuthorizedBuyersMarketplace;
class UriTargeting extends \Google\Collection
{
protected $collection_key = 'targetedUris';
/**
* A list of URLs to be excluded.
*
* @var string[]
*/
public $excludedUris;
/**
* A list of URLs to be included.
*
* @var string[]
*/
public $targetedUris;
/**
* A list of URLs to be excluded.
*
* @param string[] $excludedUris
*/
public function setExcludedUris($excludedUris)
{
$this->excludedUris = $excludedUris;
}
/**
* @return string[]
*/
public function getExcludedUris()
{
return $this->excludedUris;
}
/**
* A list of URLs to be included.
*
* @param string[] $targetedUris
*/
public function setTargetedUris($targetedUris)
{
$this->targetedUris = $targetedUris;
}
/**
* @return string[]
*/
public function getTargetedUris()
{
return $this->targetedUris;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UriTargeting::class, 'Google_Service_AuthorizedBuyersMarketplace_UriTargeting');
@@ -0,0 +1,75 @@
<?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\AuthorizedBuyersMarketplace;
class VideoTargeting extends \Google\Collection
{
protected $collection_key = 'targetedPositionTypes';
/**
* A list of video positions to be excluded. When this field is populated, the
* targeted_position_types field must be empty.
*
* @var string[]
*/
public $excludedPositionTypes;
/**
* A list of video positions to be included. When this field is populated, the
* excluded_position_types field must be empty.
*
* @var string[]
*/
public $targetedPositionTypes;
/**
* A list of video positions to be excluded. When this field is populated, the
* targeted_position_types field must be empty.
*
* @param string[] $excludedPositionTypes
*/
public function setExcludedPositionTypes($excludedPositionTypes)
{
$this->excludedPositionTypes = $excludedPositionTypes;
}
/**
* @return string[]
*/
public function getExcludedPositionTypes()
{
return $this->excludedPositionTypes;
}
/**
* A list of video positions to be included. When this field is populated, the
* excluded_position_types field must be empty.
*
* @param string[] $targetedPositionTypes
*/
public function setTargetedPositionTypes($targetedPositionTypes)
{
$this->targetedPositionTypes = $targetedPositionTypes;
}
/**
* @return string[]
*/
public function getTargetedPositionTypes()
{
return $this->targetedPositionTypes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(VideoTargeting::class, 'Google_Service_AuthorizedBuyersMarketplace_VideoTargeting');