Skip to content

Commit

Permalink
feat(content): update the api
Browse files Browse the repository at this point in the history
#### content:v2.1

The following keys were added:
- resources.accounts.methods.requestphoneverification (Total Keys: 16)
- resources.freelistingsprogram.methods.get (Total Keys: 11)
- resources.freelistingsprogram.methods.requestreview (Total Keys: 11)
- resources.shoppingadsprogram.methods.get (Total Keys: 11)
- resources.shoppingadsprogram.methods.requestreview (Total Keys: 11)
- schemas.FreeListingsProgramStatus (Total Keys: 16)
- schemas.RequestPhoneVerificationRequest (Total Keys: 5)
- schemas.RequestPhoneVerificationResponse (Total Keys: 3)
- schemas.RequestReviewFreeListingsRequest (Total Keys: 3)
- schemas.RequestReviewShoppingAdsRequest (Total Keys: 3)
- schemas.ShoppingAdsProgramStatus (Total Keys: 15)
  • Loading branch information
yoshi-automation committed Jul 27, 2021
1 parent ec1425b commit b123349
Show file tree
Hide file tree
Showing 7 changed files with 884 additions and 24 deletions.
65 changes: 65 additions & 0 deletions docs/dyn/content_v2_1.accounts.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,12 +125,18 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#listlinks_next">listlinks_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#requestphoneverification">requestphoneverification(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Request verification code to start phone verification.</p>
<p class="toc_element">
<code><a href="#update">update(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.</p>
<p class="toc_element">
<code><a href="#updatelabels">updatelabels(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates labels that are assigned to the Merchant Center account by CSS user.</p>
<p class="toc_element">
<code><a href="#verifyphonenumber">verifyphonenumber(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Validates verification code to verify phone number for the account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="authinfo">authinfo(x__xgafv=None)</code>
Expand Down Expand Up @@ -771,6 +777,36 @@ <h3>Method Details</h3>
</pre>
</div>

<div class="method">
<code class="details" id="requestphoneverification">requestphoneverification(merchantId, accountId, body=None, x__xgafv=None)</code>
<pre>Request verification code to start phone verification.

Args:
merchantId: string, Required. The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required)
accountId: string, Required. The ID of the account. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for the RequestPhoneVerification method.
&quot;languageCode&quot;: &quot;A String&quot;, # Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) (for example, en-US). Language code is used to provide localized `SMS` and `PHONE_CALL`. Default language used is en-US if not provided.
&quot;phoneNumber&quot;: &quot;A String&quot;, # Phone number to be verified.
&quot;phoneRegionCode&quot;: &quot;A String&quot;, # Required. Two letter country code for the phone number, for example `CA` for Canadian numbers. See the [ISO 3166-1 alpha-2](https://wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) officially assigned codes.
&quot;phoneVerificationMethod&quot;: &quot;A String&quot;, # Verification method to receive verification code.
}

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 RequestPhoneVerification method.
&quot;verificationId&quot;: &quot;A String&quot;, # The verification ID to use in subsequent calls to `verifyphonenumber`.
}</pre>
</div>

<div class="method">
<code class="details" id="update">update(merchantId, accountId, body=None, x__xgafv=None)</code>
<pre>Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.
Expand Down Expand Up @@ -935,4 +971,33 @@ <h3>Method Details</h3>
}</pre>
</div>

<div class="method">
<code class="details" id="verifyphonenumber">verifyphonenumber(merchantId, accountId, body=None, x__xgafv=None)</code>
<pre>Validates verification code to verify phone number for the account.

Args:
merchantId: string, Required. The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required)
accountId: string, Required. The ID of the account. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for the VerifyPhoneNumber method.
&quot;phoneVerificationMethod&quot;: &quot;A String&quot;, # Verification method used to receive verification code.
&quot;verificationCode&quot;: &quot;A String&quot;, # The verification code that was sent to the phone number for validation.
&quot;verificationId&quot;: &quot;A String&quot;, # The verification ID returned by `requestphoneverification`.
}

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 VerifyPhoneNumber method.
&quot;verifiedPhoneNumber&quot;: &quot;A String&quot;, # Verified phone number if verification is successful.
}</pre>
</div>

</body></html>
146 changes: 146 additions & 0 deletions docs/dyn/content_v2_1.freelistingsprogram.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
<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_1.html">Content API for Shopping</a> . <a href="content_v2_1.freelistingsprogram.html">freelistingsprogram</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="#get">get(merchantId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the status and review eligibility for the free listing program.</p>
<p class="toc_element">
<code><a href="#requestreview">requestreview(merchantId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Requests a review for Free Listings program in the provided region. Important: This method is only whitelisted for selected merchants.</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="get">get(merchantId, x__xgafv=None)</code>
<pre>Retrieves the status and review eligibility for the free listing program.

Args:
merchantId: string, Required. The ID of the account. (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 GetFreeListingsProgramStatus.
&quot;regionStatuses&quot;: [ # Status of the program in each region. Regions with the same status and review eligibility are grouped together in `regionCodes`.
{ # Status of program and region.
&quot;disapprovalDate&quot;: &quot;A String&quot;, # Date by which `eligibility_status` will go from `WARNING` to `DISAPPROVED`. It will be present when `eligibility_status` is `WARNING`. Date will be provided in ISO 8601 format i.e. YYYY-MM-DD
&quot;eligibilityStatus&quot;: &quot;A String&quot;, # Eligibility status of the standard free listing program.
&quot;enhancedEligibilityStatus&quot;: &quot;A String&quot;, # Eligibility status of the enhanced free listing program.
&quot;ineligibilityReason&quot;: &quot;A String&quot;, # Reason if a program in a given country is not eligible for review. Populated only if `review_eligibility_status` is `INELIGIBLE`.
&quot;regionCodes&quot;: [ # The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) codes for all the regions with the same `eligibilityStatus` and `reviewEligibility`.
&quot;A String&quot;,
],
&quot;reviewEligibilityStatus&quot;: &quot;A String&quot;, # If a program in a given country is eligible for review. It will be present only if eligibility status is `DISAPPROVED`.
&quot;reviewIssues&quot;: [ # These issues will be evaluated in review process. Fix all the issues before requesting the review.
&quot;A String&quot;,
],
},
],
&quot;state&quot;: &quot;A String&quot;, # If program is successfully onboarded for at least one region.
}</pre>
</div>

<div class="method">
<code class="details" id="requestreview">requestreview(merchantId, body=None, x__xgafv=None)</code>
<pre>Requests a review for Free Listings program in the provided region. Important: This method is only whitelisted for selected merchants.

Args:
merchantId: string, Required. The ID of the account. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for the RequestReviewFreeListings Program method.
&quot;regionCode&quot;: &quot;A String&quot;, # The code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country for which review is to be requested.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>

</body></html>
10 changes: 10 additions & 0 deletions docs/dyn/content_v2_1.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,11 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the datafeedstatuses Resource.</p>

<p class="toc_element">
<code><a href="content_v2_1.freelistingsprogram.html">freelistingsprogram()</a></code>
</p>
<p class="firstline">Returns the freelistingsprogram Resource.</p>

<p class="toc_element">
<code><a href="content_v2_1.liasettings.html">liasettings()</a></code>
</p>
Expand Down Expand Up @@ -224,6 +229,11 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the shippingsettings Resource.</p>

<p class="toc_element">
<code><a href="content_v2_1.shoppingadsprogram.html">shoppingadsprogram()</a></code>
</p>
<p class="firstline">Returns the shoppingadsprogram Resource.</p>

<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
Expand Down
22 changes: 11 additions & 11 deletions docs/dyn/content_v2_1.reports.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3>Method Details</h3>
{ # Request message for the ReportService.Search method.
&quot;pageSize&quot;: 42, # Number of ReportRows to retrieve in a single page. Defaults to the maximum of 1000. Values above 1000 are coerced to 1000.
&quot;pageToken&quot;: &quot;A String&quot;, # Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from `next_page_token` in the previous response should be used.
&quot;query&quot;: &quot;A String&quot;, # Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented.
&quot;query&quot;: &quot;A String&quot;, # Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented. For details on how to construct your query, see the [Query Language guide](https://developers.google.com/shopping-content/guides/reports/query-language/overview).
}

x__xgafv: string, V1 error format.
Expand Down Expand Up @@ -140,11 +140,11 @@ <h3>Method Details</h3>
},
&quot;segments&quot;: { # Dimensions according to which metrics are segmented in the response. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., impression or order. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for dimensions requested explicitly in the request&#x27;s search query. # Segmentation dimensions requested by the merchant in the query. Dimension values are only set for dimensions requested explicitly in the query.
&quot;brand&quot;: &quot;A String&quot;, # Brand of the product.
&quot;categoryL1&quot;: &quot;A String&quot;, # Product category (1st level) in Google&#x27;s product taxonomy.
&quot;categoryL2&quot;: &quot;A String&quot;, # Product category (2nd level) in Google&#x27;s product taxonomy.
&quot;categoryL3&quot;: &quot;A String&quot;, # Product category (3rd level) in Google&#x27;s product taxonomy.
&quot;categoryL4&quot;: &quot;A String&quot;, # Product category (4th level) in Google&#x27;s product taxonomy.
&quot;categoryL5&quot;: &quot;A String&quot;, # Product category (5th level) in Google&#x27;s product taxonomy.
&quot;categoryL1&quot;: &quot;A String&quot;, # [Product category (1st level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google&#x27;s product taxonomy.
&quot;categoryL2&quot;: &quot;A String&quot;, # [Product category (2nd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google&#x27;s product taxonomy.
&quot;categoryL3&quot;: &quot;A String&quot;, # [Product category (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google&#x27;s product taxonomy.
&quot;categoryL4&quot;: &quot;A String&quot;, # [Product category (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google&#x27;s product taxonomy.
&quot;categoryL5&quot;: &quot;A String&quot;, # [Product category (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google&#x27;s product taxonomy.
&quot;currencyCode&quot;: &quot;A String&quot;, # Currency in which price metrics are represented, e.g., if you select `ordered_item_sales_micros`, the returned value will be represented by this currency.
&quot;customLabel0&quot;: &quot;A String&quot;, # Custom label 0 for custom grouping of products.
&quot;customLabel1&quot;: &quot;A String&quot;, # Custom label 1 for custom grouping of products.
Expand All @@ -157,11 +157,11 @@ <h3>Method Details</h3>
&quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
&quot;offerId&quot;: &quot;A String&quot;, # Merchant-provided id of the product.
&quot;productTypeL1&quot;: &quot;A String&quot;, # Product category (1st level) in merchant&#x27;s own product taxonomy.
&quot;productTypeL2&quot;: &quot;A String&quot;, # Product category (2nd level) in merchant&#x27;s own product taxonomy.
&quot;productTypeL3&quot;: &quot;A String&quot;, # Product category (3rd level) in merchant&#x27;s own product taxonomy.
&quot;productTypeL4&quot;: &quot;A String&quot;, # Product category (4th level) in merchant&#x27;s own product taxonomy.
&quot;productTypeL5&quot;: &quot;A String&quot;, # Product category (5th level) in merchant&#x27;s own product taxonomy.
&quot;productTypeL1&quot;: &quot;A String&quot;, # [Product type (1st level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant&#x27;s own product taxonomy.
&quot;productTypeL2&quot;: &quot;A String&quot;, # [Product type (2nd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant&#x27;s own product taxonomy.
&quot;productTypeL3&quot;: &quot;A String&quot;, # [Product type (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant&#x27;s own product taxonomy.
&quot;productTypeL4&quot;: &quot;A String&quot;, # [Product type (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant&#x27;s own product taxonomy.
&quot;productTypeL5&quot;: &quot;A String&quot;, # [Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant&#x27;s own product taxonomy.
&quot;program&quot;: &quot;A String&quot;, # Program to which metrics apply, e.g., Free Product Listing.
&quot;title&quot;: &quot;A String&quot;, # Title of the product.
&quot;week&quot;: { # 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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # First day of the week (Monday) of the metrics date in the merchant timezone.
Expand Down
Loading

0 comments on commit b123349

Please sign in to comment.