CompanyService (v202308)

Provides operations for creating, updating and retrieving Company objects.

Production WSDL
https://ads.google.com/apis/ads/publisher/v202308/CompanyService?wsdl
Namespace
https://www.google.com/apis/ads/publisher/v202308
Operations
Errors

createCompanies

Creates new Company objects.

Parameters

Field Type Description
companies Company[]

Response

Field Type Description
rval Company[]

getCompaniesByStatement

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

PQL Property Object Property
id Company.id
name Company.name
type Company.type
lastModifiedDateTime Company.lastModifiedDateTime

Parameters

Field Type Description
filterStatement Statement

Response

Field Type Description
rval CompanyPage

performCompanyAction

Performs actions on Company objects that match the given Statement.

Parameters

Field Type Description
companyAction
  1. CompanyAction
    1. ReInviteAction
    2. EndAgreementAction
    3. ResendInvitationAction
statement Statement

Response

Field Type Description
rval UpdateResult

updateCompanies

Updates the specified Company objects.

Parameters

Field Type Description
companies Company[]

Response

Field Type Description
rval Company[]

Errors

Error Reasons
ApiVersionError Errors related to the usage of API versions.
Enumerations
UPDATE_TO_NEWER_VERSION
Indicates that the operation is not allowed in the version the request was made in.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
AuthenticationError An error for an exception that occurred when authenticating.
Enumerations
AMBIGUOUS_SOAP_REQUEST_HEADER
The SOAP message contains a request header with an ambiguous definition of the authentication header fields. This means either the authToken and oAuthToken fields were both null or both were specified. Exactly one value should be specified with each request.
INVALID_EMAIL
The login provided is invalid.
AUTHENTICATION_FAILED
Tried to authenticate with provided information, but failed.
INVALID_OAUTH_SIGNATURE
The OAuth provided is invalid.
INVALID_SERVICE
The specified service to use was not recognized.
MISSING_SOAP_REQUEST_HEADER
The SOAP message is missing a request header with an authToken and optional networkCode.
MISSING_AUTHENTICATION_HTTP_HEADER
The HTTP request is missing a request header with an authToken
MISSING_AUTHENTICATION
The request is missing an authToken
NETWORK_API_ACCESS_DISABLED
The network does not have API access enabled.
NO_NETWORKS_TO_ACCESS
The user is not associated with any network.
NETWORK_NOT_FOUND
No network for the given networkCode was found.
NETWORK_CODE_REQUIRED
The user has access to more than one network, but did not provide a networkCode.
CONNECTION_ERROR
An error happened on the server side during connection to authentication service.
GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK
The user tried to create a test network using an account that already is associated with a network.
UNDER_INVESTIGATION
The account is blocked and under investigation by the collections team. Please contact Google for more information.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CollectionSizeError Error for the size of the collection being too large
Enumerations
TOO_LARGE
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CommonError A place for common errors that can be used across services.
Enumerations
NOT_FOUND
Indicates that an attempt was made to retrieve an entity that does not exist.
ALREADY_EXISTS
Indicates that an attempt was made to create an entity that already exists.
NOT_APPLICABLE
Indicates that a value is not applicable for given use case.
DUPLICATE_OBJECT
Indicates that two elements in the collection were identical.
CANNOT_UPDATE
Indicates that an attempt was made to change an immutable field.
UNSUPPORTED_OPERATION
Indicates that the requested operation is not supported.
CONCURRENT_MODIFICATION
Indicates that another request attempted to update the same data in the same network at about the same time. Please wait and try the request again.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CompanyCreditStatusError Lists all errors due to Company.creditStatus.
Enumerations
COMPANY_CREDIT_STATUS_CHANGE_NOT_ALLOWED
The user's role does not have permission to change Company.creditStatus from the default value. The default value is Company.CreditStatus.ACTIVE for the Basic credit status setting and Company.CreditStatus.ON_HOLD for the Advanced credit status setting.
CANNOT_USE_CREDIT_STATUS_SETTING
The network has not been enabled for editing credit status settings for companies.
CANNOT_USE_ADVANCED_CREDIT_STATUS_SETTING
The network has not been enabled for the Advanced credit status settings for companies. Company.creditStatus must be either ACTIVE or INACTIVE.
UNACCEPTABLE_COMPANY_CREDIT_STATUS_FOR_ORDER
An order cannot be created or updated because the Order.advertiserId or the Order.agencyId it is associated with has Company.creditStatus that is not ACTIVE or ON_HOLD.
UNACCEPTABLE_COMPANY_CREDIT_STATUS_FOR_LINE_ITEM
A line item cannot be created for the order because the Order.advertiserId or {Order#agencyId} it is associated with has Company.creditStatus that is not ACTIVE or ON_HOLD.
CANNOT_BLOCK_COMPANY_TOO_MANY_APPROVED_ORDERS
The company cannot be blocked because there are more than 200 approved orders of the company. Archive some, so that there are less than 200 of them.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CompanyError A list of all errors associated with companies.
Enumerations
CANNOT_SET_THIRD_PARTY_COMPANY_DUE_TO_TYPE
Indicates that an attempt was made to set a third party company for a company whose type is not the same as the third party company.
CANNOT_UPDATE_COMPANY_TYPE
Indicates that an invalid attempt was made to change a company's type.
INVALID_COMPANY_TYPE
Indicates that this type of company is not supported.
PRIMARY_CONTACT_DOES_NOT_BELONG_TO_THIS_COMPANY
Indicates that an attempt was made to assign a primary contact who does not belong to the specified company.
THIRD_PARTY_STATS_PROVIDER_IS_WRONG_ROLE_TYPE
Indicates that the user specified as the third party stats provider is of the wrong role type. The user must have the third party stats provider role.
INVALID_LABEL_ASSOCIATION
Labels can only be applied to Company.Type.ADVERTISER, Company.Type.HOUSE_ADVERTISER, and Company.Type.AD_NETWORK company types.
INVALID_COMPANY_TYPE_FOR_DEFAULT_BILLING_SETTING
Indicates that the Company.Type does not support default billing settings.
INVALID_DEFAULT_BILLING_SETTING
Indicates that the format of the default billing setting is wrong.
COMPANY_HAS_ACTIVE_SHARE_ASSIGNMENTS
Cannot remove the cross selling config from a company that has active share assignments.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CrossSellError Lists all errors associated with cross selling.
Enumerations
COMPANY_IS_NOT_DISTRIBUTION_PARTNER
A company for cross-sell partner must be of type Company.Type.PARTNER.
CHANGING_PARTNER_NETWORK_IS_NOT_SUPPORTED
The network code of a cross-sell partner cannot be changed.
MISSING_DISTRIBUTOR_PARTNER_NAME
A cross-sell partner must have a partner name.
DISTRIBUTOR_NETWORK_MISSING_PUBLISHER_FEATURE
The cross-sell distributor publisher feature must be enabled.
CONTENT_PROVIDER_NETWORK_MISSING_PUBLISHER_FEATURE
The cross-sell publisher features must be enabled on the partner's network.
INVALID_DISTRIBUTOR_PARTNER_NAME
The cross-sell partner name conflicts with an ad unit name on the partner's network.
INVALID_CONTENT_PROVIDER_NETWORK
The network code of a cross-sell partner is invalid.
CONTENT_PROVIDER_NETWORK_CANNOT_BE_ACTIVE_NETWORK
The content provider network must be different than the distributor network.
CONTENT_PROVIDER_NETWORK_ALREADY_ENABLED_FOR_CROSS_SELLING
The same network code was already enabled for cross-sell in a different company.
DISTRIBUTOR_RULE_VIOLATION_ERROR
A rule defined by the cross selling distributor has been violated by a line item targeting a shared ad unit. Violating this rule is an error.
DISTRIBUTOR_RULE_VIOLATION_WARNING
A rule defined by the cross selling distributor has been violated by a line item targeting a shared ad unit. Violating this rule is a warning.

By setting LineItem.skipCrossSellingRuleWarningChecks, the content partner can suppress the warning (and create or save the line item).

This flag is available beginning in V201411.

UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CustomFieldValueError Errors specific to editing custom field values
Enumerations
CUSTOM_FIELD_NOT_FOUND
An attempt was made to modify or create a CustomFieldValue for a CustomField that does not exist.
CUSTOM_FIELD_INACTIVE
An attempt was made to create a new value for a custom field that is inactive.
CUSTOM_FIELD_OPTION_NOT_FOUND
An attempt was made to modify or create a CustomFieldValue corresponding to a CustomFieldOption that could not be found.
INVALID_ENTITY_TYPE
An attempt was made to modify or create a CustomFieldValue with an association to an entity of the wrong type for its field.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
ExchangeSignupApiError ApiError for exceptions thrown by ExchangeSignupService.
Enumerations
ADSENSE_ACCOUNT_CREATION_ERROR
ADSENSE_ACCOUNT_ALREADY_HAS_EXCHANGE
FAILED_TO_ADD_WEBSITE_TO_PROPERTY
FAILED_TO_CREATE_LINK_FOR_NEW_ACCOUNT
CANNOT_CREATE_NEW_ACCOUNT_FOR_MAPPED_CUSTOMER
FAILED_TO_CREATE_EXCHANGE_SETTINGS
DUPLICATE_PRODUCT_TYPE
INVALID_SIGNUP_PRODUCT
UNKNOWN_PRODUCT
BAD_SITE_VERIFICATION_UPDATE_REQUEST
NO_EXCHANGE_ACCOUNT
SINGLE_SYNDICATION_PRODUCT
ACCOUNT_NOT_YET_READY
MULTIPLE_ADSENSE_ACCOUNTS_NOT_ALLOWED
MISSING_LEGAL_ENTITY_NAME
MISSING_ACTIVE_BILLING_PROFILE
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
FeatureError Errors related to feature management. If you attempt using a feature that is not available to the current network you'll receive a FeatureError with the missing feature as the trigger.
Enumerations
MISSING_FEATURE
A feature is being used that is not enabled on the current network.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
InternalApiError Indicates that a server-side error has occured. InternalApiErrors are generally not the result of an invalid request or message sent by the client.
Enumerations
UNEXPECTED_INTERNAL_API_ERROR
API encountered an unexpected internal error.
TRANSIENT_ERROR
A temporary error occurred during the request. Please retry.
UNKNOWN
The cause of the error is not known or only defined in newer versions.
DOWNTIME
The API is currently unavailable for a planned downtime.
ERROR_GENERATING_RESPONSE
Mutate succeeded but server was unable to build response. Client should not retry mutate.
InvalidEmailError Caused by supplying a value for an email attribute that is not a valid email address.
Enumerations
INVALID_FORMAT
The value is not a valid email address.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
InvalidUrlError Lists all errors associated with URLs.
Enumerations
ILLEGAL_CHARACTERS
The URL contains invalid characters.
INVALID_FORMAT
The format of the URL is not allowed. This could occur for a number of reasons. For example, if an invalid scheme is specified (like "ftp://") or if a port is specified when not required, or if a query was specified when not required.
INSECURE_SCHEME
URL contains insecure scheme.
NO_SCHEME
The URL does not contain a scheme.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
InventoryClientApiError ApiError for common exceptions thrown when accessing AdSense InventoryClient.
Enumerations
ACCESS_DENIED
ADSENSE_AUTH_ERROR
ADSENSE_RPC_ERROR
DOMAIN_NO_SCHEME
DOMAIN_INVALID_HOST
DOMAIN_INVALID_TLD
DOMAIN_ONE_STRING_AND_PUBLIC_SUFFIX
DOMAIN_INVALID_INPUT
DOMAIN_NO_PUBLIC_SUFFIX
UNKNOWN_ERROR
LabelEntityAssociationError Errors specific to creating label entity associations.
Enumerations
DUPLICATE_ASSOCIATION
The label has already been attached to the entity.
INVALID_ASSOCIATION
A label is being applied to an entity that does not support that entity type.
NEGATION_NOT_ALLOWED
Label negation cannot be applied to the entity type.
DUPLICATE_ASSOCIATION_WITH_NEGATION
The same label is being applied and negated to the same entity.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
NetworkError An error for a network.
Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
MULTI_CURRENCY_NOT_SUPPORTED
Multi-currency support is not enabled for this network. This is an Ad Manager 360 feature.
UNSUPPORTED_CURRENCY
Currency provided is not supported.
NETWORK_CURRENCY_CANNOT_BE_SAME_AS_SECONDARY
The network currency cannot also be specified as a secondary currency.
CANNOT_DELETE_CURRENCY_WITH_ACTIVE_RATE_CARDS
The currency cannot be deleted as it is still being used by active rate cards.
DELEGATION_CHILD_NETWORK_CANNOT_BECOME_A_PARENT
An MCM child network cannot become a parent network.
DELEGATION_PARENT_NETWORK_CANNOT_BECOME_A_CHILD
An MCM parent network cannot become a child of another network.
CANNOT_ADD_SAME_NETWORK_AS_DELEGATION_CHILD
In MCM, a network cannot become a parent of itself.
MAX_APPROVED_DELEGATION_CHILD_NETWORKS_EXCEEDED
The MCM parent network has exceeded the system limit of child networks.
MAX_PENDING_DELEGATION_CHILD_NETWORKS_EXCEEDED
The MCM parent network has exceeded the system limit of child networks pending approval.
CHILD_NETWORK_ALREADY_EXISTS
The network is already being managed by the parent network for MCM.
CHILD_NETWORK_CANNOT_BE_DISAPPROVED
A child network must not be disapproved.
IN_PARENT_DELEGATION_UNSUPPORTED_FOR_NETWORK
Only Ad Manager 360 networks are allowed to manage the inventory of other networks.
ERROR_REENABLING_AD_EXCHANGE_ON_MCM_CHILD
When an MCM child network self-signsup for ad exchange but disconnects from the parent, then tries to re-enable again, this indicates that there was an error in re-enabling ad exchange.
ERROR_SETTING_SITE_SERVING_MODE_ON_MCM_CHILD
The error shown when there is an issue setting the approved site serving field when re-enabling or disabling ad exchange on an MCM child.
NotNullError Caused by supplying a null value for an attribute that cannot be null.
Enumerations
ARG1_NULL
Assuming that a method will not have more than 3 arguments, if it does, return NULL
ARG2_NULL
ARG3_NULL
NULL
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
NullError Caused by supplying a non-null value for an attribute that should be null.
Enumerations
NOT_NULL
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
ParseError Lists errors related to parsing.
Enumerations
UNPARSABLE
Indicates an error in parsing an attribute.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
PermissionError Errors related to incorrect permission.
Enumerations
PERMISSION_DENIED
User does not have the required permission for the request.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
PublisherQueryLanguageContextError An error that occurs while executing a PQL query contained in a Statement object.
Enumerations
UNEXECUTABLE
Indicates that there was an error executing the PQL.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
PublisherQueryLanguageSyntaxError An error that occurs while parsing a PQL query contained in a Statement object.
Enumerations
UNPARSABLE
Indicates that there was a PQL syntax error.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
QuotaError Describes a client-side error on which a user is attempting to perform an action to which they have no quota remaining.
Enumerations
EXCEEDED_QUOTA
The number of requests made per second is too high and has exceeded the allowable limit. The recommended approach to handle this error is to wait about 5 seconds and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time.

Another way to mitigate this error is to limit requests to 8 per second for Ad Manager 360 accounts, or 2 per second for Ad Manager accounts. Once again this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error.

UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
REPORT_JOB_LIMIT
This user has exceeded the allowed number of new report requests per hour (this includes both reports run via the UI and reports run via ReportService.runReportJob). The recommended approach to handle this error is to wait about 10 minutes and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time.

Another way to mitigate this error is to limit the number of new report requests to 250 per hour per user. Once again, this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error.
RegExError Caused by supplying a value for an object attribute that does not conform to a documented valid regular expression.
Enumerations
INVALID
Invalid value found.
NULL
Null value found.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
RequiredCollectionError A list of all errors to be used for validating sizes of collections.
Enumerations
REQUIRED
A required collection is missing.
TOO_LARGE
Collection size is too large.
TOO_SMALL
Collection size is too small.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
RequiredError Errors due to missing required field.
Enumerations
REQUIRED
Missing required field.
RequiredNumberError A list of all errors to be used in conjunction with required number validators.
Enumerations
REQUIRED
TOO_LARGE
TOO_SMALL
TOO_LARGE_WITH_DETAILS
TOO_SMALL_WITH_DETAILS
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
ServerError Errors related to the server.
Enumerations
SERVER_ERROR
Indicates that an unexpected error occured.
SERVER_BUSY
Indicates that the server is currently experiencing a high load. Please wait and try your request again.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
SiteError Errors associated with the Site.
Enumerations
INVALID_CHILD_NETWORK_CODE
The network code must belong to an MCM child network.
CANNOT_ARCHIVE_SITE_WITH_SUBSITES
Archive all subsites before archiving the site.
INVALID_URL_FOR_SITE
The URL is invalid for a top-level site.
MULTIPLE_UPDATES_FOR_SAME_SITE
The batch of sites could not be updated because the same site was updated multiple times in the batch.
TOO_MANY_SITES_PER_REVIEW_REQUEST
Too many sites in the request to submit them for review.
TOO_MANY_REVIEW_REQUESTS_FOR_SITE
The site has been submitted for review too many times.
INVALID_APPROVAL_STATUS_FOR_REVIEW
Only sites with approval status ApprovalStatus.DRAFT, ApprovalStatus.DISAPPROVED and ApprovalStatus.REQUIRES_REVIEW can be submitted for review.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
StatementError An error that occurs while parsing Statement objects.
Enumerations
VARIABLE_NOT_BOUND_TO_VALUE
A bind variable has not been bound to a value.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
StringFormatError A list of error code for reporting invalid content of input strings.
Enumerations
UNKNOWN
ILLEGAL_CHARS
The input string value contains disallowed characters.
INVALID_FORMAT
The input string value is invalid for the associated field.
StringLengthError Errors for Strings which do not meet given length constraints.
Enumerations
TOO_LONG
TOO_SHORT
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
TeamError Errors related to a Team.
Enumerations
ENTITY_NOT_ON_USERS_TEAMS
User cannot use this entity because it is not on any of the user's teams.
AD_UNITS_NOT_ON_ORDER_TEAMS
The targeted or excluded ad unit must be on the order's teams.
PLACEMENTS_NOT_ON_ORDER_TEAMS
The targeted placement must be on the order's teams.
MISSING_USERS_TEAM
Entity cannot be created because it is not on any of the user's teams.
ALL_TEAM_ASSOCIATION_NOT_ALLOWED
A team that gives access to all entities of a given type cannot be associated with an entity of that type.
INVALID_TEAM_ASSIGNMENT
The assignment of team to entities is invalid.
CANNOT_UPDATE_INACTIVE_TEAM
Cannot modify or create a team with an inactive status.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
TypeError An error for a field which is an invalid type.
UniqueError An error for a field which must satisfy a uniqueness constraint