@maxim_mazurok/gapi.client.datamanager-v1 0.2.20260722 → 0.2.20260729

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 +152 -6
  2. package/package.json +1 -1
  3. package/readme.md +5 -0
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://datamanager.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20260722
12
+ // Revision: 20260729
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -25,6 +25,12 @@ declare namespace gapi.client {
25
25
 
26
26
  namespace datamanager {
27
27
  interface AddressInfo {
28
+ /** Optional. The street and number of the user's address. Used only for Google Analytics. This field is hashed and possibly encrypted. Normalize the value before hashing: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace */
29
+ addressLine?: string;
30
+ /** Optional. The administrative area (state/province) of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace */
31
+ administrativeArea?: string;
32
+ /** Optional. The city of the user's address. Used only for Google Analytics. The value should be normalized as such: - Remove symbol characters - Convert to lowercase - Remove leading and trailing whitespace */
33
+ city?: string;
28
34
  /** Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. */
29
35
  familyName?: string;
30
36
  /** Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. */
@@ -103,7 +109,7 @@ declare namespace gapi.client {
103
109
  campaignId?: string;
104
110
  /** Required. The name of the associated campaign. */
105
111
  campaignName?: string;
106
- /** Optional. Information gathered about the device being used when the ad event happened. */
112
+ /** Required. Information gathered about the device being used when the ad event happened. */
107
113
  deviceInfo?: DeviceInfo;
108
114
  /** Optional. An ID created and managed by the caller that uniquely identifies this event. Required if you want to deduplicate ad events that are included in multiple requests. Otherwise, this field is optional. */
109
115
  eventId?: string;
@@ -143,7 +149,7 @@ declare namespace gapi.client {
143
149
  | 'PLATFORM_TYPE_TABLET';
144
150
  /** String value for platform type. */
145
151
  platformTypeString?: string;
146
- /** Required. The ISO 3166-2 country plus subdivision. */
152
+ /** Optional. The ISO 3166-2 country plus subdivision. */
147
153
  regionCode?: string;
148
154
  /** Required. The platform source of the ad, akin to the Google Analytics source. */
149
155
  source?: string;
@@ -196,10 +202,14 @@ declare namespace gapi.client {
196
202
  consent?: Consent;
197
203
  /** Optional. Defines which Destination to send the audience member to. */
198
204
  destinationReferences?: string[];
205
+ /** Encrypted Google User IDs. */
206
+ googleUserIdData?: GoogleUserIdData;
199
207
  /** Data identifying the user's mobile devices. */
200
208
  mobileData?: MobileData;
201
209
  /** [Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908). This feature is only available to data partners. */
202
210
  pairData?: PairData;
211
+ /** Partner-provided identifiers. */
212
+ partnerProvidedIdData?: PartnerProvidedIdData;
203
213
  /** Data related to publisher provided identifiers. This feature is only available to data partners. */
204
214
  ppidData?: PpidData;
205
215
  /** User-provided data that identifies the user. */
@@ -306,7 +316,7 @@ declare namespace gapi.client {
306
316
  browserVersion?: string;
307
317
  /** Optional. The category of device. For example, “desktop”, “tablet”, “mobile”, “smart TV”. */
308
318
  category?: string;
309
- /** Optional. The IP address of the device for the given context. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details. */
319
+ /** Optional. The IP address of the device for the given context. Required when used in an AdEvent. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details. */
310
320
  ipAddress?: string;
311
321
  /** Optional. The language the device uses in ISO 639-1 format. */
312
322
  languageCode?: string;
@@ -485,6 +495,29 @@ declare namespace gapi.client {
485
495
  /** Optional. The value the field to set. */
486
496
  value?: string;
487
497
  }
498
+ interface FieldWarning {
499
+ /** The detailed warning message describing the issue. */
500
+ description?: string;
501
+ /** The field path that triggered the warning. Uses the same format as google.rpc.BadRequest.FieldViolation.field. */
502
+ field?: string;
503
+ /** The warning reason. */
504
+ reason?:
505
+ | 'WARNING_REASON_UNSPECIFIED'
506
+ | 'WARNING_REASON_CUSTOM_VARIABLE_NOT_ENABLED'
507
+ | 'WARNING_REASON_CUSTOM_VARIABLE_NOT_PREDEFINED'
508
+ | 'WARNING_REASON_CART_DATA_NOT_SUPPORTED_WITH_GBRAID_OR_WBRAID'
509
+ | 'WARNING_REASON_CART_DATA_ITEM_MERCHANT_PRODUCT_ID_MISSING'
510
+ | 'WARNING_REASON_CART_DATA_ITEM_UNIT_PRICE_MISSING'
511
+ | 'WARNING_REASON_GENERIC'
512
+ | 'WARNING_REASON_INVALID_CLIENT_ID'
513
+ | 'WARNING_REASON_INVALID_SUBDIVISION_CODE'
514
+ | 'WARNING_REASON_INVALID_REGION_CODE'
515
+ | 'WARNING_REASON_INVALID_SUBCONTINENT_CODE'
516
+ | 'WARNING_REASON_INVALID_CONTINENT_CODE'
517
+ | 'WARNING_REASON_INVALID_DEVICE_CATEGORY'
518
+ | 'WARNING_REASON_INVALID_DEVICE_SCREEN_RESOLUTION'
519
+ | 'WARNING_REASON_INVALID_MERCHANT_ID';
520
+ }
488
521
  interface GcpWrappedKeyInfo {
489
522
  /** Required. The base64 encoded encrypted data encryption key. */
490
523
  encryptedDek?: string;
@@ -495,10 +528,14 @@ declare namespace gapi.client {
495
528
  /** Required. The [Workload Identity](//cloud.google.com/iam/docs/workload-identity-federation) pool provider required to use KEK. */
496
529
  wipProvider?: string;
497
530
  }
531
+ interface GoogleUserIdData {
532
+ /** Required. The list of encrypted google user IDs. */
533
+ googleUserIds?: string[];
534
+ }
498
535
  interface IngestAdEventsRequest {
499
536
  /** Required. Required (at least 1). A list of ad events. */
500
537
  adEvents?: AdEvent[];
501
- /** Optional. Information about encryption keys which are used to encrypt the data. */
538
+ /** Required. Information about encryption keys which are used to encrypt the data. */
502
539
  encryptionInfo?: EncryptionInfo;
503
540
  /** Optional. If true, the request is validated, but not executed. */
504
541
  validateOnly?: boolean;
@@ -521,16 +558,22 @@ declare namespace gapi.client {
521
558
  validateOnly?: boolean;
522
559
  }
523
560
  interface IngestAudienceMembersResponse {
561
+ /** Detailed row-level warnings with field paths. */
562
+ fieldWarnings?: FieldWarning[];
524
563
  /** The auto-generated ID of the request. */
525
564
  requestId?: string;
526
565
  }
527
566
  interface IngestAudienceMembersStatus {
528
567
  /** The status of the composite data ingestion to the destination. */
529
568
  compositeDataIngestionStatus?: IngestCompositeDataStatus;
569
+ /** The status of the google user id data ingestion to the destination. */
570
+ googleUserIdDataIngestionStatus?: IngestGoogleUserIdDataStatus;
530
571
  /** The status of the mobile data ingestion to the destination. */
531
572
  mobileDataIngestionStatus?: IngestMobileDataStatus;
532
573
  /** The status of the pair data ingestion to the destination. */
533
574
  pairDataIngestionStatus?: IngestPairDataStatus;
575
+ /** The status of the partner provided id data ingestion to the destination. */
576
+ partnerProvidedIdDataIngestionStatus?: IngestPartnerProvidedIdDataStatus;
534
577
  /** The status of the ppid data ingestion to the destination. */
535
578
  ppidDataIngestionStatus?: IngestPpidDataStatus;
536
579
  /** The status of the user data ingestion to the destination. */
@@ -594,6 +637,8 @@ declare namespace gapi.client {
594
637
  validateOnly?: boolean;
595
638
  }
596
639
  interface IngestEventsResponse {
640
+ /** Detailed row-level warnings with field paths. */
641
+ fieldWarnings?: FieldWarning[];
597
642
  /** The auto-generated ID of the request. */
598
643
  requestId?: string;
599
644
  }
@@ -601,6 +646,12 @@ declare namespace gapi.client {
601
646
  /** The total count of events sent in the upload request. Includes all events in the request, regardless of whether they were successfully ingested or not. */
602
647
  recordCount?: string;
603
648
  }
649
+ interface IngestGoogleUserIdDataStatus {
650
+ /** The total count of google user ids sent in the upload request for the destination. Includes all google user ids in the request, regardless of whether they were successfully ingested or not. */
651
+ googleUserIdCount?: string;
652
+ /** The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. */
653
+ recordCount?: string;
654
+ }
604
655
  interface IngestMobileDataStatus {
605
656
  /** The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not. */
606
657
  mobileIdCount?: string;
@@ -613,6 +664,12 @@ declare namespace gapi.client {
613
664
  /** The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. */
614
665
  recordCount?: string;
615
666
  }
667
+ interface IngestPartnerProvidedIdDataStatus {
668
+ /** The total count of partner provided ids sent in the upload request for the destination. Includes all partner provided ids in the request, regardless of whether they were successfully ingested or not. */
669
+ partnerProvidedIdCount?: string;
670
+ /** The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. */
671
+ recordCount?: string;
672
+ }
616
673
  interface IngestPpidDataStatus {
617
674
  /** The total count of ppids sent in the upload request for the destination. Includes all ppids in the request, regardless of whether they were successfully ingested or not. */
618
675
  ppidCount?: string;
@@ -751,7 +808,7 @@ declare namespace gapi.client {
751
808
  userInterestId?: string;
752
809
  }
753
810
  interface MobileData {
754
- /** Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 `mobileIds` can be provided in a single AudienceMember. */
811
+ /** Required. The list of mobile device IDs (Android advertising ID, iOS IDFA for Customer Match user lists and Android advertising ID, iOS IDFA, Xbox or Microsoft ID, Amazon Fire TV ID, Roku ID, Generic Device ID for basic user lists). At most 10 `mobileIds` can be provided in a single AudienceMember. */
755
812
  mobileIds?: string[];
756
813
  }
757
814
  interface MobileIdInfo {
@@ -824,6 +881,10 @@ declare namespace gapi.client {
824
881
  /** Optional. The list of implicit accounts. */
825
882
  implicitAccounts?: PartnerCustomerAccount[];
826
883
  }
884
+ interface PartnerProvidedIdData {
885
+ /** Required. The list of partner-provided identifiers. */
886
+ partnerProvidedIds?: string[];
887
+ }
827
888
  interface PpidData {
828
889
  /** Required. The list of publisher provided identifiers for a user. */
829
890
  ppids?: string[];
@@ -856,6 +917,19 @@ declare namespace gapi.client {
856
917
  syncStatus?:
857
918
  'SYNC_STATUS_UNSPECIFIED' | 'CREATED' | 'READY_FOR_USE' | 'FAILED';
858
919
  }
920
+ interface RemoveAllAudienceMembersRequest {
921
+ /** Required. The list of destinations to remove the users from. */
922
+ destinations?: Destination[];
923
+ /** Optional. The remove as of time. If set, only audience members last added before this time will be removed. If not set, it defaults to current time. The remove as of time must not be in the future. */
924
+ removeAsOfTime?: string;
925
+ /** Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results. */
926
+ validateOnly?: boolean;
927
+ }
928
+ interface RemoveAllAudienceMembersResponse {
929
+ /** The auto-generated ID of the request. */
930
+ requestId?: string;
931
+ }
932
+ interface RemoveAllAudienceMembersStatus {}
859
933
  interface RemoveAudienceMembersRequest {
860
934
  /** Required. The list of users to remove. */
861
935
  audienceMembers?: AudienceMember[];
@@ -875,10 +949,14 @@ declare namespace gapi.client {
875
949
  interface RemoveAudienceMembersStatus {
876
950
  /** The status of the composite data removal from the destination. */
877
951
  compositeDataRemovalStatus?: RemoveCompositeDataStatus;
952
+ /** The status of the google user id data removal from the destination. */
953
+ googleUserIdDataRemovalStatus?: RemoveGoogleUserIdDataStatus;
878
954
  /** The status of the mobile data removal from the destination. */
879
955
  mobileDataRemovalStatus?: RemoveMobileDataStatus;
880
956
  /** The status of the pair data removal from the destination. */
881
957
  pairDataRemovalStatus?: RemovePairDataStatus;
958
+ /** The status of the partner provided id data removal from the destination. */
959
+ partnerProvidedIdDataRemovalStatus?: RemovePartnerProvidedIdDataStatus;
882
960
  /** The status of the ppid data removal from the destination. */
883
961
  ppidDataRemovalStatus?: RemovePpidDataStatus;
884
962
  /** The status of the user data removal from the destination. */
@@ -892,6 +970,12 @@ declare namespace gapi.client {
892
970
  /** The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. */
893
971
  recordCount?: string;
894
972
  }
973
+ interface RemoveGoogleUserIdDataStatus {
974
+ /** The total count of google user ids sent in the removal request. Includes all google user ids in the request, regardless of whether they were successfully removed or not. */
975
+ googleUserIdCount?: string;
976
+ /** The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. */
977
+ recordCount?: string;
978
+ }
895
979
  interface RemoveMobileDataStatus {
896
980
  /** The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not. */
897
981
  mobileIdCount?: string;
@@ -904,6 +988,12 @@ declare namespace gapi.client {
904
988
  /** The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. */
905
989
  recordCount?: string;
906
990
  }
991
+ interface RemovePartnerProvidedIdDataStatus {
992
+ /** The total count of partner provided ids sent in the removal request. Includes all partner provided ids in the request, regardless of whether they were successfully removed or not. */
993
+ partnerProvidedIdCount?: string;
994
+ /** The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. */
995
+ recordCount?: string;
996
+ }
907
997
  interface RemovePpidDataStatus {
908
998
  /** The total count of ppids sent in the removal request. Includes all ppids in the request, regardless of whether they were successfully removed or not. */
909
999
  ppidCount?: string;
@@ -933,6 +1023,8 @@ declare namespace gapi.client {
933
1023
  errorInfo?: ErrorInfo;
934
1024
  /** The status of the ingest events request. */
935
1025
  eventsIngestionStatus?: IngestEventsStatus;
1026
+ /** The status of the remove all audience members request. */
1027
+ removeAllAudienceMembersStatus?: any;
936
1028
  /** The request status of the destination. */
937
1029
  requestStatus?:
938
1030
  | 'REQUEST_STATUS_UNKNOWN'
@@ -2222,6 +2314,60 @@ declare namespace gapi.client {
2222
2314
  },
2223
2315
  body: RemoveAudienceMembersRequest,
2224
2316
  ): Request<RemoveAudienceMembersResponse>;
2317
+ /** Removes all audience members from the provided destinations. */
2318
+ removeAll(request: {
2319
+ /** V1 error format. */
2320
+ '$.xgafv'?: '1' | '2';
2321
+ /** OAuth access token. */
2322
+ access_token?: string;
2323
+ /** Data format for response. */
2324
+ alt?: 'json' | 'media' | 'proto';
2325
+ /** JSONP */
2326
+ callback?: string;
2327
+ /** Selector specifying which fields to include in a partial response. */
2328
+ fields?: string;
2329
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2330
+ key?: string;
2331
+ /** OAuth 2.0 token for the current user. */
2332
+ oauth_token?: string;
2333
+ /** Returns response with indentations and line breaks. */
2334
+ prettyPrint?: boolean;
2335
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2336
+ quotaUser?: string;
2337
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2338
+ upload_protocol?: string;
2339
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2340
+ uploadType?: string;
2341
+ /** Request body */
2342
+ resource: RemoveAllAudienceMembersRequest;
2343
+ }): Request<RemoveAllAudienceMembersResponse>;
2344
+ removeAll(
2345
+ request: {
2346
+ /** V1 error format. */
2347
+ '$.xgafv'?: '1' | '2';
2348
+ /** OAuth access token. */
2349
+ access_token?: string;
2350
+ /** Data format for response. */
2351
+ alt?: 'json' | 'media' | 'proto';
2352
+ /** JSONP */
2353
+ callback?: string;
2354
+ /** Selector specifying which fields to include in a partial response. */
2355
+ fields?: string;
2356
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2357
+ key?: string;
2358
+ /** OAuth 2.0 token for the current user. */
2359
+ oauth_token?: string;
2360
+ /** Returns response with indentations and line breaks. */
2361
+ prettyPrint?: boolean;
2362
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2363
+ quotaUser?: string;
2364
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2365
+ upload_protocol?: string;
2366
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2367
+ uploadType?: string;
2368
+ },
2369
+ body: RemoveAllAudienceMembersRequest,
2370
+ ): Request<RemoveAllAudienceMembersResponse>;
2225
2371
  }
2226
2372
  interface EventsResource {
2227
2373
  /** Uploads a list of Event resources from the provided Destination. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.datamanager-v1",
3
- "version": "0.2.20260722",
3
+ "version": "0.2.20260729",
4
4
  "description": "TypeScript typings for Data Manager API v1",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -99,6 +99,11 @@ Removes a list of AudienceMember resources from the provided Destination.
99
99
  */
100
100
  await gapi.client.datamanager.audienceMembers.remove({});
101
101
 
102
+ /*
103
+ Removes all audience members from the provided destinations.
104
+ */
105
+ await gapi.client.datamanager.audienceMembers.removeAll({});
106
+
102
107
  /*
103
108
  Uploads a list of Event resources from the provided Destination.
104
109
  */