+ invitations()
+
Returns the invitations Resource.
+ +
+ users()
+
Returns the users Resource.
+ +
+ create(accountId=None, body, x__xgafv=None)
Creates a new client buyer.
+
+ get(accountId, clientAccountId, x__xgafv=None)
Gets a client buyer with a given client account ID.
+
+ list(accountId, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the clients for the current sponsor buyer.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ update(accountId=None, clientAccountId, body, x__xgafv=None)
Updates an existing client buyer.
+create(accountId=None, body, x__xgafv=None)
+ Creates a new client buyer.
+
+Args:
+ accountId: string, Unique numerical account ID for the buyer of which the client buyer
+is a customer; the sponsor buyer to create a client for. (required) (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A client resource represents a client buyer—an agency,
+ # a brand, or an advertiser customer of the sponsor buyer.
+ # Users associated with the client buyer have restricted access to
+ # the Ad Exchange Marketplace and certain other sections
+ # of the Ad Exchange Buyer UI based on the role
+ # granted to the client buyer.
+ # All fields are required unless otherwise specified.
+ "status": "A String", # The status of the client buyer.
+ "clientAccountId": "A String", # The globally-unique numerical ID of the client.
+ # The value of this field is ignored in create and update operations.
+ "entityName": "A String", # The name of the entity. This field is automatically fetched based on
+ # the type and ID.
+ # The value of this field is ignored in create and update operations.
+ "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
+ "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
+ # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
+ # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
+ "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
+ "entityId": "A String", # Numerical identifier of the client entity.
+ # The entity can be an advertiser, a brand, or an agency.
+ # This identifier is unique among all the entities with the same type.
+ #
+ # A list of all known advertisers with their identifiers is available in the
+ # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
+ # file.
+ #
+ # A list of all known brands with their identifiers is available in the
+ # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
+ # file.
+ #
+ # A list of all known agencies with their identifiers is available in the
+ # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
+ # file.
+ "clientName": "A String", # Name used to represent this client to publishers.
+ # You may have multiple clients that map to the same entity,
+ # but for each client the combination of `clientName` and entity
+ # must be unique.
+ # You can specify this field as empty.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client resource represents a client buyer—an agency,
+ # a brand, or an advertiser customer of the sponsor buyer.
+ # Users associated with the client buyer have restricted access to
+ # the Ad Exchange Marketplace and certain other sections
+ # of the Ad Exchange Buyer UI based on the role
+ # granted to the client buyer.
+ # All fields are required unless otherwise specified.
+ "status": "A String", # The status of the client buyer.
+ "clientAccountId": "A String", # The globally-unique numerical ID of the client.
+ # The value of this field is ignored in create and update operations.
+ "entityName": "A String", # The name of the entity. This field is automatically fetched based on
+ # the type and ID.
+ # The value of this field is ignored in create and update operations.
+ "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
+ "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
+ # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
+ # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
+ "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
+ "entityId": "A String", # Numerical identifier of the client entity.
+ # The entity can be an advertiser, a brand, or an agency.
+ # This identifier is unique among all the entities with the same type.
+ #
+ # A list of all known advertisers with their identifiers is available in the
+ # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
+ # file.
+ #
+ # A list of all known brands with their identifiers is available in the
+ # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
+ # file.
+ #
+ # A list of all known agencies with their identifiers is available in the
+ # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
+ # file.
+ "clientName": "A String", # Name used to represent this client to publishers.
+ # You may have multiple clients that map to the same entity,
+ # but for each client the combination of `clientName` and entity
+ # must be unique.
+ # You can specify this field as empty.
+ }
+get(accountId, clientAccountId, x__xgafv=None)
+ Gets a client buyer with a given client account ID.
+
+Args:
+ accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
+ clientAccountId: string, Numerical account ID of the client buyer to retrieve. (required) (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client resource represents a client buyer—an agency,
+ # a brand, or an advertiser customer of the sponsor buyer.
+ # Users associated with the client buyer have restricted access to
+ # the Ad Exchange Marketplace and certain other sections
+ # of the Ad Exchange Buyer UI based on the role
+ # granted to the client buyer.
+ # All fields are required unless otherwise specified.
+ "status": "A String", # The status of the client buyer.
+ "clientAccountId": "A String", # The globally-unique numerical ID of the client.
+ # The value of this field is ignored in create and update operations.
+ "entityName": "A String", # The name of the entity. This field is automatically fetched based on
+ # the type and ID.
+ # The value of this field is ignored in create and update operations.
+ "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
+ "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
+ # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
+ # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
+ "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
+ "entityId": "A String", # Numerical identifier of the client entity.
+ # The entity can be an advertiser, a brand, or an agency.
+ # This identifier is unique among all the entities with the same type.
+ #
+ # A list of all known advertisers with their identifiers is available in the
+ # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
+ # file.
+ #
+ # A list of all known brands with their identifiers is available in the
+ # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
+ # file.
+ #
+ # A list of all known agencies with their identifiers is available in the
+ # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
+ # file.
+ "clientName": "A String", # Name used to represent this client to publishers.
+ # You may have multiple clients that map to the same entity,
+ # but for each client the combination of `clientName` and entity
+ # must be unique.
+ # You can specify this field as empty.
+ }
+list(accountId, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all the clients for the current sponsor buyer.
+
+Args:
+ accountId: string, Unique numerical account ID of the sponsor buyer to list the clients for. (required)
+ pageSize: integer, Requested page size. The server may return fewer clients than requested.
+If unspecified, the server will pick an appropriate default.
+ pageToken: string, A token identifying a page of results the server should return.
+Typically, this is the value of
+ListClientsResponse.nextPageToken
+returned from the previous call to the
+accounts.clients.list method.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # A token to retrieve the next page of results.
+ # Pass this value in the
+ # ListClientsRequest.pageToken
+ # field in the subsequent call to the
+ # accounts.clients.list method
+ # to retrieve the next page of results.
+ "clients": [ # The returned list of clients.
+ { # A client resource represents a client buyer—an agency,
+ # a brand, or an advertiser customer of the sponsor buyer.
+ # Users associated with the client buyer have restricted access to
+ # the Ad Exchange Marketplace and certain other sections
+ # of the Ad Exchange Buyer UI based on the role
+ # granted to the client buyer.
+ # All fields are required unless otherwise specified.
+ "status": "A String", # The status of the client buyer.
+ "clientAccountId": "A String", # The globally-unique numerical ID of the client.
+ # The value of this field is ignored in create and update operations.
+ "entityName": "A String", # The name of the entity. This field is automatically fetched based on
+ # the type and ID.
+ # The value of this field is ignored in create and update operations.
+ "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
+ "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
+ # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
+ # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
+ "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
+ "entityId": "A String", # Numerical identifier of the client entity.
+ # The entity can be an advertiser, a brand, or an agency.
+ # This identifier is unique among all the entities with the same type.
+ #
+ # A list of all known advertisers with their identifiers is available in the
+ # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
+ # file.
+ #
+ # A list of all known brands with their identifiers is available in the
+ # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
+ # file.
+ #
+ # A list of all known agencies with their identifiers is available in the
+ # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
+ # file.
+ "clientName": "A String", # Name used to represent this client to publishers.
+ # You may have multiple clients that map to the same entity,
+ # but for each client the combination of `clientName` and entity
+ # must be unique.
+ # You can specify this field as empty.
+ },
+ ],
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
update(accountId=None, clientAccountId, body, x__xgafv=None)
+ Updates an existing client buyer.
+
+Args:
+ accountId: string, Unique numerical account ID for the buyer of which the client buyer
+is a customer; the sponsor buyer to update a client for. (required) (required)
+ clientAccountId: string, Unique numerical account ID of the client to update. (required) (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A client resource represents a client buyer—an agency,
+ # a brand, or an advertiser customer of the sponsor buyer.
+ # Users associated with the client buyer have restricted access to
+ # the Ad Exchange Marketplace and certain other sections
+ # of the Ad Exchange Buyer UI based on the role
+ # granted to the client buyer.
+ # All fields are required unless otherwise specified.
+ "status": "A String", # The status of the client buyer.
+ "clientAccountId": "A String", # The globally-unique numerical ID of the client.
+ # The value of this field is ignored in create and update operations.
+ "entityName": "A String", # The name of the entity. This field is automatically fetched based on
+ # the type and ID.
+ # The value of this field is ignored in create and update operations.
+ "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
+ "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
+ # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
+ # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
+ "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
+ "entityId": "A String", # Numerical identifier of the client entity.
+ # The entity can be an advertiser, a brand, or an agency.
+ # This identifier is unique among all the entities with the same type.
+ #
+ # A list of all known advertisers with their identifiers is available in the
+ # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
+ # file.
+ #
+ # A list of all known brands with their identifiers is available in the
+ # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
+ # file.
+ #
+ # A list of all known agencies with their identifiers is available in the
+ # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
+ # file.
+ "clientName": "A String", # Name used to represent this client to publishers.
+ # You may have multiple clients that map to the same entity,
+ # but for each client the combination of `clientName` and entity
+ # must be unique.
+ # You can specify this field as empty.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client resource represents a client buyer—an agency,
+ # a brand, or an advertiser customer of the sponsor buyer.
+ # Users associated with the client buyer have restricted access to
+ # the Ad Exchange Marketplace and certain other sections
+ # of the Ad Exchange Buyer UI based on the role
+ # granted to the client buyer.
+ # All fields are required unless otherwise specified.
+ "status": "A String", # The status of the client buyer.
+ "clientAccountId": "A String", # The globally-unique numerical ID of the client.
+ # The value of this field is ignored in create and update operations.
+ "entityName": "A String", # The name of the entity. This field is automatically fetched based on
+ # the type and ID.
+ # The value of this field is ignored in create and update operations.
+ "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
+ "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
+ # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
+ # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
+ "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
+ "entityId": "A String", # Numerical identifier of the client entity.
+ # The entity can be an advertiser, a brand, or an agency.
+ # This identifier is unique among all the entities with the same type.
+ #
+ # A list of all known advertisers with their identifiers is available in the
+ # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
+ # file.
+ #
+ # A list of all known brands with their identifiers is available in the
+ # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
+ # file.
+ #
+ # A list of all known agencies with their identifiers is available in the
+ # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
+ # file.
+ "clientName": "A String", # Name used to represent this client to publishers.
+ # You may have multiple clients that map to the same entity,
+ # but for each client the combination of `clientName` and entity
+ # must be unique.
+ # You can specify this field as empty.
+ }
+
+ create(accountId, clientAccountId=None, body, x__xgafv=None)
Creates and sends out an email invitation to access
+
+ get(accountId, clientAccountId=None, invitationId, x__xgafv=None)
Retrieves an existing client user invitation.
+
+ list(accountId, clientAccountId=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the client users invitations for a client
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+create(accountId, clientAccountId=None, body, x__xgafv=None)
+ Creates and sends out an email invitation to access
+an Ad Exchange client buyer account.
+
+Args:
+ accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
+ clientAccountId: string, Numerical account ID of the client buyer that the user
+should be associated with. (required) (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An invitation for a new client user to get access to the AdExchange Buyer UI.
+ #
+ # All fields are required unless otherwise specified.
+ "clientAccountId": "A String", # Numerical account ID of the client buyer
+ # that the invited user is associated with.
+ # The value of this field is ignored in create operations.
+ "email": "A String", # The email address to which the invitation is sent. Email
+ # addresses should be unique among all client users under each sponsor
+ # buyer.
+ "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
+ # The value of this field is ignored in create operations.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An invitation for a new client user to get access to the AdExchange Buyer UI.
+ #
+ # All fields are required unless otherwise specified.
+ "clientAccountId": "A String", # Numerical account ID of the client buyer
+ # that the invited user is associated with.
+ # The value of this field is ignored in create operations.
+ "email": "A String", # The email address to which the invitation is sent. Email
+ # addresses should be unique among all client users under each sponsor
+ # buyer.
+ "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
+ # The value of this field is ignored in create operations.
+ }
+get(accountId, clientAccountId=None, invitationId, x__xgafv=None)
+ Retrieves an existing client user invitation.
+
+Args:
+ accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
+ clientAccountId: string, Numerical account ID of the client buyer that the user invitation
+to be retrieved is associated with. (required) (required)
+ invitationId: string, Numerical identifier of the user invitation to retrieve. (required) (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An invitation for a new client user to get access to the AdExchange Buyer UI.
+ #
+ # All fields are required unless otherwise specified.
+ "clientAccountId": "A String", # Numerical account ID of the client buyer
+ # that the invited user is associated with.
+ # The value of this field is ignored in create operations.
+ "email": "A String", # The email address to which the invitation is sent. Email
+ # addresses should be unique among all client users under each sponsor
+ # buyer.
+ "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
+ # The value of this field is ignored in create operations.
+ }
+list(accountId, clientAccountId=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all the client users invitations for a client
+with a given account ID.
+
+Args:
+ accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
+ clientAccountId: string, Numerical account ID of the client buyer to list invitations for.
+(required)
+You must either specify a string representation of a
+numerical account identifier or the `-` character
+to list all the invitations for all the clients
+of a given sponsor buyer. (required)
+ pageSize: integer, Requested page size. Server may return fewer clients than requested.
+If unspecified, server will pick an appropriate default.
+ pageToken: string, A token identifying a page of results the server should return.
+Typically, this is the value of
+ListClientUserInvitationsResponse.nextPageToken
+returned from the previous call to the
+clients.invitations.list
+method.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # A token to retrieve the next page of results.
+ # Pass this value in the
+ # ListClientUserInvitationsRequest.pageToken
+ # field in the subsequent call to the
+ # clients.invitations.list
+ # method to retrieve the next
+ # page of results.
+ "invitations": [ # The returned list of client users.
+ { # An invitation for a new client user to get access to the AdExchange Buyer UI.
+ #
+ # All fields are required unless otherwise specified.
+ "clientAccountId": "A String", # Numerical account ID of the client buyer
+ # that the invited user is associated with.
+ # The value of this field is ignored in create operations.
+ "email": "A String", # The email address to which the invitation is sent. Email
+ # addresses should be unique among all client users under each sponsor
+ # buyer.
+ "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
+ # The value of this field is ignored in create operations.
+ },
+ ],
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ get(accountId, clientAccountId=None, userId, x__xgafv=None)
Retrieves an existing client user.
+
+ list(accountId=None, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the known client users for a specified
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ update(accountId, clientAccountId=None, userId, body, x__xgafv=None)
Updates an existing client user.
+get(accountId, clientAccountId=None, userId, x__xgafv=None)
+ Retrieves an existing client user.
+
+Args:
+ accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
+ clientAccountId: string, Numerical account ID of the client buyer
+that the user to be retrieved is associated with. (required) (required)
+ userId: string, Numerical identifier of the user to retrieve. (required) (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client user is created under a client buyer and has restricted access to
+ # the Ad Exchange Marketplace and certain other sections
+ # of the Ad Exchange Buyer UI based on the role
+ # granted to the associated client buyer.
+ #
+ # The only way a new client user can be created is via accepting an
+ # email invitation
+ # (see the
+ # accounts.clients.invitations.create
+ # method).
+ #
+ # All fields are required unless otherwise specified.
+ "status": "A String", # The status of the client user.
+ "clientAccountId": "A String", # Numerical account ID of the client buyer
+ # with which the user is associated; the
+ # buyer must be a client of the current sponsor buyer.
+ # The value of this field is ignored in an update operation.
+ "userId": "A String", # The unique numerical ID of the client user
+ # that has accepted an invitation.
+ # The value of this field is ignored in an update operation.
+ "email": "A String", # User's email address. The value of this field
+ # is ignored in an update operation.
+ }
+list(accountId=None, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all the known client users for a specified
+sponsor buyer account ID.
+
+Args:
+ accountId: string, Numerical account ID of the sponsor buyer of the client to list users for.
+(required) (required)
+ clientAccountId: string, The account ID of the client buyer to list users for. (required)
+You must specify either a string representation of a
+numerical account identifier or the `-` character
+to list all the client users for all the clients
+of a given sponsor buyer. (required)
+ pageSize: integer, Requested page size. The server may return fewer clients than requested.
+If unspecified, the server will pick an appropriate default.
+ pageToken: string, A token identifying a page of results the server should return.
+Typically, this is the value of
+ListClientUsersResponse.nextPageToken
+returned from the previous call to the
+accounts.clients.users.list method.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "nextPageToken": "A String", # A token to retrieve the next page of results.
+ # Pass this value in the
+ # ListClientUsersRequest.pageToken
+ # field in the subsequent call to the
+ # clients.invitations.list
+ # method to retrieve the next
+ # page of results.
+ "users": [ # The returned list of client users.
+ { # A client user is created under a client buyer and has restricted access to
+ # the Ad Exchange Marketplace and certain other sections
+ # of the Ad Exchange Buyer UI based on the role
+ # granted to the associated client buyer.
+ #
+ # The only way a new client user can be created is via accepting an
+ # email invitation
+ # (see the
+ # accounts.clients.invitations.create
+ # method).
+ #
+ # All fields are required unless otherwise specified.
+ "status": "A String", # The status of the client user.
+ "clientAccountId": "A String", # Numerical account ID of the client buyer
+ # with which the user is associated; the
+ # buyer must be a client of the current sponsor buyer.
+ # The value of this field is ignored in an update operation.
+ "userId": "A String", # The unique numerical ID of the client user
+ # that has accepted an invitation.
+ # The value of this field is ignored in an update operation.
+ "email": "A String", # User's email address. The value of this field
+ # is ignored in an update operation.
+ },
+ ],
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
update(accountId, clientAccountId=None, userId, body, x__xgafv=None)
+ Updates an existing client user.
+Only the user status can be changed on update.
+
+Args:
+ accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
+ clientAccountId: string, Numerical account ID of the client buyer that the user to be retrieved
+is associated with. (required) (required)
+ userId: string, Numerical identifier of the user to retrieve. (required) (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A client user is created under a client buyer and has restricted access to
+ # the Ad Exchange Marketplace and certain other sections
+ # of the Ad Exchange Buyer UI based on the role
+ # granted to the associated client buyer.
+ #
+ # The only way a new client user can be created is via accepting an
+ # email invitation
+ # (see the
+ # accounts.clients.invitations.create
+ # method).
+ #
+ # All fields are required unless otherwise specified.
+ "status": "A String", # The status of the client user.
+ "clientAccountId": "A String", # Numerical account ID of the client buyer
+ # with which the user is associated; the
+ # buyer must be a client of the current sponsor buyer.
+ # The value of this field is ignored in an update operation.
+ "userId": "A String", # The unique numerical ID of the client user
+ # that has accepted an invitation.
+ # The value of this field is ignored in an update operation.
+ "email": "A String", # User's email address. The value of this field
+ # is ignored in an update operation.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client user is created under a client buyer and has restricted access to
+ # the Ad Exchange Marketplace and certain other sections
+ # of the Ad Exchange Buyer UI based on the role
+ # granted to the associated client buyer.
+ #
+ # The only way a new client user can be created is via accepting an
+ # email invitation
+ # (see the
+ # accounts.clients.invitations.create
+ # method).
+ #
+ # All fields are required unless otherwise specified.
+ "status": "A String", # The status of the client user.
+ "clientAccountId": "A String", # Numerical account ID of the client buyer
+ # with which the user is associated; the
+ # buyer must be a client of the current sponsor buyer.
+ # The value of this field is ignored in an update operation.
+ "userId": "A String", # The unique numerical ID of the client user
+ # that has accepted an invitation.
+ # The value of this field is ignored in an update operation.
+ "email": "A String", # User's email address. The value of this field
+ # is ignored in an update operation.
+ }
+
+ clients()
+
Returns the clients Resource.
+ + \ No newline at end of file diff --git a/docs/dyn/adexchangebuyer2_v2beta1.html b/docs/dyn/adexchangebuyer2_v2beta1.html new file mode 100644 index 00000000000..8b295013034 --- /dev/null +++ b/docs/dyn/adexchangebuyer2_v2beta1.html @@ -0,0 +1,103 @@ + + + +
+ accounts()
+
Returns the accounts Resource.
+ + +Create a BatchHttpRequest object based on the discovery document.
+new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document. + + Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. ++
Returns the marketplacenotes Resource.
+
+ marketplaceprivateauction()
+
Returns the marketplaceprivateauction Resource.
+ @@ -124,6 +129,11 @@Returns the proposals Resource.
+
+ pubprofiles()
+
Returns the pubprofiles Resource.
+Create a BatchHttpRequest object based on the discovery document.
diff --git a/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html b/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html index dcb1eb5f4d0..2cc6ec1b5ad 100644 --- a/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html +++ b/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html @@ -81,7 +81,7 @@insert(proposalId, body)
Add new deals for the specified proposal
+list(proposalId, pqlQuery=None)
List all the deals for a given proposal
@@ -98,7 +98,7 @@insert(proposalId, body)
+ Add new deals for the specified proposal
+
+Args:
+ proposalId: string, proposalId for which deals need to be added. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "deals": [ # The list of deals to add
+ { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+ "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
"sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
{
"email": "A String", # Email address of the contact.
@@ -208,7 +318,19 @@ Method Details
],
"webPropertyCode": "A String",
"proposalId": "A String",
- "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+ "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
+ "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+ "frequencyCaps": [
+ {
+ "numTimeUnits": 42,
+ "timeUnitType": "A String",
+ "maxImpressions": 42,
+ },
+ ],
+ "creativeBlockingLevel": "A String",
+ "deliveryRateType": "A String",
+ },
"terms": { # The negotiable terms of the deal. (updatable)
"brandingType": "A String", # Visibilty of the URL in bid requests.
"estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
@@ -216,10 +338,12 @@ Method Details
"currencyCode": "A String", # The currency code for the price.
"amountMicros": 3.14, # The price value in micros.
},
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
"nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
"fixedPrices": [ # Fixed price for the specified buyer.
{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
@@ -235,6 +359,7 @@ Method Details
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"fixedPrices": [ # Fixed price for the specified buyer.
{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
@@ -246,10 +371,21 @@ Method Details
},
],
"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
+ "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
+ "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes publisher will book the deal with a impression buffer, however clients are billed using the original contracted quantity.
+ "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
+ },
},
"nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
"reservePricePerBuyers": [ # Reserve price for the specified buyer.
{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
@@ -260,56 +396,12 @@ Method Details
},
},
],
- "privateAuctionId": "A String", # Id of the corresponding private auction.
},
"description": "A String", # Description for the proposed terms of the deal.
},
- "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
- "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
- "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
- "inventoryDescription": "A String", # Description for the deal terms. (updatable)
- "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
- },
- ],
- "proposalRevisionNumber": "A String", # The updated revision number for the proposal.
- }
-insert(proposalId, body)
- Add new deals for the specified proposal
-
-Args:
- proposalId: string, proposalId for which deals need to be added. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "deals": [ # The list of deals to add
- { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
- "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
- "frequencyCaps": [
- {
- "numTimeUnits": 42,
- "timeUnitType": "A String",
- "maxImpressions": 42,
- },
- ],
- "creativeBlockingLevel": "A String",
- "deliveryRateType": "A String",
- },
- "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
- "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
- "name": "A String", # The name of the deal. (updatable)
- "buyerPrivateData": { # Buyer private data (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
- "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
- "sharedTargetings": [ # The shared targeting visible to buyers and sellers. (updatable)
+ "sharedTargetings": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)
{
- "inclusions": [ # The list of value to include as part of the targeting.
+ "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
{
"longValue": "A String", # The long value to exclude/include.
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
@@ -340,7 +432,7 @@ Method Details
"stringValue": "A String", # The string value to exclude/include.
},
],
- "exclusions": [ # The list of values to exclude from targeting.
+ "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
{
"longValue": "A String", # The long value to exclude/include.
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
@@ -374,8 +466,43 @@ Method Details
"key": "A String", # The key representing the shared targeting criterion.
},
],
- "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
"dealId": "A String", # A unique deal=id for the deal (readonly).
+ "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly)
+ "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+ "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+ "programmaticCreativeSource": "A String", # Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)
+ "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+ "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
+ "name": "A String", # The name of the deal. (updatable)
+ "buyerPrivateData": { # Buyer private data (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
+ "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions)
+ "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)
+ "hasSellerPaused": True or False,
+ "hasBuyerPaused": True or False,
+ "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first.
+ },
+ },
+ "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
+ },
+ ],
+ "proposalRevisionNumber": "A String", # The last known proposal revision number.
+ "updateAction": "A String", # Indicates an optional action to take on the proposal
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "deals": [ # List of deals added (in the same proposal as passed in the request)
+ { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+ "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
"sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
{
"email": "A String", # Email address of the contact.
@@ -384,7 +511,19 @@ Method Details
],
"webPropertyCode": "A String",
"proposalId": "A String",
- "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+ "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
+ "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+ "frequencyCaps": [
+ {
+ "numTimeUnits": 42,
+ "timeUnitType": "A String",
+ "maxImpressions": 42,
+ },
+ ],
+ "creativeBlockingLevel": "A String",
+ "deliveryRateType": "A String",
+ },
"terms": { # The negotiable terms of the deal. (updatable)
"brandingType": "A String", # Visibilty of the URL in bid requests.
"estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
@@ -392,10 +531,12 @@ Method Details
"currencyCode": "A String", # The currency code for the price.
"amountMicros": 3.14, # The price value in micros.
},
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
"nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
"fixedPrices": [ # Fixed price for the specified buyer.
{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
@@ -411,6 +552,7 @@ Method Details
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"fixedPrices": [ # Fixed price for the specified buyer.
{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
@@ -422,10 +564,21 @@ Method Details
},
],
"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
+ "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
+ "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes publisher will book the deal with a impression buffer, however clients are billed using the original contracted quantity.
+ "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
+ },
},
"nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
"reservePricePerBuyers": [ # Reserve price for the specified buyer.
{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
@@ -436,51 +589,12 @@ Method Details
},
},
],
- "privateAuctionId": "A String", # Id of the corresponding private auction.
},
"description": "A String", # Description for the proposed terms of the deal.
},
- "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
- "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
- "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
- "inventoryDescription": "A String", # Description for the deal terms. (updatable)
- "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
- },
- ],
- "proposalRevisionNumber": "A String", # The last known proposal revision number.
- "updateAction": "A String", # Indicates an optional action to take on the proposal
- }
-
-
-Returns:
- An object of the form:
-
- {
- "deals": [ # List of deals added (in the same proposal as passed in the request)
- { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
- "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
- "frequencyCaps": [
- {
- "numTimeUnits": 42,
- "timeUnitType": "A String",
- "maxImpressions": 42,
- },
- ],
- "creativeBlockingLevel": "A String",
- "deliveryRateType": "A String",
- },
- "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
- "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
- "name": "A String", # The name of the deal. (updatable)
- "buyerPrivateData": { # Buyer private data (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
- "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
- "sharedTargetings": [ # The shared targeting visible to buyers and sellers. (updatable)
+ "sharedTargetings": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)
{
- "inclusions": [ # The list of value to include as part of the targeting.
+ "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
{
"longValue": "A String", # The long value to exclude/include.
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
@@ -511,7 +625,7 @@ Method Details
"stringValue": "A String", # The string value to exclude/include.
},
],
- "exclusions": [ # The list of values to exclude from targeting.
+ "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
{
"longValue": "A String", # The long value to exclude/include.
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
@@ -545,17 +659,71 @@ Method Details
"key": "A String", # The key representing the shared targeting criterion.
},
],
- "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
"dealId": "A String", # A unique deal=id for the deal (readonly).
- "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
- {
+ "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly)
+ "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+ "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+ "programmaticCreativeSource": "A String", # Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)
+ "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+ "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
+ "name": "A String", # The name of the deal. (updatable)
+ "buyerPrivateData": { # Buyer private data (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
+ "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions)
+ "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)
+ "hasSellerPaused": True or False,
+ "hasBuyerPaused": True or False,
+ "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first.
+ },
+ },
+ "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
+ },
+ ],
+ "proposalRevisionNumber": "A String", # The updated revision number for the proposal.
+ }
+list(proposalId, pqlQuery=None)
+ List all the deals for a given proposal
+
+Args:
+ proposalId: string, The proposalId to get deals for. To search across proposals specify order_id = '-' as part of the URL. (required)
+ pqlQuery: string, Query string to retrieve specific deals.
+
+Returns:
+ An object of the form:
+
+ {
+ "deals": [ # List of deals for the proposal
+ { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+ "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
+ {
"email": "A String", # Email address of the contact.
"name": "A String", # The name of the contact.
},
],
"webPropertyCode": "A String",
"proposalId": "A String",
- "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+ "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
+ "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+ "frequencyCaps": [
+ {
+ "numTimeUnits": 42,
+ "timeUnitType": "A String",
+ "maxImpressions": 42,
+ },
+ ],
+ "creativeBlockingLevel": "A String",
+ "deliveryRateType": "A String",
+ },
"terms": { # The negotiable terms of the deal. (updatable)
"brandingType": "A String", # Visibilty of the URL in bid requests.
"estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
@@ -563,10 +731,12 @@ Method Details
"currencyCode": "A String", # The currency code for the price.
"amountMicros": 3.14, # The price value in micros.
},
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
"nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
"fixedPrices": [ # Fixed price for the specified buyer.
{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
@@ -582,6 +752,7 @@ Method Details
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"fixedPrices": [ # Fixed price for the specified buyer.
{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
@@ -593,10 +764,21 @@ Method Details
},
],
"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
+ "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
+ "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes publisher will book the deal with a impression buffer, however clients are billed using the original contracted quantity.
+ "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
+ },
},
"nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
"reservePricePerBuyers": [ # Reserve price for the specified buyer.
{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
@@ -607,57 +789,12 @@ Method Details
},
},
],
- "privateAuctionId": "A String", # Id of the corresponding private auction.
},
"description": "A String", # Description for the proposed terms of the deal.
},
- "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
- "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
- "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
- "inventoryDescription": "A String", # Description for the deal terms. (updatable)
- "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
- },
- ],
- "proposalRevisionNumber": "A String", # The updated revision number for the proposal.
- }
-list(proposalId)
- List all the deals for a given proposal
-
-Args:
- proposalId: string, The proposalId to get deals for. (required)
-
-Returns:
- An object of the form:
-
- {
- "deals": [ # List of deals for the proposal
- { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
- "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
- "frequencyCaps": [
- {
- "numTimeUnits": 42,
- "timeUnitType": "A String",
- "maxImpressions": 42,
- },
- ],
- "creativeBlockingLevel": "A String",
- "deliveryRateType": "A String",
- },
- "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
- "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
- "name": "A String", # The name of the deal. (updatable)
- "buyerPrivateData": { # Buyer private data (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
- "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
- "sharedTargetings": [ # The shared targeting visible to buyers and sellers. (updatable)
+ "sharedTargetings": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)
{
- "inclusions": [ # The list of value to include as part of the targeting.
+ "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
{
"longValue": "A String", # The long value to exclude/include.
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
@@ -688,7 +825,7 @@ Method Details
"stringValue": "A String", # The string value to exclude/include.
},
],
- "exclusions": [ # The list of values to exclude from targeting.
+ "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
{
"longValue": "A String", # The long value to exclude/include.
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
@@ -722,8 +859,47 @@ Method Details
"key": "A String", # The key representing the shared targeting criterion.
},
],
- "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
"dealId": "A String", # A unique deal=id for the deal (readonly).
+ "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly)
+ "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+ "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+ "programmaticCreativeSource": "A String", # Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)
+ "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+ "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
+ "name": "A String", # The name of the deal. (updatable)
+ "buyerPrivateData": { # Buyer private data (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
+ "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions)
+ "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)
+ "hasSellerPaused": True or False,
+ "hasBuyerPaused": True or False,
+ "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first.
+ },
+ },
+ "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
+ },
+ ],
+ }
+update(proposalId, body)
+ Replaces all the deals in the proposal with the passed in deals
+
+Args:
+ proposalId: string, The proposalId to edit deals on. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "deals": [ # List of deals to edit. Service may perform 3 different operations based on comparison of deals in this list vs deals already persisted in database: 1. Add new deal to proposal If a deal in this list does not exist in the proposal, the service will create a new deal and add it to the proposal. Validation will follow AddOrderDealsRequest. 2. Update existing deal in the proposal If a deal in this list already exist in the proposal, the service will update that existing deal to this new deal in the request. Validation will follow UpdateOrderDealsRequest. 3. Delete deals from the proposal (just need the id) If a existing deal in the proposal is not present in this list, the service will delete that deal from the proposal. Validation will follow DeleteOrderDealsRequest.
+ { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+ "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
"sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
{
"email": "A String", # Email address of the contact.
@@ -732,7 +908,19 @@ Method Details
],
"webPropertyCode": "A String",
"proposalId": "A String",
- "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+ "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
+ "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+ "frequencyCaps": [
+ {
+ "numTimeUnits": 42,
+ "timeUnitType": "A String",
+ "maxImpressions": 42,
+ },
+ ],
+ "creativeBlockingLevel": "A String",
+ "deliveryRateType": "A String",
+ },
"terms": { # The negotiable terms of the deal. (updatable)
"brandingType": "A String", # Visibilty of the URL in bid requests.
"estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
@@ -740,10 +928,12 @@ Method Details
"currencyCode": "A String", # The currency code for the price.
"amountMicros": 3.14, # The price value in micros.
},
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
"nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
"fixedPrices": [ # Fixed price for the specified buyer.
{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
@@ -759,6 +949,7 @@ Method Details
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"fixedPrices": [ # Fixed price for the specified buyer.
{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
@@ -770,10 +961,21 @@ Method Details
},
],
"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
+ "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
+ "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes publisher will book the deal with a impression buffer, however clients are billed using the original contracted quantity.
+ "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
+ },
},
"nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
"reservePricePerBuyers": [ # Reserve price for the specified buyer.
{ # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
@@ -784,55 +986,12 @@ Method Details
},
},
],
- "privateAuctionId": "A String", # Id of the corresponding private auction.
},
"description": "A String", # Description for the proposed terms of the deal.
},
- "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
- "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
- "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
- "inventoryDescription": "A String", # Description for the deal terms. (updatable)
- "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
- },
- ],
- }
-update(proposalId, body)
- Replaces all the deals in the proposal with the passed in deals
-
-Args:
- proposalId: string, The proposalId to edit deals on. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{
- "deals": [ # List of deals to edit. Service may perform 3 different operations based on comparison of deals in this list vs deals already persisted in database: 1. Add new deal to proposal If a deal in this list does not exist in the proposal, the service will create a new deal and add it to the proposal. Validation will follow AddOrderDealsRequest. 2. Update existing deal in the proposal If a deal in this list already exist in the proposal, the service will update that existing deal to this new deal in the request. Validation will follow UpdateOrderDealsRequest. 3. Delete deals from the proposal (just need the id) If a existing deal in the proposal is not present in this list, the service will delete that deal from the proposal. Validation will follow DeleteOrderDealsRequest.
- { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
- "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
- "frequencyCaps": [
- {
- "numTimeUnits": 42,
- "timeUnitType": "A String",
- "maxImpressions": 42,
- },
- ],
- "creativeBlockingLevel": "A String",
- "deliveryRateType": "A String",
- },
- "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
- "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
- "name": "A String", # The name of the deal. (updatable)
- "buyerPrivateData": { # Buyer private data (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
- "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
- "sharedTargetings": [ # The shared targeting visible to buyers and sellers. (updatable)
+ "sharedTargetings": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)
{
- "inclusions": [ # The list of value to include as part of the targeting.
+ "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
{
"longValue": "A String", # The long value to exclude/include.
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
@@ -863,7 +1022,7 @@ Method Details
"stringValue": "A String", # The string value to exclude/include.
},
],
- "exclusions": [ # The list of values to exclude from targeting.
+ "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
{
"longValue": "A String", # The long value to exclude/include.
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
@@ -897,92 +1056,34 @@ Method Details
"key": "A String", # The key representing the shared targeting criterion.
},
],
- "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
"dealId": "A String", # A unique deal=id for the deal (readonly).
- "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- "webPropertyCode": "A String",
- "proposalId": "A String",
+ "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly)
+ "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+ "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+ "programmaticCreativeSource": "A String", # Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)
+ "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+ "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
+ "name": "A String", # The name of the deal. (updatable)
+ "buyerPrivateData": { # Buyer private data (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
"flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
- "terms": { # The negotiable terms of the deal. (updatable)
- "brandingType": "A String", # Visibilty of the URL in bid requests.
- "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The price value in micros.
+ "dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions)
+ "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)
+ "hasSellerPaused": True or False,
+ "hasBuyerPaused": True or False,
+ "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first.
},
- "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
- "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- },
- "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
- "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
- },
- "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
- "reservePricePerBuyers": [ # Reserve price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- "privateAuctionId": "A String", # Id of the corresponding private auction.
- },
- "description": "A String", # Description for the proposed terms of the deal.
},
"creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
- "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
- "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
- "inventoryDescription": "A String", # Description for the deal terms. (updatable)
- "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
},
],
"proposal": { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting: # If specified, also updates the proposal in the batch transaction. This is useful when the proposal and the deals need to be updated in one transaction.
#
# (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
- "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
- "proposalState": "A String", # The current state of the proposal. (readonly)
- "name": "A String", # The name for the proposal (updatable)
- "buyerPrivateData": { # Private data for buyer. (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
- },
- "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
- "accountId": "A String", # Adx account id of the buyer.
- },
"labels": [ # List of labels associated with the proposal. (readonly)
{
"createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
@@ -999,30 +1100,41 @@ Method Details
"accountId": "A String", # The accountId of the party that created the label.
},
],
- "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
- "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
"sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
{
"email": "A String", # Email address of the contact.
"name": "A String", # The name of the contact.
},
],
- "lastUpdaterRole": "A String",
- "proposalId": "A String", # The unique id of the proposal. (readonly).
+ "negotiationId": "A String", # Optional negotiation id if this proposal is a preferred deal proposal.
"inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
"revisionNumber": "A String", # The revision number for the proposal (readonly).
- "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
+ "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
+ "seller": { # Reference to the seller on the proposal. (readonly, except on create)
+ "subAccountId": "A String", # Optional sub-account id for the seller.
+ "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+ },
+ "proposalId": "A String", # The unique id of the proposal. (readonly).
"isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+ "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
+ "privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal.
+ "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
+ "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
"buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
"accountId": "A String", # Adx account id of the buyer.
},
"hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
- "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly)
- "seller": { # Reference to the seller on the proposal. (readonly, except on create)
- "subAccountId": "A String", # Optional sub-account id for the seller.
- "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+ "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
+ "proposalState": "A String", # The current state of the proposal. (readonly)
+ "name": "A String", # The name for the proposal (updatable)
+ "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
},
- "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
+ "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action)
"buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
{
"email": "A String", # Email address of the contact.
@@ -1041,6 +1153,17 @@ Method Details
{
"deals": [ # List of all deals in the proposal after edit.
{ # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+ "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
+ "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
+ {
+ "email": "A String", # Email address of the contact.
+ "name": "A String", # The name of the contact.
+ },
+ ],
+ "webPropertyCode": "A String",
+ "proposalId": "A String",
+ "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+ "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
"deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
"frequencyCaps": [
{
@@ -1052,18 +1175,77 @@ Method Details
"creativeBlockingLevel": "A String",
"deliveryRateType": "A String",
},
- "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
- "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
- "name": "A String", # The name of the deal. (updatable)
- "buyerPrivateData": { # Buyer private data (hidden from seller).
- "referenceId": "A String",
- "referencePayload": "A String",
+ "terms": { # The negotiable terms of the deal. (updatable)
+ "brandingType": "A String", # Visibilty of the URL in bid requests.
+ "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ "sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
+ "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+ "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ },
+ ],
+ },
+ "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+ "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+ "fixedPrices": [ # Fixed price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ },
+ ],
+ "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
+ "billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
+ "price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ "originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes publisher will book the deal with a impression buffer, however clients are billed using the original contracted quantity.
+ "currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into advertiser's currency without discrepancy.
+ },
+ },
+ "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+ "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
+ "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+ { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+ "auctionTier": "A String", # Optional access type for this buyer.
+ "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+ "accountId": "A String", # Adx account id of the buyer.
+ },
+ "price": { # The specified price
+ "pricingType": "A String", # The pricing type for the deal/product.
+ "currencyCode": "A String", # The currency code for the price.
+ "amountMicros": 3.14, # The price value in micros.
+ },
+ },
+ ],
+ },
+ "description": "A String", # Description for the proposed terms of the deal.
},
- "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
- "flightEndTimeMs": "A String", # Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
- "sharedTargetings": [ # The shared targeting visible to buyers and sellers. (updatable)
+ "sharedTargetings": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)
{
- "inclusions": [ # The list of value to include as part of the targeting.
+ "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
{
"longValue": "A String", # The long value to exclude/include.
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
@@ -1094,7 +1276,7 @@ Method Details
"stringValue": "A String", # The string value to exclude/include.
},
],
- "exclusions": [ # The list of values to exclude from targeting.
+ "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
{
"longValue": "A String", # The long value to exclude/include.
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
@@ -1128,79 +1310,32 @@ Method Details
"key": "A String", # The key representing the shared targeting criterion.
},
],
- "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
"dealId": "A String", # A unique deal=id for the deal (readonly).
- "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly)
- {
- "email": "A String", # Email address of the contact.
- "name": "A String", # The name of the contact.
- },
- ],
- "webPropertyCode": "A String",
- "proposalId": "A String",
+ "creativeSafeFrameCompatibility": "A String", # Specifies whether the creative is safeFrame compatible (buyer-readonly)
+ "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+ "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+ "programmaticCreativeSource": "A String", # Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)
+ "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+ "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
+ "name": "A String", # The name of the deal. (updatable)
+ "buyerPrivateData": { # Buyer private data (hidden from seller).
+ "referenceId": "A String",
+ "referencePayload": "A String",
+ },
+ "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+ "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create)
"flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)
- "terms": { # The negotiable terms of the deal. (updatable)
- "brandingType": "A String", # Visibilty of the URL in bid requests.
- "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The price value in micros.
- },
- "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
- "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
+ "dealServingMetadata": { # Metadata about the serving status of this deal (readonly, writes via custom actions)
+ "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused. Each of the has_buyer_paused or the has_seller_paused bits can be set independently. # Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)
+ "hasSellerPaused": True or False,
+ "hasBuyerPaused": True or False,
+ "firstPausedBy": "A String", # If the deal is paused, records which party paused the deal first.
},
- "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
- "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
- "fixedPrices": [ # Fixed price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
- },
- "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
- "reservePricePerBuyers": [ # Reserve price for the specified buyer.
- { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
- "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
- "accountId": "A String", # Adx account id of the buyer.
- },
- "price": { # The specified price
- "pricingType": "A String", # The pricing type for the deal/product.
- "currencyCode": "A String", # The currency code for the price.
- "amountMicros": 3.14, # The price value in micros.
- },
- },
- ],
- "privateAuctionId": "A String", # Id of the corresponding private auction.
- },
- "description": "A String", # Description for the proposed terms of the deal.
},
"creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
- "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
- "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
- "inventoryDescription": "A String", # Description for the deal terms. (updatable)
- "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
},
],
+ "orderRevisionNumber": "A String", # The latest revision number after the update has been applied.
}
+ updateproposal(privateAuctionId, body)
Update a given private auction proposal
+updateproposal(privateAuctionId, body)
+ Update a given private auction proposal
+
+Args:
+ privateAuctionId: string, The private auction id to be updated. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "note": { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number. # Optional note to be added.
+ "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
+ "proposalRevisionNumber": "A String", # If the note is associated with a proposal revision number, then store that here. (readonly, except on create)
+ "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
+ "note": "A String", # The actual note to attach. (readonly, except on create)
+ "proposalId": "A String", # The proposalId that a note is attached to. (readonly)
+ "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
+ "noteId": "A String", # The unique id for the note. (readonly)
+ "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
+ },
+ "externalDealId": "A String", # The externalDealId of the deal to be updated.
+ "proposalRevisionNumber": "A String", # The current revision number of the proposal to be updated.
+ "updateAction": "A String", # The proposed action on the private auction proposal.
+ }
+
+
+Search for proposals using pql query
+ +Update the given proposal to indicate that setup has been completed.
update(proposalId, revisionNumber, updateAction, body)
Update the given proposal
@@ -103,16 +106,6 @@setupcomplete(proposalId)
+ Update the given proposal to indicate that setup has been completed. + +Args: + proposalId: string, The proposal id for which the setup is complete (required) ++
update(proposalId, revisionNumber, updateAction, body)
Update the given proposal @@ -546,16 +564,6 @@Method Details
{ # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting: # # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller. - "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". - "proposalState": "A String", # The current state of the proposal. (readonly) - "name": "A String", # The name for the proposal (updatable) - "buyerPrivateData": { # Private data for buyer. (hidden from seller). - "referenceId": "A String", - "referencePayload": "A String", - }, - "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly) - "accountId": "A String", # Adx account id of the buyer. - }, "labels": [ # List of labels associated with the proposal. (readonly) { "createTimeMs": "A String", # The creation time (in ms since epoch) for the label. @@ -572,30 +580,41 @@Method Details
"accountId": "A String", # The accountId of the party that created the label. }, ], - "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly) - "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly). "sellerContacts": [ # Optional contact information for the seller (buyer-readonly). { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. }, ], - "lastUpdaterRole": "A String", - "proposalId": "A String", # The unique id of the proposal. (readonly). + "negotiationId": "A String", # Optional negotiation id if this proposal is a preferred deal proposal. "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create). "revisionNumber": "A String", # The revision number for the proposal (readonly). - "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly) + "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly). + "seller": { # Reference to the seller on the proposal. (readonly, except on create) + "subAccountId": "A String", # Optional sub-account id for the seller. + "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. + }, + "proposalId": "A String", # The unique id of the proposal. (readonly). "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly). + "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly) + "privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal. + "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly) + "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly) "buyer": { # Reference to the buyer on the proposal. (readonly, except on create) "accountId": "A String", # Adx account id of the buyer. }, "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) - "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly) - "seller": { # Reference to the seller on the proposal. (readonly, except on create) - "subAccountId": "A String", # Optional sub-account id for the seller. - "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. + "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". + "proposalState": "A String", # The current state of the proposal. (readonly) + "name": "A String", # The name for the proposal (updatable) + "buyerPrivateData": { # Private data for buyer. (hidden from seller). + "referenceId": "A String", + "referencePayload": "A String", }, - "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly) + "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly) + "accountId": "A String", # Adx account id of the buyer. + }, + "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly) { "email": "A String", # Email address of the contact. @@ -611,16 +630,6 @@Method Details
{ # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting: # # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller. - "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". - "proposalState": "A String", # The current state of the proposal. (readonly) - "name": "A String", # The name for the proposal (updatable) - "buyerPrivateData": { # Private data for buyer. (hidden from seller). - "referenceId": "A String", - "referencePayload": "A String", - }, - "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly) - "accountId": "A String", # Adx account id of the buyer. - }, "labels": [ # List of labels associated with the proposal. (readonly) { "createTimeMs": "A String", # The creation time (in ms since epoch) for the label. @@ -637,30 +646,41 @@Method Details
"accountId": "A String", # The accountId of the party that created the label. }, ], - "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly) - "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly). "sellerContacts": [ # Optional contact information for the seller (buyer-readonly). { "email": "A String", # Email address of the contact. "name": "A String", # The name of the contact. }, ], - "lastUpdaterRole": "A String", - "proposalId": "A String", # The unique id of the proposal. (readonly). + "negotiationId": "A String", # Optional negotiation id if this proposal is a preferred deal proposal. "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create). "revisionNumber": "A String", # The revision number for the proposal (readonly). - "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly) + "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly). + "seller": { # Reference to the seller on the proposal. (readonly, except on create) + "subAccountId": "A String", # Optional sub-account id for the seller. + "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. + }, + "proposalId": "A String", # The unique id of the proposal. (readonly). "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly). + "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly) + "privateAuctionId": "A String", # Optional private auction id if this proposal is a private auction proposal. + "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly) + "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly) "buyer": { # Reference to the buyer on the proposal. (readonly, except on create) "accountId": "A String", # Adx account id of the buyer. }, "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) - "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly) - "seller": { # Reference to the seller on the proposal. (readonly, except on create) - "subAccountId": "A String", # Optional sub-account id for the seller. - "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. + "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". + "proposalState": "A String", # The current state of the proposal. (readonly) + "name": "A String", # The name for the proposal (updatable) + "buyerPrivateData": { # Private data for buyer. (hidden from seller). + "referenceId": "A String", + "referencePayload": "A String", }, - "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly) + "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly) + "accountId": "A String", # Adx account id of the buyer. + }, + "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly) { "email": "A String", # Email address of the contact. diff --git a/docs/dyn/adexchangebuyer_v1_4.pubprofiles.html b/docs/dyn/adexchangebuyer_v1_4.pubprofiles.html new file mode 100644 index 00000000000..e4271c07deb --- /dev/null +++ b/docs/dyn/adexchangebuyer_v1_4.pubprofiles.html @@ -0,0 +1,143 @@ + + + +Ad Exchange Buyer API . pubprofiles
+Instance Methods
+ +Gets the requested publisher profile(s) by publisher accountId.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/analytics_v3.management.accountSummaries.html b/docs/dyn/analytics_v3.management.accountSummaries.html index 2114c3f832e..f01e419566e 100644 --- a/docs/dyn/analytics_v3.management.accountSummaries.html +++ b/docs/dyn/analytics_v3.management.accountSummaries.html @@ -94,6 +94,7 @@list(accountId)+Gets the requested publisher profile(s) by publisher accountId. + +Args: + accountId: integer, The accountId of the publisher to get profiles for. (required) + +Returns: + An object of the form: + + { + "profiles": [ # Profiles for the requested publisher + { + "googlePlusLink": "A String", # Link to publisher's Google+ page. + "mediaKitLink": "A String", # The url for additional marketing and sales materials. + "publisherProvidedForecast": { # This message carries publisher provided forecasting information. # Publisher provided forecasting information. + "weeklyImpressions": "A String", # Publisher provided weekly impressions. + "dimensions": [ # Publisher provided dimensions. E.g. geo, sizes etc... + { # This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]} + "dimensionType": "A String", + "dimensionValues": [ + { # Value of the dimension. + "id": 42, # Id of the dimension. + "name": "A String", # Name of the dimension mainly for debugging purposes. + }, + ], + }, + ], + "weeklyUniques": "A String", # Publisher provided weekly uniques. + }, + "overview": "A String", # Publisher provided overview. + "buyerPitchStatement": "A String", # A pitch statement for the buyer + "isParent": True or False, # True, if this is the parent profile, which represents all domains owned by the publisher. + "topHeadlines": [ # Publisher provided key metrics and rankings. + "A String", + ], + "publisherProfileId": "A String", # Unique Id for publisher profile. + "accountId": "A String", # The account id of the seller. + "programmaticContact": "A String", # Programmatic contact for the publisher profile. + "rateCardInfoLink": "A String", # Link to publisher rate card + "seller": { # Seller of the publisher profile. + "subAccountId": "A String", # Optional sub-account id for the seller. + "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. + }, + "directContact": "A String", # Direct contact for the publisher profile. + "samplePageLink": "A String", # Link for a sample content page. + "state": "A String", # State of the publisher profile. + "exchange": "A String", # Exchange where this publisher profile is from. E.g. AdX, Rubicon etc... + "kind": "adexchangebuyer#publisherProfileApiProto", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#publisherProfileApiProto". + "name": "A String", + "publisherDomains": [ # The list of domains represented in this publisher profile. Empty if this is a parent profile. + "A String", + ], + "isPublished": True or False, # True, if this profile is published. Deprecated for state. + "audience": "A String", # Publisher provided info on its audience. + "logoUrl": "A String", # The url to the logo for the publisher. + "profileId": 42, # The pair of (seller.account_id, profile_id) uniquely identifies a publisher profile for a given publisher. + }, + ], + }+Method Details
"kind": "analytics#accountSummaries", # Collection type. "items": [ # A list of AccountSummaries. { # JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles. + "starred": True or False, # Indicates whether this account is starred or not. "kind": "analytics#accountSummary", # Resource type for Analytics AccountSummary. "webProperties": [ # List of web properties under this account. { # JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property. @@ -102,6 +103,7 @@Method Details
"level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM. "profiles": [ # List of profiles under this web property. { # JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile. + "starred": True or False, # Indicates whether this view (profile) is starred or not. "kind": "analytics#profileSummary", # Resource type for Analytics ProfileSummary. "type": "A String", # View (Profile) type. Supported types: WEB or APP. "id": "A String", # View (profile) ID. @@ -110,6 +112,7 @@Method Details
], "websiteUrl": "A String", # Website url for this web property. "internalWebPropertyId": "A String", # Internal ID for this web property. + "starred": True or False, # Indicates whether this web property is starred or not. "id": "A String", # Web property ID of the form UA-XXXXX-YY. }, ], diff --git a/docs/dyn/analytics_v3.management.accounts.html b/docs/dyn/analytics_v3.management.accounts.html index f3dca44945b..a005cc2b10d 100644 --- a/docs/dyn/analytics_v3.management.accounts.html +++ b/docs/dyn/analytics_v3.management.accounts.html @@ -102,6 +102,7 @@Method Details
"href": "A String", # Link to the list of web properties for this account. "type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties". }, + "starred": True or False, # Indicates whether this account is starred or not. "id": "A String", # Account ID. "selfLink": "A String", # Link for this account. "permissions": { # Permissions the user has for this account. diff --git a/docs/dyn/analytics_v3.management.goals.html b/docs/dyn/analytics_v3.management.goals.html index 249639da232..35fa3602cc0 100644 --- a/docs/dyn/analytics_v3.management.goals.html +++ b/docs/dyn/analytics_v3.management.goals.html @@ -85,10 +85,10 @@Instance Methods
Lists goals to which the user has access.
-
patch(accountId, webPropertyId, profileId, goalId, body)Updates an existing view (profile). This method supports patch semantics.
+Updates an existing goal. This method supports patch semantics.
-
update(accountId, webPropertyId, profileId, goalId, body)Updates an existing view (profile).
+Updates an existing goal.
Method Details
@@ -438,6 +444,10 @@get(accountId, webPropertyId, profileId, goalId)@@ -360,7 +360,7 @@Method Details
@@ -286,6 +289,10 @@patch(accountId, webPropertyId, profileId, goalId, body)-Updates an existing view (profile). This method supports patch semantics. +Updates an existing goal. This method supports patch semantics. Args: accountId: string, Account ID to update the goal. (required) @@ -483,7 +483,7 @@Method Details
@@ -186,6 +187,10 @@update(accountId, webPropertyId, profileId, goalId, body)-Updates an existing view (profile). +Updates an existing goal. Args: accountId: string, Account ID to update the goal. (required) diff --git a/docs/dyn/analytics_v3.management.profiles.html b/docs/dyn/analytics_v3.management.profiles.html index daf686f27e7..be50130fedc 100644 --- a/docs/dyn/analytics_v3.management.profiles.html +++ b/docs/dyn/analytics_v3.management.profiles.html @@ -109,9 +109,9 @@Method Details
Gets a view (profile) to which the user has access. Args: - accountId: string, Account ID to retrieve the goal for. (required) - webPropertyId: string, Web property ID to retrieve the goal for. (required) - profileId: string, View (Profile) ID to retrieve the goal for. (required) + accountId: string, Account ID to retrieve the view (profile) for. (required) + webPropertyId: string, Web property ID to retrieve the view (profile) for. (required) + profileId: string, View (Profile) ID to retrieve the view (profile) for. (required) Returns: An object of the form: @@ -136,6 +136,10 @@Method Details
"type": "analytics#goals", # Value is "analytics#goals". }, "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. + "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. + "href": "A String", # Link to the web property to which this view (profile) belongs. + "type": "analytics#webproperty", # Value is "analytics#webproperty". + }, "permissions": { # Permissions the user has for this view (profile). "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. "A String", @@ -148,10 +152,7 @@Method Details
"created": "A String", # Time this view (profile) was created. "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). "websiteUrl": "A String", # Website URL for this view (profile). - "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. - "href": "A String", # Link to the web property to which this view (profile) belongs. - "type": "analytics#webproperty", # Value is "analytics#webproperty". - }, + "starred": True or False, # Indicates whether this view (profile) is starred or not. "selfLink": "A String", # Link for this view (profile). }Method Details
"type": "analytics#goals", # Value is "analytics#goals". }, "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. + "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. + "href": "A String", # Link to the web property to which this view (profile) belongs. + "type": "analytics#webproperty", # Value is "analytics#webproperty". + }, "permissions": { # Permissions the user has for this view (profile). "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. "A String", @@ -198,10 +203,7 @@Method Details
"created": "A String", # Time this view (profile) was created. "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). "websiteUrl": "A String", # Website URL for this view (profile). - "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. - "href": "A String", # Link to the web property to which this view (profile) belongs. - "type": "analytics#webproperty", # Value is "analytics#webproperty". - }, + "starred": True or False, # Indicates whether this view (profile) is starred or not. "selfLink": "A String", # Link for this view (profile). } @@ -229,6 +231,10 @@Method Details
"type": "analytics#goals", # Value is "analytics#goals". }, "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. + "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. + "href": "A String", # Link to the web property to which this view (profile) belongs. + "type": "analytics#webproperty", # Value is "analytics#webproperty". + }, "permissions": { # Permissions the user has for this view (profile). "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. "A String", @@ -241,10 +247,7 @@Method Details
"created": "A String", # Time this view (profile) was created. "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). "websiteUrl": "A String", # Website URL for this view (profile). - "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. - "href": "A String", # Link to the web property to which this view (profile) belongs. - "type": "analytics#webproperty", # Value is "analytics#webproperty". - }, + "starred": True or False, # Indicates whether this view (profile) is starred or not. "selfLink": "A String", # Link for this view (profile). }Method Details
"type": "analytics#goals", # Value is "analytics#goals". }, "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. + "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. + "href": "A String", # Link to the web property to which this view (profile) belongs. + "type": "analytics#webproperty", # Value is "analytics#webproperty". + }, "permissions": { # Permissions the user has for this view (profile). "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. "A String", @@ -298,10 +305,7 @@Method Details
"created": "A String", # Time this view (profile) was created. "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). "websiteUrl": "A String", # Website URL for this view (profile). - "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. - "href": "A String", # Link to the web property to which this view (profile) belongs. - "type": "analytics#webproperty", # Value is "analytics#webproperty". - }, + "starred": True or False, # Indicates whether this view (profile) is starred or not. "selfLink": "A String", # Link for this view (profile). }, ], @@ -344,6 +348,10 @@Method Details
"type": "analytics#goals", # Value is "analytics#goals". }, "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. + "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. + "href": "A String", # Link to the web property to which this view (profile) belongs. + "type": "analytics#webproperty", # Value is "analytics#webproperty". + }, "permissions": { # Permissions the user has for this view (profile). "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. "A String", @@ -356,10 +364,7 @@Method Details
"created": "A String", # Time this view (profile) was created. "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). "websiteUrl": "A String", # Website URL for this view (profile). - "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. - "href": "A String", # Link to the web property to which this view (profile) belongs. - "type": "analytics#webproperty", # Value is "analytics#webproperty". - }, + "starred": True or False, # Indicates whether this view (profile) is starred or not. "selfLink": "A String", # Link for this view (profile). } @@ -387,6 +392,10 @@Method Details
"type": "analytics#goals", # Value is "analytics#goals". }, "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. + "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. + "href": "A String", # Link to the web property to which this view (profile) belongs. + "type": "analytics#webproperty", # Value is "analytics#webproperty". + }, "permissions": { # Permissions the user has for this view (profile). "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. "A String", @@ -399,10 +408,7 @@Method Details
"created": "A String", # Time this view (profile) was created. "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). "websiteUrl": "A String", # Website URL for this view (profile). - "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. - "href": "A String", # Link to the web property to which this view (profile) belongs. - "type": "analytics#webproperty", # Value is "analytics#webproperty". - }, + "starred": True or False, # Indicates whether this view (profile) is starred or not. "selfLink": "A String", # Link for this view (profile). }Method Details
"type": "analytics#goals", # Value is "analytics#goals". }, "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. + "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. + "href": "A String", # Link to the web property to which this view (profile) belongs. + "type": "analytics#webproperty", # Value is "analytics#webproperty". + }, "permissions": { # Permissions the user has for this view (profile). "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. "A String", @@ -450,10 +460,7 @@Method Details
"created": "A String", # Time this view (profile) was created. "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). "websiteUrl": "A String", # Website URL for this view (profile). - "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. - "href": "A String", # Link to the web property to which this view (profile) belongs. - "type": "analytics#webproperty", # Value is "analytics#webproperty". - }, + "starred": True or False, # Indicates whether this view (profile) is starred or not. "selfLink": "A String", # Link for this view (profile). } @@ -481,6 +488,10 @@Method Details
"type": "analytics#goals", # Value is "analytics#goals". }, "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. + "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. + "href": "A String", # Link to the web property to which this view (profile) belongs. + "type": "analytics#webproperty", # Value is "analytics#webproperty". + }, "permissions": { # Permissions the user has for this view (profile). "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property. "A String", @@ -493,10 +504,7 @@Method Details
"created": "A String", # Time this view (profile) was created. "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile). "websiteUrl": "A String", # Website URL for this view (profile). - "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs. - "href": "A String", # Link to the web property to which this view (profile) belongs. - "type": "analytics#webproperty", # Value is "analytics#webproperty". - }, + "starred": True or False, # Indicates whether this view (profile) is starred or not. "selfLink": "A String", # Link for this view (profile). }
+ reports()
+
Returns the reports Resource.
+ + +Create a BatchHttpRequest object based on the discovery document.
+new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document. + + Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. ++
+ batchGet(body, x__xgafv=None)
Returns the Analytics data.
+batchGet(body, x__xgafv=None)
+ Returns the Analytics data.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The batch request containing multiple report request.
+ "reportRequests": [ # Requests, each request will have a separate response.
+ # There can be a maximum of 5 requests. All requests should have the same
+ # `dateRange`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.
+ { # The main request class which specifies the Reporting API request.
+ "pivots": [ # The pivot definitions.
+ { # The Pivot describes the pivot section in the request.
+ # The Pivot helps rearrange the information in the table for certain reports
+ # by pivoting your data on a second dimension.
+ "metrics": [ # Metrics to aggregate and return.
+ { # A metric in the request.
+ "alias": "A String", # An alias for the metric expression is an alternate name for the
+ # expression. The alias can be used for filtering and sorting. This field
+ # is optional and is useful if the expression is not a single metric but
+ # a complex expression which cannot be used in filtering and sorting.
+ # The alias is also used in the response column header.
+ "expression": "A String", # A metric expression in the request. An expression is constructed from one
+ # or more metrics and numbers. Accepted operators include: Plus (+), Minus
+ # (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,
+ # Positive cardinal numbers (0-9), can include decimals and is limited to
+ # 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the
+ # metric expression is just a single metric name like `ga:users`.
+ # Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics
+ # will result in unexpected results.
+ "formattingType": "A String", # Specifies how the metric expression should be formatted, for example
+ # `INTEGER`.
+ },
+ ],
+ "startGroup": 42, # If k metrics were requested, then the response will contain some
+ # data-dependent multiple of k columns in the report. E.g., if you pivoted
+ # on the dimension `ga:browser` then you'd get k columns for "Firefox", k
+ # columns for "IE", k columns for "Chrome", etc. The ordering of the groups
+ # of columns is determined by descending order of "total" for the first of
+ # the k values. Ties are broken by lexicographic ordering of the first
+ # pivot dimension, then lexicographic ordering of the second pivot
+ # dimension, and so on. E.g., if the totals for the first value for
+ # Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns
+ # would be Chrome, Firefox, IE.
+ #
+ # The following let you choose which of the groups of k columns are
+ # included in the response.
+ "dimensions": [ # A list of dimensions to show as pivot columns.
+ { # A dimension in the request.
+ "name": "A String", # Name of the dimension to fetch, for example `ga:browser`.
+ "histogramBuckets": [ # If non-empty, we place dimension values into buckets after string to
+ # int64. Dimension values that are not the string representation of an
+ # integral value will be converted to zero. The bucket values have to be in
+ # increasing order. Each bucket is closed on the lower end, and open on the
+ # upper end. The "first" bucket includes all values less than the first
+ # boundary, the "last" bucket includes all values up to infinity. Dimension
+ # values that fall in a bucket get transformed to a new dimension value. For
+ # example, if one gives a list of "0, 1, 3, 4, 7", then we return the
+ # following buckets:
+ #
+ # - bucket #1: values < 0, dimension value "<0"
+ # - bucket #2: values in [0,1), dimension value "0"
+ # - bucket #3: values in [1,3), dimension value "1-2"
+ # - bucket #4: values in [3,4), dimension value "3"
+ # - bucket #5: values in [4,7), dimension value "4-6"
+ # - bucket #6: values >= 7, dimension value "7+"
+ #
+ # NOTE: If you are applying histogram mutation on any dimension, and using
+ # that dimension in sort, you will want to use the sort type
+ # `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values
+ # will be sorted according to dictionary
+ # (lexicographic) order. For example the ascending dictionary order is:
+ #
+ # "<50", "1001+", "121-1000", "50-120"
+ #
+ # And the ascending `HISTOGRAM_BUCKET` order is:
+ #
+ # "<50", "50-120", "121-1000", "1001+"
+ #
+ # The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"`
+ # for a histogram-mutated dimension.
+ "A String",
+ ],
+ },
+ ],
+ "dimensionFilterClauses": [ # DimensionFilterClauses are logically combined with an `AND` operator: only
+ # data that is included by all these DimensionFilterClauses contributes to
+ # the values in this pivot region. Dimension filters can be used to restrict
+ # the columns shown in the pivot region. For example if you have
+ # `ga:browser` as the requested dimension in the pivot region, and you
+ # specify key filters to restrict `ga:browser` to only "IE" or "Firefox",
+ # then only those two browsers would show up as columns.
+ { # A group of dimension filters. Set the operator value to specify how
+ # the filters are logically combined.
+ "operator": "A String", # The operator for combining multiple dimension filters. If unspecified, it
+ # is treated as an `OR`.
+ "filters": [ # The repeated set of filters. They are logically combined based on the
+ # operator specified.
+ { # Dimension filter specifies the filtering options on a dimension.
+ "dimensionName": "A String", # The dimension to filter on. A DimensionFilter must contain a dimension.
+ "operator": "A String", # How to match the dimension to the expression. The default is REGEXP.
+ "expressions": [ # Strings or regular expression to match against. Only the first value of
+ # the list is used for comparison unless the operator is `IN_LIST`.
+ # If `IN_LIST` operator, then the entire list is used to filter the
+ # dimensions as explained in the description of the `IN_LIST` operator.
+ "A String",
+ ],
+ "not": True or False, # Logical `NOT` operator. If this boolean is set to true, then the matching
+ # dimension values will be excluded in the report. The default is false.
+ "caseSensitive": True or False, # Should the match be case sensitive? Default is false.
+ },
+ ],
+ },
+ ],
+ "maxGroupCount": 42, # Specifies the maximum number of groups to return.
+ # The default value is 10, also the maximum value is 1,000.
+ },
+ ],
+ "hideTotals": True or False, # If set to true, hides the total of all metrics for all the matching rows,
+ # for every date range. The default false and will return the totals.
+ "metrics": [ # Metrics, the quantitative measurements, requested in the request.
+ # Requests must specify at least one metric.
+ { # A metric in the request.
+ "alias": "A String", # An alias for the metric expression is an alternate name for the
+ # expression. The alias can be used for filtering and sorting. This field
+ # is optional and is useful if the expression is not a single metric but
+ # a complex expression which cannot be used in filtering and sorting.
+ # The alias is also used in the response column header.
+ "expression": "A String", # A metric expression in the request. An expression is constructed from one
+ # or more metrics and numbers. Accepted operators include: Plus (+), Minus
+ # (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,
+ # Positive cardinal numbers (0-9), can include decimals and is limited to
+ # 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the
+ # metric expression is just a single metric name like `ga:users`.
+ # Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics
+ # will result in unexpected results.
+ "formattingType": "A String", # Specifies how the metric expression should be formatted, for example
+ # `INTEGER`.
+ },
+ ],
+ "dimensions": [ # Dimensions requested in the request.
+ { # A dimension in the request.
+ "name": "A String", # Name of the dimension to fetch, for example `ga:browser`.
+ "histogramBuckets": [ # If non-empty, we place dimension values into buckets after string to
+ # int64. Dimension values that are not the string representation of an
+ # integral value will be converted to zero. The bucket values have to be in
+ # increasing order. Each bucket is closed on the lower end, and open on the
+ # upper end. The "first" bucket includes all values less than the first
+ # boundary, the "last" bucket includes all values up to infinity. Dimension
+ # values that fall in a bucket get transformed to a new dimension value. For
+ # example, if one gives a list of "0, 1, 3, 4, 7", then we return the
+ # following buckets:
+ #
+ # - bucket #1: values < 0, dimension value "<0"
+ # - bucket #2: values in [0,1), dimension value "0"
+ # - bucket #3: values in [1,3), dimension value "1-2"
+ # - bucket #4: values in [3,4), dimension value "3"
+ # - bucket #5: values in [4,7), dimension value "4-6"
+ # - bucket #6: values >= 7, dimension value "7+"
+ #
+ # NOTE: If you are applying histogram mutation on any dimension, and using
+ # that dimension in sort, you will want to use the sort type
+ # `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values
+ # will be sorted according to dictionary
+ # (lexicographic) order. For example the ascending dictionary order is:
+ #
+ # "<50", "1001+", "121-1000", "50-120"
+ #
+ # And the ascending `HISTOGRAM_BUCKET` order is:
+ #
+ # "<50", "50-120", "121-1000", "1001+"
+ #
+ # The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"`
+ # for a histogram-mutated dimension.
+ "A String",
+ ],
+ },
+ ],
+ "dimensionFilterClauses": [ # The dimension filter clauses for filtering Dimension Values. They are
+ # logically combined with the `AND` operator. Note that filtering occurs
+ # before any dimensions are aggregated, so that the returned metrics
+ # represent the total for only the relevant dimensions.
+ { # A group of dimension filters. Set the operator value to specify how
+ # the filters are logically combined.
+ "operator": "A String", # The operator for combining multiple dimension filters. If unspecified, it
+ # is treated as an `OR`.
+ "filters": [ # The repeated set of filters. They are logically combined based on the
+ # operator specified.
+ { # Dimension filter specifies the filtering options on a dimension.
+ "dimensionName": "A String", # The dimension to filter on. A DimensionFilter must contain a dimension.
+ "operator": "A String", # How to match the dimension to the expression. The default is REGEXP.
+ "expressions": [ # Strings or regular expression to match against. Only the first value of
+ # the list is used for comparison unless the operator is `IN_LIST`.
+ # If `IN_LIST` operator, then the entire list is used to filter the
+ # dimensions as explained in the description of the `IN_LIST` operator.
+ "A String",
+ ],
+ "not": True or False, # Logical `NOT` operator. If this boolean is set to true, then the matching
+ # dimension values will be excluded in the report. The default is false.
+ "caseSensitive": True or False, # Should the match be case sensitive? Default is false.
+ },
+ ],
+ },
+ ],
+ "includeEmptyRows": True or False, # If set to false, the response does not include rows if all the retrieved
+ # metrics are equal to zero. The default is false which will exclude these
+ # rows.
+ "filtersExpression": "A String", # Dimension or metric filters that restrict the data returned for your
+ # request. To use the `filtersExpression`, supply a dimension or metric on
+ # which to filter, followed by the filter expression. For example, the
+ # following expression selects `ga:browser` dimension which starts with
+ # Firefox; `ga:browser=~^Firefox`. For more information on dimensions
+ # and metric filters, see
+ # [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).
+ "segments": [ # Segment the data returned for the request. A segment definition helps look
+ # at a subset of the segment request. A request can contain up to four
+ # segments. All requests should have the same segment definitions. Requests
+ # with segments must have the `ga:segment` dimension.
+ { # The segment definition, if the report needs to be segmented.
+ # A Segment is a subset of the Analytics data. For example, of the entire
+ # set of users, one Segment might be users from a particular country or city.
+ "dynamicSegment": { # Dynamic segment definition for defining the segment within the request. # A dynamic segment definition in the request.
+ # A segment can select users, sessions or both.
+ "sessionSegment": { # SegmentDefinition defines the segment to be a set of SegmentFilters which # Session Segment to select sessions to include in the segment.
+ # are combined together with a logical `AND` operation.
+ "segmentFilters": [ # A segment is defined by a set of segment filters which are combined
+ # together with a logical `AND` operation.
+ { # SegmentFilter defines the segment to be either a simple or a sequence
+ # segment. A simple segment condition contains dimension and metric conditions
+ # to select the sessions or users. A sequence segment condition can be used to
+ # select users or sessions based on sequential conditions.
+ "not": True or False, # If true, match the complement of simple or sequence segment.
+ # For example, to match all visits not from "New York", we can define the
+ # segment as follows:
+ #
+ # "sessionSegment": {
+ # "segmentFilters": [{
+ # "simpleSegment" :{
+ # "orFiltersForSegment": [{
+ # "segmentFilterClauses":[{
+ # "dimensionFilter": {
+ # "dimensionName": "ga:city",
+ # "expressions": ["New York"]
+ # }
+ # }]
+ # }]
+ # },
+ # "not": "True"
+ # }]
+ # },
+ "simpleSegment": { # A Simple segment conditions consist of one or more dimension/metric # A Simple segment conditions consist of one or more dimension/metric
+ # conditions that can be combined
+ # conditions that can be combined.
+ "orFiltersForSegment": [ # A list of segment filters groups which are combined with logical `AND`
+ # operator.
+ { # A list of segment filters in the `OR` group are combined with the logical OR
+ # operator.
+ "segmentFilterClauses": [ # List of segment filters to be combined with a `OR` operator.
+ { # Filter Clause to be used in a segment definition, can be wither a metric or
+ # a dimension filter.
+ "not": True or False, # Matches the complement (`!`) of the filter.
+ "dimensionFilter": { # Dimension filter specifies the filtering options on a dimension. # Dimension Filter for the segment definition.
+ "minComparisonValue": "A String", # Minimum comparison values for `BETWEEN` match type.
+ "maxComparisonValue": "A String", # Maximum comparison values for `BETWEEN` match type.
+ "dimensionName": "A String", # Name of the dimension for which the filter is being applied.
+ "caseSensitive": True or False, # Should the match be case sensitive, ignored for `IN_LIST` operator.
+ "operator": "A String", # The operator to use to match the dimension with the expressions.
+ "expressions": [ # The list of expressions, only the first element is used for all operators
+ "A String",
+ ],
+ },
+ "metricFilter": { # Metric filter to be used in a segment filter clause. # Metric Filter for the segment definition.
+ "operator": "A String", # Specifies is the operation to perform to compare the metric. The default
+ # is `EQUAL`.
+ "scope": "A String", # Scope for a metric defines the level at which that metric is defined. The
+ # specified metric scope must be equal to or greater than its primary scope
+ # as defined in the data model. The primary scope is defined by if the
+ # segment is selecting users or sessions.
+ "comparisonValue": "A String", # The value to compare against. If the operator is `BETWEEN`, this value is
+ # treated as minimum comparison value.
+ "maxComparisonValue": "A String", # Max comparison value is only used for `BETWEEN` operator.
+ "metricName": "A String", # The metric that will be filtered on. A `metricFilter` must contain a
+ # metric name.
+ },
+ },
+ ],
+ },
+ ],
+ },
+ "sequenceSegment": { # Sequence conditions consist of one or more steps, where each step is defined # Sequence conditions consist of one or more steps, where each step is
+ # defined by one or more dimension/metric conditions. Multiple steps can
+ # be combined with special sequence operators.
+ # by one or more dimension/metric conditions. Multiple steps can be combined
+ # with special sequence operators.
+ "firstStepShouldMatchFirstHit": True or False, # If set, first step condition must match the first hit of the visitor (in
+ # the date range).
+ "segmentSequenceSteps": [ # The list of steps in the sequence.
+ { # A segment sequence definition.
+ "matchType": "A String", # Specifies if the step immediately precedes or can be any time before the
+ # next step.
+ "orFiltersForSegment": [ # A sequence is specified with a list of Or grouped filters which are
+ # combined with `AND` operator.
+ { # A list of segment filters in the `OR` group are combined with the logical OR
+ # operator.
+ "segmentFilterClauses": [ # List of segment filters to be combined with a `OR` operator.
+ { # Filter Clause to be used in a segment definition, can be wither a metric or
+ # a dimension filter.
+ "not": True or False, # Matches the complement (`!`) of the filter.
+ "dimensionFilter": { # Dimension filter specifies the filtering options on a dimension. # Dimension Filter for the segment definition.
+ "minComparisonValue": "A String", # Minimum comparison values for `BETWEEN` match type.
+ "maxComparisonValue": "A String", # Maximum comparison values for `BETWEEN` match type.
+ "dimensionName": "A String", # Name of the dimension for which the filter is being applied.
+ "caseSensitive": True or False, # Should the match be case sensitive, ignored for `IN_LIST` operator.
+ "operator": "A String", # The operator to use to match the dimension with the expressions.
+ "expressions": [ # The list of expressions, only the first element is used for all operators
+ "A String",
+ ],
+ },
+ "metricFilter": { # Metric filter to be used in a segment filter clause. # Metric Filter for the segment definition.
+ "operator": "A String", # Specifies is the operation to perform to compare the metric. The default
+ # is `EQUAL`.
+ "scope": "A String", # Scope for a metric defines the level at which that metric is defined. The
+ # specified metric scope must be equal to or greater than its primary scope
+ # as defined in the data model. The primary scope is defined by if the
+ # segment is selecting users or sessions.
+ "comparisonValue": "A String", # The value to compare against. If the operator is `BETWEEN`, this value is
+ # treated as minimum comparison value.
+ "maxComparisonValue": "A String", # Max comparison value is only used for `BETWEEN` operator.
+ "metricName": "A String", # The metric that will be filtered on. A `metricFilter` must contain a
+ # metric name.
+ },
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ },
+ },
+ ],
+ },
+ "name": "A String", # The name of the dynamic segment.
+ "userSegment": { # SegmentDefinition defines the segment to be a set of SegmentFilters which # User Segment to select users to include in the segment.
+ # are combined together with a logical `AND` operation.
+ "segmentFilters": [ # A segment is defined by a set of segment filters which are combined
+ # together with a logical `AND` operation.
+ { # SegmentFilter defines the segment to be either a simple or a sequence
+ # segment. A simple segment condition contains dimension and metric conditions
+ # to select the sessions or users. A sequence segment condition can be used to
+ # select users or sessions based on sequential conditions.
+ "not": True or False, # If true, match the complement of simple or sequence segment.
+ # For example, to match all visits not from "New York", we can define the
+ # segment as follows:
+ #
+ # "sessionSegment": {
+ # "segmentFilters": [{
+ # "simpleSegment" :{
+ # "orFiltersForSegment": [{
+ # "segmentFilterClauses":[{
+ # "dimensionFilter": {
+ # "dimensionName": "ga:city",
+ # "expressions": ["New York"]
+ # }
+ # }]
+ # }]
+ # },
+ # "not": "True"
+ # }]
+ # },
+ "simpleSegment": { # A Simple segment conditions consist of one or more dimension/metric # A Simple segment conditions consist of one or more dimension/metric
+ # conditions that can be combined
+ # conditions that can be combined.
+ "orFiltersForSegment": [ # A list of segment filters groups which are combined with logical `AND`
+ # operator.
+ { # A list of segment filters in the `OR` group are combined with the logical OR
+ # operator.
+ "segmentFilterClauses": [ # List of segment filters to be combined with a `OR` operator.
+ { # Filter Clause to be used in a segment definition, can be wither a metric or
+ # a dimension filter.
+ "not": True or False, # Matches the complement (`!`) of the filter.
+ "dimensionFilter": { # Dimension filter specifies the filtering options on a dimension. # Dimension Filter for the segment definition.
+ "minComparisonValue": "A String", # Minimum comparison values for `BETWEEN` match type.
+ "maxComparisonValue": "A String", # Maximum comparison values for `BETWEEN` match type.
+ "dimensionName": "A String", # Name of the dimension for which the filter is being applied.
+ "caseSensitive": True or False, # Should the match be case sensitive, ignored for `IN_LIST` operator.
+ "operator": "A String", # The operator to use to match the dimension with the expressions.
+ "expressions": [ # The list of expressions, only the first element is used for all operators
+ "A String",
+ ],
+ },
+ "metricFilter": { # Metric filter to be used in a segment filter clause. # Metric Filter for the segment definition.
+ "operator": "A String", # Specifies is the operation to perform to compare the metric. The default
+ # is `EQUAL`.
+ "scope": "A String", # Scope for a metric defines the level at which that metric is defined. The
+ # specified metric scope must be equal to or greater than its primary scope
+ # as defined in the data model. The primary scope is defined by if the
+ # segment is selecting users or sessions.
+ "comparisonValue": "A String", # The value to compare against. If the operator is `BETWEEN`, this value is
+ # treated as minimum comparison value.
+ "maxComparisonValue": "A String", # Max comparison value is only used for `BETWEEN` operator.
+ "metricName": "A String", # The metric that will be filtered on. A `metricFilter` must contain a
+ # metric name.
+ },
+ },
+ ],
+ },
+ ],
+ },
+ "sequenceSegment": { # Sequence conditions consist of one or more steps, where each step is defined # Sequence conditions consist of one or more steps, where each step is
+ # defined by one or more dimension/metric conditions. Multiple steps can
+ # be combined with special sequence operators.
+ # by one or more dimension/metric conditions. Multiple steps can be combined
+ # with special sequence operators.
+ "firstStepShouldMatchFirstHit": True or False, # If set, first step condition must match the first hit of the visitor (in
+ # the date range).
+ "segmentSequenceSteps": [ # The list of steps in the sequence.
+ { # A segment sequence definition.
+ "matchType": "A String", # Specifies if the step immediately precedes or can be any time before the
+ # next step.
+ "orFiltersForSegment": [ # A sequence is specified with a list of Or grouped filters which are
+ # combined with `AND` operator.
+ { # A list of segment filters in the `OR` group are combined with the logical OR
+ # operator.
+ "segmentFilterClauses": [ # List of segment filters to be combined with a `OR` operator.
+ { # Filter Clause to be used in a segment definition, can be wither a metric or
+ # a dimension filter.
+ "not": True or False, # Matches the complement (`!`) of the filter.
+ "dimensionFilter": { # Dimension filter specifies the filtering options on a dimension. # Dimension Filter for the segment definition.
+ "minComparisonValue": "A String", # Minimum comparison values for `BETWEEN` match type.
+ "maxComparisonValue": "A String", # Maximum comparison values for `BETWEEN` match type.
+ "dimensionName": "A String", # Name of the dimension for which the filter is being applied.
+ "caseSensitive": True or False, # Should the match be case sensitive, ignored for `IN_LIST` operator.
+ "operator": "A String", # The operator to use to match the dimension with the expressions.
+ "expressions": [ # The list of expressions, only the first element is used for all operators
+ "A String",
+ ],
+ },
+ "metricFilter": { # Metric filter to be used in a segment filter clause. # Metric Filter for the segment definition.
+ "operator": "A String", # Specifies is the operation to perform to compare the metric. The default
+ # is `EQUAL`.
+ "scope": "A String", # Scope for a metric defines the level at which that metric is defined. The
+ # specified metric scope must be equal to or greater than its primary scope
+ # as defined in the data model. The primary scope is defined by if the
+ # segment is selecting users or sessions.
+ "comparisonValue": "A String", # The value to compare against. If the operator is `BETWEEN`, this value is
+ # treated as minimum comparison value.
+ "maxComparisonValue": "A String", # Max comparison value is only used for `BETWEEN` operator.
+ "metricName": "A String", # The metric that will be filtered on. A `metricFilter` must contain a
+ # metric name.
+ },
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ },
+ },
+ ],
+ },
+ },
+ "segmentId": "A String", # The segment ID of a built-in or custom segment, for example `gaid::-3`.
+ },
+ ],
+ "hideValueRanges": True or False, # If set to true, hides the minimum and maximum across all matching rows.
+ # The default is false and the value ranges are returned.
+ "orderBys": [ # Sort order on output rows. To compare two rows, the elements of the
+ # following are applied in order until a difference is found. All date
+ # ranges in the output get the same row order.
+ { # Specifies the sorting options.
+ "orderType": "A String", # The order type. The default orderType is `VALUE`.
+ "fieldName": "A String", # The field which to sort by. The default sort order is ascending. Example:
+ # `ga:browser`.
+ # Note, that you can only specify one field for sort here. For example,
+ # `ga:browser, ga:city` is not valid.
+ "sortOrder": "A String", # The sorting order for the field.
+ },
+ ],
+ "cohortGroup": { # Defines a cohort group. # Cohort group associated with this request. If there is a cohort group
+ # in the request the `ga:cohort` dimension must be present. All requests
+ # should have the same cohort definitions.
+ # For example:
+ #
+ # "cohortGroup": {
+ # "cohorts": [{
+ # "name": "cohort 1",
+ # "type": "FIRST_VISIT_DATE",
+ # "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
+ # },{
+ # "name": "cohort 2"
+ # "type": "FIRST_VISIT_DATE"
+ # "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
+ # }]
+ # }
+ "cohorts": [ # The definition for the cohort.
+ { # Defines a cohort. A cohort is a group of users who share a common
+ # characteristic. For example, all users with the same acquisition date
+ # belong to the same cohort.
+ "dateRange": { # A contiguous set of days: startDate, startDate + 1 day, ..., endDate. # This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users
+ # whose first visit date is between start date and end date defined in the
+ # DateRange. The date ranges should be aligned for cohort requests. If the
+ # request contains `ga:cohortNthDay` it should be exactly one day long,
+ # if `ga:cohortNthWeek` it should be aligned to the week boundary (starting
+ # at Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range
+ # should be aligned to the month (starting at the first and ending on the
+ # last day of the month).
+ # For LTV requests there are no such restrictions.
+ # You do not need to supply a date range for the
+ # `reportsRequest.dateRanges` field.
+ # The start and end dates are specified in
+ # [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.
+ "startDate": "A String", # The start date for the query in the format `YYYY-MM-DD`.
+ "endDate": "A String", # The end date for the query in the format `YYYY-MM-DD`.
+ },
+ "type": "A String", # Type of the cohort. The only supported type as of now is
+ # `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated
+ # as `FIRST_VISIT_DATE` type cohort.
+ "name": "A String", # A unique name for the cohort. If not defined name will be auto-generated
+ # with values cohort_[1234...].
+ },
+ ],
+ "lifetimeValue": True or False, # Enable Life Time Value (LTV). LTV measures lifetime value for users
+ # acquired through different channels.
+ # Please see:
+ # [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and
+ # [Lifetime Value](https://support.google.com/analytics/answer/6182550)
+ # If the value of lifetimeValue is false:
+ #
+ # - The metric values are similar to the values in the web interface cohort
+ # report.
+ # - The cohort definition date ranges must be aligned to the calendar week
+ # and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in
+ # the cohort definition should be a Sunday and the `endDate` should be the
+ # following Saturday, and for `ga:cohortNthMonth`, the `startDate`
+ # should be the 1st of the month and `endDate` should be the last day
+ # of the month.
+ #
+ # When the lifetimeValue is true:
+ #
+ # - The metric values will correspond to the values in the web interface
+ # LifeTime value report.
+ # - The Lifetime Value report shows you how user value (Revenue) and
+ # engagement (Appviews, Goal Completions, Sessions, and Session Duration)
+ # grow during the 90 days after a user is acquired.
+ # - The metrics are calculated as a cumulative average per user per the time
+ # increment.
+ # - The cohort definition date ranges need not be aligned to the calendar
+ # week and month boundaries.
+ # - The `viewId` must be an
+ # [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)
+ },
+ "dateRanges": [ # Date ranges in the request. The request can have a maximum of 2 date
+ # ranges. The response will contain a set of metric values for each
+ # combination of the dimensions for each date range in the request. So, if
+ # there are two date ranges, there will be two set of metric values, one for
+ # the original date range and one for the second date range.
+ # The `reportRequest.dateRanges` field should not be specified for cohorts
+ # or Lifetime value requests.
+ # If a date range is not provided, the default date range is (startDate:
+ # current date - 7 days, endDate: current date - 1 day)
+ { # A contiguous set of days: startDate, startDate + 1 day, ..., endDate.
+ # The start and end dates are specified in
+ # [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.
+ "startDate": "A String", # The start date for the query in the format `YYYY-MM-DD`.
+ "endDate": "A String", # The end date for the query in the format `YYYY-MM-DD`.
+ },
+ ],
+ "pageToken": "A String", # A continuation token to get the next page of the results. Adding this to
+ # the request will return the rows after the pageToken. The pageToken should
+ # be the value returned in the nextPageToken parameter in the response to
+ # the GetReports request.
+ "samplingLevel": "A String", # The desired sampling level. If the sampling level is not specified the
+ # DEFAULT sampling level will be used. All requests should have same
+ # `samplingLevel`.
+ "pageSize": 42, # Page size is for paging and specifies the maximum number of returned rows.
+ # Page size should be >= 0. A query returns the default of 1,000 rows.
+ # The Analytics Core Reporting API returns a maximum of 10,000 rows per
+ # request, no matter how many you ask for. It can also return fewer rows
+ # than requested, if there aren't as many dimension segments as you expect.
+ # For instance, there are fewer than 300 possible values for `ga:country`,
+ # so when segmenting only by country, you can't get more than 300 rows,
+ # even if you set `pageSize` to a higher value.
+ "metricFilterClauses": [ # The metric filter clauses. They are logically combined with the `AND`
+ # operator. Metric filters look at only the first date range and not the
+ # comparing date range. Note that filtering on metrics occurs after the
+ # metrics are aggregated.
+ { # Represents a group of metric filters.
+ # Set the operator value to specify how the filters are logically combined.
+ "operator": "A String", # The operator for combining multiple metric filters. If unspecified, it is
+ # treated as an `OR`.
+ "filters": [ # The repeated set of filters. They are logically combined based on the
+ # operator specified.
+ { # MetricFilter specifies the filter on a metric.
+ "operator": "A String", # Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the
+ # comparisonValue, the default is `EQUAL`. If the operator is
+ # `IS_MISSING`, checks if the metric is missing and would ignore the
+ # comparisonValue.
+ "not": True or False, # Logical `NOT` operator. If this boolean is set to true, then the matching
+ # metric values will be excluded in the report. The default is false.
+ "comparisonValue": "A String", # The value to compare against.
+ "metricName": "A String", # The metric that will be filtered on. A metricFilter must contain a metric
+ # name. A metric name can be an alias earlier defined as a metric or it can
+ # also be a metric expression.
+ },
+ ],
+ },
+ ],
+ "viewId": "A String", # Unique View Id for retrieving Analytics data.
+ },
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The main response class which holds the reports from the Reporting API
+ # `batchGet` call.
+ "reports": [ # Responses corresponding to each of the request.
+ { # The data response corresponding to the request.
+ "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
+ "data": { # The data part of the report. # Response data.
+ "rows": [ # There's one ReportRow for every unique combination of dimensions.
+ { # A row in the report.
+ "metrics": [ # List of metrics for each requested DateRange
+ { # Used to return a list of metrics for a single DateRange / dimension
+ # combination
+ "values": [ # Each value corresponds to each Metric in the request.
+ "A String",
+ ],
+ "pivotValueRegions": [ # The values of each pivot region.
+ { # The metric values in the pivot region.
+ "values": [ # The values of the metrics in each of the pivot regions.
+ "A String",
+ ],
+ },
+ ],
+ },
+ ],
+ "dimensions": [ # List of requested dimensions.
+ "A String",
+ ],
+ },
+ ],
+ "maximums": [ # Minimum and maximum values seen over all matching rows. These are both
+ # empty when `hideValueRanges` in the request is false, or when
+ # rowCount is zero.
+ { # Used to return a list of metrics for a single DateRange / dimension
+ # combination
+ "values": [ # Each value corresponds to each Metric in the request.
+ "A String",
+ ],
+ "pivotValueRegions": [ # The values of each pivot region.
+ { # The metric values in the pivot region.
+ "values": [ # The values of the metrics in each of the pivot regions.
+ "A String",
+ ],
+ },
+ ],
+ },
+ ],
+ "minimums": [ # Minimum and maximum values seen over all matching rows. These are both
+ # empty when `hideValueRanges` in the request is false, or when
+ # rowCount is zero.
+ { # Used to return a list of metrics for a single DateRange / dimension
+ # combination
+ "values": [ # Each value corresponds to each Metric in the request.
+ "A String",
+ ],
+ "pivotValueRegions": [ # The values of each pivot region.
+ { # The metric values in the pivot region.
+ "values": [ # The values of the metrics in each of the pivot regions.
+ "A String",
+ ],
+ },
+ ],
+ },
+ ],
+ "isDataGolden": True or False, # Indicates if response to this request is golden or not. Data is
+ # golden when the exact same request will not produce any new results if
+ # asked at a later point in time.
+ "samplingSpaceSizes": [ # If sampling was enabled, this returns the total number of samples
+ # present, one entry per date range.
+ "A String",
+ ],
+ "totals": [ # For each requested date range, for the set of all rows that match
+ # the query, every requested value format gets a total. The total
+ # for a value format is computed by first totaling the metrics
+ # mentioned in the value format and then evaluating the value
+ # format as a scalar expression. E.g., The "totals" for
+ # `3 / (ga:sessions + 2)` we compute
+ # `3 / ((sum of all relevant ga:sessions) + 2)`.
+ # Totals are computed before pagination.
+ { # Used to return a list of metrics for a single DateRange / dimension
+ # combination
+ "values": [ # Each value corresponds to each Metric in the request.
+ "A String",
+ ],
+ "pivotValueRegions": [ # The values of each pivot region.
+ { # The metric values in the pivot region.
+ "values": [ # The values of the metrics in each of the pivot regions.
+ "A String",
+ ],
+ },
+ ],
+ },
+ ],
+ "rowCount": 42, # Total number of matching rows for this query.
+ "samplesReadCounts": [ # If sampling was enabled, this returns the total number of samples
+ # read, one entry per date range
+ "A String",
+ ],
+ },
+ "columnHeader": { # Column headers. # The column headers.
+ "dimensions": [ # The dimension names in the response.
+ "A String",
+ ],
+ "metricHeader": { # The headers for the metrics. # Metric headers for the metrics in the response.
+ "pivotHeaders": [ # Headers for the pivots in the response.
+ { # The headers for each of the pivot sections defined in the request.
+ "totalPivotGroupsCount": 42, # The total number of groups for this pivot.
+ "pivotHeaderEntries": [ # A single pivot section header.
+ { # The headers for the each of the metric column corresponding to the metrics
+ # requested in the pivots section of the response.
+ "dimensionValues": [ # The values for the dimensions in the pivot.
+ "A String",
+ ],
+ "dimensionNames": [ # The name of the dimensions in the pivotDimensionValues field in the
+ # response.
+ "A String",
+ ],
+ "metric": { # Header for the metrics. # The metric header for the metric in the pivot.
+ "type": "A String", # The type of the metric, for example `INTEGER`.
+ "name": "A String", # The name of the header.
+ },
+ },
+ ],
+ },
+ ],
+ "metricHeaderEntries": [ # Headers for the metrics in the response.
+ { # Header for the metrics.
+ "type": "A String", # The type of the metric, for example `INTEGER`.
+ "name": "A String", # The name of the header.
+ },
+ ],
+ },
+ },
+ },
+ ],
+ }
+approve(enterpriseId, productId, body)
-Approves the specified product (and the relevant app permissions, if any).
+Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000.
generateApprovalUrl(enterpriseId, productId, languageCode=None)
Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product.
@@ -89,13 +89,18 @@
getPermissions(enterpriseId, productId)
Retrieves the Android app permissions required by this app.
+
+ list(enterpriseId, language=None, maxResults=None, token=None, query=None, approved=None)
Finds approved products that match a query.
updatePermissions(enterpriseId, productId, body)
This method has been deprecated. To programmatically approve applications, you must use the iframe mechanism via the generateApprovalUrl and approve methods of the Products resource. For more information, see the Play EMM API usage requirements.
approve(enterpriseId, productId, body)
- Approves the specified product (and the relevant app permissions, if any). +Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. + +To learn how to use Google Play for Work to design and create a store layout to display approved products to your users, see Store Layout Design. Args: enterpriseId: string, The ID of the enterprise. (required) @@ -147,6 +152,7 @@Method Details
{ # A product represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) # # The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface. + "smallIconUrl": "A String", # A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px. "kind": "androidenterprise#product", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product". "distributionChannel": "A String", # How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play Store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted. "title": "A String", # The name of the product. @@ -158,7 +164,7 @@Method Details
}, ], "productPricing": "A String", # Whether this product is free, free with in-app purchases, or paid. - "iconUrl": "A String", # A link to an image that can be used as an icon for the product. + "iconUrl": "A String", # A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px. "authorName": "A String", # The name of the author of the product (e.g. the app developer). "requiresContainerApp": True or False, # Whether this app can only be installed on devices using the Android for Work container app. "detailsUrl": "A String", # A link to the (consumer) Google Play details page for the product. @@ -231,6 +237,58 @@Method Details
}
list(enterpriseId, language=None, maxResults=None, token=None, query=None, approved=None)
+ Finds approved products that match a query.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results are returned in the language best matching the preferred language.
+ maxResults: integer, Specifies the maximum number of products that can be returned per request. If not specified, uses a default value of 100, which is also the maximum retrievable within a single response.
+ token: string, A pagination token is contained in a requestÂ’s response when there are more products. The token can be used in a subsequent request to obtain more products, and so forth. This parameter cannot be used in the initial request.
+ query: string, The search query as typed in the Google Play Store search box. If omitted, all approved apps will be returned (using the pagination parameters).
+ approved: boolean, Specifies whether to search among all products (false) or among only products that have been approved (true). Only "true" is supported, and should be specified.
+
+Returns:
+ An object of the form:
+
+ { # The matching products.
+ "product": [ # Information about a product (e.g. an app) in the Google Play Store, for display to an enterprise admin.
+ { # A product represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.)
+ #
+ # The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface.
+ "smallIconUrl": "A String", # A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px.
+ "kind": "androidenterprise#product", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product".
+ "distributionChannel": "A String", # How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play Store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted.
+ "title": "A String", # The name of the product.
+ "workDetailsUrl": "A String", # A link to the Google Play for Work details page for the product, for use by an Enterprise administrator.
+ "appVersion": [ # App versions currently available for this product. The returned list contains only public versions. Alpha and beta versions are not included.
+ { # This represents a single version of the app.
+ "versionCode": 42, # Unique increasing identifier for the app version.
+ "versionString": "A String", # The string used in the Play Store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4").
+ },
+ ],
+ "productPricing": "A String", # Whether this product is free, free with in-app purchases, or paid.
+ "iconUrl": "A String", # A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px.
+ "authorName": "A String", # The name of the author of the product (e.g. the app developer).
+ "requiresContainerApp": True or False, # Whether this app can only be installed on devices using the Android for Work container app.
+ "detailsUrl": "A String", # A link to the (consumer) Google Play details page for the product.
+ "productId": "A String", # A string of the form app:. For example, app:com.google.android.gm represents the Gmail app.
+ },
+ ],
+ "kind": "androidenterprise#productsListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productsListResponse".
+ "tokenPagination": { # Pagination information for token pagination.
+ "nextPageToken": "A String",
+ "previousPageToken": "A String",
+ },
+ "pageInfo": { # General pagination information.
+ "totalResults": 42,
+ "startIndex": 42,
+ "resultPerPage": 42,
+ },
+ }
+updatePermissions(enterpriseId, productId, body)
This method has been deprecated. To programmatically approve applications, you must use the iframe mechanism via the generateApprovalUrl and approve methods of the Products resource. For more information, see the Play EMM API usage requirements. diff --git a/docs/dyn/androidenterprise_v1.storelayoutclusters.html b/docs/dyn/androidenterprise_v1.storelayoutclusters.html index b175361a85f..85b4a9a09f6 100644 --- a/docs/dyn/androidenterprise_v1.storelayoutclusters.html +++ b/docs/dyn/androidenterprise_v1.storelayoutclusters.html @@ -120,7 +120,7 @@Method Details
"kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster". "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. # - # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters. + # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters. "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster. "A String", ], @@ -148,7 +148,7 @@Method Details
"kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster". "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. # - # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters. + # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters. "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster. "A String", ], @@ -169,7 +169,7 @@Method Details
"kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster". "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. # - # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters. + # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters. "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster. "A String", ], @@ -200,7 +200,7 @@Method Details
"kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster". "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. # - # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters. + # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters. "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster. "A String", ], @@ -232,7 +232,7 @@Method Details
"kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster". "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. # - # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters. + # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters. "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster. "A String", ], @@ -253,7 +253,7 @@Method Details
"kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster". "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. # - # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters. + # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters. "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster. "A String", ], @@ -282,7 +282,7 @@Method Details
"kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster". "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. # - # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters. + # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters. "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster. "A String", ], @@ -303,7 +303,7 @@Method Details
"kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster". "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined. # - # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters. + # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 256 characters. "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster. "A String", ], diff --git a/docs/dyn/androidenterprise_v1.users.html b/docs/dyn/androidenterprise_v1.users.html index ed911d59cc2..45fafdaddd5 100644 --- a/docs/dyn/androidenterprise_v1.users.html +++ b/docs/dyn/androidenterprise_v1.users.html @@ -130,7 +130,7 @@Method Details
# # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users. + "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". "id": "A String", # The unique ID for the user. }
Returns the purchases Resource.
+
+ reviews()
+
Returns the reviews Resource.
+Create a BatchHttpRequest object based on the discovery document.
diff --git a/docs/dyn/androidpublisher_v2.purchases.subscriptions.html b/docs/dyn/androidpublisher_v2.purchases.subscriptions.html index f77d1ce9a9a..e4610c598d6 100644 --- a/docs/dyn/androidpublisher_v2.purchases.subscriptions.html +++ b/docs/dyn/androidpublisher_v2.purchases.subscriptions.html @@ -141,10 +141,20 @@Returns a single review.
+
+ list(packageName, token=None, maxResults=None, startIndex=None)
Returns a list of reviews.
+
+ reply(packageName, reviewId, body)
Reply to a single review, or update an existing reply.
+get(packageName, reviewId)
+ Returns a single review.
+
+Args:
+ packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
+ reviewId: string, A parameter (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "authorName": "A String", # The name of the user who wrote the review.
+ "reviewId": "A String", # Unique identifier for this review.
+ "comments": [ # A repeated field containing comments for the review.
+ {
+ "developerComment": { # A comment from a developer.
+ "lastModified": { # The last time at which this comment was updated.
+ "nanos": 42,
+ "seconds": "A String",
+ },
+ "text": "A String", # The content of the comment, i.e. reply body.
+ },
+ "userComment": { # A comment from a user.
+ "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent.
+ "reviewerLanguage": "A String", # Language code for the reviewer. This is taken from the device settings so is not guaranteed to match the language the review is written in. May be absent.
+ "lastModified": { # The last time at which this comment was updated.
+ "nanos": 42,
+ "seconds": "A String",
+ },
+ "starRating": 42, # The star rating associated with the review, from 1 to 5.
+ "text": "A String", # The content of the comment, i.e. review body. In some cases users have been able to write a review with separate title and body; in those cases the title and body are concatenated and separated by a tab character.
+ "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent.
+ "androidOsVersion": 42, # Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent.
+ "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent.
+ },
+ },
+ ],
+ }
+list(packageName, token=None, maxResults=None, startIndex=None)
+ Returns a list of reviews.
+
+Args:
+ packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
+ token: string, A parameter
+ maxResults: integer, A parameter
+ startIndex: integer, A parameter
+
+Returns:
+ An object of the form:
+
+ {
+ "reviews": [
+ {
+ "authorName": "A String", # The name of the user who wrote the review.
+ "reviewId": "A String", # Unique identifier for this review.
+ "comments": [ # A repeated field containing comments for the review.
+ {
+ "developerComment": { # A comment from a developer.
+ "lastModified": { # The last time at which this comment was updated.
+ "nanos": 42,
+ "seconds": "A String",
+ },
+ "text": "A String", # The content of the comment, i.e. reply body.
+ },
+ "userComment": { # A comment from a user.
+ "appVersionCode": 42, # Integer version code of the app as installed at the time the review was written. May be absent.
+ "reviewerLanguage": "A String", # Language code for the reviewer. This is taken from the device settings so is not guaranteed to match the language the review is written in. May be absent.
+ "lastModified": { # The last time at which this comment was updated.
+ "nanos": 42,
+ "seconds": "A String",
+ },
+ "starRating": 42, # The star rating associated with the review, from 1 to 5.
+ "text": "A String", # The content of the comment, i.e. review body. In some cases users have been able to write a review with separate title and body; in those cases the title and body are concatenated and separated by a tab character.
+ "device": "A String", # Codename for the reviewer's device, e.g. klte, flounder. May be absent.
+ "androidOsVersion": 42, # Integer Android SDK version of the user's device at the time the review was written, e.g. 23 is Marshmallow. May be absent.
+ "appVersionName": "A String", # String version name of the app as installed at the time the review was written. May be absent.
+ },
+ },
+ ],
+ },
+ ],
+ "tokenPagination": {
+ "nextPageToken": "A String",
+ "previousPageToken": "A String",
+ },
+ "pageInfo": {
+ "totalResults": 42,
+ "startIndex": 42,
+ "resultPerPage": 42,
+ },
+ }
+reply(packageName, reviewId, body)
+ Reply to a single review, or update an existing reply.
+
+Args:
+ packageName: string, Unique identifier for the Android app for which we want reviews; for example, "com.spiffygame". (required)
+ reviewId: string, A parameter (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "replyText": "A String", # The text to set as the reply. Replies of more than approximately 350 characters will be rejected. HTML tags will be stripped.
+ }
+
+
+Returns:
+ An object of the form:
+
+ {
+ "result": {
+ "replyText": "A String", # The reply text that was applied.
+ "lastEdited": { # The time at which the reply took effect.
+ "nanos": 42,
+ "seconds": "A String",
+ },
+ },
+ }
+
+ instances()
+
Returns the instances Resource.
+
create(appsId, servicesId, body, x__xgafv=None)
Deploys new code and resource files to a version.
@@ -89,6 +94,9 @@
list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(appsId, servicesId, versionsId, body, mask=None, x__xgafv=None)
Updates an existing version. Note: UNIMPLEMENTED.
create(appsId, servicesId, body, x__xgafv=None)
@@ -266,7 +274,7 @@ patch(appsId, servicesId, versionsId, body, mask=None, x__xgafv=None)
+ Updates an existing version. Note: UNIMPLEMENTED.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource to update. For example: "apps/myapp/services/default/versions/1". (required)
+ servicesId: string, Part of `name`. See documentation of `appsId`. (required)
+ versionsId: string, Part of `name`. See documentation of `appsId`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A Version is a specific set of source code and configuration files deployed to a service.
+ "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
+ "idleTimeout": "A String", # The instance will be shut down this amount of time after receiving its last request.
+ "maxInstances": 42, # The maximum number of instances for App Engine to create for this version.
+ },
+ "betaSettings": { # Beta settings supplied to the application via metadata.
+ "a_key": "A String",
+ },
+ "vm": True or False, # Whether to deploy this app in a VM container.
+ "instanceClass": "A String", # The instance class to use to run this app. Valid values for AutomaticScaling are `[F1, F2, F4, F4_1G]`. Valid values for ManualScaling and BasicScaling are `[B1, B2, B4, B8, B4_1G]`. Default: "F1" for AutomaticScaling, "B1" for ManualScaling and BasicScaling
+ "errorHandlers": [ # Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ { # A custom static error page to be served when an error occurs.
+ "errorCode": "A String", # The error condition this handler applies to.
+ "mimeType": "A String", # MIME type of file. If unspecified, "text/html" is assumed.
+ "staticFile": "A String", # Static file content to be served for this error.
+ },
+ ],
+ "id": "A String", # The relative name/path of the Version within the service. Example: "v1". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used.
+ "apiConfig": { # API Serving configuration for Cloud Endpoints. # Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "url": "A String", # URL to serve the endpoint at.
+ "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
+ "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
+ "login": "A String", # What level of login is required to access this resource. Default is "optional".
+ "script": "A String", # Specifies the path to the script from the application root directory.
+ },
+ "threadsafe": True or False, # If true, multiple requests can be dispatched to the app at once.
+ "healthCheck": { # Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances. # Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "restartThreshold": 42, # The number of consecutive failed health checks before an instance is restarted.
+ "checkInterval": "A String", # The interval between health checks.
+ "unhealthyThreshold": 42, # The number of consecutive failed health checks before removing traffic.
+ "healthyThreshold": 42, # The number of consecutive successful health checks before receiving traffic.
+ "host": "A String", # The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)
+ "timeout": "A String", # The amount of time before the health check is considered failed.
+ "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
+ },
+ "defaultExpiration": "A String", # The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "libraries": [ # Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ { # A Python runtime third-party library required by the application.
+ "version": "A String", # The version of the library to select, or "latest".
+ "name": "A String", # The name of the library, e.g. "PIL" or "django".
+ },
+ ],
+ "deployer": "A String", # The email address of the user who created this version. @OutputOnly
+ "env": "A String", # The App Engine execution environment to use for this version. Default: "1"
+ "diskUsageBytes": "A String", # Total size of version files hosted on App Engine disk in bytes. @OutputOnly
+ "automaticScaling": { # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics. # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
+ "minPendingLatency": "A String", # The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
+ "networkUtilization": { # Target scaling by network usage (for VM runtimes only). # Target scaling by network usage.
+ "targetReceivedBytesPerSec": 42, # Target bytes per second received.
+ "targetSentBytesPerSec": 42, # Target bytes per second sent.
+ "targetReceivedPacketsPerSec": 42, # Target packets per second received.
+ "targetSentPacketsPerSec": 42, # Target packets per second sent.
+ },
+ "diskUtilization": { # Target scaling by disk usage (for VM runtimes only). # Target scaling by disk usage.
+ "targetWriteOpsPerSec": 42, # Target ops per second written.
+ "targetReadBytesPerSec": 42, # Target bytes per second read.
+ "targetReadOpsPerSec": 42, # Target ops per second read.
+ "targetWriteBytesPerSec": 42, # Target bytes per second written.
+ },
+ "maxPendingLatency": "A String", # The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
+ "maxIdleInstances": 42, # The maximum number of idle instances that App Engine should maintain for this version.
+ "minIdleInstances": 42, # The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a service, since other versions are not expected to receive significant traffic.
+ "requestUtilization": { # Target scaling by request utilization (for VM runtimes only). # Target scaling by request utilization.
+ "targetConcurrentRequests": 42, # Target number of concurrent requests.
+ "targetRequestCountPerSec": 42, # Target requests per second.
+ },
+ "coolDownPeriod": "A String", # The amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Applies only to the VM runtime.
+ "maxTotalInstances": 42, # Max number of instances that App Engine should start to handle requests.
+ "maxConcurrentRequests": 42, # The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.
+ "minTotalInstances": 42, # Minimum number of instances that App Engine should maintain.
+ "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+ "targetUtilization": 3.14, # Target (0-1) CPU utilization ratio to maintain when scaling.
+ "aggregationWindowLength": "A String", # The period of time over which CPU utilization is calculated.
+ },
+ },
+ "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "a_key": "A String",
+ },
+ "resources": { # Used to specify how many machine resources an app version needs. # Used to specify how many machine resources an app version needs (for VM runtimes only).
+ "diskGb": 3.14, # How much disk size, in GB, an app version needs.
+ "cpu": 3.14, # How many CPU cores an app version needs.
+ "memoryGb": 3.14, # How much memory, in GB, an app version needs.
+ },
+ "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
+ "instances": 42, # The number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
+ },
+ "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
+ "A String",
+ ],
+ "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ "files": { # A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
+ "a_key": { # A single source file which is part of the application to be deployed.
+ "mimeType": "A String", # The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used.
+ "sourceUrl": "A String", # The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
+ "sha1Sum": "A String", # The SHA1 (160 bits) hash of the file in hex.
+ },
+ },
+ "sourceReferences": [ # The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.
+ { # A reference to a particular snapshot of the source tree used to build and deploy the application.
+ "revisionId": "A String", # The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
+ "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
+ },
+ ],
+ "container": { # A Docker (container) image which should be used to start the application. # If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime.
+ "image": "A String", # Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@digest
+ },
+ },
+ "network": { # Used to specify extra network settings (for VM runtimes only). # Used to specify extra network settings (for VM runtimes only).
+ "instanceTag": "A String", # A tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # A list of ports (or port pairs) to forward from the VM into the app container.
+ "A String",
+ ],
+ "name": "A String", # The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named "default" will be used. (The short name should be specified, not the resource path.)
+ },
+ "nobuildFilesRegex": "A String", # Go only. Files that match this pattern will not be built into the app. May only be set on create requests.
+ "name": "A String", # The full path to the Version resource in the API. Example: "apps/myapp/services/default/versions/v1". @OutputOnly
+ "handlers": [ # An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+ { # A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
+ "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
+ "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
+ "urlRegex": "A String", # A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required.
+ "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches the URL pattern.
+ "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ },
+ "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
+ "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
+ "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
+ "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
+ "requireMatchingFile": True or False, # If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL.
+ "uploadPathRegex": "A String", # A regular expression that matches the file paths for all files that will be referenced by this handler.
+ "path": "A String", # The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
+ "httpHeaders": { # HTTP headers to use for all responses from these URLs.
+ "a_key": "A String",
+ },
+ },
+ "apiEndpoint": { # Use Google Cloud Endpoints to handle requests. # Use API Endpoints to handle requests.
+ "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+ },
+ "login": "A String", # What level of login is required to access this resource.
+ "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. A `302` is used by default.
+ },
+ ],
+ "creationTime": "A String", # Creation time of this version. This will be between the start and end times of the operation that creates this version. @OutputOnly
+ "servingStatus": "A String", # The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.
+ "runtime": "A String", # The desired runtime. Values can include python27, java7, go, etc.
+ }
+
+ mask: string, Standard field mask for the set of fields to be updated.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @ype with type URL.
+ },
+ }
+