Version v2 of the Content API is scheduled for sunset on September 30th, 2021. Onboarding to v2 ended on April 30, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible.

For more information, see Migrating to v2.1 and this blog post.

REST Resource: shoppingadsprogram

Resource: ShoppingAdsProgramStatus

Response message for shoppingadsprogram.get.

JSON representation
{
  "state": enum (ProgramState),
  "regionStatuses": [
    {
      object (RegionStatus)
    }
  ]
}
Fields
state

enum (ProgramState)

If program is successfully onboarded for at least one region.

regionStatuses[]

object (RegionStatus)

Status of the program in each region. Regions with the same status and review eligibility are grouped together in regionCodes.

ProgramState

State of the program onboarding.

Enums
PROGRAM_STATE_UNSPECIFIED State is not known.
ONBOARDED Program is onboarded for at least one country.
NOT_ONBOARDED Program is not onboarded for any country.

RegionStatus

Status of program and region.

JSON representation
{
  "regionCodes": [
    string
  ],
  "eligibilityStatus": enum (State),
  "reviewIssues": [
    string
  ],
  "disapprovalDate": string,
  "reviewEligibilityStatus": enum (ReviewEligibility),
  "ineligibilityReason": string
}
Fields
regionCodes[]

string

The two-letter ISO 3166-1 alpha-2 codes for all the regions with the same eligibilityStatus and reviewEligibility.

eligibilityStatus

enum (State)

Eligibility status of the Shopping Ads program.

reviewIssues[]

string

These issues will be evaluated in review process. Fix all the issues before requesting the review.

disapprovalDate

string

Date by which eligibilityStatus will go from WARNING to DISAPPROVED. It will be present when eligibilityStatus is WARNING. Date will be provided in ISO 8601 format i.e. YYYY-MM-DD

reviewEligibilityStatus

enum (ReviewEligibility)

If a program in a given country is eligible for review. It will be present only if eligibility status is DISAPPROVED.

ineligibilityReason

string

Reason if a program in a given country is not eligible for review. Populated only if reviewEligibilityStatus is INELIGIBLE.

Methods

get

Retrieves the status and review eligibility for the Shopping Ads program.

requestreview

Requests a review for Shopping Ads program in the provided country.