Documentation ¶
Overview ¶
Package adexchangebuyer provides access to the Ad Exchange Buyer API.
See https://developers.google.com/ad-exchange/buyer-rest
Usage example:
import "google.golang.org/api/adexchangebuyer/v1.4" ... adexchangebuyerService, err := adexchangebuyer.New(oauthHttpClient)
Index ¶
- Constants
- type Account
- type AccountBidderLocation
- type AccountsGetCall
- type AccountsList
- type AccountsListCall
- type AccountsPatchCall
- type AccountsService
- type AccountsUpdateCall
- type BillingInfo
- type BillingInfoGetCall
- type BillingInfoList
- type BillingInfoListCall
- type BillingInfoService
- type Budget
- type BudgetGetCall
- type BudgetPatchCall
- type BudgetService
- type BudgetUpdateCall
- type Creative
- type CreativeCorrections
- type CreativeFilteringReasons
- type CreativeFilteringReasonsReasons
- type CreativeServingRestrictions
- type CreativeServingRestrictionsContexts
- type CreativeServingRestrictionsDisapprovalReasons
- type CreativesGetCall
- type CreativesInsertCall
- type CreativesList
- type CreativesListCall
- func (c *CreativesListCall) AccountId(accountId int64) *CreativesListCall
- func (c *CreativesListCall) BuyerCreativeId(buyerCreativeId string) *CreativesListCall
- func (c *CreativesListCall) DealsStatusFilter(dealsStatusFilter string) *CreativesListCall
- func (c *CreativesListCall) Do() (*CreativesList, error)
- func (c *CreativesListCall) Fields(s ...googleapi.Field) *CreativesListCall
- func (c *CreativesListCall) MaxResults(maxResults int64) *CreativesListCall
- func (c *CreativesListCall) OpenAuctionStatusFilter(openAuctionStatusFilter string) *CreativesListCall
- func (c *CreativesListCall) PageToken(pageToken string) *CreativesListCall
- type CreativesService
- type PerformanceReport
- type PerformanceReportList
- type PerformanceReportListCall
- func (c *PerformanceReportListCall) Do() (*PerformanceReportList, error)
- func (c *PerformanceReportListCall) Fields(s ...googleapi.Field) *PerformanceReportListCall
- func (c *PerformanceReportListCall) MaxResults(maxResults int64) *PerformanceReportListCall
- func (c *PerformanceReportListCall) PageToken(pageToken string) *PerformanceReportListCall
- type PerformanceReportService
- type PretargetingConfig
- type PretargetingConfigDeleteCall
- type PretargetingConfigDimensions
- type PretargetingConfigExcludedPlacements
- type PretargetingConfigGetCall
- type PretargetingConfigInsertCall
- type PretargetingConfigList
- type PretargetingConfigListCall
- type PretargetingConfigPatchCall
- type PretargetingConfigPlacements
- type PretargetingConfigService
- func (r *PretargetingConfigService) Delete(accountId int64, configId int64) *PretargetingConfigDeleteCall
- func (r *PretargetingConfigService) Get(accountId int64, configId int64) *PretargetingConfigGetCall
- func (r *PretargetingConfigService) Insert(accountId int64, pretargetingconfig *PretargetingConfig) *PretargetingConfigInsertCall
- func (r *PretargetingConfigService) List(accountId int64) *PretargetingConfigListCall
- func (r *PretargetingConfigService) Patch(accountId int64, configId int64, pretargetingconfig *PretargetingConfig) *PretargetingConfigPatchCall
- func (r *PretargetingConfigService) Update(accountId int64, configId int64, pretargetingconfig *PretargetingConfig) *PretargetingConfigUpdateCall
- type PretargetingConfigUpdateCall
- type Service
Constants ¶
const (
// Manage your Ad Exchange buyer account configuration
AdexchangeBuyerScope = "https://www.googleapis.com/auth/adexchange.buyer"
)
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Account ¶
type Account struct { // BidderLocation: Your bidder locations that have distinct URLs. BidderLocation []*AccountBidderLocation `json:"bidderLocation,omitempty"` // CookieMatchingNid: The nid parameter value used in cookie match // requests. Please contact your technical account manager if you need // to change this. CookieMatchingNid string `json:"cookieMatchingNid,omitempty"` // CookieMatchingUrl: The base URL used in cookie match requests. CookieMatchingUrl string `json:"cookieMatchingUrl,omitempty"` // Id: Account id. Id int64 `json:"id,omitempty"` // Kind: Resource type. Kind string `json:"kind,omitempty"` // MaximumActiveCreatives: The maximum number of active creatives that // an account can have, where a creative is active if it was inserted or // bid with in the last 30 days. Please contact your technical account // manager if you need to change this. MaximumActiveCreatives int64 `json:"maximumActiveCreatives,omitempty"` // MaximumTotalQps: The sum of all bidderLocation.maximumQps values // cannot exceed this. Please contact your technical account manager if // you need to change this. MaximumTotalQps int64 `json:"maximumTotalQps,omitempty"` // NumberActiveCreatives: The number of creatives that this account // inserted or bid with in the last 30 days. NumberActiveCreatives int64 `json:"numberActiveCreatives,omitempty"` }
Account: Configuration data for an Ad Exchange buyer account.
type AccountBidderLocation ¶
type AccountBidderLocation struct { // MaximumQps: The maximum queries per second the Ad Exchange will send. MaximumQps int64 `json:"maximumQps,omitempty"` // Region: The geographical region the Ad Exchange should send requests // from. Only used by some quota systems, but always setting the value // is recommended. Allowed values: // - ASIA // - EUROPE // - US_EAST // - US_WEST Region string `json:"region,omitempty"` // Url: The URL to which the Ad Exchange will send bid requests. Url string `json:"url,omitempty"` }
type AccountsGetCall ¶
type AccountsGetCall struct {
// contains filtered or unexported fields
}
func (*AccountsGetCall) Do ¶
func (c *AccountsGetCall) Do() (*Account, error)
func (*AccountsGetCall) Fields ¶
func (c *AccountsGetCall) Fields(s ...googleapi.Field) *AccountsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type AccountsList ¶
type AccountsList struct { // Items: A list of accounts. Items []*Account `json:"items,omitempty"` // Kind: Resource type. Kind string `json:"kind,omitempty"` }
AccountsList: An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
type AccountsListCall ¶
type AccountsListCall struct {
// contains filtered or unexported fields
}
func (*AccountsListCall) Do ¶
func (c *AccountsListCall) Do() (*AccountsList, error)
func (*AccountsListCall) Fields ¶
func (c *AccountsListCall) Fields(s ...googleapi.Field) *AccountsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type AccountsPatchCall ¶
type AccountsPatchCall struct {
// contains filtered or unexported fields
}
func (*AccountsPatchCall) Do ¶
func (c *AccountsPatchCall) Do() (*Account, error)
func (*AccountsPatchCall) Fields ¶
func (c *AccountsPatchCall) Fields(s ...googleapi.Field) *AccountsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type AccountsService ¶
type AccountsService struct {
// contains filtered or unexported fields
}
func NewAccountsService ¶
func NewAccountsService(s *Service) *AccountsService
func (*AccountsService) Get ¶
func (r *AccountsService) Get(id int64) *AccountsGetCall
Get: Gets one account by ID.
func (*AccountsService) List ¶
func (r *AccountsService) List() *AccountsListCall
List: Retrieves the authenticated user's list of accounts.
func (*AccountsService) Patch ¶
func (r *AccountsService) Patch(id int64, account *Account) *AccountsPatchCall
Patch: Updates an existing account. This method supports patch semantics.
func (*AccountsService) Update ¶
func (r *AccountsService) Update(id int64, account *Account) *AccountsUpdateCall
Update: Updates an existing account.
type AccountsUpdateCall ¶
type AccountsUpdateCall struct {
// contains filtered or unexported fields
}
func (*AccountsUpdateCall) Do ¶
func (c *AccountsUpdateCall) Do() (*Account, error)
func (*AccountsUpdateCall) Fields ¶
func (c *AccountsUpdateCall) Fields(s ...googleapi.Field) *AccountsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type BillingInfo ¶
type BillingInfo struct { // AccountId: Account id. AccountId int64 `json:"accountId,omitempty"` // AccountName: Account name. AccountName string `json:"accountName,omitempty"` // BillingId: A list of adgroup IDs associated with this particular // account. These IDs may show up as part of a realtime bidding // BidRequest, which indicates a bid request for this account. BillingId []string `json:"billingId,omitempty"` // Kind: Resource type. Kind string `json:"kind,omitempty"` }
BillingInfo: The configuration data for an Ad Exchange billing info.
type BillingInfoGetCall ¶
type BillingInfoGetCall struct {
// contains filtered or unexported fields
}
func (*BillingInfoGetCall) Do ¶
func (c *BillingInfoGetCall) Do() (*BillingInfo, error)
func (*BillingInfoGetCall) Fields ¶
func (c *BillingInfoGetCall) Fields(s ...googleapi.Field) *BillingInfoGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type BillingInfoList ¶
type BillingInfoList struct { // Items: A list of billing info relevant for your account. Items []*BillingInfo `json:"items,omitempty"` // Kind: Resource type. Kind string `json:"kind,omitempty"` }
BillingInfoList: A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.
type BillingInfoListCall ¶
type BillingInfoListCall struct {
// contains filtered or unexported fields
}
func (*BillingInfoListCall) Do ¶
func (c *BillingInfoListCall) Do() (*BillingInfoList, error)
func (*BillingInfoListCall) Fields ¶
func (c *BillingInfoListCall) Fields(s ...googleapi.Field) *BillingInfoListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type BillingInfoService ¶
type BillingInfoService struct {
// contains filtered or unexported fields
}
func NewBillingInfoService ¶
func NewBillingInfoService(s *Service) *BillingInfoService
func (*BillingInfoService) Get ¶
func (r *BillingInfoService) Get(accountId int64) *BillingInfoGetCall
Get: Returns the billing information for one account specified by account ID.
func (*BillingInfoService) List ¶
func (r *BillingInfoService) List() *BillingInfoListCall
List: Retrieves a list of billing information for all accounts of the authenticated user.
type Budget ¶
type Budget struct { // AccountId: The id of the account. This is required for get and update // requests. AccountId int64 `json:"accountId,omitempty,string"` // BillingId: The billing id to determine which adgroup to provide // budget information for. This is required for get and update requests. BillingId int64 `json:"billingId,omitempty,string"` // BudgetAmount: The budget amount to apply for the billingId provided. // This is required for update requests. BudgetAmount int64 `json:"budgetAmount,omitempty,string"` // CurrencyCode: The currency code for the buyer. This cannot be altered // here. CurrencyCode string `json:"currencyCode,omitempty"` // Id: The unique id that describes this item. Id string `json:"id,omitempty"` // Kind: The kind of the resource, i.e. "adexchangebuyer#budget". Kind string `json:"kind,omitempty"` }
Budget: The configuration data for Ad Exchange RTB - Budget API.
type BudgetGetCall ¶
type BudgetGetCall struct {
// contains filtered or unexported fields
}
func (*BudgetGetCall) Do ¶
func (c *BudgetGetCall) Do() (*Budget, error)
func (*BudgetGetCall) Fields ¶
func (c *BudgetGetCall) Fields(s ...googleapi.Field) *BudgetGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type BudgetPatchCall ¶
type BudgetPatchCall struct {
// contains filtered or unexported fields
}
func (*BudgetPatchCall) Do ¶
func (c *BudgetPatchCall) Do() (*Budget, error)
func (*BudgetPatchCall) Fields ¶
func (c *BudgetPatchCall) Fields(s ...googleapi.Field) *BudgetPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type BudgetService ¶
type BudgetService struct {
// contains filtered or unexported fields
}
func NewBudgetService ¶
func NewBudgetService(s *Service) *BudgetService
func (*BudgetService) Get ¶
func (r *BudgetService) Get(accountId int64, billingId int64) *BudgetGetCall
Get: Returns the budget information for the adgroup specified by the accountId and billingId.
func (*BudgetService) Patch ¶
func (r *BudgetService) Patch(accountId int64, billingId int64, budget *Budget) *BudgetPatchCall
Patch: Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.
func (*BudgetService) Update ¶
func (r *BudgetService) Update(accountId int64, billingId int64, budget *Budget) *BudgetUpdateCall
Update: Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.
type BudgetUpdateCall ¶
type BudgetUpdateCall struct {
// contains filtered or unexported fields
}
func (*BudgetUpdateCall) Do ¶
func (c *BudgetUpdateCall) Do() (*Budget, error)
func (*BudgetUpdateCall) Fields ¶
func (c *BudgetUpdateCall) Fields(s ...googleapi.Field) *BudgetUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type Creative ¶
type Creative struct { // HTMLSnippet: The HTML snippet that displays the ad when inserted in // the web page. If set, videoURL should not be set. HTMLSnippet string `json:"HTMLSnippet,omitempty"` // AccountId: Account id. AccountId int64 `json:"accountId,omitempty"` // AdvertiserId: Detected advertiser id, if any. Read-only. This field // should not be set in requests. AdvertiserId googleapi.Int64s `json:"advertiserId,omitempty"` // AdvertiserName: The name of the company being advertised in the // creative. AdvertiserName string `json:"advertiserName,omitempty"` // AgencyId: The agency id for this creative. AgencyId int64 `json:"agencyId,omitempty,string"` // Attribute: All attributes for the ads that may be shown from this // snippet. Attribute []int64 `json:"attribute,omitempty"` // BuyerCreativeId: A buyer-specific id identifying the creative in this // ad. BuyerCreativeId string `json:"buyerCreativeId,omitempty"` // ClickThroughUrl: The set of destination urls for the snippet. ClickThroughUrl []string `json:"clickThroughUrl,omitempty"` // Corrections: Shows any corrections that were applied to this // creative. Read-only. This field should not be set in requests. Corrections []*CreativeCorrections `json:"corrections,omitempty"` // DealsStatus: Top-level deals status. Read-only. This field should not // be set in requests. If disapproved, an entry for // auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also // exist. Note that this may be nuanced with other contextual // restrictions, in which case it may be preferable to read from // servingRestrictions directly. DealsStatus string `json:"dealsStatus,omitempty"` // FilteringReasons: The filtering reasons for the creative. Read-only. // This field should not be set in requests. FilteringReasons *CreativeFilteringReasons `json:"filteringReasons,omitempty"` // Height: Ad height. Height int64 `json:"height,omitempty"` // Kind: Resource type. Kind string `json:"kind,omitempty"` // OpenAuctionStatus: Top-level open auction status. Read-only. This // field should not be set in requests. If disapproved, an entry for // auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also // exist. Note that this may be nuanced with other contextual // restrictions, in which case it may be preferable to read from // ServingRestrictions directly. OpenAuctionStatus string `json:"openAuctionStatus,omitempty"` // ProductCategories: Detected product categories, if any. Read-only. // This field should not be set in requests. ProductCategories []int64 `json:"productCategories,omitempty"` // RestrictedCategories: All restricted categories for the ads that may // be shown from this snippet. RestrictedCategories []int64 `json:"restrictedCategories,omitempty"` // SensitiveCategories: Detected sensitive categories, if any. // Read-only. This field should not be set in requests. SensitiveCategories []int64 `json:"sensitiveCategories,omitempty"` // ServingRestrictions: The granular status of this ad in specific // contexts. A context here relates to where something ultimately serves // (for example, a physical location, a platform, an HTTPS vs HTTP // request, or the type of auction). Read-only. This field should not be // set in requests. ServingRestrictions []*CreativeServingRestrictions `json:"servingRestrictions,omitempty"` // VendorType: All vendor types for the ads that may be shown from this // snippet. VendorType []int64 `json:"vendorType,omitempty"` // VideoURL: The url to fetch a video ad. If set, HTMLSnippet should not // be set. VideoURL string `json:"videoURL,omitempty"` // Width: Ad width. Width int64 `json:"width,omitempty"` }
Creative: A creative and its classification data.
type CreativeCorrections ¶
type CreativeFilteringReasons ¶
type CreativeFilteringReasons struct { // Date: The date in ISO 8601 format for the data. The data is collected // from 00:00:00 to 23:59:59 in PST. Date string `json:"date,omitempty"` // Reasons: The filtering reasons. Reasons []*CreativeFilteringReasonsReasons `json:"reasons,omitempty"` }
CreativeFilteringReasons: The filtering reasons for the creative. Read-only. This field should not be set in requests.
type CreativeFilteringReasonsReasons ¶
type CreativeFilteringReasonsReasons struct { // FilteringCount: The number of times the creative was filtered for the // status. The count is aggregated across all publishers on the // exchange. FilteringCount int64 `json:"filteringCount,omitempty,string"` // FilteringStatus: The filtering status code. Please refer to the // creative-status-codes.txt file for different statuses. FilteringStatus int64 `json:"filteringStatus,omitempty"` }
type CreativeServingRestrictions ¶
type CreativeServingRestrictions struct { // Contexts: All known contexts/restrictions. Contexts []*CreativeServingRestrictionsContexts `json:"contexts,omitempty"` // DisapprovalReasons: The reasons for disapproval within this // restriction, if any. Note that not all disapproval reasons may be // categorized, so it is possible for the creative to have a status of // DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for // disapproval_reasons. In this case, please reach out to your TAM to // help debug the issue. DisapprovalReasons []*CreativeServingRestrictionsDisapprovalReasons `json:"disapprovalReasons,omitempty"` // Reason: Why the creative is ineligible to serve in this context // (e.g., it has been explicitly disapproved or is pending review). Reason string `json:"reason,omitempty"` }
type CreativeServingRestrictionsContexts ¶
type CreativeServingRestrictionsContexts struct { // AuctionType: Only set when contextType=AUCTION_TYPE. Represents the // auction types this restriction applies to. AuctionType []string `json:"auctionType,omitempty"` // ContextType: The type of context (e.g., location, platform, auction // type, SSL-ness). ContextType string `json:"contextType,omitempty"` // GeoCriteriaId: Only set when contextType=LOCATION. Represents the geo // criterias this restriction applies to. GeoCriteriaId []int64 `json:"geoCriteriaId,omitempty"` // Platform: Only set when contextType=PLATFORM. Represents the // platforms this restriction applies to. Platform []string `json:"platform,omitempty"` }
type CreativesGetCall ¶
type CreativesGetCall struct {
// contains filtered or unexported fields
}
func (*CreativesGetCall) Do ¶
func (c *CreativesGetCall) Do() (*Creative, error)
func (*CreativesGetCall) Fields ¶
func (c *CreativesGetCall) Fields(s ...googleapi.Field) *CreativesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type CreativesInsertCall ¶
type CreativesInsertCall struct {
// contains filtered or unexported fields
}
func (*CreativesInsertCall) Do ¶
func (c *CreativesInsertCall) Do() (*Creative, error)
func (*CreativesInsertCall) Fields ¶
func (c *CreativesInsertCall) Fields(s ...googleapi.Field) *CreativesInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type CreativesList ¶
type CreativesList struct { // Items: A list of creatives. Items []*Creative `json:"items,omitempty"` // Kind: Resource type. Kind string `json:"kind,omitempty"` // NextPageToken: Continuation token used to page through creatives. To // retrieve the next page of results, set the next request's "pageToken" // value to this. NextPageToken string `json:"nextPageToken,omitempty"` }
CreativesList: The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
type CreativesListCall ¶
type CreativesListCall struct {
// contains filtered or unexported fields
}
func (*CreativesListCall) AccountId ¶
func (c *CreativesListCall) AccountId(accountId int64) *CreativesListCall
AccountId sets the optional parameter "accountId": When specified, only creatives for the given account ids are returned.
func (*CreativesListCall) BuyerCreativeId ¶
func (c *CreativesListCall) BuyerCreativeId(buyerCreativeId string) *CreativesListCall
BuyerCreativeId sets the optional parameter "buyerCreativeId": When specified, only creatives for the given buyer creative ids are returned.
func (*CreativesListCall) DealsStatusFilter ¶
func (c *CreativesListCall) DealsStatusFilter(dealsStatusFilter string) *CreativesListCall
DealsStatusFilter sets the optional parameter "dealsStatusFilter": When specified, only creatives having the given direct deals status are returned.
Possible values:
"approved" - Creatives which have been approved for serving on
direct deals.
"conditionally_approved" - Creatives which have been conditionally
approved for serving on direct deals.
"disapproved" - Creatives which have been disapproved for serving
on direct deals.
"not_checked" - Creatives whose direct deals status is not yet
checked.
func (*CreativesListCall) Do ¶
func (c *CreativesListCall) Do() (*CreativesList, error)
func (*CreativesListCall) Fields ¶
func (c *CreativesListCall) Fields(s ...googleapi.Field) *CreativesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*CreativesListCall) MaxResults ¶
func (c *CreativesListCall) MaxResults(maxResults int64) *CreativesListCall
MaxResults sets the optional parameter "maxResults": Maximum number of entries returned on one result page. If not set, the default is 100.
func (*CreativesListCall) OpenAuctionStatusFilter ¶
func (c *CreativesListCall) OpenAuctionStatusFilter(openAuctionStatusFilter string) *CreativesListCall
OpenAuctionStatusFilter sets the optional parameter "openAuctionStatusFilter": When specified, only creatives having the given open auction status are returned.
Possible values:
"approved" - Creatives which have been approved for serving on the
open auction.
"conditionally_approved" - Creatives which have been conditionally
approved for serving on the open auction.
"disapproved" - Creatives which have been disapproved for serving
on the open auction.
"not_checked" - Creatives whose open auction status is not yet
checked.
func (*CreativesListCall) PageToken ¶
func (c *CreativesListCall) PageToken(pageToken string) *CreativesListCall
PageToken sets the optional parameter "pageToken": A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
type CreativesService ¶
type CreativesService struct {
// contains filtered or unexported fields
}
func NewCreativesService ¶
func NewCreativesService(s *Service) *CreativesService
func (*CreativesService) Get ¶
func (r *CreativesService) Get(accountId int64, buyerCreativeId string) *CreativesGetCall
Get: Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
func (*CreativesService) Insert ¶
func (r *CreativesService) Insert(creative *Creative) *CreativesInsertCall
Insert: Submit a new creative.
func (*CreativesService) List ¶
func (r *CreativesService) List() *CreativesListCall
List: Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
type PerformanceReport ¶
type PerformanceReport struct { // BidRate: The number of bid responses with an ad. BidRate float64 `json:"bidRate,omitempty"` // BidRequestRate: The number of bid requests sent to your bidder. BidRequestRate float64 `json:"bidRequestRate,omitempty"` // CalloutStatusRate: Rate of various prefiltering statuses per match. // Please refer to the callout-status-codes.txt file for different // statuses. CalloutStatusRate []interface{} `json:"calloutStatusRate,omitempty"` // CookieMatcherStatusRate: Average QPS for cookie matcher operations. CookieMatcherStatusRate []interface{} `json:"cookieMatcherStatusRate,omitempty"` // CreativeStatusRate: Rate of ads with a given status. Please refer to // the creative-status-codes.txt file for different statuses. CreativeStatusRate []interface{} `json:"creativeStatusRate,omitempty"` // FilteredBidRate: The number of bid responses that were filtered due // to a policy violation or other errors. FilteredBidRate float64 `json:"filteredBidRate,omitempty"` // HostedMatchStatusRate: Average QPS for hosted match operations. HostedMatchStatusRate []interface{} `json:"hostedMatchStatusRate,omitempty"` // InventoryMatchRate: The number of potential queries based on your // pretargeting settings. InventoryMatchRate float64 `json:"inventoryMatchRate,omitempty"` // Kind: Resource type. Kind string `json:"kind,omitempty"` // Latency50thPercentile: The 50th percentile round trip latency(ms) as // perceived from Google servers for the duration period covered by the // report. Latency50thPercentile float64 `json:"latency50thPercentile,omitempty"` // Latency85thPercentile: The 85th percentile round trip latency(ms) as // perceived from Google servers for the duration period covered by the // report. Latency85thPercentile float64 `json:"latency85thPercentile,omitempty"` // Latency95thPercentile: The 95th percentile round trip latency(ms) as // perceived from Google servers for the duration period covered by the // report. Latency95thPercentile float64 `json:"latency95thPercentile,omitempty"` // NoQuotaInRegion: Rate of various quota account statuses per quota // check. NoQuotaInRegion float64 `json:"noQuotaInRegion,omitempty"` // OutOfQuota: Rate of various quota account statuses per quota check. OutOfQuota float64 `json:"outOfQuota,omitempty"` // PixelMatchRequests: Average QPS for pixel match requests from // clients. PixelMatchRequests float64 `json:"pixelMatchRequests,omitempty"` // PixelMatchResponses: Average QPS for pixel match responses from // clients. PixelMatchResponses float64 `json:"pixelMatchResponses,omitempty"` // QuotaConfiguredLimit: The configured quota limits for this account. QuotaConfiguredLimit float64 `json:"quotaConfiguredLimit,omitempty"` // QuotaThrottledLimit: The throttled quota limits for this account. QuotaThrottledLimit float64 `json:"quotaThrottledLimit,omitempty"` // Region: The trading location of this data. Region string `json:"region,omitempty"` // SuccessfulRequestRate: The number of properly formed bid responses // received by our servers within the deadline. SuccessfulRequestRate float64 `json:"successfulRequestRate,omitempty"` // Timestamp: The unix timestamp of the starting time of this // performance data. Timestamp int64 `json:"timestamp,omitempty,string"` // UnsuccessfulRequestRate: The number of bid responses that were // unsuccessful due to timeouts, incorrect formatting, etc. UnsuccessfulRequestRate float64 `json:"unsuccessfulRequestRate,omitempty"` }
PerformanceReport: The configuration data for an Ad Exchange performance report list.
type PerformanceReportList ¶
type PerformanceReportList struct { // Kind: Resource type. Kind string `json:"kind,omitempty"` // PerformanceReport: A list of performance reports relevant for the // account. PerformanceReport []*PerformanceReport `json:"performanceReport,omitempty"` }
PerformanceReportList: The configuration data for an Ad Exchange performance report list. https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py
type PerformanceReportListCall ¶
type PerformanceReportListCall struct {
// contains filtered or unexported fields
}
func (*PerformanceReportListCall) Do ¶
func (c *PerformanceReportListCall) Do() (*PerformanceReportList, error)
func (*PerformanceReportListCall) Fields ¶
func (c *PerformanceReportListCall) Fields(s ...googleapi.Field) *PerformanceReportListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PerformanceReportListCall) MaxResults ¶
func (c *PerformanceReportListCall) MaxResults(maxResults int64) *PerformanceReportListCall
MaxResults sets the optional parameter "maxResults": Maximum number of entries returned on one result page. If not set, the default is 100.
func (*PerformanceReportListCall) PageToken ¶
func (c *PerformanceReportListCall) PageToken(pageToken string) *PerformanceReportListCall
PageToken sets the optional parameter "pageToken": A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
type PerformanceReportService ¶
type PerformanceReportService struct {
// contains filtered or unexported fields
}
func NewPerformanceReportService ¶
func NewPerformanceReportService(s *Service) *PerformanceReportService
func (*PerformanceReportService) List ¶
func (r *PerformanceReportService) List(accountId int64, endDateTime string, startDateTime string) *PerformanceReportListCall
List: Retrieves the authenticated user's list of performance metrics.
type PretargetingConfig ¶
type PretargetingConfig struct { // BillingId: The id for billing purposes, provided for reference. Leave // this field blank for insert requests; the id will be generated // automatically. BillingId int64 `json:"billingId,omitempty,string"` // ConfigId: The config id; generated automatically. Leave this field // blank for insert requests. ConfigId int64 `json:"configId,omitempty,string"` // ConfigName: The name of the config. Must be unique. Required for all // requests. ConfigName string `json:"configName,omitempty"` // CreativeType: List must contain exactly one of // PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO. CreativeType []string `json:"creativeType,omitempty"` // Dimensions: Requests which allow one of these (width, height) pairs // will match. All pairs must be supported ad dimensions. Dimensions []*PretargetingConfigDimensions `json:"dimensions,omitempty"` // ExcludedContentLabels: Requests with any of these content labels will // not match. Values are from content-labels.txt in the downloadable // files section. ExcludedContentLabels googleapi.Int64s `json:"excludedContentLabels,omitempty"` // ExcludedGeoCriteriaIds: Requests containing any of these geo criteria // ids will not match. ExcludedGeoCriteriaIds googleapi.Int64s `json:"excludedGeoCriteriaIds,omitempty"` // ExcludedPlacements: Requests containing any of these placements will // not match. ExcludedPlacements []*PretargetingConfigExcludedPlacements `json:"excludedPlacements,omitempty"` // ExcludedUserLists: Requests containing any of these users list ids // will not match. ExcludedUserLists googleapi.Int64s `json:"excludedUserLists,omitempty"` // ExcludedVerticals: Requests containing any of these vertical ids will // not match. Values are from the publisher-verticals.txt file in the // downloadable files section. ExcludedVerticals googleapi.Int64s `json:"excludedVerticals,omitempty"` // GeoCriteriaIds: Requests containing any of these geo criteria ids // will match. GeoCriteriaIds googleapi.Int64s `json:"geoCriteriaIds,omitempty"` // IsActive: Whether this config is active. Required for all requests. IsActive bool `json:"isActive,omitempty"` // Kind: The kind of the resource, i.e. // "adexchangebuyer#pretargetingConfig". Kind string `json:"kind,omitempty"` // Languages: Request containing any of these language codes will match. Languages []string `json:"languages,omitempty"` // MobileCarriers: Requests containing any of these mobile carrier ids // will match. Values are from mobile-carriers.csv in the downloadable // files section. MobileCarriers googleapi.Int64s `json:"mobileCarriers,omitempty"` // MobileDevices: Requests containing any of these mobile device ids // will match. Values are from mobile-devices.csv in the downloadable // files section. MobileDevices googleapi.Int64s `json:"mobileDevices,omitempty"` // MobileOperatingSystemVersions: Requests containing any of these // mobile operating system version ids will match. Values are from // mobile-os.csv in the downloadable files section. MobileOperatingSystemVersions googleapi.Int64s `json:"mobileOperatingSystemVersions,omitempty"` // Placements: Requests containing any of these placements will match. Placements []*PretargetingConfigPlacements `json:"placements,omitempty"` // Platforms: Requests matching any of these platforms will match. // Possible values are PRETARGETING_PLATFORM_MOBILE, // PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. Platforms []string `json:"platforms,omitempty"` // SupportedCreativeAttributes: Creative attributes should be declared // here if all creatives corresponding to this pretargeting // configuration have that creative attribute. Values are from // pretargetable-creative-attributes.txt in the downloadable files // section. SupportedCreativeAttributes googleapi.Int64s `json:"supportedCreativeAttributes,omitempty"` // UserLists: Requests containing any of these user list ids will match. UserLists googleapi.Int64s `json:"userLists,omitempty"` // VendorTypes: Requests that allow any of these vendor ids will match. // Values are from vendors.txt in the downloadable files section. VendorTypes googleapi.Int64s `json:"vendorTypes,omitempty"` // Verticals: Requests containing any of these vertical ids will match. Verticals googleapi.Int64s `json:"verticals,omitempty"` }
type PretargetingConfigDeleteCall ¶
type PretargetingConfigDeleteCall struct {
// contains filtered or unexported fields
}
func (*PretargetingConfigDeleteCall) Do ¶
func (c *PretargetingConfigDeleteCall) Do() error
func (*PretargetingConfigDeleteCall) Fields ¶
func (c *PretargetingConfigDeleteCall) Fields(s ...googleapi.Field) *PretargetingConfigDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type PretargetingConfigExcludedPlacements ¶
type PretargetingConfigExcludedPlacements struct { // Token: The value of the placement. Interpretation depends on the // placement type, e.g. URL for a site placement, channel name for a // channel placement, app id for a mobile app placement. Token string `json:"token,omitempty"` // Type: The type of the placement. Type string `json:"type,omitempty"` }
type PretargetingConfigGetCall ¶
type PretargetingConfigGetCall struct {
// contains filtered or unexported fields
}
func (*PretargetingConfigGetCall) Do ¶
func (c *PretargetingConfigGetCall) Do() (*PretargetingConfig, error)
func (*PretargetingConfigGetCall) Fields ¶
func (c *PretargetingConfigGetCall) Fields(s ...googleapi.Field) *PretargetingConfigGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type PretargetingConfigInsertCall ¶
type PretargetingConfigInsertCall struct {
// contains filtered or unexported fields
}
func (*PretargetingConfigInsertCall) Do ¶
func (c *PretargetingConfigInsertCall) Do() (*PretargetingConfig, error)
func (*PretargetingConfigInsertCall) Fields ¶
func (c *PretargetingConfigInsertCall) Fields(s ...googleapi.Field) *PretargetingConfigInsertCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type PretargetingConfigList ¶
type PretargetingConfigList struct { // Items: A list of pretargeting configs Items []*PretargetingConfig `json:"items,omitempty"` // Kind: Resource type. Kind string `json:"kind,omitempty"` }
type PretargetingConfigListCall ¶
type PretargetingConfigListCall struct {
// contains filtered or unexported fields
}
func (*PretargetingConfigListCall) Do ¶
func (c *PretargetingConfigListCall) Do() (*PretargetingConfigList, error)
func (*PretargetingConfigListCall) Fields ¶
func (c *PretargetingConfigListCall) Fields(s ...googleapi.Field) *PretargetingConfigListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type PretargetingConfigPatchCall ¶
type PretargetingConfigPatchCall struct {
// contains filtered or unexported fields
}
func (*PretargetingConfigPatchCall) Do ¶
func (c *PretargetingConfigPatchCall) Do() (*PretargetingConfig, error)
func (*PretargetingConfigPatchCall) Fields ¶
func (c *PretargetingConfigPatchCall) Fields(s ...googleapi.Field) *PretargetingConfigPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type PretargetingConfigPlacements ¶
type PretargetingConfigPlacements struct { // Token: The value of the placement. Interpretation depends on the // placement type, e.g. URL for a site placement, channel name for a // channel placement, app id for a mobile app placement. Token string `json:"token,omitempty"` // Type: The type of the placement. Type string `json:"type,omitempty"` }
type PretargetingConfigService ¶
type PretargetingConfigService struct {
// contains filtered or unexported fields
}
func NewPretargetingConfigService ¶
func NewPretargetingConfigService(s *Service) *PretargetingConfigService
func (*PretargetingConfigService) Delete ¶
func (r *PretargetingConfigService) Delete(accountId int64, configId int64) *PretargetingConfigDeleteCall
Delete: Deletes an existing pretargeting config.
func (*PretargetingConfigService) Get ¶
func (r *PretargetingConfigService) Get(accountId int64, configId int64) *PretargetingConfigGetCall
Get: Gets a specific pretargeting configuration
func (*PretargetingConfigService) Insert ¶
func (r *PretargetingConfigService) Insert(accountId int64, pretargetingconfig *PretargetingConfig) *PretargetingConfigInsertCall
Insert: Inserts a new pretargeting configuration.
func (*PretargetingConfigService) List ¶
func (r *PretargetingConfigService) List(accountId int64) *PretargetingConfigListCall
List: Retrieves a list of the authenticated user's pretargeting configurations.
func (*PretargetingConfigService) Patch ¶
func (r *PretargetingConfigService) Patch(accountId int64, configId int64, pretargetingconfig *PretargetingConfig) *PretargetingConfigPatchCall
Patch: Updates an existing pretargeting config. This method supports patch semantics.
func (*PretargetingConfigService) Update ¶
func (r *PretargetingConfigService) Update(accountId int64, configId int64, pretargetingconfig *PretargetingConfig) *PretargetingConfigUpdateCall
Update: Updates an existing pretargeting config.
type PretargetingConfigUpdateCall ¶
type PretargetingConfigUpdateCall struct {
// contains filtered or unexported fields
}
func (*PretargetingConfigUpdateCall) Do ¶
func (c *PretargetingConfigUpdateCall) Do() (*PretargetingConfig, error)
func (*PretargetingConfigUpdateCall) Fields ¶
func (c *PretargetingConfigUpdateCall) Fields(s ...googleapi.Field) *PretargetingConfigUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Accounts *AccountsService BillingInfo *BillingInfoService Budget *BudgetService Creatives *CreativesService PerformanceReport *PerformanceReportService PretargetingConfig *PretargetingConfigService // contains filtered or unexported fields }