Chrome Web Store API . publishers . items

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.

fetchReviews(name, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Fetch user reviews for an item.

Args:
  name: string, Required. The item resource name whose reviews are being fetched. Format: publishers/{publisher_id}/items/{item_id} (required)
  filter: string, Optional. A filter to apply to the reviews. Only equality comparison on rating is supported, e.g. `rating = 5`.
  orderBy: string, Optional. An optional comma-separated list of fields by which to sort the results. The default sort order is ascending (`asc`). Supported fields are: - `rating`: Supported orders are `asc` (default) and `desc`. - `create_time`: Only `desc` (most recent first) is supported; `desc` must be explicitly specified since the default is `asc`. Example: `rating desc`, `create_time desc`, or `rating desc, create_time desc`.
  pageSize: integer, Optional. The maximum number of reviews to return. The service may return fewer than this value. If unspecified, at most 50 reviews will be returned. The maximum value is 200; values above 200 will be coerced to 200.
  pageToken: string, Optional. A page token, received from a previous `FetchItemReviews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchItemReviews` must match the call that provided the page token.
  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 FetchItemReviews.
  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "reviews": [ # The list of reviews.
    { # A review written by a user to rate an item in the Chrome Web Store.
      "authorInfo": { # Info on the author of the review. # Info on the author of the review.
        "displayName": "A String", # Display name for the author.
      },
      "comment": "A String", # Content of the review.
      "createTime": "A String", # Output only. When the review was posted.
      "item": "A String", # Output only. The item that this review evaluates. Format: publishers/{publisher}/items/{item}
      "name": "A String", # Identifier. Review resource name. Format: reviews/{reviewId}
      "rating": 42, # Rating of the item, between 1 and 5.
    },
  ],
}

fetchReviews_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.

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.
}

getRatingSummary(name, x__xgafv=None)

Gets the RatingSummary for the publishers item.

Args:
  name: string, Required. The name of the rating summary to retrieve. Format: publishers/{publisher}/items/{item}/ratingSummary (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Singleton resource for the rating summary of an item.
  "fiveStarRatingCount": "A String", # The number of five star ratings.
  "fourStarRatingCount": "A String", # The number of four star ratings.
  "name": "A String", # Identifier. Item rating summary resource name Format: publishers/{publisher}/items/{item}/ratingSummary
  "nonEmptyReviewCount": "A String", # The number of ratings with a non-empty review text.
  "oneStarRatingCount": "A String", # The number of one star ratings.
  "rating": 3.14, # The rating of the item as shown on the store page, expressed as a double between 1 and 5.
  "ratingCount": "A String", # The total number of ratings for the item.
  "threeStarRatingCount": "A String", # The number of three star ratings.
  "twoStarRatingCount": "A String", # The number of two star ratings.
}

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.
  "blockOnWarnings": True or False, # Optional. When set to true the request will fail if there are any warnings during validation and the details will be included in the `error.details`. Otherwise warnings are treated as non-blocking and will be ignored for validation but will be included in the response for inspection. Defaults to `false` if unset.
  "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.
  "warningInfo": { # Message containing details on warnings encountered during PublishItem. # Output only. Non-blocking warnings encountered during the request.
    "warnings": [ # All warnings encountered during the request.
      { # Represents a single warning encountered during the request.
        "description": "A String", # A description of the warning. Developers should use this message to understand the warning and take appropriate action to resolve the issue.
        "reason": "A String", # The reason for the warning. This is a constant value that identifies the proximate cause of the warning.
      },
    ],
  },
}

queryMetrics(name, dimensions=None, metrics=None, pageSize=None, pageToken=None, timeSpec_firstDate_day=None, timeSpec_firstDate_month=None, timeSpec_firstDate_year=None, timeSpec_lastDate_day=None, timeSpec_lastDate_month=None, timeSpec_lastDate_year=None, x__xgafv=None)

Query the metrics for an item.

Args:
  name: string, Required. The name of the item to query the metrics for. Format: publishers/{publisher}/items/{item} (required)
  dimensions: string, Optional. Dimensions to slice the metrics by. At most one dimension can be specified. **Supported dimensions:** - os: The operating system of the user. - app-version: The version of the item. - country: The country of the user. - install-source: The source of the install. - install-type: The type of install (from webstore, inline, or other). - language: The language of the user. - enabled: If the item is enabled or disabled. - utm-campaign: The UTM campaign of the user. - utm-content: The UTM content of the user. - utm-medium: The UTM medium of the user. - utm-source: The UTM source of the user. - utm-term: The UTM term of the user. (repeated)
  metrics: string, Required. The metrics to query the metric set for. **Supported metrics:** - installs: Count of item installs. - installs-7d: Count of item installs in the last 7 days. - uninstalls: Count of item uninstalls. - users: Count of daily active users of the item. - users-7d: Count of 7-day active users of the item. - impressions: Count of item impressions across the entire store front. - page-views: Count of individual views of the item's detail page. (repeated)
  pageSize: integer, Optional. The maximum number of rows to return. If unspecified, at most 100 rows will be returned. The maximum value is 1000; Values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to the request must match the call that provided the page token.
  timeSpec_firstDate_day: integer, Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
  timeSpec_firstDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  timeSpec_firstDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  timeSpec_lastDate_day: integer, Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
  timeSpec_lastDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  timeSpec_lastDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  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 QueryItemMetrics.
  "metricRows": [ # The metric rows.
    { # A single row of metrics and dimension values.
      "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date of the record.
        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      },
      "dimensionValues": [ # Dimension value columns for the row.
        "A String",
      ],
      "metricValues": [ # Metric columns for the row.
        { # Represents the value of a single metric
          "metric": "A String", # The name of the metric
          "uniqueUserCount": "A String", # The unique user count associated with the metric (if applicable).
          "value": "A String", # The value of the metric.
        },
      ],
    },
  ],
  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

queryMetrics_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.

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

Rolls back an item's published CRX package to a specified previously published CRX package and publishes it to all users.

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

{ # Request message for RollbackItem.
  "newVersion": "A String", # Required. The new version to assign to the package being rolled back to. This effectively "rolls forward" the previous package by giving it a higher version number than the currently-published package. E.g. if the current published version is 1.1, the new version could be 1.1.1 or 1.2 but not 1.0.
  "rollbackReason": "A String", # Required. The reason for the rollback that will be used for internal auditing and developer dashboard visibility.
  "targetCrxVersion": "A String", # Required. The target previously published CRX version to roll back to. If unset, defaults to the last published CRX version.
  "validateOnly": True or False, # Optional. If set, validate and dry run the request but do not actually initiate the rollback
}

  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 `RollbackItem`.
}

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`.
}