aboutsummaryrefslogtreecommitdiff
path: root/docs/dyn/content_v2.datafeedstatuses.html
blob: 61d173df9277cf14c02be472ad804f0a2ddcb534 (plain)
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
<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="content_v2.html">Content API for Shopping</a> . <a href="content_v2.datafeedstatuses.html">datafeedstatuses</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#custombatch">custombatch(body)</a></code></p>
<p class="firstline">A description of how to use this function</p>
<p class="toc_element">
  <code><a href="#get">get(merchantId, datafeedId)</a></code></p>
<p class="firstline">Retrieves the status of a datafeed from your Merchant Center account.</p>
<p class="toc_element">
  <code><a href="#list">list(merchantId)</a></code></p>
<p class="firstline">Lists the statuses of the datafeeds in your Merchant Center account.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="custombatch">custombatch(body)</code>
  <pre>A description of how to use this function

Args:
  body: object, The request body. (required)
    The object takes the form of:

{
    "entries": [
      { # A batch entry encoding a single non-batch request to the datafeedstatuses service of the Content API for Shopping.
        "batchId": 42, # An entry ID, unique within the batch request.
        "datafeedId": "A String", # The ID of the data feed to get or delete.
        "merchantId": "A String", # The ID of the managing account.
        "method": "A String", # The method (get).
      },
    ],
  }


Returns:
  An object of the form:

    {
    "kind": "content#datafeedstatusesCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesCustomBatchResponse".
    "entries": [
      { # A batch entry encoding a single non-batch response from the datafeedstatuses service of the Content API for Shopping.
        "batchId": 42, # The ID of the request entry this entry responds to.
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "datafeedStatus": { # The requested data feed status. Defined if and only if the request was successful.
          "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
          "errors": [ # The list of errors occurring in the feed.
            { # An error occurring in the feed, like "invalid price".
              "count": 42, # The number of occurrences of the error in the feed.
              "message": "A String", # The error message, e.g., "Invalid price".
              "code": "A String", # The code of the error, e.g., "validation/invalid_value".
              "examples": [ # A list of example occurrences of the error, grouped by product.
                { # An example occurrence for a particular error.
                  "itemId": "A String", # The ID of the example item.
                  "value": "A String", # The problematic value.
                  "lineNumber": 42, # Line number in the data feed where the example is found.
                },
              ],
            },
          ],
          "processingStatus": "A String", # The processing status of the feed.
          "itemsTotal": 42, # The number of items in the feed that were processed.
          "warnings": [ # The list of errors occurring in the feed.
            { # An error occurring in the feed, like "invalid price".
              "count": 42, # The number of occurrences of the error in the feed.
              "message": "A String", # The error message, e.g., "Invalid price".
              "code": "A String", # The code of the error, e.g., "validation/invalid_value".
              "examples": [ # A list of example occurrences of the error, grouped by product.
                { # An example occurrence for a particular error.
                  "itemId": "A String", # The ID of the example item.
                  "value": "A String", # The problematic value.
                  "lineNumber": 42, # Line number in the data feed where the example is found.
                },
              ],
            },
          ],
          "itemsValid": 42, # The number of items in the feed that were valid.
          "datafeedId": "A String", # The ID of the feed for which the status is reported.
        },
      },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="get">get(merchantId, datafeedId)</code>
  <pre>Retrieves the status of a datafeed from your Merchant Center account.

Args:
  merchantId: string, A parameter (required)
  datafeedId: string, A parameter (required)

Returns:
  An object of the form:

    {
    "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
    "errors": [ # The list of errors occurring in the feed.
      { # An error occurring in the feed, like "invalid price".
        "count": 42, # The number of occurrences of the error in the feed.
        "message": "A String", # The error message, e.g., "Invalid price".
        "code": "A String", # The code of the error, e.g., "validation/invalid_value".
        "examples": [ # A list of example occurrences of the error, grouped by product.
          { # An example occurrence for a particular error.
            "itemId": "A String", # The ID of the example item.
            "value": "A String", # The problematic value.
            "lineNumber": 42, # Line number in the data feed where the example is found.
          },
        ],
      },
    ],
    "processingStatus": "A String", # The processing status of the feed.
    "itemsTotal": 42, # The number of items in the feed that were processed.
    "warnings": [ # The list of errors occurring in the feed.
      { # An error occurring in the feed, like "invalid price".
        "count": 42, # The number of occurrences of the error in the feed.
        "message": "A String", # The error message, e.g., "Invalid price".
        "code": "A String", # The code of the error, e.g., "validation/invalid_value".
        "examples": [ # A list of example occurrences of the error, grouped by product.
          { # An example occurrence for a particular error.
            "itemId": "A String", # The ID of the example item.
            "value": "A String", # The problematic value.
            "lineNumber": 42, # Line number in the data feed where the example is found.
          },
        ],
      },
    ],
    "itemsValid": 42, # The number of items in the feed that were valid.
    "datafeedId": "A String", # The ID of the feed for which the status is reported.
  }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(merchantId)</code>
  <pre>Lists the statuses of the datafeeds in your Merchant Center account.

Args:
  merchantId: string, A parameter (required)

Returns:
  An object of the form:

    {
    "kind": "content#datafeedstatusesListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedstatusesListResponse".
    "resources": [
      {
        "kind": "content#datafeedStatus", # Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus".
        "errors": [ # The list of errors occurring in the feed.
          { # An error occurring in the feed, like "invalid price".
            "count": 42, # The number of occurrences of the error in the feed.
            "message": "A String", # The error message, e.g., "Invalid price".
            "code": "A String", # The code of the error, e.g., "validation/invalid_value".
            "examples": [ # A list of example occurrences of the error, grouped by product.
              { # An example occurrence for a particular error.
                "itemId": "A String", # The ID of the example item.
                "value": "A String", # The problematic value.
                "lineNumber": 42, # Line number in the data feed where the example is found.
              },
            ],
          },
        ],
        "processingStatus": "A String", # The processing status of the feed.
        "itemsTotal": 42, # The number of items in the feed that were processed.
        "warnings": [ # The list of errors occurring in the feed.
          { # An error occurring in the feed, like "invalid price".
            "count": 42, # The number of occurrences of the error in the feed.
            "message": "A String", # The error message, e.g., "Invalid price".
            "code": "A String", # The code of the error, e.g., "validation/invalid_value".
            "examples": [ # A list of example occurrences of the error, grouped by product.
              { # An example occurrence for a particular error.
                "itemId": "A String", # The ID of the example item.
                "value": "A String", # The problematic value.
                "lineNumber": 42, # Line number in the data feed where the example is found.
              },
            ],
          },
        ],
        "itemsValid": 42, # The number of items in the feed that were valid.
        "datafeedId": "A String", # The ID of the feed for which the status is reported.
      },
    ],
  }</pre>
</div>

</body></html>