Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.adGroupAds

Resource: AdGroupAd

An ad group ad.

JSON representation
{
  "resourceName": string,
  "status": enum (AdGroupAdStatus),
  "ad": {
    object (Ad)
  },
  "policySummary": {
    object (AdGroupAdPolicySummary)
  },
  "adStrength": enum (AdStrength),
  "labels": [
    string
  ],
  "adGroup": string
}
Fields
resourceName

string

Immutable. The resource name of the ad. Ad group ad resource names have the form:

customers/{customerId}/adGroupAds/{adGroupId}~{ad_id}

status

enum (AdGroupAdStatus)

The status of the ad.

ad

object (Ad)

Immutable. The ad.

policySummary

object (AdGroupAdPolicySummary)

Output only. Policy information for the ad.

adStrength

enum (AdStrength)

Output only. Overall ad strength for this ad group ad.

labels[]

string

Output only. The resource names of labels attached to this ad group ad.

adGroup

string

Immutable. The ad group to which the ad belongs.

AdGroupAdStatus

The possible statuses of an AdGroupAd.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

ENABLED The ad group ad is enabled.
PAUSED The ad group ad is paused.
REMOVED The ad group ad is removed.

AdGroupAdPolicySummary

Contains policy information for an ad.

JSON representation
{
  "policyTopicEntries": [
    {
      object (PolicyTopicEntry)
    }
  ],
  "reviewStatus": enum (PolicyReviewStatus),
  "approvalStatus": enum (PolicyApprovalStatus)
}
Fields
policyTopicEntries[]

object (PolicyTopicEntry)

Output only. The list of policy findings for this ad.

reviewStatus

enum (PolicyReviewStatus)

Output only. Where in the review process this ad is.

approvalStatus

enum (PolicyApprovalStatus)

Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries.

AdStrength

Enum listing the possible ad strengths.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PENDING The ad strength is currently pending.
NO_ADS No ads could be generated.
POOR Poor strength.
AVERAGE Average strength.
GOOD Good strength.
EXCELLENT Excellent strength.

Methods

get

Returns the requested ad in full detail.

mutate

Creates, updates, or removes ads.