Web Service: CompanyService

Port type CompanyServiceInterfaceSource code

1. createCompanies
   Source code
   Description:
   Creates new {@link Company} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createCompaniesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createCompanies

   Creates new {@link Company} objects.

   • companies - optional, unbounded; type Company
     A {@code Company} represents an agency, a single advertiser or an entire advertising network.
     • id - optional; type long
       Uniquely identifies the {@code Company}. This value is read-only and is assigned by Google when the company is created. This attribute is required for updates.
     • name - optional; type string
       The full name of the company. This attribute is required and has a maximum length of 127 characters.
     • type - optional; type Company.Type - type string with restriction - enum { 'HOUSE_ADVERTISER', 'HOUSE_AGENCY', 'ADVERTISER', 'AGENCY', 'AD_NETWORK', 'PARTNER', 'CHILD_PUBLISHER', 'VIEWABILITY_PROVIDER', 'UNKNOWN' }
       Specifies what kind of company this is. This attribute is required.
     • address - optional; type string
       Specifies the address of the company. This attribute is optional and has a maximum length of 1024 characters.
     • email - optional; type string
       Specifies the email of the company. This attribute is optional and has a maximum length of 128 characters.
     • faxPhone - optional; type string
       Specifies the fax phone number of the company. This attribute is optional and has a maximum length of 63 characters.
     • primaryPhone - optional; type string
       Specifies the primary phone number of the company. This attribute is optional and has a maximum length of 63 characters.
     • externalId - optional; type string
       Specifies the external ID of the company. This attribute is optional and has a maximum length of 255 characters.
     • comment - optional; type string
       Specifies the comment of the company. This attribute is optional and has a maximum length of 1024 characters.
     • creditStatus - optional; type Company.CreditStatus - type string with restriction - enum { 'ACTIVE', 'ON_HOLD', 'CREDIT_STOP', 'INACTIVE', 'BLOCKED' }
       Specifies the company's credit status. This attribute is optional and defaults to {@link CreditStatus#ACTIVE} when basic credit status settings are enabled, and {@link CreditStatus#ON_HOLD} when advanced credit status settings are enabled.
     • appliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       The set of labels applied to this company.
     • primaryContactId - optional; type long
       The ID of the {@link Contact} who is acting as the primary contact for this company. This attribute is optional.
     • appliedTeamIds - optional, unbounded; type long
       The IDs of all teams that this company is on directly.
     • thirdPartyCompanyId - optional; type int
       Specifies the ID of the Google-recognized canonicalized form of this company. This attribute is optional.
     • lastModifiedDateTime - optional; type DateTime
       The date and time this company was last modified.
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • childPublisher - optional; type ChildPublisher
       A {@code ChildPublisher} represents a network being managed as part of Multiple Customer Management.
       • approvedDelegationType - optional; type DelegationType - type string with restriction - enum { 'UNKNOWN', 'MANAGE_ACCOUNT', 'MANAGE_INVENTORY' }
         Type of delegation the parent has been approved to have over the child. This field is read-only, and set to the proposed delegation type value {@code proposedDelegationType} upon approval by the child network. The value remains null if the parent network has not been approved.
       • proposedDelegationType - optional; type DelegationType - type string with restriction - enum { 'UNKNOWN', 'MANAGE_ACCOUNT', 'MANAGE_INVENTORY' }
         Type of delegation the parent has proposed to have over the child, pending approval of the child network. Set the value of this field to the delegation type you intend this network to have over the child network. Upon approval by the child network, its value is copied to {@code approvedDelegationType}, and {@code proposedDelegationType} is set to null.
       • status - optional; type DelegationStatus - type string with restriction - enum { 'UNKNOWN', 'APPROVED', 'PENDING', 'REJECTED', 'WITHDRAWN' }
         Status of the delegation relationship between parent and child.
       • accountStatus - optional; type AccountStatus - type string with restriction - enum { 'UNKNOWN', 'INVITED', 'DECLINED', 'PENDING_GOOGLE_APPROVAL', 'APPROVED', 'CLOSED_POLICY_VIOLATION', 'CLOSED_INVALID_ACTIVITY', 'CLOSED_BY_PUBLISHER', 'DISAPPROVED_INELIGIBLE', 'DISAPPROVED_DUPLICATE_ACCOUNT', 'EXPIRED', 'INACTIVE', 'DEACTIVATED_BY_AD_MANAGER' }
         Status of the child publisher's Ad Manager account based on {@code ChildPublisher#status} as well as Google's policy verification results. This field is read-only.
       • childNetworkCode - optional; type string
         Network code of child network.
       • sellerId - optional; type string
         The child publisher's seller ID, as specified in the parent publisher's sellers.json file.

         This field is only relevant for Manage Inventory child publishers.

       • proposedRevenueShareMillipercent - optional; type long
         The proposed revenue share that the parent publisher will receive in millipercentage (values 0 to 100000) for Manage Account proposals. For example, 15% is 15000 millipercent.

         For updates, this field is read-only. Use company actions to propose new revenue share agreements for existing MCM children. This field is ignored for Manage Inventory proposals.

       • onboardingTasks - optional, unbounded; type OnboardingTask - type string with restriction - enum { 'UNKNOWN', 'BILLING_PROFILE_CREATION', 'PHONE_PIN_VERIFICATION', 'AD_MANAGER_ACCOUNT_SETUP' }
         The child publisher's pending onboarding tasks.

         This will only be populated if the child publisher's {@code AccountStatus} is {@code PENDING_GOOGLE_APPROVAL}. This attribute is read-only.

       Info required for when Company Type is CHILD_PUBLISHER.
     • viewabilityProvider - optional; type ViewabilityProvider
       Info required for when Company Type is VIEWABILITY_PROVIDER.
       Information required for {@link Company} of Type VIEWABILITY_PROVIDER. It contains all of the data needed to capture viewability metrics.
       • vendorKey - optional; type string
         The key for this ad verification vendor.
       • verificationScriptUrl - optional; type string
         The URL that hosts the verification script for this vendor.
       • verificationParameters - optional; type string
         The parameters that will be passed to the verification script.
       • verificationRejectionTrackerUrl - optional; type string
         The URL that should be pinged if the verification script cannot be run.
   Output:
   createCompaniesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createCompaniesResponse

   • rval - optional, unbounded; type Company
     A {@code Company} represents an agency, a single advertiser or an entire advertising network.
     • id - optional; type long
       Uniquely identifies the {@code Company}. This value is read-only and is assigned by Google when the company is created. This attribute is required for updates.
     • name - optional; type string
       The full name of the company. This attribute is required and has a maximum length of 127 characters.
     • type - optional; type Company.Type - type string with restriction - enum { 'HOUSE_ADVERTISER', 'HOUSE_AGENCY', 'ADVERTISER', 'AGENCY', 'AD_NETWORK', 'PARTNER', 'CHILD_PUBLISHER', 'VIEWABILITY_PROVIDER', 'UNKNOWN' }
       Specifies what kind of company this is. This attribute is required.
     • address - optional; type string
       Specifies the address of the company. This attribute is optional and has a maximum length of 1024 characters.
     • email - optional; type string
       Specifies the email of the company. This attribute is optional and has a maximum length of 128 characters.
     • faxPhone - optional; type string
       Specifies the fax phone number of the company. This attribute is optional and has a maximum length of 63 characters.
     • primaryPhone - optional; type string
       Specifies the primary phone number of the company. This attribute is optional and has a maximum length of 63 characters.
     • externalId - optional; type string
       Specifies the external ID of the company. This attribute is optional and has a maximum length of 255 characters.
     • comment - optional; type string
       Specifies the comment of the company. This attribute is optional and has a maximum length of 1024 characters.
     • creditStatus - optional; type Company.CreditStatus - type string with restriction - enum { 'ACTIVE', 'ON_HOLD', 'CREDIT_STOP', 'INACTIVE', 'BLOCKED' }
       Specifies the company's credit status. This attribute is optional and defaults to {@link CreditStatus#ACTIVE} when basic credit status settings are enabled, and {@link CreditStatus#ON_HOLD} when advanced credit status settings are enabled.
     • appliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       The set of labels applied to this company.
     • primaryContactId - optional; type long
       The ID of the {@link Contact} who is acting as the primary contact for this company. This attribute is optional.
     • appliedTeamIds - optional, unbounded; type long
       The IDs of all teams that this company is on directly.
     • thirdPartyCompanyId - optional; type int
       Specifies the ID of the Google-recognized canonicalized form of this company. This attribute is optional.
     • lastModifiedDateTime - optional; type DateTime
       The date and time this company was last modified.
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • childPublisher - optional; type ChildPublisher
       A {@code ChildPublisher} represents a network being managed as part of Multiple Customer Management.
       • approvedDelegationType - optional; type DelegationType - type string with restriction - enum { 'UNKNOWN', 'MANAGE_ACCOUNT', 'MANAGE_INVENTORY' }
         Type of delegation the parent has been approved to have over the child. This field is read-only, and set to the proposed delegation type value {@code proposedDelegationType} upon approval by the child network. The value remains null if the parent network has not been approved.
       • proposedDelegationType - optional; type DelegationType - type string with restriction - enum { 'UNKNOWN', 'MANAGE_ACCOUNT', 'MANAGE_INVENTORY' }
         Type of delegation the parent has proposed to have over the child, pending approval of the child network. Set the value of this field to the delegation type you intend this network to have over the child network. Upon approval by the child network, its value is copied to {@code approvedDelegationType}, and {@code proposedDelegationType} is set to null.
       • status - optional; type DelegationStatus - type string with restriction - enum { 'UNKNOWN', 'APPROVED', 'PENDING', 'REJECTED', 'WITHDRAWN' }
         Status of the delegation relationship between parent and child.
       • accountStatus - optional; type AccountStatus - type string with restriction - enum { 'UNKNOWN', 'INVITED', 'DECLINED', 'PENDING_GOOGLE_APPROVAL', 'APPROVED', 'CLOSED_POLICY_VIOLATION', 'CLOSED_INVALID_ACTIVITY', 'CLOSED_BY_PUBLISHER', 'DISAPPROVED_INELIGIBLE', 'DISAPPROVED_DUPLICATE_ACCOUNT', 'EXPIRED', 'INACTIVE', 'DEACTIVATED_BY_AD_MANAGER' }
         Status of the child publisher's Ad Manager account based on {@code ChildPublisher#status} as well as Google's policy verification results. This field is read-only.
       • childNetworkCode - optional; type string
         Network code of child network.
       • sellerId - optional; type string
         The child publisher's seller ID, as specified in the parent publisher's sellers.json file.

         This field is only relevant for Manage Inventory child publishers.

       • proposedRevenueShareMillipercent - optional; type long
         The proposed revenue share that the parent publisher will receive in millipercentage (values 0 to 100000) for Manage Account proposals. For example, 15% is 15000 millipercent.

         For updates, this field is read-only. Use company actions to propose new revenue share agreements for existing MCM children. This field is ignored for Manage Inventory proposals.

       • onboardingTasks - optional, unbounded; type OnboardingTask - type string with restriction - enum { 'UNKNOWN', 'BILLING_PROFILE_CREATION', 'PHONE_PIN_VERIFICATION', 'AD_MANAGER_ACCOUNT_SETUP' }
         The child publisher's pending onboarding tasks.

         This will only be populated if the child publisher's {@code AccountStatus} is {@code PENDING_GOOGLE_APPROVAL}. This attribute is read-only.

       Info required for when Company Type is CHILD_PUBLISHER.
     • viewabilityProvider - optional; type ViewabilityProvider
       Info required for when Company Type is VIEWABILITY_PROVIDER.
       Information required for {@link Company} of Type VIEWABILITY_PROVIDER. It contains all of the data needed to capture viewability metrics.
       • vendorKey - optional; type string
         The key for this ad verification vendor.
       • verificationScriptUrl - optional; type string
         The URL that hosts the verification script for this vendor.
       • verificationParameters - optional; type string
         The parameters that will be passed to the verification script.
       • verificationRejectionTrackerUrl - optional; type string
         The URL that should be pinged if the verification script cannot be run.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
2. getCompaniesByStatement
   Source code
   Description:
   Gets a {@link CompanyPage} of {@link Company} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link Company#id}
   {@code name}	{@link Company#name}
   {@code type}	{@link Company#type}
   {@code lastModifiedDateTime}	{@link Company#lastModifiedDateTime}

   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getCompaniesByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getCompaniesByStatement

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

   PQL Property	Object Property
   {@code id}	{@link Company#id}
   {@code name}	{@link Company#name}
   {@code type}	{@link Company#type}
   {@code lastModifiedDateTime}	{@link Company#lastModifiedDateTime}

   • filterStatement - optional; type Statement
     Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

     An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

     Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

     An example of such a query might be {@code "WHERE id = :idValue"}.

     Statements also support use of the LIKE keyword. This provides wildcard string matching.

     An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

     The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
     • query - optional; type string
       Holds the query in PQL syntax. The syntax is:
       [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
       

       
            := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
       

     • values - optional, unbounded; type String_ValueMapEntry
       Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

       In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

       This represents an entry in a map with a key of type String and value of type Value.
       • key - optional; type string
       • value - optional; type Value
         {@code Value} represents a value.
   Output:
   getCompaniesByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getCompaniesByStatementResponse

   • rval - optional; type CompanyPage
     Captures a page of {@link Company} objects.
     • totalResultSetSize - optional; type int
       The size of the total result set to which this page belongs.
     • startIndex - optional; type int
       The absolute index in the total result set on which this page begins.
     • results - optional, unbounded; type Company
       A {@code Company} represents an agency, a single advertiser or an entire advertising network.
       • id - optional; type long
         Uniquely identifies the {@code Company}. This value is read-only and is assigned by Google when the company is created. This attribute is required for updates.
       • name - optional; type string
         The full name of the company. This attribute is required and has a maximum length of 127 characters.
       • type - optional; type Company.Type - type string with restriction - enum { 'HOUSE_ADVERTISER', 'HOUSE_AGENCY', 'ADVERTISER', 'AGENCY', 'AD_NETWORK', 'PARTNER', 'CHILD_PUBLISHER', 'VIEWABILITY_PROVIDER', 'UNKNOWN' }
         Specifies what kind of company this is. This attribute is required.
       • address - optional; type string
         Specifies the address of the company. This attribute is optional and has a maximum length of 1024 characters.
       • email - optional; type string
         Specifies the email of the company. This attribute is optional and has a maximum length of 128 characters.
       • faxPhone - optional; type string
         Specifies the fax phone number of the company. This attribute is optional and has a maximum length of 63 characters.
       • primaryPhone - optional; type string
         Specifies the primary phone number of the company. This attribute is optional and has a maximum length of 63 characters.
       • externalId - optional; type string
         Specifies the external ID of the company. This attribute is optional and has a maximum length of 255 characters.
       • comment - optional; type string
         Specifies the comment of the company. This attribute is optional and has a maximum length of 1024 characters.
       • creditStatus - optional; type Company.CreditStatus - type string with restriction - enum { 'ACTIVE', 'ON_HOLD', 'CREDIT_STOP', 'INACTIVE', 'BLOCKED' }
         Specifies the company's credit status. This attribute is optional and defaults to {@link CreditStatus#ACTIVE} when basic credit status settings are enabled, and {@link CreditStatus#ON_HOLD} when advanced credit status settings are enabled.
       • appliedLabels - optional, unbounded; type AppliedLabel
         Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
         • labelId - optional; type long
           The ID of a created {@link Label}.
         • isNegated - optional; type boolean
           {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
         The set of labels applied to this company.
       • primaryContactId - optional; type long
         The ID of the {@link Contact} who is acting as the primary contact for this company. This attribute is optional.
       • appliedTeamIds - optional, unbounded; type long
         The IDs of all teams that this company is on directly.
       • thirdPartyCompanyId - optional; type int
         Specifies the ID of the Google-recognized canonicalized form of this company. This attribute is optional.
       • lastModifiedDateTime - optional; type DateTime
         The date and time this company was last modified.
         Represents a date combined with the time of day.
         • date - optional; type Date
           Represents a date.
           • year - optional; type int
             Year (e.g., 2009)
           • month - optional; type int
             Month (1..12)
           • day - optional; type int
             Day (1..31)
         • hour - optional; type int
         • minute - optional; type int
         • second - optional; type int
         • timeZoneId - optional; type string
       • childPublisher - optional; type ChildPublisher
         A {@code ChildPublisher} represents a network being managed as part of Multiple Customer Management.
         • approvedDelegationType - optional; type DelegationType - type string with restriction - enum { 'UNKNOWN', 'MANAGE_ACCOUNT', 'MANAGE_INVENTORY' }
           Type of delegation the parent has been approved to have over the child. This field is read-only, and set to the proposed delegation type value {@code proposedDelegationType} upon approval by the child network. The value remains null if the parent network has not been approved.
         • proposedDelegationType - optional; type DelegationType - type string with restriction - enum { 'UNKNOWN', 'MANAGE_ACCOUNT', 'MANAGE_INVENTORY' }
           Type of delegation the parent has proposed to have over the child, pending approval of the child network. Set the value of this field to the delegation type you intend this network to have over the child network. Upon approval by the child network, its value is copied to {@code approvedDelegationType}, and {@code proposedDelegationType} is set to null.
         • status - optional; type DelegationStatus - type string with restriction - enum { 'UNKNOWN', 'APPROVED', 'PENDING', 'REJECTED', 'WITHDRAWN' }
           Status of the delegation relationship between parent and child.
         • accountStatus - optional; type AccountStatus - type string with restriction - enum { 'UNKNOWN', 'INVITED', 'DECLINED', 'PENDING_GOOGLE_APPROVAL', 'APPROVED', 'CLOSED_POLICY_VIOLATION', 'CLOSED_INVALID_ACTIVITY', 'CLOSED_BY_PUBLISHER', 'DISAPPROVED_INELIGIBLE', 'DISAPPROVED_DUPLICATE_ACCOUNT', 'EXPIRED', 'INACTIVE', 'DEACTIVATED_BY_AD_MANAGER' }
           Status of the child publisher's Ad Manager account based on {@code ChildPublisher#status} as well as Google's policy verification results. This field is read-only.
         • childNetworkCode - optional; type string
           Network code of child network.
         • sellerId - optional; type string
           The child publisher's seller ID, as specified in the parent publisher's sellers.json file.

           This field is only relevant for Manage Inventory child publishers.

         • proposedRevenueShareMillipercent - optional; type long
           The proposed revenue share that the parent publisher will receive in millipercentage (values 0 to 100000) for Manage Account proposals. For example, 15% is 15000 millipercent.

           For updates, this field is read-only. Use company actions to propose new revenue share agreements for existing MCM children. This field is ignored for Manage Inventory proposals.

         • onboardingTasks - optional, unbounded; type OnboardingTask - type string with restriction - enum { 'UNKNOWN', 'BILLING_PROFILE_CREATION', 'PHONE_PIN_VERIFICATION', 'AD_MANAGER_ACCOUNT_SETUP' }
           The child publisher's pending onboarding tasks.

           This will only be populated if the child publisher's {@code AccountStatus} is {@code PENDING_GOOGLE_APPROVAL}. This attribute is read-only.

         Info required for when Company Type is CHILD_PUBLISHER.
       • viewabilityProvider - optional; type ViewabilityProvider
         Info required for when Company Type is VIEWABILITY_PROVIDER.
         Information required for {@link Company} of Type VIEWABILITY_PROVIDER. It contains all of the data needed to capture viewability metrics.
         • vendorKey - optional; type string
           The key for this ad verification vendor.
         • verificationScriptUrl - optional; type string
           The URL that hosts the verification script for this vendor.
         • verificationParameters - optional; type string
           The parameters that will be passed to the verification script.
         • verificationRejectionTrackerUrl - optional; type string
           The URL that should be pinged if the verification script cannot be run.
       The collection of companies contained within this page.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
3. performCompanyAction
   Source code
   Description:
   Performs actions on {@link Company} objects that match the given {@code Statement}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performCompanyActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performCompanyAction

   Performs actions on {@link Company} objects that match the given {@code Statement}.

   • companyAction - optional; type CompanyAction
     Represents the actions that can be performed on {@code Company} objects.
     • statement - optional; type Statement
       Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

       An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

       Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

       An example of such a query might be {@code "WHERE id = :idValue"}.

       Statements also support use of the LIKE keyword. This provides wildcard string matching.

       An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

       The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
       • query - optional; type string
         Holds the query in PQL syntax. The syntax is:
         [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
         

         
              := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
         

       • values - optional, unbounded; type String_ValueMapEntry
         Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

         In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

         This represents an entry in a map with a key of type String and value of type Value.
         • key - optional; type string
         • value - optional; type Value
           {@code Value} represents a value.
   Output:
   performCompanyActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type performCompanyActionResponse

   • rval - optional; type UpdateResult
     Represents the result of performing an action on objects.
     • numChanges - optional; type int
       The number of objects that were changed as a result of performing the action.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
4. updateCompanies
   Source code
   Description:
   Updates the specified {@link Company} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateCompaniesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateCompanies

   Updates the specified {@link Company} objects.

   • companies - optional, unbounded; type Company
     A {@code Company} represents an agency, a single advertiser or an entire advertising network.
     • id - optional; type long
       Uniquely identifies the {@code Company}. This value is read-only and is assigned by Google when the company is created. This attribute is required for updates.
     • name - optional; type string
       The full name of the company. This attribute is required and has a maximum length of 127 characters.
     • type - optional; type Company.Type - type string with restriction - enum { 'HOUSE_ADVERTISER', 'HOUSE_AGENCY', 'ADVERTISER', 'AGENCY', 'AD_NETWORK', 'PARTNER', 'CHILD_PUBLISHER', 'VIEWABILITY_PROVIDER', 'UNKNOWN' }
       Specifies what kind of company this is. This attribute is required.
     • address - optional; type string
       Specifies the address of the company. This attribute is optional and has a maximum length of 1024 characters.
     • email - optional; type string
       Specifies the email of the company. This attribute is optional and has a maximum length of 128 characters.
     • faxPhone - optional; type string
       Specifies the fax phone number of the company. This attribute is optional and has a maximum length of 63 characters.
     • primaryPhone - optional; type string
       Specifies the primary phone number of the company. This attribute is optional and has a maximum length of 63 characters.
     • externalId - optional; type string
       Specifies the external ID of the company. This attribute is optional and has a maximum length of 255 characters.
     • comment - optional; type string
       Specifies the comment of the company. This attribute is optional and has a maximum length of 1024 characters.
     • creditStatus - optional; type Company.CreditStatus - type string with restriction - enum { 'ACTIVE', 'ON_HOLD', 'CREDIT_STOP', 'INACTIVE', 'BLOCKED' }
       Specifies the company's credit status. This attribute is optional and defaults to {@link CreditStatus#ACTIVE} when basic credit status settings are enabled, and {@link CreditStatus#ON_HOLD} when advanced credit status settings are enabled.
     • appliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       The set of labels applied to this company.
     • primaryContactId - optional; type long
       The ID of the {@link Contact} who is acting as the primary contact for this company. This attribute is optional.
     • appliedTeamIds - optional, unbounded; type long
       The IDs of all teams that this company is on directly.
     • thirdPartyCompanyId - optional; type int
       Specifies the ID of the Google-recognized canonicalized form of this company. This attribute is optional.
     • lastModifiedDateTime - optional; type DateTime
       The date and time this company was last modified.
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • childPublisher - optional; type ChildPublisher
       A {@code ChildPublisher} represents a network being managed as part of Multiple Customer Management.
       • approvedDelegationType - optional; type DelegationType - type string with restriction - enum { 'UNKNOWN', 'MANAGE_ACCOUNT', 'MANAGE_INVENTORY' }
         Type of delegation the parent has been approved to have over the child. This field is read-only, and set to the proposed delegation type value {@code proposedDelegationType} upon approval by the child network. The value remains null if the parent network has not been approved.
       • proposedDelegationType - optional; type DelegationType - type string with restriction - enum { 'UNKNOWN', 'MANAGE_ACCOUNT', 'MANAGE_INVENTORY' }
         Type of delegation the parent has proposed to have over the child, pending approval of the child network. Set the value of this field to the delegation type you intend this network to have over the child network. Upon approval by the child network, its value is copied to {@code approvedDelegationType}, and {@code proposedDelegationType} is set to null.
       • status - optional; type DelegationStatus - type string with restriction - enum { 'UNKNOWN', 'APPROVED', 'PENDING', 'REJECTED', 'WITHDRAWN' }
         Status of the delegation relationship between parent and child.
       • accountStatus - optional; type AccountStatus - type string with restriction - enum { 'UNKNOWN', 'INVITED', 'DECLINED', 'PENDING_GOOGLE_APPROVAL', 'APPROVED', 'CLOSED_POLICY_VIOLATION', 'CLOSED_INVALID_ACTIVITY', 'CLOSED_BY_PUBLISHER', 'DISAPPROVED_INELIGIBLE', 'DISAPPROVED_DUPLICATE_ACCOUNT', 'EXPIRED', 'INACTIVE', 'DEACTIVATED_BY_AD_MANAGER' }
         Status of the child publisher's Ad Manager account based on {@code ChildPublisher#status} as well as Google's policy verification results. This field is read-only.
       • childNetworkCode - optional; type string
         Network code of child network.
       • sellerId - optional; type string
         The child publisher's seller ID, as specified in the parent publisher's sellers.json file.

         This field is only relevant for Manage Inventory child publishers.

       • proposedRevenueShareMillipercent - optional; type long
         The proposed revenue share that the parent publisher will receive in millipercentage (values 0 to 100000) for Manage Account proposals. For example, 15% is 15000 millipercent.

         For updates, this field is read-only. Use company actions to propose new revenue share agreements for existing MCM children. This field is ignored for Manage Inventory proposals.

       • onboardingTasks - optional, unbounded; type OnboardingTask - type string with restriction - enum { 'UNKNOWN', 'BILLING_PROFILE_CREATION', 'PHONE_PIN_VERIFICATION', 'AD_MANAGER_ACCOUNT_SETUP' }
         The child publisher's pending onboarding tasks.

         This will only be populated if the child publisher's {@code AccountStatus} is {@code PENDING_GOOGLE_APPROVAL}. This attribute is read-only.

       Info required for when Company Type is CHILD_PUBLISHER.
     • viewabilityProvider - optional; type ViewabilityProvider
       Info required for when Company Type is VIEWABILITY_PROVIDER.
       Information required for {@link Company} of Type VIEWABILITY_PROVIDER. It contains all of the data needed to capture viewability metrics.
       • vendorKey - optional; type string
         The key for this ad verification vendor.
       • verificationScriptUrl - optional; type string
         The URL that hosts the verification script for this vendor.
       • verificationParameters - optional; type string
         The parameters that will be passed to the verification script.
       • verificationRejectionTrackerUrl - optional; type string
         The URL that should be pinged if the verification script cannot be run.
   Output:
   updateCompaniesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateCompaniesResponse

   • rval - optional, unbounded; type Company
     A {@code Company} represents an agency, a single advertiser or an entire advertising network.
     • id - optional; type long
       Uniquely identifies the {@code Company}. This value is read-only and is assigned by Google when the company is created. This attribute is required for updates.
     • name - optional; type string
       The full name of the company. This attribute is required and has a maximum length of 127 characters.
     • type - optional; type Company.Type - type string with restriction - enum { 'HOUSE_ADVERTISER', 'HOUSE_AGENCY', 'ADVERTISER', 'AGENCY', 'AD_NETWORK', 'PARTNER', 'CHILD_PUBLISHER', 'VIEWABILITY_PROVIDER', 'UNKNOWN' }
       Specifies what kind of company this is. This attribute is required.
     • address - optional; type string
       Specifies the address of the company. This attribute is optional and has a maximum length of 1024 characters.
     • email - optional; type string
       Specifies the email of the company. This attribute is optional and has a maximum length of 128 characters.
     • faxPhone - optional; type string
       Specifies the fax phone number of the company. This attribute is optional and has a maximum length of 63 characters.
     • primaryPhone - optional; type string
       Specifies the primary phone number of the company. This attribute is optional and has a maximum length of 63 characters.
     • externalId - optional; type string
       Specifies the external ID of the company. This attribute is optional and has a maximum length of 255 characters.
     • comment - optional; type string
       Specifies the comment of the company. This attribute is optional and has a maximum length of 1024 characters.
     • creditStatus - optional; type Company.CreditStatus - type string with restriction - enum { 'ACTIVE', 'ON_HOLD', 'CREDIT_STOP', 'INACTIVE', 'BLOCKED' }
       Specifies the company's credit status. This attribute is optional and defaults to {@link CreditStatus#ACTIVE} when basic credit status settings are enabled, and {@link CreditStatus#ON_HOLD} when advanced credit status settings are enabled.
     • appliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       The set of labels applied to this company.
     • primaryContactId - optional; type long
       The ID of the {@link Contact} who is acting as the primary contact for this company. This attribute is optional.
     • appliedTeamIds - optional, unbounded; type long
       The IDs of all teams that this company is on directly.
     • thirdPartyCompanyId - optional; type int
       Specifies the ID of the Google-recognized canonicalized form of this company. This attribute is optional.
     • lastModifiedDateTime - optional; type DateTime
       The date and time this company was last modified.
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • childPublisher - optional; type ChildPublisher
       A {@code ChildPublisher} represents a network being managed as part of Multiple Customer Management.
       • approvedDelegationType - optional; type DelegationType - type string with restriction - enum { 'UNKNOWN', 'MANAGE_ACCOUNT', 'MANAGE_INVENTORY' }
         Type of delegation the parent has been approved to have over the child. This field is read-only, and set to the proposed delegation type value {@code proposedDelegationType} upon approval by the child network. The value remains null if the parent network has not been approved.
       • proposedDelegationType - optional; type DelegationType - type string with restriction - enum { 'UNKNOWN', 'MANAGE_ACCOUNT', 'MANAGE_INVENTORY' }
         Type of delegation the parent has proposed to have over the child, pending approval of the child network. Set the value of this field to the delegation type you intend this network to have over the child network. Upon approval by the child network, its value is copied to {@code approvedDelegationType}, and {@code proposedDelegationType} is set to null.
       • status - optional; type DelegationStatus - type string with restriction - enum { 'UNKNOWN', 'APPROVED', 'PENDING', 'REJECTED', 'WITHDRAWN' }
         Status of the delegation relationship between parent and child.
       • accountStatus - optional; type AccountStatus - type string with restriction - enum { 'UNKNOWN', 'INVITED', 'DECLINED', 'PENDING_GOOGLE_APPROVAL', 'APPROVED', 'CLOSED_POLICY_VIOLATION', 'CLOSED_INVALID_ACTIVITY', 'CLOSED_BY_PUBLISHER', 'DISAPPROVED_INELIGIBLE', 'DISAPPROVED_DUPLICATE_ACCOUNT', 'EXPIRED', 'INACTIVE', 'DEACTIVATED_BY_AD_MANAGER' }
         Status of the child publisher's Ad Manager account based on {@code ChildPublisher#status} as well as Google's policy verification results. This field is read-only.
       • childNetworkCode - optional; type string
         Network code of child network.
       • sellerId - optional; type string
         The child publisher's seller ID, as specified in the parent publisher's sellers.json file.

         This field is only relevant for Manage Inventory child publishers.

       • proposedRevenueShareMillipercent - optional; type long
         The proposed revenue share that the parent publisher will receive in millipercentage (values 0 to 100000) for Manage Account proposals. For example, 15% is 15000 millipercent.

         For updates, this field is read-only. Use company actions to propose new revenue share agreements for existing MCM children. This field is ignored for Manage Inventory proposals.

       • onboardingTasks - optional, unbounded; type OnboardingTask - type string with restriction - enum { 'UNKNOWN', 'BILLING_PROFILE_CREATION', 'PHONE_PIN_VERIFICATION', 'AD_MANAGER_ACCOUNT_SETUP' }
         The child publisher's pending onboarding tasks.

         This will only be populated if the child publisher's {@code AccountStatus} is {@code PENDING_GOOGLE_APPROVAL}. This attribute is read-only.

       Info required for when Company Type is CHILD_PUBLISHER.
     • viewabilityProvider - optional; type ViewabilityProvider
       Info required for when Company Type is VIEWABILITY_PROVIDER.
       Information required for {@link Company} of Type VIEWABILITY_PROVIDER. It contains all of the data needed to capture viewability metrics.
       • vendorKey - optional; type string
         The key for this ad verification vendor.
       • verificationScriptUrl - optional; type string
         The URL that hosts the verification script for this vendor.
       • verificationParameters - optional; type string
         The parameters that will be passed to the verification script.
       • verificationRejectionTrackerUrl - optional; type string
         The URL that should be pinged if the verification script cannot be run.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.