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.

PolicyTopicEntry

Policy finding attached to a resource (e.g. alcohol policy associated with a site that sells alcohol).

Each PolicyTopicEntry has a topic that indicates the specific ads policy the entry is about and a type to indicate the effect that the entry will have on serving. It may optionally have one or more evidences that indicate the reason for the finding. It may also optionally have one or more constraints that provide details about how serving may be restricted.

JSON representation
{
  "type": enum (PolicyTopicEntryType),
  "evidences": [
    {
      object (PolicyTopicEvidence)
    }
  ],
  "constraints": [
    {
      object (PolicyTopicConstraint)
    }
  ],
  "topic": string
}
Fields
type

enum (PolicyTopicEntryType)

Describes the negative or positive effect this policy will have on serving.

evidences[]

object (PolicyTopicEvidence)

Additional information that explains policy finding (e.g. the brand name for a trademark finding).

constraints[]

object (PolicyTopicConstraint)

Indicates how serving of this resource may be affected (e.g. not serving in a country).

topic

string

Policy topic this finding refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time.

PolicyTopicEntryType

The possible policy topic entry types.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

PROHIBITED The resource will not be served.
LIMITED The resource will not be served under some circumstances.
FULLY_LIMITED The resource cannot serve at all because of the current targeting criteria.
DESCRIPTIVE May be of interest, but does not limit how the resource is served.
BROADENING Could increase coverage beyond normal.
AREA_OF_INTEREST_ONLY Constrained for all targeted countries, but may serve in other countries through area of interest.

PolicyTopicEvidence

Additional information that explains a policy finding.

JSON representation
{

  // Union field value can be only one of the following:
  "websiteList": {
    object (WebsiteList)
  },
  "textList": {
    object (TextList)
  },
  "languageCode": string,
  "destinationTextList": {
    object (DestinationTextList)
  },
  "destinationMismatch": {
    object (DestinationMismatch)
  },
  "destinationNotWorking": {
    object (DestinationNotWorking)
  }
  // End of list of possible types for union field value.
}
Fields
Union field value. Specific evidence information depending on the evidence type. value can be only one of the following:
websiteList

object (WebsiteList)

List of websites linked with this resource.

textList

object (TextList)

List of evidence found in the text of a resource.

languageCode

string

The language the resource was detected to be written in. This is an IETF language tag such as "en-US".

destinationTextList

object (DestinationTextList)

The text in the destination of the resource that is causing a policy finding.

destinationMismatch

object (DestinationMismatch)

Mismatch between the destinations of a resource's URLs.

destinationNotWorking

object (DestinationNotWorking)

Details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.

WebsiteList

A list of websites that caused a policy finding. Used for ONE_WEBSITE_PER_AD_GROUP policy topic, for example. In case there are more than five websites, only the top five (those that appear in resources the most) will be listed here.

JSON representation
{
  "websites": [
    string
  ]
}
Fields
websites[]

string

Websites that caused the policy finding.

TextList

A list of fragments of text that violated a policy.

JSON representation
{
  "texts": [
    string
  ]
}
Fields
texts[]

string

The fragments of text from the resource that caused the policy finding.

DestinationTextList

A list of strings found in a destination page that caused a policy finding.

JSON representation
{
  "destinationTexts": [
    string
  ]
}
Fields
destinationTexts[]

string

List of text found in the resource's destination page.

DestinationMismatch

Evidence of mismatches between the URLs of a resource.

JSON representation
{
  "urlTypes": [
    enum (PolicyTopicEvidenceDestinationMismatchUrlType)
  ]
}
Fields
urlTypes[]

enum (PolicyTopicEvidenceDestinationMismatchUrlType)

The set of URLs that did not match each other.

PolicyTopicEvidenceDestinationMismatchUrlType

The possible policy topic evidence destination mismatch url types.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

DISPLAY_URL The display url.
FINAL_URL The final url.
FINAL_MOBILE_URL The final mobile url.
TRACKING_URL The tracking url template, with substituted desktop url.
MOBILE_TRACKING_URL The tracking url template, with substituted mobile url.

DestinationNotWorking

Evidence details when the destination is returning an HTTP error code or isn't functional in all locations for commonly used devices.

JSON representation
{
  "device": enum (PolicyTopicEvidenceDestinationNotWorkingDevice),
  "expandedUrl": string,
  "lastCheckedDateTime": string,

  // Union field reason can be only one of the following:
  "dnsErrorType": enum (PolicyTopicEvidenceDestinationNotWorkingDnsErrorType),
  "httpErrorCode": string
  // End of list of possible types for union field reason.
}
Fields
device

enum (PolicyTopicEvidenceDestinationNotWorkingDevice)

The type of device that failed to load the URL.

expandedUrl

string

The full URL that didn't work.

lastCheckedDateTime

string

The time the URL was last checked. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"

Union field reason. Indicates the reason of the DESTINATION_NOT_WORKING policy finding. reason can be only one of the following:
dnsErrorType

enum (PolicyTopicEvidenceDestinationNotWorkingDnsErrorType)

The type of DNS error.

httpErrorCode

string (int64 format)

The HTTP error code.

PolicyTopicEvidenceDestinationNotWorkingDevice

The possible policy topic evidence destination not working devices.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

DESKTOP Landing page doesn't work on desktop device.
ANDROID Landing page doesn't work on Android device.
IOS Landing page doesn't work on iOS device.

PolicyTopicEvidenceDestinationNotWorkingDnsErrorType

The possible policy topic evidence destination not working DNS error types.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

HOSTNAME_NOT_FOUND Host name not found in DNS when fetching landing page.
GOOGLE_CRAWLER_DNS_ISSUE Google internal crawler issue when communicating with DNS. This error doesn't mean the landing page doesn't work. Google will recrawl the landing page.

PolicyTopicConstraint

Describes the effect on serving that a policy topic entry will have.

JSON representation
{

  // Union field value can be only one of the following:
  "countryConstraintList": {
    object (CountryConstraintList)
  },
  "resellerConstraint": {
    object (ResellerConstraint)
  },
  "certificateMissingInCountryList": {
    object (CountryConstraintList)
  },
  "certificateDomainMismatchInCountryList": {
    object (CountryConstraintList)
  }
  // End of list of possible types for union field value.
}
Fields
Union field value. Specific information about the constraint. value can be only one of the following:
countryConstraintList

object (CountryConstraintList)

Countries where the resource cannot serve.

resellerConstraint

object (ResellerConstraint)

Reseller constraint.

certificateMissingInCountryList

object (CountryConstraintList)

Countries where a certificate is required for serving.

certificateDomainMismatchInCountryList

object (CountryConstraintList)

Countries where the resource's domain is not covered by the certificates associated with it.

CountryConstraintList

A list of countries where a resource's serving is constrained.

JSON representation
{
  "countries": [
    {
      object (CountryConstraint)
    }
  ],
  "totalTargetedCountries": integer
}
Fields
countries[]

object (CountryConstraint)

Countries in which serving is restricted.

totalTargetedCountries

integer

Total number of countries targeted by the resource.

CountryConstraint

Indicates that a resource's ability to serve in a particular country is constrained.

JSON representation
{
  "countryCriterion": string
}
Fields
countryCriterion

string

Geo target constant resource name of the country in which serving is constrained.

ResellerConstraint

Indicates that a policy topic was constrained due to disapproval of the website for reseller purposes.