Method: customers.smartCampaignSettings.getSmartCampaignStatus

Returns the status of the requested Smart campaign.

HTTP request

GET https://googleads.googleapis.com/v17/{resourceName=customers/*/smartCampaignSettings/*}:getSmartCampaignStatus

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resourceName

string

Required. The resource name of the Smart campaign setting belonging to the Smart campaign to fetch the status of.

Request body

The request body must be empty.

Response body

Response message for SmartCampaignSettingService.GetSmartCampaignStatus.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "smartCampaignStatus": enum (SmartCampaignStatus),

  // Union field smart_campaign_status_details can be only one of the following:
  "notEligibleDetails": {
    object (SmartCampaignNotEligibleDetails)
  },
  "eligibleDetails": {
    object (SmartCampaignEligibleDetails)
  },
  "pausedDetails": {
    object (SmartCampaignPausedDetails)
  },
  "removedDetails": {
    object (SmartCampaignRemovedDetails)
  },
  "endedDetails": {
    object (SmartCampaignEndedDetails)
  }
  // End of list of possible types for union field smart_campaign_status_details.
}
Fields
smartCampaignStatus

enum (SmartCampaignStatus)

The status of this Smart campaign.
Union field smart_campaign_status_details. Additional details accompanying the status of a Smart campaign. smart_campaign_status_details can be only one of the following:
notEligibleDetails

object (SmartCampaignNotEligibleDetails)

Details related to Smart campaigns that are ineligible to serve.
eligibleDetails

object (SmartCampaignEligibleDetails)

Details related to Smart campaigns that are eligible to serve.
pausedDetails

object (SmartCampaignPausedDetails)

Details related to paused Smart campaigns.
removedDetails

object (SmartCampaignRemovedDetails)

Details related to removed Smart campaigns.
endedDetails

object (SmartCampaignEndedDetails)

Details related to Smart campaigns that have ended.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

SmartCampaignStatus

Smart campaign statuses.

Enums
UNSPECIFIED The status has not been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
PAUSED The campaign was paused.
NOT_ELIGIBLE The campaign is not eligible to serve and has issues that may require intervention.
PENDING The campaign is pending the approval of at least one ad.
ELIGIBLE The campaign is eligible to serve.
REMOVED The campaign has been removed.
ENDED The campaign has ended.

SmartCampaignNotEligibleDetails

Details related to Smart campaigns that are not eligible to serve.

JSON representation 
{
  "notEligibleReason": enum (SmartCampaignNotEligibleReason)
}
Fields
notEligibleReason

enum (SmartCampaignNotEligibleReason)

The reason why the Smart campaign is not eligible to serve.

SmartCampaignNotEligibleReason

Reasons for why a Smart campaign is not eligible to serve.

Enums
UNSPECIFIED The status has not been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.
ACCOUNT_ISSUE The campaign is not eligible to serve because of an issue with the account.
BILLING_ISSUE The campaign is not eligible to serve because of a payment issue.
BUSINESS_PROFILE_LOCATION_REMOVED The business profile location associated with the campaign has been removed.
ALL_ADS_DISAPPROVED All system-generated ads have been disapproved. Consult the policySummary field in the AdGroupAd resource for more details.

SmartCampaignEligibleDetails

Details related to Smart campaigns that are eligible to serve.

JSON representation 
{
  "lastImpressionDateTime": string,
  "endDateTime": string
}
Fields
lastImpressionDateTime

string

The timestamp of the last impression observed in the last 48 hours for this campaign. The timestamp is in the customer’s timezone and in “yyyy-MM-dd HH:mm:ss” format.
endDateTime

string

The timestamp of when the campaign will end, if applicable. The timestamp is in the customer’s timezone and in “yyyy-MM-dd HH:mm:ss” format.

SmartCampaignPausedDetails

Details related to paused Smart campaigns.

JSON representation 
{
  "pausedDateTime": string
}
Fields
pausedDateTime

string

The timestamp of when the campaign was last paused. The timestamp is in the customer’s timezone and in “yyyy-MM-dd HH:mm:ss” format.

SmartCampaignRemovedDetails

Details related to removed Smart campaigns.

JSON representation 
{
  "removedDateTime": string
}
Fields
removedDateTime

string

The timestamp of when the campaign was removed. The timestamp is in the customer’s timezone and in “yyyy-MM-dd HH:mm:ss” format.

SmartCampaignEndedDetails

Details related to Smart campaigns that have ended.

JSON representation 
{
  "endDateTime": string
}
Fields
endDateTime

string

The timestamp of when the campaign ended. The timestamp is in the customer’s timezone and in “yyyy-MM-dd HH:mm:ss” format.