File: merchantapi_issueresolution_v1.accounts.aggregateProductStatuses.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (153 lines) | stat: -rw-r--r-- 6,551 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="merchantapi_issueresolution_v1.html">Merchant API</a> . <a href="merchantapi_issueresolution_v1.accounts.html">accounts</a> . <a href="merchantapi_issueresolution_v1.accounts.aggregateProductStatuses.html">aggregateProductStatuses</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>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 = &quot;SHOPPING_ADS&quot; AND country = &quot;US&quot;`.
  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.
  &quot;aggregateProductStatuses&quot;: [ # The `AggregateProductStatuses` resources for the given account.
    { # Aggregate product statuses for a given reporting context and country.
      &quot;country&quot;: &quot;A String&quot;, # 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).
      &quot;itemLevelIssues&quot;: [ # The product issues that affect the given reporting context and country.
        { # The ItemLevelIssue of the product status.
          &quot;attribute&quot;: &quot;A String&quot;, # The attribute&#x27;s name, if the issue is caused by a single attribute.
          &quot;code&quot;: &quot;A String&quot;, # The error code of the issue.
          &quot;description&quot;: &quot;A String&quot;, # A short issue description in English.
          &quot;detail&quot;: &quot;A String&quot;, # A detailed issue description in English.
          &quot;documentationUri&quot;: &quot;A String&quot;, # The URL of a web page to help with resolving this issue.
          &quot;productCount&quot;: &quot;A String&quot;, # The number of products affected by this issue.
          &quot;resolution&quot;: &quot;A String&quot;, # Whether the issue can be resolved by the merchant.
          &quot;severity&quot;: &quot;A String&quot;, # How this issue affects serving of the offer.
        },
      ],
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the `AggregateProductStatuses` resource. Format: `accounts/{account}/aggregateProductStatuses/{aggregateProductStatuses}`
      &quot;reportingContext&quot;: &quot;A String&quot;, # The reporting context of the aggregate product statuses.
      &quot;stats&quot;: { # Products statistics. # Products statistics for the given reporting context and country.
        &quot;activeCount&quot;: &quot;A String&quot;, # The number of products that are active.
        &quot;disapprovedCount&quot;: &quot;A String&quot;, # The number of products that are disapproved.
        &quot;expiringCount&quot;: &quot;A String&quot;, # The number of products that are expiring.
        &quot;pendingCount&quot;: &quot;A String&quot;, # The number of products that are pending.
      },
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>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 &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>