| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, h1, h2, h3, div, span, p, pre, a { |
| 5 |
margin: 0; |
| 6 |
padding: 0; |
| 7 |
border: 0; |
| 8 |
font-weight: inherit; |
| 9 |
font-style: inherit; |
| 10 |
font-size: 100%; |
| 11 |
font-family: inherit; |
| 12 |
vertical-align: baseline; |
| 13 |
} |
| 14 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, h2, h3 { |
| 50 |
border-bottom: solid #CCC 1px; |
| 51 |
} |
| 52 |
|
| 53 |
.toc_element { |
| 54 |
margin-top: 0.5em; |
| 55 |
} |
| 56 |
|
| 57 |
.firstline { |
| 58 |
margin-left: 2 em; |
| 59 |
} |
| 60 |
|
| 61 |
.method { |
| 62 |
margin-top: 1em; |
| 63 |
border: solid 1px #CCC; |
| 64 |
padding: 1em; |
| 65 |
background: #EEE; |
| 66 |
} |
| 67 |
|
| 68 |
.details { |
| 69 |
font-weight: bold; |
| 70 |
font-size: 14px; |
| 71 |
} |
| 72 |
|
| 73 |
</style> |
| 74 |
|
| 75 |
<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.shoppingadsprogram.html">shoppingadsprogram</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#get">get(merchantId, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">Retrieves the status and review eligibility for the Shopping Ads program. Returns errors and warnings if they require action to resolve, will become disapprovals, or impact impressions. Use `accountstatuses` to view all issues for an account.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#requestreview">requestreview(merchantId, body=None, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">Requests a review of Shopping ads in a specific region. This method deprecated. Use the `MerchantSupportService` to view product and account issues and request a review.</p> |
| 86 |
<h3>Method Details</h3> |
| 87 |
<div class="method"> |
| 88 |
<code class="details" id="close">close()</code> |
| 89 |
<pre>Close httplib2 connections.</pre> |
| 90 |
</div> |
| 91 |
|
| 92 |
<div class="method"> |
| 93 |
<code class="details" id="get">get(merchantId, x__xgafv=None)</code> |
| 94 |
<pre>Retrieves the status and review eligibility for the Shopping Ads program. Returns errors and warnings if they require action to resolve, will become disapprovals, or impact impressions. Use `accountstatuses` to view all issues for an account. |
| 95 |
|
| 96 |
Args: |
| 97 |
merchantId: string, Required. The ID of the account. (required) |
| 98 |
x__xgafv: string, V1 error format. |
| 99 |
Allowed values |
| 100 |
1 - v1 error format |
| 101 |
2 - v2 error format |
| 102 |
|
| 103 |
Returns: |
| 104 |
An object of the form: |
| 105 |
|
| 106 |
{ # Response message for GetShoppingAdsProgramStatus. |
| 107 |
"globalState": "A String", # State of the program. `ENABLED` if there are offers for at least one region. |
| 108 |
"regionStatuses": [ # Status of the program in each region. Regions with the same status and review eligibility are grouped together in `regionCodes`. |
| 109 |
{ # Status of program and region. |
| 110 |
"disapprovalDate": "A String", # Date by which eligibilityStatus will go from `WARNING` to `DISAPPROVED`. Only visible when your eligibilityStatus is WARNING. In [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DD`. |
| 111 |
"eligibilityStatus": "A String", # Eligibility status of the Shopping Ads program. |
| 112 |
"onboardingIssues": [ # Issues that must be fixed to be eligible for review. |
| 113 |
"A String", |
| 114 |
], |
| 115 |
"regionCodes": [ # 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`. |
| 116 |
"A String", |
| 117 |
], |
| 118 |
"reviewEligibilityStatus": "A String", # If a program is eligible for review in a specific region. Only visible if `eligibilityStatus` is `DISAPPROVED`. |
| 119 |
"reviewIneligibilityReason": "A String", # Review ineligibility reason if account is not eligible for review. |
| 120 |
"reviewIneligibilityReasonDescription": "A String", # Reason a program in a specific region isn’t eligible for review. Only visible if `reviewEligibilityStatus` is `INELIGIBLE`. |
| 121 |
"reviewIneligibilityReasonDetails": { # Additional details for review ineligibility reasons. # Additional information for ineligibility. If `reviewIneligibilityReason` is `IN_COOLDOWN_PERIOD`, a timestamp for the end of the cooldown period is provided. |
| 122 |
"cooldownTime": "A String", # This timestamp represents end of cooldown period for review ineligbility reason `IN_COOLDOWN_PERIOD`. |
| 123 |
}, |
| 124 |
"reviewIssues": [ # Issues evaluated in the review process. Fix all issues before requesting a review. |
| 125 |
"A String", |
| 126 |
], |
| 127 |
}, |
| 128 |
], |
| 129 |
}</pre> |
| 130 |
</div> |
| 131 |
|
| 132 |
<div class="method"> |
| 133 |
<code class="details" id="requestreview">requestreview(merchantId, body=None, x__xgafv=None)</code> |
| 134 |
<pre>Requests a review of Shopping ads in a specific region. This method deprecated. Use the `MerchantSupportService` to view product and account issues and request a review. |
| 135 |
|
| 136 |
Args: |
| 137 |
merchantId: string, Required. The ID of the account. (required) |
| 138 |
body: object, The request body. |
| 139 |
The object takes the form of: |
| 140 |
|
| 141 |
{ # Request message for the RequestReviewShoppingAds program method. |
| 142 |
"regionCode": "A String", # 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. |
| 143 |
} |
| 144 |
|
| 145 |
x__xgafv: string, V1 error format. |
| 146 |
Allowed values |
| 147 |
1 - v1 error format |
| 148 |
2 - v2 error format |
| 149 |
</pre> |
| 150 |
</div> |
| 151 |
|
| 152 |
</body></html> |