REST Resource: shoppingadsprogram

Stay organized with collections Save and categorize content based on your preferences.

Resource: ShoppingAdsProgramStatus

Response message for shoppingadsprogram.get.

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

enum (ProgramState)

State of the program. ENABLED if there are offers 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

Different states of the program for the account.

Enums
PROGRAM_STATE_UNSPECIFIED State is unknown.
NOT_ENABLED Program is not enabled for any country.
NO_OFFERS_UPLOADED No products have been uploaded for any region. Upload products to Merchant Center.
ENABLED Program is enabled and offers are uploaded for at least one country.

RegionStatus

Status of program and region.

JSON representation
{
  "regionCodes": [
    string
  ],
  "eligibilityStatus": enum (State),
  "reviewIssues": [
    string
  ],
  "onboardingIssues": [
    string
  ],

  // Union field _disapproval_date can be only one of the following:
  "disapprovalDate": string
  // End of list of possible types for union field _disapproval_date.

  // Union field _review_eligibility_status can be only one of the following:
  "reviewEligibilityStatus": enum (ReviewEligibility)
  // End of list of possible types for union field _review_eligibility_status.

  // Union field _review_ineligibility_reason can be only one of the following:
  "reviewIneligibilityReason": enum (ReviewIneligibilityReason)
  // End of list of possible types for union field _review_ineligibility_reason.

  // Union field _review_ineligibility_reason_description can be only one of the
  // following:
  "reviewIneligibilityReasonDescription": string
  // End of list of possible types for union field
  // _review_ineligibility_reason_description.

  // Union field _review_ineligibility_reason_details can be only one of the
  // following:
  "reviewIneligibilityReasonDetails": {
    object (ReviewIneligibilityReasonDetails)
  }
  // End of list of possible types for union field
  // _review_ineligibility_reason_details.
}
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

Issues evaluated in the review process. Fix all issues before requesting a review.

onboardingIssues[]

string

Issues that must be fixed to be eligible for review.

Union field _disapproval_date.

_disapproval_date can be only one of the following:

disapprovalDate

string

Date by which eligibilityStatus will go from WARNING to DISAPPROVED. Only visible when your eligibilityStatus is WARNING. In ISO 8601 format: YYYY-MM-DD.

Union field _review_eligibility_status.

_review_eligibility_status can be only one of the following:

reviewEligibilityStatus

enum (ReviewEligibility)

If a program is eligible for review in a specific region. Only visible if eligibilityStatus is DISAPPROVED.

Union field _review_ineligibility_reason.

_review_ineligibility_reason can be only one of the following:

reviewIneligibilityReason

enum (ReviewIneligibilityReason)

Review ineligibility reason if account is not eligible for review.

Union field _review_ineligibility_reason_description.

_review_ineligibility_reason_description can be only one of the following:

reviewIneligibilityReasonDescription

string

Reason a program in a specific region isn’t eligible for review. Only visible if reviewEligibilityStatus is INELIGIBLE.

Union field _review_ineligibility_reason_details.

_review_ineligibility_reason_details can be only one of the following:

reviewIneligibilityReasonDetails

object (ReviewIneligibilityReasonDetails)

Additional information for ineligibility. If reviewIneligibilityReason is IN_COOLDOWN_PERIOD, a timestamp for the end of the cooldown period is provided.

ReviewIneligibilityReasonDetails

Additional details for review ineligibility reasons.

JSON representation
{

  // Union field _cooldown_time can be only one of the following:
  "cooldownTime": string
  // End of list of possible types for union field _cooldown_time.
}
Fields

Union field _cooldown_time.

_cooldown_time can be only one of the following:

cooldownTime

string (Timestamp format)

This timestamp represents end of cooldown period for review ineligbility reason IN_COOLDOWN_PERIOD.

Methods

get

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

requestreview

Requests a review of Shopping ads in a specific region.