Content API for Shopping . freelistingsprogram

Instance Methods

checkoutsettings()

Returns the checkoutsettings Resource.

close()

Close httplib2 connections.

get(merchantId, x__xgafv=None)

Retrieves the status and review eligibility for the free listing 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.

requestreview(merchantId, body=None, x__xgafv=None)

Requests a review of free listings in a specific region. This method deprecated. Use the `MerchantSupportService` to view product and account issues and request a review.

Method Details

close()
Close httplib2 connections.
get(merchantId, x__xgafv=None)
Retrieves the status and review eligibility for the free listing 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.

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.
  "globalState": "A String", # State of the program. `ENABLED` if there are offers for at least one region.
  "regionStatuses": [ # 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.
      "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`.
      "eligibilityStatus": "A String", # Eligibility status of the standard free listing program.
      "onboardingIssues": [ # Issues that must be fixed to be eligible for review.
        "A String",
      ],
      "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`.
        "A String",
      ],
      "reviewEligibilityStatus": "A String", # If a program is eligible for review in a specific region. Only visible if `eligibilityStatus` is `DISAPPROVED`.
      "reviewIneligibilityReason": "A String", # Review ineligibility reason if account is not eligible for review.
      "reviewIneligibilityReasonDescription": "A String", # Reason a program in a specific region isn’t eligible for review. Only visible if `reviewEligibilityStatus` is `INELIGIBLE`.
      "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.
        "cooldownTime": "A String", # This timestamp represents end of cooldown period for review ineligbility reason `IN_COOLDOWN_PERIOD`.
      },
      "reviewIssues": [ # Issues evaluated in the review process. Fix all issues before requesting a review.
        "A String",
      ],
    },
  ],
}
requestreview(merchantId, body=None, x__xgafv=None)
Requests a review of free listings in a specific region. This method deprecated. Use the `MerchantSupportService` to view product and account issues and request a review.

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.
  "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.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format