@maxim_mazurok/gapi.client.adexchangebuyer2-v2beta1 0.0.20220912 → 0.0.20220914

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +31 -31
  2. package/package.json +1 -1
  3. package/tests.ts +5 -5
package/index.d.ts CHANGED
@@ -10,7 +10,7 @@
10
10
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
11
11
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
12
12
  // Generated from: https://adexchangebuyer.googleapis.com/$discovery/rest?version=v2beta1
13
- // Revision: 20220912
13
+ // Revision: 20220914
14
14
 
15
15
  /// <reference types="gapi.client" />
16
16
 
@@ -199,7 +199,7 @@ declare namespace gapi.client {
199
199
  advertiserName?: string;
200
200
  /** The agency ID for this creative. */
201
201
  agencyId?: string;
202
- /** Output only. The last update timestamp of the creative via API. */
202
+ /** Output only. The last update timestamp of the creative through the API. */
203
203
  apiUpdateTime?: string;
204
204
  /** All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. */
205
205
  attributes?: string[];
@@ -249,7 +249,7 @@ declare namespace gapi.client {
249
249
  restrictedCategories?: string[];
250
250
  /**
251
251
  * Output only. 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
252
- * vs HTTP request, or the type of auction).
252
+ * versus HTTP request, or the type of auction).
253
253
  */
254
254
  servingRestrictions?: ServingRestriction[];
255
255
  /** All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. */
@@ -338,7 +338,7 @@ declare namespace gapi.client {
338
338
  availableEndTime?: string;
339
339
  /**
340
340
  * Optional. 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
341
- * with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds.
341
+ * with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
342
342
  */
343
343
  availableStartTime?: string;
344
344
  /** Buyer private data (hidden from seller). */
@@ -358,7 +358,7 @@ declare namespace gapi.client {
358
358
  createTime?: string;
359
359
  /** Output only. Specifies the creative pre-approval policy. */
360
360
  creativePreApprovalPolicy?: string;
361
- /** Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. */
361
+ /** Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. */
362
362
  creativeRestrictions?: CreativeRestrictions;
363
363
  /** Output only. Specifies whether the creative is safeFrame compatible. */
364
364
  creativeSafeFrameCompatibility?: string;
@@ -483,13 +483,13 @@ declare namespace gapi.client {
483
483
  */
484
484
  breakdownDimensions?: string[];
485
485
  /**
486
- * The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the
487
- * `bidders/*‍/accounts/*‍/filterSets/*` pattern.
486
+ * The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name
487
+ * matches the `bidders/*‍/accounts/*‍/filterSets/*` pattern.
488
488
  */
489
489
  creativeId?: string;
490
490
  /**
491
- * The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the
492
- * `bidders/*‍/accounts/*‍/filterSets/*` pattern.
491
+ * The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches
492
+ * the `bidders/*‍/accounts/*‍/filterSets/*` pattern.
493
493
  */
494
494
  dealId?: string;
495
495
  /** The environment on which to filter; optional. */
@@ -507,7 +507,7 @@ declare namespace gapi.client {
507
507
  */
508
508
  name?: string;
509
509
  /**
510
- * The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the
510
+ * The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the
511
511
  * platforms).
512
512
  */
513
513
  platforms?: string[];
@@ -519,11 +519,11 @@ declare namespace gapi.client {
519
519
  relativeDateRange?: RelativeDateRange;
520
520
  /**
521
521
  * For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed
522
- * together (i.e., if non-empty, results must match any one of the publisher networks). See
522
+ * together (for example, if non-empty, results must match any one of the publisher networks). See
523
523
  * [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.
524
524
  */
525
525
  sellerNetworkIds?: number[];
526
- /** The granularity of time intervals if a time series breakdown is desired; optional. */
526
+ /** The granularity of time intervals if a time series breakdown is preferred; optional. */
527
527
  timeSeriesGranularity?: string;
528
528
  }
529
529
  interface FirstPartyMobileApplicationTargeting {
@@ -697,7 +697,7 @@ declare namespace gapi.client {
697
697
  nextPageToken?: string;
698
698
  }
699
699
  interface ListFilteredBidsResponse {
700
- /** List of rows, with counts of filtered bids aggregated by filtering reason (i.e. creative status). */
700
+ /** List of rows, with counts of filtered bids aggregated by filtering reason (for example, creative status). */
701
701
  creativeStatusRows?: CreativeStatusRow[];
702
702
  /**
703
703
  * A token to retrieve the next page of results. Pass this value in the ListFilteredBidsRequest.pageToken field in the subsequent call to the filteredBids.list method to retrieve the
@@ -724,7 +724,7 @@ declare namespace gapi.client {
724
724
  nextPageToken?: string;
725
725
  }
726
726
  interface ListLosingBidsResponse {
727
- /** List of rows, with counts of losing bids aggregated by loss reason (i.e. creative status). */
727
+ /** List of rows, with counts of losing bids aggregated by loss reason (for example, creative status). */
728
728
  creativeStatusRows?: CreativeStatusRow[];
729
729
  /**
730
730
  * A token to retrieve the next page of results. Pass this value in the ListLosingBidsRequest.pageToken field in the subsequent call to the losingBids.list method to retrieve the next
@@ -761,8 +761,8 @@ declare namespace gapi.client {
761
761
  }
762
762
  interface LocationContext {
763
763
  /**
764
- * IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo
765
- * criteria IDs.
764
+ * IDs representing the geo location for this context. Refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria
765
+ * IDs.
766
766
  */
767
767
  geoCriteriaIds?: number[];
768
768
  }
@@ -771,9 +771,9 @@ declare namespace gapi.client {
771
771
  geoTargeting?: CriteriaTargeting;
772
772
  /** Inventory sizes to be included/excluded. */
773
773
  inventorySizeTargeting?: InventorySizeTargeting;
774
- /** Placement targeting information, e.g., URL, mobile applications. */
774
+ /** Placement targeting information, for example, URL, mobile applications. */
775
775
  placementTargeting?: PlacementTargeting;
776
- /** Technology targeting information, e.g., operating system, device category. */
776
+ /** Technology targeting information, for example, operating system, device category. */
777
777
  technologyTargeting?: TechnologyTargeting;
778
778
  /** Video targeting information. */
779
779
  videoTargeting?: VideoTargeting;
@@ -782,9 +782,9 @@ declare namespace gapi.client {
782
782
  /** The expected value of the metric. */
783
783
  value?: string;
784
784
  /**
785
- * The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using
786
- * the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError
787
- * = 100 * Z * sqrt(variance) / value
785
+ * The variance (for example, square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of
786
+ * value, using the following formula, where Z is the standard constant that depends on the preferred size of the confidence interval (for example, for 90% confidence interval, use Z =
787
+ * 1.645): marginOfError = 100 * Z * sqrt(variance) / value
788
788
  */
789
789
  variance?: string;
790
790
  }
@@ -1047,9 +1047,9 @@ declare namespace gapi.client {
1047
1047
  startTimestamp?: string;
1048
1048
  }
1049
1049
  interface RelativeDateRange {
1050
- /** The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7. */
1050
+ /** The number of days in the requested date range, for example, for a range spanning today: 1. For a range spanning the last 7 days: 7. */
1051
1051
  durationDays?: number;
1052
- /** The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0. */
1052
+ /** The end date of the filter set, specified as the number of days before today, for example, for a range where the last date is today: 0. */
1053
1053
  offsetDays?: number;
1054
1054
  }
1055
1055
  interface RemoveDealAssociationRequest {
@@ -1103,8 +1103,8 @@ declare namespace gapi.client {
1103
1103
  /** Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. */
1104
1104
  disapproval?: Disapproval;
1105
1105
  /**
1106
- * Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval
1107
- * field instead.
1106
+ * Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; use disapproval field
1107
+ * instead.
1108
1108
  */
1109
1109
  disapprovalReasons?: Disapproval[];
1110
1110
  /** The status of the creative in this context (for example, it has been explicitly disapproved or is pending review). */
@@ -1918,8 +1918,8 @@ declare namespace gapi.client {
1918
1918
  /** OAuth 2.0 token for the current user. */
1919
1919
  oauth_token?: string;
1920
1920
  /**
1921
- * Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will
1922
- * pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
1921
+ * Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server
1922
+ * will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
1923
1923
  */
1924
1924
  pageSize?: number;
1925
1925
  /**
@@ -2169,8 +2169,8 @@ declare namespace gapi.client {
2169
2169
  }): Request<ListProposalsResponse>;
2170
2170
  /**
2171
2171
  * Update given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this
2172
- * method only applies to PG and PD deals. For PA deals, please call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call
2173
- * PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
2172
+ * method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals
2173
+ * for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
2174
2174
  */
2175
2175
  pause(request: {
2176
2176
  /** V1 error format. */
@@ -2233,8 +2233,8 @@ declare namespace gapi.client {
2233
2233
  body: PauseProposalDealsRequest): Request<Proposal>;
2234
2234
  /**
2235
2235
  * Update given deals to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all listed deals in the request. Currently,
2236
- * this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party.
2237
- * It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
2236
+ * this method only applies to PG and PD deals. For PA deals, call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is
2237
+ * an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
2238
2238
  */
2239
2239
  resume(request: {
2240
2240
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.adexchangebuyer2-v2beta1",
3
- "version": "0.0.20220912",
3
+ "version": "0.0.20220914",
4
4
  "description": "TypeScript typings for Ad Exchange Buyer API II v2beta1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20220912
6
+ // Revision: 20220914
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -535,8 +535,8 @@ gapi.load('client', async () => {
535
535
  });
536
536
  /**
537
537
  * Update given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this
538
- * method only applies to PG and PD deals. For PA deals, please call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call
539
- * PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
538
+ * method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for
539
+ * deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
540
540
  */
541
541
  await gapi.client.adexchangebuyer2.accounts.finalizedProposals.pause({
542
542
  accountId: "Test string",
@@ -549,8 +549,8 @@ gapi.load('client', async () => {
549
549
  });
550
550
  /**
551
551
  * Update given deals to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all listed deals in the request. Currently, this
552
- * method only applies to PG and PD deals. For PA deals, please call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an
553
- * error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
552
+ * method only applies to PG and PD deals. For PA deals, call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error
553
+ * to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.
554
554
  */
555
555
  await gapi.client.adexchangebuyer2.accounts.finalizedProposals.resume({
556
556
  accountId: "Test string",