Skip to content

Commit 8c07b29

Browse files
yoshi-automationyoshi-automation
committed
feat(dataportability): update the api
#### dataportability:v1 The following keys were added: - resources.archiveJobs.methods.cancel (Total Keys: 12) - schemas.CancelPortabilityArchiveRequest (Total Keys: 2) - schemas.CancelPortabilityArchiveResponse (Total Keys: 2) - schemas.InitiatePortabilityArchiveRequest.properties.endTime (Total Keys: 2) - schemas.InitiatePortabilityArchiveRequest.properties.startTime (Total Keys: 2) - schemas.InitiatePortabilityArchiveResponse.properties.accessType.type (Total Keys: 1) - schemas.PortabilityArchiveState.properties.exportTime (Total Keys: 2) - schemas.PortabilityArchiveState.properties.startTime (Total Keys: 2) #### dataportability:v1beta The following keys were added: - resources.archiveJobs.methods.cancel (Total Keys: 12) - schemas.CancelPortabilityArchiveRequest (Total Keys: 2) - schemas.CancelPortabilityArchiveResponse (Total Keys: 2) - schemas.InitiatePortabilityArchiveRequest.properties.endTime (Total Keys: 2) - schemas.InitiatePortabilityArchiveRequest.properties.startTime (Total Keys: 2) - schemas.InitiatePortabilityArchiveResponse.properties.accessType.type (Total Keys: 1) - schemas.PortabilityArchiveState.properties.exportTime (Total Keys: 2) - schemas.PortabilityArchiveState.properties.startTime (Total Keys: 2)
1 parent 0734775 commit 8c07b29

6 files changed

+344
-2
lines changed

‎docs/dyn/dataportability_v1.archiveJobs.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@
7474

7575
<h1><a href="dataportability_v1.html">Data Portability API</a> . <a href="dataportability_v1.archiveJobs.html">archiveJobs</a></h1>
7676
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
79+
<p class="firstline">Cancels a Portability Archive job.</p>
7780
<p class="toc_element">
7881
<code><a href="#close">close()</a></code></p>
7982
<p class="firstline">Close httplib2 connections.</p>
@@ -84,6 +87,30 @@ <h2>Instance Methods</h2>
8487
<code><a href="#retry">retry(name, body=None, x__xgafv=None)</a></code></p>
8588
<p class="firstline">Retries a failed Portability Archive job.</p>
8689
<h3>Method Details</h3>
90+
<div class="method">
91+
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
92+
<pre>Cancels a Portability Archive job.
93+
94+
Args:
95+
name: string, Required. The Archive job ID you&#x27;re canceling. This is returned by the InitiatePortabilityArchive response. The format is: archiveJobs/{archive_job}. Canceling is only executed if the job is in progress. (required)
96+
body: object, The request body.
97+
The object takes the form of:
98+
99+
{ # Request to cancel a Portability Archive job.
100+
}
101+
102+
x__xgafv: string, V1 error format.
103+
Allowed values
104+
1 - v1 error format
105+
2 - v2 error format
106+
107+
Returns:
108+
An object of the form:
109+
110+
{ # Response to canceling a Data Portability Archive job.
111+
}</pre>
112+
</div>
113+
87114
<div class="method">
88115
<code class="details" id="close">close()</code>
89116
<pre>Close httplib2 connections.</pre>
@@ -104,7 +131,9 @@ <h3>Method Details</h3>
104131
An object of the form:
105132

106133
{ # Resource that contains the state of an Archive job.
134+
&quot;exportTime&quot;: &quot;A String&quot;, # The timestamp that represents the end point for the data you are exporting. If the end_time value is set in the InitiatePortabilityArchiveRequest, this field is set to that value. If end_time is not set, this value is set to the time the export was requested.
107135
&quot;name&quot;: &quot;A String&quot;, # The resource name of ArchiveJob&#x27;s PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID provided in the request.
136+
&quot;startTime&quot;: &quot;A String&quot;, # The timestamp that represents the starting point for the data you are exporting. This field is set only if the start_time field is specified in the InitiatePortabilityArchiveRequest.
108137
&quot;state&quot;: &quot;A String&quot;, # Resource that represents the state of the Archive job.
109138
&quot;urls&quot;: [ # If the state is complete, this method returns the signed URLs of the objects in the Cloud Storage bucket.
110139
&quot;A String&quot;,

‎docs/dyn/dataportability_v1.portabilityArchive.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,11 @@ <h3>Method Details</h3>
9595
The object takes the form of:
9696

9797
{ # Request to kick off an Archive job.
98+
&quot;endTime&quot;: &quot;A String&quot;, # Optional. The timestamp that represents the end point for the data you are exporting. If the end_time is not specified in the InitiatePortabilityArchiveRequest, this field is set to the latest available data.
9899
&quot;resources&quot;: [ # The resources from which you&#x27;re exporting data. These values have a 1:1 correspondence with the OAuth scopes.
99100
&quot;A String&quot;,
100101
],
102+
&quot;startTime&quot;: &quot;A String&quot;, # Optional. The timestamp that represents the starting point for the data you are exporting. If the start_time is not specified in the InitiatePortabilityArchiveRequest, the field is set to the earliest available data.
101103
}
102104

103105
x__xgafv: string, V1 error format.
@@ -109,6 +111,7 @@ <h3>Method Details</h3>
109111
An object of the form:
110112

111113
{ # Response from initiating an Archive job.
114+
&quot;accessType&quot;: &quot;A String&quot;, # The access type of the Archive job initiated by the API.
112115
&quot;archiveJobId&quot;: &quot;A String&quot;, # The archive job ID that is initiated in the API. This can be used to get the state of the job.
113116
}</pre>
114117
</div>

‎docs/dyn/dataportability_v1beta.archiveJobs.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@
7474

7575
<h1><a href="dataportability_v1beta.html">Data Portability API</a> . <a href="dataportability_v1beta.archiveJobs.html">archiveJobs</a></h1>
7676
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
79+
<p class="firstline">Cancels a Portability Archive job.</p>
7780
<p class="toc_element">
7881
<code><a href="#close">close()</a></code></p>
7982
<p class="firstline">Close httplib2 connections.</p>
@@ -84,6 +87,30 @@ <h2>Instance Methods</h2>
8487
<code><a href="#retry">retry(name, body=None, x__xgafv=None)</a></code></p>
8588
<p class="firstline">Retries a failed Portability Archive job.</p>
8689
<h3>Method Details</h3>
90+
<div class="method">
91+
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
92+
<pre>Cancels a Portability Archive job.
93+
94+
Args:
95+
name: string, Required. The Archive job ID you&#x27;re canceling. This is returned by the InitiatePortabilityArchive response. The format is: archiveJobs/{archive_job}. Canceling is only executed if the job is in progress. (required)
96+
body: object, The request body.
97+
The object takes the form of:
98+
99+
{ # Request to cancel a Portability Archive job.
100+
}
101+
102+
x__xgafv: string, V1 error format.
103+
Allowed values
104+
1 - v1 error format
105+
2 - v2 error format
106+
107+
Returns:
108+
An object of the form:
109+
110+
{ # Response to canceling a Data Portability Archive job.
111+
}</pre>
112+
</div>
113+
87114
<div class="method">
88115
<code class="details" id="close">close()</code>
89116
<pre>Close httplib2 connections.</pre>
@@ -104,7 +131,9 @@ <h3>Method Details</h3>
104131
An object of the form:
105132

106133
{ # Resource that contains the state of an Archive job.
134+
&quot;exportTime&quot;: &quot;A String&quot;, # The timestamp that represents the end point for the data you are exporting. If the end_time value is set in the InitiatePortabilityArchiveRequest, this field is set to that value. If end_time is not set, this value is set to the time the export was requested.
107135
&quot;name&quot;: &quot;A String&quot;, # The resource name of ArchiveJob&#x27;s PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID provided in the request.
136+
&quot;startTime&quot;: &quot;A String&quot;, # The timestamp that represents the starting point for the data you are exporting. This field is set only if the start_time field is specified in the InitiatePortabilityArchiveRequest.
108137
&quot;state&quot;: &quot;A String&quot;, # Resource that represents the state of the Archive job.
109138
&quot;urls&quot;: [ # If the state is complete, this method returns the signed URLs of the objects in the Cloud Storage bucket.
110139
&quot;A String&quot;,

‎docs/dyn/dataportability_v1beta.portabilityArchive.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,11 @@ <h3>Method Details</h3>
9595
The object takes the form of:
9696

9797
{ # Request to kick off an Archive job.
98+
&quot;endTime&quot;: &quot;A String&quot;, # Optional. The timestamp that represents the end point for the data you are exporting. If the end_time is not specified in the InitiatePortabilityArchiveRequest, this field is set to the latest available data.
9899
&quot;resources&quot;: [ # The resources from which you&#x27;re exporting data. These values have a 1:1 correspondence with the OAuth scopes.
99100
&quot;A String&quot;,
100101
],
102+
&quot;startTime&quot;: &quot;A String&quot;, # Optional. The timestamp that represents the starting point for the data you are exporting. If the start_time is not specified in the InitiatePortabilityArchiveRequest, the field is set to the earliest available data.
101103
}
102104

103105
x__xgafv: string, V1 error format.
@@ -109,6 +111,7 @@ <h3>Method Details</h3>
109111
An object of the form:
110112

111113
{ # Response from initiating an Archive job.
114+
&quot;accessType&quot;: &quot;A String&quot;, # The access type of the Archive job initiated by the API.
112115
&quot;archiveJobId&quot;: &quot;A String&quot;, # The archive job ID that is initiated in the API. This can be used to get the state of the job.
113116
}</pre>
114117
</div>

‎googleapiclient/discovery_cache/documents/dataportability.v1.json

Lines changed: 140 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,99 @@
302302
"resources": {
303303
"archiveJobs": {
304304
"methods": {
305+
"cancel": {
306+
"description": "Cancels a Portability Archive job.",
307+
"flatPath": "v1/archiveJobs/{archiveJobsId}:cancel",
308+
"httpMethod": "POST",
309+
"id": "dataportability.archiveJobs.cancel",
310+
"parameterOrder": [
311+
"name"
312+
],
313+
"parameters": {
314+
"name": {
315+
"description": "Required. The Archive job ID you're canceling. This is returned by the InitiatePortabilityArchive response. The format is: archiveJobs/{archive_job}. Canceling is only executed if the job is in progress.",
316+
"location": "path",
317+
"pattern": "^archiveJobs/[^/]+$",
318+
"required": true,
319+
"type": "string"
320+
}
321+
},
322+
"path": "v1/{+name}:cancel",
323+
"request": {
324+
"$ref": "CancelPortabilityArchiveRequest"
325+
},
326+
"response": {
327+
"$ref": "CancelPortabilityArchiveResponse"
328+
},
329+
"scopes": [
330+
"https://www.googleapis.com/auth/dataportability.alerts.subscriptions",
331+
"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations",
332+
"https://www.googleapis.com/auth/dataportability.chrome.autofill",
333+
"https://www.googleapis.com/auth/dataportability.chrome.bookmarks",
334+
"https://www.googleapis.com/auth/dataportability.chrome.dictionary",
335+
"https://www.googleapis.com/auth/dataportability.chrome.extensions",
336+
"https://www.googleapis.com/auth/dataportability.chrome.history",
337+
"https://www.googleapis.com/auth/dataportability.chrome.reading_list",
338+
"https://www.googleapis.com/auth/dataportability.chrome.settings",
339+
"https://www.googleapis.com/auth/dataportability.discover.follows",
340+
"https://www.googleapis.com/auth/dataportability.discover.likes",
341+
"https://www.googleapis.com/auth/dataportability.discover.not_interested",
342+
"https://www.googleapis.com/auth/dataportability.maps.aliased_places",
343+
"https://www.googleapis.com/auth/dataportability.maps.commute_routes",
344+
"https://www.googleapis.com/auth/dataportability.maps.commute_settings",
345+
"https://www.googleapis.com/auth/dataportability.maps.ev_profile",
346+
"https://www.googleapis.com/auth/dataportability.maps.factual_contributions",
347+
"https://www.googleapis.com/auth/dataportability.maps.offering_contributions",
348+
"https://www.googleapis.com/auth/dataportability.maps.photos_videos",
349+
"https://www.googleapis.com/auth/dataportability.maps.questions_answers",
350+
"https://www.googleapis.com/auth/dataportability.maps.reviews",
351+
"https://www.googleapis.com/auth/dataportability.maps.starred_places",
352+
"https://www.googleapis.com/auth/dataportability.myactivity.maps",
353+
"https://www.googleapis.com/auth/dataportability.myactivity.myadcenter",
354+
"https://www.googleapis.com/auth/dataportability.myactivity.play",
355+
"https://www.googleapis.com/auth/dataportability.myactivity.search",
356+
"https://www.googleapis.com/auth/dataportability.myactivity.shopping",
357+
"https://www.googleapis.com/auth/dataportability.myactivity.youtube",
358+
"https://www.googleapis.com/auth/dataportability.mymaps.maps",
359+
"https://www.googleapis.com/auth/dataportability.order_reserve.purchases_reservations",
360+
"https://www.googleapis.com/auth/dataportability.play.devices",
361+
"https://www.googleapis.com/auth/dataportability.play.grouping",
362+
"https://www.googleapis.com/auth/dataportability.play.installs",
363+
"https://www.googleapis.com/auth/dataportability.play.library",
364+
"https://www.googleapis.com/auth/dataportability.play.playpoints",
365+
"https://www.googleapis.com/auth/dataportability.play.promotions",
366+
"https://www.googleapis.com/auth/dataportability.play.purchases",
367+
"https://www.googleapis.com/auth/dataportability.play.redemptions",
368+
"https://www.googleapis.com/auth/dataportability.play.subscriptions",
369+
"https://www.googleapis.com/auth/dataportability.play.usersettings",
370+
"https://www.googleapis.com/auth/dataportability.saved.collections",
371+
"https://www.googleapis.com/auth/dataportability.search_ugc.comments",
372+
"https://www.googleapis.com/auth/dataportability.search_ugc.media.reviews_and_stars",
373+
"https://www.googleapis.com/auth/dataportability.search_ugc.media.streaming_video_providers",
374+
"https://www.googleapis.com/auth/dataportability.search_ugc.media.thumbs",
375+
"https://www.googleapis.com/auth/dataportability.search_ugc.media.watched",
376+
"https://www.googleapis.com/auth/dataportability.searchnotifications.settings",
377+
"https://www.googleapis.com/auth/dataportability.searchnotifications.subscriptions",
378+
"https://www.googleapis.com/auth/dataportability.shopping.addresses",
379+
"https://www.googleapis.com/auth/dataportability.shopping.reviews",
380+
"https://www.googleapis.com/auth/dataportability.streetview.imagery",
381+
"https://www.googleapis.com/auth/dataportability.youtube.channel",
382+
"https://www.googleapis.com/auth/dataportability.youtube.clips",
383+
"https://www.googleapis.com/auth/dataportability.youtube.comments",
384+
"https://www.googleapis.com/auth/dataportability.youtube.live_chat",
385+
"https://www.googleapis.com/auth/dataportability.youtube.music",
386+
"https://www.googleapis.com/auth/dataportability.youtube.playable",
387+
"https://www.googleapis.com/auth/dataportability.youtube.posts",
388+
"https://www.googleapis.com/auth/dataportability.youtube.private_playlists",
389+
"https://www.googleapis.com/auth/dataportability.youtube.private_videos",
390+
"https://www.googleapis.com/auth/dataportability.youtube.public_playlists",
391+
"https://www.googleapis.com/auth/dataportability.youtube.public_videos",
392+
"https://www.googleapis.com/auth/dataportability.youtube.shopping",
393+
"https://www.googleapis.com/auth/dataportability.youtube.subscriptions",
394+
"https://www.googleapis.com/auth/dataportability.youtube.unlisted_playlists",
395+
"https://www.googleapis.com/auth/dataportability.youtube.unlisted_videos"
396+
]
397+
},
305398
"getPortabilityArchiveState": {
306399
"description": "Retrieves the state of an Archive job for the Portability API.",
307400
"flatPath": "v1/archiveJobs/{archiveJobsId}/portabilityArchiveState",
@@ -662,9 +755,21 @@
662755
}
663756
}
664757
},
665-
"revision": "20250120",
758+
"revision": "20250212",
666759
"rootUrl": "https://dataportability.googleapis.com/",
667760
"schemas": {
761+
"CancelPortabilityArchiveRequest": {
762+
"description": "Request to cancel a Portability Archive job.",
763+
"id": "CancelPortabilityArchiveRequest",
764+
"properties": {},
765+
"type": "object"
766+
},
767+
"CancelPortabilityArchiveResponse": {
768+
"description": "Response to canceling a Data Portability Archive job.",
769+
"id": "CancelPortabilityArchiveResponse",
770+
"properties": {},
771+
"type": "object"
772+
},
668773
"Empty": {
669774
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
670775
"id": "Empty",
@@ -675,12 +780,22 @@
675780
"description": "Request to kick off an Archive job.",
676781
"id": "InitiatePortabilityArchiveRequest",
677782
"properties": {
783+
"endTime": {
784+
"description": "Optional. The timestamp that represents the end point for the data you are exporting. If the end_time is not specified in the InitiatePortabilityArchiveRequest, this field is set to the latest available data.",
785+
"format": "google-datetime",
786+
"type": "string"
787+
},
678788
"resources": {
679789
"description": "The resources from which you're exporting data. These values have a 1:1 correspondence with the OAuth scopes.",
680790
"items": {
681791
"type": "string"
682792
},
683793
"type": "array"
794+
},
795+
"startTime": {
796+
"description": "Optional. The timestamp that represents the starting point for the data you are exporting. If the start_time is not specified in the InitiatePortabilityArchiveRequest, the field is set to the earliest available data.",
797+
"format": "google-datetime",
798+
"type": "string"
684799
}
685800
},
686801
"type": "object"
@@ -689,6 +804,20 @@
689804
"description": "Response from initiating an Archive job.",
690805
"id": "InitiatePortabilityArchiveResponse",
691806
"properties": {
807+
"accessType": {
808+
"description": "The access type of the Archive job initiated by the API.",
809+
"enum": [
810+
"ACCESS_TYPE_UNSPECIFIED",
811+
"ACCESS_TYPE_ONE_TIME",
812+
"ACCESS_TYPE_TIME_BASED"
813+
],
814+
"enumDescriptions": [
815+
"Default value. This value is unused.",
816+
"One-time access to the requested scopes.",
817+
"Multiple exports allowed over 30 days. Enum value subject to change before launch."
818+
],
819+
"type": "string"
820+
},
692821
"archiveJobId": {
693822
"description": "The archive job ID that is initiated in the API. This can be used to get the state of the job.",
694823
"type": "string"
@@ -700,10 +829,20 @@
700829
"description": "Resource that contains the state of an Archive job.",
701830
"id": "PortabilityArchiveState",
702831
"properties": {
832+
"exportTime": {
833+
"description": "The timestamp that represents the end point for the data you are exporting. If the end_time value is set in the InitiatePortabilityArchiveRequest, this field is set to that value. If end_time is not set, this value is set to the time the export was requested.",
834+
"format": "google-datetime",
835+
"type": "string"
836+
},
703837
"name": {
704838
"description": "The resource name of ArchiveJob's PortabilityArchiveState singleton. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID provided in the request.",
705839
"type": "string"
706840
},
841+
"startTime": {
842+
"description": "The timestamp that represents the starting point for the data you are exporting. This field is set only if the start_time field is specified in the InitiatePortabilityArchiveRequest.",
843+
"format": "google-datetime",
844+
"type": "string"
845+
},
707846
"state": {
708847
"description": "Resource that represents the state of the Archive job.",
709848
"enum": [

0 commit comments

Comments
 (0)