...

Text file src/google.golang.org/api/appsactivity/v1/appsactivity-api.json

Documentation: google.golang.org/api/appsactivity/v1

     1{
     2  "auth": {
     3    "oauth2": {
     4      "scopes": {
     5        "https://www.googleapis.com/auth/activity": {
     6          "description": "View the activity history of your Google apps"
     7        }
     8      }
     9    }
    10  },
    11  "basePath": "/appsactivity/v1/",
    12  "baseUrl": "https://www.googleapis.com/appsactivity/v1/",
    13  "batchPath": "batch/appsactivity/v1",
    14  "description": "Provides a historical view of activity.",
    15  "discoveryVersion": "v1",
    16  "documentationLink": "https://developers.google.com/google-apps/activity/",
    17  "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/EPm-mIaUlffEieKph-AEYsz0i8Y\"",
    18  "icons": {
    19    "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
    20    "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
    21  },
    22  "id": "appsactivity:v1",
    23  "kind": "discovery#restDescription",
    24  "name": "appsactivity",
    25  "ownerDomain": "google.com",
    26  "ownerName": "Google",
    27  "parameters": {
    28    "alt": {
    29      "default": "json",
    30      "description": "Data format for the response.",
    31      "enum": [
    32        "json"
    33      ],
    34      "enumDescriptions": [
    35        "Responses with Content-Type of application/json"
    36      ],
    37      "location": "query",
    38      "type": "string"
    39    },
    40    "fields": {
    41      "description": "Selector specifying which fields to include in a partial response.",
    42      "location": "query",
    43      "type": "string"
    44    },
    45    "key": {
    46      "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
    47      "location": "query",
    48      "type": "string"
    49    },
    50    "oauth_token": {
    51      "description": "OAuth 2.0 token for the current user.",
    52      "location": "query",
    53      "type": "string"
    54    },
    55    "prettyPrint": {
    56      "default": "true",
    57      "description": "Returns response with indentations and line breaks.",
    58      "location": "query",
    59      "type": "boolean"
    60    },
    61    "quotaUser": {
    62      "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
    63      "location": "query",
    64      "type": "string"
    65    },
    66    "userIp": {
    67      "description": "Deprecated. Please use quotaUser instead.",
    68      "location": "query",
    69      "type": "string"
    70    }
    71  },
    72  "protocol": "rest",
    73  "resources": {
    74    "activities": {
    75      "methods": {
    76        "list": {
    77          "description": "Returns a list of activities visible to the current logged in user. Visible activities are determined by the visibility settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter.",
    78          "httpMethod": "GET",
    79          "id": "appsactivity.activities.list",
    80          "parameters": {
    81            "drive.ancestorId": {
    82              "description": "Identifies the Drive folder containing the items for which to return activities.",
    83              "location": "query",
    84              "type": "string"
    85            },
    86            "drive.fileId": {
    87              "description": "Identifies the Drive item to return activities for.",
    88              "location": "query",
    89              "type": "string"
    90            },
    91            "groupingStrategy": {
    92              "default": "driveUi",
    93              "description": "Indicates the strategy to use when grouping singleEvents items in the associated combinedEvent object.",
    94              "enum": [
    95                "driveUi",
    96                "none"
    97              ],
    98              "enumDescriptions": [
    99                "",
   100                ""
   101              ],
   102              "location": "query",
   103              "type": "string"
   104            },
   105            "pageSize": {
   106              "default": "50",
   107              "description": "The maximum number of events to return on a page. The response includes a continuation token if there are more events.",
   108              "format": "int32",
   109              "location": "query",
   110              "type": "integer"
   111            },
   112            "pageToken": {
   113              "description": "A token to retrieve a specific page of results.",
   114              "location": "query",
   115              "type": "string"
   116            },
   117            "source": {
   118              "description": "The Google service from which to return activities. Possible values of source are: \n- drive.google.com",
   119              "location": "query",
   120              "type": "string"
   121            },
   122            "userId": {
   123              "default": "me",
   124              "description": "The ID used for ACL checks (does not filter the resulting event list by the assigned value). Use the special value me to indicate the currently authenticated user.",
   125              "location": "query",
   126              "type": "string"
   127            }
   128          },
   129          "path": "activities",
   130          "response": {
   131            "$ref": "ListActivitiesResponse"
   132          },
   133          "scopes": [
   134            "https://www.googleapis.com/auth/activity"
   135          ]
   136        }
   137      }
   138    }
   139  },
   140  "revision": "20200128",
   141  "rootUrl": "https://www.googleapis.com/",
   142  "schemas": {
   143    "Activity": {
   144      "description": "An Activity resource is a combined view of multiple events. An activity has a list of individual events and a combined view of the common fields among all events.",
   145      "id": "Activity",
   146      "properties": {
   147        "combinedEvent": {
   148          "$ref": "Event",
   149          "description": "The fields common to all of the singleEvents that make up the Activity."
   150        },
   151        "singleEvents": {
   152          "description": "A list of all the Events that make up the Activity.",
   153          "items": {
   154            "$ref": "Event"
   155          },
   156          "type": "array"
   157        }
   158      },
   159      "type": "object"
   160    },
   161    "Event": {
   162      "description": "Represents the changes associated with an action taken by a user.",
   163      "id": "Event",
   164      "properties": {
   165        "additionalEventTypes": {
   166          "description": "Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.",
   167          "items": {
   168            "enum": [
   169              "comment",
   170              "create",
   171              "edit",
   172              "emptyTrash",
   173              "move",
   174              "permissionChange",
   175              "rename",
   176              "trash",
   177              "unknown",
   178              "untrash",
   179              "upload"
   180            ],
   181            "enumDescriptions": [
   182              "",
   183              "",
   184              "",
   185              "",
   186              "",
   187              "",
   188              "",
   189              "",
   190              "",
   191              "",
   192              ""
   193            ],
   194            "type": "string"
   195          },
   196          "type": "array"
   197        },
   198        "eventTimeMillis": {
   199          "description": "The time at which the event occurred formatted as Unix time in milliseconds.",
   200          "format": "uint64",
   201          "type": "string"
   202        },
   203        "fromUserDeletion": {
   204          "description": "Whether this event is caused by a user being deleted.",
   205          "type": "boolean"
   206        },
   207        "move": {
   208          "$ref": "Move",
   209          "description": "Extra information for move type events, such as changes in an object's parents."
   210        },
   211        "permissionChanges": {
   212          "description": "Extra information for permissionChange type events, such as the user or group the new permission applies to.",
   213          "items": {
   214            "$ref": "PermissionChange"
   215          },
   216          "type": "array"
   217        },
   218        "primaryEventType": {
   219          "description": "The main type of event that occurred.",
   220          "enum": [
   221            "comment",
   222            "create",
   223            "edit",
   224            "emptyTrash",
   225            "move",
   226            "permissionChange",
   227            "rename",
   228            "trash",
   229            "unknown",
   230            "untrash",
   231            "upload"
   232          ],
   233          "enumDescriptions": [
   234            "",
   235            "",
   236            "",
   237            "",
   238            "",
   239            "",
   240            "",
   241            "",
   242            "",
   243            "",
   244            ""
   245          ],
   246          "type": "string"
   247        },
   248        "rename": {
   249          "$ref": "Rename",
   250          "description": "Extra information for rename type events, such as the old and new names."
   251        },
   252        "target": {
   253          "$ref": "Target",
   254          "description": "Information specific to the Target object modified by the event."
   255        },
   256        "user": {
   257          "$ref": "User",
   258          "description": "Represents the user responsible for the event."
   259        }
   260      },
   261      "type": "object"
   262    },
   263    "ListActivitiesResponse": {
   264      "description": "The response from the list request. Contains a list of activities and a token to retrieve the next page of results.",
   265      "id": "ListActivitiesResponse",
   266      "properties": {
   267        "activities": {
   268          "description": "List of activities.",
   269          "items": {
   270            "$ref": "Activity"
   271          },
   272          "type": "array"
   273        },
   274        "nextPageToken": {
   275          "description": "Token for the next page of results.",
   276          "type": "string"
   277        }
   278      },
   279      "type": "object"
   280    },
   281    "Move": {
   282      "description": "Contains information about changes in an object's parents as a result of a move type event.",
   283      "id": "Move",
   284      "properties": {
   285        "addedParents": {
   286          "description": "The added parent(s).",
   287          "items": {
   288            "$ref": "Parent"
   289          },
   290          "type": "array"
   291        },
   292        "removedParents": {
   293          "description": "The removed parent(s).",
   294          "items": {
   295            "$ref": "Parent"
   296          },
   297          "type": "array"
   298        }
   299      },
   300      "type": "object"
   301    },
   302    "Parent": {
   303      "description": "Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.",
   304      "id": "Parent",
   305      "properties": {
   306        "id": {
   307          "description": "The parent's ID.",
   308          "type": "string"
   309        },
   310        "isRoot": {
   311          "description": "Whether this is the root folder.",
   312          "type": "boolean"
   313        },
   314        "title": {
   315          "description": "The parent's title.",
   316          "type": "string"
   317        }
   318      },
   319      "type": "object"
   320    },
   321    "Permission": {
   322      "description": "Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.",
   323      "id": "Permission",
   324      "properties": {
   325        "name": {
   326          "description": "The name of the user or group the permission applies to.",
   327          "type": "string"
   328        },
   329        "permissionId": {
   330          "description": "The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.",
   331          "type": "string"
   332        },
   333        "role": {
   334          "description": "Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.",
   335          "enum": [
   336            "commenter",
   337            "fileOrganizer",
   338            "owner",
   339            "publishedReader",
   340            "reader",
   341            "writer"
   342          ],
   343          "enumDescriptions": [
   344            "",
   345            "",
   346            "",
   347            "",
   348            "",
   349            ""
   350          ],
   351          "type": "string"
   352        },
   353        "type": {
   354          "description": "Indicates how widely permissions are granted.",
   355          "enum": [
   356            "anyone",
   357            "domain",
   358            "group",
   359            "user"
   360          ],
   361          "enumDescriptions": [
   362            "",
   363            "",
   364            "",
   365            ""
   366          ],
   367          "type": "string"
   368        },
   369        "user": {
   370          "$ref": "User",
   371          "description": "The user's information if the type is USER."
   372        },
   373        "withLink": {
   374          "description": "Whether the permission requires a link to the file.",
   375          "type": "boolean"
   376        }
   377      },
   378      "type": "object"
   379    },
   380    "PermissionChange": {
   381      "description": "Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.",
   382      "id": "PermissionChange",
   383      "properties": {
   384        "addedPermissions": {
   385          "description": "Lists all Permission objects added.",
   386          "items": {
   387            "$ref": "Permission"
   388          },
   389          "type": "array"
   390        },
   391        "removedPermissions": {
   392          "description": "Lists all Permission objects removed.",
   393          "items": {
   394            "$ref": "Permission"
   395          },
   396          "type": "array"
   397        }
   398      },
   399      "type": "object"
   400    },
   401    "Photo": {
   402      "description": "Photo information for a user.",
   403      "id": "Photo",
   404      "properties": {
   405        "url": {
   406          "description": "The URL of the photo.",
   407          "type": "string"
   408        }
   409      },
   410      "type": "object"
   411    },
   412    "Rename": {
   413      "description": "Contains information about a renametype event.",
   414      "id": "Rename",
   415      "properties": {
   416        "newTitle": {
   417          "description": "The new title.",
   418          "type": "string"
   419        },
   420        "oldTitle": {
   421          "description": "The old title.",
   422          "type": "string"
   423        }
   424      },
   425      "type": "object"
   426    },
   427    "Target": {
   428      "description": "Information about the object modified by the event.",
   429      "id": "Target",
   430      "properties": {
   431        "id": {
   432          "description": "The ID of the target. For example, in Google Drive, this is the file or folder ID.",
   433          "type": "string"
   434        },
   435        "mimeType": {
   436          "description": "The MIME type of the target.",
   437          "type": "string"
   438        },
   439        "name": {
   440          "description": "The name of the target. For example, in Google Drive, this is the title of the file.",
   441          "type": "string"
   442        }
   443      },
   444      "type": "object"
   445    },
   446    "User": {
   447      "description": "A representation of a user.",
   448      "id": "User",
   449      "properties": {
   450        "isDeleted": {
   451          "description": "A boolean which indicates whether the specified User was deleted. If true, name, photo and permission_id will be omitted.",
   452          "type": "boolean"
   453        },
   454        "isMe": {
   455          "description": "Whether the user is the authenticated user.",
   456          "type": "boolean"
   457        },
   458        "name": {
   459          "description": "The displayable name of the user.",
   460          "type": "string"
   461        },
   462        "permissionId": {
   463          "description": "The permission ID associated with this user. Equivalent to the Drive API's permission ID for this user, returned as part of the Drive Permissions resource.",
   464          "type": "string"
   465        },
   466        "photo": {
   467          "$ref": "Photo",
   468          "description": "The profile photo of the user. Not present if the user has no profile photo."
   469        }
   470      },
   471      "type": "object"
   472    }
   473  },
   474  "servicePath": "appsactivity/v1/",
   475  "title": "Drive Activity API",
   476  "version": "v1"
   477}

View as plain text