google-api-go-client: document arrays of enums and add struct descrip…

…tions. Also, don't break URLs in comments. This improves issue googleapis#2. Change-Id: I32fbbe26238f5c1527a7e9cd42b063749f76d881 Reviewed-on: https://code-review.googlesource.com/3240 Reviewed-by: Brad Fitzpatrick <[email protected]>
R4CHI7 · Jul 28, 2015 · ca04995 · ca04995
1 parent a0c5ebc
commit ca04995
Show file tree

Hide file tree

Showing 129 changed files with 6,343 additions and 73 deletions.
diff --git a/adexchangebuyer/v1.2/adexchangebuyer-gen.go b/adexchangebuyer/v1.2/adexchangebuyer-gen.go
@@ -92,6 +92,7 @@ type CreativesService struct {
  s *Service
 }
 
+// Account: Configuration data for an Ad Exchange buyer account.
 type Account struct {
  // BidderLocation: Your bidder locations that have distinct URLs.
  BidderLocation []*AccountBidderLocation `json:"bidderLocation,omitempty"`
@@ -143,6 +144,9 @@ type AccountBidderLocation struct {
  Url string `json:"url,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 AccountsList struct {
  // Items: A list of accounts.
  Items []*Account `json:"items,omitempty"`
@@ -151,6 +155,7 @@ type AccountsList struct {
  Kind string `json:"kind,omitempty"`
 }
 
+// Creative: A creative and its classification data.
 type Creative struct {
  // HTMLSnippet: The HTML snippet that displays the ad when inserted in
  // the web page. If set, videoURL should not be set.
@@ -247,6 +252,8 @@ type CreativeDisapprovalReasons struct {
  Reason string `json:"reason,omitempty"`
 }
 
+// CreativeFilteringReasons: The filtering reasons for the creative.
+// Read-only. This field should not be set in requests.
 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.
@@ -267,6 +274,9 @@ type CreativeFilteringReasonsReasons struct {
  FilteringStatus int64 `json:"filteringStatus,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 CreativesList struct {
  // Items: A list of creatives.
  Items []*Creative `json:"items,omitempty"`

diff --git a/adexchangebuyer/v1.3/adexchangebuyer-gen.go b/adexchangebuyer/v1.3/adexchangebuyer-gen.go
@@ -152,6 +152,7 @@ type PretargetingConfigService struct {
  s *Service
 }
 
+// Account: Configuration data for an Ad Exchange buyer account.
 type Account struct {
  // BidderLocation: Your bidder locations that have distinct URLs.
  BidderLocation []*AccountBidderLocation `json:"bidderLocation,omitempty"`
@@ -203,6 +204,9 @@ type AccountBidderLocation struct {
  Url string `json:"url,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 AccountsList struct {
  // Items: A list of accounts.
  Items []*Account `json:"items,omitempty"`
@@ -211,6 +215,7 @@ type AccountsList struct {
  Kind string `json:"kind,omitempty"`
 }
 
+// BillingInfo: The configuration data for an Ad Exchange billing info.
 type BillingInfo struct {
  // AccountId: Account id.
  AccountId int64 `json:"accountId,omitempty"`
@@ -227,6 +232,9 @@ type BillingInfo struct {
  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 BillingInfoList struct {
  // Items: A list of billing info relevant for your account.
  Items []*BillingInfo `json:"items,omitempty"`
@@ -235,6 +243,7 @@ type BillingInfoList struct {
  Kind string `json:"kind,omitempty"`
 }
 
+// Budget: The configuration data for Ad Exchange RTB - Budget API.
 type Budget struct {
  // AccountId: The id of the account. This is required for get and update
  // requests.
@@ -259,6 +268,7 @@ type Budget struct {
  Kind string `json:"kind,omitempty"`
 }
 
+// Creative: A creative and its classification data.
 type Creative struct {
  // HTMLSnippet: The HTML snippet that displays the ad when inserted in
  // the web page. If set, videoURL should not be set.
@@ -355,6 +365,8 @@ type CreativeDisapprovalReasons struct {
  Reason string `json:"reason,omitempty"`
 }
 
+// CreativeFilteringReasons: The filtering reasons for the creative.
+// Read-only. This field should not be set in requests.
 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.
@@ -375,6 +387,9 @@ type CreativeFilteringReasonsReasons struct {
  FilteringStatus int64 `json:"filteringStatus,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 CreativesList struct {
  // Items: A list of creatives.
  Items []*Creative `json:"items,omitempty"`
@@ -388,6 +403,7 @@ type CreativesList struct {
  NextPageToken string `json:"nextPageToken,omitempty"`
 }
 
+// DirectDeal: The configuration data for an Ad Exchange direct deal.
 type DirectDeal struct {
  // AccountId: The account id of the buyer this deal is for.
  AccountId int64 `json:"accountId,omitempty"`
@@ -438,6 +454,9 @@ type DirectDeal struct {
  StartTime int64 `json:"startTime,omitempty,string"`
 }
 
+// DirectDealsList: A direct deals feed lists Direct Deals the Ad
+// Exchange buyer account has access to. This includes direct deals set
+// up for the buyer account as well as its merged stream seats.
 type DirectDealsList struct {
  // DirectDeals: A list of direct deals relevant for your account.
  DirectDeals []*DirectDeal `json:"directDeals,omitempty"`
@@ -446,6 +465,8 @@ type DirectDealsList struct {
  Kind string `json:"kind,omitempty"`
 }
 
+// PerformanceReport: The configuration data for an Ad Exchange
+// performance report list.
 type PerformanceReport struct {
  // BidRate: The number of bid responses with an ad.
  BidRate float64 `json:"bidRate,omitempty"`
@@ -531,6 +552,10 @@ type PerformanceReport struct {
  UnsuccessfulRequestRate float64 `json:"unsuccessfulRequestRate,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 PerformanceReportList struct {
  // Kind: Resource type.
  Kind string `json:"kind,omitempty"`

diff --git a/adexchangebuyer/v1.4/adexchangebuyer-gen.go b/adexchangebuyer/v1.4/adexchangebuyer-gen.go
@@ -140,6 +140,7 @@ type PretargetingConfigService struct {
  s *Service
 }
 
+// Account: Configuration data for an Ad Exchange buyer account.
 type Account struct {
  // BidderLocation: Your bidder locations that have distinct URLs.
  BidderLocation []*AccountBidderLocation `json:"bidderLocation,omitempty"`
@@ -191,6 +192,9 @@ type AccountBidderLocation struct {
  Url string `json:"url,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 AccountsList struct {
  // Items: A list of accounts.
  Items []*Account `json:"items,omitempty"`
@@ -199,6 +203,7 @@ type AccountsList struct {
  Kind string `json:"kind,omitempty"`
 }
 
+// BillingInfo: The configuration data for an Ad Exchange billing info.
 type BillingInfo struct {
  // AccountId: Account id.
  AccountId int64 `json:"accountId,omitempty"`
@@ -215,6 +220,9 @@ type BillingInfo struct {
  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 BillingInfoList struct {
  // Items: A list of billing info relevant for your account.
  Items []*BillingInfo `json:"items,omitempty"`
@@ -223,6 +231,7 @@ type BillingInfoList struct {
  Kind string `json:"kind,omitempty"`
 }
 
+// Budget: The configuration data for Ad Exchange RTB - Budget API.
 type Budget struct {
  // AccountId: The id of the account. This is required for get and update
  // requests.
@@ -247,6 +256,7 @@ type Budget struct {
  Kind string `json:"kind,omitempty"`
 }
 
+// Creative: A creative and its classification data.
 type Creative struct {
  // HTMLSnippet: The HTML snippet that displays the ad when inserted in
  // the web page. If set, videoURL should not be set.
@@ -346,6 +356,8 @@ type CreativeCorrections struct {
  Reason string `json:"reason,omitempty"`
 }
 
+// CreativeFilteringReasons: The filtering reasons for the creative.
+// Read-only. This field should not be set in requests.
 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.
@@ -409,6 +421,9 @@ type CreativeServingRestrictionsDisapprovalReasons struct {
  Reason string `json:"reason,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 CreativesList struct {
  // Items: A list of creatives.
  Items []*Creative `json:"items,omitempty"`
@@ -422,6 +437,8 @@ type CreativesList struct {
  NextPageToken string `json:"nextPageToken,omitempty"`
 }
 
+// PerformanceReport: The configuration data for an Ad Exchange
+// performance report list.
 type PerformanceReport struct {
  // BidRate: The number of bid responses with an ad.
  BidRate float64 `json:"bidRate,omitempty"`
@@ -507,6 +524,10 @@ type PerformanceReport struct {
  UnsuccessfulRequestRate float64 `json:"unsuccessfulRequestRate,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 PerformanceReportList struct {
  // Kind: Resource type.
  Kind string `json:"kind,omitempty"`

diff --git a/adexchangeseller/v1.1/adexchangeseller-gen.go b/adexchangeseller/v1.1/adexchangeseller-gen.go
@@ -383,6 +383,8 @@ type CustomChannel struct {
  TargetingInfo *CustomChannelTargetingInfo `json:"targetingInfo,omitempty"`
 }
 
+// CustomChannelTargetingInfo: The targeting information of this custom
+// channel, if activated.
 type CustomChannelTargetingInfo struct {
  // AdsAppearOn: The name used to describe this channel externally.
  AdsAppearOn string `json:"adsAppearOn,omitempty"`

diff --git a/adexchangeseller/v1/adexchangeseller-gen.go b/adexchangeseller/v1/adexchangeseller-gen.go
@@ -268,6 +268,8 @@ type CustomChannel struct {
  TargetingInfo *CustomChannelTargetingInfo `json:"targetingInfo,omitempty"`
 }
 
+// CustomChannelTargetingInfo: The targeting information of this custom
+// channel, if activated.
 type CustomChannelTargetingInfo struct {
  // AdsAppearOn: The name used to describe this channel externally.
  AdsAppearOn string `json:"adsAppearOn,omitempty"`

diff --git a/adexchangeseller/v2.0/adexchangeseller-gen.go b/adexchangeseller/v2.0/adexchangeseller-gen.go
@@ -319,6 +319,8 @@ type CustomChannel struct {
  TargetingInfo *CustomChannelTargetingInfo `json:"targetingInfo,omitempty"`
 }
 
+// CustomChannelTargetingInfo: The targeting information of this custom
+// channel, if activated.
 type CustomChannelTargetingInfo struct {
  // AdsAppearOn: The name used to describe this channel externally.
  AdsAppearOn string `json:"adsAppearOn,omitempty"`