SiteService (v202411)

  • The SiteService provides operations to manage Site objects in Ad Manager.

  • You can create, retrieve based on a statement, perform actions on, and update Site objects using this service.

  • The service defines various error types that can occur during operations, including authentication, collection size, and site-specific errors.
Production WSDL
https://ads.google.com/apis/ads/publisher/v202411/SiteService?wsdl
Namespace
https://www.google.com/apis/ads/publisher/v202411
Operations
Errors

createSites

Creates new Site objects.

Parameters

Field Type Description
sites Site[]

Response

Field Type Description
rval Site[]

getSitesByStatement

Gets a SitePage of Site objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property Object Property
id Site.id
url Site.url
childNetworkCode Site.childNetworkCode
approvalStatus Site.approvalStatus
lastModifiedApprovalStatusDateTime
Restriction: The lastModifiedApprovalStatusDateTime PQL property can only be used in a top-level expression scoping the filterStatement to Sites whose approvalStatus was modified on or after a specified date and time. (e.x. "WHERE lastModifiedApprovalStatusDateTime >= '2022-01-01T00:00:00'").

Parameters

Field Type Description
filterStatement Statement

Response

Field Type Description
rval SitePage

performSiteAction

Performs actions on Site objects that match the given Statement.query.

Parameters

Field Type Description
siteAction
  1. SiteAction
    1. DeactivateSite
    2. SubmitSiteForApproval
filterStatement Statement

Response

Field Type Description
rval UpdateResult

updateSites

Updates the specified Site objects.

The Site.childNetworkCode can be updated in order to 1) change the child network, 2) move a site from O&O to represented, or 3) move a site from represented to O&O.

Parameters

Field Type Description
sites Site[]

Response

Field Type Description
rval Site[]

Errors

Error Reasons
AdSenseAccountError
Enumerations
ASSOCIATE_ACCOUNT_API_ERROR
CANNOT_ACCESS_INVALID_ACCOUNT
ACCOUNT_ACCESS_DENIED
GET_AD_SLOT_API_ERROR
GET_CHANNEL_API_ERROR
GET_BULK_ACCOUNT_STATUSES_API_ERROR
RESEND_VERIFICATION_EMAIL_ERROR
UNEXPECTED_API_RESPONSE_ERROR
UNKNOWN
ApiVersionError
Enumerations
UPDATE_TO_NEWER_VERSION
UNKNOWN
AuthenticationError
Enumerations
AMBIGUOUS_SOAP_REQUEST_HEADER
INVALID_EMAIL
AUTHENTICATION_FAILED
INVALID_OAUTH_SIGNATURE
INVALID_SERVICE
MISSING_SOAP_REQUEST_HEADER
MISSING_AUTHENTICATION_HTTP_HEADER
MISSING_AUTHENTICATION
NETWORK_API_ACCESS_DISABLED
NO_NETWORKS_TO_ACCESS
NETWORK_NOT_FOUND
NETWORK_CODE_REQUIRED
CONNECTION_ERROR
GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK
UNDER_INVESTIGATION
UNKNOWN
CollectionSizeError
Enumerations
TOO_LARGE
UNKNOWN
CommonError
Enumerations
NOT_FOUND
ALREADY_EXISTS
NOT_APPLICABLE
DUPLICATE_OBJECT
CANNOT_UPDATE
UNSUPPORTED_OPERATION
CONCURRENT_MODIFICATION
UNKNOWN
EntityLimitReachedError
Enumerations
CUSTOM_TARGETING_VALUES_LIMIT_REACHED
AD_EXCLUSION_RULES_LIMIT_REACHED
FIRST_PARTY_AUDIENCE_SEGMENTS_LIMIT_REACHED
PLACEMENTS_LIMIT_REACHED
LINE_ITEMS_LIMIT_REACHED
ACTIVE_LINE_ITEMS_LIMIT_REACHED
DAI_ENCODING_PROFILES_LIMIT_REACHED
TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED
FORECAST_ADJUSTMENTS_LIMIT_REACHED
ACTIVE_EXPERIMENTS_LIMIT_REACHED
SITES_LIMIT_REACHED
USER_TEAMS_LIMIT_REACHED
UNKNOWN
FeatureError
Enumerations
MISSING_FEATURE
UNKNOWN
InternalApiError
Enumerations
UNEXPECTED_INTERNAL_API_ERROR
TRANSIENT_ERROR
UNKNOWN
DOWNTIME
ERROR_GENERATING_RESPONSE
NotNullError
Enumerations
ARG1_NULL
ARG2_NULL
ARG3_NULL
NULL
UNKNOWN
NullError
Enumerations
NOT_NULL
UNKNOWN
ParseError
Enumerations
UNPARSABLE
UNKNOWN
PermissionError
Enumerations
PERMISSION_DENIED
UNKNOWN
PublisherQueryLanguageContextError
Enumerations
UNEXECUTABLE
UNKNOWN
PublisherQueryLanguageSyntaxError
Enumerations
UNPARSABLE
UNKNOWN
QuotaError
Enumerations
EXCEEDED_QUOTA
UNKNOWN
REPORT_JOB_LIMIT
SEGMENT_POPULATION_LIMIT
RequiredCollectionError
Enumerations
REQUIRED
TOO_LARGE
TOO_SMALL
UNKNOWN
RequiredError
Enumerations
REQUIRED
ServerError
Enumerations
SERVER_ERROR
SERVER_BUSY
UNKNOWN
SiteError
Enumerations
INVALID_CHILD_NETWORK_CODE
CANNOT_ARCHIVE_SITE_WITH_SUBSITES
INVALID_URL_FOR_SITE
MULTIPLE_UPDATES_FOR_SAME_SITE
TOO_MANY_SITES_PER_REVIEW_REQUEST
TOO_MANY_REVIEW_REQUESTS_FOR_SITE
INVALID_APPROVAL_STATUS_FOR_REVIEW
UNKNOWN
StatementError
Enumerations
VARIABLE_NOT_BOUND_TO_VALUE
UNKNOWN
StringFormatError
Enumerations
UNKNOWN
ILLEGAL_CHARS
INVALID_FORMAT
StringLengthError
Enumerations
TOO_LONG
TOO_SHORT
UNKNOWN
UrlError
Enumerations
CANNOT_USE_RESERVED_URL
CANNOT_USE_GOOGLE_URL
INVALID_URL
UNKNOWN