Chrome Web Store API . publishers . items

Instance Methods

cancelSubmission(name, body=None, x__xgafv=None)

Cancel the current active submission of an item if present. This can be used to cancel the review of a pending submission.

close()

Close httplib2 connections.

fetchStatus(name, x__xgafv=None)

Fetch the status of an item.

publish(name, body=None, x__xgafv=None)

Submit the item to be published in the store. The item will be submitted for review unless `skip_review` is set to true, or the item is staged from a previous submission with `publish_type` set to `STAGED_PUBLISH`.

setPublishedDeployPercentage(name, body=None, x__xgafv=None)

Set a higher target deploy percentage for the item's published revision. This will be updated without the item being submitted for review. This is only available to items with over 10,000 seven-day active users.

Method Details

cancelSubmission(name, body=None, x__xgafv=None)
Cancel the current active submission of an item if present. This can be used to cancel the review of a pending submission.

Args:
  name: string, Required. Name of the item to cancel the submission of in the form `publishers/{publisherId}/items/{itemId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for CancelSubmission.
}

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

Returns:
  An object of the form:

    { # Response message for `CancelSubmission`.
}
close()
Close httplib2 connections.
fetchStatus(name, x__xgafv=None)
Fetch the status of an item.

Args:
  name: string, Required. Name of the item to retrieve the status of in the form `publishers/{publisherId}/items/{itemId}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for `FetchItemStatus`.
  "itemId": "A String", # Output only. The ID of the item.
  "lastAsyncUploadState": "A String", # Output only. The state of the last async upload for an item. Only set when there has been an async upload for the item in the past 24 hours.
  "name": "A String", # The name of the requested item.
  "publicKey": "A String", # The public key of the item, which may be generated by the store.
  "publishedItemRevisionStatus": { # Details on the status of an item revision. # Output only. Status of the current published revision of the item. Will be unset if the item is not published.
    "distributionChannels": [ # Details on the package of the item
      { # Deployment information for a specific release channel
        "crxVersion": "A String", # The extension version provided in the manifest of the uploaded package.
        "deployPercentage": 42, # The current deploy percentage for the release channel (nonnegative number between 0 and 100).
      },
    ],
    "state": "A String", # Output only. Current state of the item
  },
  "submittedItemRevisionStatus": { # Details on the status of an item revision. # Status of the item revision submitted to be published. Will be unset if the item has not been submitted for publishing since the last successful publish.
    "distributionChannels": [ # Details on the package of the item
      { # Deployment information for a specific release channel
        "crxVersion": "A String", # The extension version provided in the manifest of the uploaded package.
        "deployPercentage": 42, # The current deploy percentage for the release channel (nonnegative number between 0 and 100).
      },
    ],
    "state": "A String", # Output only. Current state of the item
  },
  "takenDown": True or False, # If true, the item has been taken down for a policy violation. Check the developer dashboard for details.
  "warned": True or False, # If true, the item has been warned for a policy violation and will be taken down if not resolved. Check the developer dashboard for details.
}
publish(name, body=None, x__xgafv=None)
Submit the item to be published in the store. The item will be submitted for review unless `skip_review` is set to true, or the item is staged from a previous submission with `publish_type` set to `STAGED_PUBLISH`.

Args:
  name: string, Required. Name of the item in the form `publishers/{publisherId}/items/{itemId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for PublishItem.
  "deployInfos": [ # Optional. Additional deploy information including the desired initial percentage rollout. Defaults to the current value saved in the developer dashboard if unset.
    { # Deployment information for a specific release channel. Used in requests to update deployment parameters.
      "deployPercentage": 42, # Required. The current deploy percentage for the release channel (nonnegative number between 0 and 100).
    },
  ],
  "publishType": "A String", # Optional. Use this to control if the item is published immediately on approval or staged for publishing in the future. Defaults to `DEFAULT_PUBLISH` if unset.
  "skipReview": True or False, # Optional. Whether to attempt to skip item review. The API will validate if the item qualifies and return a validation error if the item requires review. Defaults to `false` if unset.
}

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

Returns:
  An object of the form:

    { # Response message for `PublishItem`.
  "itemId": "A String", # Output only. The ID of the item.
  "name": "A String", # The name of the item that was submitted
  "state": "A String", # Output only. The current state of the submission.
}
setPublishedDeployPercentage(name, body=None, x__xgafv=None)
Set a higher target deploy percentage for the item's published revision. This will be updated without the item being submitted for review. This is only available to items with over 10,000 seven-day active users.

Args:
  name: string, Required. Name of the item to update the published revision of in the form `publishers/{publisherId}/items/{itemId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SetPublishedDeployPercentage.
  "deployPercentage": 42, # Required. Unscaled percentage value for the publised revision (nonnegative number between 0 and 100). It must be larger than the existing target percentage.
}

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

Returns:
  An object of the form:

    { # Response message for `SetPublishedDeployPercentage`.
}