google-api-python-client 2.196.0__py3-none-any.whl → 2.198.0__py3-none-any.whl
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.
- {google_api_python_client-2.196.0.dist-info → google_api_python_client-2.198.0.dist-info}/METADATA +1 -1
- {google_api_python_client-2.196.0.dist-info → google_api_python_client-2.198.0.dist-info}/RECORD +269 -264
- googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +6 -6
- googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +10 -2
- googleapiclient/discovery_cache/documents/admin.directory_v1.json +14 -4
- googleapiclient/discovery_cache/documents/admin.directoryv1.json +14 -4
- googleapiclient/discovery_cache/documents/admin.reports_v1.json +8 -4
- googleapiclient/discovery_cache/documents/admin.reportsv1.json +8 -4
- googleapiclient/discovery_cache/documents/admob.v1.json +3 -3
- googleapiclient/discovery_cache/documents/admob.v1beta.json +3 -3
- googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json +58 -46
- googleapiclient/discovery_cache/documents/aiplatform.v1.json +2128 -279
- googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +9049 -1244
- googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +17 -3
- googleapiclient/discovery_cache/documents/alloydb.v1.json +60 -7
- googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +58 -2
- googleapiclient/discovery_cache/documents/alloydb.v1beta.json +58 -2
- googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +39 -1
- googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +5 -1
- googleapiclient/discovery_cache/documents/analyticshub.v1.json +39 -2
- googleapiclient/discovery_cache/documents/androidmanagement.v1.json +79 -2
- googleapiclient/discovery_cache/documents/androidpublisher.v3.json +73 -8
- googleapiclient/discovery_cache/documents/apigee.v1.json +12 -7
- googleapiclient/discovery_cache/documents/apphub.v1.json +5 -5
- googleapiclient/discovery_cache/documents/apphub.v1alpha.json +5 -5
- googleapiclient/discovery_cache/documents/artifactregistry.v1.json +292 -3
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +3 -3
- googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +83 -1
- googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +147 -1
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +2 -2
- googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json +2 -2
- googleapiclient/discovery_cache/documents/backupdr.v1.json +69 -5
- googleapiclient/discovery_cache/documents/batch.v1.json +2 -2
- googleapiclient/discovery_cache/documents/beyondcorp.v1.json +3 -3
- googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +3 -3
- googleapiclient/discovery_cache/documents/bigquery.v2.json +144 -43
- googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json +44 -1
- googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json +20 -1
- googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +32 -1
- googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +3 -3
- googleapiclient/discovery_cache/documents/blogger.v3.json +2 -2
- googleapiclient/discovery_cache/documents/calendar.v3.json +14 -5
- googleapiclient/discovery_cache/documents/ces.v1.json +625 -176
- googleapiclient/discovery_cache/documents/ces.v1beta.json +893 -181
- googleapiclient/discovery_cache/documents/chat.v1.json +49 -9
- googleapiclient/discovery_cache/documents/chromemanagement.v1.json +844 -3
- googleapiclient/discovery_cache/documents/chromewebstore.v2.json +39 -1
- googleapiclient/discovery_cache/documents/classroom.v1.json +29 -5
- googleapiclient/discovery_cache/documents/cloudbuild.v1.json +48 -1
- googleapiclient/discovery_cache/documents/cloudbuild.v2.json +3 -3
- googleapiclient/discovery_cache/documents/cloudchannel.v1.json +2 -2
- googleapiclient/discovery_cache/documents/clouddeploy.v1.json +70 -3
- googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json +163 -13
- googleapiclient/discovery_cache/documents/cloudidentity.v1.json +78 -5
- googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +115 -5
- googleapiclient/discovery_cache/documents/cloudkms.v1.json +104 -45
- googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json +1 -3
- googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json +1 -3
- googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json +2534 -0
- googleapiclient/discovery_cache/documents/cloudproductregistry.v1.json +546 -0
- googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +5 -5
- googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +5 -5
- googleapiclient/discovery_cache/documents/cloudsearch.v1.json +4 -4
- googleapiclient/discovery_cache/documents/cloudsupport.v2.json +57 -2
- googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +21 -16
- googleapiclient/discovery_cache/documents/cloudtasks.v2.json +9 -9
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +4 -68
- googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +9 -9
- googleapiclient/discovery_cache/documents/cloudtrace.v1.json +223 -1
- googleapiclient/discovery_cache/documents/cloudtrace.v2.json +223 -1
- googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json +223 -1
- googleapiclient/discovery_cache/documents/composer.v1beta1.json +5 -1
- googleapiclient/discovery_cache/documents/compute.alpha.json +6106 -3346
- googleapiclient/discovery_cache/documents/compute.beta.json +2159 -404
- googleapiclient/discovery_cache/documents/compute.v1.json +511 -26
- googleapiclient/discovery_cache/documents/config.v1.json +62 -10
- googleapiclient/discovery_cache/documents/connectors.v1.json +48 -1
- googleapiclient/discovery_cache/documents/connectors.v2.json +170 -1
- googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +238 -1790
- googleapiclient/discovery_cache/documents/container.v1.json +343 -71
- googleapiclient/discovery_cache/documents/container.v1beta1.json +334 -74
- googleapiclient/discovery_cache/documents/containeranalysis.v1.json +268 -65
- googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +266 -71
- googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +269 -74
- googleapiclient/discovery_cache/documents/databasecenter.v1beta.json +3633 -0
- googleapiclient/discovery_cache/documents/dataflow.v1b3.json +11 -7
- googleapiclient/discovery_cache/documents/dataform.v1.json +32 -18
- googleapiclient/discovery_cache/documents/dataform.v1beta1.json +174 -18
- googleapiclient/discovery_cache/documents/datalineage.v1.json +344 -4
- googleapiclient/discovery_cache/documents/datamanager.v1.json +928 -44
- googleapiclient/discovery_cache/documents/datamigration.v1.json +29 -7
- googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +5 -5
- googleapiclient/discovery_cache/documents/datapipelines.v1.json +2 -2
- googleapiclient/discovery_cache/documents/dataplex.v1.json +1185 -69
- googleapiclient/discovery_cache/documents/dataproc.v1.json +129 -73
- googleapiclient/discovery_cache/documents/datastream.v1.json +270 -1
- googleapiclient/discovery_cache/documents/developerconnect.v1.json +14 -1
- googleapiclient/discovery_cache/documents/developerknowledge.v1.json +2 -2
- googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json +83 -3
- googleapiclient/discovery_cache/documents/dfareporting.v4.json +10 -3
- googleapiclient/discovery_cache/documents/dfareporting.v5.json +12 -23
- googleapiclient/discovery_cache/documents/dialogflow.v2.json +211 -1
- googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +211 -1
- googleapiclient/discovery_cache/documents/dialogflow.v3.json +142 -1
- googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +142 -1
- googleapiclient/discovery_cache/documents/discoveryengine.v1.json +644 -37
- googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +906 -37
- googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +528 -35
- googleapiclient/discovery_cache/documents/displayvideo.v2.json +176 -73
- googleapiclient/discovery_cache/documents/displayvideo.v3.json +211 -98
- googleapiclient/discovery_cache/documents/displayvideo.v4.json +215 -100
- googleapiclient/discovery_cache/documents/dlp.v2.json +521 -5
- googleapiclient/discovery_cache/documents/documentai.v1.json +140 -3
- googleapiclient/discovery_cache/documents/documentai.v1beta3.json +3 -3
- googleapiclient/discovery_cache/documents/domains.v1.json +10 -1
- googleapiclient/discovery_cache/documents/domains.v1alpha2.json +10 -1
- googleapiclient/discovery_cache/documents/domains.v1beta1.json +10 -1
- googleapiclient/discovery_cache/documents/eventarc.v1.json +6 -106
- googleapiclient/discovery_cache/documents/fcm.v1.json +12 -2
- googleapiclient/discovery_cache/documents/firebase.v1beta1.json +5 -1
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +10 -3
- googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +5 -3
- googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json +3 -3
- googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +22 -3
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +194 -9
- googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +194 -9
- googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +301 -9
- googleapiclient/discovery_cache/documents/firestore.v1.json +5 -1
- googleapiclient/discovery_cache/documents/firestore.v1beta1.json +5 -1
- googleapiclient/discovery_cache/documents/gkebackup.v1.json +228 -2
- googleapiclient/discovery_cache/documents/gkehub.v1.json +2396 -1257
- googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +438 -75
- googleapiclient/discovery_cache/documents/gkehub.v1beta.json +422 -73
- googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +31 -1
- googleapiclient/discovery_cache/documents/gkehub.v2.json +47 -3
- googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +47 -3
- googleapiclient/discovery_cache/documents/gkehub.v2beta.json +47 -3
- googleapiclient/discovery_cache/documents/gmail.v1.json +35 -9
- googleapiclient/discovery_cache/documents/gmailpostmastertools.v2.json +3 -3
- googleapiclient/discovery_cache/documents/health.v4.json +2040 -49
- googleapiclient/discovery_cache/documents/healthcare.v1.json +7 -3
- googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +33 -3
- googleapiclient/discovery_cache/documents/homegraph.v1.json +95 -3
- googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json +18 -14
- googleapiclient/discovery_cache/documents/iamcredentials.v1.json +3 -3
- googleapiclient/discovery_cache/documents/language.v1.json +37 -1
- googleapiclient/discovery_cache/documents/language.v1beta2.json +37 -1
- googleapiclient/discovery_cache/documents/language.v2.json +37 -1
- googleapiclient/discovery_cache/documents/logging.v2.json +59 -24
- googleapiclient/discovery_cache/documents/looker.v1.json +97 -15
- googleapiclient/discovery_cache/documents/managedidentities.v1.json +2 -2
- googleapiclient/discovery_cache/documents/managedidentities.v1alpha1.json +2 -2
- googleapiclient/discovery_cache/documents/managedidentities.v1beta1.json +2 -2
- googleapiclient/discovery_cache/documents/managedkafka.v1.json +19 -1
- googleapiclient/discovery_cache/documents/memcache.v1.json +3 -3
- googleapiclient/discovery_cache/documents/memcache.v1beta2.json +3 -3
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +7 -5
- googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +7 -5
- googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json +7 -5
- googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +7 -5
- googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json +6 -4
- googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +6 -4
- googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1beta.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +467 -7
- googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +10 -3
- googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +5 -3
- googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json +6 -4
- googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +6 -4
- googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +5 -3
- googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +76 -1
- googleapiclient/discovery_cache/documents/monitoring.v1.json +147 -3
- googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +6 -1
- googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +1 -20
- googleapiclient/discovery_cache/documents/netapp.v1.json +258 -17
- googleapiclient/discovery_cache/documents/netapp.v1beta1.json +275 -17
- googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +363 -3
- googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +16 -1
- googleapiclient/discovery_cache/documents/networkmanagement.v1.json +1358 -18
- googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +47 -3
- googleapiclient/discovery_cache/documents/networksecurity.v1.json +594 -3
- googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +1082 -8
- googleapiclient/discovery_cache/documents/networkservices.v1.json +1127 -126
- googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +23 -11
- googleapiclient/discovery_cache/documents/notebooks.v1.json +3 -3
- googleapiclient/discovery_cache/documents/notebooks.v2.json +24 -7
- googleapiclient/discovery_cache/documents/observability.v1.json +76 -1
- googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +253 -59
- googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +253 -59
- googleapiclient/discovery_cache/documents/oracledatabase.v1.json +6720 -2499
- googleapiclient/discovery_cache/documents/orgpolicy.v2.json +30 -30
- googleapiclient/discovery_cache/documents/osconfig.v1.json +243 -1
- googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +243 -1
- googleapiclient/discovery_cache/documents/osconfig.v1beta.json +243 -1
- googleapiclient/discovery_cache/documents/osconfig.v2.json +243 -1
- googleapiclient/discovery_cache/documents/osconfig.v2beta.json +243 -1
- googleapiclient/discovery_cache/documents/oslogin.v1.json +5 -1
- googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +5 -1
- googleapiclient/discovery_cache/documents/oslogin.v1beta.json +5 -1
- googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +5 -1
- googleapiclient/discovery_cache/documents/parametermanager.v1.json +1 -11
- googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +7 -4
- googleapiclient/discovery_cache/documents/places.v1.json +210 -12
- googleapiclient/discovery_cache/documents/policytroubleshooter.v3beta.json +17 -3
- googleapiclient/discovery_cache/documents/privateca.v1.json +13 -4
- googleapiclient/discovery_cache/documents/privateca.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/pubsub.v1.json +40 -3
- googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +6 -4
- googleapiclient/discovery_cache/documents/redis.v1.json +348 -33
- googleapiclient/discovery_cache/documents/redis.v1beta1.json +348 -33
- googleapiclient/discovery_cache/documents/retail.v2.json +5 -5
- googleapiclient/discovery_cache/documents/retail.v2alpha.json +5 -5
- googleapiclient/discovery_cache/documents/retail.v2beta.json +5 -5
- googleapiclient/discovery_cache/documents/run.v1.json +27 -14
- googleapiclient/discovery_cache/documents/run.v2.json +58 -13
- googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json +75 -32
- googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +949 -80
- googleapiclient/discovery_cache/documents/searchads360.v23.json +59984 -0
- googleapiclient/discovery_cache/documents/securitycenter.v1.json +1568 -3723
- googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +1358 -3043
- googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +1417 -3068
- googleapiclient/discovery_cache/documents/securityposture.v1.json +4 -4
- googleapiclient/discovery_cache/documents/servicecontrol.v1.json +9 -1
- googleapiclient/discovery_cache/documents/servicecontrol.v2.json +9 -1
- googleapiclient/discovery_cache/documents/servicedirectory.v1.json +3 -3
- googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/servicemanagement.v1.json +5 -3
- googleapiclient/discovery_cache/documents/sheets.v4.json +4 -4
- googleapiclient/discovery_cache/documents/solar.v1.json +46 -1
- googleapiclient/discovery_cache/documents/sqladmin.v1.json +342 -19
- googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +342 -19
- googleapiclient/discovery_cache/documents/storage.v1.json +12 -2
- googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json +209 -49
- googleapiclient/discovery_cache/documents/tagmanager.v2.json +134 -1
- googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json +479 -3
- googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +11 -3
- googleapiclient/discovery_cache/documents/trafficdirector.v2.json +11 -1
- googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +408 -3
- googleapiclient/discovery_cache/documents/vault.v1.json +35 -13
- googleapiclient/discovery_cache/documents/vmmigration.v1.json +12 -3
- googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +12 -3
- googleapiclient/discovery_cache/documents/vmwareengine.v1.json +80 -2
- googleapiclient/discovery_cache/documents/vpcaccess.v1.json +3 -3
- googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json +3 -3
- googleapiclient/discovery_cache/documents/walletobjects.v1.json +6 -1
- googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json +167 -0
- googleapiclient/discovery_cache/documents/webrisk.v1.json +2 -2
- googleapiclient/discovery_cache/documents/workloadmanager.v1.json +213 -213
- googleapiclient/discovery_cache/documents/workspaceevents.v1.json +36 -1
- googleapiclient/discovery_cache/documents/workstations.v1.json +43 -3
- googleapiclient/discovery_cache/documents/workstations.v1beta.json +41 -1
- googleapiclient/discovery_cache/documents/youtube.v3.json +201 -33
- googleapiclient/discovery_cache/documents/youtubereporting.v1.json +6 -1
- googleapiclient/version.py +1 -1
- {google_api_python_client-2.196.0.dist-info → google_api_python_client-2.198.0.dist-info}/WHEEL +0 -0
- {google_api_python_client-2.196.0.dist-info → google_api_python_client-2.198.0.dist-info}/licenses/LICENSE +0 -0
- {google_api_python_client-2.196.0.dist-info → google_api_python_client-2.198.0.dist-info}/top_level.txt +0 -0
|
@@ -732,6 +732,28 @@
|
|
|
732
732
|
}
|
|
733
733
|
}
|
|
734
734
|
},
|
|
735
|
+
"adEvents": {
|
|
736
|
+
"methods": {
|
|
737
|
+
"ingest": {
|
|
738
|
+
"description": "Uploads a list of AdEvent resources to Google Analytics. This feature is only available to accounts on an allowlist.",
|
|
739
|
+
"flatPath": "v1/adEvents:ingest",
|
|
740
|
+
"httpMethod": "POST",
|
|
741
|
+
"id": "datamanager.adEvents.ingest",
|
|
742
|
+
"parameterOrder": [],
|
|
743
|
+
"parameters": {},
|
|
744
|
+
"path": "v1/adEvents:ingest",
|
|
745
|
+
"request": {
|
|
746
|
+
"$ref": "IngestAdEventsRequest"
|
|
747
|
+
},
|
|
748
|
+
"response": {
|
|
749
|
+
"$ref": "IngestAdEventsResponse"
|
|
750
|
+
},
|
|
751
|
+
"scopes": [
|
|
752
|
+
"https://www.googleapis.com/auth/datamanager"
|
|
753
|
+
]
|
|
754
|
+
}
|
|
755
|
+
}
|
|
756
|
+
},
|
|
735
757
|
"audienceMembers": {
|
|
736
758
|
"methods": {
|
|
737
759
|
"ingest": {
|
|
@@ -820,13 +842,336 @@
|
|
|
820
842
|
}
|
|
821
843
|
}
|
|
822
844
|
},
|
|
823
|
-
"revision": "
|
|
845
|
+
"revision": "20260605",
|
|
824
846
|
"rootUrl": "https://datamanager.googleapis.com/",
|
|
825
847
|
"schemas": {
|
|
848
|
+
"AdEvent": {
|
|
849
|
+
"description": "An ad event.",
|
|
850
|
+
"id": "AdEvent",
|
|
851
|
+
"properties": {
|
|
852
|
+
"adFormat": {
|
|
853
|
+
"description": "Enum value for ad format.",
|
|
854
|
+
"enum": [
|
|
855
|
+
"AD_FORMAT_UNSPECIFIED",
|
|
856
|
+
"AD_FORMAT_AR",
|
|
857
|
+
"AD_FORMAT_AUDIO",
|
|
858
|
+
"AD_FORMAT_BANNER",
|
|
859
|
+
"AD_FORMAT_BUMPER",
|
|
860
|
+
"AD_FORMAT_CAROUSEL",
|
|
861
|
+
"AD_FORMAT_COLLECTION",
|
|
862
|
+
"AD_FORMAT_IMAGE",
|
|
863
|
+
"AD_FORMAT_INTERACTIVE",
|
|
864
|
+
"AD_FORMAT_INTERSTITIAL",
|
|
865
|
+
"AD_FORMAT_IN_FEED",
|
|
866
|
+
"AD_FORMAT_IN_STREAM",
|
|
867
|
+
"AD_FORMAT_IN_STREAM_SKIPPABLE",
|
|
868
|
+
"AD_FORMAT_IN_STREAM_NON_SKIPPABLE",
|
|
869
|
+
"AD_FORMAT_NATIVE",
|
|
870
|
+
"AD_FORMAT_SHORTS",
|
|
871
|
+
"AD_FORMAT_STORY",
|
|
872
|
+
"AD_FORMAT_SPONSORED",
|
|
873
|
+
"AD_FORMAT_VIDEO"
|
|
874
|
+
],
|
|
875
|
+
"enumDescriptions": [
|
|
876
|
+
"Unspecified ad format.",
|
|
877
|
+
"AR ad.",
|
|
878
|
+
"Audio ad.",
|
|
879
|
+
"Banner ad.",
|
|
880
|
+
"Bumper ad.",
|
|
881
|
+
"Carousel ad.",
|
|
882
|
+
"Collection ad.",
|
|
883
|
+
"Image ad.",
|
|
884
|
+
"Interactive ad.",
|
|
885
|
+
"Interstitial ad.",
|
|
886
|
+
"In-feed ad.",
|
|
887
|
+
"In-stream ad.",
|
|
888
|
+
"In-stream skippable ad.",
|
|
889
|
+
"In-stream non-skippable ad.",
|
|
890
|
+
"Native ad.",
|
|
891
|
+
"Shorts ad.",
|
|
892
|
+
"Story ad.",
|
|
893
|
+
"Sponsored ad.",
|
|
894
|
+
"Video ad."
|
|
895
|
+
],
|
|
896
|
+
"type": "string"
|
|
897
|
+
},
|
|
898
|
+
"adFormatString": {
|
|
899
|
+
"description": "String value for ad format.",
|
|
900
|
+
"type": "string"
|
|
901
|
+
},
|
|
902
|
+
"adGroupId": {
|
|
903
|
+
"description": "Optional. The ID of the associated ad group.",
|
|
904
|
+
"type": "string"
|
|
905
|
+
},
|
|
906
|
+
"adHeight": {
|
|
907
|
+
"description": "Optional. The height of the ad in pixels.",
|
|
908
|
+
"format": "int32",
|
|
909
|
+
"type": "integer"
|
|
910
|
+
},
|
|
911
|
+
"adId": {
|
|
912
|
+
"description": "Optional. The ID of the associated ad within the group.",
|
|
913
|
+
"type": "string"
|
|
914
|
+
},
|
|
915
|
+
"adPlacement": {
|
|
916
|
+
"description": "Enum value for ad placement.",
|
|
917
|
+
"enum": [
|
|
918
|
+
"AD_PLACEMENT_UNSPECIFIED",
|
|
919
|
+
"AD_PLACEMENT_DISCOVER",
|
|
920
|
+
"AD_PLACEMENT_FEED",
|
|
921
|
+
"AD_PLACEMENT_FOOTER",
|
|
922
|
+
"AD_PLACEMENT_HEADER",
|
|
923
|
+
"AD_PLACEMENT_HOME",
|
|
924
|
+
"AD_PLACEMENT_IN_CONTENT",
|
|
925
|
+
"AD_PLACEMENT_PROMOTED",
|
|
926
|
+
"AD_PLACEMENT_SEARCH",
|
|
927
|
+
"AD_PLACEMENT_STORY"
|
|
928
|
+
],
|
|
929
|
+
"enumDescriptions": [
|
|
930
|
+
"Unspecified ad placement.",
|
|
931
|
+
"Discover placement.",
|
|
932
|
+
"Feed placement.",
|
|
933
|
+
"Footer placement.",
|
|
934
|
+
"Header placement.",
|
|
935
|
+
"Home placement.",
|
|
936
|
+
"In-content placement.",
|
|
937
|
+
"Promoted placement.",
|
|
938
|
+
"Search placement.",
|
|
939
|
+
"Story placement."
|
|
940
|
+
],
|
|
941
|
+
"type": "string"
|
|
942
|
+
},
|
|
943
|
+
"adPlacementString": {
|
|
944
|
+
"description": "String value for ad placement.",
|
|
945
|
+
"type": "string"
|
|
946
|
+
},
|
|
947
|
+
"adType": {
|
|
948
|
+
"description": "Enum value for ad type.",
|
|
949
|
+
"enum": [
|
|
950
|
+
"AD_TYPE_UNSPECIFIED",
|
|
951
|
+
"AD_TYPE_DISPLAY",
|
|
952
|
+
"AD_TYPE_TEXT",
|
|
953
|
+
"AD_TYPE_IMAGE",
|
|
954
|
+
"AD_TYPE_RICH_MEDIA",
|
|
955
|
+
"AD_TYPE_HTML",
|
|
956
|
+
"AD_TYPE_AUDIO",
|
|
957
|
+
"AD_TYPE_VIDEO"
|
|
958
|
+
],
|
|
959
|
+
"enumDescriptions": [
|
|
960
|
+
"Unspecified ad type.",
|
|
961
|
+
"Display ad.",
|
|
962
|
+
"Text ad.",
|
|
963
|
+
"Image ad.",
|
|
964
|
+
"Rich media ad.",
|
|
965
|
+
"HTML ad.",
|
|
966
|
+
"Audio ad.",
|
|
967
|
+
"Video ad."
|
|
968
|
+
],
|
|
969
|
+
"type": "string"
|
|
970
|
+
},
|
|
971
|
+
"adTypeString": {
|
|
972
|
+
"description": "String value for ad type.",
|
|
973
|
+
"type": "string"
|
|
974
|
+
},
|
|
975
|
+
"adWidth": {
|
|
976
|
+
"description": "Optional. The width of the ad in pixels.",
|
|
977
|
+
"format": "int32",
|
|
978
|
+
"type": "integer"
|
|
979
|
+
},
|
|
980
|
+
"advertiserId": {
|
|
981
|
+
"description": "Required. The ID of the advertiser for the ad event. This must match the ID sent in the linking flow.",
|
|
982
|
+
"type": "string"
|
|
983
|
+
},
|
|
984
|
+
"attributionHint": {
|
|
985
|
+
"description": "Optional. The partner-assumed attribution status for this ad event. This acts only as a signal for how the partner assumed attribution played out, and does not force an end result in final reports.",
|
|
986
|
+
"enum": [
|
|
987
|
+
"ATTRIBUTION_HINT_UNSPECIFIED",
|
|
988
|
+
"ATTRIBUTION_HINT_CONVERTED",
|
|
989
|
+
"ATTRIBUTION_HINT_NOT_CONVERTED"
|
|
990
|
+
],
|
|
991
|
+
"enumDescriptions": [
|
|
992
|
+
"Unknown attribution status.",
|
|
993
|
+
"Converted status.",
|
|
994
|
+
"Not converted status."
|
|
995
|
+
],
|
|
996
|
+
"type": "string"
|
|
997
|
+
},
|
|
998
|
+
"campaignId": {
|
|
999
|
+
"description": "Required. The ID of the associated campaign.",
|
|
1000
|
+
"type": "string"
|
|
1001
|
+
},
|
|
1002
|
+
"campaignName": {
|
|
1003
|
+
"description": "Required. The name of the associated campaign.",
|
|
1004
|
+
"type": "string"
|
|
1005
|
+
},
|
|
1006
|
+
"deviceInfo": {
|
|
1007
|
+
"$ref": "DeviceInfo",
|
|
1008
|
+
"description": "Optional. Information gathered about the device being used when the ad event happened."
|
|
1009
|
+
},
|
|
1010
|
+
"eventId": {
|
|
1011
|
+
"description": "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.",
|
|
1012
|
+
"type": "string"
|
|
1013
|
+
},
|
|
1014
|
+
"eventSubtype": {
|
|
1015
|
+
"description": "Enum value for event subtype.",
|
|
1016
|
+
"enum": [
|
|
1017
|
+
"EVENT_SUBTYPE_UNSPECIFIED",
|
|
1018
|
+
"EVENT_SUBTYPE_IMPRESSION",
|
|
1019
|
+
"EVENT_SUBTYPE_ENGAGED_VIEW",
|
|
1020
|
+
"EVENT_SUBTYPE_ONSITE_CLICK",
|
|
1021
|
+
"EVENT_SUBTYPE_OUTBOUND_CLICK"
|
|
1022
|
+
],
|
|
1023
|
+
"enumDescriptions": [
|
|
1024
|
+
"Unspecified event subtype.",
|
|
1025
|
+
"Impression event.",
|
|
1026
|
+
"Engaged view event.",
|
|
1027
|
+
"Onsite click event.",
|
|
1028
|
+
"Outbound click event."
|
|
1029
|
+
],
|
|
1030
|
+
"type": "string"
|
|
1031
|
+
},
|
|
1032
|
+
"eventSubtypeString": {
|
|
1033
|
+
"description": "String value for event subtype.",
|
|
1034
|
+
"type": "string"
|
|
1035
|
+
},
|
|
1036
|
+
"eventType": {
|
|
1037
|
+
"description": "Required. The type of the event.",
|
|
1038
|
+
"enum": [
|
|
1039
|
+
"EVENT_TYPE_UNSPECIFIED",
|
|
1040
|
+
"EVENT_TYPE_VIEW",
|
|
1041
|
+
"EVENT_TYPE_CLICK"
|
|
1042
|
+
],
|
|
1043
|
+
"enumDescriptions": [
|
|
1044
|
+
"Unspecified event type.",
|
|
1045
|
+
"View event.",
|
|
1046
|
+
"Click event."
|
|
1047
|
+
],
|
|
1048
|
+
"type": "string"
|
|
1049
|
+
},
|
|
1050
|
+
"measurementAllowed": {
|
|
1051
|
+
"description": "Optional. Represents if the row is allowed to be used for measurement purposes, as governed by applicable privacy laws within regional jurisdiction.",
|
|
1052
|
+
"type": "boolean"
|
|
1053
|
+
},
|
|
1054
|
+
"medium": {
|
|
1055
|
+
"description": "Required. The medium of the ad, akin to the Google Analytics medium.",
|
|
1056
|
+
"type": "string"
|
|
1057
|
+
},
|
|
1058
|
+
"mobileDeviceId": {
|
|
1059
|
+
"description": "Optional. The device ID of the device that the ad was served to.",
|
|
1060
|
+
"type": "string"
|
|
1061
|
+
},
|
|
1062
|
+
"platform": {
|
|
1063
|
+
"description": "Enum value for platform.",
|
|
1064
|
+
"enum": [
|
|
1065
|
+
"PLATFORM_UNSPECIFIED",
|
|
1066
|
+
"PLATFORM_IOS",
|
|
1067
|
+
"PLATFORM_ANDROID",
|
|
1068
|
+
"PLATFORM_WEB"
|
|
1069
|
+
],
|
|
1070
|
+
"enumDescriptions": [
|
|
1071
|
+
"Unspecified platform.",
|
|
1072
|
+
"iOS platform.",
|
|
1073
|
+
"Android platform.",
|
|
1074
|
+
"Web platform."
|
|
1075
|
+
],
|
|
1076
|
+
"type": "string"
|
|
1077
|
+
},
|
|
1078
|
+
"platformString": {
|
|
1079
|
+
"description": "String value for platform.",
|
|
1080
|
+
"type": "string"
|
|
1081
|
+
},
|
|
1082
|
+
"platformType": {
|
|
1083
|
+
"description": "Enum value for platform type.",
|
|
1084
|
+
"enum": [
|
|
1085
|
+
"PLATFORM_TYPE_UNSPECIFIED",
|
|
1086
|
+
"PLATFORM_TYPE_MOBILE",
|
|
1087
|
+
"PLATFORM_TYPE_DESKTOP",
|
|
1088
|
+
"PLATFORM_TYPE_CTV",
|
|
1089
|
+
"PLATFORM_TYPE_PHONE",
|
|
1090
|
+
"PLATFORM_TYPE_TABLET"
|
|
1091
|
+
],
|
|
1092
|
+
"enumDescriptions": [
|
|
1093
|
+
"Unspecified platform type.",
|
|
1094
|
+
"Mobile platform.",
|
|
1095
|
+
"Desktop platform.",
|
|
1096
|
+
"CTV platform.",
|
|
1097
|
+
"Phone platform.",
|
|
1098
|
+
"Tablet platform."
|
|
1099
|
+
],
|
|
1100
|
+
"type": "string"
|
|
1101
|
+
},
|
|
1102
|
+
"platformTypeString": {
|
|
1103
|
+
"description": "String value for platform type.",
|
|
1104
|
+
"type": "string"
|
|
1105
|
+
},
|
|
1106
|
+
"regionCode": {
|
|
1107
|
+
"description": "Required. The ISO 3166-2 country plus subdivision.",
|
|
1108
|
+
"type": "string"
|
|
1109
|
+
},
|
|
1110
|
+
"source": {
|
|
1111
|
+
"description": "Required. The platform source of the ad, akin to the Google Analytics source.",
|
|
1112
|
+
"type": "string"
|
|
1113
|
+
},
|
|
1114
|
+
"targetingType": {
|
|
1115
|
+
"description": "Enum value for targeting type.",
|
|
1116
|
+
"enum": [
|
|
1117
|
+
"TARGETING_TYPE_UNSPECIFIED",
|
|
1118
|
+
"TARGETING_TYPE_AUDIENCE",
|
|
1119
|
+
"TARGETING_TYPE_CONTEXTUAL",
|
|
1120
|
+
"TARGETING_TYPE_DEMOGRAPHIC",
|
|
1121
|
+
"TARGETING_TYPE_DEVICE",
|
|
1122
|
+
"TARGETING_TYPE_GEO",
|
|
1123
|
+
"TARGETING_TYPE_INTEREST",
|
|
1124
|
+
"TARGETING_TYPE_PURCHASE_INTENT",
|
|
1125
|
+
"TARGETING_TYPE_REMARKETING"
|
|
1126
|
+
],
|
|
1127
|
+
"enumDescriptions": [
|
|
1128
|
+
"Unspecified targeting type.",
|
|
1129
|
+
"Audience targeting.",
|
|
1130
|
+
"Contextual targeting.",
|
|
1131
|
+
"Demographic targeting.",
|
|
1132
|
+
"Device targeting.",
|
|
1133
|
+
"Geo targeting.",
|
|
1134
|
+
"Interest targeting.",
|
|
1135
|
+
"Purchase intent targeting.",
|
|
1136
|
+
"Remarketing targeting."
|
|
1137
|
+
],
|
|
1138
|
+
"type": "string"
|
|
1139
|
+
},
|
|
1140
|
+
"targetingTypeString": {
|
|
1141
|
+
"description": "String value for targeting type.",
|
|
1142
|
+
"type": "string"
|
|
1143
|
+
},
|
|
1144
|
+
"timestamp": {
|
|
1145
|
+
"description": "Required. The time the event occurred.",
|
|
1146
|
+
"format": "google-datetime",
|
|
1147
|
+
"type": "string"
|
|
1148
|
+
},
|
|
1149
|
+
"userData": {
|
|
1150
|
+
"$ref": "UserData",
|
|
1151
|
+
"description": "Optional. Multiple pieces of user-provided data, representing the user the event is associated with. It is possible to provide multiple instances of the same type of data (e.g. email address). The more data provided, the more likely a match will be found."
|
|
1152
|
+
},
|
|
1153
|
+
"viewabilityInfo": {
|
|
1154
|
+
"$ref": "ViewabilityInfo",
|
|
1155
|
+
"description": "Required. Details of the viewability of the ad served."
|
|
1156
|
+
}
|
|
1157
|
+
},
|
|
1158
|
+
"type": "object"
|
|
1159
|
+
},
|
|
826
1160
|
"AdIdentifiers": {
|
|
827
1161
|
"description": "Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).",
|
|
828
1162
|
"id": "AdIdentifiers",
|
|
829
1163
|
"properties": {
|
|
1164
|
+
"dclid": {
|
|
1165
|
+
"description": "Optional. The display click ID associated with this event.",
|
|
1166
|
+
"type": "string"
|
|
1167
|
+
},
|
|
1168
|
+
"encryptedUserIds": {
|
|
1169
|
+
"description": "Optional. Any number of encrypted user IDs.",
|
|
1170
|
+
"items": {
|
|
1171
|
+
"$ref": "EncryptedUserId"
|
|
1172
|
+
},
|
|
1173
|
+
"type": "array"
|
|
1174
|
+
},
|
|
830
1175
|
"gbraid": {
|
|
831
1176
|
"description": "Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.",
|
|
832
1177
|
"type": "string"
|
|
@@ -835,10 +1180,22 @@
|
|
|
835
1180
|
"description": "Optional. The Google click ID (gclid) associated with this event.",
|
|
836
1181
|
"type": "string"
|
|
837
1182
|
},
|
|
1183
|
+
"impressionId": {
|
|
1184
|
+
"description": "Optional. The impression ID associated with this event.",
|
|
1185
|
+
"type": "string"
|
|
1186
|
+
},
|
|
838
1187
|
"landingPageDeviceInfo": {
|
|
839
1188
|
"$ref": "DeviceInfo",
|
|
840
1189
|
"description": "Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser\u2019s site after interacting with the ad."
|
|
841
1190
|
},
|
|
1191
|
+
"matchId": {
|
|
1192
|
+
"description": "Optional. The match ID field used to join this event with a previous event.",
|
|
1193
|
+
"type": "string"
|
|
1194
|
+
},
|
|
1195
|
+
"mobileDeviceId": {
|
|
1196
|
+
"description": "Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms\u2019 identifiers for advertisers.",
|
|
1197
|
+
"type": "string"
|
|
1198
|
+
},
|
|
842
1199
|
"sessionAttributes": {
|
|
843
1200
|
"description": "Optional. Session attributes for event attribution and modeling.",
|
|
844
1201
|
"type": "string"
|
|
@@ -877,6 +1234,10 @@
|
|
|
877
1234
|
"description": "The audience member to be operated on.",
|
|
878
1235
|
"id": "AudienceMember",
|
|
879
1236
|
"properties": {
|
|
1237
|
+
"compositeData": {
|
|
1238
|
+
"$ref": "CompositeData",
|
|
1239
|
+
"description": "Group of multiple identifier types."
|
|
1240
|
+
},
|
|
880
1241
|
"consent": {
|
|
881
1242
|
"$ref": "Consent",
|
|
882
1243
|
"description": "Optional. The consent setting for the user."
|
|
@@ -961,6 +1322,13 @@
|
|
|
961
1322
|
"description": "The cart data associated with the event.",
|
|
962
1323
|
"id": "CartData",
|
|
963
1324
|
"properties": {
|
|
1325
|
+
"couponCodes": {
|
|
1326
|
+
"description": "Optional. The list of coupon codes that were applied to the cart. Cart-level and item-level coupon codes are independent. If the event is for a Google Analytics destination, only provide a single coupon code. Google Analytics ignores additional coupon codes.",
|
|
1327
|
+
"items": {
|
|
1328
|
+
"type": "string"
|
|
1329
|
+
},
|
|
1330
|
+
"type": "array"
|
|
1331
|
+
},
|
|
964
1332
|
"items": {
|
|
965
1333
|
"description": "Optional. The list of items associated with the event.",
|
|
966
1334
|
"items": {
|
|
@@ -988,6 +1356,24 @@
|
|
|
988
1356
|
},
|
|
989
1357
|
"type": "object"
|
|
990
1358
|
},
|
|
1359
|
+
"CompositeData": {
|
|
1360
|
+
"description": "Composite data holding identifiers and associated data for a user. At least one of `user_data` or `ip_data` is required.",
|
|
1361
|
+
"id": "CompositeData",
|
|
1362
|
+
"properties": {
|
|
1363
|
+
"ipData": {
|
|
1364
|
+
"description": "Optional. IP address data representing customer interaction used to build the audience.",
|
|
1365
|
+
"items": {
|
|
1366
|
+
"$ref": "IpData"
|
|
1367
|
+
},
|
|
1368
|
+
"type": "array"
|
|
1369
|
+
},
|
|
1370
|
+
"userData": {
|
|
1371
|
+
"$ref": "UserData",
|
|
1372
|
+
"description": "Optional. User-provided data that identifies the user."
|
|
1373
|
+
}
|
|
1374
|
+
},
|
|
1375
|
+
"type": "object"
|
|
1376
|
+
},
|
|
991
1377
|
"Consent": {
|
|
992
1378
|
"description": "[Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user.",
|
|
993
1379
|
"id": "Consent",
|
|
@@ -1054,6 +1440,17 @@
|
|
|
1054
1440
|
},
|
|
1055
1441
|
"type": "object"
|
|
1056
1442
|
},
|
|
1443
|
+
"CoordinatorKeyInfo": {
|
|
1444
|
+
"description": "Information about the coordinator key.",
|
|
1445
|
+
"id": "CoordinatorKeyInfo",
|
|
1446
|
+
"properties": {
|
|
1447
|
+
"keyId": {
|
|
1448
|
+
"description": "Required. The ID of the chosen coordinator key.",
|
|
1449
|
+
"type": "string"
|
|
1450
|
+
}
|
|
1451
|
+
},
|
|
1452
|
+
"type": "object"
|
|
1453
|
+
},
|
|
1057
1454
|
"CustomVariable": {
|
|
1058
1455
|
"description": "Custom variable for ads conversions.",
|
|
1059
1456
|
"id": "CustomVariable",
|
|
@@ -1076,6 +1473,36 @@
|
|
|
1076
1473
|
},
|
|
1077
1474
|
"type": "object"
|
|
1078
1475
|
},
|
|
1476
|
+
"DataTypeCount": {
|
|
1477
|
+
"description": "The count for a specific data type.",
|
|
1478
|
+
"id": "DataTypeCount",
|
|
1479
|
+
"properties": {
|
|
1480
|
+
"count": {
|
|
1481
|
+
"description": "The count for this data type.",
|
|
1482
|
+
"format": "int64",
|
|
1483
|
+
"type": "string"
|
|
1484
|
+
},
|
|
1485
|
+
"type": {
|
|
1486
|
+
"description": "The type of data.",
|
|
1487
|
+
"enum": [
|
|
1488
|
+
"DATA_TYPE_UNSPECIFIED",
|
|
1489
|
+
"EMAIL",
|
|
1490
|
+
"PHONE_NUMBER",
|
|
1491
|
+
"ADDRESS",
|
|
1492
|
+
"IP_ADDRESS"
|
|
1493
|
+
],
|
|
1494
|
+
"enumDescriptions": [
|
|
1495
|
+
"The data type is unspecified.",
|
|
1496
|
+
"The data is an email address.",
|
|
1497
|
+
"The data is a phone number.",
|
|
1498
|
+
"The data is a physical address.",
|
|
1499
|
+
"The data is an IP address."
|
|
1500
|
+
],
|
|
1501
|
+
"type": "string"
|
|
1502
|
+
}
|
|
1503
|
+
},
|
|
1504
|
+
"type": "object"
|
|
1505
|
+
},
|
|
1079
1506
|
"Destination": {
|
|
1080
1507
|
"description": "The Google product you're sending data to. For example, a Google Ads account.",
|
|
1081
1508
|
"id": "Destination",
|
|
@@ -1107,10 +1534,52 @@
|
|
|
1107
1534
|
"description": "Information about the device being used (if any) when the event happened.",
|
|
1108
1535
|
"id": "DeviceInfo",
|
|
1109
1536
|
"properties": {
|
|
1537
|
+
"brand": {
|
|
1538
|
+
"description": "Optional. The brand of the device.",
|
|
1539
|
+
"type": "string"
|
|
1540
|
+
},
|
|
1541
|
+
"browser": {
|
|
1542
|
+
"description": "Optional. The brand or type of the browser.",
|
|
1543
|
+
"type": "string"
|
|
1544
|
+
},
|
|
1545
|
+
"browserVersion": {
|
|
1546
|
+
"description": "Optional. The version of the browser.",
|
|
1547
|
+
"type": "string"
|
|
1548
|
+
},
|
|
1549
|
+
"category": {
|
|
1550
|
+
"description": "Optional. The category of device. For example, \u201cdesktop\u201d, \u201ctablet\u201d, \u201cmobile\u201d, \u201csmart TV\u201d.",
|
|
1551
|
+
"type": "string"
|
|
1552
|
+
},
|
|
1110
1553
|
"ipAddress": {
|
|
1111
1554
|
"description": "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.",
|
|
1112
1555
|
"type": "string"
|
|
1113
1556
|
},
|
|
1557
|
+
"languageCode": {
|
|
1558
|
+
"description": "Optional. The language the device uses in ISO 639-1 format.",
|
|
1559
|
+
"type": "string"
|
|
1560
|
+
},
|
|
1561
|
+
"model": {
|
|
1562
|
+
"description": "Optional. The model of the device.",
|
|
1563
|
+
"type": "string"
|
|
1564
|
+
},
|
|
1565
|
+
"operatingSystem": {
|
|
1566
|
+
"description": "Optional. The operating system or platform of the device.",
|
|
1567
|
+
"type": "string"
|
|
1568
|
+
},
|
|
1569
|
+
"operatingSystemVersion": {
|
|
1570
|
+
"description": "Optional. The version of the operating system or platform.",
|
|
1571
|
+
"type": "string"
|
|
1572
|
+
},
|
|
1573
|
+
"screenHeight": {
|
|
1574
|
+
"description": "Optional. The height of the screen in pixels.",
|
|
1575
|
+
"format": "int32",
|
|
1576
|
+
"type": "integer"
|
|
1577
|
+
},
|
|
1578
|
+
"screenWidth": {
|
|
1579
|
+
"description": "Optional. The width of the screen in pixels.",
|
|
1580
|
+
"format": "int32",
|
|
1581
|
+
"type": "integer"
|
|
1582
|
+
},
|
|
1114
1583
|
"userAgent": {
|
|
1115
1584
|
"description": "Optional. The user-agent string of the device for the given context.",
|
|
1116
1585
|
"type": "string"
|
|
@@ -1124,6 +1593,58 @@
|
|
|
1124
1593
|
"properties": {},
|
|
1125
1594
|
"type": "object"
|
|
1126
1595
|
},
|
|
1596
|
+
"EncryptedUserId": {
|
|
1597
|
+
"description": "A user identifier issued to be used for attribution. All fields are required if this is used.",
|
|
1598
|
+
"id": "EncryptedUserId",
|
|
1599
|
+
"properties": {
|
|
1600
|
+
"encryptedId": {
|
|
1601
|
+
"description": "Required. The alphanumeric encrypted id.",
|
|
1602
|
+
"type": "string"
|
|
1603
|
+
},
|
|
1604
|
+
"entityId": {
|
|
1605
|
+
"description": "Required. The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.",
|
|
1606
|
+
"format": "int64",
|
|
1607
|
+
"type": "string"
|
|
1608
|
+
},
|
|
1609
|
+
"entityType": {
|
|
1610
|
+
"description": "Required. The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.",
|
|
1611
|
+
"enum": [
|
|
1612
|
+
"ENCRYPTION_ENTITY_TYPE_UNSPECIFIED",
|
|
1613
|
+
"CAMPAIGN_MANAGER_ACCOUNT",
|
|
1614
|
+
"CAMPAIGN_MANAGER_ADVERTISER",
|
|
1615
|
+
"DISPLAY_VIDEO_PARTNER",
|
|
1616
|
+
"DISPLAY_VIDEO_ADVERTISER",
|
|
1617
|
+
"GOOGLE_ADS_CUSTOMER",
|
|
1618
|
+
"GOOGLE_AD_MANAGER_NETWORK_CODE"
|
|
1619
|
+
],
|
|
1620
|
+
"enumDescriptions": [
|
|
1621
|
+
"Unspecified encryption entity type.",
|
|
1622
|
+
"Campaign Manager 360 account.",
|
|
1623
|
+
"Campaign Manager 360 advertiser.",
|
|
1624
|
+
"Display & Video 360 partner.",
|
|
1625
|
+
"Display & Video 360 advertiser.",
|
|
1626
|
+
"Google Ads customer.",
|
|
1627
|
+
"Google Ad Manager network code."
|
|
1628
|
+
],
|
|
1629
|
+
"type": "string"
|
|
1630
|
+
},
|
|
1631
|
+
"source": {
|
|
1632
|
+
"description": "Required. Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.",
|
|
1633
|
+
"enum": [
|
|
1634
|
+
"ENCRYPTION_SOURCE_UNSPECIFIED",
|
|
1635
|
+
"AD_SERVING",
|
|
1636
|
+
"DATA_TRANSFER"
|
|
1637
|
+
],
|
|
1638
|
+
"enumDescriptions": [
|
|
1639
|
+
"Unspecified encryption source.",
|
|
1640
|
+
"Ad serving encryption source.",
|
|
1641
|
+
"Data transfer encryption source."
|
|
1642
|
+
],
|
|
1643
|
+
"type": "string"
|
|
1644
|
+
}
|
|
1645
|
+
},
|
|
1646
|
+
"type": "object"
|
|
1647
|
+
},
|
|
1127
1648
|
"EncryptionInfo": {
|
|
1128
1649
|
"description": "Encryption information for the data being ingested.",
|
|
1129
1650
|
"id": "EncryptionInfo",
|
|
@@ -1132,6 +1653,10 @@
|
|
|
1132
1653
|
"$ref": "AwsWrappedKeyInfo",
|
|
1133
1654
|
"description": "Amazon Web Services wrapped key information."
|
|
1134
1655
|
},
|
|
1656
|
+
"coordinatorKeyInfo": {
|
|
1657
|
+
"$ref": "CoordinatorKeyInfo",
|
|
1658
|
+
"description": "Key information for the chosen coordinator key. This is not supported for the IngestEvents, IngestAudienceMembers, and RemoveAudienceMembers methods."
|
|
1659
|
+
},
|
|
1135
1660
|
"gcpWrappedKeyInfo": {
|
|
1136
1661
|
"$ref": "GcpWrappedKeyInfo",
|
|
1137
1662
|
"description": "Google Cloud Platform wrapped key information."
|
|
@@ -1174,38 +1699,22 @@
|
|
|
1174
1699
|
"PROCESSING_ERROR_REASON_AWS_AUTH_FAILED",
|
|
1175
1700
|
"PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR",
|
|
1176
1701
|
"PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER",
|
|
1177
|
-
"PROCESSING_ERROR_REASON_ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID"
|
|
1178
|
-
|
|
1179
|
-
"
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
false,
|
|
1194
|
-
false,
|
|
1195
|
-
false,
|
|
1196
|
-
false,
|
|
1197
|
-
false,
|
|
1198
|
-
false,
|
|
1199
|
-
false,
|
|
1200
|
-
false,
|
|
1201
|
-
false,
|
|
1202
|
-
false,
|
|
1203
|
-
false,
|
|
1204
|
-
false,
|
|
1205
|
-
false,
|
|
1206
|
-
false,
|
|
1207
|
-
false,
|
|
1208
|
-
true
|
|
1702
|
+
"PROCESSING_ERROR_REASON_ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID",
|
|
1703
|
+
"PROCESSING_ERROR_REASON_MATCH_ID_NOT_FOUND",
|
|
1704
|
+
"PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_MATCH_ID",
|
|
1705
|
+
"PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_GCLID",
|
|
1706
|
+
"PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_DCLID",
|
|
1707
|
+
"PROCESSING_ERROR_REASON_INVALID_AD_IDENTIFIERS",
|
|
1708
|
+
"PROCESSING_ERROR_REASON_INVALID_MOBILE_ID_FORMAT",
|
|
1709
|
+
"PROCESSING_ERROR_REASON_ORIGINAL_CONVERSIONS_NOT_FOUND",
|
|
1710
|
+
"PROCESSING_ERROR_REASON_EVENT_ID_DECODE_ERROR",
|
|
1711
|
+
"PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND_FOR_IMPRESSION_ID",
|
|
1712
|
+
"PROCESSING_ERROR_REASON_USER_ID_NOT_FOUND",
|
|
1713
|
+
"PROCESSING_ERROR_REASON_CONVERSION_PRECEDES_CLICK",
|
|
1714
|
+
"PROCESSING_ERROR_REASON_TOO_RECENT_CLICK",
|
|
1715
|
+
"PROCESSING_ERROR_REASON_INVALID_CLICK",
|
|
1716
|
+
"PROCESSING_ERROR_REASON_INVALID_OPERATING_ACCOUNT_FOR_CLICK",
|
|
1717
|
+
"PROCESSING_ERROR_REASON_CLICK_NOT_FOUND"
|
|
1209
1718
|
],
|
|
1210
1719
|
"enumDescriptions": [
|
|
1211
1720
|
"The processing error reason is unknown.",
|
|
@@ -1236,7 +1745,22 @@ true
|
|
|
1236
1745
|
"The system failed to authenticate with AWS.",
|
|
1237
1746
|
"Failed to decrypt the UserIdentifier data using the DEK.",
|
|
1238
1747
|
"The user attempted to ingest events with an ad identifier that isn't from the operating account's ads.",
|
|
1239
|
-
"One-per-click conversion actions cannot be used with BRAIDs."
|
|
1748
|
+
"One-per-click conversion actions cannot be used with BRAIDs.",
|
|
1749
|
+
"The match ID can not be found.",
|
|
1750
|
+
"The user ID can not be found for the match ID.",
|
|
1751
|
+
"The user ID can not be found for the GCLID.",
|
|
1752
|
+
"The user ID can not be found for the DCLID.",
|
|
1753
|
+
"There are ad identifiers that are invalid.",
|
|
1754
|
+
"The mobile ID format is invalid.",
|
|
1755
|
+
"The original conversions can't be found.",
|
|
1756
|
+
"The event ID (dclid or impression ID) cannot be decoded.",
|
|
1757
|
+
"The user ID cannot be found for the given impression ID.",
|
|
1758
|
+
"The user ID cannot be found.",
|
|
1759
|
+
"The event timestamp on the event was earlier than the associated click.",
|
|
1760
|
+
"The click occurred too recently.",
|
|
1761
|
+
"The event can't be attributed to a click (GCLID). This may be because the click did not come from a Google Ads campaign, for example.",
|
|
1762
|
+
"The click from the event isn't associated with the `operating_account` of the destination.",
|
|
1763
|
+
"A corresponding click can't be found that matches the provided attributes."
|
|
1240
1764
|
],
|
|
1241
1765
|
"type": "string"
|
|
1242
1766
|
},
|
|
@@ -1277,6 +1801,10 @@ true
|
|
|
1277
1801
|
},
|
|
1278
1802
|
"type": "array"
|
|
1279
1803
|
},
|
|
1804
|
+
"appInstanceId": {
|
|
1805
|
+
"description": "Optional. A unique identifier for the user instance of an app client for this GA4 app stream.",
|
|
1806
|
+
"type": "string"
|
|
1807
|
+
},
|
|
1280
1808
|
"cartData": {
|
|
1281
1809
|
"$ref": "CartData",
|
|
1282
1810
|
"description": "Optional. Information about the transaction and items associated with the event."
|
|
@@ -1289,6 +1817,11 @@ true
|
|
|
1289
1817
|
"$ref": "Consent",
|
|
1290
1818
|
"description": "Optional. Information about whether the associated user has provided different types of consent."
|
|
1291
1819
|
},
|
|
1820
|
+
"conversionCount": {
|
|
1821
|
+
"description": "Optional. The conversion quantity associated with the event, for counting-based conversions.",
|
|
1822
|
+
"format": "double",
|
|
1823
|
+
"type": "number"
|
|
1824
|
+
},
|
|
1292
1825
|
"conversionValue": {
|
|
1293
1826
|
"description": "Optional. The conversion value associated with the event, for value-based conversions.",
|
|
1294
1827
|
"format": "double",
|
|
@@ -1316,6 +1849,10 @@ true
|
|
|
1316
1849
|
"$ref": "DeviceInfo",
|
|
1317
1850
|
"description": "Optional. Information gathered about the device being used (if any) when the event happened."
|
|
1318
1851
|
},
|
|
1852
|
+
"eventLocation": {
|
|
1853
|
+
"$ref": "EventLocation",
|
|
1854
|
+
"description": "Optional. Information gathered about the location of the user when this event occurred."
|
|
1855
|
+
},
|
|
1319
1856
|
"eventName": {
|
|
1320
1857
|
"description": "Optional. The name of the event. Required for GA4 events.",
|
|
1321
1858
|
"type": "string"
|
|
@@ -1328,6 +1865,7 @@ true
|
|
|
1328
1865
|
"APP",
|
|
1329
1866
|
"IN_STORE",
|
|
1330
1867
|
"PHONE",
|
|
1868
|
+
"MESSAGE",
|
|
1331
1869
|
"OTHER"
|
|
1332
1870
|
],
|
|
1333
1871
|
"enumDescriptions": [
|
|
@@ -1336,6 +1874,7 @@ true
|
|
|
1336
1874
|
"The event was generated from an app.",
|
|
1337
1875
|
"The event was generated from an in-store transaction.",
|
|
1338
1876
|
"The event was generated from a phone call.",
|
|
1877
|
+
"The event was generated from a message.",
|
|
1339
1878
|
"The event was generated from other sources."
|
|
1340
1879
|
],
|
|
1341
1880
|
"type": "string"
|
|
@@ -1357,8 +1896,12 @@ true
|
|
|
1357
1896
|
"format": "google-datetime",
|
|
1358
1897
|
"type": "string"
|
|
1359
1898
|
},
|
|
1899
|
+
"thirdPartyUserData": {
|
|
1900
|
+
"$ref": "UserData",
|
|
1901
|
+
"description": "Optional. The same type of data provided in user_data, but explicitly flagged as being provided as owned by a third-party and not first-party advertiser data."
|
|
1902
|
+
},
|
|
1360
1903
|
"transactionId": {
|
|
1361
|
-
"description": "Optional. The unique identifier for this event. Required for
|
|
1904
|
+
"description": "Optional. The unique identifier for this event. Required for events sent as an additional data source for tag conversions.",
|
|
1362
1905
|
"type": "string"
|
|
1363
1906
|
},
|
|
1364
1907
|
"userData": {
|
|
@@ -1376,6 +1919,37 @@ true
|
|
|
1376
1919
|
},
|
|
1377
1920
|
"type": "object"
|
|
1378
1921
|
},
|
|
1922
|
+
"EventLocation": {
|
|
1923
|
+
"description": "The location where the event occurred.",
|
|
1924
|
+
"id": "EventLocation",
|
|
1925
|
+
"properties": {
|
|
1926
|
+
"city": {
|
|
1927
|
+
"description": "Optional. The name of the city where the event occurred.",
|
|
1928
|
+
"type": "string"
|
|
1929
|
+
},
|
|
1930
|
+
"continentCode": {
|
|
1931
|
+
"description": "Optional. The continent code in UN M49 format where the event occurred.",
|
|
1932
|
+
"type": "string"
|
|
1933
|
+
},
|
|
1934
|
+
"regionCode": {
|
|
1935
|
+
"description": "Optional. The 2-letter CLDR region code of the user's address.",
|
|
1936
|
+
"type": "string"
|
|
1937
|
+
},
|
|
1938
|
+
"storeId": {
|
|
1939
|
+
"description": "Optional. Required for Store Sales. The identifier to represent a physical store where the event happened.",
|
|
1940
|
+
"type": "string"
|
|
1941
|
+
},
|
|
1942
|
+
"subcontinentCode": {
|
|
1943
|
+
"description": "Optional. The subcontinent code in UN M49 format where the event occurred.",
|
|
1944
|
+
"type": "string"
|
|
1945
|
+
},
|
|
1946
|
+
"subdivisionCode": {
|
|
1947
|
+
"description": "Optional. The ISO 3166-2 subdivision code where the event occurred.",
|
|
1948
|
+
"type": "string"
|
|
1949
|
+
}
|
|
1950
|
+
},
|
|
1951
|
+
"type": "object"
|
|
1952
|
+
},
|
|
1379
1953
|
"EventParameter": {
|
|
1380
1954
|
"description": "Event parameter for GA4 events.",
|
|
1381
1955
|
"id": "EventParameter",
|
|
@@ -1437,6 +2011,34 @@ true
|
|
|
1437
2011
|
},
|
|
1438
2012
|
"type": "object"
|
|
1439
2013
|
},
|
|
2014
|
+
"IngestAdEventsRequest": {
|
|
2015
|
+
"description": "Request to upload ad events.",
|
|
2016
|
+
"id": "IngestAdEventsRequest",
|
|
2017
|
+
"properties": {
|
|
2018
|
+
"adEvents": {
|
|
2019
|
+
"description": "Required. Required (at least 1). A list of ad events.",
|
|
2020
|
+
"items": {
|
|
2021
|
+
"$ref": "AdEvent"
|
|
2022
|
+
},
|
|
2023
|
+
"type": "array"
|
|
2024
|
+
},
|
|
2025
|
+
"encryptionInfo": {
|
|
2026
|
+
"$ref": "EncryptionInfo",
|
|
2027
|
+
"description": "Optional. Information about encryption keys which are used to encrypt the data."
|
|
2028
|
+
},
|
|
2029
|
+
"validateOnly": {
|
|
2030
|
+
"description": "Optional. If true, the request is validated, but not executed.",
|
|
2031
|
+
"type": "boolean"
|
|
2032
|
+
}
|
|
2033
|
+
},
|
|
2034
|
+
"type": "object"
|
|
2035
|
+
},
|
|
2036
|
+
"IngestAdEventsResponse": {
|
|
2037
|
+
"description": "Response from an ad event ingestion operation.",
|
|
2038
|
+
"id": "IngestAdEventsResponse",
|
|
2039
|
+
"properties": {},
|
|
2040
|
+
"type": "object"
|
|
2041
|
+
},
|
|
1440
2042
|
"IngestAudienceMembersRequest": {
|
|
1441
2043
|
"description": "Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse.",
|
|
1442
2044
|
"id": "IngestAudienceMembersRequest",
|
|
@@ -1503,6 +2105,10 @@ true
|
|
|
1503
2105
|
"description": "The status of the ingest audience members request.",
|
|
1504
2106
|
"id": "IngestAudienceMembersStatus",
|
|
1505
2107
|
"properties": {
|
|
2108
|
+
"compositeDataIngestionStatus": {
|
|
2109
|
+
"$ref": "IngestCompositeDataStatus",
|
|
2110
|
+
"description": "The status of the composite data ingestion to the destination."
|
|
2111
|
+
},
|
|
1506
2112
|
"mobileDataIngestionStatus": {
|
|
1507
2113
|
"$ref": "IngestMobileDataStatus",
|
|
1508
2114
|
"description": "The status of the mobile data ingestion to the destination."
|
|
@@ -1526,6 +2132,55 @@ true
|
|
|
1526
2132
|
},
|
|
1527
2133
|
"type": "object"
|
|
1528
2134
|
},
|
|
2135
|
+
"IngestCompositeDataStatus": {
|
|
2136
|
+
"description": "The status of the composite data ingestion to the destination containing stats related to the ingestion.",
|
|
2137
|
+
"id": "IngestCompositeDataStatus",
|
|
2138
|
+
"properties": {
|
|
2139
|
+
"dataTypeCounts": {
|
|
2140
|
+
"description": "The total count of data types sent in the upload request for the destination, broken down by data type. Includes all data types in the request, regardless of whether they were successfully ingested or not.",
|
|
2141
|
+
"items": {
|
|
2142
|
+
"$ref": "DataTypeCount"
|
|
2143
|
+
},
|
|
2144
|
+
"type": "array"
|
|
2145
|
+
},
|
|
2146
|
+
"recordCount": {
|
|
2147
|
+
"description": "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.",
|
|
2148
|
+
"format": "int64",
|
|
2149
|
+
"type": "string"
|
|
2150
|
+
},
|
|
2151
|
+
"uploadMatchRateRange": {
|
|
2152
|
+
"description": "The match rate range of the upload.",
|
|
2153
|
+
"enum": [
|
|
2154
|
+
"MATCH_RATE_RANGE_UNKNOWN",
|
|
2155
|
+
"MATCH_RATE_RANGE_NOT_ELIGIBLE",
|
|
2156
|
+
"MATCH_RATE_RANGE_LESS_THAN_20",
|
|
2157
|
+
"MATCH_RATE_RANGE_20_TO_30",
|
|
2158
|
+
"MATCH_RATE_RANGE_31_TO_40",
|
|
2159
|
+
"MATCH_RATE_RANGE_41_TO_50",
|
|
2160
|
+
"MATCH_RATE_RANGE_51_TO_60",
|
|
2161
|
+
"MATCH_RATE_RANGE_61_TO_70",
|
|
2162
|
+
"MATCH_RATE_RANGE_71_TO_80",
|
|
2163
|
+
"MATCH_RATE_RANGE_81_TO_90",
|
|
2164
|
+
"MATCH_RATE_RANGE_91_TO_100"
|
|
2165
|
+
],
|
|
2166
|
+
"enumDescriptions": [
|
|
2167
|
+
"The match rate range is unknown.",
|
|
2168
|
+
"The match rate range is not eligible.",
|
|
2169
|
+
"The match rate range is less than 20% (in the interval `[0, 20)`).",
|
|
2170
|
+
"The match rate range is between 20% and 30% (in the interval `[20, 31)`).",
|
|
2171
|
+
"The match rate range is between 31% and 40% (in the interval `[31, 41)`).",
|
|
2172
|
+
"The match rate range is between 41% and 50% (in the interval `[41, 51)`).",
|
|
2173
|
+
"The match rate range is between 51% and 60% (in the interval `[51, 61)`.",
|
|
2174
|
+
"The match rate range is between 61% and 70% (in the interval `[61, 71)`).",
|
|
2175
|
+
"The match rate range is between 71% and 80% (in the interval `[71, 81)`).",
|
|
2176
|
+
"The match rate range is between 81% and 90% (in the interval `[81, 91)`).",
|
|
2177
|
+
"The match rate range is between 91% and 100% (in the interval `[91, 100]`)."
|
|
2178
|
+
],
|
|
2179
|
+
"type": "string"
|
|
2180
|
+
}
|
|
2181
|
+
},
|
|
2182
|
+
"type": "object"
|
|
2183
|
+
},
|
|
1529
2184
|
"IngestEventsRequest": {
|
|
1530
2185
|
"description": "Request to upload audience members to the provided destinations. Returns an IngestEventsResponse.",
|
|
1531
2186
|
"id": "IngestEventsRequest",
|
|
@@ -1765,6 +2420,27 @@ true
|
|
|
1765
2420
|
},
|
|
1766
2421
|
"type": "object"
|
|
1767
2422
|
},
|
|
2423
|
+
"IpData": {
|
|
2424
|
+
"description": "IP address information for a user. We recommend including observe_start_time and observe_end_time to help improve Customer Match match rates.",
|
|
2425
|
+
"id": "IpData",
|
|
2426
|
+
"properties": {
|
|
2427
|
+
"ipAddress": {
|
|
2428
|
+
"description": "Required. IP address captured at the time of customer interaction. Accepts standard string formats for both IPv4 and IPv6.",
|
|
2429
|
+
"type": "string"
|
|
2430
|
+
},
|
|
2431
|
+
"observeEndTime": {
|
|
2432
|
+
"description": "Optional. Last recorded interaction time from this IP address in a session.",
|
|
2433
|
+
"format": "google-datetime",
|
|
2434
|
+
"type": "string"
|
|
2435
|
+
},
|
|
2436
|
+
"observeStartTime": {
|
|
2437
|
+
"description": "Optional. First recorded interaction time from this IP address in a session.",
|
|
2438
|
+
"format": "google-datetime",
|
|
2439
|
+
"type": "string"
|
|
2440
|
+
}
|
|
2441
|
+
},
|
|
2442
|
+
"type": "object"
|
|
2443
|
+
},
|
|
1768
2444
|
"Item": {
|
|
1769
2445
|
"description": "Represents an item in the cart associated with the event.",
|
|
1770
2446
|
"id": "Item",
|
|
@@ -1776,10 +2452,34 @@ true
|
|
|
1776
2452
|
},
|
|
1777
2453
|
"type": "array"
|
|
1778
2454
|
},
|
|
2455
|
+
"conversionValue": {
|
|
2456
|
+
"description": "Optional. The conversion value associated with this item within the event, for cases where the conversion value is different for each item.",
|
|
2457
|
+
"format": "double",
|
|
2458
|
+
"type": "number"
|
|
2459
|
+
},
|
|
2460
|
+
"customVariables": {
|
|
2461
|
+
"description": "Optional. Additional key/value pair information to send to the conversion containers (conversion action or Floodlight activity), when tracking per-item conversions.",
|
|
2462
|
+
"items": {
|
|
2463
|
+
"$ref": "ItemCustomVariable"
|
|
2464
|
+
},
|
|
2465
|
+
"type": "array"
|
|
2466
|
+
},
|
|
1779
2467
|
"itemId": {
|
|
1780
2468
|
"description": "Optional. A unique identifier to reference the item.",
|
|
1781
2469
|
"type": "string"
|
|
1782
2470
|
},
|
|
2471
|
+
"merchantFeedLabel": {
|
|
2472
|
+
"description": "Optional. The feed label of the Merchant Center feed. If countries are still being used, the 2-letter country code in ISO-3166-1 alpha-2 can be used instead. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.",
|
|
2473
|
+
"type": "string"
|
|
2474
|
+
},
|
|
2475
|
+
"merchantFeedLanguageCode": {
|
|
2476
|
+
"description": "Optional. The language code in ISO 639-1 associated with the Merchant Center feed where your items are uploaded.",
|
|
2477
|
+
"type": "string"
|
|
2478
|
+
},
|
|
2479
|
+
"merchantId": {
|
|
2480
|
+
"description": "Optional. The Merchant Center ID associated with the item. For Store Sales events this will override the value set at the cart level. This field is ignored for other events.",
|
|
2481
|
+
"type": "string"
|
|
2482
|
+
},
|
|
1783
2483
|
"merchantProductId": {
|
|
1784
2484
|
"description": "Optional. The product ID within the Merchant Center account.",
|
|
1785
2485
|
"type": "string"
|
|
@@ -1797,6 +2497,28 @@ true
|
|
|
1797
2497
|
},
|
|
1798
2498
|
"type": "object"
|
|
1799
2499
|
},
|
|
2500
|
+
"ItemCustomVariable": {
|
|
2501
|
+
"description": "Item-level custom variable for ads conversions.",
|
|
2502
|
+
"id": "ItemCustomVariable",
|
|
2503
|
+
"properties": {
|
|
2504
|
+
"destinationReferences": {
|
|
2505
|
+
"description": "Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.",
|
|
2506
|
+
"items": {
|
|
2507
|
+
"type": "string"
|
|
2508
|
+
},
|
|
2509
|
+
"type": "array"
|
|
2510
|
+
},
|
|
2511
|
+
"value": {
|
|
2512
|
+
"description": "Optional. The value to store for the custom variable.",
|
|
2513
|
+
"type": "string"
|
|
2514
|
+
},
|
|
2515
|
+
"variable": {
|
|
2516
|
+
"description": "Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.",
|
|
2517
|
+
"type": "string"
|
|
2518
|
+
}
|
|
2519
|
+
},
|
|
2520
|
+
"type": "object"
|
|
2521
|
+
},
|
|
1800
2522
|
"ItemParameter": {
|
|
1801
2523
|
"description": "A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.",
|
|
1802
2524
|
"id": "ItemParameter",
|
|
@@ -2117,10 +2839,43 @@ true
|
|
|
2117
2839
|
},
|
|
2118
2840
|
"type": "object"
|
|
2119
2841
|
},
|
|
2842
|
+
"PartnerCustomerAccount": {
|
|
2843
|
+
"description": "Represents a customer account in the partner's system.",
|
|
2844
|
+
"id": "PartnerCustomerAccount",
|
|
2845
|
+
"properties": {
|
|
2846
|
+
"accountId": {
|
|
2847
|
+
"description": "Required. The identifier of the customer account in the partner's ID space.",
|
|
2848
|
+
"type": "string"
|
|
2849
|
+
},
|
|
2850
|
+
"accountName": {
|
|
2851
|
+
"description": "Optional. The name of the account.",
|
|
2852
|
+
"type": "string"
|
|
2853
|
+
},
|
|
2854
|
+
"accountType": {
|
|
2855
|
+
"description": "Optional. The type of the account. Can be used to distinguish between advertiser accounts and business level accounts, for example.",
|
|
2856
|
+
"type": "string"
|
|
2857
|
+
}
|
|
2858
|
+
},
|
|
2859
|
+
"type": "object"
|
|
2860
|
+
},
|
|
2120
2861
|
"PartnerLink": {
|
|
2121
2862
|
"description": "A partner link between an owning account and a partner account.",
|
|
2122
2863
|
"id": "PartnerLink",
|
|
2123
2864
|
"properties": {
|
|
2865
|
+
"featureSet": {
|
|
2866
|
+
"description": "Optional. Immutable. The set of features supported for the partner link. If not specified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT.",
|
|
2867
|
+
"enum": [
|
|
2868
|
+
"FEATURE_SET_UNSPECIFIED",
|
|
2869
|
+
"FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT",
|
|
2870
|
+
"FEATURE_SET_AD_EVENT_MANAGEMENT"
|
|
2871
|
+
],
|
|
2872
|
+
"enumDescriptions": [
|
|
2873
|
+
"Unspecified feature set. If unspecified, the system behavior defaults to FEATURE_SET_AUDIENCE_AND_EVENT_MANAGEMENT.",
|
|
2874
|
+
"Indicates a link used for audience and event management.",
|
|
2875
|
+
"Indicates a link used for ad event management."
|
|
2876
|
+
],
|
|
2877
|
+
"type": "string"
|
|
2878
|
+
},
|
|
2124
2879
|
"name": {
|
|
2125
2880
|
"description": "Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}",
|
|
2126
2881
|
"type": "string"
|
|
@@ -2133,10 +2888,32 @@ true
|
|
|
2133
2888
|
"$ref": "ProductAccount",
|
|
2134
2889
|
"description": "Required. The partner account granted access by the owning account."
|
|
2135
2890
|
},
|
|
2891
|
+
"partnerCustomerAccount": {
|
|
2892
|
+
"$ref": "PartnerCustomerAccount",
|
|
2893
|
+
"description": "Optional. The customer account in the partner system. This is required for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set."
|
|
2894
|
+
},
|
|
2136
2895
|
"partnerLinkId": {
|
|
2137
2896
|
"description": "Output only. The partner link ID.",
|
|
2138
2897
|
"readOnly": true,
|
|
2139
2898
|
"type": "string"
|
|
2899
|
+
},
|
|
2900
|
+
"partnerLinkMetadata": {
|
|
2901
|
+
"$ref": "PartnerLinkMetadata",
|
|
2902
|
+
"description": "Optional. Metadata associated with the partner link. This is optional and only accepted for partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT."
|
|
2903
|
+
}
|
|
2904
|
+
},
|
|
2905
|
+
"type": "object"
|
|
2906
|
+
},
|
|
2907
|
+
"PartnerLinkMetadata": {
|
|
2908
|
+
"description": "Represents metadata associated with a partner link.",
|
|
2909
|
+
"id": "PartnerLinkMetadata",
|
|
2910
|
+
"properties": {
|
|
2911
|
+
"implicitAccounts": {
|
|
2912
|
+
"description": "Optional. The list of implicit accounts.",
|
|
2913
|
+
"items": {
|
|
2914
|
+
"$ref": "PartnerCustomerAccount"
|
|
2915
|
+
},
|
|
2916
|
+
"type": "array"
|
|
2140
2917
|
}
|
|
2141
2918
|
},
|
|
2142
2919
|
"type": "object"
|
|
@@ -2164,7 +2941,7 @@ true
|
|
|
2164
2941
|
"type": "string"
|
|
2165
2942
|
},
|
|
2166
2943
|
"accountType": {
|
|
2167
|
-
"description": "
|
|
2944
|
+
"description": "Required. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.",
|
|
2168
2945
|
"enum": [
|
|
2169
2946
|
"ACCOUNT_TYPE_UNSPECIFIED",
|
|
2170
2947
|
"GOOGLE_ADS",
|
|
@@ -2172,7 +2949,8 @@ true
|
|
|
2172
2949
|
"DISPLAY_VIDEO_ADVERTISER",
|
|
2173
2950
|
"DATA_PARTNER",
|
|
2174
2951
|
"GOOGLE_ANALYTICS_PROPERTY",
|
|
2175
|
-
"GOOGLE_AD_MANAGER_AUDIENCE_LINK"
|
|
2952
|
+
"GOOGLE_AD_MANAGER_AUDIENCE_LINK",
|
|
2953
|
+
"FLOODLIGHT_CONFIG"
|
|
2176
2954
|
],
|
|
2177
2955
|
"enumDescriptions": [
|
|
2178
2956
|
"Unspecified product. Should never be used.",
|
|
@@ -2181,7 +2959,8 @@ true
|
|
|
2181
2959
|
"Display & Video 360 advertiser.",
|
|
2182
2960
|
"Data Partner.",
|
|
2183
2961
|
"Google Analytics.",
|
|
2184
|
-
"Google Ad Manager audience link."
|
|
2962
|
+
"Google Ad Manager audience link.",
|
|
2963
|
+
"Floodlight configuration."
|
|
2185
2964
|
],
|
|
2186
2965
|
"type": "string"
|
|
2187
2966
|
},
|
|
@@ -2294,6 +3073,10 @@ true
|
|
|
2294
3073
|
"description": "The status of the remove audience members request.",
|
|
2295
3074
|
"id": "RemoveAudienceMembersStatus",
|
|
2296
3075
|
"properties": {
|
|
3076
|
+
"compositeDataRemovalStatus": {
|
|
3077
|
+
"$ref": "RemoveCompositeDataStatus",
|
|
3078
|
+
"description": "The status of the composite data removal from the destination."
|
|
3079
|
+
},
|
|
2297
3080
|
"mobileDataRemovalStatus": {
|
|
2298
3081
|
"$ref": "RemoveMobileDataStatus",
|
|
2299
3082
|
"description": "The status of the mobile data removal from the destination."
|
|
@@ -2317,6 +3100,25 @@ true
|
|
|
2317
3100
|
},
|
|
2318
3101
|
"type": "object"
|
|
2319
3102
|
},
|
|
3103
|
+
"RemoveCompositeDataStatus": {
|
|
3104
|
+
"description": "The status of the composite data removal from the destination.",
|
|
3105
|
+
"id": "RemoveCompositeDataStatus",
|
|
3106
|
+
"properties": {
|
|
3107
|
+
"dataTypeCounts": {
|
|
3108
|
+
"description": "The total count of data types sent in the removal request, broken down by data type. Includes all data types in the request, regardless of whether they were successfully removed or not.",
|
|
3109
|
+
"items": {
|
|
3110
|
+
"$ref": "DataTypeCount"
|
|
3111
|
+
},
|
|
3112
|
+
"type": "array"
|
|
3113
|
+
},
|
|
3114
|
+
"recordCount": {
|
|
3115
|
+
"description": "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.",
|
|
3116
|
+
"format": "int64",
|
|
3117
|
+
"type": "string"
|
|
3118
|
+
}
|
|
3119
|
+
},
|
|
3120
|
+
"type": "object"
|
|
3121
|
+
},
|
|
2320
3122
|
"RemoveMobileDataStatus": {
|
|
2321
3123
|
"description": "The status of the mobile data removal from the destination.",
|
|
2322
3124
|
"id": "RemoveMobileDataStatus",
|
|
@@ -2420,7 +3222,7 @@ true
|
|
|
2420
3222
|
},
|
|
2421
3223
|
"errorInfo": {
|
|
2422
3224
|
"$ref": "ErrorInfo",
|
|
2423
|
-
"description": "An error info error containing the error reason and error counts related to the upload."
|
|
3225
|
+
"description": "An error info error containing the error reason and error counts related to the upload. Only populated if the `request_status` is `FAILED` or `PARTIAL_SUCCESS`. This field isn't populated while the request has `request_status` of `PROCESSING`."
|
|
2424
3226
|
},
|
|
2425
3227
|
"eventsIngestionStatus": {
|
|
2426
3228
|
"$ref": "IngestEventsStatus",
|
|
@@ -2437,16 +3239,16 @@ true
|
|
|
2437
3239
|
],
|
|
2438
3240
|
"enumDescriptions": [
|
|
2439
3241
|
"The request status is unknown.",
|
|
2440
|
-
"
|
|
3242
|
+
"Processing succeeded for all records without any errors. However, there may be warnings in the `warning_info` field.",
|
|
2441
3243
|
"The request is processing.",
|
|
2442
|
-
"
|
|
2443
|
-
"
|
|
3244
|
+
"Processing failed for all records. Check the `error_info` field for error details, and check the `warning_info` field for warning details.",
|
|
3245
|
+
"Processing completed successfully without errors for some records, but failed with errors for other records. Check the `error_info` field for error details, and check the `warning_info` field for warning details."
|
|
2444
3246
|
],
|
|
2445
3247
|
"type": "string"
|
|
2446
3248
|
},
|
|
2447
3249
|
"warningInfo": {
|
|
2448
3250
|
"$ref": "WarningInfo",
|
|
2449
|
-
"description": "A warning info containing the warning reason and warning counts related to the upload."
|
|
3251
|
+
"description": "A warning info containing the warning reason and warning counts related to the upload. This field isn't populated while the request has `request_status` of `PROCESSING`."
|
|
2450
3252
|
}
|
|
2451
3253
|
},
|
|
2452
3254
|
"type": "object"
|
|
@@ -2522,11 +3324,23 @@ true
|
|
|
2522
3324
|
"readOnly": true,
|
|
2523
3325
|
"type": "string"
|
|
2524
3326
|
},
|
|
3327
|
+
"gmailMembersCount": {
|
|
3328
|
+
"description": "Output only. Estimated number of members in this user list on Gmail.",
|
|
3329
|
+
"format": "int64",
|
|
3330
|
+
"readOnly": true,
|
|
3331
|
+
"type": "string"
|
|
3332
|
+
},
|
|
2525
3333
|
"searchNetworkMembersCount": {
|
|
2526
3334
|
"description": "Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns.",
|
|
2527
3335
|
"format": "int64",
|
|
2528
3336
|
"readOnly": true,
|
|
2529
3337
|
"type": "string"
|
|
3338
|
+
},
|
|
3339
|
+
"youtubeMembersCount": {
|
|
3340
|
+
"description": "Output only. Estimated number of members in this user list on YouTube.",
|
|
3341
|
+
"format": "int64",
|
|
3342
|
+
"readOnly": true,
|
|
3343
|
+
"type": "string"
|
|
2530
3344
|
}
|
|
2531
3345
|
},
|
|
2532
3346
|
"type": "object"
|
|
@@ -3202,6 +4016,76 @@ true
|
|
|
3202
4016
|
},
|
|
3203
4017
|
"type": "object"
|
|
3204
4018
|
},
|
|
4019
|
+
"ViewabilityInfo": {
|
|
4020
|
+
"description": "Details of the viewability of the ad served.",
|
|
4021
|
+
"id": "ViewabilityInfo",
|
|
4022
|
+
"properties": {
|
|
4023
|
+
"mediaDuration": {
|
|
4024
|
+
"description": "Optional. The duration of the ad media.",
|
|
4025
|
+
"format": "google-duration",
|
|
4026
|
+
"type": "string"
|
|
4027
|
+
},
|
|
4028
|
+
"mediaQuartile": {
|
|
4029
|
+
"description": "Optional. The amount of the media that was played as discrete quartiles.",
|
|
4030
|
+
"enum": [
|
|
4031
|
+
"MEDIA_QUARTILE_UNSPECIFIED",
|
|
4032
|
+
"MEDIA_QUARTILE_START",
|
|
4033
|
+
"MEDIA_QUARTILE_FIRST_QUARTILE",
|
|
4034
|
+
"MEDIA_QUARTILE_MIDPOINT",
|
|
4035
|
+
"MEDIA_QUARTILE_THIRD_QUARTILE",
|
|
4036
|
+
"MEDIA_QUARTILE_COMPLETE"
|
|
4037
|
+
],
|
|
4038
|
+
"enumDescriptions": [
|
|
4039
|
+
"Unspecified media quartile.",
|
|
4040
|
+
"Start.",
|
|
4041
|
+
"First quartile.",
|
|
4042
|
+
"Midpoint.",
|
|
4043
|
+
"Third quartile.",
|
|
4044
|
+
"Complete."
|
|
4045
|
+
],
|
|
4046
|
+
"type": "string"
|
|
4047
|
+
},
|
|
4048
|
+
"mediaSkippable": {
|
|
4049
|
+
"description": "Optional. Whether the ad media was skippable or not.",
|
|
4050
|
+
"type": "boolean"
|
|
4051
|
+
},
|
|
4052
|
+
"mediaVolumePercent": {
|
|
4053
|
+
"description": "Optional. The numerical percent (0-100) of the volume of the media playback.",
|
|
4054
|
+
"format": "int32",
|
|
4055
|
+
"type": "integer"
|
|
4056
|
+
},
|
|
4057
|
+
"playbackDuration": {
|
|
4058
|
+
"description": "Optional. The duration of playback of the ad media, regardless of whether it was viewable or not.",
|
|
4059
|
+
"format": "google-duration",
|
|
4060
|
+
"type": "string"
|
|
4061
|
+
},
|
|
4062
|
+
"viewType": {
|
|
4063
|
+
"description": "Required. The type of the event.",
|
|
4064
|
+
"enum": [
|
|
4065
|
+
"VIEW_TYPE_UNSPECIFIED",
|
|
4066
|
+
"VIEW_TYPE_MRC_VIEWED",
|
|
4067
|
+
"VIEW_TYPE_MRC_RENDERED"
|
|
4068
|
+
],
|
|
4069
|
+
"enumDescriptions": [
|
|
4070
|
+
"Unspecified view type.",
|
|
4071
|
+
"MRC viewed.",
|
|
4072
|
+
"MRC rendered."
|
|
4073
|
+
],
|
|
4074
|
+
"type": "string"
|
|
4075
|
+
},
|
|
4076
|
+
"viewableDuration": {
|
|
4077
|
+
"description": "Optional. The amount of time the ad was viewable for.",
|
|
4078
|
+
"format": "google-duration",
|
|
4079
|
+
"type": "string"
|
|
4080
|
+
},
|
|
4081
|
+
"viewablePercent": {
|
|
4082
|
+
"description": "Optional. The numerical percent (0-100) of the pixels that were viewable.",
|
|
4083
|
+
"format": "int32",
|
|
4084
|
+
"type": "integer"
|
|
4085
|
+
}
|
|
4086
|
+
},
|
|
4087
|
+
"type": "object"
|
|
4088
|
+
},
|
|
3205
4089
|
"WarningCount": {
|
|
3206
4090
|
"description": "The warning count for a given warning reason.",
|
|
3207
4091
|
"id": "WarningCount",
|
|
@@ -3228,7 +4112,7 @@ true
|
|
|
3228
4112
|
"The WIP could not be used because it was rejected by its attestation condition.",
|
|
3229
4113
|
"The WIP is formatted incorrectly or the WIP does not exist.",
|
|
3230
4114
|
"The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.",
|
|
3231
|
-
"Failed to decrypt
|
|
4115
|
+
"Failed to decrypt the UserIdentifier data using the DEK.",
|
|
3232
4116
|
"Internal error.",
|
|
3233
4117
|
"The system failed to authenticate with AWS."
|
|
3234
4118
|
],
|