Merchant API . accounts . aggregateProductStatuses

close()

Close httplib2 connections.

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results.

Args:
  parent: string, Required. The account to list aggregate product statuses for. Format: `accounts/{account}` (required)
  filter: string, Optional. A filter expression that filters the aggregate product statuses. Filtering is only supported by the `reporting_context` and `country` field. For example: `reporting_context = "SHOPPING_ADS" AND country = "US"`.
  pageSize: integer, Optional. The maximum number of aggregate product statuses to return. The service may return fewer than this value. If unspecified, at most 25 aggregate product statuses are returned. The maximum value is 250; values above 250 are coerced to 250.
  pageToken: string, Optional. A page token, received from a previous `ListAggregateProductStatuses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAggregateProductStatuses` 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 the `ListAggregateProductStatuses` method.
  "aggregateProductStatuses": [ # The `AggregateProductStatuses` resources for the given account.
    { # Aggregate product statuses for a given reporting context and country.
      "country": "A String", # The country of the aggregate product statuses. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
      "itemLevelIssues": [ # The product issues that affect the given reporting context and country.
        { # The ItemLevelIssue of the product status.
          "attribute": "A String", # The attribute's name, if the issue is caused by a single attribute.
          "code": "A String", # The error code of the issue.
          "description": "A String", # A short issue description in English.
          "detail": "A String", # A detailed issue description in English.
          "documentationUri": "A String", # The URL of a web page to help with resolving this issue.
          "productCount": "A String", # The number of products affected by this issue.
          "resolution": "A String", # Whether the issue can be resolved by the merchant.
          "severity": "A String", # How this issue affects serving of the offer.
        },
      ],
      "name": "A String", # Identifier. The name of the `AggregateProductStatuses` resource. Format: `accounts/{account}/aggregateProductStatuses/{aggregateProductStatuses}`
      "reportingContext": "A String", # The reporting context of the aggregate product statuses.
      "stats": { # Products statistics. # Products statistics for the given reporting context and country.
        "activeCount": "A String", # The number of products that are active.
        "disapprovedCount": "A String", # The number of products that are disapproved.
        "expiringCount": "A String", # The number of products that are expiring.
        "pendingCount": "A String", # The number of products that are pending.
      },
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

list_next()

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.