Apps Script API . projects . deployments

create(scriptId=*, body=None, x__xgafv=None)

Creates a deployment of an Apps Script project.

Args:
  scriptId: string, The script project's Drive ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Metadata the defines how a deployment is configured.
    "manifestFileName": "A String", # The manifest file name for this deployment.
    "versionNumber": 42, # The version number on which this deployment is based.
    "scriptId": "A String", # The script project's Drive ID.
    "description": "A String", # The description for this deployment.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Representation of a single script deployment.
    "entryPoints": [ # The deployment's entry points.
      { # A configuration that defines how a deployment is accessed externally.
        "entryPointType": "A String", # The type of the entry point.
        "webApp": { # A web application entry point. # An entry point specification for web apps.
          "url": "A String", # The URL for the web application.
          "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
            "executeAs": "A String", # Who to execute the web app as.
            "access": "A String", # Who has permission to run the web app.
          },
        },
        "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
          "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
            "access": "A String", # Who has permission to run the API executable.
          },
        },
        "addOn": { # An add-on entry point. # Add-on properties.
          "reportIssueUrl": "A String", # The add-on's optional report issue URL.
          "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
          "description": "A String", # The add-on's optional description.
          "title": "A String", # The add-on's required title.
          "addOnType": "A String", # The add-on's required list of supported container types.
          "helpUrl": "A String", # The add-on's optional help URL.
        },
      },
    ],
    "deploymentId": "A String", # The deployment ID for this deployment.
    "updateTime": "A String", # Last modified date time stamp.
    "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
        "manifestFileName": "A String", # The manifest file name for this deployment.
        "versionNumber": 42, # The version number on which this deployment is based.
        "scriptId": "A String", # The script project's Drive ID.
        "description": "A String", # The description for this deployment.
      },
  }

delete(scriptId=*, deploymentId=*, x__xgafv=None)

Deletes a deployment of an Apps Script project.

Args:
  scriptId: string, The script project's Drive ID. (required)
  deploymentId: string, The deployment ID to be undeployed. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }

get(scriptId=*, deploymentId=*, x__xgafv=None)

Gets a deployment of an Apps Script project.

Args:
  scriptId: string, The script project's Drive ID. (required)
  deploymentId: string, The deployment ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Representation of a single script deployment.
    "entryPoints": [ # The deployment's entry points.
      { # A configuration that defines how a deployment is accessed externally.
        "entryPointType": "A String", # The type of the entry point.
        "webApp": { # A web application entry point. # An entry point specification for web apps.
          "url": "A String", # The URL for the web application.
          "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
            "executeAs": "A String", # Who to execute the web app as.
            "access": "A String", # Who has permission to run the web app.
          },
        },
        "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
          "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
            "access": "A String", # Who has permission to run the API executable.
          },
        },
        "addOn": { # An add-on entry point. # Add-on properties.
          "reportIssueUrl": "A String", # The add-on's optional report issue URL.
          "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
          "description": "A String", # The add-on's optional description.
          "title": "A String", # The add-on's required title.
          "addOnType": "A String", # The add-on's required list of supported container types.
          "helpUrl": "A String", # The add-on's optional help URL.
        },
      },
    ],
    "deploymentId": "A String", # The deployment ID for this deployment.
    "updateTime": "A String", # Last modified date time stamp.
    "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
        "manifestFileName": "A String", # The manifest file name for this deployment.
        "versionNumber": 42, # The version number on which this deployment is based.
        "scriptId": "A String", # The script project's Drive ID.
        "description": "A String", # The description for this deployment.
      },
  }

list(scriptId=*, pageSize=None, pageToken=None, x__xgafv=None)

Lists the deployments of an Apps Script project.

Args:
  scriptId: string, The script project's Drive ID. (required)
  pageSize: integer, The maximum number of deployments on each returned page. Defaults to 50.
  pageToken: string, The token for continuing a previous list request on the next page. This
should be set to the value of `nextPageToken` from a previous response.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response with the list of deployments for the specified Apps Script project.
    "nextPageToken": "A String", # The token that can be used in the next call to get the next page of
        # results.
    "deployments": [ # The list of deployments.
      { # Representation of a single script deployment.
        "entryPoints": [ # The deployment's entry points.
          { # A configuration that defines how a deployment is accessed externally.
            "entryPointType": "A String", # The type of the entry point.
            "webApp": { # A web application entry point. # An entry point specification for web apps.
              "url": "A String", # The URL for the web application.
              "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
                "executeAs": "A String", # Who to execute the web app as.
                "access": "A String", # Who has permission to run the web app.
              },
            },
            "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
              "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
                "access": "A String", # Who has permission to run the API executable.
              },
            },
            "addOn": { # An add-on entry point. # Add-on properties.
              "reportIssueUrl": "A String", # The add-on's optional report issue URL.
              "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
              "description": "A String", # The add-on's optional description.
              "title": "A String", # The add-on's required title.
              "addOnType": "A String", # The add-on's required list of supported container types.
              "helpUrl": "A String", # The add-on's optional help URL.
            },
          },
        ],
        "deploymentId": "A String", # The deployment ID for this deployment.
        "updateTime": "A String", # Last modified date time stamp.
        "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
            "manifestFileName": "A String", # The manifest file name for this deployment.
            "versionNumber": 42, # The version number on which this deployment is based.
            "scriptId": "A String", # The script project's Drive ID.
            "description": "A String", # The description for this deployment.
          },
      },
    ],
  }

list_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    

update(scriptId=*, deploymentId=*, body=None, x__xgafv=None)

Updates a deployment of an Apps Script project.

Args:
  scriptId: string, The script project's Drive ID. (required)
  deploymentId: string, The deployment ID for this deployment. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request with deployment information to update an existing deployment.
    "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
        "manifestFileName": "A String", # The manifest file name for this deployment.
        "versionNumber": 42, # The version number on which this deployment is based.
        "scriptId": "A String", # The script project's Drive ID.
        "description": "A String", # The description for this deployment.
      },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Representation of a single script deployment.
    "entryPoints": [ # The deployment's entry points.
      { # A configuration that defines how a deployment is accessed externally.
        "entryPointType": "A String", # The type of the entry point.
        "webApp": { # A web application entry point. # An entry point specification for web apps.
          "url": "A String", # The URL for the web application.
          "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
            "executeAs": "A String", # Who to execute the web app as.
            "access": "A String", # Who has permission to run the web app.
          },
        },
        "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
          "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
            "access": "A String", # Who has permission to run the API executable.
          },
        },
        "addOn": { # An add-on entry point. # Add-on properties.
          "reportIssueUrl": "A String", # The add-on's optional report issue URL.
          "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
          "description": "A String", # The add-on's optional description.
          "title": "A String", # The add-on's required title.
          "addOnType": "A String", # The add-on's required list of supported container types.
          "helpUrl": "A String", # The add-on's optional help URL.
        },
      },
    ],
    "deploymentId": "A String", # The deployment ID for this deployment.
    "updateTime": "A String", # Last modified date time stamp.
    "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
        "manifestFileName": "A String", # The manifest file name for this deployment.
        "versionNumber": 42, # The version number on which this deployment is based.
        "scriptId": "A String", # The script project's Drive ID.
        "description": "A String", # The description for this deployment.
      },
  }